Skip to content

8357598: Toolkit.removeAWTEventListener should handle null listener in AWTEventListenerProxy #25401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from

Conversation

mrserb
Copy link
Member

@mrserb mrserb commented May 22, 2025

The issue was found here: #24692 (comment)

AWTEventListener and AWTEventListenerProxy are public classes and there's no assertion that EventListenerProxy.getListener() will always return a non-null value. So removeAWTEventListener method should fetch the listener from the proxy and check it for null similar to how it is implemented in addAWTEventListener. Currently, it works fine because we never insert null values into the map. So it is just a code clarification.

One of the test is updated just to touch that codepath.


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-8357598: Toolkit.removeAWTEventListener should handle null listener in AWTEventListenerProxy (Bug - P4)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 25401

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

Using diff file

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

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented May 22, 2025

👋 Welcome back serb! 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
Copy link

openjdk bot commented May 22, 2025

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

8357598: Toolkit.removeAWTEventListener should handle null listener in AWTEventListenerProxy

Reviewed-by: aivanov, dnguyen

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

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.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk
Copy link

openjdk bot commented May 22, 2025

@mrserb The following labels will be automatically applied to this pull request:

  • client
  • i18n

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

System.out.println("Do not test for XAWT Toolkit.");
System.out.println("Passing automatically.");
return;
}

Copy link
Member Author

Choose a reason for hiding this comment

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

I do not know why it was disabled on XToolkit, seems to work fine.

@mrserb mrserb marked this pull request as ready for review May 25, 2025 07:51
@openjdk openjdk bot added the rfr Pull request is ready for review label May 25, 2025
@mlbridge
Copy link

mlbridge bot commented May 25, 2025

Webrevs

Copy link
Member

@aivanov-jdk aivanov-jdk left a comment

Choose a reason for hiding this comment

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

Looks good.

I'll submit a test job.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label May 27, 2025
@openjdk openjdk bot removed the ready Pull request is ready to be integrated label May 27, 2025
@mrserb mrserb requested a review from aivanov-jdk May 29, 2025 08:34
Copy link
Contributor

@DamonGuy DamonGuy left a comment

Choose a reason for hiding this comment

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

LGTM. Ran a test job myself and everything looks good.

private static void verify(Toolkit tk, int expected) {
AWTEventListener[] array = tk.getAWTEventListeners();
if (array == null || array.length != expected) {
System.out.println("[Simple test failed!!]");
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this print statement is required?

Copy link
Member

Choose a reason for hiding this comment

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

Probably not, but it follows the common pattern in the test.

@@ -23,7 +23,7 @@

/*
Copy link
Contributor

@TejeshR13 TejeshR13 May 30, 2025

Choose a reason for hiding this comment

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

Suggested change
/*
/*
* @test
* @bug 4290704 8357598
* @summary Test use of AWTEventListenerProxyTest class
*/

Most of the test follow this pattern for jtreg tags. It would be good if you use it too for code consistency.

Copy link
Member

Choose a reason for hiding this comment

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

Not required, but can be updated…

@openjdk openjdk bot added the ready Pull request is ready to be integrated label May 30, 2025
@mrserb
Copy link
Member Author

mrserb commented May 31, 2025

/integrate

@openjdk
Copy link

openjdk bot commented May 31, 2025

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

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label May 31, 2025
@openjdk openjdk bot closed this May 31, 2025
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels May 31, 2025
@openjdk
Copy link

openjdk bot commented May 31, 2025

@mrserb Pushed as commit 3a3ea7e.

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

@mrserb mrserb deleted the JDK-8357598 branch May 31, 2025 07:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

4 participants