Fix out-of-order effect error when suspending in React Native #570
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
…g via a layout effect, and ensure nested effects don't get left open
🦋 Changeset detectedLatest commit: 6d049c1 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
✅ Deploy Preview for preact-signals-demo ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Size Change: +30 B (+0.04%) Total Size: 80.5 kB
ℹ️ View Unchanged
|
JoviDeCroock
approved these changes
Jun 12, 2024
Co-authored-by: Jovi De Croock <[email protected]>
Merged
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 have not managed to reproduce this in tests, since it only seems to happen in React Native, and I believe only with Hermes. In this environment, layout effects are flushed after a microtask (or synchronously?), and rendering can be triggered synchronously from them (via setState/useSyncExternalStore/etc). This means the "close current tracking context" operation we schedule after a Promise tick doesn't happen before the next render begins, which can cause an unmanaged useSignals() call to be left "open".
I've added a
useLayoutEffect()to unmanageduseSignals()to address this, which just works by closing any open tracking context when React finishes the current render (as defined by the time at which React begins to execute effects).As part of this, I also had to tweak
store.f()to ignore repeated calls, as doing so could also trigger the "Out-of-order effect" exception (endEffect()does not guard against this internally as its only possible to trigger when reaching into the guts of signals-core as we do in the integration libraries).