8316017: Refactor timeout handler in PassFailJFrame #15668

aivanov-jdk · 2023-09-11T18:18:28Z

Refactored timeout handling in PassFailJFrame:

Managing the timer and formatting the time left is inside TimeoutHandler class.
The class handles timer events and updates the label accordingly.

This is implemented on top of #15665.

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-8316017: Refactor timeout handler in PassFailJFrame (Bug - P4)

Reviewers

Phil Race (@prrace - Reviewer) ⚠️ Review applies to 39ebc7c8

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 15668

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

Using diff file

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

Webrev

Link to Webrev Comment

Instructions for FileChooserSymLinkTest are rendered in HTML.

Each text component (JTextArea or JEditorPane) are configured in its own dedicated method. This avoids unnecessary type casts.

It reverts the accidental change where I unwrapped call to createUI

Moved it to a named class, saved the instance in a field. It's to be used with test windows.

The Builder now provides a method to create test UI, PassFailJFrame automatically invokes the method reference on the EDT and then shows both the instruction frame and the test window.

Also clean up the doc for disposeWindows().

The WindowClosingHandler is used both for the instruction frame and for test UI windows. Also add blank lines to separate different parts of the class.

It's not supposed to be extended.

bridgekeeper · 2023-09-11T18:20:24Z

👋 Welcome back aivanov! A progress list of the required criteria for merging this PR into pr/15665 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-09-11T18:21:55Z

@aivanov-jdk 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.

mlbridge · 2023-09-11T18:25:58Z

Webrevs

lawrence-andrew · 2023-09-12T00:42:38Z

Looks good to me.

prrace · 2023-09-19T18:35:12Z

test/jdk/java/awt/regtesthelpers/PassFailJFrame.java

