8277122: SplitPane divider drag can hang the layout #669

Maran23 · 2021-11-15T14:34:04Z

When a divider is moved via drag or code it will call requestLayout() for the SplitPane.
While this is fine, it is also called when the SplitPaneSkin#layoutChildren(..) method is repositioning the divider.

This makes no sense since we are currently layouting everything, so we don't need to request it again. (The divider positioning is the first part of layoutChildren(..). In the second part the SplitPane content is layouted based off those positions)

-> With this behaviour the layout may hang under some conditions (check attached source). The problem is that the requestLayout() will mark the SplitPane dirty but won't propagate to the parent since the SplitPane is currently doing a layout.

This PR fixes this by not requesting layout when we are currently doing it (and thus repositioning the dividers as part of it).

Note: I also fixed a simple typo of a private method in SplitPaneSkin:
initializeDivderEventHandlers -> initializeDividerEventHandlers

Progress

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

Issue

JDK-8277122: SplitPane divider drag can hang the layout

Reviewers

Jeanette Winzenburg (@kleopatra - Reviewer)
Ajit Ghaisas (@aghaisas - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jfx pull/669/head:pull/669
$ git checkout pull/669

Update a local copy of the PR:
$ git checkout pull/669
$ git pull https://git.openjdk.java.net/jfx pull/669/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 669

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jfx/pull/669.diff

bridgekeeper · 2021-11-15T14:35:11Z

👋 Welcome back mhanl! 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.

mlbridge · 2021-11-15T14:38:58Z

Webrevs

kleopatra · 2021-11-19T12:39:23Z

interesting issue - and fix :) Verified the mis-behaviour before the fix and its working after.

Wondering, though (read: I don't understand 😀)

why the layout details in the splitpane hinders the visual update of a completely unrelated component (like the combo)?
why does it only happen on increasing the divider pos, not on decreasing?

As to the test: would prefer to also see a test of the fixed effect (vs. the fix implementation of not re-entering layout) - might be a bit tricky, though.

Maran23 · 2021-11-20T20:00:12Z

interesting issue - and fix :) Verified the mis-behaviour before the fix and its working after.

Wondering, though (read: I don't understand 😀)

why the layout details in the splitpane hinders the visual update of a completely unrelated component (like the combo)?

why does it only happen on increasing the divider pos, not on decreasing?

As to the test: would prefer to also see a test of the fixed effect (vs. the fix implementation of not re-entering layout) - might be a bit tricky, though.

the ComboBox is a child of the SplitPane, so therefore it is affected by the invalid layout state of the SplitPane.
-> With that said, is doesn't need to be a ComboBox but can also be another SplitPane(divider drag won't work), TableView(scroll won't work), TitledPane(the collapse/expand won't work) and probably other controls as well.
it can also happen when decreasing, it might be that you need to set the min width to 0 of the left content of the SplitPane.
-> The bug is only happening if you start drag the divider 'out of bounds', when the drag starts to have no effect since the divider is already at the min/max position. The layout code whoever will in t his case adjust the divider a second time since it would now be out of bounds, which will result in this bug.

Do you mean something like checking the ComboBox display text?

EDIT: I added another test for decreasing the divider position to a negatiave number. :)

…d readability

aghaisas · 2021-11-26T09:19:40Z

/reviewers 2

openjdk · 2021-11-26T09:20:47Z

@aghaisas
The number of required reviews for this PR is now set to 2 (with at least 1 of role reviewers).

kleopatra

fix looks good (though it feels a bit upside down that it is needed ;) - verified example/tests failing/passing before/after fixing

left minor inline comments (just to make it easier to understand :)

modules/javafx.controls/src/main/java/javafx/scene/control/skin/SplitPaneSkin.java

modules/javafx.controls/src/test/java/test/javafx/scene/control/SplitPaneTest.java

kleopatra · 2022-01-25T13:45:54Z

modules/javafx.controls/src/test/java/test/javafx/scene/control/SplitPaneTest.java

+        stageLoader.dispose();
+    }


the stageLoader is not disposed if the test fails - a (recently introduced :) general pattern is to use an instance field that's disposed in the test cleanup

Hm, is this really needed? Not sure, are there any side effects by the StageLoader like this when a test failed?
Just asking since the StageLoader is used a lot like this.
And since the tests normally run green unless you may change something locally (on the JavaFX Pipeline it should never be red), it would probably never affect anything (or maybe it does?).

Hm, is this really needed?

yes, IMO, we want the exact same cleanup for passing/failing tests. So either dispose is required always (then need to make sure it's called on failure) or not required always (then all its calls would be noise).

Not sure, are there any side effects by the StageLoader like this when a test failed? Just asking since the StageLoader is used a lot like this.

don't now (and doesn't matter, what matters is the guaranteed cleanup) - and aware of those slightly fishy patterns, we all learn :) Faintly remember having discussed the point in a PR (can't find it right now, though), and just as faintly remember the outcome was to guarantee the cleanup in new tests.

ah okay. Was just confusing for me since I never read that and I think some recent PRs still had this pattern, e.g. also the touch table scrolling PR I had a look at yesterday.

Maybe for future it makes sense to have an abstract test class with the stage loader setup already in place.

just for reference - found the source of my faintly remember

I see. Unfortunately though that was not done consistently during the past PRs.

Done. Also adjusted the copyright year ;)

…o 2022

kleopatra

looks good now :)

aghaisas

The fix looks good. +1.

openjdk · 2022-01-31T12:36:02Z

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

8277122: SplitPane divider drag can hang the layout

