Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add warning and test for useSyncExternalStore when getSnapshot isn't cached #22262

Merged
merged 3 commits into from
Sep 7, 2021
Merged

Add warning and test for useSyncExternalStore when getSnapshot isn't cached #22262

merged 3 commits into from
Sep 7, 2021

Conversation

salazarm
Copy link
Contributor

@salazarm salazarm commented Sep 7, 2021

  • Add a test to the React repo (useSyncExternalStore-test.js) that renders a component that uses useSyncExternalStore.
  • Pass a getSnapshot function to useSyncExternalStore that returns a new object each time it's called
  • The test will throw because of an infinite update loop. It should also log a warning in development that the result of getSnapshot must be cached (can bikeshed the exact text of the warning during code review)

Test Plan:
yarn test

Copy link
Collaborator

@acdlite acdlite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! I think the error message you've chosen is fine, we can revisit it before release with more details, and probably a link to the corresponding documentation (when it's written).

You can merge it once CI passes

@sizebot
Copy link

sizebot commented Sep 7, 2021

Comparing: 771da6e...e6fbd54

Critical size changes

Includes critical production bundles, as well as any change greater than 2%:

Name +/- Base Current +/- gzip Base gzip Current gzip
oss-stable/react-dom/cjs/react-dom.production.min.js = 127.60 kB 127.60 kB = 40.73 kB 40.73 kB
oss-experimental/react-dom/cjs/react-dom.production.min.js = 130.42 kB 130.42 kB = 41.66 kB 41.66 kB
facebook-www/ReactDOM-prod.classic.js = 405.18 kB 405.18 kB = 75.05 kB 75.05 kB
facebook-www/ReactDOM-prod.modern.js = 393.75 kB 393.75 kB = 73.33 kB 73.33 kB
facebook-www/ReactDOMForked-prod.classic.js = 405.18 kB 405.18 kB = 75.05 kB 75.05 kB
oss-experimental/use-sync-external-store/cjs/use-sync-external-store.development.js +3.96% 6.84 kB 7.11 kB +2.71% 2.84 kB 2.92 kB
oss-stable-semver/use-sync-external-store/cjs/use-sync-external-store.development.js +3.96% 6.84 kB 7.11 kB +2.71% 2.84 kB 2.92 kB
oss-stable/use-sync-external-store/cjs/use-sync-external-store.development.js +3.96% 6.84 kB 7.11 kB +2.71% 2.84 kB 2.92 kB

Significant size changes

Includes any change greater than 0.2%:

Expand to show
Name +/- Base Current +/- gzip Base gzip Current gzip
oss-experimental/use-sync-external-store/cjs/use-sync-external-store.development.js +3.96% 6.84 kB 7.11 kB +2.71% 2.84 kB 2.92 kB
oss-stable-semver/use-sync-external-store/cjs/use-sync-external-store.development.js +3.96% 6.84 kB 7.11 kB +2.71% 2.84 kB 2.92 kB
oss-stable/use-sync-external-store/cjs/use-sync-external-store.development.js +3.96% 6.84 kB 7.11 kB +2.71% 2.84 kB 2.92 kB

Generated by 🚫 dangerJS against e6fbd54

@acdlite acdlite merged commit 031abd2 into facebook:main Sep 7, 2021
@salazarm salazarm deleted the test/warningForUseSyncExternalStoreGetSnapshot branch September 7, 2021 16:22
facebook-github-bot pushed a commit to facebook/react-native that referenced this pull request Sep 11, 2021
Summary:
This sync includes the following changes:
- **[95d762e40](facebook/react@95d762e40 )**: Remove duplicate test //<Andrew Clark>//
- **[d4d1dc085](facebook/react@d4d1dc085 )**: Reorder VARIANT feature flags ([#22266](facebook/react#22266)) //<Dan Abramov>//
- **[2f156eafb](facebook/react@2f156eafb )**: Adjust consoleManagedByDevToolsDuringStrictMode feature flag ([#22253](facebook/react#22253)) //<Dan Abramov>//
- **[cfd819332](facebook/react@cfd819332 )**: Add useSyncExternalStore to react-debug-tools ([#22240](facebook/react#22240)) //<Andrew Clark>//
- **[8e80592a3](facebook/react@8e80592a3 )**: Remove state queue from useSyncExternalStore ([#22265](facebook/react#22265)) //<Andrew Clark>//
- **[06f98c168](facebook/react@06f98c168 )**: Implement useSyncExternalStore in Fiber ([#22239](facebook/react#22239)) //<Andrew Clark>//
- **[77912d9a0](facebook/react@77912d9a0 )**: Wire up the native API for useSyncExternalStore ([#22237](facebook/react#22237)) //<Andrew Clark>//
- **[031abd24b](facebook/react@031abd24b )**: Add warning and test for useSyncExternalStore when getSnapshot isn't cached ([#22262](facebook/react#22262)) //<salazarm>//
- **[b8884de24](facebook/react@b8884de24 )**: break up import keyword to avoid being accidentally parsed as dynamic import statement in external code ([#21918](facebook/react#21918)) //<Jianhua Zheng>//
- **[6d6bba5bf](facebook/react@6d6bba5bf )**: Fix typo in ReactUpdatePriority-test.js ([#21958](facebook/react#21958)) //<Ikko Ashimine>//
- **[0c0d1ddae](facebook/react@0c0d1ddae )**: feat(eslint-plugin-react-hooks): support ESLint 8.x ([#22248](facebook/react#22248)) //<Michaël De Boey>//
- **[1314299c7](facebook/react@1314299c7 )**: Initial shim of useSyncExternalStore ([#22211](facebook/react#22211)) //<Andrew Clark>//
- **[fc40f02ad](facebook/react@fc40f02ad )**: Add consoleManagedByDevToolsDuringStrictMode feature flag in React Reconciler ([#22196](facebook/react#22196)) //<Luna Ruan>//
- **[46a0f050a](facebook/react@46a0f050a )**: Set up use-sync-external-store package ([#22202](facebook/react#22202)) //<Andrew Clark>//
- **[8723e772b](facebook/react@8723e772b )**: Fix a string interpolation typo in ReactHooks test ([#22174](facebook/react#22174)) //<Matt Hargett>//
- **[60a30cf32](facebook/react@60a30cf32 )**: Console Logging for StrictMode Double Rendering ([#22030](facebook/react#22030)) //<Luna Ruan>//
- **[76bbad3e3](facebook/react@76bbad3e3 )**: Add maxYieldMs feature flag in Scheduler ([#22165](facebook/react#22165)) //<Ricky>//
- **[b0b53ae2c](facebook/react@b0b53ae2c )**: Add feature flags for scheduler experiments ([#22105](facebook/react#22105)) //<Ricky>//

Changelog:
[General][Changed] - React Native sync for revisions bd5bf55...95d762e

jest_e2e[run_all_tests]

Reviewed By: mdvacca

Differential Revision: D30809906

fbshipit-source-id: 131cfdf91e15f67fa59a5d925467e538ee89fe10
zhengjitf pushed a commit to zhengjitf/react that referenced this pull request Apr 15, 2022
…cached (facebook#22262)

* add warning and test

* Wrap console error in __DEV__ flag

* prettier
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants