Update dependency react-redux to v9
This MR contains the following updates:
Package | Change | Age | Adoption | Passing | Confidence |
---|---|---|---|---|---|
react-redux | ^8.0.0 -> ^9.0.0 |
Release Notes
reduxjs/react-redux
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 in https://github.com/reduxjs/react-redux/pull/2107
Full Changelog: https://github.com/reduxjs/react-redux/compare/v9.0.3...v9.0.4
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 in https://github.com/reduxjs/react-redux/pull/2104 - Drop
@types/react-dom
and lower@types/react
to min needed by @markerikson in https://github.com/reduxjs/react-redux/pull/2105
Full Changelog: https://github.com/reduxjs/react-redux/compare/v9.0.2...v9.0.3
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 in https://github.com/reduxjs/react-redux/pull/2102
Full Changelog: https://github.com/reduxjs/react-redux/compare/v9.0.1...v9.0.2
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 in https://github.com/reduxjs/react-redux/pull/2100
Full Changelog: https://github.com/reduxjs/react-redux/compare/v9.0.0...v9.0.1
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 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!) React-Redux is a separate, package, but we expect you'll be upgrading them together.
### 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", 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. 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, 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:
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, 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 in https://github.com/reduxjs/react-redux/pull/2038
- Add stack to dev mode checks by @EskiMojo14 in https://github.com/reduxjs/react-redux/pull/2064
- add an extra entrypoint for React Server Components by @phryneas in https://github.com/reduxjs/react-redux/pull/2062
- Inline hoist-non-react-statics to eliminate a dep and help shaking by @markerikson in https://github.com/reduxjs/react-redux/pull/2066
- Make context typing more accurate by @EskiMojo14 in https://github.com/reduxjs/react-redux/pull/2041
- Fix
uSES
imports and run against RTK CI examples by @markerikson in https://github.com/reduxjs/react-redux/pull/2070 - Copy CI setup for RTK examples by @markerikson in https://github.com/reduxjs/react-redux/pull/2072
- Fix useSelector() in combination with lazy loaded components breaks with react v18 (#1977) by @jeroenpx in https://github.com/reduxjs/react-redux/pull/2068
- Actually add
sideEffects: "false"
topackage.json
in v9 by @markerikson in https://github.com/reduxjs/react-redux/pull/2079 - Inline
react-is
utils to fix tree-shaking in 9.0 by @markerikson in https://github.com/reduxjs/react-redux/pull/2085 - Rename
noopCheck
toidentityFunctionCheck
by @aryaemami59 in https://github.com/reduxjs/react-redux/pull/2091 - Use scoped JSX for React types by @markerikson in https://github.com/reduxjs/react-redux/pull/2092
Full Changelog: https://github.com/reduxjs/react-redux/compare/v8.1.2...v9.0.0
v8.1.3
This bugfix release fixes an issue with subscriptions being lost when lazy-loaded components are used with React Suspense, and includes stack traces in useSelector
usage warnings .
What's Changed
- Add stack to dev mode checks by @EskiMojo14 in https://github.com/reduxjs/react-redux/pull/2064
- Fix useSelector() in combination with lazy loaded components breaks with react v18 (#1977) by @jeroenpx in https://github.com/reduxjs/react-redux/pull/2068
Full Changelog: https://github.com/reduxjs/react-redux/compare/v8.1.2...v8.1.3
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: https://github.com/reduxjs/react-redux/compare/v8.1.1...v8.1.2
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, 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 in https://github.com/reduxjs/react-redux/pull/2034
- create singleton context by React version by @phryneas in https://github.com/reduxjs/react-redux/pull/2039
- remove RTK peerDep by @markerikson in
44fc725
Full Changelog: https://github.com/reduxjs/react-redux/compare/v8.1.0...v8.1.1
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
useSelector
Development Mode Checks for 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 rootstate
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:
// Example: globally configure the root state "noop" check to run every time
<Provider store={store} noopCheck="always">
{children}
</Provider>
// 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 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 in https://github.com/reduxjs/react-redux/pull/1990
- Add a stability check, to see if selector returns stable result when called with same parameters. by @EskiMojo14 in https://github.com/reduxjs/react-redux/pull/2000
- Add an E2E-ish test that verifies behavior when imported into RSCs by @markerikson in https://github.com/reduxjs/react-redux/pull/2030
- lazily create Context for RSC compat by @phryneas in https://github.com/reduxjs/react-redux/pull/2025
- Add warning for selectors that return the entire state by @EskiMojo14 in https://github.com/reduxjs/react-redux/pull/2022
Full Changelog: https://github.com/reduxjs/react-redux/compare/v8.0.7...v8.1.0
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 in https://github.com/reduxjs/react-redux/pull/2017
-
d45204f
: Fix broken RTK peer dep
Full Changelog: https://github.com/reduxjs/react-redux/compare/v8.0.5...v8.0.7
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 in https://github.com/reduxjs/react-redux/pull/2017
Full Changelog: https://github.com/reduxjs/react-redux/compare/v8.0.5...v8.0.6
Configuration
-
If you want to rebase/retry this MR, check this box
This MR has been generated by Renovate Bot.