Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support of Host header #9411

Merged
merged 6 commits into from
Feb 6, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .chloggen/otlphttpexporter_hostheader.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
component: confighttp

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Add support of Host header

# One or more tracking issues or pull requests related to the change
issues: [9395]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: [user]
5 changes: 4 additions & 1 deletion config/confighttp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@ README](../configtls/README.md).

- `endpoint`: address:port
- [`tls`](../configtls/README.md)
- `headers`: name/value pairs added to the HTTP request headers
- [`headers`](https://pkg.go.dev/net/http#Request): name/value pairs added to the HTTP request headers
- certain headers such as Content-Length and Connection are automatically written when needed and values in Header may be ignored.
- `Host` header is automatically derived from `endpoint` value. However, this automatic assignment can be overridden by explicitly setting the Host field in the headers field.
- if `Host` header is provided then it overrides `Host` field in [Request](https://pkg.go.dev/net/http#Request) which results as an override of `Host` header value.
- [`read_buffer_size`](https://golang.org/pkg/net/http/#Transport)
- [`timeout`](https://golang.org/pkg/net/http/#Client)
- [`write_buffer_size`](https://golang.org/pkg/net/http/#Transport)
Expand Down
7 changes: 7 additions & 0 deletions config/confighttp/confighttp.go
Original file line number Diff line number Diff line change
Expand Up @@ -236,9 +236,16 @@ type headerRoundTripper struct {

// RoundTrip is a custom RoundTripper that adds headers to the request.
func (interceptor *headerRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
// Set Host header if provided
hostHeader, found := interceptor.headers["Host"]
if found && hostHeader != "" {
// `Host` field should be set to override default `Host` header value which is Endpoint
req.Host = string(hostHeader)
}
for k, v := range interceptor.headers {
req.Header.Set(k, string(v))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would Host still be available at this point?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hi, yes! It works in test that I wrote and test is broken without this change. I also just tested in my environment and it works.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took a closer look at Go's documentation, and there's one mismatch here compared to that. Go's stdlib precedence is:

  • req.Host
  • req.URL.Host (from HTTPServerConfig.Endpoint.Host)
  • req.Headers["Host"] (from HTTPServerConfig.Headers["Host"])

Right now, we don't have an equivalent to req.Host in confighttp, so this PR introduces the following precedence order:

  • HTTPServerConfig.Headers["Host"]
  • HTTPServerConfig.Endpoint.Host

While I don't expect this to be a breaking change affecting any users at all given that this header must be explicitly set as part of the headers field, I would prefer if we'd introduce a HostHeader field, to be consistent with Go ("path of least surprise" type of thing).

But I'm not 100% convinced myself. I'd appreciate other approvers to give their opinions.

cc @open-telemetry/collector-approvers

Copy link

@MadVikingGod MadVikingGod Feb 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The http.Request doesn't use the Headers["Host"].

// For client requests, Host optionally overrides the Host
// header to send. If empty, the Request.Write method uses
// the value of URL.Host. Host may contain an international
// domain name.
Host string

}

// Send the request to next transport.
return interceptor.transport.RoundTrip(req)
}
Expand Down
35 changes: 35 additions & 0 deletions config/confighttp/confighttp_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1061,6 +1061,41 @@ func TestHttpClientHeaders(t *testing.T) {
}
}

func TestHttpClientHostHeader(t *testing.T) {
hostHeader := "th"
tt := struct {
name string
headers map[string]configopaque.String
}{
name: "with_host_header",
headers: map[string]configopaque.String{
"Host": configopaque.String(hostHeader),
},
}

t.Run(tt.name, func(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
assert.Equal(t, hostHeader, r.Host)
w.WriteHeader(http.StatusOK)
}))
defer server.Close()
serverURL, _ := url.Parse(server.URL)
setting := HTTPClientSettings{
Endpoint: serverURL.String(),
TLSSetting: configtls.TLSClientSetting{},
ReadBufferSize: 0,
WriteBufferSize: 0,
Timeout: 0,
Headers: tt.headers,
}
client, _ := setting.ToClient(componenttest.NewNopHost(), componenttest.NewNopTelemetrySettings())
req, err := http.NewRequest(http.MethodGet, setting.Endpoint, nil)
assert.NoError(t, err)
_, err = client.Do(req)
assert.NoError(t, err)
})
}

func TestContextWithClient(t *testing.T) {
testCases := []struct {
desc string
Expand Down
Loading