fix(sentry): ignore GraphQL client validation errors#1034
Open
sentry[bot] wants to merge 1 commit into
Open
Conversation
Contributor
Author
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1034 +/- ##
=======================================
Coverage 91.90% 91.90%
=======================================
Files 1318 1318
Lines 50711 50713 +2
Branches 1625 1625
=======================================
+ Hits 46604 46606 +2
Misses 3801 3801
Partials 306 306
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
GraphQL validation errors, such as
GraphQLError: Fragment cannot be spread here as objects of type 'Me' can never be of type 'User'., are currently being logged asGraphQL internal server errorin Sentry.Root Cause
The
error_formatterinapps/codecov-api/graphql_api/views.pywas not correctly distinguishing between actual server-side exceptions and client-side GraphQL validation errors. When a GraphQL query fails validation (e.g., due to an invalid fragment spread or unknown field), theerror.original_errorattribute isNone. The existing logic would then fall into a genericelseblock, logging these client-caused issues as internal server errors to Sentry.Solution
Modified the
error_formatterto explicitly check forerror.original_error is None. If this condition is met, it indicates a GraphQL validation error originating from a malformed client query. In such cases, the formatted error is now returned directly, preventing it from being logged as an internal server error or captured by Sentry. This ensures that Sentry alerts are reserved for genuine server-side issues.Legal Boilerplate
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. In 2022 this entity acquired Codecov and as result Sentry is going to need some rights from me in order to utilize my contributions in this PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
Fixes API-E91