feat: add utility to normalize graphql request (#29)

Author: vuongxuongminh

router.go

@@ -5,7 +5,6 @@ import (
 	"errors"
 	"io/ioutil"
 	"net/http"
-	"strings"
 	"time"
 
 	"github.com/99designs/gqlgen/graphql/handler"
@@ -15,9 +14,7 @@ import (
 	"github.com/gbox-proxy/gbox/admin/generated"
 	"github.com/gorilla/handlers"
 	"github.com/gorilla/mux"
-	"github.com/jensneuse/graphql-go-tools/pkg/astparser"
 	"github.com/jensneuse/graphql-go-tools/pkg/graphql"
-	"github.com/jensneuse/graphql-go-tools/pkg/operationreport"
 	"go.uber.org/zap"
 )
 
@@ -78,7 +75,7 @@ func (h *Handler) GraphQLOverWebsocketHandle(w http.ResponseWriter, r *http.Requ
 	}
 
 	n := r.Context().Value(nextHandlerCtxKey).(caddyhttp.Handler)
-	mr := newWebsocketMetricsResponseWriter(w, h)
+	mr := newWebsocketMetricsResponseWriter(w, h.schema, h)
 	reporter.error = h.ReverseProxy.ServeHTTP(mr, r, n)
 }
 
@@ -153,39 +150,14 @@ func (h *Handler) unmarshalHTTPRequest(r *http.Request) (*graphql.Request, error
 		return nil, err
 	}
 
-	err = graphql.UnmarshalHttpRequest(copyHTTPRequest, gqlRequest)
-
-	if err != nil {
+	if err = graphql.UnmarshalHttpRequest(copyHTTPRequest, gqlRequest); err != nil {
 		return nil, err
 	}
 
-	if result, _ := gqlRequest.Normalize(h.schema); !result.Successful {
-		return nil, result.Errors
-	}
-
-	operation, _ := astparser.ParseGraphqlDocumentString(gqlRequest.Query)
-	numOfOperations := operation.NumOfOperationDefinitions()
-	operationName := strings.TrimSpace(gqlRequest.OperationName)
-	report := &operationreport.Report{}
-
-	if operationName == "" && numOfOperations > 1 {
-		report.AddExternalError(operationreport.ErrRequiredOperationNameIsMissing())
-
-		return nil, report
-	}
-
-	if operationName == "" && numOfOperations == 1 {
-		operationName = operation.OperationDefinitionNameString(0)
-	}
-
-	if !operation.OperationNameExists(operationName) {
-		report.AddExternalError(operationreport.ErrOperationWithProvidedOperationNameNotFound(operationName))
-
-		return nil, report
+	if err = normalizeGraphqlRequest(h.schema, gqlRequest); err != nil {
+		return nil, err
 	}
 
-	gqlRequest.OperationName = operationName
-
 	return gqlRequest, nil
 }
 

utils.go

@@ -3,9 +3,12 @@ package gbox
 import (
 	"bytes"
 	"net/http"
+	"strings"
 	"sync"
 
+	"github.com/jensneuse/graphql-go-tools/pkg/astparser"
 	"github.com/jensneuse/graphql-go-tools/pkg/graphql"
+	"github.com/jensneuse/graphql-go-tools/pkg/operationreport"
 )
 
 var bufferPool = sync.Pool{
@@ -24,3 +27,34 @@ func writeResponseErrors(errors error, w http.ResponseWriter) error {
 
 	return nil
 }
+
+func normalizeGraphqlRequest(schema *graphql.Schema, gqlRequest *graphql.Request) error {
+	if result, _ := gqlRequest.Normalize(schema); !result.Successful {
+		return result.Errors
+	}
+
+	operation, _ := astparser.ParseGraphqlDocumentString(gqlRequest.Query)
+	numOfOperations := operation.NumOfOperationDefinitions()
+	operationName := strings.TrimSpace(gqlRequest.OperationName)
+	report := &operationreport.Report{}
+
+	if operationName == "" && numOfOperations > 1 {
+		report.AddExternalError(operationreport.ErrRequiredOperationNameIsMissing())
+
+		return report
+	}
+
+	if operationName == "" && numOfOperations == 1 {
+		operationName = operation.OperationDefinitionNameString(0)
+	}
+
+	if !operation.OperationNameExists(operationName) {
+		report.AddExternalError(operationreport.ErrOperationWithProvidedOperationNameNotFound(operationName))
+
+		return report
+	}
+
+	gqlRequest.OperationName = operationName
+
+	return nil
+}

ws.go

@@ -16,14 +16,16 @@ import (
 type wsMetricsResponseWriter struct {
 	requestMetrics
 	*caddyhttp.ResponseWriterWrapper
+	schema *graphql.Schema
 }
 
-func newWebsocketMetricsResponseWriter(w http.ResponseWriter, rm requestMetrics) *wsMetricsResponseWriter {
+func newWebsocketMetricsResponseWriter(w http.ResponseWriter, s *graphql.Schema, rm requestMetrics) *wsMetricsResponseWriter {
 	return &wsMetricsResponseWriter{
-		requestMetrics: rm,
 		ResponseWriterWrapper: &caddyhttp.ResponseWriterWrapper{
 			ResponseWriter: w,
 		},
+		schema:         s,
+		requestMetrics: rm,
 	}
 }
 
@@ -35,6 +37,7 @@ func (r *wsMetricsResponseWriter) Hijack() (net.Conn, *bufio.ReadWriter, error)
 		c = &wsMetricsConn{
 			Conn:           c,
 			requestMetrics: r.requestMetrics,
+			schema:         r.schema,
 		}
 	}
 
@@ -45,14 +48,15 @@ type wsMetricsConn struct {
 	net.Conn
 	requestMetrics
 	request     *graphql.Request
+	schema      *graphql.Schema
 	subscribeAt time.Time
 }
 
 func (c *wsMetricsConn) Read(b []byte) (n int, err error) {
 	n, err = c.Conn.Read(b)
 
-	if err != nil {
-		if c.request != nil {
+	if c.request != nil || err != nil {
+		if err != nil {
 			c.addMetricsEndRequest(c.request, time.Since(c.subscribeAt))
 			c.request = nil
 		}
@@ -88,6 +92,10 @@ func (c *wsMetricsConn) Read(b []byte) (n int, err error) {
 			return n, err
 		}
 
+		if e := normalizeGraphqlRequest(c.schema, request); e != nil {
+			return n, err
+		}
+
 		c.request = request
 		c.subscribeAt = time.Now()
 		c.addMetricsBeginRequest(request)

ws_test.go

@@ -58,8 +58,17 @@ func (m *testRequestMetrics) addMetricsEndRequest(request *graphql.Request, dura
 }
 
 func TestWsMetricsConn(t *testing.T) {
+	s, _ := graphql.NewSchemaFromString(`
+type Query {
+	users [User!]!
+}
+
+type User {
+	id: ID!
+}
+`)
 	m := newTestRequestMetrics(t)
-	w := newWebsocketMetricsResponseWriter(&testWsResponseWriter{}, m)
+	w := newWebsocketMetricsResponseWriter(&testWsResponseWriter{}, s, m)
 	conn, _, _ := w.Hijack()
 	buff := new(bytes.Buffer)
 	wsutil.WriteClientText(buff, []byte(`{"type": "start", "payload":{"query": "subscription { users { id } }"}}`))
@@ -76,6 +85,15 @@ func TestWsMetricsConn(t *testing.T) {
 }
 
 func TestWsMetricsConnBadCases(t *testing.T) {
+	s, _ := graphql.NewSchemaFromString(`
+type Query {
+	users [User!]!
+}
+
+type User {
+	id: ID!
+}
+`)
 	testCases := map[string]struct {
 		message string
 	}{
@@ -93,7 +111,7 @@ func TestWsMetricsConnBadCases(t *testing.T) {
 
 	for name, testCase := range testCases {
 		m := newTestRequestMetrics(t)
-		w := newWebsocketMetricsResponseWriter(&testWsResponseWriter{}, m)
+		w := newWebsocketMetricsResponseWriter(&testWsResponseWriter{}, s, m)
 		conn, _, _ := w.Hijack()
 		buff := new(bytes.Buffer)