[Fizz] Expose a method to abort a pending request #21027
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
This allows us to abort work and put everything into client rendered mode if we don't want to wait for further I/O. It also allows us to cancel fallbacks if we complete the main content before the fallback.
Since this API already returns a value, we need to use destructuring to expose more options.
facebook-github-bot
added
CLA Signed
React Core Team
|
Comparing: 3fb11ee...28c0533 Critical size changesIncludes critical production bundles, as well as any change greater than 2%:
Significant size changesIncludes any change greater than 0.2%: Expand to show
|
|
Since Flight has a similar API maybe it should have the same. Another API design could be to just provide a timeout option. I'm not sure how else you'd use it other than like timeout 0 (renderToString) or some time based abort. |
|
Edit: Hm. Now that I think about it... AbortSignal is the idiomatic way to do this. We can just accept that as an option. I did that instead. |
gaearon
reviewed
Mar 18, 2021
| let request; | ||
| const stream = new ReadableStream({ | ||
| if (options && options.signal) { | ||
| options.signal.addEventListener('abort', () => abort(request)); |
There was a problem hiding this comment.
This doesn't ever need to be cleaned up, right?
There was a problem hiding this comment.
Good question. I would assume the owner would drop the signal when they're done but we might as well clean it up to be sure.
gaearon
approved these changes
Mar 18, 2021
zhengjitf
pushed a commit
to zhengjitf/react
that referenced
this pull request
Mar 23, 2021
* Track all suspended work while it's still pending This allows us to abort work and put everything into client rendered mode if we don't want to wait for further I/O. It also allows us to cancel fallbacks if we complete the main content before the fallback. * Expose abort API to the browser streams Since this API already returns a value, we need to use destructuring to expose more options. * Add a test including the client actually client rendering it * Use AbortSignal option for W3C streams instead of external control * Clean up listener after it's used once
facebook-github-bot
pushed a commit
to facebook/react-native
that referenced
this pull request
Mar 23, 2021
Summary: This sync includes the following changes: - **[6d3ecb70d](facebook/react@6d3ecb70d )**: Remove unstable_changedBits ([#20953](facebook/react#20953)) //<Andrew Clark>// - **[754e30728](facebook/react@754e30728 )**: Delete immediateQueueCallbackNode ([#20980](facebook/react#20980)) //<Andrew Clark>// - **[be5a2e231](facebook/react@be5a2e231 )**: Land enableSyncMicrotasks ([#20979](facebook/react#20979)) //<Andrew Clark>// - **[f6bc9c824](facebook/react@f6bc9c824 )**: [Fizz] Expose maxBoundarySize as an option ([#21029](facebook/react#21029)) //<Sebastian Markbåge>// - **[154b85213](facebook/react@154b85213 )**: [Fizz] Expose a method to explicitly start writing to a Node stream ([#21028](facebook/react#21028)) //<Sebastian Markbåge>// - **[cf485e6f6](facebook/react@cf485e6f6 )**: [Fizz] Expose a method to abort a pending request ([#21027](facebook/react#21027)) //<Sebastian Markbåge>// - **[3fb11eed9](facebook/react@3fb11eed9 )**: React Native: Touch Instrumentation Interface ([#21024](facebook/react#21024)) //<Timothy Yung>// - **[825c3021f](facebook/react@825c3021f )**: Don't delete trailing mismatches during hydration at the root ([#21021](facebook/react#21021)) //<Sebastian Markbåge>// - **[1d1e49cfa](facebook/react@1d1e49cfa )**: [Fizz] Assign an ID to the first DOM element in a fallback or insert a dummy (and testing infra) ([#21020](facebook/react#21020)) //<Sebastian Markbåge>// - **[466b26c92](facebook/react@466b26c92 )**: Store commit durations on HostRoot for DevTools access ([#20983](facebook/react#20983)) //<Brian Vaughn>// - **[89acfa639](facebook/react@89acfa639 )**: Fix native event batching in concurrent mode ([#21010](facebook/react#21010)) //<Ricky>// - **[0203b6567](facebook/react@0203b6567 )**: chore: update react-reconciler README ([#21016](facebook/react#21016)) //<susiwen8>// Changelog: [General][Changed] - React Native sync for revisions c9f6d0a...6d3ecb7 jest_e2e[run_all_tests] Reviewed By: JoshuaGross, kacieb Differential Revision: D27231625 fbshipit-source-id: 89c0c0662e69044ae8890486a693013bee6005dd
koto
pushed a commit
to koto/react
that referenced
this pull request
Jun 15, 2021
* Track all suspended work while it's still pending This allows us to abort work and put everything into client rendered mode if we don't want to wait for further I/O. It also allows us to cancel fallbacks if we complete the main content before the fallback. * Expose abort API to the browser streams Since this API already returns a value, we need to use destructuring to expose more options. * Add a test including the client actually client rendering it * Use AbortSignal option for W3C streams instead of external control * Clean up listener after it's used once
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.
This introduces a Set of SuspendedWork to the data structures. This is basically like an AbortSignal. In fact, it should probably be coupled with an actual AbortSignal at the same places.
For work inside a fallback, the abortSet is associated with the boundary that it's a fallback for. This lets the boundary cancel the fallback if the boundary completes.
For all other work, the abortSet is associated with the whole request. This lets you cancel this work for the whole request. If a pending boundary is canceled, then its fallback is canceled too.
I expose this method as an explicit separate control for the Node API. Seems more idiomatic and the follow PR will add such a control anyway. For the Browser API, I accept an actual AbortSignal as an option.
This can be used to implement for example timeout semantics.
There's a subtle difference between this API and just closing the stream. It lets the stream continue emitting whatever is still queued to flush. It also emits a signal to the client that these fallbacks should be client rendered instead of waiting for the server. But we really should have some way to recover from a terminated stream if we're able to hydrate.