-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(deps): update dependency react-redux to v9 #433
base: master
Are you sure you want to change the base?
Conversation
|
c254a4d
to
ccc91de
Compare
tracked in a private ticket https://2u-internal.atlassian.net/browse/APER-3769 |
blocked until FPF and Paragon support React 18. |
blocked until FPF and Paragon support React 18. |
03bde62
to
ff90e6d
Compare
111581d
to
ca88da3
Compare
bf21630
to
f6fb4c4
Compare
f850b86
to
033282d
Compare
40c2edd
to
67065c0
Compare
67065c0
to
78f72e5
Compare
78f72e5
to
ab5bdaa
Compare
This PR contains the following updates:
7.2.9
->9.2.0
Release Notes
reduxjs/react-redux (react-redux)
v9.2.0
Compare Source
This feature release updates the React peer dependency to work with React 19, and improves treeshakeability of our build artifacts.
Changelog
React 19 Compat
React 19 was just released! We've updated our peer dep to accept React 19, and updated our runtime and type tests to check against both React 18 and 19.
Treeshaking
We've done some nitty-gritty optimization work to ensure bundlers correctly treeshake unused parts of the bundle.
What's Changed
Full Changelog: reduxjs/react-redux@v9.1.2...v9.2.0
v9.1.2
Compare Source
v9.1.1
Compare Source
This bugfix release fixes an issue with
connect
and React Native caused by changes to our bundling setup in v9. Nestedconnect
calls should work correctly now.What's Changed
Equals
constraint into an intersection type. by @DanielRosenwasser in https://github.com/reduxjs/react-redux/pull/2123useIsomorphicLayoutEffect
usage in React Native environments by @aryaemami59 in https://github.com/reduxjs/react-redux/pull/2156Full Changelog: reduxjs/react-redux@v9.1.0...v9.1.1
v9.1.0
Compare Source
v9.0.4
Compare Source
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 thenpm
package manager throwing peer dep errors on install.What's Changed
Full Changelog: reduxjs/react-redux@v9.0.3...v9.0.4
v9.0.3
Compare Source
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 namedbatch
.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 corereact
package. Our prior implementation relied on having separatebatch.ts
andbatch.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
batch
by @markerikson in https://github.com/reduxjs/react-redux/pull/2104@types/react-dom
and lower@types/react
to min needed by @markerikson in https://github.com/reduxjs/react-redux/pull/2105Full Changelog: reduxjs/react-redux@v9.0.2...v9.0.3
v9.0.2
Compare Source
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
.mjs
to.js
by @aryaemami59 in https://github.com/reduxjs/react-redux/pull/2102Full Changelog: reduxjs/react-redux@v9.0.1...v9.0.2
v9.0.1
Compare Source
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
Full Changelog: reduxjs/react-redux@v9.0.0...v9.0.1
v9.0.0
Compare Source
This major release:
useSelector
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.
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 theuse-sync-external-store
"shim" package that provided an official userland implementation of theuseSyncExternalStore
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 namedreact-redux.legacy-esm.js
to support Webpack 4 (which does not recognize theexports
field inpackage.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 theink
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 toidentityFunctionCheck
for clarity. We've also changed the structure of the options object to be:hoist-non-react-statics
andreact-is
Deps InlinedHigher 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 byconnect
.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
uSES
imports and run against RTK CI examples by @markerikson in https://github.com/reduxjs/react-redux/pull/2070sideEffects: "false"
topackage.json
in v9 by @markerikson in https://github.com/reduxjs/react-redux/pull/2079react-is
utils to fix tree-shaking in 9.0 by @markerikson in https://github.com/reduxjs/react-redux/pull/2085noopCheck
toidentityFunctionCheck
by @aryaemami59 in https://github.com/reduxjs/react-redux/pull/2091Full Changelog: reduxjs/react-redux@v8.1.2...v9.0.0
v8.1.3
Compare Source
v8.1.2
Compare Source
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:
globalThis
(in this case it will fall back to the previous behaviour).Full Changelog: reduxjs/react-redux@v8.1.1...v8.1.2
v8.1.1
Compare Source
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
44fc725
Full Changelog: reduxjs/react-redux@v8.1.0...v8.1.1
v8.1.0
Compare Source
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:useSelector
will warn if the results are different referencesuseSelector
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: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-specificcreateApi
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
Full Changelog: reduxjs/react-redux@v8.0.7...v8.1.0
v8.0.7
Compare Source
This release updates the peer dependencies to accept Redux Toolkit, and accept the ongoing RTK and Redux core betas as valid peer deps.
What's Changed
d45204f
: Fix broken RTK peer depFull Changelog: reduxjs/react-redux@v8.0.5...v8.0.7
v8.0.6
Compare Source
~~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
Full Changelog: reduxjs/react-redux@v8.0.5...v8.0.6
v8.0.5
Compare Source
This release fixes a few minor TS issues.
What's Changed
Provider
: pass state (S
) generic through toProviderProps
by @OliverJAsh in https://github.com/reduxjs/react-redux/pull/1960equalityFn
type inNoInfer
by @phryneas in https://github.com/reduxjs/react-redux/pull/1965Full Changelog: reduxjs/react-redux@v8.0.4...v8.0.5
v8.0.4
Compare Source
This patch release fixes some minor TS types issues, and updates the rarely-used
areStatesEqual
option forconnect
to now pass throughownProps
for additional use in determining which pieces of state to compare if desired.Changelog
TS Fixes
We've fixed an import of
React
that caused issues with theallowSyntheticDefaultImports
TS compiler flag in user projects.connect
already accepted a custom context instance asprops.context
, and had runtime checks in case users were passing through a real value with app data asprops.context
instead. However, the TS types did not handle that case, and this would fail to compile. If your own component expectsprops.context
with actual data,connect
's types now use that type instead.The
ConnectedProps<T>
type had a mismatch with React's built-inReact.ComponentProps<Component>
type, and that should now work correctly.Other Changes
The
areStatesEqual
option toconnect
now receivesownProps
as well, in case you need to make a more specific comparison with certain sections of state.The new signature is:
What's Changed
ComponentProps
from older@types/react
by @Andarist in https://github.com/reduxjs/react-redux/pull/1956Full Changelog: reduxjs/react-redux@v8.0.2...v8.0.4
v8.0.3
Compare Source
This release was accidentally published without an intended fix - please use v8.0.4 instead
v8.0.2
Compare Source
This patch release tweaks the behavior of
connect
to print a one-time warning when the obsoletepure
option is passed in, rather than throwing an error. This fixes crashes caused by libraries such asreact-beautiful-dnd
continuing to pass in that option (unnecessarily) to React-Redux v8.What's Changed
Full Changelog: reduxjs/react-redux@v8.0.1...v8.0.2
v8.0.1
Compare Source
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
Subscription
causesnoImplicitAny
error by @vicrep in https://github.com/reduxjs/react-redux/pull/1910Full Changelog: reduxjs/react-redux@v8.0.0...v8.0.1
v8.0.0
Compare Source
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 deprecatedconnectAdvanced
API and thepure
option forconnect
.Overview, Compatibility, and Migration
Our public API is still the same (
<Provider>
,connect
anduseSelector/useDispatch
), but we've updated the internals to use the newuseSyncExternalStore
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, thepure
option forconnect
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 havingchildren
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
Additionally, please see the React post on How to Ugprade to React 18 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. 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 designeduseSyncExternalStore
to support the needs and use cases of React-Redux, and we used React-Redux v8 as a testbed for howuseSyncExternalStore
would behave and what it needed to cover. This in turn helped ensure thatuseSyncExternalStore
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
anduseSelector
, so we do not anticipate any meaningful performance regressions.useSyncExternalStore
and BundlingThe
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 importsuseSyncExternalStore
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, theuseSyncExternalStore
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: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, 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.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 aConnect<State = unknown>
type that can be used as a "pre-typed" version ofconnect
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
typeThe
@types/react-redux
package, which has always been maintained by the community, included aDefaultRootState
interface that was intended for use with TS's "module augmentation" capability. Bothconnect
anduseSelector
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. Instead, we direct users to extract the
RootState
andAppDispatch
types from the store setup, and create pre-typed versions of the React-Redux 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 tounknown
instead.Technically the module augmentation approach can still be done in userland, 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, 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 forconnect
, which forced components to re-render regardless of whether props/state had actually changed if it was set tofalse
. 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'suseSyncExternalStore
strictly requires immutable updates. So, we've removed thepure
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:
pure
removal by @Andarist in https://github.com/reduxjs/react-redux/pull/1859useSyncExternalStore
shim behavior and update React deps by @markerikson in https://github.com/reduxjs/react-redux/pull/1884DefaultRootState
type by @markerikson in https://github.com/reduxjs/react-redux/pull/1887serverState
behavior by @markerikson in https://github.com/reduxjs/react-redux/pull/1888peerDependencies
by @kyletsang in https://github.com/reduxjs/react-redux/pull/1893dispatchProp
arg inmergeProps
by @markerikson in https://github.com/reduxjs/react-redux/pull/1897Configuration
📅 Schedule: Branch creation - "* 0-3 * * 1" in timezone America/New_York, Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.