Skip to content
New issue

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

Sign up for GitHub

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

Jump to bottom

Update dependency react-redux to v9 #310

Merged
merged 1 commit into from
Dec 18, 2023
Merged

Update dependency react-redux to v9 #310

merged 1 commit into from
Dec 18, 2023

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Dec 5, 2023 •
edited
Loading

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
react-redux ^8.0.5 -> ^9.0.0 age adoption passing confidence

Release Notes

reduxjs/react-redux (react-redux)

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 the npm 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 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

Full 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

Full 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:

  • 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

Full Changelog: reduxjs/react-redux@v8.1.2...v9.0.0

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ 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.

  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot added the major label Dec 5, 2023
@mergify mergify bot requested a review from SvenKirschbaum December 5, 2023 17:53
@renovate renovate bot force-pushed the renovate/react-redux-9.x branch from 1895a6b to 5aa9612 Compare December 14, 2023 22:26
@renovate renovate bot force-pushed the renovate/react-redux-9.x branch from 5aa9612 to c335b84 Compare December 18, 2023 17:59
@mergify mergify bot requested a review from SvenKirschbaum December 18, 2023 18:00
@mergify mergify bot merged commit 46059bf into master Dec 18, 2023
4 checks passed
@mergify mergify bot deleted the renovate/react-redux-9.x branch December 18, 2023 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SvenKirschbaum SvenKirschbaum SvenKirschbaum approved these changes

Assignees

@SvenKirschbaum SvenKirschbaum

Labels
major
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@SvenKirschbaum