connect: pass ownProps to areStatesEqual #1952
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 81d2296:
|
✅ Deploy Preview for react-redux-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
Ping, @markerikson & @timdorr can you take a look at this PR? |
timdorr
approved these changes
Aug 31, 2022
kathaypacific
referenced
this pull request
in valora-inc/wallet
Jan 24, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [react-redux](https://github.com/reduxjs/react-redux) | [`^7.2.0` -> `^7.2.9`](https://renovatebot.com/diffs/npm/react-redux/7.2.0/7.2.9) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>reduxjs/react-redux</summary> ### [`v7.2.9`](https://github.com/reduxjs/react-redux/releases/tag/v7.2.9) [Compare Source](https://github.com/reduxjs/react-redux/compare/v7.2.8...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: ```ts { areStatesEqual?: ( nextState: State, prevState: State, nextOwnProps: TOwnProps, prevOwnProps: TOwnProps ) => boolean } ``` #### What's Changed - connect: pass ownProps to areStatesEqual by [@​jspurlin](https://github.com/jspurlin) in [https://github.com/reduxjs/react-redux/pull/1952](https://github.com/reduxjs/react-redux/pull/1952) **Full Changelog**: reduxjs/react-redux@v7.2.8...v7.2.9 ### [`v7.2.8`](https://github.com/reduxjs/react-redux/releases/tag/v7.2.8) [Compare Source](https://github.com/reduxjs/react-redux/compare/v7.2.7...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!](https://github.com/reduxjs/react-redux/releases/tag/v8.0.0-beta.3)**. 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](https://github.com/reduxjs/react-redux/issues/1740#issuecomment-1085190240), 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**: reduxjs/react-redux@v7.2.7...v7.2.8 ### [`v7.2.7`](https://github.com/reduxjs/react-redux/releases/tag/v7.2.7) [Compare Source](https://github.com/reduxjs/react-redux/compare/v7.2.6...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!](https://github.com/reduxjs/react-redux/releases/tag/v8.0.0-beta.3)**. 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`](https://github.com/reduxjs/react-redux/releases/tag/v7.2.6) [Compare Source](https://github.com/reduxjs/react-redux/compare/v7.2.5...v7.2.6) Just a quick fix for a Yarn install warning. Sorry about the noise! #### [Changes](https://github.com/reduxjs/react-redux/compare/v7.2.5...v7.2.6) - Remove `workspaces` from our package.json to silence a Yarn warning ([@​timdorr](https://github.com/timdorr)) ### [`v7.2.5`](https://github.com/reduxjs/react-redux/releases/tag/v7.2.5) [Compare Source](https://github.com/reduxjs/react-redux/compare/v7.2.4...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](https://github.com/reactwg/react-18/discussions/4), 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](https://github.com/reduxjs/react-redux/issues/1737), and are [prototyping compatibility implementation updates](https://github.com/reduxjs/react-redux/pull/1808). 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](https://github.com/reduxjs/react-redux/issues/1811) - [@​markerikson](https://github.com/markerikson)) - Update v7 branch to use Yarn v2 and improve CI process ([#​1810](https://github.com/reduxjs/react-redux/issues/1810) - [@​markerikson](https://github.com/markerikson)) - Reduce unnecessary calls to useSelector selector ([#​1803](https://github.com/reduxjs/react-redux/issues/1803) - [@​sufian-slack](https://github.com/sufian-slack) ) - Port Subscription closure implementation from 8.x to 7.x ([#​1809](https://github.com/reduxjs/react-redux/issues/1809) - [@​mbelsky](https://github.com/mbelsky)) ### [`v7.2.4`](https://github.com/reduxjs/react-redux/releases/tag/v7.2.4) [Compare Source](https://github.com/reduxjs/react-redux/compare/v7.2.3...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](https://github.com/reduxjs/react-redux/issues/1709) - [@​xty](https://github.com/xty)) - Verify that selector and equalityF of useSelector are functions ([#​1706](https://github.com/reduxjs/react-redux/issues/1706) - [@​gshilin](https://github.com/gshilin)) - Import bindActionCreators from redux ([#​1705](https://github.com/reduxjs/react-redux/issues/1705) - [@​timdorr](https://github.com/timdorr)) - Don't re-run the selector after update ([#​1701](https://github.com/reduxjs/react-redux/issues/1701) - [@​timdorr](https://github.com/timdorr)) ### [`v7.2.3`](https://github.com/reduxjs/react-redux/releases/tag/v7.2.3) [Compare Source](https://github.com/reduxjs/react-redux/compare/v7.2.2...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](https://github.com/reduxjs/react-redux/issues/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](https://redux.js.org/tutorials/fundamentals/part-5-ui-react). #### Changelog - Automatically install [@​types/react-redux](https://github.com/types/react-redux) as a dependency ([#​1699](https://github.com/reduxjs/react-redux/issues/1699) - [@​markerikson](https://github.com/markerikson) ) - Reuse latest selected state on selector re-run ([#​1654](https://github.com/reduxjs/react-redux/issues/1654)) ([#​1660](https://github.com/reduxjs/react-redux/issues/1660) - [@​otakustay](https://github.com/otakustay)) - Use useIsomorphicLayoutEffect in Provider for consistency ([#​1683](https://github.com/reduxjs/react-redux/issues/1683) - [@​speakingcode](https://github.com/speakingcode) ) ### [`v7.2.2`](https://github.com/reduxjs/react-redux/releases/tag/v7.2.2) [Compare Source](https://github.com/reduxjs/react-redux/compare/v7.2.1...v7.2.2) This release allows you to use React Redux with React 17 without a warning when installing. That's about it. #### [Changes](https://github.com/reduxjs/react-redux/compare/v7.2.1...v7.2.2) - Upgrade react peer dependency to v17 ([#​1647](https://github.com/reduxjs/react-redux/issues/1647) by [@​wachunei](https://github.com/wachunei)) ### [`v7.2.1`](https://github.com/reduxjs/react-redux/releases/tag/v7.2.1) [Compare Source](https://github.com/reduxjs/react-redux/compare/v7.2.0...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](https://reactjs.org/docs/hooks-reference.html#usedebugvalue) 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 named `forwardedRef` - Fixed a typo in a `useSelector` error message #### [Changes](https://github.com/reduxjs/react-redux/compare/v7.2.0...v7.2.1) - Fix error message typo in useSelector ('You must pass a selector...). ([@​Pixelwelder](https://github.com/Pixelwelder) - [#​1581](https://github.com/reduxjs/react-redux/issues/1581)) - fix useSelector race condition with memoized selector when dispatching in child components useLayoutEffect as well as cDM/cDU ([@​dai-shi](https://github.com/dai-shi) - [#​1536](https://github.com/reduxjs/react-redux/issues/1536)) - removed a redundant object creation when using forceUpdate ([@​vzaidman](https://github.com/vzaidman) - [#​1567](https://github.com/reduxjs/react-redux/issues/1567)) - Rename internal forwardedRef usage ([@​dtschust](https://github.com/dtschust) - [#​1553](https://github.com/reduxjs/react-redux/issues/1553)) - Show useSelector result in React DevTools ([@​Finesse](https://github.com/Finesse) - [#​1530](https://github.com/reduxjs/react-redux/issues/1530)) </details> --- ### 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. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/valora-inc/wallet). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMDUuNCIsInVwZGF0ZWRJblZlciI6IjM0LjEwNS40In0=--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the ability for consumers to have access to ownProps inside of areStatesEqual.
Currently there is no way to
See: #781