create-react-microservice
create-react-microservice copied to clipboard
TASK: Update dependency react-redux to v8
This PR contains the following updates:
Package | Change | Age | Adoption | Passing | Confidence |
---|---|---|---|---|---|
react-redux | 5.1.2 -> 8.1.1 |
Release Notes
reduxjs/react-redux (react-redux)
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
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 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
v8.0.5
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/1960 - wrap
equalityFn
type inNoInfer
by @​phryneas in https://github.com/reduxjs/react-redux/pull/1965 - Fix wrapped component prop types when passing nullish mapDispatchToProps by @​marconi1992 in https://github.com/reduxjs/react-redux/pull/1928
Full Changelog: https://github.com/reduxjs/react-redux/compare/v8.0.4...v8.0.5
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:
{
areStatesEqual?: (
nextState: State,
prevState: State,
nextOwnProps: TOwnProps,
prevOwnProps: TOwnProps
) => boolean
}
What's Changed
- Don't require allowSyntheticDefaultImports: true by @​apepper in https://github.com/reduxjs/react-redux/pull/1924
- Fixed type issue with
ComponentProps
from older@types/react
by @​Andarist in https://github.com/reduxjs/react-redux/pull/1956 - connect: pass ownProps to areStatesEqual by @​jspurlin in https://github.com/reduxjs/react-redux/pull/1951
- Omit built-in context prop if user component props include context by @​markerikson in https://github.com/reduxjs/react-redux/pull/1958
Full Changelog: https://github.com/reduxjs/react-redux/compare/v8.0.2...v8.0.4
v8.0.3
This release was accidentally published without an intended fix - please use v8.0.4 instead
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 in https://github.com/reduxjs/react-redux/pull/1922
Full Changelog: https://github.com/reduxjs/react-redux/compare/v8.0.1...v8.0.2
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 by @​Methuselah96 in https://github.com/reduxjs/react-redux/pull/1904
- fix(ts): incorrect import of
Subscription
causesnoImplicitAny
error by @​vicrep in https://github.com/reduxjs/react-redux/pull/1910
Full Changelog: https://github.com/reduxjs/react-redux/compare/v8.0.0...v8.0.1
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
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 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:
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, 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. Instead, we direct users to extract the RootState
and AppDispatch
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 to unknown
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 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 in https://github.com/reduxjs/react-redux/pull/1739
- Initial experimental React 18 compat prototyping by @​markerikson in https://github.com/reduxjs/react-redux/pull/1808
- Fix compatibility with React 18 strict effects by @​markerikson in https://github.com/reduxjs/react-redux/pull/1817
- Update to latest React 18 alpha dependencies by @​markerikson in https://github.com/reduxjs/react-redux/pull/1834
- Port remaining v7 typetests and improve v8 types by @​markerikson in https://github.com/reduxjs/react-redux/pull/1855
- Add initial SSR support for React 18 and React-Redux v8 by @​markerikson in https://github.com/reduxjs/react-redux/pull/1835
- test: Adjust type tests to be compatible with React 18 typings by @​eps1lon in https://github.com/reduxjs/react-redux/pull/1868
- Switch back to Subscription in useSelector to fix unsubscribe perf by @​markerikson in https://github.com/reduxjs/react-redux/pull/1870
- Cleanup more code after
pure
removal by @​Andarist in https://github.com/reduxjs/react-redux/pull/1859 - Swap
useSyncExternalStore
shim behavior and update React deps by @​markerikson in https://github.com/reduxjs/react-redux/pull/1884 - Remove
DefaultRootState
type by @​markerikson in https://github.com/reduxjs/react-redux/pull/1887 - Add SSR test for
serverState
behavior by @​markerikson in https://github.com/reduxjs/react-redux/pull/1888 - Cleanup internal types in selectorFactory.ts by @​Methuselah96 in https://github.com/reduxjs/react-redux/pull/1889
- Remove ts-ignore for initMergeProps by @​Methuselah96 in https://github.com/reduxjs/react-redux/pull/1891
- fix(deps): add optional peer deps into
peerDependencies
by @​kyletsang in https://github.com/reduxjs/react-redux/pull/1893 - Update peer deps for v8 by @​markerikson in https://github.com/reduxjs/react-redux/pull/1895
- Port DT fix for
dispatchProp
arg inmergeProps
by @​markerikson in https://github.com/reduxjs/react-redux/pull/1897 - Update docs for v8 final by @​markerikson in https://github.com/reduxjs/react-redux/pull/1902
v7.2.9
This patch release 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.
The new signature is:
{
areStatesEqual?: (
nextState: State,
prevState: State,
nextOwnProps: TOwnProps,
prevOwnProps: TOwnProps
) => boolean
}
What's Changed
- connect: pass ownProps to areStatesEqual by @​jspurlin in https://github.com/reduxjs/react-redux/pull/1952
Full Changelog: https://github.com/reduxjs/react-redux/compare/v7.2.8...v7.2.9
v7.2.8
This release fixes a bug in the 7.x branch that caused <Provider>
to unsubscribe and stop updating completely when used inside of React 18's <StrictMode>
. The new "strict effects" behavior double-mounts components, and the subscription needed to be set up inside of a useLayoutEffect
instead of a useMemo
. This was previously fixed as part of v8 development, and we've backported it.
Note: If you are now using React 18, we strongly recommend using the React-Redux v8 beta instead of v7.x!. v8 has been rewritten internally to work correctly with React 18's Concurrent Rendering capabilities. React-Redux v7 will run and generally work okay with existing code, but may have rendering issues if you start using Concurrent Rendering capabilities in your code.
Now that React 18 is out, we plan to finalize React-Redux v8 and release it live within the next couple weeks. Per an update yesterday in the "v8 roadmap" thread, React-Redux v8 will be updated in the next couple days to ensure support for React 16.8+ as part of the next beta release. We would really appreciate final feedback on using React-Redux v8 beta with React 18 before we publish the final version.
Full Changelog: https://github.com/reduxjs/react-redux/compare/v7.2.7...v7.2.8
v7.2.7
This release updates React-Redux v7's peer dependencies to accept React 18 as a valid version, only to avoid installation errors caused by NPM's "install all the peer deps and error if they don't match" behavior.
Note: If you are now using React 18, we strongly recommend using the React-Redux v8 beta instead of v7.x!. v8 has been rewritten internally to work correctly with React 18's Concurrent Rendering capabilities. React-Redux v7 will run and generally work okay with existing code, but may have rendering issues if you start using Concurrent Rendering capabilities in your code.
Now that React 18 is out, we plan to finalize React-Redux v8 and release it live within the next couple weeks. We would really appreciate final feedback on using React-Redux v8 beta with React 18 before we publish the final version.
v7.2.6
Just a quick fix for a Yarn install warning. Sorry about the noise!
Changes
- Remove
workspaces
from our package.json to silence a Yarn warning (@​timdorr)
v7.2.5
This release shrinks the size of our internal Subscription
class, and updates useSelector
to avoid an unnecessary selector call on mount.
Changes
Subscription Size Refactor
Our internal Subscription
implementation has been written as a class ever since it was added in v5. By rewriting it as a closure factory, we were able to shave a few bytes off the final bundle size.
useSelector
Mount Optimization
A user noticed that useSelector
had never been given an early "bail out if the root state is the same" check to match how connect
works. This resulted in a usually-unnecessary second call to the provided selector on mount. We've added that check.
Entry Point Consolidation
We've consolidated the list of exported public APIs into a single file, and both the index.js
and alternate-renderers.js
entry points now re-export everything from that file. No meaningful change here, just shuffling lines of code around for consistency.
Other Updates
React-Redux v8 and React 18 Development
With the announcement of React 18, we've been working with the React team to plan our migration path to keep React-Redux fully compatible with React's upcoming features.
We've already migrated the React-Redux main development branch to TypeScript, and are prototyping compatibility implementation updates. We'd appreciate any assistance from the community in testing out these changes so that we can ensure React-Redux works great for everyone when React 18 is ready!
Internal Tooling Updates
Our master
branch now uses Yarn v2 for package management, is built with TypeScript, and we've made CI updates to test against multiple TS versions.
The 7.x
branch has also been updated to use Yarn v2 for consistency.
These only affect contributors to the React-Redux package itself.
Changelog
- Port entry point consolidation from 8.x branch (#​1811 - @​markerikson)
- Update v7 branch to use Yarn v2 and improve CI process (#​1810 - @​markerikson)
- Reduce unnecessary calls to useSelector selector (#​1803 - @​sufian-slack )
- Port Subscription closure implementation from 8.x to 7.x (#​1809 - @​mbelsky)
v7.2.4
This release drops our dependency on the core redux
package by inlining bindActionCreators
, and tweaks useSelector
to ensure that selectors aren't run an extra time while re-rendering.
Changelog
Redux Dependency Removal
React-Redux has always imported the bindActionCreators
utility from the core redux
package for use in connect
. However, that meant that we had to have a peer dependency on redux
, and this was the only reason we actually required that redux
be installed. This became more annoying with the arrival of Redux Toolkit, which has its own dependency on redux
internally, and thus users typically saw peer dependency warnings saying that "redux
isn't listed as a dependency in your app".
Code reuse across separate packages is a great thing, but sometimes the right thing to do is duplicate code. So, we've inlined bindActionCreators
directly into React-Redux, and we've completely dropped the dependency on Redux. This means that React-Redux will no longer produce a peerDep warning when used with Redux Toolkit, and <Provider>
and connect
really only need a Redux-store-compatible value to work right.
useSelector
Fixes
Users reported that useSelector
was re-running selector functions again unnecessarily while rendering after a dispatch. We've tweaked the logic to ensure that doesn't happen.
useSelector
also now has checks in development to ensure that selector
and equalityFn
are functions.
Changes
- Remove wrapActionCreators (#​1709 - @​xty)
- Verify that selector and equalityF of useSelector are functions (#​1706 - @​gshilin)
- Import bindActionCreators from redux (#​1705 - @​timdorr)
- Don't re-run the selector after update (#​1701 - @​timdorr)
v7.2.3
This release improves behavior in useSelector
by returning the existing reference if the newly returned selector result passes the equality check, and adds a hard dependency on the @types/react-redux
package to ensure TS users always have the typedefs installed.
Changes
useSelector
Results Reuse
Issue #​1654 reported that useSelector
was returning new references from a selector even if the equality comparison function returned true
. This is because the equality check was only ever being performed during the action dispatch process.
We now run the equality comparison against the value calculated by the selector while rendering, and return the existing reference for consistency if the old and new values are considered equal. This should improve some cases where further derived values where being recalculated unnecessarily.
TS Types Now Included
React-Redux has always been written in plain JS, and the typedefs maintained by the community in DefinitelyTyped. We plan on eventually rewriting the library in TypeScript in a future React-Redux v8 release, but until then the types can stay in DT.
However, having to always manually install @types/react-redux
is annoying, and some users have gotten confused by that. This release adds a hard dependency on @types/react-redux
, so that if you install react-redux
, you automatically get the types as well. This should simplify the process for TS users.
Docs Updates
We've made several docs updates recently:
- Renamed "Quick Start" to "Getting Started" and "Static Typing" to "Usage with TypeScript"
- Dropped the docs API versioning setup, as the legacy API version docs pages were rarely viewed and the versioning setup confused docs contributors
- Moved the old "Intro > Basic Tutorial" to "Tutorials > Connect" and marked it as semi-obsolete
We are currently working on a new React-Redux tutorial that will teach the React-Redux hooks as the primary approach, based on the "UI and React" page in the Redux docs "Fundamentals" tutorial.
Changelog
- Automatically install @​types/react-redux as a dependency (#​1699 - @​markerikson )
- Reuse latest selected state on selector re-run (#​1654) (#​1660 - @​otakustay)
- Use useIsomorphicLayoutEffect in Provider for consistency (#​1683 - @​speakingcode )
v7.2.2
This release allows you to use React Redux with React 17 without a warning when installing. That's about it.
Changes
- Upgrade react peer dependency to v17 (#​1647 by @​wachunei)
v7.2.1
This release improves useSelector
value display in the React DevTools, fixes a potential race condition, and fixes a couple additional minor issues.
useSelector
DevTools Display
The React DevTools normally show custom hooks with their inspected name (such as "Selector" for useSelector
), and any calls to core hooks inside. This is not always informative, so React has the useDebugValue
hook to allow custom hooks to specify what value should be shown instead.
useSelector
now calls useDebugValue
to specifically show the current selected value instead of its internal hooks usage.
Bug Fixes
This release has a few different bug fixes:
- A potential race condition when dispatching actions from child components in the commit phase vs selecting data in a parent
- Removed an excess new object creation when forcing a re-render
- Our internal prop name for a forwarded ref is now
reactReduxForwardedRef
to avoid a rare situation where someone else might be passing down a field namedforwardedRef
- Fixed a typo in a
useSelector
error message
Changes
- Fix error message typo in useSelector ('You must pass a selector...). (@​Pixelwelder - #​1581)
- fix useSelector race condition with memoized selector when dispatching in child components useLayoutEffect as well as cDM/cDU (@​dai-shi - #​1536)
- removed a redundant object creation when using forceUpdate (@​vzaidman - #​1567)
- Rename internal forwardedRef usage (@​dtschust - #​1553)
- Show useSelector result in React DevTools (@​Finesse - #​1530)
v7.2.0
This release fixes two bugs, an algorithmic problem with unsubscribing components and a memory leak with connect
. It also has optimizations for production bundle size, and adds a couple small improvements to developer readability while debugging.
Bug Fixes
connect
in v7 is implemented using hooks, and the hooks usage captures numerous values from the surrounding scope. We received a PR informing us that the way we were capturing these values would likely result in a copy of the first version of its props being kept alive indefinitely.
This memory leak has been fixed by extracting a custom hook that receives all the necessary values as arguments, so that they're not captured via closure.
We also received a PR letting us know that the unsubscribe logic had a quadratic algorithm in it, as removing a subscriber would use an indexOf(listener)
check to remove that callback. If there were a large number of subscribers, that line's runtime would increase rapidly, causing slowdowns.
This algorithm has been replaced with tracking subscribers via a linked list, which drastically improves the runtime of this section of the code even with large numbers of subscribers.
Thanks to @​larrylin28 and @​wurstbonbon for finding these bugs and submitting PRs to fix them!
Bundle Size Improvements
We've made a number of small tweaks to the codebase to improve the ability of bundlers to shake and minimize the final included size in a bundle. The net result is that [email protected]
is smaller than 7.1.3, dropping 1.3K min and 0.6K min+gzip. (In fact, it's even smaller than the pre-hooks 7.0.0 when gzipped!)
Thanks to @​Andarist for doing most of the work on this!
Debugging Improvements
The ReactReduxContext
instance now has a displayName
set, so it should show up in the React DevTools as ReactRedux.Provider
.
Also, when an error is caught in useSelector
and re-thrown, we now append the original stack trace.
Thanks to @​pieplu and @​r3dm1ke for these!
Changes
- Fix memory leak issue with
UseEffect
(@​larrylin28 - #​1506) - Optimize createListenerCollection (@​wurstbonbon - #​1523)
- Rethrowing original errors thrown in selector functions (@​Andarist - #​1474)
- Remove invariant in favor of doing NODE_ENV checks directly (@​Andarist - #​1472)
- Wrap .propTypes and .displayName assignments with DEV check (@​Andarist - #​1471)
- Add pure annotations to help with DCE (@​timdorr -
5e0c50d
) - Inline this function. (@​timdorr -
58ae5ed
) - Add a displayName on ReactReduxContext (@​pieplu - #​1462)
v7.1.3
Forgot to remove a console
statement before I published 7.1.2. Oops!
Lint your source code before publishing, folks.
Changes
- Remove leftover console statement (@​markerikson -
30101bb
)
v7.1.2
This releases fixes a subtle timing bug with connect
and useSelector
in React Native environments, and adds the ability to pass through non-Redux-store values as a store
prop.
Fixed Store Subscriptions in React Native
Our current implementation requires cascading updates down through connected components. This is primarily done during React's "commit phase" via the useLayoutEffect
hook. Unfortunately, React warns when useLayoutEffect
is called in SSR environments, so we try to feature-detect that and fall back to useEffect
just to avoid that warning.
Unfortunately, a tweak to the feature detection conditions during the pre-7.1.0 work caused the check to accidentally fail in React Native environments. This meant that useEffect
was actually being used all the time, and this led to occasional timing bugs such as #​1313 and #​1437 . This affected the previous v7.1.x releases.
We've fixed that issue, and added additional test cases to ensure that our code works correctly under React Native.
See #​1444 for more details on the feature detection and the fix.
Passing Through Non-Store Values
connect
has always accepted passing a Redux store directly to connected components as a prop named store
(with the exception of v6). As a result, the store
prop has effectively been treated as a "reserved" prop, in much the same way that key
and ref
are "reserved" prop names handled by React.
Some users may be using the word "store" to describe their domain data, and have asked to allow variables that aren't a Redux store through the store
prop to the component (#​1393). We've finally been able to implement that capability.
Changes
- Pass non-Redux-store values through the
store
prop (@​markerikson - #​1447) - Fix RN batching and effect behavior (@​markerikson - #​1444)
- Remove unused
latestStoreState
field (@​Hypnosphi - #​1426) - Mark the react renderers as optional peer deps. (@​timdorr -
388d9e4
) - Use the same condition for checking if SSR in useSelector.js as in connectAdvanced.js (@​LeoDanielsson - #​1419)
v7.1.1
This release includes some new APIs for those that want to use a custom React Context with our Hooks API, a small memory optimization, and has a fix for when the store
changes on a Provider
with incompatible children
.
Changes
- Add
create*Hook
factory APIs (#​1309 by @​ryaninvents) - Free resources (free detached nodes from memory) (#​1380 by @​MosheZemah)
- Convert Provider into function component with hooks (#​1377 by @​mpeyper)
v7.1.0
Hooks!
After much discussion, we've decided these Hook things are probably going to stick around, so we might as well add some. Many thanks to @​MrWolfZ, @​josepot, @​perrin4869, and @​mpeyper for their contributions and to everyone else that offered feedback, ideas, and critiques as we built them out. Go open source!
Changes
- Add React Hooks (#​1248 by @​MrWolfZ)
- Add
deps
argument touseSelector
(#​1251 by @​MrWolfZ) - Use react-hooks-testing-library to test hooks (#​1259 by @​mpeyper)
- Remove
useRedux
(@​markerikson) - Remove
useActions
(@​markerikson) - Remove
deps
argument (#​1272 by @​josepot) - Replace
shallowEqual
with reference equality inuseSelector
(#​1288 by @​perrin4869) - Avoid unnecessary selector evaluations (#​1273 by @​josepot)
- Minor Hook testing improvements (#​1294 by @​MrWolfZ)
v7.0.3
This release includes a bugfix for a timing issue in connect()
, and also lowers our React peer dependency slightly to allow better usage with React Native 0.59.
Changes
- fix timing issue in component updates due to consecutive dispatches (#​1263 by @​MrWolfZ)
- Lower react peer dependency to ^16.8.3 (#​1242 by @​jeremy-deutsch)
v7.0.2
This is a bug fix release with a small performance improvement and fix for nested component unmounting.
Changes
- Memoize renderedWrappedComponent separately (#​1234 by @​vzaidman)
- Fix timing issue with setting up store subscription inside a connected component (#​1235 by @​MrWolfZ)
v7.0.1
React-Redux version 7 resolves the performance issues that were reported with version 6, and lays the groundwork for us to design and ship a public useRedux()
-type Hooks API in a later 7.x release.
The major change for this release is that connect
is now implemented using Hooks internally. Because of this, we now require a minimum React version of 16.8.4 or higher.
This release has undergone extensive performance benchmarking, and we're confident that it's the fastest version of React-Redux yet! We've also expanded our test suite to cover a number of additional use cases and scenarios.
npm install react-redux@latest
For discussion on the reasons for the major version change and the development process, see:
issue #​1177 - React-Redux Roadmap: v6, Context, Subscriptions, and Hooks.
For discussion on the possible design of a future public hooks API, see:
issue #​1179: Discussion: Potential hooks API design
Changes
This release should be public-API-compatible with version 6. The only public breaking change is the update of our React peer dependency from 16.4 to 16.8.4.
Note:
connect
now usesReact.memo()
internally, which returns a special object rather than a function. Any code that assumed React components are only functions is wrong, and has been wrong since the release of React 16.6. If you were using PropTypes to check for valid component types, you should change fromPropTypes.func
toPropTypes.elementType
instead.
Internal Changes
Direct Component Subscriptions
In v6, we switched from individual components subscribing to the store, to having <Provider>
subscribe and components read the store state from React's Context API. This worked, but unfortunately the Context API isn't as optimized for frequent updates as we'd hoped, and our usage patterns led to some folks reporting performance issues in some scenarios.
In v7, we've switched back to using direct subscriptions internally, which should improve performance considerably.
(This does result in some changes that are visible to user-facing code, in that updates dispatched in React lifecycle methods are immediately reflected in later component updates. Examples of this include components dispatching while mounting in an SSR environment. This was the behavior through v5, and is not considered part of our public API.)
Batched Updates
React has an unstable_batchedUpdates
API that it uses to group together multiple updates from the same event loop tick. The React team encouraged us to use this, and we've updated our internal Redux subscription handling to leverage this API. This should also help improve performance, by cutting down on the number of distinct renders caused by a Redux store update.
connect
Rewritten with Hooks
We've reimplemented our connect
wrapper component to use hooks internally. While it may not be visible to you, it's nice to know we can take advantage of the latest React goodies!
Public API Changes
Return of store
as a Prop
We've brought back the ability to pass a store as a prop directly to connected components. This was removed in version 6 due to internal implementation changes (components no longer subscribed to the store directly). Some users expressed concerns that working with context
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.