Skip to content

Conversation

@stachenov
Copy link

@stachenov stachenov commented Aug 8, 2023

Hello!

I'm a member of the UI team in JetBrains IntelliJ department, and we have this bug with popup menus being shown on the wrong monitor in multi-monitor environments:

https://youtrack.jetbrains.com/issue/JBR-5824/Dual-monitor-bug-on-the-context-menu

I managed to track it down to this JDK bug:

https://bugs.openjdk.org/browse/JDK-6415065

I've described the cause and the fix in the commit message, but in short, what happens here is that JMenu.getPopupMenuOrigin sometimes returns coordinates outside (usually above) of the current screen, and later JPopupMenu.adjustPopupLocationToFitScreen uses those coordinates to fit the entire popup menu into the screen, which goes wrong because at that point it's no longer known which screen the menu was initially invoked on.

I've fixed this by making sure the Y coordinate is still within the correct screen when it's returned from JMenu.getPopupMenuOrigin.


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-6415065: Submenu is shown on wrong screen in multiple monitor environment (Bug - P4)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 15185

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

Using diff file

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

Webrev

Link to Webrev Comment

@bridgekeeper bridgekeeper bot added the oca Needs verification of OCA signatory status label Aug 8, 2023
@bridgekeeper
Copy link

bridgekeeper bot commented Aug 8, 2023

Hi @stachenov, welcome to this OpenJDK project and thanks for contributing!

We do not recognize you as Contributor and need to ensure you have signed the Oracle Contributor Agreement (OCA). If you have not signed the OCA, please follow the instructions. Please fill in your GitHub username in the "Username" field of the application. Once you have signed the OCA, please let us know by writing /signed in a comment in this pull request.

If you already are an OpenJDK Author, Committer or Reviewer, please click here to open a new issue so that we can record that fact. Please use "Add GitHub user stachenov" as summary for the issue.

If you are contributing this work on behalf of your employer and your employer has signed the OCA, please let us know by writing /covered in a comment in this pull request.

@openjdk
Copy link

openjdk bot commented Aug 8, 2023

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

  • client

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.

@openjdk openjdk bot added the client client-libs-dev@openjdk.org label Aug 8, 2023
@stachenov
Copy link
Author

/covered

@bridgekeeper bridgekeeper bot added the oca-verify Needs verification of OCA signatory status label Aug 8, 2023
@bridgekeeper
Copy link

bridgekeeper bot commented Aug 8, 2023

Thank you! Please allow for a few business days to verify that your employer has signed the OCA. Also, please note that pull requests that are pending an OCA check will not usually be evaluated, so your patience is appreciated!

