Update the extensions tag to contain errors when the nautilus gateway… (#90)

* only run test coverage if there's a token

* enable gomodules

* no bash

* Update the extensions tag to contain errors when the nautilus gateway returns an error

- The “code” field is required by some frontend libraries, such as apollo-client. While this is not a
graphql requirement, this is a pretty widely used pattern by libraries like graphqlgen and also
by apollo-server.

Co-authored-by: Alec Aivazis <alec@aivazis.com>

Author: Bardhi Shtylla

http.go

@@ -27,6 +27,10 @@ type HTTPOperation struct {
 }
 
 func formatErrors(data map[string]interface{}, err error) map[string]interface{} {
+	return formatErrorsWithCode(data, err, "UNKNOWN_ERROR")
+}
+
+func formatErrorsWithCode(data map[string]interface{}, err error, code string) map[string]interface{} {
 	// the final list of formatted errors
 	var errList graphql.ErrorList
 
@@ -35,9 +39,7 @@ func formatErrors(data map[string]interface{}, err error) map[string]interface{}
 		errList = list
 	} else {
 		errList = graphql.ErrorList{
-			&graphql.Error{
-				Message: err.Error(),
-			},
+			graphql.NewError(code, err.Error()),
 		}
 	}
 
@@ -169,7 +171,10 @@ func (g *Gateway) GraphQLHandler(w http.ResponseWriter, r *http.Request) {
 		// if there is no query or cache key
 		if operation.Query == "" && cacheKey == "" {
 			statusCode = http.StatusUnprocessableEntity
-			results = append(results, formatErrors(nil, errors.New("could not find query body")))
+			results = append(
+				results,
+				formatErrorsWithCode(nil, errors.New("could not find query body"), "BAD_USER_INPUT"),
+			)
 			continue
 		}
 
@@ -185,7 +190,7 @@ func (g *Gateway) GraphQLHandler(w http.ResponseWriter, r *http.Request) {
 		// Get the plan, and return a 400 if we can't get the plan
 		plan, err := g.GetPlans(requestContext)
 		if err != nil {
-			response, err := json.Marshal(formatErrors(nil, err))
+			response, err := json.Marshal(formatErrorsWithCode(nil, err, "GRAPHQL_VALIDATION_FAILED"))
 			if err != nil {
 				// if we couldn't serialize the response then we're in internal error territory
 				response, err = json.Marshal(formatErrors(nil, err))
@@ -200,7 +205,7 @@ func (g *Gateway) GraphQLHandler(w http.ResponseWriter, r *http.Request) {
 		// fire the query with the request context passed through to execution
 		result, err = g.Execute(requestContext, plan)
 		if err != nil {
-			results = append(results, formatErrors(nil, err))
+			results = append(results, formatErrorsWithCode(nil, err, "INTERNAL_SERVER_ERROR"))
 			continue
 		}
 

http_test.go

@@ -18,6 +18,13 @@ import (
 	"github.com/vektah/gqlparser/ast"
 )
 
+type resultWithErrors struct {
+	Errors []struct {
+		Extensions map[string]string `json:"extensions"`
+		Message    string            `json:"message"`
+	} `json:"errors"`
+}
+
 func TestGraphQLHandler_postMissingQuery(t *testing.T) {
 	schema, err := graphql.LoadSchema(`
 		type Query {
@@ -83,6 +90,13 @@ func TestGraphQLHandler(t *testing.T) {
 
 		// make sure we got an error code
 		assert.Equal(t, http.StatusUnprocessableEntity, responseRecorder.Result().StatusCode)
+
+		// verify the graphql error code
+		result, err := readResultWithErrors(responseRecorder, t)
+		if err != nil {
+			assert.Error(t, err)
+		}
+		assert.Equal(t, result.Errors[0].Extensions["code"], "BAD_USER_INPUT")
 	})
 
 	t.Run("Non-object variables fails", func(t *testing.T) {
@@ -151,9 +165,28 @@ func TestGraphQLHandler(t *testing.T) {
 
 		// make sure we got an error code
 		assert.Equal(t, http.StatusInternalServerError, responseRecorder.Result().StatusCode)
+
+		// verify the graphql error code
+		result, err := readResultWithErrors(responseRecorder, t)
+		if err != nil {
+			assert.Error(t, err)
+		}
+		assert.Equal(t, result.Errors[0].Extensions["code"], "UNKNOWN_ERROR")
 	})
 }
 
+func readResultWithErrors(responseRecorder *httptest.ResponseRecorder, t *testing.T) (*resultWithErrors, error) {
+	body, err := ioutil.ReadAll(responseRecorder.Result().Body)
+	if err != nil {
+		return nil, err
+	}
+
+	//result := map[string]interface{}{}
+	result := resultWithErrors{}
+	err = json.Unmarshal(body, &result)
+	return &result, nil
+}
+
 func TestQueryPlanCacheParameters_post(t *testing.T) {
 	// load the schema we'll test
 	schema, _ := graphql.LoadSchema(`