8265137: java.util.Random suddenly has new public methods nowhere documented #3469

JimLaskey · 2021-04-13T16:33:21Z

Move makeXXXSpilterator from public (@hidden) to protected. No API ch

Progress

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

Issue

JDK-8265137: java.util.Random suddenly has new public methods nowhere documented

Reviewers

Uwe Schindler (@uschindler - Author) ⚠️ Review applies to 482ea0a
Joe Darcy (@jddarcy - Reviewer) ⚠️ Review applies to 3381f00
Stuart Marks (@stuart-marks - Reviewer) ⚠️ Review applies to 3381f00

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 3469

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

Using diff file

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

…ange.

JimLaskey · 2021-04-13T16:33:34Z

/label core-libs

bridgekeeper · 2021-04-13T16:33:55Z

👋 Welcome back jlaskey! 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 · 2021-04-13T16:36:21Z

@JimLaskey
The core-libs label was successfully added.

mlbridge · 2021-04-13T16:39:16Z

Webrevs

uschindler

This looks exactly like my proposed solution!

+1 Thanks!

uschindler · 2021-04-13T17:27:03Z

Just my question: Is @hidden not needed to remove the documentation from protected method? Or is this automatically hidden by javadoc?

JimLaskey · 2021-04-13T17:29:40Z

Just my question: Is @hidden not needed to remove the documentation from protected method? Or is this automatically hidden by javadoc?

protected methods don't show up.

AlanBateman · 2021-04-14T12:39:24Z

/csr

openjdk · 2021-04-14T12:40:06Z

@AlanBateman has indicated that a compatibility and specification (CSR) request is needed for this pull request.
@JimLaskey please create a CSR request and add link to it in JDK-8265137. This pull request cannot be integrated until the CSR request is approved.

uschindler

To me this looks fine. It is all a bit of hack, but this makes sure the public API of java.util.Random does not change in comparison to JDK 16.
The final protected method may be visible by IDEs but it cannot be called und is not overrideable as it is final.

forax · 2021-04-14T17:31:32Z

I don't see the point of having those methods virtual, they can be public static in RandomSupport given that there is only one implementation (the one with an if ... instanceof).
Also the static final proxy should be spelled PROXY.

src/java.base/share/classes/jdk/internal/util/random/RandomSupport.java

uschindler · 2021-04-16T09:49:33Z

Due to the changes now: I think the CSR got obsolete?

JimLaskey · 2021-04-16T10:46:35Z

I put the CSR back to draft until I was happy with the changeset.

JimLaskey · 2021-04-22T12:15:18Z

/help

openjdk · 2021-04-22T12:15:45Z

@JimLaskey Available commands:

cc - add or remove an additional classification label
clean - Mark the backport pull request as a clean backport
contributor - adds or removes additional contributors for a PR
covered - used when employer has signed the OCA
csr - require a compatibility and specification request (CSR) for this pull request
help - shows this text
integrate - performs integration of the changes in the PR
issue - edit the list of issues that this PR solves
label - add or remove an additional classification label
open - Set the pull request state to "open"
reviewer - manage additional reviewers for a PR
reviewers - set the number of additional required reviewers for this PR
signed - used after signing the OCA
solves - edit the list of issues that this PR solves
sponsor - performs integration of a PR that is authored by a non-committer
summary - updates the summary in the commit message
test - used to run tests

JimLaskey · 2021-04-22T12:20:01Z

/help reviewer

openjdk · 2021-04-22T12:20:20Z

@JimLaskey Available commands:

cc - add or remove an additional classification label
clean - Mark the backport pull request as a clean backport
contributor - adds or removes additional contributors for a PR
covered - used when employer has signed the OCA
csr - require a compatibility and specification request (CSR) for this pull request
help - shows this text
integrate - performs integration of the changes in the PR
issue - edit the list of issues that this PR solves
label - add or remove an additional classification label
open - Set the pull request state to "open"
reviewer - manage additional reviewers for a PR
reviewers - set the number of additional required reviewers for this PR
signed - used after signing the OCA
solves - edit the list of issues that this PR solves
sponsor - performs integration of a PR that is authored by a non-committer
summary - updates the summary in the commit message
test - used to run tests

forax · 2021-04-22T13:45:19Z

Looks good

+1

stuart-marks

Overall looks good.

AbstractSpliteratorGenerator now is a bit weird because it's a utility class that has static methods, and it's an abstract superclass that has instance methods that mostly just call the static methods. Seems to me that additional cleanup is possible. It might not be worth it right now, since the main point of this PR -- to remove "leakage" of these helper methods into the public API -- has been achieved.

The RandomXXXSpliterator nested classes could also stand some scrutiny. The constructors consume a RandomGenerator, which is stored in an instance variable. Various comments still refer to this as an AbstractSpliteratorGenerator. (See line 961 for example; can't comment directly because it's not part of this commit.)

But it's not clear to me that the RandomXXXSpliterator classes really need a full RandomGenerator. For example, as far as I can see, RandomIntSpliterator only needs nextInt to generate int values; therefore it could be IntSupplier. Similar for long and double. (I'm applying the Interface Segregation Principle here.) But again this is probably a cleanup for another day.

stuart-marks · 2021-04-22T16:10:20Z

src/java.base/share/classes/jdk/internal/util/random/RandomSupport.java

         */
