fix: Handle network errors with proper Error objects#3998
Open
sentry[bot] wants to merge 1 commit into
Open
Conversation
Bundle ReportChanges will increase total bundle size by 338 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
|
❌ 4 Tests Failed:
View the top 3 failed test(s) by shortest run time
To view more test analytics, go to the Test Analytics Dashboard |
Collaborator
✅ Deploy preview for gazebo ready!Previews expire after 1 month automatically.
|
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.
Description
This PR addresses the "Error: he" issue (GAZEBO-17ZM) which occurred when
rejectNetworkErrorwas called, leading to unhandled exceptions in the UI.Problem:
Previously,
rejectNetworkErrorwould returnPromise.reject()with a plain JavaScript object{dev, data, status}. When React Query'suseSuspenseQueryV5rethrew this plain object in a minified production bundle, React would report the error as "Error: he", where "he" was the minified variable name holding the plain object. This resulted in an unhandled exception, as theNetworkErrorBoundarywas not designed to catch non-Error objects directly and the outer Sentry ErrorBoundary would capture a cryptic message.Impact:
This change ensures that all network-related rejections are proper
Errorobjects, providing more meaningful stack traces and error messages (no more "Error: he"). It allows theNetworkErrorBoundaryto correctly intercept and display user-friendly messages for network-related issues, preventing unhandled exceptions from crashing the application or reporting unhelpful messages to Sentry.Code Example
No direct code example is provided, but changes are made in
src/shared/api/rejectNetworkError.tsandsrc/layouts/shared/NetworkErrorBoundary/NetworkErrorBoundary.jsx.Notable Changes
NetworkErrorclass: A new classNetworkErrorwas created insrc/shared/api/rejectNetworkError.tsthat extends the nativeErrorclass. This custom error class now properly carriesstatusanddataproperties.rejectNetworkError: TherejectNetworkErrorfunction now throws instances of theNetworkErrorclass instead of plain objects. This ensures that any rejection from this utility is always a properErrorobject.NetworkErrorBoundary: TheNetworkErrorBoundaryinsrc/layouts/shared/NetworkErrorBoundary/NetworkErrorBoundary.jsxwas updated to explicitly check if an error is aninstanceof NetworkErrorbefore attempting to access itsstatusproperty. This prevents incorrect handling of non-NetworkErrorobjects and ensures that only intended network errors are processed by this boundary.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-17ZM