Merge branch 'graphql-go:master' into master

Author: chienfuchen32

.circleci/config.yml

@@ -0,0 +1,40 @@
+defaults: &defaults
+  working_directory: /go/src/github.com/graphql-go/handler
+  steps:
+    - checkout
+    - run: go get -v -t -d ./...
+    - run: go test ./...
+ 
+version: 2
+jobs:
+  golang:1.8.7:
+    <<: *defaults
+    docker:
+      - image: circleci/golang:1.8.7
+  golang:1.9.7:
+    <<: *defaults
+    docker:
+      - image: circleci/golang:1.9.7
+  golang:latest:
+    <<: *defaults
+    docker:
+      - image: circleci/golang:latest
+  coveralls:
+    working_directory: /go/src/github.com/graphql-go/handler
+    docker:
+      - image: circleci/golang:latest
+    steps:
+      - checkout
+      - run: go get -v -t -d ./...
+      - run: go get github.com/mattn/goveralls
+      - run: go test -v -cover -race -coverprofile=coverage.out
+      - run: /go/bin/goveralls -coverprofile=coverage.out -service=circle-ci -repotoken $COVERALLS_TOKEN
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - golang:1.8.7
+      - golang:1.9.7
+      - golang:latest
+      - coveralls

.gitignore

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

.travis.yml

