fix: Prevent cascading 'Not Found Error' Sentry events on commit page#3984
Draft
sentry[bot] wants to merge 1 commit into
Draft
fix: Prevent cascading 'Not Found Error' Sentry events on commit page#3984sentry[bot] wants to merge 1 commit into
sentry[bot] wants to merge 1 commit into
Conversation
Author
❌ 1 Tests Failed:
View the top 1 failed test(s) by shortest run time
|
Author
Bundle ReportChanges will increase total bundle size by 7 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: gazebo-production-systemAssets Changed:
Files in
view changes for bundle: gazebo-production-esmAssets Changed:
Files in
|
Collaborator
✅ Deploy preview for gazebo ready!Previews expire after 1 month automatically.
|
❌ 1 Tests Failed:
View the top 1 failed test(s) by shortest run time
To view more test analytics, go to the Test Analytics Dashboard |
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
1 participant
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.
Description
This PR addresses GAZEBO-17YQ, where navigating to a commit page for a non-existent or inaccessible repository resulted in a cascade of 'Not Found Error' Sentry events.
Problem:
When a user visited a commit detail page (e.g.,
/:provider/:owner/:repo/commit/:commit) for a repository that did not exist or was not configured with Codecov, multiple data-fetching hooks (useCommitTeam,useCommit,useRepoOverview, etc.) would independently query the GraphQL API. The API would correctly return__typename: 'NotFoundError'. Each of these hooks would then callrejectNetworkError, leading to multiple Sentry events for the same underlying issue.Root Cause:
The
CommitDetailPagecomponent was not rendering the<NotFound />component early enough. WhileCommitPageDataQueryOptscorrectly identified theNotFoundError, it rejected its promise, causinguseSuspenseQueryV5to throw. This prevented theCommitDetailPage's ownNotFoundguard from being reached before child components (and their respective data hooks) were mounted and executed, leading to redundant Sentry captures.Solution:
CommitPageDataQueryOpts: Instead of callingrejectNetworkErrorwhenrepository.__typename === 'NotFoundError', it now returns a simple{ notFound: true }sentinel value. This keeps the query resolved (not thrown) and prevents a Sentry event at this level.CommitDetailPage: An early checkif ('notFound' in commitPageData && commitPageData.notFound)has been added. If the sentinel is present, the page immediately renders<NotFound />. This ensures that child components and their data hooks are never mounted when the repository is not found.Benefits:
<NotFound />page when a repository is genuinely missing or inaccessible, without unnecessary data fetching attempts by child components.Code Example
N/A
Notable Changes
CommitPageDataQueryOptsto return a sentinel value{ notFound: true }instead of rejecting the promise when a repository is not found, preventing premature Sentry events.CommitDetailPageto include an early check for this sentinel value, allowing it to render the<NotFound />component immediately and prevent child components from mounting and initiating redundant data fetches.<NotFound />page for missing or inaccessible repositories.Screenshots
N/A
Link to Sample Entry
N/A
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 GAZEBO-17YQ