-        protected AbstractSpliteratorGenerator() {
+        private AbstractSpliteratorGenerator() {
        }



This comment is wrong now since there are instances of this class (really, subclasses). The constructor should probably simply be removed.

uschindler

Hi,
the overall setup is mch better than before! This also makes the problem we have seen in policeman-tools/forbidden-apis#177 go away, because Random/ThreadLocalRandom no longer extend a public, but internal/hidden class (forbiddenapis is a classfile analyzer that tries to prevent user's from extending internal JDK APIs in one of its checks). When looking into superclasses of Random, it detected a "bad superclass from an internal package".

So this alone makes me very happy with this.

In addition, it no longer changes APIs of Random/ThreadLocalRandom, only the new interface is added.

+1 to merge

JimLaskey · 2021-04-27T10:47:34Z

Please mark the CSR https://bugs.openjdk.java.net/browse/JDK-8265221 as reviewed.

openjdk · 2021-05-04T05:30:02Z

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

8265137: java.util.Random suddenly has new public methods nowhere documented

Reviewed-by: uschindler, darcy, smarks

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.

JimLaskey · 2021-05-04T11:52:09Z

/integrate

openjdk · 2021-05-04T11:53:26Z

@JimLaskey Pushed as commit 05e6017.

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

Move makeXXXSpilterator from public (@hidden) to protected. No API ch…

4bde44f

…ange.

openjdk bot added rfr Pull request is ready for review core-libs core-libs-dev@openjdk.org labels Apr 13, 2021

uschindler approved these changes Apr 13, 2021

View reviewed changes

Make makeXXXSpliterator final

a6e35c6

openjdk bot added the csr Pull request needs approved CSR before integration label Apr 14, 2021

uschindler approved these changes Apr 14, 2021

View reviewed changes

JimLaskey added 2 commits April 14, 2021 14:52

change static final from 'proxy' to 'PROXY'

c6b5da3

Move makeXXXSpliterator methods to RandomSupport

0094c43

uschindler reviewed Apr 15, 2021

View reviewed changes

src/java.base/share/classes/jdk/internal/util/random/RandomSupport.java Outdated Show resolved Hide resolved

Remove extraneous references to makeXXXSpliterator

d72575d

JimLaskey added 3 commits April 21, 2021 09:58

Correct the hierarchy of Random

5932335

Remove @hidden

7d2ca8e

Merge branch 'master' into 8265137

3381f00

jddarcy approved these changes Apr 21, 2021

View reviewed changes

stuart-marks approved these changes Apr 22, 2021

View reviewed changes

uschindler approved these changes Apr 23, 2021

View reviewed changes

Remove unnecessary constructor.

482ea0a

uschindler approved these changes Apr 29, 2021

View reviewed changes

openjdk bot removed the csr Pull request needs approved CSR before integration label May 4, 2021

openjdk bot added the ready Pull request is ready to be integrated label May 4, 2021

Merge branch 'master' into 8265137

218a7d9

openjdk bot closed this May 4, 2021

openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels May 4, 2021

8265137: java.util.Random suddenly has new public methods nowhere documented #3469

8265137: java.util.Random suddenly has new public methods nowhere documented #3469

JimLaskey commented Apr 13, 2021 •

edited by openjdk bot

JimLaskey commented Apr 13, 2021

bridgekeeper bot commented Apr 13, 2021

openjdk bot commented Apr 13, 2021

mlbridge bot commented Apr 13, 2021 •

edited

uschindler left a comment

uschindler commented Apr 13, 2021

JimLaskey commented Apr 13, 2021

AlanBateman commented Apr 14, 2021

openjdk bot commented Apr 14, 2021

uschindler left a comment

forax commented Apr 14, 2021

uschindler commented Apr 16, 2021

JimLaskey commented Apr 16, 2021

JimLaskey commented Apr 22, 2021

openjdk bot commented Apr 22, 2021

JimLaskey commented Apr 22, 2021

openjdk bot commented Apr 22, 2021

forax commented Apr 22, 2021

stuart-marks left a comment

stuart-marks Apr 22, 2021

uschindler left a comment

JimLaskey commented Apr 27, 2021

openjdk bot commented May 4, 2021 •

edited

JimLaskey commented May 4, 2021

openjdk bot commented May 4, 2021

8265137: java.util.Random suddenly has new public methods nowhere documented #3469

8265137: java.util.Random suddenly has new public methods nowhere documented #3469

Conversation

JimLaskey commented Apr 13, 2021 • edited by openjdk bot

Progress

Issue

Reviewers

Reviewing

JimLaskey commented Apr 13, 2021

bridgekeeper bot commented Apr 13, 2021

openjdk bot commented Apr 13, 2021

mlbridge bot commented Apr 13, 2021 • edited

Webrevs

uschindler left a comment

Choose a reason for hiding this comment

uschindler commented Apr 13, 2021

JimLaskey commented Apr 13, 2021

AlanBateman commented Apr 14, 2021

openjdk bot commented Apr 14, 2021

uschindler left a comment

Choose a reason for hiding this comment

forax commented Apr 14, 2021

uschindler commented Apr 16, 2021

JimLaskey commented Apr 16, 2021

JimLaskey commented Apr 22, 2021

openjdk bot commented Apr 22, 2021

JimLaskey commented Apr 22, 2021

openjdk bot commented Apr 22, 2021

forax commented Apr 22, 2021

stuart-marks left a comment

Choose a reason for hiding this comment

stuart-marks Apr 22, 2021

Choose a reason for hiding this comment

uschindler left a comment

Choose a reason for hiding this comment

JimLaskey commented Apr 27, 2021

openjdk bot commented May 4, 2021 • edited

JimLaskey commented May 4, 2021

openjdk bot commented May 4, 2021

JimLaskey commented Apr 13, 2021 •

edited by openjdk bot

mlbridge bot commented Apr 13, 2021 •

edited

openjdk bot commented May 4, 2021 •

edited