feat: support response compression (#199)

Author: hgiasac

cmd/hasura-ndc-go/command/internal/testdata/basic/source/go.mod

@@ -20,6 +20,7 @@ require (
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/go-viper/mapstructure/v2 v2.4.0 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.27.1 // indirect
+	github.com/klauspost/compress v1.18.0 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/prometheus/client_golang v1.23.0 // indirect
 	github.com/prometheus/client_model v0.6.2 // indirect

cmd/hasura-ndc-go/command/internal/testdata/empty/source/go.mod

@@ -19,6 +19,7 @@ require (
 	github.com/go-viper/mapstructure/v2 v2.4.0 // indirect
 	github.com/google/uuid v1.6.0 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.27.1 // indirect
+	github.com/klauspost/compress v1.18.0 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/prometheus/client_golang v1.23.0 // indirect
 	github.com/prometheus/client_model v0.6.2 // indirect

cmd/hasura-ndc-go/command/internal/testdata/single_op/source/go.mod

@@ -20,6 +20,7 @@ require (
 	github.com/go-viper/mapstructure/v2 v2.4.0 // indirect
 	github.com/google/uuid v1.6.0 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.27.1 // indirect
+	github.com/klauspost/compress v1.18.0 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/prometheus/client_golang v1.23.0 // indirect
 	github.com/prometheus/client_model v0.6.2 // indirect

cmd/hasura-ndc-go/command/internal/testdata/snake_case/source/go.mod

@@ -20,6 +20,7 @@ require (
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/go-viper/mapstructure/v2 v2.4.0 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.27.1 // indirect
+	github.com/klauspost/compress v1.18.0 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/prometheus/client_golang v1.23.0 // indirect
 	github.com/prometheus/client_model v0.6.2 // indirect

connector/http.go

@@ -52,28 +52,6 @@ var allowedTraceEndpoints = map[string]string{
 
 var debugApiPaths = []string{apiPathMetrics, apiPathHealth}
 
-// define a custom response write to capture response information for logging.
-type customResponseWriter struct {
-	http.ResponseWriter
-
-	statusCode int
-	bodyLength int
-	body       []byte
-}
-
-func (cw *customResponseWriter) WriteHeader(statusCode int) {
-	cw.statusCode = statusCode
-	cw.ResponseWriter.WriteHeader(statusCode)
-}
-
-func (cw *customResponseWriter) Write(body []byte) (int, error) {
-	cw.body = body
-	bodyLength, err := cw.ResponseWriter.Write(body)
-	cw.bodyLength = bodyLength
-
-	return bodyLength, err
-}
-
 // implements a simple router to reuse for both configuration and connector servers.
 type router struct {
 	routes          map[string]map[string][]http.HandlerFunc
@@ -258,7 +236,7 @@ func (rt *router) createHandleFunc( //nolint:gocognit
 
 		logger := rt.logger.With(slog.String("request_id", requestID))
 		req := r.WithContext(context.WithValue(ctx, logContextKey, logger))
-		writer := &customResponseWriter{ResponseWriter: w}
+		writer := newCustomResponseWriter(r, w)
 
 		for _, h := range handlers {
 			h(writer, req)

connector/response.go

@@ -0,0 +1,72 @@
+package connector
+
+import (
+	"bytes"
+	"net/http"
+	"strings"
+
+	"github.com/hasura/ndc-sdk-go/utils/compression"
+)
+
+const (
+	acceptEncodingHeader  = "Accept-Encoding"
+	contentEncodingHeader = "Content-Encoding"
+)
+
+// define a custom response write to capture response information for logging.
+type customResponseWriter struct {
+	http.ResponseWriter
+
+	contentEncoding string
+	statusCode      int
+	bodyLength      int
+	body            []byte
+}
+
+var _ http.ResponseWriter = (*customResponseWriter)(nil)
+
+func newCustomResponseWriter(r *http.Request, w http.ResponseWriter) *customResponseWriter {
+	var contentEncoding string
+
+	acceptEncoding := r.Header.Get(acceptEncodingHeader)
+
+	if acceptEncoding != "" {
+		for enc := range strings.SplitSeq(acceptEncoding, ",") {
+			enc = strings.ToLower(strings.TrimSpace(enc))
+
+			if compression.DefaultCompressor.IsEncodingSupported(enc) {
+				contentEncoding = enc
+
+				break
+			}
+		}
+	}
+
+	return &customResponseWriter{
+		ResponseWriter:  w,
+		contentEncoding: contentEncoding,
+	}
+}
+
+func (cw *customResponseWriter) WriteHeader(statusCode int) {
+	cw.statusCode = statusCode
+
+	if cw.contentEncoding != "" {
+		cw.ResponseWriter.Header().Set(contentEncodingHeader, cw.contentEncoding)
+	}
+
+	cw.ResponseWriter.WriteHeader(statusCode)
+}
+
+func (cw *customResponseWriter) Write(body []byte) (int, error) {
+	cw.body = body
+	cw.bodyLength = len(body)
+
+	written, err := compression.DefaultCompressor.Compress(
+		cw.ResponseWriter,
+		cw.contentEncoding,
+		bytes.NewReader(body),
+	)
+
+	return int(written), err
+}

connector/server_test.go

@@ -14,6 +14,7 @@ import (
 
 	"github.com/hasura/ndc-sdk-go/schema"
 	"github.com/hasura/ndc-sdk-go/utils"
+	"github.com/hasura/ndc-sdk-go/utils/compression"
 	"gotest.tools/v3/assert"
 )
 
@@ -226,11 +227,11 @@ func (mc *mockConnector) Query(
 	}, nil
 }
 
-func httpPostJSON(url string, body any) (*http.Response, error) {
-	return httpPostJSONWithNDCVersion(url, schema.NDCVersion, body)
+func httpPostJSON(url string, headers map[string]string, body any) (*http.Response, error) {
+	return httpPostJSONWithNDCVersion(url, schema.NDCVersion, headers, body)
 }
 
-func httpPostJSONWithNDCVersion(url string, ndcVersion string, body any) (*http.Response, error) {
+func httpPostJSONWithNDCVersion(url string, ndcVersion string, headers map[string]string, body any) (*http.Response, error) {
 	bodyBytes, err := json.Marshal(body)
 	if err != nil {
 		return nil, err
@@ -244,6 +245,10 @@ func httpPostJSONWithNDCVersion(url string, ndcVersion string, body any) (*http.
 	req.Header.Set("Content-Type", "application/json")
 	req.Header.Set(schema.XHasuraNDCVersion, ndcVersion)
 
+	for key, value := range headers {
+		req.Header.Set(key, value)
+	}
+
 	return http.DefaultClient.Do(req)
 }
 
@@ -252,9 +257,21 @@ func assertHTTPResponse[B any](t *testing.T, res *http.Response, statusCode int,
 
 	defer res.Body.Close()
 
-	bodyBytes, err := io.ReadAll(res.Body)
+	var bodyBytes []byte
+	var err error
+	contentEnc := res.Header.Get(contentEncodingHeader)
+
+	if contentEnc != "" {
+		db, err := compression.DefaultCompressor.Decompress(res.Body, contentEnc)
+		assert.NilError(t, err)
+
+		bodyBytes, err = io.ReadAll(db)
+	} else {
+		bodyBytes, err = io.ReadAll(res.Body)
+	}
+
 	if err != nil {
-		t.Error("failed to read response body")
+		t.Errorf("failed to read response body: %s", err)
 		t.FailNow()
 	}
 
@@ -422,7 +439,7 @@ func TestServerConnector(t *testing.T) {
 	})
 
 	t.Run("POST /query", func(t *testing.T) {
-		res, err := httpPostJSON(fmt.Sprintf("%s/query", httpServer.URL), schema.QueryRequest{
+		res, err := httpPostJSON(fmt.Sprintf("%s/query", httpServer.URL), nil, schema.QueryRequest{
 			Collection:              "articles",
 			Arguments:               schema.QueryRequestArguments{},
 			CollectionRelationships: schema.QueryRequestCollectionRelationships{},
@@ -448,7 +465,7 @@ func TestServerConnector(t *testing.T) {
 	})
 
 	t.Run("POST /query - json decode failure", func(t *testing.T) {
-		res, err := httpPostJSON(fmt.Sprintf("%s/query", httpServer.URL), "")
+		res, err := httpPostJSON(fmt.Sprintf("%s/query", httpServer.URL), nil, "")
 		if err != nil {
 			t.Errorf("expected no error, got %s", err)
 			t.FailNow()
@@ -463,7 +480,7 @@ func TestServerConnector(t *testing.T) {
 	})
 
 	t.Run("POST /query - collection not found", func(t *testing.T) {
-		res, err := httpPostJSON(fmt.Sprintf("%s/query", httpServer.URL), schema.QueryRequest{
+		res, err := httpPostJSON(fmt.Sprintf("%s/query", httpServer.URL), nil, schema.QueryRequest{
 			Collection:              "test",
 			Arguments:               schema.QueryRequestArguments{},
 			CollectionRelationships: schema.QueryRequestCollectionRelationships{},
@@ -485,6 +502,7 @@ func TestServerConnector(t *testing.T) {
 		res, err := httpPostJSONWithNDCVersion(
 			fmt.Sprintf("%s/query", httpServer.URL),
 			"unknown",
+			nil,
 			schema.QueryRequest{
 				Collection:              "test",
 				Arguments:               schema.QueryRequestArguments{},
@@ -506,7 +524,7 @@ func TestServerConnector(t *testing.T) {
 	t.Run("POST_query_max_body_size", func(t *testing.T) {
 		collectionName := strings.Repeat("xxxxxxxxxxxxxxxx", 1024*1024/16)
 
-		res, err := httpPostJSON(fmt.Sprintf("%s/query", httpServer.URL), schema.QueryRequest{
+		res, err := httpPostJSON(fmt.Sprintf("%s/query", httpServer.URL), nil, schema.QueryRequest{
 			Collection:              collectionName,
 			Arguments:               schema.QueryRequestArguments{},
 			CollectionRelationships: schema.QueryRequestCollectionRelationships{},
@@ -525,7 +543,7 @@ func TestServerConnector(t *testing.T) {
 	})
 
 	t.Run("POST /mutation", func(t *testing.T) {
-		res, err := httpPostJSON(fmt.Sprintf("%s/mutation", httpServer.URL), schema.MutationRequest{
+		res, err := httpPostJSON(fmt.Sprintf("%s/mutation", httpServer.URL), nil, schema.MutationRequest{
 			Operations: []schema.MutationOperation{
 				{
 					Type: "procedure",
@@ -547,7 +565,7 @@ func TestServerConnector(t *testing.T) {
 	})
 
 	t.Run("POST /mutation - json decode failure", func(t *testing.T) {
-		res, err := httpPostJSON(fmt.Sprintf("%s/mutation", httpServer.URL), "")
+		res, err := httpPostJSON(fmt.Sprintf("%s/mutation", httpServer.URL), nil, "")
 		if err != nil {
 			t.Errorf("expected no error, got %s", err)
 			t.FailNow()
@@ -562,7 +580,7 @@ func TestServerConnector(t *testing.T) {
 	})
 
 	t.Run("POST /mutation - operation not found", func(t *testing.T) {
-		res, err := httpPostJSON(fmt.Sprintf("%s/mutation", httpServer.URL), schema.MutationRequest{
+		res, err := httpPostJSON(fmt.Sprintf("%s/mutation", httpServer.URL), nil, schema.MutationRequest{
 			Operations: []schema.MutationOperation{
 				{
 					Type: "procedure",
@@ -586,6 +604,7 @@ func TestServerConnector(t *testing.T) {
 		res, err := httpPostJSONWithNDCVersion(
 			fmt.Sprintf("%s/mutation", httpServer.URL),
 			"v0.1.6",
+			nil,
 			schema.MutationRequest{
 				Operations: []schema.MutationOperation{
 					{
@@ -613,7 +632,7 @@ func TestServerConnector(t *testing.T) {
 
 	t.Run("POST_mutation_max_body_size", func(t *testing.T) {
 		collectionName := strings.Repeat("xxxxxxxxxxxxxxxx", 1024*1024/16)
-		res, err := httpPostJSON(fmt.Sprintf("%s/mutation", httpServer.URL), schema.MutationRequest{
+		res, err := httpPostJSON(fmt.Sprintf("%s/mutation", httpServer.URL), nil, schema.MutationRequest{
 			Operations: []schema.MutationOperation{
 				{
 					Type: "procedure",
@@ -637,6 +656,7 @@ func TestServerConnector(t *testing.T) {
 	t.Run("POST /query/explain", func(t *testing.T) {
 		res, err := httpPostJSON(
 			fmt.Sprintf("%s/query/explain", httpServer.URL),
+			nil,
 			schema.QueryRequest{
 				Collection:              "articles",
 				Arguments:               schema.QueryRequestArguments{},
@@ -655,8 +675,40 @@ func TestServerConnector(t *testing.T) {
 		})
 	})
 
+	for _, encoding := range []compression.CompressionFormat{
+		compression.EncodingDeflate,
+		compression.EncodingGzip,
+		compression.EncodingZstd,
+	} {
+		t.Run("POST_query_explain_"+string(encoding), func(t *testing.T) {
+			res, err := httpPostJSON(
+				fmt.Sprintf("%s/query/explain", httpServer.URL),
+				map[string]string{
+					acceptEncodingHeader: string(encoding),
+				},
+				schema.QueryRequest{
+					Collection:              "articles",
+					Arguments:               schema.QueryRequestArguments{},
+					CollectionRelationships: schema.QueryRequestCollectionRelationships{},
+					Query:                   schema.Query{},
+					Variables:               []schema.QueryRequestVariablesElem{},
+				},
+			)
+			if err != nil {
+				t.Errorf("expected no error, got %s", err)
+				t.FailNow()
+			}
+
+			assert.Equal(t, string(encoding), res.Header.Get(contentEncodingHeader))
+
+			assertHTTPResponse(t, res, http.StatusOK, schema.ExplainResponse{
+				Details: schema.ExplainResponseDetails{},
+			})
+		})
+	}
+
 	t.Run("POST /query/explain - json decode failure", func(t *testing.T) {
-		res, err := httpPostJSON(fmt.Sprintf("%s/query/explain", httpServer.URL), map[string]any{})
+		res, err := httpPostJSON(fmt.Sprintf("%s/query/explain", httpServer.URL), nil, map[string]any{})
 		if err != nil {
 			t.Errorf("expected no error, got %s", err)
 			t.FailNow()
@@ -674,6 +726,7 @@ func TestServerConnector(t *testing.T) {
 		res, err := httpPostJSONWithNDCVersion(
 			fmt.Sprintf("%s/query/explain", httpServer.URL),
 			"unknown",
+			nil,
 			map[string]any{},
 		)
 		if err != nil {
@@ -690,6 +743,7 @@ func TestServerConnector(t *testing.T) {
 	t.Run("POST /mutation/explain", func(t *testing.T) {
 		res, err := httpPostJSON(
 			fmt.Sprintf("%s/mutation/explain", httpServer.URL),
+			nil,
 			schema.MutationRequest{
 				Operations:              []schema.MutationOperation{},
 				CollectionRelationships: make(schema.MutationRequestCollectionRelationships),
@@ -708,6 +762,7 @@ func TestServerConnector(t *testing.T) {
 	t.Run("POST /mutation/explain - json decode failure", func(t *testing.T) {
 		res, err := httpPostJSON(
 			fmt.Sprintf("%s/mutation/explain", httpServer.URL),
+			nil,
 			map[string]any{},
 		)
 		if err != nil {
@@ -727,6 +782,7 @@ func TestServerConnector(t *testing.T) {
 		res, err := httpPostJSONWithNDCVersion(
 			fmt.Sprintf("%s/mutation/explain", httpServer.URL),
 			"unknown",
+			nil,
 			map[string]any{},
 		)
 		if err != nil {

example/codegen/go.mod

@@ -22,6 +22,7 @@ require (
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/go-viper/mapstructure/v2 v2.4.0 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.27.1 // indirect
+	github.com/klauspost/compress v1.18.0 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/prometheus/client_golang v1.23.0 // indirect
 	github.com/prometheus/client_model v0.6.2 // indirect

go.mod

@@ -9,6 +9,7 @@ require (
 	github.com/go-viper/mapstructure/v2 v2.4.0
 	github.com/google/go-cmp v0.7.0
 	github.com/google/uuid v1.6.0
+	github.com/klauspost/compress v1.18.0
 	github.com/prometheus/client_golang v1.23.0
 	github.com/prometheus/common v0.65.0
 	go.opentelemetry.io/contrib/bridges/otelslog v0.12.0