@@ -1,4 +1,5 @@
-# graphql-go-handler [![Build Status](https://travis-ci.org/graphql-go/handler.svg)](https://travis-ci.org/graphql-go/handler) [![GoDoc](https://godoc.org/graphql-go/handler?status.svg)](https://godoc.org/github.com/graphql-go/handler) [![Coverage Status](https://coveralls.io/repos/graphql-go/handler/badge.svg?branch=master&service=github)](https://coveralls.io/github/graphql-go/handler?branch=master) [![Join the chat at https://gitter.im/graphql-go/graphql](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/graphql-go/graphql?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+# graphql-go-handler [![CircleCI](https://circleci.com/gh/graphql-go/handler.svg?style=svg)](https://circleci.com/gh/graphql-go/handler) [![GoDoc](https://godoc.org/graphql-go/handler?status.svg)](https://godoc.org/github.com/graphql-go/handler) [![Coverage Status](https://coveralls.io/repos/graphql-go/handler/badge.svg?branch=master&service=github)](https://coveralls.io/github/graphql-go/handler?branch=master) [![Join the chat at https://gitter.im/graphql-go/graphql](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/graphql-go/graphql?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 
 Golang HTTP.Handler for [graphl-go](https://github.com/graphql-go/graphql)
 

README.md

@@ -0,0 +1,3 @@
+module github.com/graphql-go/handler
+
+go 1.14

go.mod

@@ -24,7 +24,7 @@ func renderPlayground(w http.ResponseWriter, r *http.Request) {
 
 	d := playgroundData{
 		PlaygroundVersion:    graphcoolPlaygroundVersion,
-		Endpoint:             "/graphql",
+		Endpoint:             r.URL.Path,
 		SubscriptionEndpoint: fmt.Sprintf("ws://%v/subscriptions", r.Host),
 		SetTitle:             true,
 	}

graphcoolPlayground.go

@@ -10,6 +10,8 @@ import (
 	"github.com/graphql-go/graphql"
 
 	"context"
+
+	"github.com/graphql-go/graphql/gqlerrors"
 )
 
 const (
@@ -19,13 +21,18 @@ const (
 	ContentTypeMultipartFormData = "multipart/form-data"
 )
 
+type ResultCallbackFn func(ctx context.Context, params *graphql.Params, result *graphql.Result, responseBody []byte)
+
 type Handler struct {
-	Schema       *graphql.Schema
-	pretty       bool
-	graphiql     bool
-	playground   bool
-	rootObjectFn RootObjectFn
+	Schema           *graphql.Schema
+	pretty           bool
+	graphiql         bool
+	playground       bool
+	rootObjectFn     RootObjectFn
+	resultCallbackFn ResultCallbackFn
+	formatErrorFn    func(err error) gqlerrors.FormattedError
 }
+
 type RequestOptions struct {
 	Query         string                 `json:"query" url:"query" schema:"query"`
 	Variables     map[string]interface{} `json:"variables" url:"variables" schema:"variables"`
@@ -63,7 +70,7 @@ func NewRequestOptions(r *http.Request) *RequestOptions {
 		return reqOpt
 	}
 
-	if r.Method != "POST" {
+	if r.Method != http.MethodPost {
 		return &RequestOptions{}
 	}
 
@@ -143,6 +150,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.OriginalError())
+		}
+		result.Errors = formatted
+	}
+
 	if h.graphiql {
 		acceptHeader := r.Header.Get("Accept")
 		_, raw := r.URL.Query()["raw"]
@@ -164,17 +179,22 @@ func (h *Handler) ContextHandler(ctx context.Context, w http.ResponseWriter, r *
 	// use proper JSON Header
 	w.Header().Add("Content-Type", "application/json; charset=utf-8")
 
+	var buff []byte
 	if h.pretty {
 		w.WriteHeader(http.StatusOK)
-		buff, _ := json.MarshalIndent(result, "", "\t")
+		buff, _ = json.MarshalIndent(result, "", "\t")
 
 		w.Write(buff)
 	} else {
 		w.WriteHeader(http.StatusOK)
-		buff, _ := json.Marshal(result)
+		buff, _ = json.Marshal(result)
 
 		w.Write(buff)
 	}
+
+	if h.resultCallbackFn != nil {
+		h.resultCallbackFn(ctx, &params, result, buff)
+	}
 }
 
 // ServeHTTP provides an entrypoint into executing graphQL queries.
@@ -186,11 +206,13 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 type RootObjectFn func(ctx context.Context, r *http.Request) map[string]interface{}
 
 type Config struct {
-	Schema       *graphql.Schema
-	Pretty       bool
-	GraphiQL     bool
-	Playground   bool
-	RootObjectFn RootObjectFn
+	Schema           *graphql.Schema
+	Pretty           bool
+	GraphiQL         bool
+	Playground       bool
+	RootObjectFn     RootObjectFn
+	ResultCallbackFn ResultCallbackFn
+	FormatErrorFn    func(err error) gqlerrors.FormattedError
 }
 
 func NewConfig() *Config {
@@ -206,15 +228,18 @@ func New(p *Config) *Handler {
 	if p == nil {
 		p = NewConfig()
 	}
+
 	if p.Schema == nil {
 		panic("undefined GraphQL schema")
 	}
 
 	return &Handler{
-		Schema:       p.Schema,
-		pretty:       p.Pretty,
-		graphiql:     p.GraphiQL,
-		playground:   p.Playground,
-		rootObjectFn: p.RootObjectFn,
+		Schema:           p.Schema,
+		pretty:           p.Pretty,
+		graphiql:         p.GraphiQL,
+		playground:       p.Playground,
+		rootObjectFn:     p.RootObjectFn,
+		resultCallbackFn: p.ResultCallbackFn,
+		formatErrorFn:    p.FormatErrorFn,
 	}
 }

handler.go

@@ -13,6 +13,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"
 )
@@ -93,12 +95,23 @@ func TestHandler_BasicQuery_Pretty(t *testing.T) {
 			},
 		},
 	}
-	queryString := `query=query HeroNameQuery { hero { name } }`
+	queryString := `query=query HeroNameQuery { hero { name } }&operationName=HeroNameQuery`
 	req, _ := http.NewRequest("GET", fmt.Sprintf("/graphql?%v", queryString), nil)
 
+	callbackCalled := false
 	h := handler.New(&handler.Config{
 		Schema: &testutil.StarWarsSchema,
 		Pretty: true,
+		ResultCallbackFn: func(ctx context.Context, params *graphql.Params, result *graphql.Result, responseBody []byte) {
+			callbackCalled = true
+			if params.OperationName != "HeroNameQuery" {
+				t.Fatalf("OperationName passed to callback was not HeroNameQuery: %v", params.OperationName)
+			}
+
+			if result.HasErrors() {
+				t.Fatalf("unexpected graphql result errors")
+			}
+		},
 	})
 	result, resp := executeTest(t, h, req)
 	if resp.Code != http.StatusOK {
@@ -107,6 +120,9 @@ func TestHandler_BasicQuery_Pretty(t *testing.T) {
 	if !reflect.DeepEqual(result, expected) {
 		t.Fatalf("wrong result, graphql result diff: %v", testutil.Diff(expected, result))
 	}
+	if !callbackCalled {
+		t.Fatalf("ResultCallbackFn was not called when it should have been")
+	}
 }
 
 func TestHandler_BasicQuery_Ugly(t *testing.T) {
@@ -196,3 +212,81 @@ func TestHandler_BasicQuery_WithRootObjFn(t *testing.T) {
 		t.Fatalf("wrong result, graphql result diff: %v", testutil.Diff(expected, result))
 	}
 }
+
+type customError struct {
+	message string
+}
+
+func (e customError) Error() string {
+	return fmt.Sprintf("%s", e.message)
+}
+
+func TestHandler_BasicQuery_WithFormatErrorFn(t *testing.T) {
+	resolverError := customError{message: "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"},
+	}
+
+	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 error) gqlerrors.FormattedError {
+			formatErrorFnCalled = true
+			var formatted gqlerrors.FormattedError
+			switch err := err.(type) {
+			case *gqlerrors.Error:
+				formatted = gqlerrors.FormatError(err)
+			default:
+				t.Fatalf("unexpected error type: %v", reflect.TypeOf(err))
+			}
+			return formatted
+		},
+	})
+	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))
+	}
+}