This repository was archived by the owner on Jan 1, 2025. It is now read-only.
Add flag to skip circular dependency detection #2214
Merged
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
facebook-github-bot
added
CLA Signed
|
This pull request was exported from Phabricator. Differential Revision: D44563103 |
|
@RyanHoldren I think the failed check means you need to separate the ICSP and fbonly files out of the diff connected to this into a separate diff. |
|
I think it's okay. Doesn't it just mean that this pull request can't be merged via GitHub but must be shipped via Phabricator?
|
…2214) Summary: Pull Request resolved: facebookexperimental#2214 I discovered a bug in `detectCircularDependencies()` where it may erroneously detect a circular dependency when `graphQLQueryEffect()` is used. It arises from the fact that we are using a global stack to keep track of which Atom/Selectors have been *visited*. From the stack trace, I think I've figured out what is happening... 1) There are a bunch of `selectorGet()` calls to load dependencies. 2) This calls `detectCircularDependencies()` several times and a bunch of keys get added to the `dependencyStack`, as you would expect. So far, everything looks good. 3) Then, because it is a nested dependency, we load an Atom that has a `graphQLQueryEffect()`. 4) The `graphQLQueryEffect()` subscribes to a `RelayObservable`.The act of subscribing schedules a task using the `RelayFBScheduler`. 5) The schedule invokes `flushSyncCallbacks()` in ReactDOM. 6) Which calls `renderWithHooks()` in ReactDOM. 7) Which renders a component that calls `useRecoilValue()`. 8) We then end up back in `detectCircularDependencies()`, which is where we fail because the `dependencyStack` already includes the keys of all those previous Selectors and Atoms up to and including the Atom with the `graphQLQueryEffect()`. This change adds a flag prop named `skipCircularDependencyDetection_DANGEROUS` to `<RecoilRoot>`, which is propagated down to the `Store`. If this flag is set to `true` then `detectCircularDependencies()` is bypassed. This is obviously *less than ideal*. I think we can all agree that a fix for `detectCircularDependencies()` would be a much better solution. I am under the impression that, that will be a major refactor though, since it will require changing `dependencyStack` to be non-global and passing it all around. This flag will at least mitigate the bug until a more proper solution can be implemented. It should be very easy to back it out once that happens. Differential Revision: D44563103 fbshipit-source-id: b396ad068b5dc511664d204e326086cc6b8af29c
RyanHoldren
force-pushed
the
export-D44563103
branch
from
16216c4 to
4a21d43
Compare
|
This pull request was exported from Phabricator. Differential Revision: D44563103 |
eagle2722
added a commit
to eagle2722/Recoil
that referenced
this pull request
Sep 21, 2024
Differential Revision: D44563103 Pull Request resolved: facebookexperimental/Recoil#2214
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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:
I discovered a bug in
detectCircularDependencies()where it may erroneously detect a circular dependency whengraphQLQueryEffect()is used. It arises from the fact that we are using a global stack to keep track of which Atom/Selectors have been visited.From the stack trace, I think I've figured out what is happening...
selectorGet()calls to load dependencies.detectCircularDependencies()several times and a bunch of keys get added to thedependencyStack, as you would expect. So far, everything looks good.graphQLQueryEffect().graphQLQueryEffect()subscribes to aRelayObservable.The act of subscribing schedules a task using theRelayFBScheduler.flushSyncCallbacks()in ReactDOM.renderWithHooks()in ReactDOM.useRecoilValue().detectCircularDependencies(), which is where we fail because thedependencyStackalready includes the keys of all those previous Selectors and Atoms up to and including the Atom with thegraphQLQueryEffect().This change adds a flag prop named
skipCircularDependencyDetection_DANGEROUSto<RecoilRoot>, which is propagated down to theStore. If this flag is set totruethendetectCircularDependencies()is bypassed.This is obviously less than ideal. I think we can all agree that a fix for
detectCircularDependencies()would be a much better solution. I am under the impression that, that will be a major refactor though, since it will require changingdependencyStackto be non-global and passing it all around. This flag will at least mitigate the bug until a more proper solution can be implemented. It should be very easy to back it out once that happens.Differential Revision: D44563103