[RFC] fix(fireEvent): Flush effects from discrete events immediately #898
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
eps1lon
added
bug
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 29da123:
|
BREAKING CHANGE:
Importing from `@testing-library/react` will no longer wrap event
dispatches of `@testing-library/dom` in `act(() => {})`
eps1lon
force-pushed
the
feat/discrete-events-no-act
branch
from
54ec5ab
to
5f73381
Compare
Codecov Report
@@ Coverage Diff @@
## master #898 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 4 4
Lines 140 150 +10
Branches 28 28
=========================================
+ Hits 140 150 +10
Continue to review full report at Codecov.
|
|
Will be handled in React 18: reactwg/react-18#21 (reply in thread) |
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.
I get strong enzyme vibes from this PR (considering we rely on React implementation details). This PR is more exploratory and any discussion should probably be directed at facebook/react#21202 where I'd want this fix to land ideally.
BREAKING CHANGE
Importing from
@testing-library/reactwill no longer wrap eventdispatches of
@testing-library/dominact(() => {}).Essentially reverting #685. This will affect
user-eventbut I don't see any other way. Wrapping inact(() => {})inuser-eventis event worse sinceuser-eventis explicitly about user events whichfireEevent.clickwas not about.What:
If effects in a portaled component were scheduled from discrete event dispatches (e.g. fireEevent.click) then these effects were not flushed during that event but before we returned. This behavior does not match the behavior of events in response to a user interaction.
Why:
fireEventmajority usage is to test event dispatches in response to user interactions.How:
discrete events are no longer wrapped in
act(() => {}). Their updates are still flushed when we return though.Checklist:
docs site
I don't think we need to add docs since automatic
configurewas never documented[ ]Typescript definitions updatedPR must be revisited once Flush discrete updates immediately in a batched context facebook/react#21202 is resolved.