-
Notifications
You must be signed in to change notification settings - Fork 84
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
wip: feat: add gzip and brotli middleware #232
Closed
Closed
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
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 |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| package middleware | ||
|
|
||
| import ( | ||
| "strings" | ||
|
|
||
| gbrotli "github.com/anargu/gin-brotli" | ||
| "github.com/andybalholm/brotli" | ||
| "github.com/gin-contrib/gzip" | ||
| "github.com/gin-gonic/gin" | ||
| httpcontract "github.com/goravel/framework/contracts/http" | ||
| "github.com/goravel/framework/http" | ||
| ) | ||
|
|
||
| func newGzipMiddleware() gin.HandlerFunc { | ||
| return gzip.Gzip(gzip.DefaultCompression) // http.ConfigFacade.GetInt("compression.encoders.gzip.compression_level")) | ||
| } | ||
|
|
||
| func newBrotliMiddleware() gin.HandlerFunc { | ||
| return gbrotli.Brotli(gbrotli.Options{ | ||
| WriterOptions: brotli.WriterOptions{ | ||
| Quality: brotli.DefaultCompression, // http.ConfigFacade.GetInt("compression.encoders.compression_level"), | ||
| LGWin: gbrotli.DefaultCompression.LGWin, | ||
| }, | ||
| SkipExtensions: gbrotli.DefaultCompression.SkipExtensions, | ||
| }) | ||
| } | ||
|
|
||
| func prefersBrotli(r httpcontract.Request) bool { | ||
| encodings := strings.Split(r.Header("Accept-Encoding"), ",") | ||
| for _, e := range encodings { | ||
| if e == "br" { | ||
| return true | ||
| } | ||
| } | ||
|
|
||
| return false | ||
| } | ||
|
|
||
| func Compression() httpcontract.Middleware { | ||
| gzipMiddleware := newGzipMiddleware() | ||
| brotliMiddleware := newBrotliMiddleware() | ||
| return func(ctx httpcontract.Context) { | ||
| switch ctx := ctx.(type) { | ||
| case *http.GinContext: | ||
| instance := ctx.Instance() | ||
| if prefersBrotli(ctx.Request()) { | ||
| brotliMiddleware(instance) | ||
| } else { | ||
| gzipMiddleware(instance) | ||
| } | ||
| } | ||
|
|
||
| ctx.Request().Next() | ||
| } | ||
| } | ||
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.
Q: Can we remove the gin dependency totally?
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.
Yes it should be possible I think. I found this package but it requires an http.Handler as input. Any clue how to use this here instead of the gin one?
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.
We may need to read the source code to understand how to implement Gzip.
By the way, I missed one thing, we can use Gzip by nginx, is it necessary to implement Gzip through the framework? Most time, we need to use Nginx to make a request forwarding. cc @Marian0
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.
My 2 cents is that it is something worth it to have in the framework. There was a time until ~2016 that it was preferred to always expose go services being a proxy, (such as nginx),. But then companies started to expose their go services directly and I believe notw it is actually safe to do that. Ofc you do not get the benefits of a true proxy but compression is a nice to have for such cases.
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.
Make sense, let's go ahead. 👍