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.

Sign up for GitHub

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

Skip empty headers key if they present in the opts.Headers #1203

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Skip empty headers key if they present in the opts.Headers #1203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46906d5
Skip empty headers key if they present
dmitryk-dk Jan 22, 2025
71389e4
clarify test
dmitryk-dk Jan 22, 2025
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
4 changes: 4 additions & 0 deletions backend/httpclient/custom_headers_middleware.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ func CustomHeadersMiddleware() Middleware {

return RoundTripperFunc(func(req *http.Request) (*http.Response, error) {
for key, values := range opts.Header {
// Skip empty keys as they are not allowed
if key == "" {
continue
}
// According to https://pkg.go.dev/net/http#Request.Header, Host is a special case
if http.CanonicalHeaderKey(key) == "Host" {
req.Host = values[0]
Expand Down
25 changes: 25 additions & 0 deletions backend/httpclient/custom_headers_middleware_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,4 +112,29 @@ func TestCustomHeadersMiddleware(t *testing.T) {

require.Equal(t, []string{"ValueOne"}, req.Header.Values("X-Headerone"))
})

t.Run("With empty key should skip adding the header", func(t *testing.T) {
ctx := &testContext{}
finalRoundTripper := ctx.createRoundTripper("final")
customHeaders := CustomHeadersMiddleware()
rt := customHeaders.CreateMiddleware(Options{Header: http.Header{
"": {"ValueOne"},
}}, finalRoundTripper)
require.NotNil(t, rt)
middlewareName, ok := customHeaders.(MiddlewareName)
require.True(t, ok)
require.Equal(t, CustomHeadersMiddlewareName, middlewareName.MiddlewareName())

req, err := http.NewRequest(http.MethodGet, "http://", nil)
require.NoError(t, err)
res, err := rt.RoundTrip(req)
require.NoError(t, err)
require.NotNil(t, res)
if res.Body != nil {
require.NoError(t, res.Body.Close())
}
require.Len(t, ctx.callChain, 1)
require.ElementsMatch(t, []string{"final"}, ctx.callChain)
require.Equal(t, 0, len(req.Header))
})
}