8260581: IGV: enhance node search #2285

robcasloz · 2021-01-28T11:07:38Z

Apply several enhancements to the quick node search functionality:

Allow users to search by node id or name by default (i.e. when no property is specified) instead of name only.
Show partial matches when searching for a specific property (e.g. so that searching "type=con" lists all "control"-type nodes).
Avoid showing the "All N matching nodes" entry if there is a single match, or the user is searching a numeric value.
Rank matches so that full matches are listed first, followed by matches at the beginning of the partially matched value, followed by the rest of matches in increasing size of the partially matched value. Numeric matches with the same rank are sorted increasingly. For example, searching "5" on a set of nodes with labels {"5 AddI", "25 AddL", "253 AddL", "554 MulI"} should list the matches as follows:
1. 5 AddI
2. 554 MulI
3. 25 AddL
4. 253 AddL

As an illustration of some of these enhancements, this screenshot shows the behavior of the quick node search functionality before the changes:

and after:

Tested manually on small and large (~10000 nodes) graphs. Thanks to Christian Hagedorn for feedback on several iterations of the enhancements.

As part of the review, please evaluate not just the code changes but also the usability.

Progress

Change must not contain extraneous whitespace
Commit message must refer to an issue
Change must be properly reviewed

Issue

JDK-8260581: IGV: enhance node search

Reviewers

Christian Hagedorn (@chhagedorn - Reviewer)
Vladimir Ivanov (@iwanowww - Reviewer) ⚠️ Review applies to 73d0ed0
Xin Liu (@navyxliu - no project role)

Contributors

Christian Hagedorn <chagedorn@openjdk.org>

Download

$ git fetch https://git.openjdk.java.net/jdk pull/2285/head:pull/2285
$ git checkout pull/2285

Change the default quick search property to "label", to allow users to search by node id or name by default, instead of name only. Re-compute the "label" property every time node labels are updated.

bridgekeeper · 2021-01-28T11:08:21Z

👋 Welcome back rcastanedalo! 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 · 2021-01-28T11:09:12Z

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

hotspot-compiler

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.

robcasloz · 2021-01-28T11:10:36Z

/summary
Change the default quick search property to "label", to allow users to search by
node id or name by default, instead of name only. Re-compute the "label"
property every time node labels are updated.

openjdk · 2021-01-28T11:10:53Z

@robcasloz Setting summary to:

Change the default quick search property to "label", to allow users to search by
node id or name by default, instead of name only. Re-compute the "label"
property every time node labels are updated.

Adding an explicit "Recent Searches" category rather than the default, implicit one triggers two issues: - IGV does not show the recent searches when clicking into the search bar. - IGV selects random nodes in the list of matches instead of the top one.

robcasloz · 2021-01-29T14:07:40Z

/summary
Allow users to search by node id or name by default, show partial matches when
searching for a specific property, show 'All N matching nodes' entry only if
relevant, and rank results by level of matching.

openjdk · 2021-01-29T14:08:12Z

@robcasloz Updating existing summary to:

Allow users to search by node id or name by default, show partial matches when
searching for a specific property, show 'All N matching nodes' entry only if
relevant, and rank results by level of matching.

mlbridge · 2021-01-29T14:11:51Z

Webrevs

chhagedorn

Otherwise, it looks good to me.

I applied your patch and tested the new features in the IGV. They work as expected. Good to see the search being improved!

src/utils/IdealGraphVisualizer/View/src/com/sun/hotspot/igv/view/NodeQuickSearch.java

openjdk · 2021-01-29T15:21:54Z

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

8260581: IGV: enhance node search

Allow users to search by node id or name by default, show partial matches when
searching for a specific property, show 'All N matching nodes' entry only if
relevant, and rank results by level of matching.

Co-authored-by: Christian Hagedorn <chagedorn@openjdk.org>
Reviewed-by: chagedorn, vlivanov, xliu

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