+            if ((leftTime < 0) || failed) {
+                timer.stop();
+                testFailedReason = FAILURE_REASON
+                                   + "Timeout User did not perform testing.";


If the test was explicitly failed by the user (ie failed==true), why does the reason say that there was a time out ?

Huh, it's a good question. I didn't notice it. It's the original code that I moved into a dedicated class.

It shouldn't change the failure reason if it's already set.

The timer isn't stopped in handlers for the failure, so it's possible that timer changes it. We should also stop the timer explicitly when failure or success is handled.

@prrace Eventually, I refactored handling of failureReason. I removed failed and timeout fields; the failureReason is set via a synchronised method to ensure there cannot be data race. If failureReason is not null, the test fails. After failureReason is set to a non-null value, it cannot be changed.

The timeout handler relies on this behaviour: it calls setFailureReason unconditionally; if failureReason is already set, the timeout reason is ignored.

bridgekeeper · 2023-10-18T02:19:38Z

@aivanov-jdk 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!

Ensure the failure reason doesn't change after it's set. Removed 'failed' and 'timeout' fields: if failureReason is set, the test fails.

openjdk-notifier · 2023-10-25T11:36:55Z

The parent pull request that this pull request depends on has now been integrated and the target branch of this pull request has been updated. This means that changes from the dependent pull request can start to show up as belonging to this pull request, which may be confusing for reviewers. To remedy this situation, simply merge the latest changes from the new target branch into this pull request by running commands similar to these in the local repository for your personal fork:

git checkout 8316017-timeout-PassFail
git fetch https://git.openjdk.org/jdk.git master
git merge FETCH_HEAD
# if there are conflicts, follow the instructions given by git merge
git commit -m "Merge master"
git push

openjdk · 2023-10-25T11:39:02Z

@aivanov-jdk this pull request can not be integrated into master due to one or more merge conflicts. To resolve these merge conflicts and update this pull request you can run the following commands in the local repository for your personal fork:

git checkout 8316017-timeout-PassFail
git fetch https://git.openjdk.org/jdk.git master
git merge FETCH_HEAD
# resolve conflicts and follow the instructions given by git merge
git commit -m "Merge master"
git push

openjdk · 2023-10-25T12:39:42Z

@aivanov-jdk 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:

8316017: Refactor timeout handler in PassFailJFrame

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

aivanov-jdk · 2023-10-25T13:24:23Z

/integrate

openjdk · 2023-10-25T13:25:37Z

Going to push as commit 3abd772.
Since your change was applied there has been 1 commit pushed to the master branch:

202c013: 8318669: Target OS detection in 'test-prebuilt' makefile target is incorrect when running on MSYS2

Your commit was automatically rebased without conflicts.

openjdk · 2023-10-25T13:25:44Z

@aivanov-jdk Pushed as commit 3abd772.

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

aivanov-jdk added 14 commits September 11, 2023 12:08

Enable HTML display if instructions start with <html>

0d5343a

Instructions for FileChooserSymLinkTest are rendered in HTML.

Improve instruction formatting

db08cfc

Refactor configuration of a text component for instructions

80fec8a

Each text component (JTextArea or JEditorPane) are configured in its own dedicated method. This avoids unnecessary type casts.

Revert changes to FileChooserSymLinkTest.java

7753b3f

Wrap createUI call

c388d73

It reverts the accidental change where I unwrapped call to createUI

Refactor windowClosing listener

b78c62b

Moved it to a named class, saved the instance in a field. It's to be used with test windows.

Build functional test UI

3fc976d

The Builder now provides a method to create test UI, PassFailJFrame automatically invokes the method reference on the EDT and then shows both the instruction frame and the test window.

Use statically imported invokeAndWait and isEDT

338416f

Use functional style for disposing of windows

fd5689b

Also clean up the doc for disposeWindows().

Use invokeOnEDT in getInstructionFrameBounds

bdfc39d

Amend message in window closing handler

62a477e

The WindowClosingHandler is used both for the instruction frame and for test UI windows. Also add blank lines to separate different parts of the class.

Mark the Builder class final

37a8489

It's not supposed to be extended.

Remove trailing whitespace

70256b6

8316017: Refactor timeout handler in PassFailJFrame

27f3973

openjdk bot added the rfr Pull request is ready for review label Sep 11, 2023

openjdk bot added the client client-libs-dev@openjdk.org label Sep 11, 2023

prrace reviewed Sep 19, 2023

View reviewed changes

Refactor failure reason

39ebc7c

Ensure the failure reason doesn't change after it's set. Removed 'failed' and 'timeout' fields: if failureReason is set, the test fails.

prrace approved these changes Oct 24, 2023

View reviewed changes

openjdk-notifier bot changed the base branch from pr/15665 to master October 25, 2023 11:36

openjdk bot added the merge-conflict Pull request has merge conflict with target branch label Oct 25, 2023

Merge master

f590891

openjdk bot added ready Pull request is ready to be integrated and removed merge-conflict Pull request has merge conflict with target branch labels Oct 25, 2023

openjdk bot added the integrated Pull request has been integrated label Oct 25, 2023

openjdk bot closed this Oct 25, 2023

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Oct 25, 2023

aivanov-jdk deleted the 8316017-timeout-PassFail branch October 25, 2023 13:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

8316017: Refactor timeout handler in PassFailJFrame #15668

8316017: Refactor timeout handler in PassFailJFrame #15668

Uh oh!

aivanov-jdk commented Sep 11, 2023 •

edited by openjdk bot

Loading

Uh oh!

bridgekeeper bot commented Sep 11, 2023

Uh oh!

openjdk bot commented Sep 11, 2023

Uh oh!

mlbridge bot commented Sep 11, 2023 •

edited

Loading

Uh oh!

lawrence-andrew commented Sep 12, 2023

Uh oh!

prrace Sep 19, 2023

Uh oh!

aivanov-jdk Sep 19, 2023

Uh oh!

aivanov-jdk Oct 24, 2023

Uh oh!

bridgekeeper bot commented Oct 18, 2023

Uh oh!

openjdk-notifier bot commented Oct 25, 2023

Uh oh!

openjdk bot commented Oct 25, 2023

Uh oh!

openjdk bot commented Oct 25, 2023

Uh oh!

aivanov-jdk commented Oct 25, 2023

Uh oh!

openjdk bot commented Oct 25, 2023

Uh oh!

openjdk bot commented Oct 25, 2023

Uh oh!

Uh oh!

8316017: Refactor timeout handler in PassFailJFrame #15668

8316017: Refactor timeout handler in PassFailJFrame #15668

Uh oh!

Conversation

aivanov-jdk commented Sep 11, 2023 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Webrev

Uh oh!

bridgekeeper bot commented Sep 11, 2023

Uh oh!

openjdk bot commented Sep 11, 2023

Uh oh!

mlbridge bot commented Sep 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

lawrence-andrew commented Sep 12, 2023

Uh oh!

prrace Sep 19, 2023

Choose a reason for hiding this comment

Uh oh!

aivanov-jdk Sep 19, 2023

Choose a reason for hiding this comment

Uh oh!

aivanov-jdk Oct 24, 2023

Choose a reason for hiding this comment

Uh oh!

bridgekeeper bot commented Oct 18, 2023

Uh oh!

openjdk-notifier bot commented Oct 25, 2023

Uh oh!

openjdk bot commented Oct 25, 2023

Uh oh!

openjdk bot commented Oct 25, 2023

Uh oh!

aivanov-jdk commented Oct 25, 2023

Uh oh!

openjdk bot commented Oct 25, 2023

Uh oh!

openjdk bot commented Oct 25, 2023

Uh oh!

Uh oh!

aivanov-jdk commented Sep 11, 2023 •

edited by openjdk bot

Loading

mlbridge bot commented Sep 11, 2023 •

edited

Loading