Skip to content

{types,graphql_test}: Adds Result.ErrorsJoined implementation. #717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
24 changes: 7 additions & 17 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,25 +17,17 @@ defaults: &defaults

version: 2
jobs:
golang:1.8.7:
<<: *test_without_go_modules
docker:
- image: circleci/golang:1.8.7
golang:1.9.7:
<<: *test_without_go_modules
docker:
- image: circleci/golang:1.9.7
golang:1.11:
golang:1.23:
<<: *defaults
docker:
- image: circleci/golang:1.11
golang:latest:
- image: cimg/go:1.23
golang:1.24.1:
<<: *defaults
docker:
- image: circleci/golang:latest
- image: cimg/go:1.24.1
coveralls:
docker:
- image: circleci/golang:latest
- image: circleci/golang:1.23
steps:
- checkout
- run: go get github.com/mattn/goveralls
Expand All @@ -46,8 +38,6 @@ workflows:
version: 2
build:
jobs:
- golang:1.8.7
- golang:1.9.7
- golang:1.11
- golang:latest
- golang:1.23
- golang:1.24.1
- coveralls
31 changes: 31 additions & 0 deletions graphql_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@ package graphql_test

import (
"context"
"errors"
"reflect"
"testing"

"github.com/graphql-go/graphql"
"github.com/graphql-go/graphql/gqlerrors"
"github.com/graphql-go/graphql/testutil"
)

Expand Down Expand Up @@ -268,3 +270,32 @@ func TestEmptyStringIsNotNull(t *testing.T) {
t.Errorf("wrong result, query: %v, graphql result diff: %v", query, testutil.Diff(expected, result))
}
}

func TestResultErrorsJoinedFailure(t *testing.T) {
r := graphql.Result{}

if err := r.ErrorsJoined(); err != nil {
t.Fatalf("wrong result, want: nil, got: %v", err)
}
}

func TestResultErrorsJoinedSuccess(t *testing.T) {
r := graphql.Result{
Errors: []gqlerrors.FormattedError{
{Message: "first error"},
{Message: "second error"},
},
}

expected := errors.New("second error: first error")
Comment on lines +282 to +290
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be worth adding a test that verifies the error wrapping behavior works correctly with errors.Is or errors.As. This would ensure that the wrapping with %w is functioning as expected.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great call, it was addressed it via: 9bd0b67


if err := r.ErrorsJoined(); err != nil {
if errors.Is(err, expected) {
t.Fatalf("wrong result, want: %v, got: %v", expected, err)
}

return
}

t.Fatalf("wrong result, got: nil, want: %v", expected)
}
22 changes: 22 additions & 0 deletions types.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package graphql

import (
"fmt"

"github.com/graphql-go/graphql/gqlerrors"
)

Expand All @@ -17,3 +19,23 @@ type Result struct {
func (r *Result) HasErrors() bool {
return len(r.Errors) > 0
}

// ErrorsJoined joins and returns the errors of the result with `:` as character separator.
func (r *Result) ErrorsJoined() error {
if r.Errors == nil {
return nil
}

var result error
for _, err := range r.Errors {
if result == nil {
result = fmt.Errorf("%w", err)

continue
}

result = fmt.Errorf("%w: %w", err, result)
}

return result
}