8304146: Refactor VisibleMemberTable (LocalMemberTable) #13044

pavelrappo · 2023-03-15T15:48:37Z

Please review a change to clean up and simplify LocalMemberTable; a container to cache, classify, and provide efficient lookup for the return value of TypeElement.getEnclosedElements().

While the change primarily targets internals of LocalMemberTable, it also affects its clients: in particular, code that handles JavaFX documentation. That code does not seem to be tested well (I filed a bug for that: JDK-8304170). To make sure I haven't broken anything, aside from usual testing, I also cloned OpenJFX and built its documentation with javadoc before and after the change. Documentation bundles were identical.

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-8304146: Refactor VisibleMemberTable (LocalMemberTable)

Reviewers

Jonathan Gibbons (@jonathan-gibbons - Reviewer) ⚠️ Review applies to 6013787a

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 13044

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

Using diff file

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

Sadly, changing the member key computation ripples through JavaFX-related code.

bridgekeeper · 2023-03-15T15:50:34Z

👋 Welcome back prappo! 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 · 2023-03-15T15:53:45Z

@pavelrappo 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.

mlbridge · 2023-03-15T15:57:40Z

Webrevs

jonathan-gibbons · 2023-03-15T17:52:29Z

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberTable.java

-            return new SimpleElementVisitor14<String, Void>() {
-                @Override
-                public String visitExecutable(ExecutableElement e, Void aVoid) {
-                    return e.getSimpleName() + ":" + e.getParameters().size();


That was bizarre.

Somewhat, yes. That computation complicated code more than it improved (some aspects of) it.

jonathan-gibbons · 2023-03-15T17:52:55Z

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberTable.java

-        List<Element> getMembers(Element e, Kind kind) {
-            String key = getMemberKey(e);
-            return getMembers(key, kind);
+        List<Element> getMembers(Name simplename, Kind kind) {


Suggest: simpleName

jonathan-gibbons · 2023-03-15T17:53:13Z

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberTable.java

-        <T extends Element> List<T> getMembers(String key, Kind kind, Class<T> clazz) {
-            Map<String, List<Element>> map = memberMap.get(kind);
-            return map.getOrDefault(key, List.of())
+        <T extends Element> List<T> getMembers(Name simplename, Kind kind, Class<T> clazz) {


suggest: simpleName

jonathan-gibbons · 2023-03-15T17:53:31Z

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberTable.java

                    .stream()
                    .map(clazz::cast)
                    .toList();
        }

-        List<ExecutableElement> getPropertyMethods(String methodName, int argcount) {
-            return getMembers(methodName + ":" + argcount, Kind.METHODS).stream()
+        List<ExecutableElement> getPropertyMethods(Name simplename) {


suggest simpleName

jonathan-gibbons · 2023-03-15T17:55:53Z

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberTable.java

-                getter = found.get(0);
-            }
-            if (getter == null) {
+            // TODO: this code does not seem to be covered by tests well


Suggest: link to this TODO in recent new JBS entry.

jonathan-gibbons · 2023-03-15T17:56:06Z

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberTable.java

                    }
                }
            }

+            var setter = lmt.getPropertyMethods(utils.elementUtils.getName(pUtils.getSetName(propertyMethod))).stream()
+                    // TODO: number of parameters a setter take is not tested


Suggest: link to this TODO in recent new JBS entry.

- renames simplename to simpleName - links to the relevant JBS issue from TODOs

jonathan-gibbons

Minor naming and other suggestions.

openjdk · 2023-03-15T18:03:15Z

@pavelrappo 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:

8304146: Refactor VisibleMemberTable (LocalMemberTable)

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 5 new commits pushed to the master branch:

1ae69e3: 8304287: Problemlist java/net/SocketOption/OptionsTest.java
116627d: 8304267: JDK-8303415 missed change in Zero Interpreter
824a5e4: 8284047: Harmonize/Standardize the SSLSocket/SSLEngine/SSLSocketSSLEngine test templates
7ad48ea: 8300317: vmTestbase/nsk/stress/strace/strace* tests fail with "ERROR: wrong lengths of stack traces"
35a2969: 8302659: Modernize Windows native code for NetworkInterface

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
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.

liach · 2023-03-15T18:20:10Z

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberTable.java

-                memberMap.computeIfPresent(kind, (k, v) -> Collections.unmodifiableMap(v));
-                memberMap.computeIfAbsent(kind, t -> Map.of());
+                orderedMembers.compute(kind, (k, v) -> v == null ? List.of() : Collections.unmodifiableList(v));
+                namedMembers.compute(kind, (k, v) -> v == null ? Map.of() : Collections.unmodifiableMap(v));


Can just use replaceAll than using a for loop

There's a cost of changing that to this:

// protect from unintended change orderedMembers.replaceAll((k, l) -> Collections.unmodifiableList(l)); namedMembers.replaceAll((k, m) -> Collections.unmodifiableMap(m));

That cost is using default values for absent kinds:

List<Element> getOrderedMembers(Kind kind) { return orderedMembers.getOrDefault(kind, List.of()); } List<Element> getMembers(Name simpleName, Kind kind) { return namedMembers.getOrDefault(kind, Map.of()) .getOrDefault(simpleName, List.of()); }

Or did you mean something else?

I don't mind either way; @jonathan-gibbons do you have a preference?

TANSTAAFL

I suggest to leave the code as-is.

True, my previous suggestion is largely trivial.

In addition, I suggest to run replaceAll to ensure the map elements of each value of namedMembers is unmodifiable as well:

namedMembers.replaceAll((k, m) -> { m.replaceAll((n, members) -> Collections.unmodifiableList(members)); return Collections.unmodifiableMap(m); });

I believe that shallow unmodifiability of namedMembers is a bug, which you spotted. We should either fix it by making it deeply unmodifiable, or remove this defensiveness altogether: those lists and maps (especially maps) are internal and should never escape. I suppose, it's better to fix it now and revisit later.

Or just comment the existing code, indicating that this is just a shallow copy.

I think we should follow the original code intent, if that's not too complicated. Please have a look at the proposal in 7565f89, and if you are okay with it, and the tests pass, I'll integrate it.

@liach there's no need for namedMembers or its value maps to be unmodifiable: it's the lists that are exposed. So let's protect just them.

Sorry, pushed the change sloppily. Since it was done recently and there haven't been more pushes on top of that, I pushed forcefully. Please consider 963bff7 instead of ~~7565f89~~.

Uses better suited list/map processing.

openjdk · 2023-03-15T21:04:12Z

@pavelrappo Please do not rebase or force-push to an active PR as it invalidates existing review comments. Note for future reference, the bots always squash all changes into a single commit automatically as part of the integration. See OpenJDK Developers’ Guide for more information.

pavelrappo · 2023-03-16T22:22:50Z

/integrate

openjdk · 2023-03-16T22:23:53Z

Going to push as commit 8eed7de.
Since your change was applied there have been 20 commits pushed to the master branch:

a487a27: 8303150: DCmd framework unnecessarily creates a DCmd instance on registration
2e987d7: 8304360: Test to ensure ConstantDescs fields work
2f23c80: 8304225: Remove javax/script/Test7.java from ProblemList
96889bf: 8191565: Last-ditch Full GC should also move humongous objects
f629152: 8304055: G1: Remove OldGCAllocRegion::release
b5108b4: 8303749: Serial: Use more strict card table API
7dbab81: 8304161: Add TypeKind.from to derive from TypeDescriptor.OfField
d4eb395: 8303684: Lift upcall sharing mechanism to AbstractLinker (mainline)
dfc7214: 8304283: Modernize the switch statements in jdk.internal.foreign
7277bb1: 8293324: ciField.hpp has two methods to return field's offset
... and 10 more: https://git.openjdk.org/jdk/compare/01e6920581407bc3bd69db495fc694629ef01262...master

Your commit was automatically rebased without conflicts.

openjdk · 2023-03-16T22:24:08Z

@pavelrappo Pushed as commit 8eed7de.

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

Improve LocalMemberTable

Verified

This commit was signed with the committer’s verified signature.

sergeyklay Serghei Iakovlev

GPG key ID: C6AF1016BBDEA800

Verified
Learn about vigilant mode

45001af

Sadly, changing the member key computation ripples through JavaFX-related code.

openjdk bot added the rfr label Mar 15, 2023

openjdk bot added the javadoc label Mar 15, 2023

jonathan-gibbons reviewed Mar 15, 2023

View reviewed changes

Address feedback

5ecdca9

- renames simplename to simpleName - links to the relevant JBS issue from TODOs

jonathan-gibbons approved these changes Mar 15, 2023

View reviewed changes

openjdk bot added the ready label Mar 15, 2023

Trivially rephrase TODO

6013787

jonathan-gibbons approved these changes Mar 15, 2023

View reviewed changes

liach reviewed Mar 15, 2023

View reviewed changes

Address feedback

963bff7

Uses better suited list/map processing.

pavelrappo force-pushed the 8304146 branch from 7565f89 to 963bff7 Compare March 15, 2023 21:03

openjdk bot added the integrated label Mar 16, 2023

openjdk bot closed this Mar 16, 2023

openjdk bot removed ready rfr labels Mar 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8304146: Refactor VisibleMemberTable (LocalMemberTable) #13044

8304146: Refactor VisibleMemberTable (LocalMemberTable) #13044

pavelrappo commented Mar 15, 2023 •

edited by openjdk bot

Loading

bridgekeeper bot commented Mar 15, 2023

openjdk bot commented Mar 15, 2023

mlbridge bot commented Mar 15, 2023 •

edited

Loading

jonathan-gibbons Mar 15, 2023

pavelrappo Mar 15, 2023

jonathan-gibbons Mar 15, 2023

jonathan-gibbons Mar 15, 2023

jonathan-gibbons Mar 15, 2023

jonathan-gibbons Mar 15, 2023

jonathan-gibbons Mar 15, 2023

jonathan-gibbons left a comment

openjdk bot commented Mar 15, 2023 •

edited

Loading

liach Mar 15, 2023

pavelrappo Mar 15, 2023

pavelrappo Mar 15, 2023

jonathan-gibbons Mar 15, 2023

liach Mar 15, 2023

pavelrappo Mar 15, 2023 •

edited

Loading

jonathan-gibbons Mar 15, 2023

pavelrappo Mar 15, 2023

pavelrappo Mar 15, 2023

pavelrappo Mar 15, 2023

openjdk bot commented Mar 15, 2023

pavelrappo commented Mar 16, 2023

openjdk bot commented Mar 16, 2023

openjdk bot commented Mar 16, 2023

8304146: Refactor VisibleMemberTable (LocalMemberTable) #13044

8304146: Refactor VisibleMemberTable (LocalMemberTable) #13044

Conversation

pavelrappo commented Mar 15, 2023 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Reviewing

bridgekeeper bot commented Mar 15, 2023

openjdk bot commented Mar 15, 2023

mlbridge bot commented Mar 15, 2023 • edited Loading

Webrevs

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonathan-gibbons left a comment

Choose a reason for hiding this comment

openjdk bot commented Mar 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pavelrappo Mar 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openjdk bot commented Mar 15, 2023

pavelrappo commented Mar 16, 2023

openjdk bot commented Mar 16, 2023

openjdk bot commented Mar 16, 2023

pavelrappo commented Mar 15, 2023 •

edited by openjdk bot

Loading

mlbridge bot commented Mar 15, 2023 •

edited

Loading

openjdk bot commented Mar 15, 2023 •

edited

Loading

pavelrappo Mar 15, 2023 •

edited

Loading