-
Notifications
You must be signed in to change notification settings - Fork 8.8k
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
Improving Performance on the API Gzip Handler #12363
Merged
Merged
Changes from 3 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
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 |
---|---|---|
|
@@ -14,11 +14,12 @@ | |
package httputil | ||
|
||
import ( | ||
"compress/gzip" | ||
"compress/zlib" | ||
"io" | ||
"net/http" | ||
"strings" | ||
|
||
"github.com/klauspost/compress/gzhttp" | ||
) | ||
|
||
const ( | ||
|
@@ -30,51 +31,31 @@ const ( | |
|
||
// Wrapper around http.Handler which adds suitable response compression based | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's not around There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. good catch! thanks a lot for the comments btw! |
||
// on the client's Accept-Encoding headers. | ||
type compressedResponseWriter struct { | ||
type deflatedResponseWriter struct { | ||
bboreham marked this conversation as resolved.
Show resolved
Hide resolved
|
||
http.ResponseWriter | ||
writer io.Writer | ||
} | ||
|
||
// Writes HTTP response content data. | ||
func (c *compressedResponseWriter) Write(p []byte) (int, error) { | ||
func (c *deflatedResponseWriter) Write(p []byte) (int, error) { | ||
return c.writer.Write(p) | ||
} | ||
|
||
// Closes the compressedResponseWriter and ensures to flush all data before. | ||
func (c *compressedResponseWriter) Close() { | ||
// Closes the deflatedResponseWriter and ensures to flush all data before. | ||
func (c *deflatedResponseWriter) Close() { | ||
if zlibWriter, ok := c.writer.(*zlib.Writer); ok { | ||
zlibWriter.Flush() | ||
} | ||
if gzipWriter, ok := c.writer.(*gzip.Writer); ok { | ||
gzipWriter.Flush() | ||
} | ||
if closer, ok := c.writer.(io.Closer); ok { | ||
defer closer.Close() | ||
} | ||
} | ||
|
||
// Constructs a new compressedResponseWriter based on client request headers. | ||
func newCompressedResponseWriter(writer http.ResponseWriter, req *http.Request) *compressedResponseWriter { | ||
encodings := strings.Split(req.Header.Get(acceptEncodingHeader), ",") | ||
for _, encoding := range encodings { | ||
switch strings.TrimSpace(encoding) { | ||
case gzipEncoding: | ||
writer.Header().Set(contentEncodingHeader, gzipEncoding) | ||
return &compressedResponseWriter{ | ||
ResponseWriter: writer, | ||
writer: gzip.NewWriter(writer), | ||
} | ||
case deflateEncoding: | ||
writer.Header().Set(contentEncodingHeader, deflateEncoding) | ||
return &compressedResponseWriter{ | ||
ResponseWriter: writer, | ||
writer: zlib.NewWriter(writer), | ||
} | ||
} | ||
} | ||
return &compressedResponseWriter{ | ||
// Constructs a new deflatedResponseWriter to compress the original writer using 'deflate' compression. | ||
func newDeflateResponseWriter(writer http.ResponseWriter) *deflatedResponseWriter { | ||
return &deflatedResponseWriter{ | ||
ResponseWriter: writer, | ||
writer: writer, | ||
writer: zlib.NewWriter(writer), | ||
} | ||
} | ||
|
||
|
@@ -86,7 +67,21 @@ type CompressionHandler struct { | |
|
||
// ServeHTTP adds compression to the original http.Handler's ServeHTTP() method. | ||
func (c CompressionHandler) ServeHTTP(writer http.ResponseWriter, req *http.Request) { | ||
compWriter := newCompressedResponseWriter(writer, req) | ||
c.Handler.ServeHTTP(compWriter, req) | ||
compWriter.Close() | ||
encodings := strings.Split(req.Header.Get(acceptEncodingHeader), ",") | ||
for _, encoding := range encodings { | ||
switch strings.TrimSpace(encoding) { | ||
case gzipEncoding: | ||
gzhttp.GzipHandler(c.Handler).ServeHTTP(writer, req) | ||
return | ||
case deflateEncoding: | ||
compWriter := newDeflateResponseWriter(writer) | ||
writer.Header().Set(contentEncodingHeader, deflateEncoding) | ||
c.Handler.ServeHTTP(compWriter, req) | ||
compWriter.Close() | ||
return | ||
default: | ||
c.Handler.ServeHTTP(writer, req) | ||
return | ||
} | ||
} | ||
} |
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
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.
Why not change
zlib
to klauspost too?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.
Yeah.. we could.. lets do it! :D