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

Fixed double WriteHeader calls caused by #71 #73

Merged
merged 1 commit into from Aug 16, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions gzip.go
Expand Up @@ -159,6 +159,8 @@ func (w *GzipResponseWriter) startGzip() error {
// Write the header to gzip response.
if w.code != 0 {
w.ResponseWriter.WriteHeader(w.code)
// Ensure that no other WriteHeader's happen
w.code = 0
}

// Initialize and flush the buffer into the gzip response if there are any bytes.
Expand All @@ -184,6 +186,8 @@ func (w *GzipResponseWriter) startGzip() error {
func (w *GzipResponseWriter) startPlain() error {
if w.code != 0 {
w.ResponseWriter.WriteHeader(w.code)
// Ensure that no other WriteHeader's happen
w.code = 0
}
w.ignore = true
// If Write was never called then don't call Write on the underlying ResponseWriter.
Expand Down
52 changes: 52 additions & 0 deletions gzip_test.go
Expand Up @@ -346,6 +346,58 @@ func TestGzipDoubleClose(t *testing.T) {
assert.False(t, w1 == w2)
}

type panicOnSecondWriteHeaderWriter struct {
http.ResponseWriter
headerWritten bool
}

func (w *panicOnSecondWriteHeaderWriter) WriteHeader(s int) {
if w.headerWritten {
panic("header already written")
}
w.headerWritten = true
w.ResponseWriter.WriteHeader(s)
}

func TestGzipHandlerDoubleWriteHeader(t *testing.T) {
handler := GzipHandler(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Length", "15000")
// Specifically write the header here
w.WriteHeader(304)
// Ensure that after a Write the header isn't triggered again on close
w.Write(nil)
}))
wrapper := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w = &panicOnSecondWriteHeaderWriter{
ResponseWriter: w,
}
handler.ServeHTTP(w, r)
})

rec := httptest.NewRecorder()
// TODO: in Go1.7 httptest.NewRequest was introduced this should be used
// once 1.6 is not longer supported.
req := &http.Request{
Method: "GET",
URL: &url.URL{Path: "/"},
Proto: "HTTP/1.1",
ProtoMinor: 1,
RemoteAddr: "192.0.2.1:1234",
Header: make(http.Header),
}
req.Header.Set("Accept-Encoding", "gzip")
wrapper.ServeHTTP(rec, req)
body, err := ioutil.ReadAll(rec.Body)
if err != nil {
t.Fatalf("Unexpected error reading response body: %v", err)
}
assert.Empty(t, body)
header := rec.Header()
assert.Equal(t, "gzip", header.Get("Content-Encoding"))
assert.Equal(t, "Accept-Encoding", header.Get("Vary"))
assert.Equal(t, 304, rec.Code)
}

func TestStatusCodes(t *testing.T) {
handler := GzipHandler(http.NotFoundHandler())
r := httptest.NewRequest("GET", "/", nil)
Expand Down