9037615: 8222850: jshell tool: Misleading cascade compiler error in switch expression with undefined vars
91e6c75: 8260928: InitArrayShortSize constraint func should print a helpful error message
cb127a4: 8198343: Test java/awt/print/PrinterJob/TestPgfmtSetMPA.java may fail w/o printer
c008410: 8197825: [Test] Intermittent timeout with javax/swing JColorChooser Test
b9d4211: 8260193: Remove JVM_GetInterfaceVersion() and JVM_DTraceXXX
98a7692: 8076313: GraphicsEnvironment does not detect changes in count of monitors on Linux OS
a47befc: 8260878: com/sun/jdi/JdbOptions.java fails without jfr
d423d36: 8258508: Merge G1RedirtyCardsQueue into qset
bec6043: 8259570: (macos) tools/jpackage tests fails with 'hdiutil: couldn't eject "disk2" - Resource busy'
ffbcf1b: 8260471: Change SystemDictionary::X_klass calls to vmClasses::X_klass
... and 70 more: https://git.openjdk.java.net/jdk/compare/a97aedff9f622ba6816b7550588f1d429bff2483...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.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@chhagedorn, @iwanowww) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

iwanowww

Awesome! Finally!

robcasloz · 2021-02-01T08:38:35Z

Thanks Christian and Vladimir for reviewing! I will wait a couple more days in case anyone else has comments.

Sort otherwise equally relevant matches by node id, which is by default the first word in node labels. Thanks to Christian Hagedorn for the suggestion and (slightly adapted) patch.

robcasloz · 2021-02-01T11:31:41Z

/contributor add @chhagedorn

openjdk · 2021-02-01T11:31:53Z

@robcasloz
Contributor Christian Hagedorn <chagedorn@openjdk.org> successfully added.

robcasloz · 2021-02-01T11:38:57Z

Commit 981e903 adds a match sorting refinement contributed by @chhagedorn (numeric sorting of same-rank matches), please re-review.

chhagedorn

Thanks for adding the additional sorting suggestion! Looks good to me.

I applied the patch again and everything works as expected in the IGV.

navyxliu

LGTM. I ran it with your patch. it works as expected.

robcasloz · 2021-02-02T08:11:12Z

Thanks for adding the additional sorting suggestion! Looks good to me.

I applied the patch again and everything works as expected in the IGV.

Thanks again, Christian!

robcasloz · 2021-02-02T08:12:04Z

LGTM. I ran it with your patch. it works as expected.

Thanks for reviewing, Xin!

robcasloz · 2021-02-03T09:54:45Z

/integrate

openjdk · 2021-02-03T09:55:12Z

@robcasloz
Your change (at version 981e903) is now ready to be sponsored by a Committer.

robcasloz · 2021-02-03T09:56:54Z

Please sponsor.

iwanowww · 2021-02-03T11:11:24Z

/sponsor

openjdk · 2021-02-03T11:12:16Z

@iwanowww @robcasloz Since your change was applied there have been 80 commits pushed to the master branch:

9037615: 8222850: jshell tool: Misleading cascade compiler error in switch expression with undefined vars
91e6c75: 8260928: InitArrayShortSize constraint func should print a helpful error message
cb127a4: 8198343: Test java/awt/print/PrinterJob/TestPgfmtSetMPA.java may fail w/o printer
c008410: 8197825: [Test] Intermittent timeout with javax/swing JColorChooser Test
b9d4211: 8260193: Remove JVM_GetInterfaceVersion() and JVM_DTraceXXX
98a7692: 8076313: GraphicsEnvironment does not detect changes in count of monitors on Linux OS
a47befc: 8260878: com/sun/jdi/JdbOptions.java fails without jfr
d423d36: 8258508: Merge G1RedirtyCardsQueue into qset
bec6043: 8259570: (macos) tools/jpackage tests fails with 'hdiutil: couldn't eject "disk2" - Resource busy'
ffbcf1b: 8260471: Change SystemDictionary::X_klass calls to vmClasses::X_klass
... and 70 more: https://git.openjdk.java.net/jdk/compare/a97aedff9f622ba6816b7550588f1d429bff2483...master

Your commit was automatically rebased without conflicts.

Pushed as commit ae2c5f0.

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

8260581: IGV: search on node labels by default instead of name only

1de1e95

Change the default quick search property to "label", to allow users to search by node id or name by default, instead of name only. Re-compute the "label" property every time node labels are updated.

openjdk bot added the hotspot-compiler hotspot-compiler-dev@openjdk.org label Jan 28, 2021

robcasloz added 4 commits January 29, 2021 09:31

Update copyright headers

24bf94f

List suggestions for partial property matches as well

610e195

Show 'All N matching nodes' entry only if relevant

c7b7701

Rank quick search results

