[Fiber] support hydration when rendering Suspense anywhere #32224
+833
−40
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
ec6a539 to
5b6d0a9
Compare
5b6d0a9 to
e0dff86
Compare
e0dff86 to
7ca25bf
Compare
7ca25bf to
f49516e
Compare
f49516e to
29269cc
Compare
29269cc to
cb8aee0
Compare
cb8aee0 to
d103fac
Compare
d103fac to
4a89f74
Compare
4a89f74 to
186fd8b
Compare
186fd8b to
0c469b3
Compare
0c469b3 to
75a8cbf
Compare
75a8cbf to
d64a73c
Compare
gnoff
commented
Jan 27, 2025
d64a73c to
507f04c
Compare
507f04c to
5832fe9
Compare
b7ed994 to
a85088e
Compare
37e273b to
7d0adf7
Compare
7d0adf7 to
6ca6e31
Compare
stacked on facebook#32163 This continues the work of making Suspense workable anywhere in a react-dom tree. See the prior PRs for how we handle server rendering and client rendering. In this change we update the hydration implementation to be able to locate expected nodes. In particular this means hydration understands now that the default hydration context is the document body when the container is above the body. One case that is unique to hydration is clearing Suspense boundaries. When hydration fails or when the server instructs the client to recover an errored boundary it's possible that the html, head, and body tags in the initial document were written from a fallback or a different primary content on the server and need to be replaced by the client render. However these tags (and in the case of head, their content) won't be inside the comment nodes that identify the bounds of the Suspense boundary. And when client rendering you may not even render the same singletons that were server rendered. So when server rendering a boudnary which contributes to the preamble (the html, head, and body tag openings plus the head contents) we emit a special marker comment just before closing the boundary out. This marker encodes which parts of the preamble this boundary owned. If we need to clear the suspense boundary on the client we read this marker and use it to reset the appropriate singleton state.
6ca6e31 to
0e39257
Compare
eps1lon
approved these changes
Feb 4, 2025
| rootPreamble.htmlChunks = preambleState.htmlChunks; | ||
| preambleState.contribution |= HTMLContribution; |
There was a problem hiding this comment.
I guess the contribution flag means that the chunks of this preamble were handled and passed along? I was expecting this to set the contribution flag on the rootPreamble instead.
There was a problem hiding this comment.
Yeah the reason we even need to track which boundary contributed to which part of the preamble is because if that boundary ever needs to be retried on the client we need to clean up the disconnected parts since they won't be 'inside' that boundary like normal tags would be. The root never gets cleaned up (except in that the entire container might be cleared but that will already be the entire Document if you are rendering these singletons anyway) so when a Suspense boundary is contributing a part of the preamble it tracks in it's own state that it's preamble parts were actually used so we can associate the necessary info with that boundary on the client to clean it up.
github-actions bot
pushed a commit
that referenced
this pull request
Feb 4, 2025
follow up to #32163 This continues the work of making Suspense workable anywhere in a react-dom tree. See the prior PRs for how we handle server rendering and client rendering. In this change we update the hydration implementation to be able to locate expected nodes. In particular this means hydration understands now that the default hydration context is the document body when the container is above the body. One case that is unique to hydration is clearing Suspense boundaries. When hydration fails or when the server instructs the client to recover an errored boundary it's possible that the html, head, and body tags in the initial document were written from a fallback or a different primary content on the server and need to be replaced by the client render. However these tags (and in the case of head, their content) won't be inside the comment nodes that identify the bounds of the Suspense boundary. And when client rendering you may not even render the same singletons that were server rendered. So when server rendering a boudnary which contributes to the preamble (the html, head, and body tag openings plus the head contents) we emit a special marker comment just before closing the boundary out. This marker encodes which parts of the preamble this boundary owned. If we need to clear the suspense boundary on the client we read this marker and use it to reset the appropriate singleton state. DiffTrain build for [8bda715](8bda715)
github-actions bot
pushed a commit
that referenced
this pull request
Feb 4, 2025
follow up to #32163 This continues the work of making Suspense workable anywhere in a react-dom tree. See the prior PRs for how we handle server rendering and client rendering. In this change we update the hydration implementation to be able to locate expected nodes. In particular this means hydration understands now that the default hydration context is the document body when the container is above the body. One case that is unique to hydration is clearing Suspense boundaries. When hydration fails or when the server instructs the client to recover an errored boundary it's possible that the html, head, and body tags in the initial document were written from a fallback or a different primary content on the server and need to be replaced by the client render. However these tags (and in the case of head, their content) won't be inside the comment nodes that identify the bounds of the Suspense boundary. And when client rendering you may not even render the same singletons that were server rendered. So when server rendering a boudnary which contributes to the preamble (the html, head, and body tag openings plus the head contents) we emit a special marker comment just before closing the boundary out. This marker encodes which parts of the preamble this boundary owned. If we need to clear the suspense boundary on the client we read this marker and use it to reset the appropriate singleton state. DiffTrain build for [8bda715](8bda715)
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.
follow up to #32163
This continues the work of making Suspense workable anywhere in a react-dom tree. See the prior PRs for how we handle server rendering and client rendering. In this change we update the hydration implementation to be able to locate expected nodes. In particular this means hydration understands now that the default hydration context is the document body when the container is above the body.
One case that is unique to hydration is clearing Suspense boundaries. When hydration fails or when the server instructs the client to recover an errored boundary it's possible that the html, head, and body tags in the initial document were written from a fallback or a different primary content on the server and need to be replaced by the client render. However these tags (and in the case of head, their content) won't be inside the comment nodes that identify the bounds of the Suspense boundary. And when client rendering you may not even render the same singletons that were server rendered. So when server rendering a boudnary which contributes to the preamble (the html, head, and body tag openings plus the head contents) we emit a special marker comment just before closing the boundary out. This marker encodes which parts of the preamble this boundary owned. If we need to clear the suspense boundary on the client we read this marker and use it to reset the appropriate singleton state.