8294948: Document IllegalArgumentException and NullPointerException thrown by URLStreamHandler::parseURL and URLStreamHandler::setURL by dfuch · Pull Request #10609 · openjdk/jdk

dfuch · 2022-10-07T16:11:07Z

During the review of JDK-8293590, it was noted that some methods in URLStreamHandler were missing an @throws IllegalArgumentException clause in their API documentation.

This change adds the requested information, and also clarifies throwing MalformedURLException from URL constructors.

The CSR can be reviewed here: https://bugs.openjdk.org/browse/JDK-8294984

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
Change requires a CSR request to be approved

Issues

JDK-8294948: Document IllegalArgumentException and NullPointerException thrown by URLStreamHandler::parseURL and URLStreamHandler::setURL
JDK-8294984: Document IllegalArgumentException and NullPointerException thrown by URLStreamHandler::parseURL and URLStreamHandler::setURL (CSR)

Reviewers

Jaikiran Pai (@jaikiran - Reviewer) ⚠️ Review applies to e2b3870b
Aleksei Efimov (@AlekseiEfimov - Committer) ⚠️ Review applies to e2b3870b
Alan Bateman (@AlanBateman - Reviewer) ⚠️ Review applies to 5b0692b7
Michael McMahon (@Michael-Mc-Mahon - Reviewer) ⚠️ Review applies to 5b0692b7

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 10609

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

Using diff file

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

bridgekeeper · 2022-10-07T16:11:20Z

👋 Welcome back dfuchs! 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.

dfuch · 2022-10-07T16:11:36Z

/csr needed

openjdk · 2022-10-07T16:19:46Z

@dfuch this pull request will not be integrated until the CSR request JDK-8294984 for issue JDK-8294948 has been approved.

openjdk · 2022-10-07T16:25:50Z

@dfuch 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 · 2022-10-07T16:29:56Z

Webrevs

jaikiran · 2022-10-11T11:05:38Z

Hello Daniel, the change looks fine to me and it does indeed document what is already being thrown from those methods currently.

AlekseiEfimov

New documentation looks good to me, and matches the source code.

AlanBateman · 2022-10-16T07:31:03Z

src/java.base/share/classes/java/net/URL.java

+ * URLStreamHandler#parseURL(URL, String, int, int) parseURL method} is
+ * called during URL construction and it throws {@code IllegalArgumentException}.
+ * However, which checks are performed is implementation dependent, and
+ * callers should not rely on such checks for full URL validation.


I think the API note will need a few adjustments.

The first sentence uses the word "additionally" but the text prior to that isn't about throwing exceptions. I think what you mean is in addition to the reasons specified by the URL constructors, in which case this makes it normative. Maybe you could lend on the text "parsed URL fails to comply ..." or if that is too complicated then just drop this part of the API note.

A second sentence uses "In particular when ..." but I don't think URL specifies that it calls the parseURL method. If the URL constructors did specify this when you could reference it here. If you map to document the mapping of ISE to MalformedURLException then I think the URL constructors will need to document that they delegate to parseURL and throw MalformedURLException if the parsing fails with IAE.

Thanks @AlanBateman - I have updated the API note, added an @implSpec in two of the constructors to spell out that they are calling the stream handler's parseURL method (the first one says it's equivalent to the second one so I don't think @implSpec is needed there), and improved the @throws MalformedURLException with more details.
Does the new text match your expectations?

src/java.base/share/classes/java/net/URL.java

AlanBateman · 2022-10-19T11:25:14Z

src/java.base/share/classes/java/net/URL.java

     *
