Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix intercepting headers in middlewares
As explained in the TestInterceptedHeader test, in case a middleware filters out the headers, this middleware can be done inefficient in case one following handler is using c.String or other methods writing to the response body directly. This commit fixes the issue by using c.Writer when writing the Status as done in other c.Header, c.SetCookie and other response writers. The bug has been originally discovered using https://github.com/gin-contrib/gzip where a failing test has been added here: https://github.com/tjamet/gzip/blob/header/gzip_test.go#L71 Signed-off-by: Thibault Jamet <tjamet@users.noreply.github.com>
- Loading branch information
Showing
2 changed files
with
51 additions
and
1 deletion.
There are no files selected for viewing
This file contains 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 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,50 @@ | ||
// +build go1.7 | ||
|
||
package gin | ||
|
||
import ( | ||
"bytes" | ||
"net/http" | ||
"net/http/httptest" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/assert" | ||
) | ||
|
||
type interceptedWriter struct { | ||
ResponseWriter | ||
b *bytes.Buffer | ||
} | ||
|
||
func (i interceptedWriter) WriteHeader(code int) { | ||
i.Header().Del("X-Test") | ||
i.ResponseWriter.WriteHeader(code) | ||
} | ||
func TestInterceptedHeader(t *testing.T) { | ||
w := httptest.NewRecorder() | ||
c, r := CreateTestContext(w) | ||
|
||
r.Use(func(c *Context) { | ||
i := interceptedWriter{ | ||
ResponseWriter: c.Writer, | ||
b: bytes.NewBuffer(nil), | ||
} | ||
c.Writer = i | ||
c.Next() | ||
c.Header("X-Test", "overridden") | ||
c.Writer = i.ResponseWriter | ||
}) | ||
r.GET("/", func(c *Context) { | ||
c.Header("X-Test", "original") | ||
c.Header("X-Test-2", "present") | ||
c.String(http.StatusOK, "hello world") | ||
}) | ||
c.Request = httptest.NewRequest("GET", "/", nil) | ||
r.HandleContext(c) | ||
// Result() has headers frozen when WriteHeaderNow() has been called | ||
// Compared to this time, this is when the response headers will be flushed | ||
// As response is flushed on c.String, the Header cannot be set by the first | ||
// middleware. Assert this | ||
assert.Equal(t, "", w.Result().Header.Get("X-Test")) | ||
assert.Equal(t, "present", w.Result().Header.Get("X-Test-2")) | ||
} |