Merge pull request #58 from graphql-go/formatErrorFn

handler: adds formatErrorFn

Author: chris-ramon

.gitignore

@@ -23,3 +23,4 @@ _testmain.go
 *.test
 *.prof
 *.swp
+.idea

handler.go

@@ -10,6 +10,8 @@ import (
 	"github.com/graphql-go/graphql"
 
 	"context"
+
+	"github.com/graphql-go/graphql/gqlerrors"
 )
 
 const (
@@ -27,7 +29,9 @@ type Handler struct {
 	playground       bool
 	rootObjectFn     RootObjectFn
 	resultCallbackFn ResultCallbackFn
+	formatErrorFn    func(err gqlerrors.FormattedError) gqlerrors.FormattedError
 }
+
 type RequestOptions struct {
 	Query         string                 `json:"query" url:"query" schema:"query"`
 	Variables     map[string]interface{} `json:"variables" url:"variables" schema:"variables"`
@@ -137,6 +141,14 @@ func (h *Handler) ContextHandler(ctx context.Context, w http.ResponseWriter, r *
 	}
 	result := graphql.Do(params)
 
+	if formatErrorFn := h.formatErrorFn; formatErrorFn != nil && len(result.Errors) > 0 {
+		formatted := make([]gqlerrors.FormattedError, len(result.Errors))
+		for i, formattedError := range result.Errors {
+			formatted[i] = formatErrorFn(formattedError)
+		}
+		result.Errors = formatted
+	}
+
 	if h.graphiql {
 		acceptHeader := r.Header.Get("Accept")
 		_, raw := r.URL.Query()["raw"]
@@ -191,6 +203,7 @@ type Config struct {
 	Playground       bool
 	RootObjectFn     RootObjectFn
 	ResultCallbackFn ResultCallbackFn
+	FormatErrorFn    func(err gqlerrors.FormattedError) gqlerrors.FormattedError
 }
 
 func NewConfig() *Config {
@@ -206,6 +219,7 @@ func New(p *Config) *Handler {
 	if p == nil {
 		p = NewConfig()
 	}
+
 	if p.Schema == nil {
 		panic("undefined GraphQL schema")
 	}
@@ -217,5 +231,6 @@ func New(p *Config) *Handler {
 		playground:       p.Playground,
 		rootObjectFn:     p.RootObjectFn,
 		resultCallbackFn: p.ResultCallbackFn,
+		formatErrorFn:    p.FormatErrorFn,
 	}
 }

handler_test.go

@@ -2,6 +2,7 @@ package handler_test
 
 import (
 	"encoding/json"
+	"errors"
 	"fmt"
 	"io/ioutil"
 	"net/http"
@@ -13,6 +14,8 @@ import (
 	"context"
 
 	"github.com/graphql-go/graphql"
+	"github.com/graphql-go/graphql/gqlerrors"
+	"github.com/graphql-go/graphql/language/location"
 	"github.com/graphql-go/graphql/testutil"
 	"github.com/graphql-go/handler"
 )
@@ -210,3 +213,90 @@ func TestHandler_BasicQuery_WithRootObjFn(t *testing.T) {
 		t.Fatalf("wrong result, graphql result diff: %v", testutil.Diff(expected, result))
 	}
 }
+
+type customError struct {
+	error
+}
+
+func (e customError) Error() string {
+	return e.error.Error()
+}
+
+func TestHandler_BasicQuery_WithFormatErrorFn(t *testing.T) {
+	resolverError := customError{error: errors.New("resolver error")}
+	myNameQuery := graphql.NewObject(graphql.ObjectConfig{
+		Name: "Query",
+		Fields: graphql.Fields{
+			"name": &graphql.Field{
+				Name: "name",
+				Type: graphql.String,
+				Resolve: func(p graphql.ResolveParams) (interface{}, error) {
+					return nil, resolverError
+				},
+			},
+		},
+	})
+	myNameSchema, err := graphql.NewSchema(graphql.SchemaConfig{
+		Query: myNameQuery,
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	customFormattedError := gqlerrors.FormattedError{
+		Message: resolverError.Error(),
+		Locations: []location.SourceLocation{
+			location.SourceLocation{
+				Line:   1,
+				Column: 2,
+			},
+		},
+		Path: []interface{}{"name"},
+		Extensions: map[string]interface{}{
+			"fromFormatFn": "FROM_FORMAT_FN",
+		},
+	}
+
+	expected := &graphql.Result{
+		Data: map[string]interface{}{
+			"name": nil,
+		},
+		Errors: []gqlerrors.FormattedError{customFormattedError},
+	}
+
+	queryString := `query={name}`
+	req, _ := http.NewRequest("GET", fmt.Sprintf("/graphql?%v", queryString), nil)
+
+	formatErrorFnCalled := false
+	h := handler.New(&handler.Config{
+		Schema: &myNameSchema,
+		Pretty: true,
+		FormatErrorFn: func(err gqlerrors.FormattedError) gqlerrors.FormattedError {
+			formatErrorFnCalled = true
+			originalError := err.OriginalError()
+			switch errType := originalError.(type) {
+			case customError:
+			default:
+				t.Fatalf("unexpected error type: %v", reflect.TypeOf(errType))
+			}
+			return gqlerrors.FormattedError{
+				Message:   err.Message,
+				Locations: err.Locations,
+				Path:      err.Path,
+				Extensions: map[string]interface{}{
+					"fromFormatFn": "FROM_FORMAT_FN",
+				},
+			}
+		},
+	})
+	result, resp := executeTest(t, h, req)
+	if resp.Code != http.StatusOK {
+		t.Fatalf("unexpected server response %v", resp.Code)
+	}
+	if !formatErrorFnCalled {
+		t.Fatalf("FormatErrorFn was not called when it should have been")
+	}
+	if !reflect.DeepEqual(result, expected) {
+		t.Fatalf("wrong result, graphql result diff: %v", testutil.Diff(expected, result))
+	}
+}