Catch hydration errors and link to Hydrogen issue #1032
Merged
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
We see quite a few hydration errors right now related to Suspense and server components: #920
This is fine, because the client rendering of the server components response works just fine. However, it distracts developers and makes them think something is wrong with their application.
This PR leverages the new
onRecoverableError
hook to catch hydration errors. In development, we print out a message explaining that it's due to experimental bugs with a link to the Hydrogen issue. In production, nothing is printed, and the user isn't the wiser that any hydration error happened at all.In development, the hydration error is still thrown in red above, but this is printed below:
To tophat this, remove the Suspense boundary around the children inside
Layout.server.jsx
.Before submitting the PR, please make sure you do the following:
fixes #123
)yarn changeset add
if this PR cause a version bump based on Keep a Changelog and adheres to Semantic Versioning