api,netty: Add custom header support for HTTP CONNECT proxy #12474
+388
−11
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
devalkone
force-pushed
the
proxy-custom-headers
branch
2 times, most recently
from
2ce7276 to
484d810
Compare
ejona86
approved these changes
Nov 5, 2025
| /** | ||
| * Returns the headers associated with this proxied socket address. | ||
| */ | ||
| public Map<String, String> getHeaders() { |
There was a problem hiding this comment.
Let's add @ExperimentalApi here and to the setter. We add it to all new APIs. This seems easy to stabilize.
You can look around for some examples, but basically you create a tracking issue and use the URL in the annotation.
There was a problem hiding this comment.
Done! Added @ExperimentalApi("https://github.com/grpc/grpc-java/issues/12479") to both getHeaders() and setHeaders().
Used #12479 as tracking issue.
Allow users to specify custom HTTP headers when connecting through an HTTP CONNECT proxy. This extends HttpConnectProxiedSocketAddress with an optional headers field (Map<String, String>), which is converted to Netty's HttpHeaders in the protocol negotiator. This change is fully backward-compatible. Existing code without headers continues to work as before. Fixes grpc#9826
devalkone
force-pushed
the
proxy-custom-headers
branch
from
484d810 to
25d026c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #9826
Description
This PR adds support for custom HTTP headers in HTTP CONNECT proxy connections, as requested in #9826.
Currently,
HttpConnectProxiedSocketAddressonly supports username and password for proxy authentication. However, HTTP/1.1 CONNECT supports arbitrary headers. This change adds aheadersfield to allow users to pass custom headers to the proxy.Changes
headersfield toHttpConnectProxiedSocketAddresssetHeaders()method to BuilderProtocolNegotiators.httpProxy()to convert headers to Netty'sHttpHeadersTesting
HttpConnectProxiedSocketAddresshttpProxy_customHeaders()inProtocolNegotiatorsTestBackward Compatibility
This is a fully backward-compatible change. The
headersfield defaults to an empty map if not set, so existing code continues to work without modifications.