RFR [15] 8236700: Upgrading JSZip from v3.1.5 to v3.2.2

Pavel Rappo pavel.rappo at oracle.com
Thu Jan 16 21:35:42 UTC 2020


Please review the following change for https://bugs.openjdk.java.net/browse/JDK-8236700:


This change upgrades the JSZip JavaScript library, used in Javadoc Search [1],
to v3.22. I tested this change as follows.

1. Commented out lines 90 through 104 in

    // if (!moduleSearchIndex) {
    //     createElem(doc, tag, 'module-search-index.js');
    // }
    // if (!packageSearchIndex) {
    //     createElem(doc, tag, 'package-search-index.js');
    // }
    // if (!typeSearchIndex) {
    //     createElem(doc, tag, 'type-search-index.js');
    // }
    // if (!memberSearchIndex) {
    //     createElem(doc, tag, 'member-search-index.js');
    // }
    // if (!tagSearchIndex) {
    //     createElem(doc, tag, 'tag-search-index.js');
    // }

This effectively makes *-search-index.js, the 5 non-zipped index files above,
unavailable. So the search UI is forced to use the zipped files and, therefore,
the JSZip library.
2. Built docs using `make docs`
3. Started a simple HTTP server in build/.../images/docs as there needs to be a
web server to serve the zipped files, via HTTP requests, to the search UI.
4. Cleared the cache of the browser
5. Opened the main docs page, index.html, in the browser and verified that only
the *-search-index.zip files were transferred.
6. Checked that the search UI produced the expected results for typical search
terms such as list, thread, string, stream, etc.
7. Checked the same for a module, package, member, and tag search terms.
This is to make sure that each of the 5 index files are accessed.


[1] https://bugs.openjdk.java.net/browse/JDK-8044243

More information about the javadoc-dev mailing list