docs(Suspense): warn against module-level cache in SSR#8485
Open
LuxologyGG wants to merge 1 commit into
Open
Conversation
Add a Pitfall on the Suspense reference page explaining that the hidden data.js cache must not be copied into server environments like Next.js, where module-level state can leak data across requests. Clarify the data.js comment in all Suspense examples accordingly. Fixes reactjs#8134
Size changesDetails📦 Next.js Bundle Analysis for react-devThis analysis was generated by the Next.js Bundle Analysis action. 🤖 This PR introduced no changes to the JavaScript bundle! 🙌 |
This file contains hidden or 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
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.
Summary
Closes #8134
The Suspense reference page examples include a hidden
data.jsfile with a module-levelMapcache that, if copied into server environments like Next.js, can leak data across requests.This PR adds a Pitfall warning before the first Suspense example and clarifies in all eight
data.jshidden files that the module-level cache is only for the client-only demo.Before / After
Before: Module-level
Mapcache indata.jswith no warning about server-side use.After: Pitfall callout at the top of the Suspense examples plus a comment in each
data.jsfile: "This module-level cache is only suitable for this client-only demo. Do not copy it into server environments."Test plan
data.jshidden files include the updated comment