8365086: CookieStore.getURIs() and get(URI) should return an immutable List #26698

jaikiran · 2025-08-08T13:28:50Z

Can I please get a review of this change which proposes to address the issue noted in https://bugs.openjdk.org/browse/JDK-8365086?

java.net.CookieStore has some APIs which return a java.util.List. These API are specified to return an immutable List. The JDK ships an implementation of the CookieStore - the java.net.InMemoryCookieStore. The implementations of the getURIs() and get(URI) methods in the InMemoryCookieStore currently return a List which is modifiable.

The changes in this PR fix those two method to return an immutable List to match the specification. A new regression test has been introduced to reproduce the issue and verify the fix.

I think this may not require a CSR since this fixes the implementation to match the already existing specification in CookieStore. I will create one if anyone suggests we should.

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-8365086: CookieStore.getURIs() and get(URI) should return an immutable List (Bug - P3)

Reviewers

Volkan Yazici (@vy - Committer) Review applies to 914fde9a
Daniel Fuchs (@dfuch - Reviewer) Review applies to 7b92b0a6
Chen Liang (@liach - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 26698

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

Using diff file

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

Using Webrev

Link to Webrev Comment

…e List

bridgekeeper · 2025-08-08T13:29:58Z

👋 Welcome back jpai! 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-08-08T13:30:31Z

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

8365086: CookieStore.getURIs() and get(URI) should return an immutable List

Reviewed-by: liach, vyazici, dfuchs

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

f83454c: 8364786: Test java/net/vthread/HttpALot.java intermittently fails - 24999 handled, expected 25000
8ad1fcc: 8364564: Shortcut configuration is not recorded in .jpackage.xml file
c1c0155: 8364129: Rename libwixhelper
... and 1 more: https://git.openjdk.org/jdk/compare/241808e13fb032b0ec192e0b7ff94891a653ac94...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.

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

openjdk · 2025-08-08T13:31:25Z

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

net

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 · 2025-08-08T13:34:51Z

Webrevs

vy · 2025-08-08T14:07:28Z

test/jdk/java/net/CookieStoreTest.java

+ *          as expected
+ * @run junit CookieStoreTest
+ */
+class CookieStoreTest {


Otherwise you get a warning that the comment block should start with a /**:

Suggested change

class CookieStoreTest {

class CookieStoreTest {

Hello Volkan, is that warning generated by a IDE? I don't see it in IntelliJ:

I think we usually put the jtreg directive block before the imports.

Is that warning generated by a IDE? I don't see it in IntelliJ:

@jaikiran, I remember seeing it highlighted somewhere, but apparently I am mistaken. Nevermind. It is all good.

Hello Chen,

I think we usually put the jtreg directive block before the imports.

It's a mix of before imports and above the class declaration in the JDK repo. I personally prefer just above the class since it's easily visible. Several of the tests in the networking area follow this currently.

vy · 2025-08-08T14:07:31Z

test/jdk/java/net/CookieStoreTest.java

+        // the returned list is expected to be immutable, so the attempt to add or remove
+        // an element must fail
+        assertThrows(UnsupportedOperationException.class, () -> cookies.add(cookie));
+        assertThrows(UnsupportedOperationException.class, () -> cookies.remove(cookie));


Nit: You can consider factoring this out to a assertCookieStoreIsImmutable(CookieStore) method.

Done. I've moved couple of those assertions to a separate method to be called from each of these test methods.

dfuch

LGTM. It may be useful to plan a release note, in case an application is depending on being able to add/remove stuff to/from the returned list, despite the documentation stating they should be immutable. For instance - an application may attempt to clear() the returned list.

liach · 2025-08-08T17:17:43Z

test/jdk/java/net/CookieStoreTest.java

+ *          as expected
+ * @run junit CookieStoreTest
+ */
+class CookieStoreTest {


I think we usually put the jtreg directive block before the imports.

liach · 2025-08-08T17:18:44Z

test/jdk/java/net/CookieStoreTest.java

+        // the list is expected to be immutable, so the attempt to add or remove
+        // an element must fail
+        assertThrows(UnsupportedOperationException.class, () -> list.add(elementToAddOrRemove));
+        assertThrows(UnsupportedOperationException.class, () -> list.remove(elementToAddOrRemove));


I think trying list.set would be meaningful too, given Arrays.asList would pass these two tests but is actually mutable.

Done. I've updated the PR to include that additional check.

liach

Code alone looks good.

jaikiran · 2025-08-10T04:15:51Z

It may be useful to plan a release note, in case an application is depending on being able to add/remove stuff to/from the returned list, despite the documentation stating they should be immutable. For instance - an application may attempt to clear() the returned list.

I've now marked the issue with release-note=yes. I'll create one shortly.

jaikiran · 2025-08-10T04:20:02Z

Thank you all for the reviews.

jaikiran · 2025-08-10T04:20:56Z

/integrate

openjdk · 2025-08-10T04:22:11Z

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

e13b4c8: 8358535: Changes in ClassValue (JDK-8351996) caused a 1-9% regression in Renaissance-PageRank
f83454c: 8364786: Test java/net/vthread/HttpALot.java intermittently fails - 24999 handled, expected 25000
8ad1fcc: 8364564: Shortcut configuration is not recorded in .jpackage.xml file
... and 2 more: https://git.openjdk.org/jdk/compare/241808e13fb032b0ec192e0b7ff94891a653ac94...master

Your commit was automatically rebased without conflicts.

openjdk · 2025-08-10T04:22:28Z

@jaikiran Pushed as commit 022e29a.

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

jaikiran added 2 commits August 8, 2025 17:23

8365086: add a test

aace799

8365086: CookieStore.getURIs() and get(URI) should return an immutabl…

914fde9

…e List

openjdk bot added net [email protected] rfr Pull request is ready for review labels Aug 8, 2025

vy approved these changes Aug 8, 2025

View reviewed changes

Volkan's review - refactor assertions into a method

7b92b0a

dfuch approved these changes Aug 8, 2025

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Aug 8, 2025

liach reviewed Aug 8, 2025

View reviewed changes

Chen's review - verify List.set() fails too

f6ff8fa

openjdk bot removed the ready Pull request is ready to be integrated label Aug 9, 2025

liach approved these changes Aug 9, 2025

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Aug 9, 2025

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

openjdk bot closed this Aug 10, 2025

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Aug 10, 2025

jaikiran deleted the 8365086 branch August 10, 2025 04:23

8365086: CookieStore.getURIs() and get(URI) should return an immutable List #26698

8365086: CookieStore.getURIs() and get(URI) should return an immutable List #26698

Conversation

jaikiran commented Aug 8, 2025 • 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 Aug 8, 2025

Uh oh!

openjdk bot commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openjdk bot commented Aug 8, 2025

Uh oh!

mlbridge bot commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dfuch left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

liach left a comment

Choose a reason for hiding this comment

Uh oh!

jaikiran commented Aug 10, 2025

Uh oh!

jaikiran commented Aug 10, 2025

Uh oh!

jaikiran commented Aug 10, 2025

Uh oh!

openjdk bot commented Aug 10, 2025

Uh oh!

openjdk bot commented Aug 10, 2025

Uh oh!

Uh oh!

jaikiran commented Aug 8, 2025 •

edited by openjdk bot

Loading

openjdk bot commented Aug 8, 2025 •

edited

Loading

mlbridge bot commented Aug 8, 2025 •

edited

Loading