feat: wrap waitFor in (async) act to support async queries without explicit act call
#344
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
thymikee
changed the title
waitFor in (async) act to support async queries without explicit act callwaitFor in (async) act to support async queries without explicit act call
thymikee
reviewed
May 21, 2020
src/waitFor.js
Outdated
Comment on lines
46
to
54
| let result: T; | ||
|
|
||
| //$FlowFixMe: this is just too complicated for flow | ||
| await act(async () => { | ||
| result = await waitForInternal(expectation, options); | ||
| }); | ||
|
|
||
| //$FlowFixMe: either we have result or `waitFor` there error | ||
| return result; |
There was a problem hiding this comment.
How about:
Suggested change
| let result: T; | |
| //$FlowFixMe: this is just too complicated for flow | |
| await act(async () => { | |
| result = await waitForInternal(expectation, options); | |
| }); | |
| //$FlowFixMe: either we have result or `waitFor` there error | |
| return result; | |
| return act(() => waitForInternal(expectation, options)); |
There was a problem hiding this comment.
Unfortunately does not work, as act is not forwarding the return value from the callback.
There was a problem hiding this comment.
We need to capture it to intermediate variable so that it can be returned by the waitFor async wrapper
There was a problem hiding this comment.
Ok, I see it now. The error suppressed by "//$FlowFixMe: this is just too complicated for flow" comes from lacking lib defs of react-test-renderer, not Flow being dumb. Worth updating the comment
thymikee
reviewed
May 21, 2020
thymikee
reviewed
May 21, 2020
src/waitFor.js
Outdated
| options?: WaitForOptions | ||
| ): Promise<T> { | ||
| if (!checkReactVersionAtLeast(16, 9)) { | ||
| return await waitForInternal(expectation, options); |
There was a problem hiding this comment.
return await is redundant, you can omit the await
thymikee
reviewed
May 21, 2020
thymikee
reviewed
May 21, 2020
thymikee
approved these changes
May 21, 2020
Co-authored-by: Michał Pierzchała <thymikee@gmail.com>
Co-authored-by: Michał Pierzchała <thymikee@gmail.com>
thymikee
reviewed
May 21, 2020
Co-authored-by: Michał Pierzchała <thymikee@gmail.com>
thymikee
added a commit
that referenced
this pull request
May 28, 2020
…explicit `act` call (#344) * Wrapped waitFor call in act to support async waitFor/findBy * Updated docs * Spelling mistake * Added short info in migration guide * Corrected spelling * Clarified comments * Added async act implementation conditional on React version * Code review changes * Update src/waitFor.js Co-authored-by: Michał Pierzchała <thymikee@gmail.com> * Update src/waitFor.js Co-authored-by: Michał Pierzchała <thymikee@gmail.com> * Fixed prettier * Update src/waitFor.js Co-authored-by: Michał Pierzchała <thymikee@gmail.com> Co-authored-by: Michał Pierzchała <thymikee@gmail.com>
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.
Summary
Wrap
waitForin (async) act to support async queries without explicitactcall. Otherwise there was a problem when async state changes caused by e.g. asyncuseEffectuses (fetching data, ...) generated drededactwarnings in the console during test runs.Closes #343