-
Notifications
You must be signed in to change notification settings - Fork 276
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[sitecore-jss-react] Introduce ErrorBoundary to serve as error handling per component #1786
Merged
Conversation
This file contains 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
…ing; add 'type' prop in ErrorBoundary to cover case when renderEach function is being used
ambrauer
reviewed
Apr 26, 2024
addy-pathania
approved these changes
May 2, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work! 👍🏼
ambrauer
approved these changes
May 2, 2024
This was referenced May 8, 2024
8 tasks
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 / Motivation
This PR introduces ErrorBoundary component. All rendered components are wrapped with it and will catch client or server side (uses < Suspense />) errors from any of its children, display appropriate message and prevent the rest of the application from failing. It accepts and can display custom error component and loading message if it is passed as a prop to parent Placeholder.
Note that ErrorBoundary will not catch errors for:
If an error occurs in development mode or during page editing the ErrorBoundary will display error message with the name of the faulty component and the error's message.
If we are in production mode and the error happens not in editing mode ErrorBoundary will display generic error message without providing additional information about the error and the component.
If Custom error component has been provided to the Placeholder showing it will take precedence over the above scenarios.
Testing Details
Types of changes