1b7dccc

robcasloz changed the title ~~8260581: IGV: search on node labels by default instead of name only~~ 8260581: IGV: enhance node search Jan 29, 2021

robcasloz added 3 commits January 29, 2021 12:22

Make it possible to disable 'Recent Searches'

87a218c

Avoid registering search results needlessly

41eeadc

robcasloz marked this pull request as ready for review January 29, 2021 14:08

openjdk bot added the rfr Pull request is ready for review label Jan 29, 2021

Remove debug print

73d0ed0

chhagedorn approved these changes Jan 29, 2021

View changes

src/utils/IdealGraphVisualizer/View/src/com/sun/hotspot/igv/view/NodeQuickSearch.java Outdated Show resolved Hide resolved

openjdk bot added the ready Pull request is ready to be integrated label Jan 29, 2021

iwanowww approved these changes Jan 29, 2021

View changes

Use Integer.compare()

537d023

Sort same-rank matches by first-word numeric value

981e903

Sort otherwise equally relevant matches by node id, which is by default the first word in node labels. Thanks to Christian Hagedorn for the suggestion and (slightly adapted) patch.

chhagedorn approved these changes Feb 1, 2021

View changes

navyxliu approved these changes Feb 2, 2021

View changes

chhagedorn approved these changes Feb 3, 2021

View changes

openjdk bot added the sponsor Pull request is ready to be sponsored label Feb 3, 2021

openjdk bot closed this Feb 3, 2021

openjdk bot added integrated Pull request has been integrated and removed sponsor Pull request is ready to be sponsored ready Pull request is ready to be integrated rfr Pull request is ready for review labels Feb 3, 2021

8260581: IGV: enhance node search #2285

8260581: IGV: enhance node search #2285

robcasloz commented Jan 28, 2021 •

edited by openjdk bot

bridgekeeper bot commented Jan 28, 2021

openjdk bot commented Jan 28, 2021

robcasloz commented Jan 28, 2021

openjdk bot commented Jan 28, 2021

robcasloz commented Jan 29, 2021

openjdk bot commented Jan 29, 2021

mlbridge bot commented Jan 29, 2021 •

edited

chhagedorn left a comment

openjdk bot commented Jan 29, 2021 •

edited

iwanowww left a comment

robcasloz commented Feb 1, 2021

robcasloz commented Feb 1, 2021

openjdk bot commented Feb 1, 2021

robcasloz commented Feb 1, 2021

chhagedorn left a comment

navyxliu left a comment

robcasloz commented Feb 2, 2021

robcasloz commented Feb 2, 2021

robcasloz commented Feb 3, 2021

openjdk bot commented Feb 3, 2021

robcasloz commented Feb 3, 2021

iwanowww commented Feb 3, 2021

openjdk bot commented Feb 3, 2021

8260581: IGV: enhance node search #2285

8260581: IGV: enhance node search #2285

Conversation

robcasloz commented Jan 28, 2021 • edited by openjdk bot

Progress

Issue

Reviewers

Contributors

Download

bridgekeeper bot commented Jan 28, 2021

openjdk bot commented Jan 28, 2021

robcasloz commented Jan 28, 2021

openjdk bot commented Jan 28, 2021

robcasloz commented Jan 29, 2021

openjdk bot commented Jan 29, 2021

mlbridge bot commented Jan 29, 2021 • edited

Webrevs

chhagedorn left a comment

Choose a reason for hiding this comment

openjdk bot commented Jan 29, 2021 • edited

iwanowww left a comment

Choose a reason for hiding this comment

robcasloz commented Feb 1, 2021

robcasloz commented Feb 1, 2021

openjdk bot commented Feb 1, 2021

robcasloz commented Feb 1, 2021

chhagedorn left a comment

Choose a reason for hiding this comment

navyxliu left a comment

Choose a reason for hiding this comment

robcasloz commented Feb 2, 2021

robcasloz commented Feb 2, 2021

robcasloz commented Feb 3, 2021

openjdk bot commented Feb 3, 2021

robcasloz commented Feb 3, 2021

iwanowww commented Feb 3, 2021

openjdk bot commented Feb 3, 2021

robcasloz commented Jan 28, 2021 •

edited by openjdk bot

mlbridge bot commented Jan 29, 2021 •

edited

openjdk bot commented Jan 29, 2021 •

edited