Reviewed-by: fastegal, aghaisas

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

78d9227: 8277853: With Touch enabled devices scrollbar disappears and the table is scrolled to the beginning
ae334c5: 8279013: ES2Pipeline fails to detect AMD vega20 graphics card
92b10aa: Merge
c47f18e: 8280280: Update boot JDK to 17.0.2
217e086: 8205915: [macOS] Accelerator assigned to button in dialog fires menuItem in owning stage
94807b6: 8280275: JUnit5 tests using Assumptions API fail to compile in some cases
4c79c54: 8187307: ListView, TableView, TreeView: receives editCancel event when edit is committed
f01c50d: Merge
7a1a19c: 8273998: Clarify specification for Window properties controlled by the window manager
a4c013f: Merge
... and 52 more: https://git.openjdk.java.net/jfx/compare/d122ed00557eeeb823a42e0c5503ab55f754e921...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 (@kleopatra, @aghaisas) 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).

Maran23 · 2022-01-31T14:25:48Z

/integrate

openjdk · 2022-01-31T14:27:36Z

@Maran23
Your change (at version a5f9f50) is now ready to be sponsored by a Committer.

kleopatra · 2022-01-31T14:58:39Z

/sponsor

openjdk · 2022-01-31T15:00:18Z

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

78d9227: 8277853: With Touch enabled devices scrollbar disappears and the table is scrolled to the beginning
ae334c5: 8279013: ES2Pipeline fails to detect AMD vega20 graphics card
92b10aa: Merge
c47f18e: 8280280: Update boot JDK to 17.0.2
217e086: 8205915: [macOS] Accelerator assigned to button in dialog fires menuItem in owning stage
94807b6: 8280275: JUnit5 tests using Assumptions API fail to compile in some cases
4c79c54: 8187307: ListView, TableView, TreeView: receives editCancel event when edit is committed
f01c50d: Merge
7a1a19c: 8273998: Clarify specification for Window properties controlled by the window manager
a4c013f: Merge
... and 52 more: https://git.openjdk.java.net/jfx/compare/d122ed00557eeeb823a42e0c5503ab55f754e921...master

Your commit was automatically rebased without conflicts.

openjdk · 2022-01-31T15:00:51Z

@kleopatra @Maran23 Pushed as commit ee52d14.

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

8277122: SplitPane divider drag can hang the layout

919f5db

openjdk bot added the rfr Ready for review label Nov 15, 2021

kevinrushforth requested a review from aghaisas November 18, 2021 00:28

8277122: Added test for setting a negative divider position + improve…

9db28ff

…d readability

kevinrushforth self-requested a review November 30, 2021 17:33

kleopatra suggested changes Jan 25, 2022

View reviewed changes

Maran23 added 2 commits January 26, 2022 21:01

8277122: Added bug id to the fix and test for future reference

345552d

8277122: Added and used global stageLoader + changed copyright year t…

a5f9f50

…o 2022

kleopatra approved these changes Jan 28, 2022

View reviewed changes

aghaisas approved these changes Jan 31, 2022

View reviewed changes

openjdk bot added the ready Ready to be integrated label Jan 31, 2022

openjdk bot added the sponsor Ready to sponsor label Jan 31, 2022

openjdk bot added the integrated Pull request has been integrated label Jan 31, 2022

openjdk bot closed this Jan 31, 2022

openjdk bot removed ready Ready to be integrated rfr Ready for review sponsor Ready to sponsor labels Jan 31, 2022

Maran23 deleted the jdk-8277122-SplitPane-divider-drag-can-hang-the-layout branch July 5, 2022 20:44

8277122: SplitPane divider drag can hang the layout #669

8277122: SplitPane divider drag can hang the layout #669

Uh oh!

Conversation

Maran23 commented Nov 15, 2021 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Uh oh!

bridgekeeper bot commented Nov 15, 2021

Uh oh!

mlbridge bot commented Nov 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

kleopatra commented Nov 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Maran23 commented Nov 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aghaisas commented Nov 26, 2021

Uh oh!

openjdk bot commented Nov 26, 2021

Uh oh!

kleopatra left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kleopatra Jan 25, 2022

Choose a reason for hiding this comment

Uh oh!

Maran23 Jan 26, 2022

Choose a reason for hiding this comment

Uh oh!

kleopatra Jan 27, 2022

Choose a reason for hiding this comment

Uh oh!

Maran23 Jan 27, 2022

Choose a reason for hiding this comment

Uh oh!

kleopatra Jan 27, 2022

Choose a reason for hiding this comment

Uh oh!

Maran23 Jan 27, 2022

Choose a reason for hiding this comment

Uh oh!

Maran23 Jan 27, 2022

Choose a reason for hiding this comment

Uh oh!

kleopatra left a comment

Choose a reason for hiding this comment

Uh oh!

aghaisas left a comment

Choose a reason for hiding this comment

Uh oh!

openjdk bot commented Jan 31, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Maran23 commented Jan 31, 2022

Uh oh!

openjdk bot commented Jan 31, 2022

Uh oh!

kleopatra commented Jan 31, 2022

Uh oh!

openjdk bot commented Jan 31, 2022

Uh oh!

openjdk bot commented Jan 31, 2022

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

Maran23 commented Nov 15, 2021 •

edited by openjdk bot

Loading

mlbridge bot commented Nov 15, 2021 •

edited

Loading

kleopatra commented Nov 19, 2021 •

edited

Loading

Maran23 commented Nov 20, 2021 •

edited

Loading

openjdk bot commented Jan 31, 2022 •

edited

Loading