mirror of
https://github.com/labstack/echo.git
synced 2024-12-18 16:20:53 +02:00
365 lines
9.9 KiB
Go
365 lines
9.9 KiB
Go
package middleware
|
|
|
|
import (
|
|
"bytes"
|
|
"compress/gzip"
|
|
"io"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"os"
|
|
"testing"
|
|
|
|
"github.com/labstack/echo/v4"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestGzip(t *testing.T) {
|
|
e := echo.New()
|
|
req := httptest.NewRequest(http.MethodGet, "/", nil)
|
|
rec := httptest.NewRecorder()
|
|
c := e.NewContext(req, rec)
|
|
|
|
// Skip if no Accept-Encoding header
|
|
h := Gzip()(func(c echo.Context) error {
|
|
c.Response().Write([]byte("test")) // For Content-Type sniffing
|
|
return nil
|
|
})
|
|
h(c)
|
|
|
|
assert.Equal(t, "test", rec.Body.String())
|
|
|
|
// Gzip
|
|
req = httptest.NewRequest(http.MethodGet, "/", nil)
|
|
req.Header.Set(echo.HeaderAcceptEncoding, gzipScheme)
|
|
rec = httptest.NewRecorder()
|
|
c = e.NewContext(req, rec)
|
|
h(c)
|
|
assert.Equal(t, gzipScheme, rec.Header().Get(echo.HeaderContentEncoding))
|
|
assert.Contains(t, rec.Header().Get(echo.HeaderContentType), echo.MIMETextPlain)
|
|
r, err := gzip.NewReader(rec.Body)
|
|
if assert.NoError(t, err) {
|
|
buf := new(bytes.Buffer)
|
|
defer r.Close()
|
|
buf.ReadFrom(r)
|
|
assert.Equal(t, "test", buf.String())
|
|
}
|
|
|
|
chunkBuf := make([]byte, 5)
|
|
|
|
// Gzip chunked
|
|
req = httptest.NewRequest(http.MethodGet, "/", nil)
|
|
req.Header.Set(echo.HeaderAcceptEncoding, gzipScheme)
|
|
rec = httptest.NewRecorder()
|
|
|
|
c = e.NewContext(req, rec)
|
|
Gzip()(func(c echo.Context) error {
|
|
c.Response().Header().Set("Content-Type", "text/event-stream")
|
|
c.Response().Header().Set("Transfer-Encoding", "chunked")
|
|
|
|
// Write and flush the first part of the data
|
|
c.Response().Write([]byte("test\n"))
|
|
c.Response().Flush()
|
|
|
|
// Read the first part of the data
|
|
assert.True(t, rec.Flushed)
|
|
assert.Equal(t, gzipScheme, rec.Header().Get(echo.HeaderContentEncoding))
|
|
r.Reset(rec.Body)
|
|
|
|
_, err = io.ReadFull(r, chunkBuf)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, "test\n", string(chunkBuf))
|
|
|
|
// Write and flush the second part of the data
|
|
c.Response().Write([]byte("test\n"))
|
|
c.Response().Flush()
|
|
|
|
_, err = io.ReadFull(r, chunkBuf)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, "test\n", string(chunkBuf))
|
|
|
|
// Write the final part of the data and return
|
|
c.Response().Write([]byte("test"))
|
|
return nil
|
|
})(c)
|
|
|
|
buf := new(bytes.Buffer)
|
|
defer r.Close()
|
|
buf.ReadFrom(r)
|
|
assert.Equal(t, "test", buf.String())
|
|
}
|
|
|
|
func TestGzipWithMinLength(t *testing.T) {
|
|
e := echo.New()
|
|
// Minimal response length
|
|
e.Use(GzipWithConfig(GzipConfig{MinLength: 10}))
|
|
e.GET("/", func(c echo.Context) error {
|
|
c.Response().Write([]byte("foobarfoobar"))
|
|
return nil
|
|
})
|
|
|
|
req := httptest.NewRequest(http.MethodGet, "/", nil)
|
|
req.Header.Set(echo.HeaderAcceptEncoding, gzipScheme)
|
|
rec := httptest.NewRecorder()
|
|
e.ServeHTTP(rec, req)
|
|
assert.Equal(t, gzipScheme, rec.Header().Get(echo.HeaderContentEncoding))
|
|
r, err := gzip.NewReader(rec.Body)
|
|
if assert.NoError(t, err) {
|
|
buf := new(bytes.Buffer)
|
|
defer r.Close()
|
|
buf.ReadFrom(r)
|
|
assert.Equal(t, "foobarfoobar", buf.String())
|
|
}
|
|
}
|
|
|
|
func TestGzipWithMinLengthTooShort(t *testing.T) {
|
|
e := echo.New()
|
|
// Minimal response length
|
|
e.Use(GzipWithConfig(GzipConfig{MinLength: 10}))
|
|
e.GET("/", func(c echo.Context) error {
|
|
c.Response().Write([]byte("test"))
|
|
return nil
|
|
})
|
|
req := httptest.NewRequest(http.MethodGet, "/", nil)
|
|
req.Header.Set(echo.HeaderAcceptEncoding, gzipScheme)
|
|
rec := httptest.NewRecorder()
|
|
e.ServeHTTP(rec, req)
|
|
assert.Equal(t, "", rec.Header().Get(echo.HeaderContentEncoding))
|
|
assert.Contains(t, rec.Body.String(), "test")
|
|
}
|
|
|
|
func TestGzipWithResponseWithoutBody(t *testing.T) {
|
|
e := echo.New()
|
|
|
|
e.Use(Gzip())
|
|
e.GET("/", func(c echo.Context) error {
|
|
return c.Redirect(http.StatusMovedPermanently, "http://localhost")
|
|
})
|
|
|
|
req := httptest.NewRequest(http.MethodGet, "/", nil)
|
|
req.Header.Set(echo.HeaderAcceptEncoding, gzipScheme)
|
|
rec := httptest.NewRecorder()
|
|
|
|
e.ServeHTTP(rec, req)
|
|
|
|
assert.Equal(t, http.StatusMovedPermanently, rec.Code)
|
|
assert.Equal(t, "", rec.Header().Get(echo.HeaderContentEncoding))
|
|
}
|
|
|
|
func TestGzipWithMinLengthChunked(t *testing.T) {
|
|
e := echo.New()
|
|
|
|
// Gzip chunked
|
|
chunkBuf := make([]byte, 5)
|
|
|
|
req := httptest.NewRequest(http.MethodGet, "/", nil)
|
|
req.Header.Set(echo.HeaderAcceptEncoding, gzipScheme)
|
|
rec := httptest.NewRecorder()
|
|
|
|
var r *gzip.Reader = nil
|
|
|
|
c := e.NewContext(req, rec)
|
|
GzipWithConfig(GzipConfig{MinLength: 10})(func(c echo.Context) error {
|
|
c.Response().Header().Set("Content-Type", "text/event-stream")
|
|
c.Response().Header().Set("Transfer-Encoding", "chunked")
|
|
|
|
// Write and flush the first part of the data
|
|
c.Response().Write([]byte("test\n"))
|
|
c.Response().Flush()
|
|
|
|
// Read the first part of the data
|
|
assert.True(t, rec.Flushed)
|
|
assert.Equal(t, gzipScheme, rec.Header().Get(echo.HeaderContentEncoding))
|
|
|
|
var err error
|
|
r, err = gzip.NewReader(rec.Body)
|
|
assert.NoError(t, err)
|
|
|
|
_, err = io.ReadFull(r, chunkBuf)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, "test\n", string(chunkBuf))
|
|
|
|
// Write and flush the second part of the data
|
|
c.Response().Write([]byte("test\n"))
|
|
c.Response().Flush()
|
|
|
|
_, err = io.ReadFull(r, chunkBuf)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, "test\n", string(chunkBuf))
|
|
|
|
// Write the final part of the data and return
|
|
c.Response().Write([]byte("test"))
|
|
return nil
|
|
})(c)
|
|
|
|
assert.NotNil(t, r)
|
|
|
|
buf := new(bytes.Buffer)
|
|
|
|
buf.ReadFrom(r)
|
|
assert.Equal(t, "test", buf.String())
|
|
|
|
r.Close()
|
|
}
|
|
|
|
func TestGzipWithMinLengthNoContent(t *testing.T) {
|
|
e := echo.New()
|
|
req := httptest.NewRequest(http.MethodGet, "/", nil)
|
|
req.Header.Set(echo.HeaderAcceptEncoding, gzipScheme)
|
|
rec := httptest.NewRecorder()
|
|
c := e.NewContext(req, rec)
|
|
h := GzipWithConfig(GzipConfig{MinLength: 10})(func(c echo.Context) error {
|
|
return c.NoContent(http.StatusNoContent)
|
|
})
|
|
if assert.NoError(t, h(c)) {
|
|
assert.Empty(t, rec.Header().Get(echo.HeaderContentEncoding))
|
|
assert.Empty(t, rec.Header().Get(echo.HeaderContentType))
|
|
assert.Equal(t, 0, len(rec.Body.Bytes()))
|
|
}
|
|
}
|
|
|
|
func TestGzipNoContent(t *testing.T) {
|
|
e := echo.New()
|
|
req := httptest.NewRequest(http.MethodGet, "/", nil)
|
|
req.Header.Set(echo.HeaderAcceptEncoding, gzipScheme)
|
|
rec := httptest.NewRecorder()
|
|
c := e.NewContext(req, rec)
|
|
h := Gzip()(func(c echo.Context) error {
|
|
return c.NoContent(http.StatusNoContent)
|
|
})
|
|
if assert.NoError(t, h(c)) {
|
|
assert.Empty(t, rec.Header().Get(echo.HeaderContentEncoding))
|
|
assert.Empty(t, rec.Header().Get(echo.HeaderContentType))
|
|
assert.Equal(t, 0, len(rec.Body.Bytes()))
|
|
}
|
|
}
|
|
|
|
func TestGzipEmpty(t *testing.T) {
|
|
e := echo.New()
|
|
req := httptest.NewRequest(http.MethodGet, "/", nil)
|
|
req.Header.Set(echo.HeaderAcceptEncoding, gzipScheme)
|
|
rec := httptest.NewRecorder()
|
|
c := e.NewContext(req, rec)
|
|
h := Gzip()(func(c echo.Context) error {
|
|
return c.String(http.StatusOK, "")
|
|
})
|
|
if assert.NoError(t, h(c)) {
|
|
assert.Equal(t, gzipScheme, rec.Header().Get(echo.HeaderContentEncoding))
|
|
assert.Equal(t, "text/plain; charset=UTF-8", rec.Header().Get(echo.HeaderContentType))
|
|
r, err := gzip.NewReader(rec.Body)
|
|
if assert.NoError(t, err) {
|
|
var buf bytes.Buffer
|
|
buf.ReadFrom(r)
|
|
assert.Equal(t, "", buf.String())
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestGzipErrorReturned(t *testing.T) {
|
|
e := echo.New()
|
|
e.Use(Gzip())
|
|
e.GET("/", func(c echo.Context) error {
|
|
return echo.ErrNotFound
|
|
})
|
|
req := httptest.NewRequest(http.MethodGet, "/", nil)
|
|
req.Header.Set(echo.HeaderAcceptEncoding, gzipScheme)
|
|
rec := httptest.NewRecorder()
|
|
e.ServeHTTP(rec, req)
|
|
assert.Equal(t, http.StatusNotFound, rec.Code)
|
|
assert.Empty(t, rec.Header().Get(echo.HeaderContentEncoding))
|
|
}
|
|
|
|
func TestGzipErrorReturnedInvalidConfig(t *testing.T) {
|
|
e := echo.New()
|
|
// Invalid level
|
|
e.Use(GzipWithConfig(GzipConfig{Level: 12}))
|
|
e.GET("/", func(c echo.Context) error {
|
|
c.Response().Write([]byte("test"))
|
|
return nil
|
|
})
|
|
req := httptest.NewRequest(http.MethodGet, "/", nil)
|
|
req.Header.Set(echo.HeaderAcceptEncoding, gzipScheme)
|
|
rec := httptest.NewRecorder()
|
|
e.ServeHTTP(rec, req)
|
|
assert.Equal(t, http.StatusInternalServerError, rec.Code)
|
|
assert.Contains(t, rec.Body.String(), "gzip")
|
|
}
|
|
|
|
// Issue #806
|
|
func TestGzipWithStatic(t *testing.T) {
|
|
e := echo.New()
|
|
e.Use(Gzip())
|
|
e.Static("/test", "../_fixture/images")
|
|
req := httptest.NewRequest(http.MethodGet, "/test/walle.png", nil)
|
|
req.Header.Set(echo.HeaderAcceptEncoding, gzipScheme)
|
|
rec := httptest.NewRecorder()
|
|
e.ServeHTTP(rec, req)
|
|
assert.Equal(t, http.StatusOK, rec.Code)
|
|
// Data is written out in chunks when Content-Length == "", so only
|
|
// validate the content length if it's not set.
|
|
if cl := rec.Header().Get("Content-Length"); cl != "" {
|
|
assert.Equal(t, cl, rec.Body.Len())
|
|
}
|
|
r, err := gzip.NewReader(rec.Body)
|
|
if assert.NoError(t, err) {
|
|
defer r.Close()
|
|
want, err := os.ReadFile("../_fixture/images/walle.png")
|
|
if assert.NoError(t, err) {
|
|
buf := new(bytes.Buffer)
|
|
buf.ReadFrom(r)
|
|
assert.Equal(t, want, buf.Bytes())
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestGzipResponseWriter_CanUnwrap(t *testing.T) {
|
|
trwu := &testResponseWriterUnwrapper{rw: httptest.NewRecorder()}
|
|
bdrw := gzipResponseWriter{
|
|
ResponseWriter: trwu,
|
|
}
|
|
|
|
result := bdrw.Unwrap()
|
|
assert.Equal(t, trwu, result)
|
|
}
|
|
|
|
func TestGzipResponseWriter_CanHijack(t *testing.T) {
|
|
trwu := testResponseWriterUnwrapperHijack{testResponseWriterUnwrapper: testResponseWriterUnwrapper{rw: httptest.NewRecorder()}}
|
|
bdrw := gzipResponseWriter{
|
|
ResponseWriter: &trwu, // this RW supports hijacking through unwrapping
|
|
}
|
|
|
|
_, _, err := bdrw.Hijack()
|
|
assert.EqualError(t, err, "can hijack")
|
|
}
|
|
|
|
func TestGzipResponseWriter_CanNotHijack(t *testing.T) {
|
|
trwu := testResponseWriterUnwrapper{rw: httptest.NewRecorder()}
|
|
bdrw := gzipResponseWriter{
|
|
ResponseWriter: &trwu, // this RW supports hijacking through unwrapping
|
|
}
|
|
|
|
_, _, err := bdrw.Hijack()
|
|
assert.EqualError(t, err, "feature not supported")
|
|
}
|
|
|
|
func BenchmarkGzip(b *testing.B) {
|
|
e := echo.New()
|
|
|
|
req := httptest.NewRequest(http.MethodGet, "/", nil)
|
|
req.Header.Set(echo.HeaderAcceptEncoding, gzipScheme)
|
|
|
|
h := Gzip()(func(c echo.Context) error {
|
|
c.Response().Write([]byte("test")) // For Content-Type sniffing
|
|
return nil
|
|
})
|
|
|
|
b.ReportAllocs()
|
|
b.ResetTimer()
|
|
|
|
for i := 0; i < b.N; i++ {
|
|
// Gzip
|
|
rec := httptest.NewRecorder()
|
|
c := e.NewContext(req, rec)
|
|
h(c)
|
|
}
|
|
}
|