grpc: support per-message compression and enforce embedding in ServerTransportStream implementations #8972
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -27,9 +27,11 @@ import ( | |
|
|
||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/codes" | ||
| "google.golang.org/grpc/credentials/insecure" | ||
| "google.golang.org/grpc/encoding" | ||
| "google.golang.org/grpc/encoding/internal" | ||
| "google.golang.org/grpc/internal/stubserver" | ||
| "google.golang.org/grpc/stats" | ||
| "google.golang.org/grpc/status" | ||
|
|
||
| testgrpc "google.golang.org/grpc/interop/grpc_testing" | ||
|
|
@@ -237,3 +239,271 @@ func (s) TestDecompressionExceedsMaxMessageSize(t *testing.T) { | |
| t.Errorf("Client.UnaryCall(%+v) returned status %v, want %v", req, got, want) | ||
| } | ||
| } | ||
|
|
||
| // statsHandler is a stats.Handler that counts the number of compressed | ||
| // outbound and inbound messages by comparing CompressedLength to Length. | ||
| type statsHandler struct { | ||
| stats.Handler | ||
| compress atomic.Int32 | ||
| decompress atomic.Int32 | ||
| } | ||
|
|
||
| func (h *statsHandler) TagRPC(ctx context.Context, _ *stats.RPCTagInfo) context.Context { return ctx } | ||
| func (h *statsHandler) TagConn(ctx context.Context, _ *stats.ConnTagInfo) context.Context { return ctx } | ||
| func (h *statsHandler) HandleConn(context.Context, stats.ConnStats) {} | ||
| func (h *statsHandler) HandleRPC(_ context.Context, s stats.RPCStats) { | ||
| switch st := s.(type) { | ||
| case *stats.OutPayload: | ||
| if st.CompressedLength < st.Length { | ||
| h.compress.Add(1) | ||
| } | ||
| case *stats.InPayload: | ||
| if st.CompressedLength < st.Length { | ||
| h.decompress.Add(1) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // TestMessageCompression_StreamToggle tests that SetServerStreamMessageCompression | ||
| // and SetClientStreamMessageCompression correctly enable and disable per-message | ||
| // compression mid-stream on the server and client side respectively. | ||
| func (s) TestMessageCompression_StreamToggle(t *testing.T) { | ||
| sh := &statsHandler{} | ||
| ss := &stubserver.StubServer{ | ||
| FullDuplexCallF: func(stream testgrpc.TestService_FullDuplexCallServer) error { | ||
| if _, err := stream.Recv(); err != nil { | ||
| return err | ||
| } | ||
| if err := stream.Send(&testpb.StreamingOutputCallResponse{ | ||
| Payload: &testpb.Payload{Body: make([]byte, 1000)}, | ||
| }); err != nil { | ||
| return err | ||
| } | ||
| if _, err := stream.Recv(); err != nil { | ||
| return err | ||
| } | ||
| if err := grpc.SetServerStreamMessageCompression(stream.Context(), false); err != nil { | ||
| return err | ||
| } | ||
| if err := stream.Send(&testpb.StreamingOutputCallResponse{ | ||
| Payload: &testpb.Payload{Body: make([]byte, 1000)}, | ||
| }); err != nil { | ||
| return err | ||
| } | ||
| if _, err := stream.Recv(); err != nil { | ||
| return err | ||
| } | ||
| if err := grpc.SetServerStreamMessageCompression(stream.Context(), true); err != nil { | ||
| return err | ||
| } | ||
| return stream.Send(&testpb.StreamingOutputCallResponse{ | ||
| Payload: &testpb.Payload{Body: make([]byte, 1000)}, | ||
| }) | ||
| }, | ||
| } | ||
|
|
||
| if err := ss.Start(nil, grpc.WithStatsHandler(sh)); err != nil { | ||
| t.Fatalf("Error starting server: %v", err) | ||
| } | ||
| defer ss.Stop() | ||
|
|
||
| ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout) | ||
| defer cancel() | ||
|
|
||
| stream, err := ss.Client.FullDuplexCall(ctx, grpc.UseCompressor("gzip")) | ||
| if err != nil { | ||
| t.Fatalf("FullDuplexCall failed: %v", err) | ||
| } | ||
|
|
||
| // 1. Send first compressed message | ||
| stream.Send(&testpb.StreamingOutputCallRequest{Payload: &testpb.Payload{Body: make([]byte, 1000)}}) | ||
| stream.Recv() | ||
| if sh.compress.Load() != 1 || sh.decompress.Load() != 1 { | ||
| t.Fatalf("After call 1 (compression enabled): got compress=%d decompress=%d, want compress=1 decompress=1", | ||
| sh.compress.Load(), sh.decompress.Load()) | ||
| } | ||
|
|
||
| // 2. Disable message compression and send second message | ||
| grpc.SetClientStreamMessageCompression(stream.Context(), false) | ||
| stream.Send(&testpb.StreamingOutputCallRequest{Payload: &testpb.Payload{Body: make([]byte, 1000)}}) | ||
| stream.Recv() | ||
| if sh.compress.Load() != 1 || sh.decompress.Load() != 1 { | ||
| t.Fatalf("After call 2 (compression disabled): got compress=%d decompress=%d, want compress=1 decompress=1", | ||
| sh.compress.Load(), sh.decompress.Load()) | ||
| } | ||
|
|
||
| // 3. Enable message compression and send third message | ||
| grpc.SetClientStreamMessageCompression(stream.Context(), true) | ||
| stream.Send(&testpb.StreamingOutputCallRequest{Payload: &testpb.Payload{Body: make([]byte, 1000)}}) | ||
| stream.Recv() | ||
| if sh.compress.Load() != 2 || sh.decompress.Load() != 2 { | ||
| t.Fatalf("After call 3 (compression re-enabled): got compress=%d decompress=%d, want compress=2 decompress=2", | ||
| sh.compress.Load(), sh.decompress.Load()) | ||
| } | ||
| } | ||
|
|
||
| // TestMessageCompression_AmbiguousContext verifies that | ||
| // SetServerStreamMessageCompression and SetClientStreamMessageCompression work | ||
| // independently when called on a context that contains keys for both a server | ||
| // stream and a client stream. This situation arises when a server handler | ||
| // propagates its context to an outbound gRPC call for deadline propagation: | ||
| // the outbound ClientStream.Context() inherits the server-stream key from the | ||
| // parent and also adds its own client-stream compression key. | ||
| func (s) TestMessageCompression_AmbiguousContext(t *testing.T) { | ||
| backendSH := &statsHandler{} | ||
| backend := &stubserver.StubServer{ | ||
| FullDuplexCallF: func(stream testgrpc.TestService_FullDuplexCallServer) error { | ||
| for { | ||
| if _, err := stream.Recv(); err == io.EOF { | ||
| return nil | ||
| } else if err != nil { | ||
| return err | ||
| } | ||
| if err := stream.Send(&testpb.StreamingOutputCallResponse{ | ||
| Payload: &testpb.Payload{Body: make([]byte, 1000)}, | ||
| }); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| }, | ||
| } | ||
| if err := backend.StartServer(grpc.StatsHandler(backendSH)); err != nil { | ||
| t.Fatalf("Error starting backend: %v", err) | ||
| } | ||
| defer backend.Stop() | ||
|
|
||
| // errCh carries any errors from the two SetXxx calls inside the proxy handler. | ||
| errCh := make(chan error, 2) | ||
| proxy := &stubserver.StubServer{ | ||
| FullDuplexCallF: func(serverStream testgrpc.TestService_FullDuplexCallServer) error { | ||
| // Use the server handler's context as the parent for the outbound | ||
| // call. This is the standard deadline-propagation pattern and is | ||
| // what makes the resulting context "ambiguous": it inherits | ||
| // streamKey{} from the server infrastructure, and the gRPC client | ||
| // stack appends compressKey{} when creating the outbound stream. | ||
| backendConn, err := grpc.NewClient( | ||
| backend.Address, | ||
| grpc.WithTransportCredentials(insecure.NewCredentials()), | ||
| ) | ||
|
Contributor
There was a problem hiding this comment. Single line here too. Please see: https://google.github.io/styleguide/go/guide#line-length |
||
| if err != nil { | ||
| return err | ||
| } | ||
| defer backendConn.Close() | ||
|
|
||
| clientStream, err := testgrpc.NewTestServiceClient(backendConn).FullDuplexCall( | ||
| serverStream.Context(), grpc.UseCompressor("gzip"), | ||
| ) | ||
|
|
||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // clientStream.Context() now has BOTH: | ||
| // - streamKey{} → the proxy's own server-side transport stream | ||
| // - compressKey{} → the outbound client stream's compression flag | ||
| ambiguousCtx := clientStream.Context() | ||
|
|
||
| // Must only affect the server stream (proxy → original caller). | ||
| errCh <- grpc.SetServerStreamMessageCompression(ambiguousCtx, false) | ||
| // Must only affect the client stream (proxy → backend). | ||
| errCh <- grpc.SetClientStreamMessageCompression(ambiguousCtx, false) | ||
|
|
||
| // Forward one request/response pair through the proxy. | ||
| req, err := serverStream.Recv() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if err := clientStream.Send(req); err != nil { | ||
| return err | ||
| } | ||
| if err := clientStream.CloseSend(); err != nil { | ||
| return err | ||
| } | ||
| resp, err := clientStream.Recv() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| return serverStream.Send(resp) | ||
| }, | ||
| } | ||
| proxySH := &statsHandler{} | ||
| if err := proxy.Start([]grpc.ServerOption{grpc.StatsHandler(proxySH)}); err != nil { | ||
| t.Fatalf("Error starting proxy: %v", err) | ||
| } | ||
| defer proxy.Stop() | ||
|
|
||
| ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout) | ||
| defer cancel() | ||
|
|
||
| stream, err := proxy.Client.FullDuplexCall(ctx, grpc.UseCompressor("gzip")) | ||
| if err != nil { | ||
| t.Fatalf("FullDuplexCall failed: %v", err) | ||
| } | ||
| if err := stream.Send(&testpb.StreamingOutputCallRequest{ | ||
| Payload: &testpb.Payload{Body: make([]byte, 1000)}, | ||
| }); err != nil { | ||
| t.Fatalf("Send failed: %v", err) | ||
| } | ||
| if _, err := stream.Recv(); err != nil { | ||
| t.Fatalf("Recv failed: %v", err) | ||
| } | ||
|
|
||
| // Collect results from both SetXxx calls. | ||
| for _, name := range []string{"SetServerStreamMessageCompression", "SetClientStreamMessageCompression"} { | ||
| select { | ||
| case err := <-errCh: | ||
| if err != nil { | ||
| t.Fatalf("%s on ambiguous context returned unexpected error: %v", name, err) | ||
| } | ||
| case <-ctx.Done(): | ||
| t.Fatalf("timed out waiting for %s result", name) | ||
| } | ||
| } | ||
|
|
||
| // SetServerStreamMessageCompression disabled compression on the | ||
| // proxy → caller direction: the proxy's server stream must not have | ||
| // sent any compressed messages. | ||
| if got := proxySH.compress.Load(); got != 0 { | ||
| t.Errorf("proxy server outbound compress count = %d, want 0 (SetServerStreamMessageCompression disabled it)", got) | ||
| } | ||
| // SetClientStreamMessageCompression disabled compression on the | ||
| // proxy → backend direction: the backend must not have received any | ||
| // compressed messages. | ||
| if got := backendSH.decompress.Load(); got != 0 { | ||
| t.Errorf("backend inbound decompress count = %d, want 0 (SetClientStreamMessageCompression disabled it)", got) | ||
| } | ||
| } | ||
|
|
||
| func (s) TestMessageCompression_Unary(t *testing.T) { | ||
| sh := &statsHandler{} | ||
| ss := &stubserver.StubServer{ | ||
| UnaryCallF: func(ctx context.Context, in *testpb.SimpleRequest) (*testpb.SimpleResponse, error) { | ||
| grpc.SetSendCompressor(ctx, "gzip") | ||
| if in.ResponseSize == 0 { | ||
| grpc.SetServerStreamMessageCompression(ctx, false) | ||
| } | ||
| return &testpb.SimpleResponse{Payload: &testpb.Payload{Body: make([]byte, 10000)}}, nil | ||
| }, | ||
| } | ||
|
|
||
| if err := ss.Start(nil, grpc.WithStatsHandler(sh)); err != nil { | ||
| t.Fatalf("Error starting server: %v", err) | ||
| } | ||
| defer ss.Stop() | ||
|
|
||
| ctx, cancel := context.WithTimeout(context.Background(), defaultTestTimeout) | ||
| defer cancel() | ||
|
|
||
| // Call 1: Compression ON | ||
| ss.Client.UnaryCall(ctx, &testpb.SimpleRequest{ResponseSize: 1, Payload: &testpb.Payload{Body: make([]byte, 1000)}}, grpc.UseCompressor("gzip")) | ||
| if sh.compress.Load() != 1 || sh.decompress.Load() != 1 { | ||
| t.Fatalf("After call 1 (compression enabled): got compress=%d decompress=%d, want compress=1 decompress=1", | ||
| sh.compress.Load(), sh.decompress.Load()) | ||
| } | ||
|
|
||
| // Call 2: Compression OFF (for response, but request is still compressed by UseCompressor) | ||
| ss.Client.UnaryCall(ctx, &testpb.SimpleRequest{ResponseSize: 0, Payload: &testpb.Payload{Body: make([]byte, 1000)}}, grpc.UseCompressor("gzip")) | ||
| if sh.compress.Load() != 2 || sh.decompress.Load() != 1 { | ||
| t.Fatalf("After call 2 (server response compression disabled): got compress=%d decompress=%d, want compress=2 decompress=1", | ||
| sh.compress.Load(), sh.decompress.Load()) | ||
| } | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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
Oops, something went wrong.
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.
Nit: Here and elsewhere in this test, please have these calls to
t.Fatalbe on a single line. Thanks.