chore(deps): update dependency redux to v5

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
redux (source)	`^4.0.4` -> `^4.0.4 \\|\\| ^5.0.0`
redux (source)	`4.2.1` -> `5.0.1`

Release Notes

reduxjs/redux (redux)

### [`v5.0.1`](https://redirect.github.com/reduxjs/redux/releases/tag/v5.0.1) [Compare Source](https://redirect.github.com/reduxjs/redux/compare/v5.0.0...v5.0.1) This **patch release** adjusts the `isPlainObject` util to allow objects created via `Object.create(null)`, and fixes a type issue which accidentally made the store state type non-nullable. #### What's Changed - fix(isPlainObject): support check Object.create(null) by [@zhe-he](https://redirect.github.com/zhe-he) in [https://github.com/reduxjs/redux/pull/4633](https://redirect.github.com/reduxjs/redux/pull/4633) - fix(types/store): Unexpectedly narrowed return type of function `Store['getState']` by [@exuanbo](https://redirect.github.com/exuanbo) in [https://github.com/reduxjs/redux/pull/4638](https://redirect.github.com/reduxjs/redux/pull/4638) **Full Changelog**: https://github.com/reduxjs/redux/compare/v5.0.0...v5.0.1 ### [`v5.0.0`](https://redirect.github.com/reduxjs/redux/releases/tag/v5.0.0) [Compare Source](https://redirect.github.com/reduxjs/redux/compare/v4.2.1...v5.0.0) This **major release**: - Converts the codebase to TypeScript - Updates the packaging for better ESM/CJS compatibility and modernizes the build output - Requires that `action.type` *must* be a string - Continues to mark `createStore` as deprecated - Deprecates the `AnyAction` type in favor of an `UnknownAction` type that is used everywhere - Removes the `PreloadedState` type in favor of a new generic argument for the `Reducer` type. 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)) ```bash ### RTK npm install @reduxjs/toolkit yarn add @reduxjs/toolkit ### Standalone npm install redux yarn add redux ``` #### Changelog ##### 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/redux.mjs`**. Most build tools should pick this up. There's also a CJS artifact, and a second copy of the ESM file named `redux.legacy-esm.js` to support Webpack 4 (which does not recognize the `exports` field in `package.json`). Additionally, all of the build artifacts now live under `./dist/` in the published package. ##### 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 `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! ##### `createStore` Marked Deprecated In [Redux 4.2.0, we marked the original `createStore` method as `@deprecated`](https://redirect.github.com/reduxjs/redux/releases/tag/v4.2.0). Strictly speaking, **this is *not* a breaking change**, nor is it new in 5.0, but we're documenting it here for completeness. **This deprecation is solely a *visual* indicator that is meant to encourage users to [migrate their apps from legacy Redux patterns to use the modern Redux Toolkit APIs](https://redux.js.org/usage/migrating-to-modern-redux)**. The deprecation results in a **visual strikethrough** when imported and used, like **~~`createStore`~~**, but with ***no* runtime errors or warnings**. **`createStore` will continue to work indefinitely, and will *not* ever be removed**. But, today we want *all* Redux users to be using Redux Toolkit for all of their Redux logic. To fix this, there are three options: - **[Follow our strong suggestion to switch over to Redux Toolkit and `configureStore`](https://redux.js.org/usage/migrating-to-modern-redux)** - Do nothing. It's just a visual strikethrough, and it doesn't affect how your code behaves. Ignore it. - Switch to using the `legacy_createStore` API that is now exported, which is the exact same function but with no `@deprecated` tag. The simplest option is to do an aliased import rename, like `import { legacy_createStore as createStore } from 'redux'` ##### Action types *must* be strings We've always specifically told our users that [actions and state *must* be serializable](https://redux.js.org/style-guide/#do-not-put-non-serializable-values-in-state-or-actions), and that `action.type` *should* be a string. This is both to ensure that actions are serializable, and to help provide a readable action history in the Redux DevTools. `store.dispatch(action)` now specifically enforces that **`action.type` *must* be a string** and will throw an error if not, in the same way it throws an error if the action is not a plain object. In practice, this was already true 99.99% of the time and shouldn't have any effect on users (especially those using Redux Toolkit and `createSlice`), but there may be some legacy Redux codebases that opted to use Symbols as action types. ##### TypeScript Changes We've dropped support for TS 4.6 and earlier, and our support matrix is now TS 4.7+. ##### Typescript rewrite In 2019, we began a community-powered conversion of the Redux codebase to TypeScript. The original effort was discussed in [#3500: Port to TypeScript](https://redirect.github.com/reduxjs/redux/issues/3500), and the work was integrated in PR [#3536: Convert to TypeScript](https://redirect.github.com/reduxjs/redux/issues/3536). However, the TS-converted code sat around in the repo for several years, unused and unpublished, due to concerns about possible compatibility issues with the existing ecosystem (as well as general inertia on our part). Redux core v5 is now built from that TS-converted source code. In theory, this should be almost identical in both runtime behavior and types to the 4.x build, but it's very likely that some of the changes may cause types issues. Please report any unexpected compatibility issues!! ##### `AnyAction` deprecated in favour of `UnknownAction` The Redux TS types have always exported an `AnyAction` type, which is defined to have `{type: string}` and treat any other field as `any`. This makes it easy to write uses like `console.log(action.whatever)`, but unfortunately does not provide any meaningful type safety. We now export an `UnknownAction` type, which treats all fields other than `action.type` as `unknown`. This encourages users to write type guards that check the action object and assert its *specific* TS type. Inside of those checks, you can access a field with better type safety. `UnknownAction` is now the default any place in the Redux source that expects an action object. `AnyAction` still exists for compatibility, but has been marked as deprecated. Note that [Redux Toolkit's action creators have a `.match()` method](https://redux-toolkit.js.org/api/createAction#actioncreatormatch) that acts as a useful type guard: ```ts if (todoAdded.match(someUnknownAction)) { // action is now typed as a PayloadAction } ``` You can also use the new `isAction` util to check if an unknown value is some kind of action object. ##### `Middleware` type changed - Middleware `action` and `next` are typed as `unknown` Previously, the `next` parameter is typed as the `D` type parameter passed, and `action` is typed as the `Action` extracted from the dispatch type. Neither of these are a safe assumption: - `next` would be typed to have **all** of the dispatch extensions, including the ones earlier in the chain that would no longer apply. - Technically it would be *mostly* safe to type `next` as the default Dispatch implemented by the base redux store, however this would cause `next(action)` to error (as we cannot promise `action` is actually an `Action`) - and it wouldn't account for any following middlewares that return anything other than the action they're given when they see a specific action. - `action` is not necessarily a known action, it can be literally anything - for example a thunk would be a function with no `.type` property (so `AnyAction` would be inaccurate) We've changed `next` to be `(action: unknown) => unknown` (which is accurate, we have no idea what `next` expects or will return), and changed the `action` parameter to be `unknown` (which as above, is accurate). In order to safely interact with values or access fields inside of the `action` argument, you must first do a type guard check to narrow the type, such as `isAction(action)` or `someActionCreator.match(action)`. This new type is incompatible with the v4 `Middleware` type, so if a package's middleware is saying it's incompatible, check which version of Redux it's getting its types from! ##### `PreloadedState` type removed in favour of `Reducer` generic We've made tweaks to the TS types to improve type safety and behavior. First, the `Reducer` type now has a `PreloadedState` possible generic: ```ts type Reducer = ( state: S | PreloadedState | undefined, action: A ) => S ``` Per the explanation in [#4491](https://redirect.github.com/reduxjs/redux/pull/4491): Why the need for this change? When the store is first created by `createStore`/`configureStore`, the initial state is set to whatever is passed as the `preloadedState` argument (or `undefined` if nothing is passed). That means that the first time that the reducer is called, it is called with the `preloadedState`. After the first call, the reducer is always passed the current state (which is `S`). For most normal reducers, `S | undefined` accurately describes what can be passed in for the `preloadedState`. However the `combineReducers` function allows for a preloaded state of `Partial | undefined`. The solution is to have a separate generic that represents what the reducer accepts for its preloaded state. That way `createStore` can then use that generic for its `preloadedState` argument. Previously, this was handled by a `$CombinedState` type, but that complicated things and led to some user-reported issues. This removes the need for `$CombinedState` altogether. This change does include some breaking changes, but overall should not have a huge impact on users upgrading in user-land: - The `Reducer`, `ReducersMapObject`, and `createStore`/`configureStore` types/function take an additional `PreloadedState` generic which defaults to `S`. - The overloads for `combineReducers` are removed in favor of a single function definition that takes the `ReducersMapObject` as its generic parameter. Removing the overloads was necessary with these changes, since sometimes it was choosing the wrong overload. - Enhancers that explicitly list the generics for the reducer will need to add the third generic. ##### Other Changes ##### Internal Listener Implementation The Redux store has always used an array to track listener callbacks, and used `listeners.findIndex` to remove listeners on unsubscribe. As we found in React-Redux, that can have perf issues when many listeners are unsubscribing at once. In React-Redux, we fixed that with a more sophisticated linked list approach. Here, we've updated the `listeners` to be stored in a `Map` instead, which has better delete performance than an array. In practice this shouldn't have any real effect, because React-Redux sets up a subscription in ``, and all nested components subscribe to that. But, nice to fix it here as well. ##### `isAction` Predicate We recently added an `isAction` predicate to RTK, then realized it's better suited for the Redux core. This can be used anywhere you have a value that *could* be a Redux action object, and you need to check if it is actually an action. This is specifically useful for use with the updated Redux middleware TS types, where the default value is now `unknown` and you need to use a type guard to tell TS that the current value is actually an action: We've also exported the `isPlainObject` util that's been in the Redux codebase for years as well. #### What's Changed Entirely too many PRs to list here, as it's been a few years since 4.2 was released :) See the diff below. **Full Changelog**: https://github.com/reduxjs/redux/compare/v4.2.1...v5.0.0

Configuration

📅 Schedule: Branch creation - "before 4am on Monday" 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 these updates again.

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

This PR was generated by Mend Renovate. View the repository job log.

openedx / frontend-platform

chore(deps): update dependency redux to v5 #717

Release Notes

Configuration

Codecov Report