8317621: --add-script should support JavaScript modules #18546

hns · 2024-03-29T09:39:18Z

Please review an enhancement to detect JavaScript modules when added to javadoc with the --add-script option, which require a different type attribute in the HTML <script> element. The main method of detection is to scan the script content for import and export statements. The *.mjs extension is also recognized, although it is rarely used for browser modules.

I have tested the recognition against scripts and modules in projects such as Angular and Mermaid and it worked quite well in detecting JavaScript modules.

Progress

Change must be properly reviewed (1 review required, with at least 1 Reviewer)
Change must not contain extraneous whitespace
Commit message must refer to an issue

Issue

JDK-8317621: --add-script should support JavaScript modules (Enhancement - P3)

Reviewers

Jonathan Gibbons (@jonathan-gibbons - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/18546/head:pull/18546
$ git checkout pull/18546

Update a local copy of the PR:
$ git checkout pull/18546
$ git pull https://git.openjdk.org/jdk.git pull/18546/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 18546

View PR using the GUI difftool:
$ git pr show -t 18546

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/18546.diff

Webrev

Link to Webrev Comment

bridgekeeper · 2024-03-29T09:40:08Z

👋 Welcome back hannesw! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

openjdk · 2024-03-29T09:41:02Z

@hns This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8317621: --add-script should support JavaScript modules

Reviewed-by: jjg

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 616 new commits pushed to the master branch:

4083255: 8316138: Add GlobalSign 2 TLS root certificates
43b109b: 8330066: HeapDumpPath and HeapDumpGzipLevel VM options do not mention HeapDumpBeforeFullGC and HeapDumpAfterFullGC
7cff04f: 8330276: Console methods with explicit Locale
8a4315f: 8331987: Enhance stacktrace clarity for CompletableFuture CancellationException
491b3b4: 8332256: Shenandoah: Do not visit heap threads during shutdown
9c02c8d: 8332255: Shenandoah: Remove duplicate definition of init mark closure
42ccb74: 8331940: ClassFile API ArrayIndexOutOfBoundsException with certain class files
61aff6d: 8332112: Update nsk.share.Log to don't print summary during VM shutdown hook
30bb066: 8332003: Clarify javadoc for MemoryLayout::offsetHandle
c4867c6: 8329273: C2 SuperWord: Some basic MemorySegment IR tests
... and 606 more: https://git.openjdk.org/jdk/compare/df01cc528d3b6e52925b92119e43caee54ec86e8...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

openjdk · 2024-03-29T09:41:18Z

@hns The following label will be automatically applied to this pull request:

javadoc

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

hns · 2024-04-22T15:35:58Z

I tested module detection on the Angular project which contains roughly 1100 .js files and 50 .mjs files.

All but one .mjs files were recognized as modules, with one file requiring the pattern to be updated to match export async function....
Of the .js files, 33 were recognized as modules, of which 3 were false positives caused by module source contained in a string literal such as this file.
I did not check for false negatives in .js files because of the number of files to look at, but it matches my expectation that most of the source and test code would be non-modular.

In the meantime I also researched usage of the .mjs extension and it turns out that .mjs is mosty used in Node.js, with .js being preferred in browser because of problems with web server MIME type configuration.

mlbridge · 2024-05-07T15:24:20Z

Webrevs

01: Full - Incremental (5a79ded2)
00: Full (3c7043de)

jonathan-gibbons

generally great; some minor comments for your consideration

jonathan-gibbons · 2024-05-14T17:24:31Z

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlConfiguration.java

+        additionalScripts = options.additionalScripts().stream().map(sf -> {
+            DocFile file = DocFile.createFileForInput(this, sf);
+            boolean isModule = sf.toLowerCase(Locale.ROOT).endsWith(".mjs");
+            if (!isModule) {
+                // Regex to detect JavaScript modules
+                Pattern modulePattern = Pattern.compile("""
+                        (?:^|[;}])\\s*(?:\
+                        import\\s*["']|\
+                        import[\\s{*][^()]*from\\s*["']|\
+                        export(?:\\s+(?:let|const|function|class|var|default|async)|\\s*[{*]))""");
+                try (InputStream in = file.openInputStream();
+                     BufferedReader reader = new BufferedReader(new InputStreamReader(in))) {
+                    isModule = reader.lines().anyMatch(s -> modulePattern.matcher(s).find());
+                } catch (DocFileIOException | IOException e) {
+                    // Errors are handled when copying resources
+                }
+            }
+            return new JavaScriptFile(DocPath.create(file.getName()), isModule);
+        }).collect(Collectors.toCollection(ArrayList::new));


stylistically, big lambdas like this are harder to read.
Consider pulling the body of this code to a separate private local method, and then using a method reference in the lambda calls.

jonathan-gibbons · 2024-05-14T17:28:33Z

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlConfiguration.java

+        additionalScripts = options.additionalScripts().stream().map(sf -> {
+            DocFile file = DocFile.createFileForInput(this, sf);
+            boolean isModule = sf.toLowerCase(Locale.ROOT).endsWith(".mjs");
+            if (!isModule) {
+                // Regex to detect JavaScript modules
+                Pattern modulePattern = Pattern.compile("""
+                        (?:^|[;}])\\s*(?:\
+                        import\\s*["']|\
+                        import[\\s{*][^()]*from\\s*["']|\
+                        export(?:\\s+(?:let|const|function|class|var|default|async)|\\s*[{*]))""");
+                try (InputStream in = file.openInputStream();
+                     BufferedReader reader = new BufferedReader(new InputStreamReader(in))) {
+                    isModule = reader.lines().anyMatch(s -> modulePattern.matcher(s).find());
+                } catch (DocFileIOException | IOException e) {
+                    // Errors are handled when copying resources
+                }
+            }
+            return new JavaScriptFile(DocPath.create(file.getName()), isModule);
+        }).collect(Collectors.toCollection(ArrayList::new));


I realize it is not a change in this PR, but is there a reason to use Collectors.toCollection(ArrayList::new) instead of Collectors.toList()

jonathan-gibbons

I'm not sure about the name of the new method, but do not as yet have any better suggestion, so OK.

hns · 2024-05-17T12:35:22Z

/integrate

openjdk · 2024-05-17T12:36:08Z

Going to push as commit 9bb6169.
Since your change was applied there have been 644 commits pushed to the master branch:

4eb1eaf: 8329617: Update stylesheet for specs and tool documentation
d4c2edf: 8331855: Convert jdk.jdeps jdeprscan and jdeps to use the Classfile API
beeffd4: 8332109: Convert remaining tests using com.sun.tools.classfile to ClassFile API
e0d1c4b: 8321428: Deprecate for removal the package java.beans.beancontext
0b0445b: 8331724: Refactor j.l.constant implementation to internal package
d84a8fd: 8332327: Return _methods_jmethod_ids field back in VMStructs
f1ce9b0: 8331557: Serial: Refactor SerialHeap::do_collection
14198f5: 8329653: JLILaunchTest fails on AIX after JDK-8329131
ae999ea: 8129418: JShell: better highlighting of errors in imports on demand
6422efa: 8332394: Add friendly output when @ir rule missing value
... and 634 more: https://git.openjdk.org/jdk/compare/df01cc528d3b6e52925b92119e43caee54ec86e8...master

Your commit was automatically rebased without conflicts.

openjdk · 2024-05-17T12:36:15Z

@hns Pushed as commit 9bb6169.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

JDK-8317621: --add-script should support JavaScript modules

041c089

openjdk bot added the javadoc javadoc-dev@openjdk.org label Mar 29, 2024

openjdk bot changed the title ~~JDK-8317621: --add-script should support JavaScript modules~~ 8317621: --add-script should support JavaScript modules Apr 10, 2024

hns added 3 commits April 22, 2024 18:25

Add support for .mjs and export async

0838cc3

Add test

fadf845

Rename .mjs module

3c7043d

hns marked this pull request as ready for review May 7, 2024 15:20

openjdk bot added the rfr Pull request is ready for review label May 7, 2024

jonathan-gibbons reviewed May 14, 2024

View reviewed changes

Address review feedback

5a79ded

jonathan-gibbons approved these changes May 15, 2024

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label May 15, 2024

openjdk bot added the integrated Pull request has been integrated label May 17, 2024

openjdk bot closed this May 17, 2024

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels May 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8317621: --add-script should support JavaScript modules #18546

8317621: --add-script should support JavaScript modules #18546

hns commented Mar 29, 2024 •

edited by openjdk bot

Loading

bridgekeeper bot commented Mar 29, 2024

openjdk bot commented Mar 29, 2024 •

edited

Loading

openjdk bot commented Mar 29, 2024

hns commented Apr 22, 2024 •

edited

Loading

mlbridge bot commented May 7, 2024 •

edited

Loading

jonathan-gibbons left a comment •

edited

Loading

jonathan-gibbons May 14, 2024

jonathan-gibbons May 14, 2024

jonathan-gibbons left a comment

hns commented May 17, 2024

openjdk bot commented May 17, 2024

openjdk bot commented May 17, 2024

8317621: --add-script should support JavaScript modules #18546

8317621: --add-script should support JavaScript modules #18546

Conversation

hns commented Mar 29, 2024 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Reviewing

Webrev

bridgekeeper bot commented Mar 29, 2024

openjdk bot commented Mar 29, 2024 • edited Loading

openjdk bot commented Mar 29, 2024

hns commented Apr 22, 2024 • edited Loading

mlbridge bot commented May 7, 2024 • edited Loading

Webrevs

jonathan-gibbons left a comment • edited Loading

Choose a reason for hiding this comment

jonathan-gibbons May 14, 2024

Choose a reason for hiding this comment

jonathan-gibbons May 14, 2024

Choose a reason for hiding this comment

jonathan-gibbons left a comment

Choose a reason for hiding this comment

hns commented May 17, 2024

openjdk bot commented May 17, 2024

openjdk bot commented May 17, 2024

hns commented Mar 29, 2024 •

edited by openjdk bot

Loading

openjdk bot commented Mar 29, 2024 •

edited

Loading

hns commented Apr 22, 2024 •

edited

Loading

mlbridge bot commented May 7, 2024 •

edited

Loading

jonathan-gibbons left a comment •

edited

Loading