Fix async timing in tests using user-event#40790
Merged
Conversation
ciampo
changed the title
await in front of user typing events in Unit Control testsawait for user interactions during unit tests
ciampo
changed the title
await for user interactions during unit tests
Contributor
|
Gotta |
…ove unnecessary `waitFor`
ciampo
force-pushed
the
fix/unit-control-tests-await
branch
from
3e9a61d to
79bdd56
Compare
ciampo
changed the title
user-event
|
Size Change: -14 B (0%) Total Size: 1.23 MB
ℹ️ View Unchanged
|
ciampo
added
[Type] Enhancement
ciampo
commented
May 3, 2022
Comment on lines
+313
to
+314
| // TODO: investigate why `onChange` gets called twice instead of once | ||
| expect( onChangeSpy ).toHaveBeenCalledTimes( 2 ); |
Contributor
Author
There was a problem hiding this comment.
This is the only diverging test — although I don't think it should block this PR from being merged, as it's a behavior that can be currently reproduced in trunk
Contributor
There was a problem hiding this comment.
I agree.
// TODO: investigate whyonChangegets called twice instead of once
I guess it's been that way for quite some time now and somehow the async oversights in the test suite were masking it. We could look at extracting this change(and your added code comment) from #40568 to a separate PR.
Contributor
Author
There was a problem hiding this comment.
Sounds like a plan! Opened #40796 with those changes
stokesman
approved these changes
May 3, 2022
Contributor
stokesman
left a comment
stokesman
left a comment
There was a problem hiding this comment.
Superbly done! It's great to see the update with user-event’s advanceTimers and the cleanup of the waitFors (which I guess had been necessary due to missing awaits in other places).
The only thing I noticed was the typo of “trigger” (x3)
This was referenced May 3, 2022
noisysocks
reviewed
May 4, 2022
| ...RTLrender( jsx ), | ||
| }; | ||
| } | ||
| const user = userEvent.setup( { |
Member
There was a problem hiding this comment.
@testing-library recommends that setup() is called inline once per test.
https://testing-library.com/docs/user-event/intro#writing-tests-with-userevent
Contributor
Author
There was a problem hiding this comment.
I must have missed that part when looking at the new v14 docs, thank you for flagging it! Opened #40839 as a follow-up with those changes
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
3 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?
Polish/improve unit tests using
@testing-library/user-eventby making sure that weawaiteach user interaction properly.Why?
As part of the investigation around fixing a timeout error when using
@testing-library/user-event(comment), and related to the recent conversations in #40568 (comment) and #40697 (comment)How?
this PR applies a few small tweaks to the unit tests of
UnitControlandFormFileUpload. Most notable changes are:@testing-library/user-eventfunctions are now prefixed withawaitjest.fakeTimers(as suggested here)waitForcalls (not needed anymore)Testing Instructions
Review code changes, and make sure that all tests pass.