Unit Tests: rewrite ReactDOM.render usages to RTL #45453
Merged
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
|
|
|
Size Change: +1.54 kB (0%) Total Size: 1.28 MB
ℹ️ View Unchanged
|
tyxla
reviewed
Nov 1, 2022
Member
tyxla
left a comment
tyxla
left a comment
There was a problem hiding this comment.
This looks great, thank you for beating me to it 🚀
I've left a few suggestions for improvement, let me know what you think!
| const { container, rerender } = render( <MergedRefs /> ); | ||
|
|
||
| const originalElement = rootElement.firstElementChild; | ||
| const originalElement = container.firstElementChild; |
Member
There was a problem hiding this comment.
Do you mind altering the default tagName in MergedRefs above to be ul for example? That way instead of creating new ESLint violations for no-node-access, we'll be able to use screen.getByRole( 'list' )?
Member
Author
There was a problem hiding this comment.
That's a neat trick, I used it 🙂 getByRole also ensures that the element actually exists. That was one of my worries when migrating the test: is firstElementChild really an element, or is it undefined?
| ] ); | ||
|
|
||
| ReactDOM.render( null, rootElement ); | ||
| rerender( null ); |
Member
There was a problem hiding this comment.
We should be able to use unmount from the result of render() above. It expresses our intentions more explicitly. WDYT?
Member
Author
There was a problem hiding this comment.
unmount() works, changed rerender( null ) instances to that 👍
| ); | ||
|
|
||
| expect( div.innerHTML ).toMatchSnapshot(); | ||
| expect( container.innerHTML ).toMatchSnapshot(); |
Member
There was a problem hiding this comment.
Mind going with container instead? We'll need to update the snapshot, but at least we'll get rid of a no-node-access violation.
Suggested change
| expect( container.innerHTML ).toMatchSnapshot(); | |
| expect( container ).toMatchSnapshot(); |
Member
Author
There was a problem hiding this comment.
As the purpose of the test is to check whether the PluginPrePublishPanel was rendered at all, by filling in a slot, I modified the assertion to check for the panel title element (with getByText). Checking the entire markup with a snapshot is redundant, so I removed the snapshot completely.
Member
Author
|
Thanks for reviewing @tyxla! All the reported issues are addressed now. |
tyxla
approved these changes
Nov 3, 2022
| ); | ||
|
|
||
| expect( div.innerHTML ).toMatchSnapshot(); | ||
| expect( screen.getByText( 'My panel title' ) ).toBeInTheDocument(); |
Member
There was a problem hiding this comment.
I've found that .toBeVisible() is even a bit more specific than .toBeInTheDocument(), but that's just me nitpicking, feel free to ignore it.
Member
Author
There was a problem hiding this comment.
Good idea, fixed.
By the way here's one place where our tests are happy with an invisible element, although they shouldn't be:
That components-popover element is made visible with an animation, and this snapshot caught only the initial frame of the animation, where there is opacity: 0. It should wait for the animation to finish. Or specify animate={ false }. In that test the animation wouldn't even run because there are fake timers and nobody advances them.
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.
There are some unit tests that use
ReactDOM.renderto render a React UI into a JSDOM element. But theReactDOM.renderAPI is deprecated in React 18.This PR is rewriting the
ReactDOM.renderto use therenderabstraction from Testing Library. Under the hood it does exactly the same thing, and when we eventually upgrade to React 18, we'll get an update tocreateRootfor free.Part of React 18 migration in #45235.