8350279: HttpClient: Add a new HttpResponse method to identify connections

[vy]

Adds HttpResponse::connectionLabel method that provides an identifier for the connection.

Implementation note: The feature is facilitated by HttpConnection::label, which should not be confused with HttpConnection::id. This distinction is explained in the JavaDoc of both properties.

---

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-8352751 to be approved

Issues

• JDK-8350279: HttpClient: Add a new HttpResponse method to identify connections (Enhancement - P4)
• JDK-8352751: HttpClient: Add a new HttpResponse method to identify connections (CSR)

Reviewers

• Daniel Fuchs (@dfuch - Reviewer)
• Jaikiran Pai (@jaikiran - Reviewer) Review applies to db61a015

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 24154

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

Using diff file

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

Using Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back vyazici! 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]

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

8350279: HttpClient: Add a new HttpResponse method to identify connections

Reviewed-by: dfuchs, jpai

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

• 03fd43f: 8353453: URLDecoder should use HexFormat
• 4e24dc0: 8353185: Introduce the concept of upgradeable files in context of JEP 493
• d7676c3: 8354508: JFR: Strengthen metadata checks for labels
• ... and 404 more: https://git.openjdk.org/jdk/compare/0cb110ebb7f8d184dd855f64c5dd7924c8202b3d...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.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@dfuch, @jaikiran) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

[openjdk]

@vy 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]

Webrevs

• 13: Full - Incremental (ad73d38c)
• 12: Full - Incremental (a0859c7c)
• 11: Full - Incremental (a1bb8cf0)
• 10: Full - Incremental (db61a015)
• 09: Full - Incremental (edc0c8d8)
• 08: Full - Incremental (741a2dd0)
• 07: Full - Incremental (4db85c31)
• 06: Full - Incremental (cc70d926)
• 05: Full - Incremental (5b418fd7)
• 04: Full - Incremental (883135d8)
• 03: Full - Incremental (59a11ccc)
• 02: Full - Incremental (a08c0cf1)
• 01: Full - Incremental (028999a7)
• 00: Full (2857dde0)

[dfuch]

/csr required

[openjdk]

@dfuch usage: /csr [needed|unneeded], requires that the issue the pull request refers to links to an approved CSR request.

[liach]

This new API returns an Optional.

1. Can users make any assumption about the connection identity when it is empty? Such as assuming such connections are all the same (as implied by your use of orElse(null) in tests) or all different?
2. If we cannot make any assumption about the empty return value, can users make any assumption that a HttpResponse obtained from the JDK built-in HttpClient always return non-empty for the label?

[vy]

/csr needed

[openjdk]

@vy has indicated that a compatibility and specification (CSR) request is needed for this pull request.

@vy please create a CSR request for issue JDK-8350279 with the correct fix version. This pull request cannot be integrated until the CSR request is approved.

[dfuch]

• Can users make any assumption about the connection identity when it is empty? Such as assuming such connections are all the same (as implied by your use of orElse(null) in tests) or all different?

No. If empty is returned you can make no assumptions. In practice this should never be null with our impl (except possibly in whitebox tests)

• If we cannot make any assumption about the empty return value, can users make any assumption that a HttpResponse obtained from the JDK built-in HttpClient always return non-empty for the label?

Yes.

[liach]

If we cannot make any assumption about the empty return value, can users make any assumption that a HttpResponse obtained from the JDK built-in HttpClient always return non-empty for the label?
Yes.

Should we specify this, like "The JDK built-in implementation of the {@code HttpClient} always assign a label to connections it create"?

[dfuch]

Should we specify this, like "The JDK built-in implementation of the {@code HttpClient} always assign a label to connections it create"?

Good question - that would be an @implNote - but I'm not sure this is required. The caller can determine whether a connection label is provided by testing whether the optional is empty.

[jaikiran]

I don't have anything else. This looks good to me. Thank you for working on this enhancement and your patience during the review.

[dfuch]

LGTM.

[vy]

/integrate

[openjdk]

@vy
Your change (at version ad73d38) is now ready to be sponsored by a Committer.

[jaikiran]

/sponsor

[openjdk]

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

• 03fd43f: 8353453: URLDecoder should use HexFormat
• 4e24dc0: 8353185: Introduce the concept of upgradeable files in context of JEP 493
• d7676c3: 8354508: JFR: Strengthen metadata checks for labels
• ... and 404 more: https://git.openjdk.org/jdk/compare/0cb110ebb7f8d184dd855f64c5dd7924c8202b3d...master

Your commit was automatically rebased without conflicts.

[openjdk]

@jaikiran @vy Pushed as commit 5fc18f5.

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