Why does @envelop/sentry v3 skip GraphQLError

[morishin]

https://www.the-guild.dev/graphql/envelop/v3/guides/migrating-from-v2-to-v3#1envelopsentry-default-will-skip-all-graphqlerror says @envelop/sentry default will skip all GraphQLError.

I was wondering why @envelop/sentry skips GraphQLError.
I think the developers should notice any error occured in GraphQL server app. For example, It should send an error to Sentry when GraphQL resolvers return null value for non-null fields.

Please let me know the motivation if you know. 🙏

envelop/packages/plugins/sentry/src/index.ts

Lines 88 to 93 in 3a11aff

	export function defaultSkipError(error: Error): boolean {
	if (isGraphQLError(error)) {
	return isGraphQLError(error.originalError);
	}
	return false;
	}

[morishin]

By the way, this description seems outdated because it includes EnvelopError dropped from v3 💭

envelop/packages/plugins/sentry/README.md

Line 69 in 3a11aff

- `skipError` (default: ignored `EnvelopError`) - Indicates whether or not to skip Sentry exception reporting for a given error. By default, this plugin skips all `EnvelopError` errors and does not report it to Sentry.

[morishin]

I guess the reason is that:

1. Every exceptions will be wrapped with GraphQLError by GraphQL server.
2. The only case when originalError is GraphQLError is that a developer raise GraphQLError with writing new GraphQLError(...) intentionally.
3. Therefore GraphQLError should not be sent to Sentry and not be masked.

[n1ru4l]

Hey @morishin, sorry for the late reply here.

This has been a bug in v3 and will be resolved with v4. See the PR #1583

We added tests to make sure this regression will not happen again.