feat: add gzip to http responses for query/batch-query #232
Conversation
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
michaelx11
commented
Jan 27, 2023
| @@ -118,7 +118,7 @@ func Test_QueryNoTopics(t *testing.T) { | |||
| require.Equal(t, codes.InvalidArgument, grpcErr.Code()) | |||
| require.EqualError(t, err, `rpc error: code = InvalidArgument desc = content topics required`) | |||
| } else { | |||
| require.EqualError(t, err, "400 Bad Request: {\"code\":3, \"message\":\"content topics required\", \"details\":[]}") | |||
| require.Regexp(t, `400 Bad Request: {"code\":3,\s?"message":"content topics required",\s?"details":\[\]}`, err.Error()) | |||
There was a problem hiding this comment.
somehow the whitespaces get stripped now? I noticed the test above already accounts for this via regexp so did the same here
There was a problem hiding this comment.
Oh right I think this is what's happening golang/protobuf#1121
mkobetic
approved these changes
Jan 27, 2023
snormore
approved these changes
Jan 27, 2023
pkg/api/handler_utils.go
Outdated
| @@ -0,0 +1,39 @@ | |||
| package api | |||
There was a problem hiding this comment.
Want to just call this file gzip.go?
There was a problem hiding this comment.
good call, will make that change
There was a problem hiding this comment.
I ended up renaming to gzip_handler.go, I balked at gzip.go since it seemed like a name that could be used a lot elsewhere.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Goal
This PR implements gzip compression for HTTP responses of the JSON interface of our node gRPC API. This happens for responses to
queryandbatch-querymethods. As of now, clients already send:Accept-Encoding: gzip, deflatebut server responses are not currently compressed. Given 1) base64 encoding and 2) redundant structure and fields, our responses are pretty compressible even though the envelope contents are high entropy.(encrypted contents of test accounts, no sweat that I'm pasting here)
Changes
One issue is that our clients currently send
Accept-Encoding: gzipeven for long-lived/subscriberequests, which our server will happily attempt to gzip before sending a response. To combat this I've implemented our gzip handler with standard libraries and gated it to just/query && /batch-queryresponses.Testing