graphql.ErrorOnPath discards error wrapping around *gqlerror.Error

[andrejgou]

What happened?

Any errors wrapped around an instance of *gqlerror.Error will be discarded when graphql.ErrorOnPath is called because of this block:

gqlgen/graphql/error.go

Lines 25 to 29 in fb13091

	if errors.As(err, &gqlErr) {
	if gqlErr.Path == nil {
	gqlErr.Path = GetPath(ctx)
	}
	return gqlErr

Our application uses a custom error presenter to retrieve and log supplemental information annotated on errors in application code or through GraphQL directives using error wrappers, e.g. errors.WithMessage
https://pkg.go.dev/github.com/pkg/errors#WithMessage

Because the error passed to the error presenter is first processed with ErrorOnPath

gqlgen/graphql/context_response.go

Line 48 in fb13091

presentedError := c.errorPresenter(ctx, ErrorOnPath(ctx, err))

we will lose any annotated information wrapped around the original *gqlerror.Error since the error wrappers have been discarded.

See a minimal example to reproduce in a golang playground:
https://go.dev/play/p/TzCt0-D-LRU

err := &gqlerror.Errorf("innermost")
// error annotation in application code or directive
wrappedErr := errors.WithMessage(err, "wrapped message")
// called on input to errorPresenter
strippedErr := graphql.ErrorOnPath(context.Background(), wrappedErr)

fmt.Printf("expect:\t\"%v\"\n", wrappedErr.Error())
fmt.Printf("actual:\t\"%v\"\n", strippedErr.Error())

yields

expect:	"wrapped message: input: innermost"
actual:	"input: innermost"

What did you expect?

The above code snippet should instead output

expect:	"wrapped message: input: innermost"
actual:	"wrapped message: input: innermost"

Minimal graphql.schema and models to reproduce

No schema/model needed. See reproduction:
https://go.dev/play/p/TzCt0-D-LRU

versions

• go run github.com/99designs/gqlgen version? Any version at 0.13.0 or above since it includes this commit
• go version? Any go version

[frederikhors]

Can you PR a fix?

[giautm]

How about this fix? #2288

Tested at: https://go.dev/play/p/wzulxsiB1PL