-
Notifications
You must be signed in to change notification settings - Fork 232
Fix/better error handling for hydrate #862
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
Open
amovar18
wants to merge
3
commits into
testing-library:main
from
amovar18:fix/better-error-handling-for-hydrate
Open
Fix/better error handling for hydrate #862
amovar18
wants to merge
3
commits into
testing-library:main
from
amovar18:fix/better-error-handling-for-hydrate
Conversation
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
❌ Deploy Preview for react-hooks-testing-library failed.
|
Thanks @Amovar1. I do not have a heap of time to look at this, but I’ll try to get to it this weekend.
A couple of notes from my quick look now:
- Can we write a test for this? It should be possible to see the error by calling
hydrate
in this test file as there is no document available there (it’s meant to replicate a ssr environment). - I think the docs are ok on this as in the case of the ssr renderer,
render
simulates the server behaviour, andhydrate
simulates the client behaviour. That said, updates to add clarity in the docs are always welcome (just be aware that our docs generation is currently broken so might be wasted effort). - Speaking of the docs, don’t worry about the netlify errors. This was already broken and unrelated to your changes.
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.
What:
This PR adds a custom error message for
hydrate
function.Why:
When hydrate function is called in non-browser environment it throws an error
document is not defined
which lead to a non-meaningful error message. This PR now aims to check if document is available or not and then throws a custom error message.How:
This PR just provides a wrapper of an
if else
block inside thehydrate
function and throws a custom error message sayingHydrate function can only be called in a client environment with a document available.
.Checklist:
SideNote: The documentation states that to use
hydrate
function for SSR testing of a hook but the conversation in the issue stated thatrender
should be used in non browser environment andhydrate
should be used on environment wheredocument
is available. Should the documentation be updated?