github.com/dgraph-io/dgraph@v1.2.8/graphql/schema/response_test.go

/*
 * Copyright 2019 Dgraph Labs, Inc. and Contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package schema

import (
	"bytes"
	"testing"

	"github.com/dgraph-io/dgraph/x"
	"github.com/pkg/errors"
	"github.com/stretchr/testify/assert"
	"github.com/vektah/gqlparser/gqlerror"
)

func TestDataAndErrors(t *testing.T) {

	tests := map[string]struct {
		data     []string
		errors   []error
		expected string
	}{
		"empty response": {
			data:     nil,
			errors:   nil,
			expected: `{"extensions": { "requestID": "reqID"}}`,
		},
		"add initial": {
			data:     []string{`"Some": "Data"`},
			errors:   nil,
			expected: `{"data": {"Some": "Data"}, "extensions": { "requestID": "reqID"}}`,
		},
		"add nothing": {
			data:     []string{`"Some": "Data"`, ""},
			errors:   nil,
			expected: `{"data": {"Some": "Data"}, "extensions": { "requestID": "reqID"}}`,
		},
		"add more": {
			data:   []string{`"Some": "Data"`, `"And": "More"`},
			errors: nil,
			expected: `{
				"data": {"Some": "Data", "And": "More"}, 
				"extensions": { "requestID": "reqID"}}`,
		},
		"errors and data": {
			data:   []string{`"Some": "Data"`, `"And": "More"`},
			errors: []error{errors.New("An Error")},
			expected: `{
				"errors":[{"message":"An Error"}],
				"data": {"Some": "Data", "And": "More"}, 
				"extensions": { "requestID": "reqID"}}`,
		},
		"many errors": {
			data:   []string{`"Some": "Data"`},
			errors: []error{errors.New("An Error"), errors.New("Another Error")},
			expected: `{
				"errors":[{"message":"An Error"}, {"message":"Another Error"}],
				"data": {"Some": "Data"}, 
				"extensions": { "requestID": "reqID"}}`,
		},
		"gql error": {
			data: []string{`"Some": "Data"`},
			errors: []error{
				&x.GqlError{Message: "An Error", Locations: []x.Location{{Line: 1, Column: 1}}}},
			expected: `{
				"errors":[{"message":"An Error", "locations": [{"line":1,"column":1}]}],
				"data": {"Some": "Data"}, 
				"extensions": { "requestID": "reqID"}}`,
		},
		"gql error with path": {
			data: []string{`"Some": "Data"`},
			errors: []error{
				&x.GqlError{
					Message:   "An Error",
					Locations: []x.Location{{Line: 1, Column: 1}},
					Path:      []interface{}{"q", 2, "n"}}},
			expected: `{
				"errors":[{
					"message":"An Error", 
					"locations": [{"line":1,"column":1}],
					"path": ["q", 2, "n"]}],
				"data": {"Some": "Data"}, 
				"extensions": { "requestID": "reqID"}}`,
		},
		"gql error list": {
			data: []string{`"Some": "Data"`},
			errors: []error{x.GqlErrorList{
				&x.GqlError{Message: "An Error", Locations: []x.Location{{Line: 1, Column: 1}}},
				&x.GqlError{Message: "Another Error", Locations: []x.Location{{Line: 1, Column: 1}}}}},
			expected: `{
				"errors":[
					{"message":"An Error", "locations": [{"line":1,"column":1}]}, 
					{"message":"Another Error", "locations": [{"line":1,"column":1}]}],
				"data": {"Some": "Data"}, 
				"extensions": { "requestID": "reqID"}}`,
		},
	}

	for name, tcase := range tests {
		t.Run(name, func(t *testing.T) {
			resp := &Response{Extensions: &Extensions{RequestID: "reqID"}}

			for _, d := range tcase.data {
				resp.AddData([]byte(d))
			}
			for _, e := range tcase.errors {
				resp.WithError(e)
			}

			buf := new(bytes.Buffer)
			resp.WriteTo(buf)

			assert.JSONEq(t, tcase.expected, buf.String())
		})
	}
}

func TestWriteTo_BadDataWithReqID(t *testing.T) {
	resp := &Response{Extensions: &Extensions{RequestID: "reqID"}}
	resp.AddData([]byte(`"not json"`))

	buf := new(bytes.Buffer)
	resp.WriteTo(buf)

	assert.JSONEq(t,
		`{"errors":[{"message":"Internal error - failed to marshal a valid JSON response"}], 
		"data": null, 
		"extensions": { "requestID": "reqID"}}`,
		buf.String())
}

func TestWriteTo_BadData(t *testing.T) {
	resp := &Response{}
	resp.AddData([]byte(`"not json"`))

	buf := new(bytes.Buffer)
	resp.WriteTo(buf)

	assert.JSONEq(t,
		`{"errors":[{"message":"Internal error - failed to marshal a valid JSON response"}], 
		"data": null, 
		"extensions": { "requestID": "unknown request ID"}}`,
		buf.String())
}

func TestErrorResponse(t *testing.T) {

	tests := map[string]struct {
		err      error
		expected string
	}{
		"an error": {
			err:      errors.New("An Error"),
			expected: `{"errors":[{"message":"An Error"}], "extensions": {"requestID":"reqID"}}`,
		},

		"an x.GqlError": {
			err: x.GqlErrorf("A GraphQL error").
				WithLocations(x.Location{Line: 1, Column: 2}),
			expected: `{"errors":[{"message": "A GraphQL error", "locations": [{"column":2, "line":1}]}],
		"extensions": {"requestID":"reqID"}}`},
		"an x.GqlErrorList": {
			err: x.GqlErrorList{
				x.GqlErrorf("A GraphQL error"),
				x.GqlErrorf("Another GraphQL error").WithLocations(x.Location{Line: 1, Column: 2})},
			expected: `{"errors":[
				{"message":"A GraphQL error"}, 
				{"message":"Another GraphQL error", "locations": [{"column":2, "line":1}]}],
				"extensions": {"requestID":"reqID"}}`},
		"a gqlerror": {
			err: &gqlerror.Error{
				Message:   "A GraphQL error",
				Locations: []gqlerror.Location{{Line: 1, Column: 2}}},
			expected: `{
				"errors":[{"message":"A GraphQL error", "locations": [{"line":1,"column":2}]}], 
				"extensions": {"requestID":"reqID"}}`,
		},
		"a list of gql errors": {
			err: gqlerror.List{
				gqlerror.Errorf("A GraphQL error"),
				&gqlerror.Error{
					Message:   "Another GraphQL error",
					Locations: []gqlerror.Location{{Line: 1, Column: 2}}}},
			expected: `{"errors":[
				{"message":"A GraphQL error"}, 
				{"message":"Another GraphQL error", "locations": [{"line":1,"column":2}]}], 
				"extensions": {"requestID":"reqID"}}`,
		},
	}

	for name, tcase := range tests {
		t.Run(name, func(t *testing.T) {

			// ErrorResponse doesn't add data - it should only be called before starting
			// execution - so in all cases no data should be present.
			resp := ErrorResponse(tcase.err, "reqID")

			buf := new(bytes.Buffer)
			resp.WriteTo(buf)

			assert.JSONEq(t, tcase.expected, buf.String())
		})
	}
}

func TestNilResponse(t *testing.T) {
	var resp *Response

	buf := new(bytes.Buffer)
	resp.WriteTo(buf)

	assert.JSONEq(t,
		`{"errors":[{"message":"Internal error - no response to write."}], 
		"data": null, 
		"extensions": {"requestID":"unknown request ID"}}`,
		buf.String())
}