Components: Remove unnecessary act() from ToolsPanel tests
#47691
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
tyxla
added
[Type] Code Quality
tyxla
requested review from
Mamaduka,
mirka,
jsnajdr,
ciampo,
flootr,
chad1008,
ntsekouras and
brookewp
|
Size Change: +726 B (0%) Total Size: 1.31 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in 51c3c34. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/4084567770
|
ciampo
reviewed
Feb 2, 2023
| @@ -172,16 +172,17 @@ const getMenuButton = () => { | |||
| * @return {HTMLElement} The menuButton. | |||
| */ | |||
| const openDropdownMenu = async () => { | |||
| const user = userEvent.setup(); | |||
There was a problem hiding this comment.
Do you think it's fine to setup userEvent inside a utility function, rather than once per test?
There was a problem hiding this comment.
Yes, I believe it's fine because a subsequent userEvent().setup() will reuse all from the prior call:
- Preparing the document - basically adding some event listeners - it's done only once, and if
prepareDocument()is called, event listeners will not be recreated. - Attaching clipboard stub to window - will reuse the same stub if it has already been created.
- Retrieving the document - will reuse the same document object.
The only thing it won't reuse is the actually returned config object reference, which we never use directly anyway, so we're good to go.
mirka
approved these changes
Feb 3, 2023
Co-authored-by: Lena Morita <[email protected]>
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 cleans up a few unnecessary
act()calls and improves some of theToolsPaneltests.Why?
When preparing our tests to work with React 18 we did a bunch of those
act()calls. It's time to clean them up where possible.How?
fireEvent.click()calls in favor ofuserEvent.click(), and those are async.fireEventusage and removing it completely from the testsTesting Instructions
Verify tests still pass:
npm run test:unit packages/components/src/tools-panel/test/index.jsTesting Instructions for Keyboard
None
Screenshots or screencast
None