Fix: Improve Sentry error reporting for API failures - #2531
Open
sentry[bot] wants to merge 1 commit into
Open
sentry[bot] wants to merge 1 commit into
sentry[bot] wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. |
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.
This PR addresses issue SOLID-W3 by improving how API errors are handled and reported to Sentry.
Problem:
Previously, many API calls in
lib/api.tswouldthrow responsedirectly when a fetch operation returned a non-OK HTTP status. When these rawResponseobjects were caught byuseMutation'sonErrorhandler and passed toSentry.captureException, Sentry would report them with an unhelpful title like "Object captured as exception with keys: _bodyBlob, _bodyInit...". This made it difficult to quickly understand the nature of the API failure.Solution:
throwIfNotOk, has been introduced inlib/api.ts. This function checksresponse.okand, if false, throws a standardErrorinstance with a descriptive message including the HTTP status code, status text, and URL.if (!response.ok) throw response;acrosslib/api.tshave been replaced with calls tothrowIfNotOk(response);. This ensures that all API failures consistently throw properErrorobjects.lib/__tests__/throwIfNotOk.test.ts, has been added to verify the correct behavior of thethrowIfNotOkhelper, ensuring it throwsErrorinstances with the expected message content.This change ensures that Sentry receives meaningful
Errorobjects for API failures, leading to clearer and more actionable error reports.Fixes SOLID-W3
@sentry <feedback>: Autofix iterates on these changes@sentry stop iterating: Autofix stops iterating on this runThis PR was automatically generated by Sentry. You can adjust this setting at any time.