if (position.y + y < screenBounds.y) { // Above the current screen?
y = screenBounds.y - position.y; // Fit into the screen, relative to our origin.
}
if (position.y + y >= screenBounds.y + screenBounds.height) { // Below the current screen?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why only the y coordinate is checked? Can we implement it for x as well for symmetry?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A good idea. I was actually thinking about it after I had submitted this. Even though I've never encountered any issues with the X coordinate, I think it's still possible in theory in some unusual circumstances. Anyway, an extra check definitely won't hurt. Will do.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the X coordinate checks as well. While I was testing it, I noticed that sometimes the screen bounds are already wrong here because the graphics configuration is returned for the wrong display above. It happens, for example, in Ubuntu, when a window spans across two monitors. This seems to be a separate issue, though, and I can't do anything about it here, it's something deeper inside the internals, and likely is platform-dependent.

…ment

What happens here is that when the position of a popup menu is
calculated, it can expand above or below, depending on the position of
the parent menu, the item being expanded and the size of the submenu and
screen resolution.

If the menu decides to expand above, the position calculation in
JMenu.getPopupMenuOrigin may yield a coordinate above the current
screen.  Later, JPopupMenu.adjustPopupLocationToFitScreen tries to fit
the entire menu into the screen.  However, it has no idea which screen
is correct, as all it has is an (x, y) location. If that location is
invalid, it may correct it by fitting it into the screen. However, if it
is valid, but located on an incorrect screen, then the whole logic goes
awry and the menu is fitted into the wrong screen.

In theory, a similar issue is possible if the menu decides to expand
below, though it's not easily reproducible as it would require a rather
unique combination of factors, such as unusually large
Menu.submenuPopupOffsetY.

The same thing could also happen to the X location, although it's less
likely because the popup menu has to be unusually wide for that.

Fix by pre-adjusting the location to fit into the correct screen in
JMenu.getPopupMenuOrigin, where the correct screen is still known.  The
resulting location may still not be final, as the menu's height needs to
be taken into account as well, but that's exactly what
JPopupMenu.adjustPopupLocationToFitScreen does.  Since the coordinate is
on the correct screen now, it fits the menu into the same screen, which
guarantees it'll be the correct one.
@stachenov stachenov force-pushed the JDK-6415065-Popup-menu-multiple-monitor-bug branch from 878c01b to 3fb94a6 Compare August 10, 2023 11:20
@openjdk
Copy link

openjdk bot commented Aug 10, 2023

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

@stachenov
Copy link
Author

OK, sorry about force-pushing, just followed the usual GitHub procedure that I'm used to. Didn't know local specifics.

@bridgekeeper bridgekeeper bot removed oca Needs verification of OCA signatory status oca-verify Needs verification of OCA signatory status labels Aug 16, 2023
@openjdk openjdk bot added the rfr Pull request is ready for review label Aug 16, 2023
@mlbridge
Copy link

mlbridge bot commented Aug 16, 2023

Webrevs

@bridgekeeper
Copy link

bridgekeeper bot commented Sep 13, 2023

@stachenov This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

@stachenov
Copy link
Author

Any news on this? The bot warns me that it'll be closed if there's no activity, but I don't understand what I can do here.

Copy link
Contributor

@prrace prrace left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks reasonable to me. Clearly what's seen in the JB tracker is odd ..

@openjdk
Copy link

openjdk bot commented Sep 20, 2023

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

6415065: Submenu is shown on wrong screen in multiple monitor environment

Reviewed-by: prr

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

  • 54028e7: 8316562: serviceability/sa/jmap-hprof/JMapHProfLargeHeapTest.java times out after JDK-8314829
  • 7c991cc: 8296246: Update Unicode Data Files to Version 15.1.0
  • a021dbc: 8316149: Open source several Swing JTree JViewport KeyboardManager tests
  • 455cfae: 8315880: change LockingMode default from LM_LEGACY to LM_LIGHTWEIGHT
  • 9e00949: 8316427: Duplicated code for {obj,type}ArrayKlass::array_klass
  • c43ebd3: 8315981: Opensource five more random Swing tests
  • e30e356: 8316461: Fix: make test outputs TEST SUCCESS after unsuccessful exit
  • 242eeae: 8286757: adlc tries to build with /pathmap but without /experimental:deterministic
  • b275bdd: 8308995: Update Network IO JFR events to be static mirror events
  • e1870d3: 8316411: compiler/compilercontrol/TestConflictInlineCommands.java fails intermittent with force inline by CompileCommand missing
  • ... and 539 more: https://git.openjdk.org/jdk/compare/87b08b6e0192d88025c2275c7dd2c4bdecda58e8...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 (@prrace) 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).

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Sep 20, 2023
@stachenov
Copy link
Author

/integrate

@openjdk openjdk bot added the sponsor Pull request is ready to be sponsored label Sep 20, 2023
@openjdk
Copy link

openjdk bot commented Sep 20, 2023

@stachenov
Your change (at version 3fb94a6) is now ready to be sponsored by a Committer.

@avu
Copy link
Contributor

avu commented Sep 21, 2023

/sponsor

@openjdk
Copy link

openjdk bot commented Sep 21, 2023

Going to push as commit 23ed890.
Since your change was applied there have been 561 commits pushed to the master branch:

  • ca47f5f: 8316105: C2: Back to back Parse Predicates from different loops but with same deopt reason are wrongly grouped together
  • 1749ba2: 8311084: Add typeSymbol() API for applicable constant pool entries
  • 9f5d2b9: 8316285: Opensource JButton manual tests
  • a35e96a: 8313612: Use JUnit in lib-test/jdk tests
  • bee7524: 8315786: [AIX] Build Disk Local Detection Issue with GNU-utils df on AIX
  • ceff47b: 8315082: [REDO] Generational ZGC: Tests crash with assert(index == 0 || is_power_of_2(index))
  • df4a25b: 8308762: Metaspace leak with Instrumentation.retransform
  • 8412479: 8316229: Enhance class initialization logging
  • c04c9ea: 8316627: JViewport Test headless failure
  • 5cacf21: 8316156: ByteArrayInputStream.transferTo causes MaxDirectMemorySize overflow
  • ... and 551 more: https://git.openjdk.org/jdk/compare/87b08b6e0192d88025c2275c7dd2c4bdecda58e8...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Sep 21, 2023
@openjdk openjdk bot closed this Sep 21, 2023
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Sep 21, 2023
@openjdk openjdk bot removed the sponsor Pull request is ready to be sponsored label Sep 21, 2023
@openjdk
Copy link

openjdk bot commented Sep 21, 2023

@avu @stachenov Pushed as commit 23ed890.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

client client-libs-dev@openjdk.org integrated Pull request has been integrated

Development

Successfully merging this pull request may close these issues.

4 participants