Switch back to Subscription in useSelector to fix unsubscribe perf #1870
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
The Subscription impl originally used an array of listeners just like the actual Redux store, but in #1523 we changed it to be a linked list to fix perf issues. The use of `indexOf+splice` caused a quadratic cost to unmounting many components. In v8, I originally dropped use of `Subscription` to potentially save on bundle size. However, `Provider` still uses `Subscription`, so that will always be in the bundle. For this issue, a user pointed out that directly subscribing to the store brought back the original quadratic unsubscription behavior, which I've confirmed locally. Swapping `store.subscribe` for `subscription.addNestedSub` fixes that issue. I've added a unit test that mounts and unmounts a massive tree and measures the elapsed time. There's a distinct difference between the "correct" and quadratic behavior. Weirdly, there's also a big diff in "correct" time between React 18, and 17 + the "compat" entry point, and I have no idea why. It's not as bad as the quadratic time, but it's still pretty expensive. I've written the test to set an acceptable max unmount time based on which React version we're running against, with some buffer added.
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 43d1cc6:
|
|
Size Change: -6 B (0%) Total Size: 21.7 kB
|
1 task
timdorr
reviewed
Feb 5, 2022
Comment on lines
+703
to
+704
| const expectedMaxUnmountTime = IS_REACT_18 ? 500 : 7000 | ||
| expect(elapsedTime).toBeLessThan(expectedMaxUnmountTime) |
There was a problem hiding this comment.
I do worry about the stability of this. This seems like a future case of "works on my machine!" being a false-positive result.
I don't think so based on how things are set up, but would it be possible to compare the React 17 vs 18 times to have an acceptable ratio instead? That would maintain stability between different CPU speeds.
There was a problem hiding this comment.
I don't particularly like it either :) But the "incorrect" times I was seeing were 13.5s for 18 and 23s for 17, and given the number of children being unmounted I see that as a big enough gap that I don't think we're likely to have a false positive due to machine/environment variance.
I do kinda want to investigate why it's slower with React 17 a bit further. But the immediate goal for this test is just to specifically document that "we expect unsubscribing lots of components to not be quadratic" so that we don't forget in the future, and catch that if we were to ever somehow lose that behavior. I think the current test at least accomplishes that.
There was a problem hiding this comment.
Worst case, the test randomly starts failing due to CPU/env stuff, and we change how it works then.
|
Merging now, will put out another v8 beta in a bit. |
github-merge-queue bot
referenced
this pull request
in valora-inc/wallet
Mar 5, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [react-redux](https://togithub.com/reduxjs/react-redux) | [`^7.2.9` -> `^9.1.0`](https://renovatebot.com/diffs/npm/react-redux/7.2.9/9.1.0) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>reduxjs/react-redux (react-redux)</summary> ### [`v9.1.0`](https://togithub.com/reduxjs/react-redux/compare/v9.0.4...v9.1.0) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v9.0.4...v9.1.0) ### [`v9.0.4`](https://togithub.com/reduxjs/react-redux/releases/tag/v9.0.4) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v9.0.3...v9.0.4) This **bugfix release** updates the React Native peer dependency to be `>= 0.69`, to better reflect the need for React 18 compat and (hopefully) resolve issues with the `npm` package manager throwing peer dep errors on install. #### What's Changed - Allow react-native newer than 0.69 as peer dependency by [@​R3DST0RM](https://togithub.com/R3DST0RM) in [https://github.com/reduxjs/react-redux/pull/2107](https://togithub.com/reduxjs/react-redux/pull/2107) **Full Changelog**: reduxjs/react-redux@v9.0.3...v9.0.4 ### [`v9.0.3`](https://togithub.com/reduxjs/react-redux/releases/tag/v9.0.3) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v9.0.2...v9.0.3) This **bugfix release** drops the ReactDOM / React Native specific use of render batching, as React 18 now automatically batches, and updates the React types dependencies #### Changelog ##### Batching Dependency Updates React-Redux has long depended on React's `unstable_batchedUpdates` API to help batch renders queued by Redux updates. It also re-exported that method as a util named `batch`. However, React 18 now auto-batches all queued renders in the same event loop tick, so `unstable_batchedUpdates` is effectively a no-op. Using `unstable_batchedUpdates` has always been a pain point, because it's exported by the renderer package (ReactDOM or React Native), rather than the core `react` package. Our prior implementation relied on having separate `batch.ts` and `batch.native.ts` files in the codebase, and expecting React Native's bundler to find the right transpiled file at app build time. Now that we're pre-bundling artifacts in React-Redux v9, that approach has become a problem. Given that React 18 already batches by default, there's no further need to continue using `unstable_batchedUpdates` internally, so we've removed our use of that and simplified the internals. We still export a `batch` method, but it's effectively a no-op that just immediately runs the given callback, and we've marked it as `@deprecated`. We've also updated the build artifacts and packaging, as there's no longer a need for an `alternate-renderers` entry point that omits batching, or a separate artifact that imports from `"react-native"`. #### What's Changed - Drop renderer-specific batching behavior and deprecate `batch` by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2104](https://togithub.com/reduxjs/react-redux/pull/2104) - Drop `@types/react-dom` and lower `@types/react` to min needed by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2105](https://togithub.com/reduxjs/react-redux/pull/2105) **Full Changelog**: reduxjs/react-redux@v9.0.2...v9.0.3 ### [`v9.0.2`](https://togithub.com/reduxjs/react-redux/releases/tag/v9.0.2) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v9.0.1...v9.0.2) This **bugfix release** makes additional tweaks to the React Native artifact filename to help resolve import and bundling issues with RN projects. #### What's Changed - Change react-native output extension from `.mjs` to `.js` by [@​aryaemami59](https://togithub.com/aryaemami59) in [https://github.com/reduxjs/react-redux/pull/2102](https://togithub.com/reduxjs/react-redux/pull/2102) **Full Changelog**: reduxjs/react-redux@v9.0.1...v9.0.2 ### [`v9.0.1`](https://togithub.com/reduxjs/react-redux/releases/tag/v9.0.1) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v9.0.0...v9.0.1) This **bugfix release** updates the package to include a new `react-redux.react-native.js` bundle that specifically imports React Native, and consolidates all of the `'react'` imports into one file to save on bundle size (and enable some tricky React Native import handling). ##### What's Changed - Add an RN-specific bundle and consolidate imports by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2100](https://togithub.com/reduxjs/react-redux/pull/2100) **Full Changelog**: reduxjs/react-redux@v9.0.0...v9.0.1 ### [`v9.0.0`](https://togithub.com/reduxjs/react-redux/releases/tag/v9.0.0) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.1.3...v9.0.0) This **major release**: - Switches to requiring React 18 and Redux Toolkit 2.0 / Redux 5.0 - Updates the packaging for better ESM/CJS compatibility and modernizes the build output - Updates the options for dev mode checks in `useSelector` - Adds a new React Server Components artifact that throws on use, to better indicate compat issues This release has **breaking changes**. This release is part of a wave of major versions of all the Redux packages: **Redux Toolkit 2.0, Redux core 5.0, React-Redux 9.0, Reselect 5.0, and Redux Thunk 3.0**. For full details on all of the breaking changes and other significant changes to all of those packages, see the **["Migrating to RTK 2.0 and Redux 5.0" migration guide](https://redux.js.org/usage/migrations/migrating-rtk-2)** in the Redux docs. > \[!NOTE] > The Redux core, Reselect, and Redux Thunk packages are included as part of Redux Toolkit, and RTK users do not need to manually upgrade them - you'll get them as part of the upgrade to RTK 2.0. (If you're not using Redux Toolkit yet, [**please start migrating your existing legacy Redux code to use Redux Toolkit today!**](https://redux.js.org/usage/migrating-to-modern-redux)) > React-Redux is a separate, package, but we expect you'll be upgrading them together. ```bash ##### React-Redux npm install react-redux yarn add react-redux ##### RTK npm install @​reduxjs/toolkit yarn add @​reduxjs/toolkit ##### Standalone Redux core npm install redux yarn add redux ``` ##### Changelog ##### React 18 and RTK 2 / Redux core 5 Are Required React-Redux 7.x and 8.x worked with all versions of React that had hooks (16.8+, 17.x, 18.x). However, React-Redux v8 used React 18's new `useSyncExternalStore` hook. In order to maintain backwards compatibility with older React versions, we used the `use-sync-external-store` "shim" package that provided an official userland implementation of the `useSyncExternalStore` hook when used with React 16 or 17. This meant that if you *were* using React 18, there were a few hundred extra bytes of shim code being imported even though it wasn't needed. For React-Redux v9, we're switching so that **React 18 is now *required*!** This both simplifies the maintenance burden on our side (fewer versions of React to test against), and also lets us drop the extra bytes because we can import `useSyncExternalStore` directly. React 18 has been out for a year and a half, and other libraries like React Query are also switching to require React 18 in their next major version. This seems like a reasonable time to make that switch. Similarly, React-Redux now depends on Redux core v5 for updated TS types (but not runtime behavior). We strongly encourage all Redux users to be using Redux Toolkit, which already includes the Redux core. Redux Toolkit 2.0 comes with Redux core 5.0 built in. ##### ESM/CJS Package Compatibility The biggest theme of the Redux v5 and RTK 2.0 releases is trying to get "true" ESM package publishing compatibility in place, while still supporting CJS in the published package. **The primary build artifact is now an ESM file, `dist/react-redux.mjs`**. Most build tools should pick this up. There's also a CJS artifact, and a second copy of the ESM file named `react-redux.legacy-esm.js` to support Webpack 4 (which does not recognize the `exports` field in `package.json`). There's also two special-case artifacts: an "alternate renderers" artifact that should be used for any renderer other than ReactDOM or React Native (such as the `ink` React CLI renderer), and a React Server Components artifact that throws when any import is used (since using hooks or context would error anyway in an RSC environment). Additionally, all of the build artifacts now live under `./dist/` in the published package. Previous releases actually shipped separate individual transpiled source files - the build artifacts are now pre-bundled, same as the rest of the Redux libraries. ##### Modernized Build Output We now publish modern JS syntax targeting ES2020, including optional chaining, object spread, and other modern syntax. If you need to ##### Build Tooling We're now building the package using https://github.com/egoist/tsup. We also now include sourcemaps for the ESM and CJS artifacts. ##### Dropping UMD Builds Redux has always shipped with UMD build artifacts. These are primarily meant for direct import as script tags, such as in a CodePen or a no-bundler build environment. We've dropped those build artifacts from the published package, on the grounds that the use cases seem pretty rare today. There's now a `react-redux.browser.mjs` file in the package that can be loaded from a CDN like Unpkg. If you have strong use cases for us continuing to include UMD build artifacts, please let us know! ##### React Server Components Behavior Per [Mark's post "My Experience Modernizing Packages to ESM"](https://blog.isquaredsoftware.com/2023/08/esm-modernization-lessons/), one of the recent pain points has been [the rollout of React Server Components and the limits the Next.js + React teams have added to RSCs](https://blog.isquaredsoftware.com/2023/08/esm-modernization-lessons/#problems-with-next-js-and-react-server-components). We see many users try to import and use React-Redux APIs in React Server Component files, then get confused why things aren't working right. To address that, we've added a new entry point with a `"react-server"` condition. Every export in that file will throw an error as soon as it's called, to help catch this mistake earlier. ##### Dev Mode Checks Updated In [v8.1.0](https://togithub.com/reduxjs/react-redux/releases/tag/v8.1.0), we updated `useSelector` to accept an options object containing options to check for selectors that always calculate new values, or that always return the root state. We've renamed the `noopCheck` option to `identityFunctionCheck` for clarity. We've also changed the structure of the options object to be: ```ts export type DevModeCheckFrequency = 'never' | 'once' | 'always' export interface UseSelectorOptions<Selected = unknown> { equalityFn?: EqualityFn<Selected> devModeChecks?: { stabilityCheck?: DevModeCheckFrequency identityFunctionCheck?: DevModeCheckFrequency } } ``` ##### `hoist-non-react-statics` and `react-is` Deps Inlined Higher Order Components have been discouraged in the React ecosystem over the last few years. However, we still include the `connect` API. It's now in maintenance mode and not in active development. As described in [the React legacy docs on HOCs](https://legacy.reactjs.org/docs/higher-order-components.html#static-methods-must-be-copied-over), one quirk of HOCs is needing to copy over static methods to the wrapper component. The `hoist-non-react-statics` package has been the standard tool to do that. We've inlined a copy of `hoist-non-react-statics` and removed the package dep, and confirmed that this improves tree-shaking. We've also done the same with the `react-is` package as well, which was also only used by `connect`. This should have no user-facing effects. ##### TypeScript Support We've dropped support for TS 4.6 and earlier, and our support matrix is now TS 4.7+. ##### What's Changed - Update packaging, build config, and entry points for v9 by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2038](https://togithub.com/reduxjs/react-redux/pull/2038) - Add stack to dev mode checks by [@​EskiMojo14](https://togithub.com/EskiMojo14) in [https://github.com/reduxjs/react-redux/pull/2064](https://togithub.com/reduxjs/react-redux/pull/2064) - add an extra entrypoint for React Server Components by [@​phryneas](https://togithub.com/phryneas) in [https://github.com/reduxjs/react-redux/pull/2062](https://togithub.com/reduxjs/react-redux/pull/2062) - Inline hoist-non-react-statics to eliminate a dep and help shaking by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2066](https://togithub.com/reduxjs/react-redux/pull/2066) - Make context typing more accurate by [@​EskiMojo14](https://togithub.com/EskiMojo14) in [https://github.com/reduxjs/react-redux/pull/2041](https://togithub.com/reduxjs/react-redux/pull/2041) - Fix `uSES` imports and run against RTK CI examples by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2070](https://togithub.com/reduxjs/react-redux/pull/2070) - Copy CI setup for RTK examples by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2072](https://togithub.com/reduxjs/react-redux/pull/2072) - Fix useSelector() in combination with lazy loaded components breaks with react v18 ([#​1977](https://togithub.com/reduxjs/react-redux/issues/1977)) by [@​jeroenpx](https://togithub.com/jeroenpx) in [https://github.com/reduxjs/react-redux/pull/2068](https://togithub.com/reduxjs/react-redux/pull/2068) - Actually add `sideEffects: "false"` to `package.json` in v9 by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2079](https://togithub.com/reduxjs/react-redux/pull/2079) - Inline `react-is` utils to fix tree-shaking in 9.0 by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2085](https://togithub.com/reduxjs/react-redux/pull/2085) - Rename `noopCheck` to `identityFunctionCheck` by [@​aryaemami59](https://togithub.com/aryaemami59) in [https://github.com/reduxjs/react-redux/pull/2091](https://togithub.com/reduxjs/react-redux/pull/2091) - Use scoped JSX for React types by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2092](https://togithub.com/reduxjs/react-redux/pull/2092) **Full Changelog**: reduxjs/react-redux@v8.1.2...v9.0.0 ### [`v8.1.3`](https://togithub.com/reduxjs/react-redux/compare/v8.1.2...v8.1.3) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.1.2...v8.1.3) ### [`v8.1.2`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.1.2) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.1.1...v8.1.2) This version changes imports from the React package to namespace imports so the package can safely be imported in React Server Components as long as you don't actually use it - this is for example important if you want to use the React-specifc `createApi` function from Redux Toolkit. Some other changes: - The behaviour of the "React Context Singletons" from 8.1.1 has been adjusted to also work if you have multiple React instances of the same version (those will now be separated) and if you are in an environment without `globalThis` (in this case it will fall back to the previous behaviour). - We do no longer use Proxies, which should help with some very outdated consumers, e.g. smart TVs, that cannot even polyfill Proxies. **Full Changelog**: reduxjs/react-redux@v8.1.1...v8.1.2 ### [`v8.1.1`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.1.1) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.1.0...v8.1.1) This bugfix release tweaks the recent lazy context setup logic to ensure a single React context instance per React version, and removes the recently added RTK peerdep to fix an issue with Yarn workspaces. #### Changelog ##### React Context Singletons React Context has always relied on reference identity. If you have two different copies of React or a library in a page, that can cause multiple versions of a context instance to be created, leading to problems like the infamous "Could not find react-redux context" error. In [v8.1.0](https://togithub.com/reduxjs/react-redux/releases/tag/v8.1.0), we reworked the internals to lazily create our single `ReactReduxContext` instance to avoid issues in a React Server Components environment. This release further tweaks that to stash a single context instance per React version found in the page, thus hopefully avoiding the "multiple copies of the same context" error in the future. #### What's Changed - fix: fix typescript error on non exported type by [@​luzzif](https://togithub.com/luzzif) in [https://github.com/reduxjs/react-redux/pull/2034](https://togithub.com/reduxjs/react-redux/pull/2034) - create singleton context by React version by [@​phryneas](https://togithub.com/phryneas) in [https://github.com/reduxjs/react-redux/pull/2039](https://togithub.com/reduxjs/react-redux/pull/2039) - remove RTK peerDep by [@​markerikson](https://togithub.com/markerikson) in [`44fc725`](https://togithub.com/reduxjs/react-redux/commit/44fc725) **Full Changelog**: reduxjs/react-redux@v8.1.0...v8.1.1 ### [`v8.1.0`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.1.0) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.7...v8.1.0) This **feature release** adds new development-mode safety checks for common errors (like poorly-written selectors), adds a workaround to fix crash errors when React-Redux hooks are imported into React Server Component files, and updates our hooks API docs page with improved explanations and updated links. #### Changelog ##### Development Mode Checks for `useSelector` We've had a number of users tell us over time that it's common to accidentally write selectors that have bad behavior and cause performance issues. The most common causes of this are either selectors that unconditionally return a new reference (such as `state => state.todos.map()` without any memoization ), or selectors that actually return the *entire* root state ( `state => state` ). We've updated `useSelector` to add safety checks in development mode that warn if these incorrect behaviors are detected: - Selectors will be called twice with the same inputs, and `useSelector` will warn if the results are different references - `useSelector` will warn if the selector result is actually the entire root `state` By default, **these checks only run *once* the first time `useSelector` is called**. This should provide a good balance between detecting possible issues, and keeping development mode execution performant without adding many unnecessary extra selector calls. If you want, you can configure this behavior globally by passing the enum flags directly to `<Provider>`, or on a per-`useSelector` basis by passing an options object as the second argument: ```ts // Example: globally configure the root state "noop" check to run every time <Provider store={store} noopCheck="always"> {children} </Provider> ``` ```ts // Example: configure `useSelector` to specifically run the reference checks differently: function Component() { // Disable check entirely for this selector const count = useSelector(selectCount, { stabilityCheck: 'never' }) // run once (default) const user = useSelector(selectUser, { stabilityCheck: 'once' }) // ... } ``` This goes along with the similar safety checks we've added to [Reselect v5 alpha](https://togithub.com/reduxjs/reselect/releases/tag/v5.0.0-alpha.2) as well. ##### Context Changes We're still trying to work out how to properly use Redux and React Server Components together. One possibility is using RTK Query's `createApi` to define data fetching endpoints, and using the generated thunks to fetch data in RSCs, but it's still an open question. However, users have reported that merely importing *any* React-Redux API in an RSC file causes a crash, because `React.createContext` is not defined in RSC files. RTKQ's React-specific `createApi` entry point imports React-Redux, so it's been unusable in RSCs. This release adds a workaround to fix that issue, by using a proxy wrapper around our singleton `ReactReduxContext` instance and lazily creating that instance on demand. In testing, this appears to both continue to work in all unit tests, *and* fixes the import error in an RSC environment. We'd appreciate further feedback in case this change does cause any issues for anyone! We've also tweaked the internals of the hooks to do checks for correct `<Provider>` usage when using a custom context, same as the default context checks. ##### Docs Updates We've cleaned up some of the Hooks API reference page, and updated links to the React docs. #### What's Changed - check for Provider even when using custom context by [@​EskiMojo14](https://togithub.com/EskiMojo14) in [https://github.com/reduxjs/react-redux/pull/1990](https://togithub.com/reduxjs/react-redux/pull/1990) - Add a stability check, to see if selector returns stable result when called with same parameters. by [@​EskiMojo14](https://togithub.com/EskiMojo14) in [https://github.com/reduxjs/react-redux/pull/2000](https://togithub.com/reduxjs/react-redux/pull/2000) - Add an E2E-ish test that verifies behavior when imported into RSCs by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2030](https://togithub.com/reduxjs/react-redux/pull/2030) - lazily create Context for RSC compat by [@​phryneas](https://togithub.com/phryneas) in [https://github.com/reduxjs/react-redux/pull/2025](https://togithub.com/reduxjs/react-redux/pull/2025) - Add warning for selectors that return the entire state by [@​EskiMojo14](https://togithub.com/EskiMojo14) in [https://github.com/reduxjs/react-redux/pull/2022](https://togithub.com/reduxjs/react-redux/pull/2022) **Full Changelog**: reduxjs/react-redux@v8.0.7...v8.1.0 ### [`v8.0.7`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.7) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.6...v8.0.7) This release updates the peer dependencies to accept Redux Toolkit, and accept the ongoing RTK and Redux core betas as valid peer deps. > **Note**: These changes were initially in 8.0.6, but that had a typo in the peer deps that broke installation. Sorry! #### What's Changed - Bump Redux peer deps to accept 5.0 betas, and bump RTK dev dep by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2017](https://togithub.com/reduxjs/react-redux/pull/2017) - [`d45204f`](https://togithub.com/reduxjs/react-redux/commit/d45204f) : Fix broken RTK peer dep **Full Changelog**: reduxjs/react-redux@v8.0.5...v8.0.7 ### [`v8.0.6`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.6) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.5...v8.0.6) \~~This release updates the peer dependencies to accept Redux Toolkit, and accept the ongoing RTK and Redux core betas as valid peer deps.~~ **This release has a peer deps typo that breaks installation - please use 8.0.7 instead !** #### What's Changed - Bump Redux peer deps to accept 5.0 betas, and bump RTK dev dep by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2017](https://togithub.com/reduxjs/react-redux/pull/2017) **Full Changelog**: reduxjs/react-redux@v8.0.5...v8.0.6 ### [`v8.0.5`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.5) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.4...v8.0.5) This release fixes a few minor TS issues. #### What's Changed - `Provider`: pass state (`S`) generic through to `ProviderProps` by [@​OliverJAsh](https://togithub.com/OliverJAsh) in [https://github.com/reduxjs/react-redux/pull/1960](https://togithub.com/reduxjs/react-redux/pull/1960) - wrap `equalityFn` type in `NoInfer` by [@​phryneas](https://togithub.com/phryneas) in [https://github.com/reduxjs/react-redux/pull/1965](https://togithub.com/reduxjs/react-redux/pull/1965) - Fix wrapped component prop types when passing nullish mapDispatchToProps by [@​marconi1992](https://togithub.com/marconi1992) in [https://github.com/reduxjs/react-redux/pull/1928](https://togithub.com/reduxjs/react-redux/pull/1928) **Full Changelog**: reduxjs/react-redux@v8.0.4...v8.0.5 ### [`v8.0.4`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.4) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.3...v8.0.4) This patch release fixes some minor TS types issues, and updates the rarely-used `areStatesEqual` option for `connect` to now pass through `ownProps` for additional use in determining which pieces of state to compare if desired. > **Note**: 8.0.3 was accidentally published without one of these fixes. Use 8.0.4 instead. #### Changelog ##### TS Fixes We've fixed an import of `React` that caused issues with the `allowSyntheticDefaultImports` TS compiler flag in user projects. `connect` already accepted a custom context instance as `props.context`, and had runtime checks in case users were passing through a real value with app data as `props.context` instead. However, the TS types did not handle that case, and this would fail to compile. If your own component expects `props.context` with actual data, `connect`'s types now use that type instead. The `ConnectedProps<T>` type had a mismatch with React's built-in `React.ComponentProps<Component>` type, and that should now work correctly. ##### Other Changes The `areStatesEqual` option to `connect` now receives `ownProps` as well, in case you need to make a more specific comparison with certain sections of state. The new signature is: ```ts { areStatesEqual?: ( nextState: State, prevState: State, nextOwnProps: TOwnProps, prevOwnProps: TOwnProps ) => boolean } ``` #### What's Changed - Don't require allowSyntheticDefaultImports: true by [@​apepper](https://togithub.com/apepper) in [https://github.com/reduxjs/react-redux/pull/1924](https://togithub.com/reduxjs/react-redux/pull/1924) - Fixed type issue with `ComponentProps` from older `@types/react` by [@​Andarist](https://togithub.com/Andarist) in [https://github.com/reduxjs/react-redux/pull/1956](https://togithub.com/reduxjs/react-redux/pull/1956) - connect: pass ownProps to areStatesEqual by [@​jspurlin](https://togithub.com/jspurlin) in [https://github.com/reduxjs/react-redux/pull/1951](https://togithub.com/reduxjs/react-redux/pull/1951) - Omit built-in context prop if user component props include context by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1958](https://togithub.com/reduxjs/react-redux/pull/1958) **Full Changelog**: reduxjs/react-redux@v8.0.2...v8.0.4 ### [`v8.0.3`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.3) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.2...v8.0.3) **This release was accidentally published without an intended fix - please use [v8.0.4](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.4) instead** ### [`v8.0.2`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.2) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.1...v8.0.2) This patch release tweaks the behavior of `connect` to print a one-time warning when the obsolete `pure` option is passed in, rather than throwing an error. This fixes crashes caused by libraries such as `react-beautiful-dnd` continuing to pass in that option (unnecessarily) to React-Redux v8. #### What's Changed - Show warning instead of throwing error that pure option has been removed by [@​ApacheEx](https://togithub.com/ApacheEx) in [https://github.com/reduxjs/react-redux/pull/1922](https://togithub.com/reduxjs/react-redux/pull/1922) **Full Changelog**: reduxjs/react-redux@v8.0.1...v8.0.2 ### [`v8.0.1`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.1) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.0...v8.0.1) This release fixes an incorrect internal import of our `Subscription` type, which was causing TS compilation errors in some user projects. We've also listed `@types/react-dom` as an optional peerDep. There are no runtime changes in this release. #### What's Changed - Add optional peer dependency on [@​types/react-dom](https://togithub.com/types/react-dom) by [@​Methuselah96](https://togithub.com/Methuselah96) in [https://github.com/reduxjs/react-redux/pull/1904](https://togithub.com/reduxjs/react-redux/pull/1904) - fix(ts): incorrect import of `Subscription` causes `noImplicitAny` error by [@​vicrep](https://togithub.com/vicrep) in [https://github.com/reduxjs/react-redux/pull/1910](https://togithub.com/reduxjs/react-redux/pull/1910) **Full Changelog**: reduxjs/react-redux@v8.0.0...v8.0.1 ### [`v8.0.0`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.0) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v7.2.9...v8.0.0) This **major version** release updates `useSelector`, `connect`, and `<Provider>` for compatibility with React 18, rewrites the React-Redux codebase to TypeScript (obsoleting use of `@types/react-redux`), modernizes build output, and removes the deprecated `connectAdvanced` API and the `pure` option for `connect`. npm i react-redux@latest yarn add react-redux@latest #### Overview, Compatibility, and Migration Our public API is still the same ( `<Provider>`, `connect` and `useSelector/useDispatch`), but we've updated the internals to use the new `useSyncExternalStore` hook from React. React-Redux v8 is still compatible with all versions of React that have hooks (16.8+, 17.x, and 18.x; React Native 0.59+), and *should* just work out of the box. In most cases, it's very likely that the only change you will need to make is bumping the package version to `"react-redux": "^8.0"`. *If* you are using the rarely-used `connectAdvanced` API, you will need to rewrite your code to avoid that, likely by using the hooks API instead. Similarly, the `pure` option for `connect` has been removed. If you are using Typescript, React-Redux is now written in TS and includes its own types. You should remove any dependencies on `@types/react-redux`. While not directly tied to React-Redux, note that **the recently updated `@types/react@18` major version has changed component definitions to remove having `children` as a prop by default**. This causes errors if you have multiple copies of `@types/react` in your project. To fix this, tell your package manager to resolve `@types/react` to a single version. Details: [**React issue #​24304: React 18 types broken since release**](https://togithub.com/facebook/react/issues/24304#issuecomment-1094565891) Additionally, please see the React post on [**How to Ugprade to React 18**](https://reactjs.org/blog/2022/03/08/react-18-upgrade-guide.html) for details on how to migrate existing apps to correctly use React 18 and take advantage of its new features. #### Changelog ##### React 18 Compatibility React-Redux now requires the new [`useSyncExternalStore` API in React 18](https://togithub.com/reactwg/react-18/discussions/86). By default, it uses the "shim" package which backfills that API in earlier React versions, so **React-Redux v8 is compatible with all React versions that have hooks** (16.8+, and React Native 0.59+) as its acceptable peer dependencies. We'd especially like to thank the React team for their extensive support and cooperation during the `useSyncExternalStore` development effort. They specifically designed `useSyncExternalStore` to support the needs and use cases of React-Redux, and we used React-Redux v8 as a testbed for how `useSyncExternalStore` would behave and what it needed to cover. This in turn helped ensure that `useSyncExternalStore` would be useful and work correctly for other libraries in the ecosystem as well. Our performance benchmarks show parity with React-Redux v7.2.5 for both `connect` and `useSelector`, so we do not anticipate any meaningful performance regressions. ##### `useSyncExternalStore` and Bundling The `useSyncExternalStore` shim is imported directly in the main entry point, so it's *always* included in bundles even if you're using React 18. This adds roughly 600 bytes minified to your bundle size. If you are using React 18 and would like to avoid that extra bundle cost, React-Redux now has a new `/next` entry point. This exports the exact same APIs, but directly imports `useSyncExternalStore` from React itself, and thus avoids including the shim. You can alias `"react-redux": "react-redux/next"` in your bundler to use that instead. ##### SSR and Hydration React 18 introduces a new `hydrateRoot` method for hydrating the UI on the client in Server-Side Rendering usage. As part of that, the `useSyncExternalStore` API requires that we pass in an alternate state value other than what's in the actual Redux store, and that alternate value will be used for the entire initial hydration render to ensure the initial rehydrated UI is an exact match for what was rendered on the server. After the hydration render is complete, React will then apply any additional changes from the store state in a follow-up render. React-Redux v8 supports this by adding a new `serverState` prop for `<Provider>`. If you're using SSR, you should pass your serialized state to `<Provider>` to ensure there are no hydration mismatch errors: ```ts import { hydrateRoot } from 'react-dom/client' import { configureStore } from '@​reduxjs/toolkit' import { Provider } from 'react-redux' const preloadedState = window.__PRELOADED_STATE__ const clientStore = configureStore({ reducer: rootReducer, preloadedState, }) hydrateRoot( document.getElementById('root'), <Provider store={clientStore} serverState={preloadedState}> <App /> </Provider> ) ``` ##### TypeScript Migration and Support The React-Redux library source has always been written in plain JS, and the community maintained the TS typings separately as `@types/react-redux`. We've (finally!) [migrated the React-Redux codebase to TypeScript](https://togithub.com/reduxjs/react-redux/issues/1737), using the existing typings as a starting point. This means that **the `@types/react-redux` package is no longer needed, and you should remove that as a dependency**. > **Note** Please ensure that any installed copies of `redux` and `@types/react` are de-duped. You are also encouraged to update to the latest versions of Redux Toolkit (1.8.1+) or Redux (4.1.2), to ensure consistency between installed types and avoid problems from types mismatches. We've tried to maintain the same external type signatures as much as possible. If you do see any compile problems, please file issues with any apparent TS-related problems so we can review them. The TS migration was a great collaborative effort, with many community members contributing migrated files. Thank you to everyone who helped out! In addition to the "pre-typed" `TypedUseSelectorHook`, there's now also a `Connect<State = unknown>` type that can be used as a "pre-typed" version of `connect` as well. As part of the process, we also updated the repo to use Yarn 3, copied the typetests files from DefinitelyTyped and expanded them, and improved our CI setup to test against multiple TS versions. ##### Removal of the `DefaultRootState` type The `@types/react-redux` package, which has always been maintained by the community, included a `DefaultRootState` interface that was intended for use with TS's "module augmentation" capability. Both `connect` and `useSelector` used this as a fallback if no state generic was provided. When we migrated React-Redux to TS, we copied over all of the types from that package as a starting point. However, the Redux team [specifically considers use of a globally augmented state type to be an anti-pattern](https://togithub.com/reduxjs/react-redux/issues/1879). Instead, we direct users to [extract the `RootState` and `AppDispatch` types from the store setup](https://redux.js.org/tutorials/typescript-quick-start#define-root-state-and-dispatch-types), and [create pre-typed versions of the React-Redux hooks](https://redux.js.org/tutorials/typescript-quick-start#define-typed-hooks) for use in the app. Now that React-Redux itself is written in TS, we've opted to remove the `DefaultRootState` type entirely. State generics now default to `unknown` instead. Technically [the module augmentation approach can still be done in userland](https://togithub.com/reduxjs/react-redux/issues/1879#issuecomment-1073284804), but we discourage this practice. ##### Modernized Build Output We've always targeted ES5 syntax in our published build artifacts as the lowest common denominator. Even the "ES module" artifacts with `import/export` keywords still were compiled to ES5 syntax otherwise. With IE11 now effectively dead and many sites no longer supporting it, we've updated our build tooling to target a more modern syntax equivalent to ES2017, which shrinks the bundle size slightly. If you still need to support ES5-only environments, please compile your own dependencies as needed for your target environment. ##### Removal of Legacy APIs We announced in 2019 that [the legacy `connectAdvanced` API would be removed in the next major version](https://togithub.com/reduxjs/react-redux/issues/1236), as it was rarely used, added internal complexity, and was also basically irrelevant with the introduction of hooks. As promised, we've removed that API. We've also removed the `pure` option for `connect`, which forced components to re-render regardless of whether props/state had actually changed if it was set to `false`. This option was needed in some cases in the early days of the React ecosystem, when components sometimes relied on external mutable data sources that could change outside of rendering. Today, no one writes components that way, the option was barely used, and React 18's `useSyncExternalStore` strictly requires immutable updates. So, we've removed the `pure` flag. Given that both of these options were almost never used, this shouldn't meaningfully affect anyone. #### Changes Due to the TS migration effort and number of contributors, this list covers just the major changes: - Integrate TypeScript port by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1739](https://togithub.com/reduxjs/react-redux/pull/1739) - Initial experimental React 18 compat prototyping by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1808](https://togithub.com/reduxjs/react-redux/pull/1808) - Fix compatibility with React 18 strict effects by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1817](https://togithub.com/reduxjs/react-redux/pull/1817) - Update to latest React 18 alpha dependencies by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1834](https://togithub.com/reduxjs/react-redux/pull/1834) - Port remaining v7 typetests and improve v8 types by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1855](https://togithub.com/reduxjs/react-redux/pull/1855) - Add initial SSR support for React 18 and React-Redux v8 by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1835](https://togithub.com/reduxjs/react-redux/pull/1835) - test: Adjust type tests to be compatible with React 18 typings by [@​eps1lon](https://togithub.com/eps1lon) in [https://github.com/reduxjs/react-redux/pull/1868](https://togithub.com/reduxjs/react-redux/pull/1868) - Switch back to Subscription in useSelector to fix unsubscribe perf by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1870](https://togithub.com/reduxjs/react-redux/pull/1870) - Cleanup more code after `pure` removal by [@​Andarist](https://togithub.com/Andarist) in [https://github.com/reduxjs/react-redux/pull/1859](https://togithub.com/reduxjs/react-redux/pull/1859) - Swap `useSyncExternalStore` shim behavior and update React deps by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1884](https://togithub.com/reduxjs/react-redux/pull/1884) - Remove `DefaultRootState` type by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1887](https://togithub.com/reduxjs/react-redux/pull/1887) - Add SSR test for `serverState` behavior by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1888](https://togithub.com/reduxjs/react-redux/pull/1888) - Cleanup internal types in selectorFactory.ts by [@​Methuselah96](https://togithub.com/Methuselah96) in [https://github.com/reduxjs/react-redux/pull/1889](https://togithub.com/reduxjs/react-redux/pull/1889) - Remove ts-ignore for initMergeProps by [@​Methuselah96](https://togithub.com/Methuselah96) in [https://github.com/reduxjs/react-redux/pull/1891](https://togithub.com/reduxjs/react-redux/pull/1891) - fix(deps): add optional peer deps into `peerDependencies` by [@​kyletsang](https://togithub.com/kyletsang) in [https://github.com/reduxjs/react-redux/pull/1893](https://togithub.com/reduxjs/react-redux/pull/1893) - Update peer deps for v8 by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1895](https://togithub.com/reduxjs/react-redux/pull/1895) - Port DT fix for `dispatchProp` arg in `mergeProps` by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1897](https://togithub.com/reduxjs/react-redux/pull/1897) - Update docs for v8 final by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1902](https://togithub.com/reduxjs/react-redux/pull/1902) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 5pm,every weekend" in timezone America/Los_Angeles, Automerge - "after 5pm,every weekend" in timezone America/Los_Angeles. 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/valora-inc/wallet). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yMjAuMiIsInVwZGF0ZWRJblZlciI6IjM3LjIyMC4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Jean Regisser <[email protected]>
shottah
referenced
this pull request
in zed-io/kolektivo
May 15, 2024
](https://renovatebot.com){kind=link}
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [react-redux](https://togithub.com/reduxjs/react-redux) | [`^7.2.9` -> `^9.1.0`](https://renovatebot.com/diffs/npm/react-redux/7.2.9/9.1.0) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>reduxjs/react-redux (react-redux)</summary> ### [`v9.1.0`](https://togithub.com/reduxjs/react-redux/compare/v9.0.4...v9.1.0) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v9.0.4...v9.1.0) ### [`v9.0.4`](https://togithub.com/reduxjs/react-redux/releases/tag/v9.0.4) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v9.0.3...v9.0.4) This **bugfix release** updates the React Native peer dependency to be `>= 0.69`, to better reflect the need for React 18 compat and (hopefully) resolve issues with the `npm` package manager throwing peer dep errors on install. #### What's Changed - Allow react-native newer than 0.69 as peer dependency by [@​R3DST0RM](https://togithub.com/R3DST0RM) in [https://github.com/reduxjs/react-redux/pull/2107](https://togithub.com/reduxjs/react-redux/pull/2107) **Full Changelog**: reduxjs/react-redux@v9.0.3...v9.0.4 ### [`v9.0.3`](https://togithub.com/reduxjs/react-redux/releases/tag/v9.0.3) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v9.0.2...v9.0.3) This **bugfix release** drops the ReactDOM / React Native specific use of render batching, as React 18 now automatically batches, and updates the React types dependencies #### Changelog ##### Batching Dependency Updates React-Redux has long depended on React's `unstable_batchedUpdates` API to help batch renders queued by Redux updates. It also re-exported that method as a util named `batch`. However, React 18 now auto-batches all queued renders in the same event loop tick, so `unstable_batchedUpdates` is effectively a no-op. Using `unstable_batchedUpdates` has always been a pain point, because it's exported by the renderer package (ReactDOM or React Native), rather than the core `react` package. Our prior implementation relied on having separate `batch.ts` and `batch.native.ts` files in the codebase, and expecting React Native's bundler to find the right transpiled file at app build time. Now that we're pre-bundling artifacts in React-Redux v9, that approach has become a problem. Given that React 18 already batches by default, there's no further need to continue using `unstable_batchedUpdates` internally, so we've removed our use of that and simplified the internals. We still export a `batch` method, but it's effectively a no-op that just immediately runs the given callback, and we've marked it as `@deprecated`. We've also updated the build artifacts and packaging, as there's no longer a need for an `alternate-renderers` entry point that omits batching, or a separate artifact that imports from `"react-native"`. #### What's Changed - Drop renderer-specific batching behavior and deprecate `batch` by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2104](https://togithub.com/reduxjs/react-redux/pull/2104) - Drop `@types/react-dom` and lower `@types/react` to min needed by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2105](https://togithub.com/reduxjs/react-redux/pull/2105) **Full Changelog**: reduxjs/react-redux@v9.0.2...v9.0.3 ### [`v9.0.2`](https://togithub.com/reduxjs/react-redux/releases/tag/v9.0.2) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v9.0.1...v9.0.2) This **bugfix release** makes additional tweaks to the React Native artifact filename to help resolve import and bundling issues with RN projects. #### What's Changed - Change react-native output extension from `.mjs` to `.js` by [@​aryaemami59](https://togithub.com/aryaemami59) in [https://github.com/reduxjs/react-redux/pull/2102](https://togithub.com/reduxjs/react-redux/pull/2102) **Full Changelog**: reduxjs/react-redux@v9.0.1...v9.0.2 ### [`v9.0.1`](https://togithub.com/reduxjs/react-redux/releases/tag/v9.0.1) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v9.0.0...v9.0.1) This **bugfix release** updates the package to include a new `react-redux.react-native.js` bundle that specifically imports React Native, and consolidates all of the `'react'` imports into one file to save on bundle size (and enable some tricky React Native import handling). ##### What's Changed - Add an RN-specific bundle and consolidate imports by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2100](https://togithub.com/reduxjs/react-redux/pull/2100) **Full Changelog**: reduxjs/react-redux@v9.0.0...v9.0.1 ### [`v9.0.0`](https://togithub.com/reduxjs/react-redux/releases/tag/v9.0.0) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.1.3...v9.0.0) This **major release**: - Switches to requiring React 18 and Redux Toolkit 2.0 / Redux 5.0 - Updates the packaging for better ESM/CJS compatibility and modernizes the build output - Updates the options for dev mode checks in `useSelector` - Adds a new React Server Components artifact that throws on use, to better indicate compat issues This release has **breaking changes**. This release is part of a wave of major versions of all the Redux packages: **Redux Toolkit 2.0, Redux core 5.0, React-Redux 9.0, Reselect 5.0, and Redux Thunk 3.0**. For full details on all of the breaking changes and other significant changes to all of those packages, see the **["Migrating to RTK 2.0 and Redux 5.0" migration guide](https://redux.js.org/usage/migrations/migrating-rtk-2)** in the Redux docs. > \[!NOTE] > The Redux core, Reselect, and Redux Thunk packages are included as part of Redux Toolkit, and RTK users do not need to manually upgrade them - you'll get them as part of the upgrade to RTK 2.0. (If you're not using Redux Toolkit yet, [**please start migrating your existing legacy Redux code to use Redux Toolkit today!**](https://redux.js.org/usage/migrating-to-modern-redux)) > React-Redux is a separate, package, but we expect you'll be upgrading them together. ```bash ##### React-Redux npm install react-redux yarn add react-redux ##### RTK npm install @​reduxjs/toolkit yarn add @​reduxjs/toolkit ##### Standalone Redux core npm install redux yarn add redux ``` ##### Changelog ##### React 18 and RTK 2 / Redux core 5 Are Required React-Redux 7.x and 8.x worked with all versions of React that had hooks (16.8+, 17.x, 18.x). However, React-Redux v8 used React 18's new `useSyncExternalStore` hook. In order to maintain backwards compatibility with older React versions, we used the `use-sync-external-store` "shim" package that provided an official userland implementation of the `useSyncExternalStore` hook when used with React 16 or 17. This meant that if you *were* using React 18, there were a few hundred extra bytes of shim code being imported even though it wasn't needed. For React-Redux v9, we're switching so that **React 18 is now *required*!** This both simplifies the maintenance burden on our side (fewer versions of React to test against), and also lets us drop the extra bytes because we can import `useSyncExternalStore` directly. React 18 has been out for a year and a half, and other libraries like React Query are also switching to require React 18 in their next major version. This seems like a reasonable time to make that switch. Similarly, React-Redux now depends on Redux core v5 for updated TS types (but not runtime behavior). We strongly encourage all Redux users to be using Redux Toolkit, which already includes the Redux core. Redux Toolkit 2.0 comes with Redux core 5.0 built in. ##### ESM/CJS Package Compatibility The biggest theme of the Redux v5 and RTK 2.0 releases is trying to get "true" ESM package publishing compatibility in place, while still supporting CJS in the published package. **The primary build artifact is now an ESM file, `dist/react-redux.mjs`**. Most build tools should pick this up. There's also a CJS artifact, and a second copy of the ESM file named `react-redux.legacy-esm.js` to support Webpack 4 (which does not recognize the `exports` field in `package.json`). There's also two special-case artifacts: an "alternate renderers" artifact that should be used for any renderer other than ReactDOM or React Native (such as the `ink` React CLI renderer), and a React Server Components artifact that throws when any import is used (since using hooks or context would error anyway in an RSC environment). Additionally, all of the build artifacts now live under `./dist/` in the published package. Previous releases actually shipped separate individual transpiled source files - the build artifacts are now pre-bundled, same as the rest of the Redux libraries. ##### Modernized Build Output We now publish modern JS syntax targeting ES2020, including optional chaining, object spread, and other modern syntax. If you need to ##### Build Tooling We're now building the package using https://github.com/egoist/tsup. We also now include sourcemaps for the ESM and CJS artifacts. ##### Dropping UMD Builds Redux has always shipped with UMD build artifacts. These are primarily meant for direct import as script tags, such as in a CodePen or a no-bundler build environment. We've dropped those build artifacts from the published package, on the grounds that the use cases seem pretty rare today. There's now a `react-redux.browser.mjs` file in the package that can be loaded from a CDN like Unpkg. If you have strong use cases for us continuing to include UMD build artifacts, please let us know! ##### React Server Components Behavior Per [Mark's post "My Experience Modernizing Packages to ESM"](https://blog.isquaredsoftware.com/2023/08/esm-modernization-lessons/), one of the recent pain points has been [the rollout of React Server Components and the limits the Next.js + React teams have added to RSCs](https://blog.isquaredsoftware.com/2023/08/esm-modernization-lessons/#problems-with-next-js-and-react-server-components). We see many users try to import and use React-Redux APIs in React Server Component files, then get confused why things aren't working right. To address that, we've added a new entry point with a `"react-server"` condition. Every export in that file will throw an error as soon as it's called, to help catch this mistake earlier. ##### Dev Mode Checks Updated In [v8.1.0](https://togithub.com/reduxjs/react-redux/releases/tag/v8.1.0), we updated `useSelector` to accept an options object containing options to check for selectors that always calculate new values, or that always return the root state. We've renamed the `noopCheck` option to `identityFunctionCheck` for clarity. We've also changed the structure of the options object to be: ```ts export type DevModeCheckFrequency = 'never' | 'once' | 'always' export interface UseSelectorOptions<Selected = unknown> { equalityFn?: EqualityFn<Selected> devModeChecks?: { stabilityCheck?: DevModeCheckFrequency identityFunctionCheck?: DevModeCheckFrequency } } ``` ##### `hoist-non-react-statics` and `react-is` Deps Inlined Higher Order Components have been discouraged in the React ecosystem over the last few years. However, we still include the `connect` API. It's now in maintenance mode and not in active development. As described in [the React legacy docs on HOCs](https://legacy.reactjs.org/docs/higher-order-components.html#static-methods-must-be-copied-over), one quirk of HOCs is needing to copy over static methods to the wrapper component. The `hoist-non-react-statics` package has been the standard tool to do that. We've inlined a copy of `hoist-non-react-statics` and removed the package dep, and confirmed that this improves tree-shaking. We've also done the same with the `react-is` package as well, which was also only used by `connect`. This should have no user-facing effects. ##### TypeScript Support We've dropped support for TS 4.6 and earlier, and our support matrix is now TS 4.7+. ##### What's Changed - Update packaging, build config, and entry points for v9 by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2038](https://togithub.com/reduxjs/react-redux/pull/2038) - Add stack to dev mode checks by [@​EskiMojo14](https://togithub.com/EskiMojo14) in [https://github.com/reduxjs/react-redux/pull/2064](https://togithub.com/reduxjs/react-redux/pull/2064) - add an extra entrypoint for React Server Components by [@​phryneas](https://togithub.com/phryneas) in [https://github.com/reduxjs/react-redux/pull/2062](https://togithub.com/reduxjs/react-redux/pull/2062) - Inline hoist-non-react-statics to eliminate a dep and help shaking by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2066](https://togithub.com/reduxjs/react-redux/pull/2066) - Make context typing more accurate by [@​EskiMojo14](https://togithub.com/EskiMojo14) in [https://github.com/reduxjs/react-redux/pull/2041](https://togithub.com/reduxjs/react-redux/pull/2041) - Fix `uSES` imports and run against RTK CI examples by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2070](https://togithub.com/reduxjs/react-redux/pull/2070) - Copy CI setup for RTK examples by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2072](https://togithub.com/reduxjs/react-redux/pull/2072) - Fix useSelector() in combination with lazy loaded components breaks with react v18 ([#​1977](https://togithub.com/reduxjs/react-redux/issues/1977)) by [@​jeroenpx](https://togithub.com/jeroenpx) in [https://github.com/reduxjs/react-redux/pull/2068](https://togithub.com/reduxjs/react-redux/pull/2068) - Actually add `sideEffects: "false"` to `package.json` in v9 by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2079](https://togithub.com/reduxjs/react-redux/pull/2079) - Inline `react-is` utils to fix tree-shaking in 9.0 by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2085](https://togithub.com/reduxjs/react-redux/pull/2085) - Rename `noopCheck` to `identityFunctionCheck` by [@​aryaemami59](https://togithub.com/aryaemami59) in [https://github.com/reduxjs/react-redux/pull/2091](https://togithub.com/reduxjs/react-redux/pull/2091) - Use scoped JSX for React types by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2092](https://togithub.com/reduxjs/react-redux/pull/2092) **Full Changelog**: reduxjs/react-redux@v8.1.2...v9.0.0 ### [`v8.1.3`](https://togithub.com/reduxjs/react-redux/compare/v8.1.2...v8.1.3) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.1.2...v8.1.3) ### [`v8.1.2`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.1.2) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.1.1...v8.1.2) This version changes imports from the React package to namespace imports so the package can safely be imported in React Server Components as long as you don't actually use it - this is for example important if you want to use the React-specifc `createApi` function from Redux Toolkit. Some other changes: - The behaviour of the "React Context Singletons" from 8.1.1 has been adjusted to also work if you have multiple React instances of the same version (those will now be separated) and if you are in an environment without `globalThis` (in this case it will fall back to the previous behaviour). - We do no longer use Proxies, which should help with some very outdated consumers, e.g. smart TVs, that cannot even polyfill Proxies. **Full Changelog**: reduxjs/react-redux@v8.1.1...v8.1.2 ### [`v8.1.1`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.1.1) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.1.0...v8.1.1) This bugfix release tweaks the recent lazy context setup logic to ensure a single React context instance per React version, and removes the recently added RTK peerdep to fix an issue with Yarn workspaces. #### Changelog ##### React Context Singletons React Context has always relied on reference identity. If you have two different copies of React or a library in a page, that can cause multiple versions of a context instance to be created, leading to problems like the infamous "Could not find react-redux context" error. In [v8.1.0](https://togithub.com/reduxjs/react-redux/releases/tag/v8.1.0), we reworked the internals to lazily create our single `ReactReduxContext` instance to avoid issues in a React Server Components environment. This release further tweaks that to stash a single context instance per React version found in the page, thus hopefully avoiding the "multiple copies of the same context" error in the future. #### What's Changed - fix: fix typescript error on non exported type by [@​luzzif](https://togithub.com/luzzif) in [https://github.com/reduxjs/react-redux/pull/2034](https://togithub.com/reduxjs/react-redux/pull/2034) - create singleton context by React version by [@​phryneas](https://togithub.com/phryneas) in [https://github.com/reduxjs/react-redux/pull/2039](https://togithub.com/reduxjs/react-redux/pull/2039) - remove RTK peerDep by [@​markerikson](https://togithub.com/markerikson) in [`44fc725`](https://togithub.com/reduxjs/react-redux/commit/44fc725) **Full Changelog**: reduxjs/react-redux@v8.1.0...v8.1.1 ### [`v8.1.0`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.1.0) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.7...v8.1.0) This **feature release** adds new development-mode safety checks for common errors (like poorly-written selectors), adds a workaround to fix crash errors when React-Redux hooks are imported into React Server Component files, and updates our hooks API docs page with improved explanations and updated links. #### Changelog ##### Development Mode Checks for `useSelector` We've had a number of users tell us over time that it's common to accidentally write selectors that have bad behavior and cause performance issues. The most common causes of this are either selectors that unconditionally return a new reference (such as `state => state.todos.map()` without any memoization ), or selectors that actually return the *entire* root state ( `state => state` ). We've updated `useSelector` to add safety checks in development mode that warn if these incorrect behaviors are detected: - Selectors will be called twice with the same inputs, and `useSelector` will warn if the results are different references - `useSelector` will warn if the selector result is actually the entire root `state` By default, **these checks only run *once* the first time `useSelector` is called**. This should provide a good balance between detecting possible issues, and keeping development mode execution performant without adding many unnecessary extra selector calls. If you want, you can configure this behavior globally by passing the enum flags directly to `<Provider>`, or on a per-`useSelector` basis by passing an options object as the second argument: ```ts // Example: globally configure the root state "noop" check to run every time <Provider store={store} noopCheck="always"> {children} </Provider> ``` ```ts // Example: configure `useSelector` to specifically run the reference checks differently: function Component() { // Disable check entirely for this selector const count = useSelector(selectCount, { stabilityCheck: 'never' }) // run once (default) const user = useSelector(selectUser, { stabilityCheck: 'once' }) // ... } ``` This goes along with the similar safety checks we've added to [Reselect v5 alpha](https://togithub.com/reduxjs/reselect/releases/tag/v5.0.0-alpha.2) as well. ##### Context Changes We're still trying to work out how to properly use Redux and React Server Components together. One possibility is using RTK Query's `createApi` to define data fetching endpoints, and using the generated thunks to fetch data in RSCs, but it's still an open question. However, users have reported that merely importing *any* React-Redux API in an RSC file causes a crash, because `React.createContext` is not defined in RSC files. RTKQ's React-specific `createApi` entry point imports React-Redux, so it's been unusable in RSCs. This release adds a workaround to fix that issue, by using a proxy wrapper around our singleton `ReactReduxContext` instance and lazily creating that instance on demand. In testing, this appears to both continue to work in all unit tests, *and* fixes the import error in an RSC environment. We'd appreciate further feedback in case this change does cause any issues for anyone! We've also tweaked the internals of the hooks to do checks for correct `<Provider>` usage when using a custom context, same as the default context checks. ##### Docs Updates We've cleaned up some of the Hooks API reference page, and updated links to the React docs. #### What's Changed - check for Provider even when using custom context by [@​EskiMojo14](https://togithub.com/EskiMojo14) in [https://github.com/reduxjs/react-redux/pull/1990](https://togithub.com/reduxjs/react-redux/pull/1990) - Add a stability check, to see if selector returns stable result when called with same parameters. by [@​EskiMojo14](https://togithub.com/EskiMojo14) in [https://github.com/reduxjs/react-redux/pull/2000](https://togithub.com/reduxjs/react-redux/pull/2000) - Add an E2E-ish test that verifies behavior when imported into RSCs by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2030](https://togithub.com/reduxjs/react-redux/pull/2030) - lazily create Context for RSC compat by [@​phryneas](https://togithub.com/phryneas) in [https://github.com/reduxjs/react-redux/pull/2025](https://togithub.com/reduxjs/react-redux/pull/2025) - Add warning for selectors that return the entire state by [@​EskiMojo14](https://togithub.com/EskiMojo14) in [https://github.com/reduxjs/react-redux/pull/2022](https://togithub.com/reduxjs/react-redux/pull/2022) **Full Changelog**: reduxjs/react-redux@v8.0.7...v8.1.0 ### [`v8.0.7`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.7) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.6...v8.0.7) This release updates the peer dependencies to accept Redux Toolkit, and accept the ongoing RTK and Redux core betas as valid peer deps. > **Note**: These changes were initially in 8.0.6, but that had a typo in the peer deps that broke installation. Sorry! #### What's Changed - Bump Redux peer deps to accept 5.0 betas, and bump RTK dev dep by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2017](https://togithub.com/reduxjs/react-redux/pull/2017) - [`d45204f`](https://togithub.com/reduxjs/react-redux/commit/d45204f) : Fix broken RTK peer dep **Full Changelog**: reduxjs/react-redux@v8.0.5...v8.0.7 ### [`v8.0.6`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.6) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.5...v8.0.6) \~~This release updates the peer dependencies to accept Redux Toolkit, and accept the ongoing RTK and Redux core betas as valid peer deps.~~ **This release has a peer deps typo that breaks installation - please use 8.0.7 instead !** #### What's Changed - Bump Redux peer deps to accept 5.0 betas, and bump RTK dev dep by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/2017](https://togithub.com/reduxjs/react-redux/pull/2017) **Full Changelog**: reduxjs/react-redux@v8.0.5...v8.0.6 ### [`v8.0.5`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.5) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.4...v8.0.5) This release fixes a few minor TS issues. #### What's Changed - `Provider`: pass state (`S`) generic through to `ProviderProps` by [@​OliverJAsh](https://togithub.com/OliverJAsh) in [https://github.com/reduxjs/react-redux/pull/1960](https://togithub.com/reduxjs/react-redux/pull/1960) - wrap `equalityFn` type in `NoInfer` by [@​phryneas](https://togithub.com/phryneas) in [https://github.com/reduxjs/react-redux/pull/1965](https://togithub.com/reduxjs/react-redux/pull/1965) - Fix wrapped component prop types when passing nullish mapDispatchToProps by [@​marconi1992](https://togithub.com/marconi1992) in [https://github.com/reduxjs/react-redux/pull/1928](https://togithub.com/reduxjs/react-redux/pull/1928) **Full Changelog**: reduxjs/react-redux@v8.0.4...v8.0.5 ### [`v8.0.4`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.4) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.3...v8.0.4) This patch release fixes some minor TS types issues, and updates the rarely-used `areStatesEqual` option for `connect` to now pass through `ownProps` for additional use in determining which pieces of state to compare if desired. > **Note**: 8.0.3 was accidentally published without one of these fixes. Use 8.0.4 instead. #### Changelog ##### TS Fixes We've fixed an import of `React` that caused issues with the `allowSyntheticDefaultImports` TS compiler flag in user projects. `connect` already accepted a custom context instance as `props.context`, and had runtime checks in case users were passing through a real value with app data as `props.context` instead. However, the TS types did not handle that case, and this would fail to compile. If your own component expects `props.context` with actual data, `connect`'s types now use that type instead. The `ConnectedProps<T>` type had a mismatch with React's built-in `React.ComponentProps<Component>` type, and that should now work correctly. ##### Other Changes The `areStatesEqual` option to `connect` now receives `ownProps` as well, in case you need to make a more specific comparison with certain sections of state. The new signature is: ```ts { areStatesEqual?: ( nextState: State, prevState: State, nextOwnProps: TOwnProps, prevOwnProps: TOwnProps ) => boolean } ``` #### What's Changed - Don't require allowSyntheticDefaultImports: true by [@​apepper](https://togithub.com/apepper) in [https://github.com/reduxjs/react-redux/pull/1924](https://togithub.com/reduxjs/react-redux/pull/1924) - Fixed type issue with `ComponentProps` from older `@types/react` by [@​Andarist](https://togithub.com/Andarist) in [https://github.com/reduxjs/react-redux/pull/1956](https://togithub.com/reduxjs/react-redux/pull/1956) - connect: pass ownProps to areStatesEqual by [@​jspurlin](https://togithub.com/jspurlin) in [https://github.com/reduxjs/react-redux/pull/1951](https://togithub.com/reduxjs/react-redux/pull/1951) - Omit built-in context prop if user component props include context by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1958](https://togithub.com/reduxjs/react-redux/pull/1958) **Full Changelog**: reduxjs/react-redux@v8.0.2...v8.0.4 ### [`v8.0.3`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.3) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.2...v8.0.3) **This release was accidentally published without an intended fix - please use [v8.0.4](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.4) instead** ### [`v8.0.2`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.2) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.1...v8.0.2) This patch release tweaks the behavior of `connect` to print a one-time warning when the obsolete `pure` option is passed in, rather than throwing an error. This fixes crashes caused by libraries such as `react-beautiful-dnd` continuing to pass in that option (unnecessarily) to React-Redux v8. #### What's Changed - Show warning instead of throwing error that pure option has been removed by [@​ApacheEx](https://togithub.com/ApacheEx) in [https://github.com/reduxjs/react-redux/pull/1922](https://togithub.com/reduxjs/react-redux/pull/1922) **Full Changelog**: reduxjs/react-redux@v8.0.1...v8.0.2 ### [`v8.0.1`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.1) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v8.0.0...v8.0.1) This release fixes an incorrect internal import of our `Subscription` type, which was causing TS compilation errors in some user projects. We've also listed `@types/react-dom` as an optional peerDep. There are no runtime changes in this release. #### What's Changed - Add optional peer dependency on [@​types/react-dom](https://togithub.com/types/react-dom) by [@​Methuselah96](https://togithub.com/Methuselah96) in [https://github.com/reduxjs/react-redux/pull/1904](https://togithub.com/reduxjs/react-redux/pull/1904) - fix(ts): incorrect import of `Subscription` causes `noImplicitAny` error by [@​vicrep](https://togithub.com/vicrep) in [https://github.com/reduxjs/react-redux/pull/1910](https://togithub.com/reduxjs/react-redux/pull/1910) **Full Changelog**: reduxjs/react-redux@v8.0.0...v8.0.1 ### [`v8.0.0`](https://togithub.com/reduxjs/react-redux/releases/tag/v8.0.0) [Compare Source](https://togithub.com/reduxjs/react-redux/compare/v7.2.9...v8.0.0) This **major version** release updates `useSelector`, `connect`, and `<Provider>` for compatibility with React 18, rewrites the React-Redux codebase to TypeScript (obsoleting use of `@types/react-redux`), modernizes build output, and removes the deprecated `connectAdvanced` API and the `pure` option for `connect`. npm i react-redux@latest yarn add react-redux@latest #### Overview, Compatibility, and Migration Our public API is still the same ( `<Provider>`, `connect` and `useSelector/useDispatch`), but we've updated the internals to use the new `useSyncExternalStore` hook from React. React-Redux v8 is still compatible with all versions of React that have hooks (16.8+, 17.x, and 18.x; React Native 0.59+), and *should* just work out of the box. In most cases, it's very likely that the only change you will need to make is bumping the package version to `"react-redux": "^8.0"`. *If* you are using the rarely-used `connectAdvanced` API, you will need to rewrite your code to avoid that, likely by using the hooks API instead. Similarly, the `pure` option for `connect` has been removed. If you are using Typescript, React-Redux is now written in TS and includes its own types. You should remove any dependencies on `@types/react-redux`. While not directly tied to React-Redux, note that **the recently updated `@types/react@18` major version has changed component definitions to remove having `children` as a prop by default**. This causes errors if you have multiple copies of `@types/react` in your project. To fix this, tell your package manager to resolve `@types/react` to a single version. Details: [**React issue #​24304: React 18 types broken since release**](https://togithub.com/facebook/react/issues/24304#issuecomment-1094565891) Additionally, please see the React post on [**How to Ugprade to React 18**](https://reactjs.org/blog/2022/03/08/react-18-upgrade-guide.html) for details on how to migrate existing apps to correctly use React 18 and take advantage of its new features. #### Changelog ##### React 18 Compatibility React-Redux now requires the new [`useSyncExternalStore` API in React 18](https://togithub.com/reactwg/react-18/discussions/86). By default, it uses the "shim" package which backfills that API in earlier React versions, so **React-Redux v8 is compatible with all React versions that have hooks** (16.8+, and React Native 0.59+) as its acceptable peer dependencies. We'd especially like to thank the React team for their extensive support and cooperation during the `useSyncExternalStore` development effort. They specifically designed `useSyncExternalStore` to support the needs and use cases of React-Redux, and we used React-Redux v8 as a testbed for how `useSyncExternalStore` would behave and what it needed to cover. This in turn helped ensure that `useSyncExternalStore` would be useful and work correctly for other libraries in the ecosystem as well. Our performance benchmarks show parity with React-Redux v7.2.5 for both `connect` and `useSelector`, so we do not anticipate any meaningful performance regressions. ##### `useSyncExternalStore` and Bundling The `useSyncExternalStore` shim is imported directly in the main entry point, so it's *always* included in bundles even if you're using React 18. This adds roughly 600 bytes minified to your bundle size. If you are using React 18 and would like to avoid that extra bundle cost, React-Redux now has a new `/next` entry point. This exports the exact same APIs, but directly imports `useSyncExternalStore` from React itself, and thus avoids including the shim. You can alias `"react-redux": "react-redux/next"` in your bundler to use that instead. ##### SSR and Hydration React 18 introduces a new `hydrateRoot` method for hydrating the UI on the client in Server-Side Rendering usage. As part of that, the `useSyncExternalStore` API requires that we pass in an alternate state value other than what's in the actual Redux store, and that alternate value will be used for the entire initial hydration render to ensure the initial rehydrated UI is an exact match for what was rendered on the server. After the hydration render is complete, React will then apply any additional changes from the store state in a follow-up render. React-Redux v8 supports this by adding a new `serverState` prop for `<Provider>`. If you're using SSR, you should pass your serialized state to `<Provider>` to ensure there are no hydration mismatch errors: ```ts import { hydrateRoot } from 'react-dom/client' import { configureStore } from '@​reduxjs/toolkit' import { Provider } from 'react-redux' const preloadedState = window.__PRELOADED_STATE__ const clientStore = configureStore({ reducer: rootReducer, preloadedState, }) hydrateRoot( document.getElementById('root'), <Provider store={clientStore} serverState={preloadedState}> <App /> </Provider> ) ``` ##### TypeScript Migration and Support The React-Redux library source has always been written in plain JS, and the community maintained the TS typings separately as `@types/react-redux`. We've (finally!) [migrated the React-Redux codebase to TypeScript](https://togithub.com/reduxjs/react-redux/issues/1737), using the existing typings as a starting point. This means that **the `@types/react-redux` package is no longer needed, and you should remove that as a dependency**. > **Note** Please ensure that any installed copies of `redux` and `@types/react` are de-duped. You are also encouraged to update to the latest versions of Redux Toolkit (1.8.1+) or Redux (4.1.2), to ensure consistency between installed types and avoid problems from types mismatches. We've tried to maintain the same external type signatures as much as possible. If you do see any compile problems, please file issues with any apparent TS-related problems so we can review them. The TS migration was a great collaborative effort, with many community members contributing migrated files. Thank you to everyone who helped out! In addition to the "pre-typed" `TypedUseSelectorHook`, there's now also a `Connect<State = unknown>` type that can be used as a "pre-typed" version of `connect` as well. As part of the process, we also updated the repo to use Yarn 3, copied the typetests files from DefinitelyTyped and expanded them, and improved our CI setup to test against multiple TS versions. ##### Removal of the `DefaultRootState` type The `@types/react-redux` package, which has always been maintained by the community, included a `DefaultRootState` interface that was intended for use with TS's "module augmentation" capability. Both `connect` and `useSelector` used this as a fallback if no state generic was provided. When we migrated React-Redux to TS, we copied over all of the types from that package as a starting point. However, the Redux team [specifically considers use of a globally augmented state type to be an anti-pattern](https://togithub.com/reduxjs/react-redux/issues/1879). Instead, we direct users to [extract the `RootState` and `AppDispatch` types from the store setup](https://redux.js.org/tutorials/typescript-quick-start#define-root-state-and-dispatch-types), and [create pre-typed versions of the React-Redux hooks](https://redux.js.org/tutorials/typescript-quick-start#define-typed-hooks) for use in the app. Now that React-Redux itself is written in TS, we've opted to remove the `DefaultRootState` type entirely. State generics now default to `unknown` instead. Technically [the module augmentation approach can still be done in userland](https://togithub.com/reduxjs/react-redux/issues/1879#issuecomment-1073284804), but we discourage this practice. ##### Modernized Build Output We've always targeted ES5 syntax in our published build artifacts as the lowest common denominator. Even the "ES module" artifacts with `import/export` keywords still were compiled to ES5 syntax otherwise. With IE11 now effectively dead and many sites no longer supporting it, we've updated our build tooling to target a more modern syntax equivalent to ES2017, which shrinks the bundle size slightly. If you still need to support ES5-only environments, please compile your own dependencies as needed for your target environment. ##### Removal of Legacy APIs We announced in 2019 that [the legacy `connectAdvanced` API would be removed in the next major version](https://togithub.com/reduxjs/react-redux/issues/1236), as it was rarely used, added internal complexity, and was also basically irrelevant with the introduction of hooks. As promised, we've removed that API. We've also removed the `pure` option for `connect`, which forced components to re-render regardless of whether props/state had actually changed if it was set to `false`. This option was needed in some cases in the early days of the React ecosystem, when components sometimes relied on external mutable data sources that could change outside of rendering. Today, no one writes components that way, the option was barely used, and React 18's `useSyncExternalStore` strictly requires immutable updates. So, we've removed the `pure` flag. Given that both of these options were almost never used, this shouldn't meaningfully affect anyone. #### Changes Due to the TS migration effort and number of contributors, this list covers just the major changes: - Integrate TypeScript port by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1739](https://togithub.com/reduxjs/react-redux/pull/1739) - Initial experimental React 18 compat prototyping by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1808](https://togithub.com/reduxjs/react-redux/pull/1808) - Fix compatibility with React 18 strict effects by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1817](https://togithub.com/reduxjs/react-redux/pull/1817) - Update to latest React 18 alpha dependencies by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1834](https://togithub.com/reduxjs/react-redux/pull/1834) - Port remaining v7 typetests and improve v8 types by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1855](https://togithub.com/reduxjs/react-redux/pull/1855) - Add initial SSR support for React 18 and React-Redux v8 by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1835](https://togithub.com/reduxjs/react-redux/pull/1835) - test: Adjust type tests to be compatible with React 18 typings by [@​eps1lon](https://togithub.com/eps1lon) in [https://github.com/reduxjs/react-redux/pull/1868](https://togithub.com/reduxjs/react-redux/pull/1868) - Switch back to Subscription in useSelector to fix unsubscribe perf by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1870](https://togithub.com/reduxjs/react-redux/pull/1870) - Cleanup more code after `pure` removal by [@​Andarist](https://togithub.com/Andarist) in [https://github.com/reduxjs/react-redux/pull/1859](https://togithub.com/reduxjs/react-redux/pull/1859) - Swap `useSyncExternalStore` shim behavior and update React deps by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1884](https://togithub.com/reduxjs/react-redux/pull/1884) - Remove `DefaultRootState` type by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1887](https://togithub.com/reduxjs/react-redux/pull/1887) - Add SSR test for `serverState` behavior by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1888](https://togithub.com/reduxjs/react-redux/pull/1888) - Cleanup internal types in selectorFactory.ts by [@​Methuselah96](https://togithub.com/Methuselah96) in [https://github.com/reduxjs/react-redux/pull/1889](https://togithub.com/reduxjs/react-redux/pull/1889) - Remove ts-ignore for initMergeProps by [@​Methuselah96](https://togithub.com/Methuselah96) in [https://github.com/reduxjs/react-redux/pull/1891](https://togithub.com/reduxjs/react-redux/pull/1891) - fix(deps): add optional peer deps into `peerDependencies` by [@​kyletsang](https://togithub.com/kyletsang) in [https://github.com/reduxjs/react-redux/pull/1893](https://togithub.com/reduxjs/react-redux/pull/1893) - Update peer deps for v8 by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1895](https://togithub.com/reduxjs/react-redux/pull/1895) - Port DT fix for `dispatchProp` arg in `mergeProps` by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1897](https://togithub.com/reduxjs/react-redux/pull/1897) - Update docs for v8 final by [@​markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/react-redux/pull/1902](https://togithub.com/reduxjs/react-redux/pull/1902) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 5pm,every weekend" in timezone America/Los_Angeles, Automerge - "after 5pm,every weekend" in timezone America/Los_Angeles. 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/valora-inc/wallet). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yMjAuMiIsInVwZGF0ZWRJblZlciI6IjM3LjIyMC4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Jean Regisser <[email protected]>
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.
The Subscription impl originally used an array of listeners just
like the actual Redux store, but in #1523 we changed it to be a
linked list to fix perf issues. The use of
indexOf+splicecauseda quadratic cost to unmounting many components.
In v8, I originally dropped use of
Subscriptionto potentiallysave on bundle size. However,
Providerstill usesSubscription,so that will always be in the bundle.
For this issue, a user pointed out that directly subscribing to the
store brought back the original quadratic unsubscription behavior,
which I've confirmed locally.
Swapping
store.subscribeforsubscription.addNestedSubfixesthat issue.
I've added a unit test that mounts and unmounts a massive tree and
measures the elapsed time. There's a distinct difference between
the "correct" and quadratic behavior. Weirdly, there's also a big
diff in "correct" time between React 18, and 17 + the "compat" entry
point, and I have no idea why. It's not as bad as the quadratic
time, but it's still pretty expensive.
I've written the test to set an acceptable max unmount time based on
which React version we're running against, with some buffer added.
Fixes #1869 .