8287134: HttpURLConnection chunked streaming mode doesn't enforce specified size #12137

c-cleary · 2023-01-23T09:04:58Z

Description

When using HttpURLConnection::setChunkedStreamingMode(), the current documentation does not make it clear that the chunklen parameter refers to the amount of bytes sent on the wire per HTTP/1.1 chunk and not the payload length per chunk. The chunklen parameter takes into account the bytes used for the chunk size header, two CRLF characters and the possible payload length inclusively.

Summary of Changes & Justification

The API text has been updated to reflect the actual behavior of the method as described above to avoid a similar bug being submitted in the future and to make it clear what the chunklen parameter specifies.

This change will require a csr.

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 CSR request JDK-8300848 to be approved

Issues

JDK-8287134: HttpURLConnection chunked streaming mode doesn't enforce specified size
JDK-8300848: HttpURLConnection chunked streaming mode doesn't enforce specified size (CSR)

Reviewers

Daniel Fuchs (@dfuch - Reviewer)
Michael McMahon (@Michael-Mc-Mahon - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 12137

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

Using diff file

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

…cified size

c-cleary · 2023-01-23T09:07:32Z

/csr needed

bridgekeeper · 2023-01-23T09:07:55Z

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

c-cleary · 2023-01-23T09:10:36Z

A CSR will be required to be submitted for this change. I will create this and allow for a review period of this PR before finalizing it.

openjdk · 2023-01-23T09:21:27Z

@c-cleary this pull request will not be integrated until the CSR request JDK-8300848 for issue JDK-8287134 has been approved.

openjdk · 2023-01-23T09:37:18Z

@c-cleary 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 · 2023-01-23T09:41:43Z

Webrevs

01: Full - Incremental (38de2297)
00: Full (93588aec)

c-cleary · 2023-01-23T10:30:53Z

A related CSR has been created here: https://bugs.openjdk.org/browse/JDK-8300848

Seeking review on that as well before moving forward.

Michael-Mc-Mahon · 2023-01-23T11:40:35Z

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

+     *          each chunk. This includes a chunk size header given as a
+     *          hexidecimal string (minimum of 1 byte), two CRLF's (4 bytes)
+     *          and a minimum payload length of 1 byte. If chunklen is less
+     *          than or equal to 5, a default value will be used.
     *


I'd suggest something like this:

chunklen The number of bytes to be written in
each chunk, including the chunk header as a
hexadecimal string (minimum of 1 byte), two CRLF's (4 bytes)
and a minimum payload length of 1 byte. If chunklen is less
than or equal to 5, a higher default value will be used.

Thanks @Michael-Mc-Mahon, I updated the text with respect to your suggestion there (which was definitely a bit more clear than mine) and corrected my spelling of hexadecimal in my most recent changes just now.

dfuch

The new text looks good to me.

c-cleary · 2023-01-23T15:08:57Z

Thanks Daniel! The related CSR has now been updated to reflect the new text.

Michael-Mc-Mahon

Looks fine.

openjdk · 2023-01-26T02:57:50Z

@c-cleary 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:

8287134: HttpURLConnection chunked streaming mode doesn't enforce specified size

Reviewed-by: dfuchs, 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 171 new commits pushed to the master branch:

b5a4744: 8300857: State return value for Types.asElement(NoType) explicitly
7e951f4: 8301092: Add benchmark for CRC32
adcfd25: 8301098: Remove dead code FileMapInfo::stop_sharing_and_unmap()
9f0887e: 8296661: Typo Found In CSSParser.java
ccf2f58: 8300806: Update googletest to v1.13.0
edf1e1a: 8300592: ASan build does not correctly propagate options to some test launchers
e80b5ea: 8299635: Hotspot update for deprecated sprintf in Xcode 14
f279c75: 8300805: Update autoconf build-aux files with latest from 2022-09-17
a23ff63: 8301086: jdk/internal/util/ByteArray/ReadWriteValues.java fails with CompilationError
61775c8: 8300997: Add curl support to createJMHBundle.sh
... and 161 more: https://git.openjdk.org/jdk/compare/85d70acc6e5b9f394d446c270f15bb3793916e63...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.

c-cleary · 2023-01-26T08:33:33Z

/integrate

openjdk · 2023-01-26T08:35:17Z

Going to push as commit 48152ef.
Since your change was applied there have been 173 commits pushed to the master branch:

4b0e656: 8298118: split-if optimization causes empty loop to temporarily have more than one phi
252621d: 8301063: Remove dead code from GrowableArray
b5a4744: 8300857: State return value for Types.asElement(NoType) explicitly
7e951f4: 8301092: Add benchmark for CRC32
adcfd25: 8301098: Remove dead code FileMapInfo::stop_sharing_and_unmap()
9f0887e: 8296661: Typo Found In CSSParser.java
ccf2f58: 8300806: Update googletest to v1.13.0
edf1e1a: 8300592: ASan build does not correctly propagate options to some test launchers
e80b5ea: 8299635: Hotspot update for deprecated sprintf in Xcode 14
f279c75: 8300805: Update autoconf build-aux files with latest from 2022-09-17
... and 163 more: https://git.openjdk.org/jdk/compare/85d70acc6e5b9f394d446c270f15bb3793916e63...master

Your commit was automatically rebased without conflicts.

openjdk · 2023-01-26T08:35:31Z

@c-cleary Pushed as commit 48152ef.

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

8287134: HttpURLConnection chunked streaming mode doesn't enforce spe…

93588ae

…cified size

c-cleary marked this pull request as ready for review January 23, 2023 09:06

openjdk bot added rfr Pull request is ready for review csr Pull request needs approved CSR before integration labels Jan 23, 2023

openjdk bot added the net net-dev@openjdk.org label Jan 23, 2023

Michael-Mc-Mahon reviewed Jan 23, 2023

View reviewed changes

8287134: Shortened text and corrected typo

38de229

dfuch approved these changes Jan 23, 2023

View reviewed changes

Michael-Mc-Mahon approved these changes Jan 25, 2023

View reviewed changes

openjdk bot removed the csr Pull request needs approved CSR before integration label Jan 26, 2023

openjdk bot added the ready Pull request is ready to be integrated label Jan 26, 2023

openjdk bot added the integrated Pull request has been integrated label Jan 26, 2023

openjdk bot closed this Jan 26, 2023

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8287134: HttpURLConnection chunked streaming mode doesn't enforce specified size #12137

8287134: HttpURLConnection chunked streaming mode doesn't enforce specified size #12137

c-cleary commented Jan 23, 2023 •

edited by openjdk bot

Loading

c-cleary commented Jan 23, 2023

bridgekeeper bot commented Jan 23, 2023

c-cleary commented Jan 23, 2023

openjdk bot commented Jan 23, 2023

openjdk bot commented Jan 23, 2023

mlbridge bot commented Jan 23, 2023 •

edited

Loading

c-cleary commented Jan 23, 2023

Michael-Mc-Mahon Jan 23, 2023

c-cleary Jan 23, 2023 •

edited

Loading

dfuch left a comment

c-cleary commented Jan 23, 2023

Michael-Mc-Mahon left a comment

openjdk bot commented Jan 26, 2023

c-cleary commented Jan 26, 2023

openjdk bot commented Jan 26, 2023

openjdk bot commented Jan 26, 2023

8287134: HttpURLConnection chunked streaming mode doesn't enforce specified size #12137

8287134: HttpURLConnection chunked streaming mode doesn't enforce specified size #12137

Conversation

c-cleary commented Jan 23, 2023 • edited by openjdk bot Loading

Description

Summary of Changes & Justification

Progress

Issues

Reviewers

Reviewing

c-cleary commented Jan 23, 2023

bridgekeeper bot commented Jan 23, 2023

c-cleary commented Jan 23, 2023

openjdk bot commented Jan 23, 2023

openjdk bot commented Jan 23, 2023

mlbridge bot commented Jan 23, 2023 • edited Loading

Webrevs

c-cleary commented Jan 23, 2023

Michael-Mc-Mahon Jan 23, 2023

Choose a reason for hiding this comment

c-cleary Jan 23, 2023 • edited Loading

Choose a reason for hiding this comment

dfuch left a comment

Choose a reason for hiding this comment

c-cleary commented Jan 23, 2023

Michael-Mc-Mahon left a comment

Choose a reason for hiding this comment

openjdk bot commented Jan 26, 2023

c-cleary commented Jan 26, 2023

openjdk bot commented Jan 26, 2023

openjdk bot commented Jan 26, 2023

c-cleary commented Jan 23, 2023 •

edited by openjdk bot

Loading

mlbridge bot commented Jan 23, 2023 •

edited

Loading

c-cleary Jan 23, 2023 •

edited

Loading