Repository navigation
Fix: strip hop-by-hop response headers, share SSE normalization, and dedupe the listener helpers #1605
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| package forwardproxy | ||
|
|
||
| import ( | ||
| "io" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/rossoctl/cortex/core/pipeline" | ||
| ) | ||
|
|
||
| // The tests in this file pin issue #1567 item 1. Hop-by-hop headers describe ONE | ||
| // connection and must not be forwarded. The four response-header copy loops used to | ||
| // relay them verbatim — requests were stripped (stripForUpstream) but responses were | ||
| // not, and a comment on one of the loops even claimed the stripping happened. Through | ||
| // the TLS bridge an HTTP/1.1 origin's Keep-Alive reaches an HTTP/2 client inside a | ||
| // HEADERS frame, which Node's http2 rejects with ERR_HTTP2_STREAM_ERROR. | ||
|
|
||
| // hopByHopUpstream answers every request with a body carrying the headers under test. | ||
| func hopByHopUpstream(t *testing.T, contentType string) *httptest.Server { | ||
| t.Helper() | ||
| upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| w.Header().Set("Content-Type", contentType) | ||
| // A hop-by-hop header by name... | ||
| w.Header().Set("Keep-Alive", "timeout=5") | ||
| // ...and one made hop-by-hop by being named in Connection. | ||
| w.Header().Set("Connection", "X-Hop-Extra") | ||
| w.Header().Set("X-Hop-Extra", "hop value") | ||
| // And one that must survive. | ||
| w.Header().Set("X-Normal", "kept") | ||
| w.WriteHeader(http.StatusOK) | ||
| _, _ = io.WriteString(w, "{}") | ||
| })) | ||
| t.Cleanup(upstream.Close) | ||
| return upstream | ||
| } | ||
|
|
||
| // proxyGet fetches url through a plain forward proxy (no plugins) and returns the | ||
| // response the proxy handed the client, body consumed. | ||
| func proxyGet(t *testing.T, url string) *http.Response { | ||
| t.Helper() | ||
| pipe, err := pipeline.New(nil) | ||
| if err != nil { | ||
| t.Fatalf("pipeline.New: %v", err) | ||
| } | ||
| srv, err := NewServer(pipeline.NewHolder(pipe), nil, nil) | ||
| if err != nil { | ||
| t.Fatalf("NewServer: %v", err) | ||
| } | ||
| proxy := httptest.NewServer(srv.Handler()) | ||
| t.Cleanup(proxy.Close) | ||
| client := &http.Client{ | ||
| Transport: &http.Transport{Proxy: http.ProxyURL(mustParseURL(proxy.URL))}, | ||
| Timeout: 10 * time.Second, | ||
| } | ||
| resp, err := client.Get(url + "/data") | ||
| if err != nil { | ||
| t.Fatalf("GET through the proxy: %v", err) | ||
| } | ||
| t.Cleanup(func() { _ = resp.Body.Close() }) | ||
| _, _ = io.Copy(io.Discard, resp.Body) | ||
| return resp | ||
| } | ||
|
|
||
| func assertNoHopByHop(t *testing.T, resp *http.Response) { | ||
| t.Helper() | ||
| if v := resp.Header.Get("Keep-Alive"); v != "" { | ||
| t.Errorf("Keep-Alive = %q, want absent — hop-by-hop headers describe one connection "+ | ||
| "and must not be forwarded to the client", v) | ||
| } | ||
| if v := resp.Header.Get("X-Hop-Extra"); v != "" { | ||
| t.Errorf("X-Hop-Extra = %q, want absent — a header named in Connection is hop-by-hop "+ | ||
| "for this connection, whatever its usual meaning", v) | ||
| } | ||
| if v := resp.Header.Get("X-Normal"); v != "kept" { | ||
| t.Errorf("X-Normal = %q, want %q — end-to-end headers must still be forwarded", v, "kept") | ||
| } | ||
| } | ||
|
|
||
| func TestForwardProxy_HopByHopResponseHeadersStripped(t *testing.T) { | ||
| resp := proxyGet(t, hopByHopUpstream(t, "application/json").URL) | ||
| assertNoHopByHop(t, resp) | ||
| } | ||
|
|
||
| // The streaming path has its own copy loop (streamPassthrough); the same rule must | ||
| // hold there. No StreamingResponder is configured, so the passthrough loop is the | ||
| // one that runs. | ||
| func TestForwardProxy_HopByHopResponseHeadersStrippedOnStream(t *testing.T) { | ||
| resp := proxyGet(t, hopByHopUpstream(t, "text/event-stream").URL) | ||
| assertNoHopByHop(t, resp) | ||
| } | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| package httpx | ||
|
|
||
| import "strings" | ||
|
|
||
| // IsEventStream reports whether a Content-Type header value names the SSE media | ||
| // type. Tolerates parameters ("text/event-stream; charset=utf-8") and ASCII case | ||
| // differences. | ||
| // | ||
| // ONE definition for all three listeners (#1567): the forward proxy, reverse proxy | ||
| // and ext_proc listeners each carried their own copy, and a fix to one — the | ||
| // parameter tolerance — reached the others only by re-editing every copy. The | ||
| // copies were identical only because someone kept them that way. | ||
| func IsEventStream(contentType string) bool { | ||
| if contentType == "" { | ||
| return false | ||
| } | ||
| // Strip parameters: "text/event-stream; charset=utf-8" → "text/event-stream". | ||
| if idx := strings.IndexByte(contentType, ';'); idx >= 0 { | ||
| contentType = contentType[:idx] | ||
| } | ||
| return strings.EqualFold(strings.TrimSpace(contentType), "text/event-stream") | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion: these two tests pin the buffered path (
serveOutbound) andstreamPassthrough. The other two call sites,handleStreamingResponse(when a StreamingResponder is configured) andstreamFallbackBuffered(an SSE stream with aWritesResponseBodyplugin), aren't covered. The helper is shared, so the logic is covered once. But the bug in #1567 was literally a copy loop at one site, so if someone inlines a loop back into one of those two paths, nothing would catch it. A small table that adds a no-op StreamingResponder plugin and a no-op response mutator would cover all four sites.