+     * @implSpec Parsing the URL involves calling the {@link
+     * URLStreamHandler#parseURL(URL, String, int, int) parseURL} method on the
+     * selected handler.


What you would think about making this more direct, e.g. "This constructor invokes the selected stream handler's parseURL method to parse the URL."

Well some of the parsing is done in URL itself: like finding the fragment, if any, setting up start and limit etc... And I didn't want to get into the rabbit hole of trying to specify what does what exactly. I can still take your suggested text if you believe it doesn't matter?

Okay, maybe your wording would be be okay if you changed "involves" to "includes" as the former hints that there is more going on that is not specified.

Good idea! Will do.

AlanBateman · 2022-10-19T11:27:01Z

src/java.base/share/classes/java/net/URL.java

+     *               of the associated protocol. In particular, if the
+     *               underlying stream handler's {@linkplain
+     *               URLStreamHandler#parseURL parseURL method} throws
+     *               {@code IllegalArgumentException}


This looks okay but it might be simpler to drop "In particular" and just say "or the stream handler's parseURL throws ...".

Thanks @AlanBateman I have pushed all the requested changes and updated the CSR. If that looks good to you I will finalize the CSR.

Michael-Mc-Mahon

LGTM

openjdk · 2022-10-19T19:42:24Z

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

8294948: Document IllegalArgumentException and NullPointerException thrown by URLStreamHandler::parseURL and URLStreamHandler::setURL

Reviewed-by: jpai, aefimov, alanb, michaelm

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

f872467: 8255746: Make PrintCompilation available on a per method level
388a56e: 8294467: Fix sequence-point warnings in Hotspot
ceb5b08: 8294468: Fix char-subscripts warnings in Hotspot
7b1c676: 8295662: jdk/incubator/vector tests fail "assert(VM_Version::supports_avx512vlbw()) failed"
5eaf568: 8295668: validate-source failure after JDK-8290011
e238920: 8295372: CompactNumberFormat handling of number one with decimal part
a5f6e31: 8295456: (ch) sun.nio.ch.Util::checkBufferPositionAligned gives misleading/incorrect error
e27bea0: 8290011: IGV: Remove dead code and cleanup
d37ce4c: 8290368: Introduce LDAP and RMI protocol-specific object factory filters to JNDI implementation

Please see this link for an up-to-date comparison between the source branch of this pull request and 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.

dfuch · 2022-10-20T08:52:57Z

/integrate

openjdk · 2022-10-20T08:55:02Z

Going to push as commit 9d0cfd1.
Since your change was applied there have been 15 commits pushed to the master branch:

dcd4650: 8294916: Cancelling a request must eventually cause its response body subscriber to be unregistered
4f994c0: 8295709: Linux AArch64 builds broken after JDK-8294438
545021b: 8294438: Fix misleading-indentation warnings in hotspot
c5e0464: 8291456: com/sun/jdi/ClassUnloadEventTest.java failed with: Wrong number of class unload events: expected 10 got 4
8d4c077: 8295302: Do not use ArrayList when LambdaForm has a single ClassData
017e798: 8293939: Move continuation_enter_setup and friends
f872467: 8255746: Make PrintCompilation available on a per method level
388a56e: 8294467: Fix sequence-point warnings in Hotspot
ceb5b08: 8294468: Fix char-subscripts warnings in Hotspot
7b1c676: 8295662: jdk/incubator/vector tests fail "assert(VM_Version::supports_avx512vlbw()) failed"
... and 5 more: https://git.openjdk.org/jdk/compare/21aeb9e7946fc7450ee48939944a69c8aa04bcce...master

Your commit was automatically rebased without conflicts.

openjdk · 2022-10-20T08:55:15Z

@dfuch Pushed as commit 9d0cfd1.

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

8294948

ea68b72

openjdk bot changed the title ~~8294948~~ 8294948: Document IllegalArgumetException thrown by URLStreamHandler::parseURL and URLStreamHandler::setURL Oct 7, 2022

openjdk bot added rfr Pull request is ready for review csr Pull request needs approved CSR before integration labels Oct 7, 2022

openjdk bot added the net net-dev@openjdk.org label Oct 7, 2022

dfuch added 2 commits October 7, 2022 17:34

8294948

6b5144c

Adding missing @throws NPE

4f92fd5

dfuch changed the title ~~8294948: Document IllegalArgumetException thrown by URLStreamHandler::parseURL and URLStreamHandler::setURL~~ 8294948: Document IllegalArgumetException and NullPointerException thrown by URLStreamHandler::parseURL and URLStreamHandler::setURL Oct 7, 2022

dfuch added 3 commits October 7, 2022 18:01

Update Copyright Years

4e8f062

Minor wording updates

5b537dc

Minor wording updates - unmmapable single quote character

e2b3870

jaikiran approved these changes Oct 11, 2022

View reviewed changes

AlekseiEfimov approved these changes Oct 11, 2022

View reviewed changes

Merge branch 'master' into url-iae-8294948

772536c

AlanBateman reviewed Oct 16, 2022

View reviewed changes

src/java.base/share/classes/java/net/URL.java Show resolved Hide resolved

dfuch added 3 commits October 17, 2022 12:37

Merge branch 'master' into url-iae-8294948

ac0ec52

Taking into account review feedback

7ead657

More review comments

f0259f1

AlanBateman reviewed Oct 19, 2022

View reviewed changes

More review feedback

5b0692b

AlanBateman approved these changes Oct 19, 2022

View reviewed changes

Merge branch 'master' into url-iae-8294948

f062dc6

Michael-Mc-Mahon approved these changes Oct 19, 2022

View reviewed changes

openjdk bot removed the csr Pull request needs approved CSR before integration label Oct 19, 2022

openjdk bot added the ready Pull request is ready to be integrated label Oct 19, 2022

openjdk bot added the integrated Pull request has been integrated label Oct 20, 2022

openjdk bot closed this Oct 20, 2022

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

Conversation

dfuch commented Oct 7, 2022 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issues

Reviewers

Reviewing

Uh oh!

bridgekeeper bot commented Oct 7, 2022

Uh oh!

dfuch commented Oct 7, 2022

Uh oh!

openjdk bot commented Oct 7, 2022

Uh oh!

openjdk bot commented Oct 7, 2022

Uh oh!

mlbridge bot commented Oct 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

jaikiran commented Oct 11, 2022

Uh oh!

AlekseiEfimov 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!

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!

Michael-Mc-Mahon left a comment

Choose a reason for hiding this comment

Uh oh!

openjdk bot commented Oct 19, 2022

Uh oh!

dfuch commented Oct 20, 2022

Uh oh!

openjdk bot commented Oct 20, 2022

Uh oh!

openjdk bot commented Oct 20, 2022

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

5 participants

dfuch commented Oct 7, 2022 •

edited by openjdk bot

Loading

mlbridge bot commented Oct 7, 2022 •

edited

Loading