8350048: Enforce threading restrictions for show and hide methods in Window, Control, and Skin #1717

andy-goryachev-oracle · 2025-02-19T20:39:19Z

enforced fx application thread
clarify doc where an IllegalStateException can get thrown, such as hide() and show()
clarified ComboBoxBase::show
added a headful test TestThreadingRestrictions

Progress

Change must not contain extraneous whitespace
Commit message must refer to an issue
Change requires CSR request JDK-8350962 to be approved
Change must be properly reviewed (2 reviews required, with at least 2 Reviewers)

Issues

JDK-8350048: Enforce threading restrictions for show and hide methods in Window, Control, and Skin (Bug - P3)
JDK-8350962: Enforce threading restrictions for show and hide methods in Window, Control, and Skin (CSR)

Reviewers

Kevin Rushforth (@kevinrushforth - Reviewer)
Michael Strauß (@mstr2 - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 1717

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jfx/pull/1717.diff

Using Webrev

Link to Webrev Comment

bridgekeeper · 2025-02-19T20:39:37Z

👋 Welcome back angorya! 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 · 2025-02-19T20:40:08Z

@andy-goryachev-oracle 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:

8350048: Enforce threading restrictions for show and hide methods in Window, Control, and Skin

Reviewed-by: kcr, mstrauss

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 no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential 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.

kevinrushforth · 2025-02-19T20:50:58Z

/reviewers 2 reviewers
/csr

openjdk · 2025-02-19T20:51:21Z

@kevinrushforth
The total number of required reviews for this PR (including the jcheck configuration and the last /reviewers command) is now set to 2 (with at least 2 Reviewers).

openjdk · 2025-02-19T20:51:56Z

@kevinrushforth has indicated that a compatibility and specification (CSR) request is needed for this pull request.

@andy-goryachev-oracle please create a CSR request for issue JDK-8350048 with the correct fix version. This pull request cannot be integrated until the CSR request is approved.

mlbridge · 2025-02-20T22:51:11Z

Webrevs

kevinrushforth · 2025-02-24T15:07:01Z

Reviewers: @kevinrushforth @arapte

kevinrushforth

The API doc changes look good, although I noted a couple additional changes that are needed.

The API docs for Dialog::hide should also be documented to throw ISE (since it calls close() directly the implementation is fine)

The API docs for Stage::close should also be documented to throw ISE (since it calls hide() directly the implementation is fine)

For ComboBoxBase, were you going to get rid of the word "aspect" in the opening sentence "... display the popup aspect of the user interface."? I think that's a little awkward even with that word removed. Maybe it could just be: "... display the popup associated with this control."

As for the implementation, There are a few places where the skin will call hide(), and I can't tell by just looking at the code that they are all guaranteed to be on the FX app thread.

For example, I recommend checking the following:

MenuBarSkin line 799
ComboBoxListViewSkin line 199

There may be others.

kevinrushforth · 2025-02-25T19:11:41Z

tests/system/src/test/java/test/robot/javafx/scene/TestThreadingRestrictions.java

+ *
+ * This test ensures that the threading restrictions are in place where required.
+ */
+@TestMethodOrder(MethodOrderer.MethodName.class)


This is unnecessary (and not a usual practice).

kevinrushforth · 2025-02-25T19:25:11Z

tests/system/src/test/java/test/robot/javafx/scene/TestThreadingRestrictions.java

+
+        test(TPopupWindow::new, (p) -> p.show(stage));
+        test(TPopupWindow::new, (p) -> p.show(stage, 0, 0));
+        test(TPopupWindow::new, (p) -> p.show(contentPane, 0, 0));


It's probably worth adding a test for hide when it isn't showing (like you've done for other objects).

kevinrushforth · 2025-02-25T19:26:36Z

tests/system/src/test/java/test/robot/javafx/scene/TestThreadingRestrictions.java

+            Util.runAndWait(() -> {
+                p.show();
+            });
+            p.hide(); // do we need to fail early here, or only when showing?


We should fail early (although this comment seems misplaced, since it is the case where it is showing).

kevinrushforth · 2025-02-25T19:26:58Z

tests/system/src/test/java/test/robot/javafx/scene/TestThreadingRestrictions.java

+    }
+
+    @Test
+    @Timeout(value = 1, unit = TimeUnit.DAYS)


Um, 1 DAY???

Seriously, though: Remove the timeout (it isn't needed or wanted).

checked in by mistake

arapte · 2025-02-27T07:43:59Z

modules/javafx.controls/src/main/java/javafx/scene/control/ChoiceBox.java

    public void show() {
-        if (!isDisabled()) setShowing(true);
+        Toolkit.getToolkit().checkFxUserThread();
+        if (!isDisabled()) {
+            setShowing(true);
+        }
    }


Would it be a good idea to move the check Toolkit.getToolkit().checkFxUserThread(); to a new method show() in Parent class Control? And may be similarly to Parent classes of other classes.

No, we don't want to add a new public show method to Control since it is only a very few controls that have the concept of showing a popup.

andy-goryachev-oracle · 2025-02-27T15:53:34Z

For example, I recommend checking the following:
MenuBarSkin line 799
ComboBoxListViewSkin line 199

I think it should be sufficient to mention the exception in the actual methods where the check is done, such as hide() and show().

kevinrushforth · 2025-02-28T15:33:13Z

For example, I recommend checking the following:
MenuBarSkin line 799
ComboBoxListViewSkin line 199

I think it should be sufficient to mention the exception in the actual methods where the check is done, such as hide() and show().

I'm not talking about docs here. What I meant that if the code in question is ever executed on a background thread such that hide is called, this will now cause an exception at runtime. I don't know whether it is possible, but it isn't immediately obvious that this can't happen on a background thread -- at least not for the two cases I mentioned. In fact, I'm pretty sure that at least the second case (ComboBoxListViewSkin line 199) is possible.

        lh.addInvalidationListener(comboBox.sceneProperty(), (o) -> {
            if (((ObservableValue)o).getValue() == null) {
                comboBox.hide();
            }
        });

I suspect that the following sequence of operations, all on a background thread, will trigger the exception:

Create a ComboBox
Create a Skin
Add the combobox to a Scene (the scene must not be showing, of course)

A solution might be to check whether the combobox is showing before hiding it.

        lh.addInvalidationListener(comboBox.sceneProperty(), (o) -> {
            if (((ObservableValue)o).getValue() == null) {
                if (comboBox.isShowing()) {
                    comboBox.hide();
                }
            }
        });

And, if the code in MenuBarSkin is a problem, then something like this might be in order:

            if (menuButton.isShowing()) {
                menuButton.hide();
            }

Similarly, I think this listener in MenuBarSkin::rebuildUI (starting on line 913) might need a check before calling menuButton.hide():

            menuButton.menuListener = (observable, oldValue, newValue) -> {
                if (menu.isShowing()) {
                    menuButton.show();
                    menuModeStart(container.getChildren().indexOf(menuButton));
                } else {
                    menuButton.hide();     // <--  check if (menuButton.isShowing()) before calling
                }
            };

kevinrushforth · 2025-02-28T15:34:37Z

The updated docs look good. Go ahead and create the CSR.

andy-goryachev-oracle · 2025-02-28T16:13:20Z

created CSR https://bugs.openjdk.org/browse/JDK-8350962

andy-goryachev-oracle · 2025-02-28T19:26:08Z

MenuBarSkin line 799
ComboBoxListViewSkin line 199

ComboBoxListViewSkin - thanks for the suggestion!

MenuBarSkin - is a bit more complex case because of the interaction with the system menu Toolkit.getToolkit().getSystemMenu().isSupported() which needs to be called from the FX application thread.

We probably should disallow creating MenuBars in background thread (similar to Window, WebView, and HtmlEditor) in the constructor. What do you think?

andy-goryachev-oracle · 2025-02-28T22:55:45Z

Created https://bugs.openjdk.org/browse/JDK-8350976 for the MenuBarSkin.

kevinrushforth

All looks good now.

Have you done a headful test run?

andy-goryachev-oracle · 2025-03-04T20:02:08Z

Have you done a headful test run?

combined branch (this PR + #1697 + #1727) is green on all platforms except for a single unrelated failure on linux:

RegionBackgroundFillUITest > testScenario1() FAILED

mstr2 · 2025-03-07T13:54:45Z

modules/javafx.graphics/src/main/java/javafx/stage/Stage.java

@@ -1183,6 +1183,8 @@ public void toBack() {
    /**
     * Closes this {@code Stage}.
     * This call is equivalent to {@code hide()}.
+     * @throws IllegalStateException if this method is called on a thread
+     * other than the JavaFX Application Thread.


Minor: add a blank line before @throws. I also think it's easier to read docs when multi-line text for a javadoc tag is indented, either by four spaces or lined up with the beginning of the first line of text (i.e. with the beginning of IllegalStateException).

good idea, even though it does not affect generated javadoc.
will do next time, to avoid re-setting the approvals ;-)

will do next time, to avoid re-setting the approvals ;-)

I'll re-approve if you decide to do the changes anyway.

it is not required, and the code is inconsistent (Stage:472) ... but ok.

Can you do it for the other changed docs also?

The general policy is to avoid unrelated changes and expanding the scope.

A proper way to address that would be to create a JBS and do a wholesale bulk edit, not sure if it's worth it though.

You've added the same javadoc tag in 20 different places. All I'm asking is that you do the change that you did in this particular place in all of the other places too.

I misunderstood, sorry. Done.

andy-goryachev-oracle · 2025-03-10T14:17:52Z

/integrate

openjdk · 2025-03-10T14:19:38Z

Going to push as commit b5f76ad.

openjdk · 2025-03-10T14:19:48Z

@andy-goryachev-oracle Pushed as commit b5f76ad.

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

initial test

27da34d

openjdk bot added the csr Need approved CSR to integrate pull request label Feb 19, 2025

andy-goryachev-oracle added 2 commits February 19, 2025 14:55

all tests

f30ca97

fixed node init test

021fddd

andy-goryachev-oracle marked this pull request as ready for review February 20, 2025 22:46

openjdk bot added the rfr Ready for review label Feb 20, 2025

This was referenced Feb 20, 2025

8349750: [TestBug] NodeInitializationStressTest: remaining Nodes #1713

Closed

8349091: Charts: exception initializing in a background thread #1697

Closed

kevinrushforth requested review from kevinrushforth and arapte February 24, 2025 15:07

kevinrushforth reviewed Feb 25, 2025

View reviewed changes

Merge remote-tracking branch 'origin/master' into 8350048.enforce

db92109

arapte reviewed Feb 27, 2025

View reviewed changes

review comments

7d8ef4e

review comments

b6afe88

kevinrushforth requested review from kevinrushforth and arapte March 3, 2025 14:30

kevinrushforth approved these changes Mar 4, 2025

View reviewed changes

openjdk bot removed the csr Need approved CSR to integrate pull request label Mar 4, 2025

Merge remote-tracking branch 'origin/master' into 8350048.enforce

3473e15

mstr2 reviewed Mar 7, 2025

View reviewed changes

mstr2 approved these changes Mar 7, 2025

View reviewed changes

openjdk bot added the ready Ready to be integrated label Mar 7, 2025

andy-goryachev-oracle added 2 commits March 7, 2025 07:41

Merge remote-tracking branch 'origin/master' into 8350048.enforce

b76e60b

indent

2f2caa3

openjdk bot removed the ready Ready to be integrated label Mar 7, 2025

andy-goryachev-oracle requested review from mstr2 and kevinrushforth March 7, 2025 15:45

andy-goryachev-oracle added 2 commits March 7, 2025 09:50

indent

fcdcb8a

indent

8663425

mstr2 approved these changes Mar 7, 2025

View reviewed changes

kevinrushforth approved these changes Mar 10, 2025

View reviewed changes

openjdk bot added the ready Ready to be integrated label Mar 10, 2025

openjdk bot added the integrated Pull request has been integrated label Mar 10, 2025

openjdk bot closed this Mar 10, 2025

openjdk bot removed ready Ready to be integrated rfr Ready for review labels Mar 10, 2025

andy-goryachev-oracle deleted the 8350048.enforce branch March 10, 2025 14:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8350048: Enforce threading restrictions for show and hide methods in Window, Control, and Skin #1717

8350048: Enforce threading restrictions for show and hide methods in Window, Control, and Skin #1717

andy-goryachev-oracle commented Feb 19, 2025 •

edited by openjdk bot

Loading

bridgekeeper bot commented Feb 19, 2025

openjdk bot commented Feb 19, 2025 •

edited

Loading

kevinrushforth commented Feb 19, 2025

openjdk bot commented Feb 19, 2025

openjdk bot commented Feb 19, 2025

mlbridge bot commented Feb 20, 2025 •

edited

Loading

kevinrushforth commented Feb 24, 2025

kevinrushforth left a comment

kevinrushforth Feb 25, 2025

kevinrushforth Feb 25, 2025

kevinrushforth Feb 25, 2025

kevinrushforth Feb 25, 2025

andy-goryachev-oracle Feb 27, 2025

arapte Feb 27, 2025

kevinrushforth Feb 27, 2025

andy-goryachev-oracle commented Feb 27, 2025

kevinrushforth commented Feb 28, 2025

kevinrushforth commented Feb 28, 2025

andy-goryachev-oracle commented Feb 28, 2025

andy-goryachev-oracle commented Feb 28, 2025

andy-goryachev-oracle commented Feb 28, 2025

kevinrushforth left a comment

andy-goryachev-oracle commented Mar 4, 2025

mstr2 Mar 7, 2025

andy-goryachev-oracle Mar 7, 2025

mstr2 Mar 7, 2025

andy-goryachev-oracle Mar 7, 2025

mstr2 Mar 7, 2025

andy-goryachev-oracle Mar 7, 2025

mstr2 Mar 7, 2025

andy-goryachev-oracle Mar 7, 2025

andy-goryachev-oracle commented Mar 10, 2025

openjdk bot commented Mar 10, 2025

openjdk bot commented Mar 10, 2025

8350048: Enforce threading restrictions for show and hide methods in Window, Control, and Skin #1717

8350048: Enforce threading restrictions for show and hide methods in Window, Control, and Skin #1717

Conversation

andy-goryachev-oracle commented Feb 19, 2025 • edited by openjdk bot Loading

Progress

Issues

Reviewers

Reviewing

bridgekeeper bot commented Feb 19, 2025

openjdk bot commented Feb 19, 2025 • edited Loading

kevinrushforth commented Feb 19, 2025

openjdk bot commented Feb 19, 2025

openjdk bot commented Feb 19, 2025

mlbridge bot commented Feb 20, 2025 • edited Loading

Webrevs

kevinrushforth commented Feb 24, 2025

kevinrushforth left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andy-goryachev-oracle commented Feb 27, 2025

kevinrushforth commented Feb 28, 2025

kevinrushforth commented Feb 28, 2025

andy-goryachev-oracle commented Feb 28, 2025

andy-goryachev-oracle commented Feb 28, 2025

andy-goryachev-oracle commented Feb 28, 2025

kevinrushforth left a comment

Choose a reason for hiding this comment

andy-goryachev-oracle commented Mar 4, 2025

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

Choose a reason for hiding this comment

andy-goryachev-oracle commented Mar 10, 2025

openjdk bot commented Mar 10, 2025

openjdk bot commented Mar 10, 2025

andy-goryachev-oracle commented Feb 19, 2025 •

edited by openjdk bot

Loading

openjdk bot commented Feb 19, 2025 •

edited

Loading

mlbridge bot commented Feb 20, 2025 •

edited

Loading