You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This works well for enum-like ErrorClassification values, but it does not work reliably for errors from graphql-java-extended-validation.
From what I can see, SentryGraphqlInstrumentation currently resolves the error type with:
error.getErrorType().toString()
and then compares that string with ignoredErrorTypes.
The problem is that graphql-java-extended-validation uses a private ResourceBundleMessageInterpolator.ValidationErrorType class. It does not expose a stable enum-like value via toString(). The semantic classification is exposed through ErrorClassification.toSpecification(...), which returns a map like:
Because of this, I currently have to work around the issue by replacing the extended-validation MessageInterpolator and returning a custom ErrorClassification whose toString() returns ExtendedValidationError only when called from Sentry:
That workaround is brittle and depends on Sentry internals.
This looks related to #2899, which added easier GraphQL error filtering. The current string-based filtering solves enum-like classifications, but it is hard to use with custom ErrorClassification implementations where toSpecification(...) carries the meaningful classification.
Solution Brainstorm
Could Sentry support a more robust way to classify ignored GraphQL errors?
A few possible approaches:
When error.getErrorType() is present, call errorType.toSpecification(error) and, if it returns a map containing a type field, allow ignored-error-types to match that value.
Add a callback/predicate for GraphQL errors. This would allow applications to inspect GraphQLError, ErrorClassification, extensions, path, etc.
Pass the GraphQLError and/or ErrorClassification through the Sentry Hint, as mentioned in Easier way of filtering errors for GraphQL #2899, so users can filter these events in beforeSend without replacing the whole GraphQL instrumentation.
My preference would be option 1 for configuration compatibility, possibly combined with option 3 for advanced filtering.
This would also make the Sentry GraphQL integration work out of the box with graphql-java-extended-validation, which is an official companion library from the graphql-java project. Since Sentry Java already integrates with graphql-java, it would be helpful if expected validation errors from this commonly used library could be ignored without replacing the message interpolator or depending on ErrorClassification.toString().
Problem Statement
I am using the GraphQL integration with:
io.sentry:sentry-spring-boot-4io.sentry:sentry-graphql-228.42.0com.graphql-java:graphql-java-extended-validation:24.0I want to ignore expected GraphQL validation errors produced by
graphql-java-extended-validation.The configuration looks like this:
This works well for enum-like ErrorClassification values, but it does not work reliably for errors from graphql-java-extended-validation.
From what I can see, SentryGraphqlInstrumentation currently resolves the error type with:
and then compares that string with ignoredErrorTypes.
The problem is that graphql-java-extended-validation uses a private ResourceBundleMessageInterpolator.ValidationErrorType class. It does not expose a stable enum-like value via toString(). The semantic classification is exposed through ErrorClassification.toSpecification(...), which returns a map like:
{ "type": "ExtendedValidationError", "validatedPath": [...], "constraint": "@..." }Because of this, I currently have to work around the issue by replacing the extended-validation MessageInterpolator and returning a custom ErrorClassification whose toString() returns ExtendedValidationError only when called from Sentry:
That workaround is brittle and depends on Sentry internals.
This looks related to #2899, which added easier GraphQL error filtering. The current string-based filtering solves enum-like classifications, but it is hard to use with custom ErrorClassification implementations where toSpecification(...) carries the meaningful classification.
Solution Brainstorm
Could Sentry support a more robust way to classify ignored GraphQL errors?
A few possible approaches:
When
error.getErrorType()is present, callerrorType.toSpecification(error)and, if it returns a map containing atypefield, allowignored-error-typesto match that value.Add a callback/predicate for GraphQL errors. This would allow applications to inspect GraphQLError, ErrorClassification, extensions, path, etc.
Pass the GraphQLError and/or ErrorClassification through the Sentry Hint, as mentioned in Easier way of filtering errors for GraphQL #2899, so users can filter these events in beforeSend without replacing the whole GraphQL instrumentation.
My preference would be option 1 for configuration compatibility, possibly combined with option 3 for advanced filtering.
This would also make the Sentry GraphQL integration work out of the box with
graphql-java-extended-validation, which is an official companion library from thegraphql-javaproject. Since Sentry Java already integrates withgraphql-java, it would be helpful if expected validation errors from this commonly used library could be ignored without replacing the message interpolator or depending onErrorClassification.toString().