Components: Refactor more tests to use real timers#47318
Merged
Conversation
|
Size Change: 0 B Total Size: 1.33 MB ℹ️ View Unchanged
|
|
Flaky tests detected in ce24334. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/3968077875
|
ciampo
reviewed
Jan 27, 2023
Comment on lines
-267
to
+271
| const menu = screen.getByRole( 'menu', { | ||
| name: 'Block Name', | ||
| } ); | ||
| expect( menu ).toBeInTheDocument(); | ||
| expect( menu ).not.toBeVisible(); | ||
| await waitFor( () => | ||
| expect( | ||
| screen.getByRole( 'menu', { | ||
| name: 'Block Name', | ||
| } ) | ||
| ).toBeVisible() | ||
| ); |
Contributor
There was a problem hiding this comment.
I'm not sure I understand these changes — previously the test was checking for the menu to be in the document, but not visible, while the new version of the test seems to check that the menu is visible.
Can you explain the rationale here? Thank you!
Member
Author
There was a problem hiding this comment.
The previous test was just wrong. If you manually go through the steps, you'll see that both the button and the menu should be visible. The previous test just wasn't properly waiting for the menu to be revealed.
Comment on lines
-224
to
+227
| const menu = screen.getByRole( 'menu', { | ||
| name: 'Block Name', | ||
| } ); | ||
| expect( menu ).toBeInTheDocument(); | ||
| expect( menu ).not.toBeVisible(); | ||
| await waitFor( () => | ||
| expect( | ||
| screen.getByRole( 'menu', { | ||
| name: 'Block Name', | ||
| } ) | ||
| ).toBeVisible() | ||
| ); |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 updates even more component tests to use real timers. This is a follow-up to #46714, #47056, #47144, and #47218.
Why?
We discovered that Jest real timers are preferable when their use is possible, see facebook/react#25889 and the description in #46714.
This post is great writing that explains the rationale in more detail:
https://jsnajdr.wordpress.com/2023/01/11/prefer-jest-real-timers-when-testing-with-react-testing-library/
How?
We're removing the specific
jest.useFakeTimers();calls. We're also removing the now unnecessaryjest.advanceTimersByTime()calls and post-test cleanup that we've been doing withjest.runOnlyPendingTimers()andjest.useRealTimers(). We're also altering some tests to wait for the appropriate actions before continuing/performing the relevant assertions.Testing Instructions
Verify all tests still pass.
Testing Instructions for Keyboard
None
Screenshots or screencast
None.