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 v7 - autoclosed #8

Closed
wants to merge 1 commit into from
Closed

Update dependency react-redux to v7 - autoclosed #8

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented Mar 4, 2020 •
edited
Loading

WhiteSource Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
react-redux 4.0.0 -> 7.2.6 age adoption passing confidence

Release Notes

reduxjs/react-redux

v7.2.6

Compare Source

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

Compare Source

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

v7.2.4

Compare Source

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

v7.2.3

Compare Source

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

v7.2.2

Compare Source

This release allows you to use React Redux with React 17 without a warning when installing. That's about it.

Changes

v7.2.1

Compare Source

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 named forwardedRef
  • Fixed a typo in a useSelector error message

Changes

v7.2.0

Compare Source

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 react-redux@7.2.0 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

v7.1.3

Compare Source

Forgot to remove a console statement before I published 7.1.2. Oops!

Lint your source code before publishing, folks.

Changes

v7.1.2

Compare Source

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

v7.1.1

Compare Source

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

v7.1.0

Compare Source

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

v7.0.3

Compare Source

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

v7.0.2

Compare Source

This is a bug fix release with a small performance improvement and fix for nested component unmounting.

Changes

v7.0.1

Compare Source

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 uses React.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 from PropTypes.func to PropTypes.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 in unit tests was not sufficient. Since our components use direct subscriptions again, we've reimplemented this option, and that should resolve those concerns.

New batch API for Batched React Updates

React's unstable_batchedUpdate() API allows any React updates in an event loop tick to be batched together into a single render pass. React already uses this internally for its own event handler callbacks. This API is actually part of the renderer packages like ReactDOM and React Native, not the React core itself.

Since React-Redux needs to work in both ReactDOM and React Native environments, we've taken care of importing this API from the correct renderer at build time for our own use. We also now re-export this function publicly ourselves, renamed to batch(). You can use it to ensure that multiple actions dispatched outside of React only result in a single render update, like this:

import { batch } from "react-redux";

function myThunk() {
    return (dispatch, getState) => {
        // should only result in one combined re-render, not two
        batch(() => {
            dispatch(increment());
            dispatch(increment());
        })
    }
}

If you are using an alternative React renderer, like the Ink CLI renderer, that method isn't available for us to import. In that case, you will need to change your code to import from the new react-redux/es/alternate-renderers entry point instead. (Use react-redux/lib/alternate-renderers for the CJS version). That entry point exports a no-op version of batch() that just executes the callback immediately, and does not provide React batching.

In that situation, you may want to consider aliasing react-redux to one of those alternate entry points in your build tool for the best compatibility, especially if you're using any other libraries that depend on React-Redux.

Note: v7.0.1 is identical code-wise to v7.0.0 . The extra patch release was to update the React requirement listed in the README.

Contributors

Thanks to:

v7.0.0

Compare Source

Initial release, but we missed some updated docs. Ignore this 😄

v6.0.1

Compare Source

This is a minor release with support for react-hot-loader and a few small bug fixes for edge cases.

While you're here, please stop by #​1177 to see our roadmap for the next versions of React Redux. We are aware that performance is not so hot in 6.0. Short version: We put too much traffic on React's context API, which isn't really designed for high levels of reads and writes. We're looking to reduce that load and get performance back on track in a minor release, so there won't be backwards compatibility concerns. We have a new extensive benchmark suite to keep us on track and ensure we're not regressing on speed in the future.

And yes, we know about Hooks. Check out #​1179.

Changes

v6.0.0

Compare Source

🎉 This is our first big release supporting the new Context API added in React 16.4!

As such, we now require React 16.4 or higher. Make sure to update your version when updating to this release.

This work has been mostly lead by @​cellog and @​markerikson, with special guest appearances by yours truly and a whole cast of helpful reviewers.

Note: If you'd like to know more about the changes in v6, and how the implementation has changed over time, see Mark's post Idiomatic Redux: The History and Implementation of React-Redux.

Breaking Changes

  • The withRef option to connect has been replaced with forwardRef. If {forwardRef : true} has been passed to connect, adding a ref to the connected wrapper component will actually return the instance of the wrapped component.

  • Passing store as a prop to a connected component is no longer supported. Instead, you may pass a custom context={MyContext} prop to both <Provider> and <ConnectedComponent>. You may also pass {context : MyContext} as an option to connect.

Behavior Changes

Any library that attempts to access the store instance out of legacy context will break, because we now put the store state into a <Context.Provider> instead. Examples of this include connected-react-router and react-redux-subspace. (The current implementation does also put the store itself into that same context. While accessing the store in context is not part of our public API, we will still try to make it possible for other libraries to access it, with the understanding that this could break at any time.)

Also, there is a behavior change around dispatching actions in constructors / componentWillMount. Previously, dispatching in a parent component's constructor would cause its children to immediately use the updated state as they mounted, because each component read from the store individually. In version 6, all components read the same current store state value from context, which means the tree will be consistent and not have "tearing". This is an improvement overall, but there may be applications that relied on the existing behavior.

Changes

v5.1.2

Compare Source

v5.1.1

Compare Source

  • Upgrade hoist-non-react-statics to deal with contextType (by @​timdorr)
  • Treat null as a valid plain object prototype in isPlainObject() (#​1075 by @​rgrove)

v5.1.0

Compare Source

The biggest fix is for connect() being used with React's newer forwardRef, memo, and lazy APIs.

We also have begun a complete rewrite of our docs for React Redux. Check them out! Many thanks to those who contributed: @​markerikson, @​sveinpg, @​wgao19, @​BTMPL, @​pyliaorachel, @​dagstuan, @​Kerumen, and @​carloluis (sorry if I forgot someone!). Docs are a great way to get started contributing to open source, so open a PR today! Check #​1001 to see what else needs to be done.

We're also looking at overhauling Redux's documentation. Check out reduxjs/redux#​2590 for the latest there.

Changes

v5.0.7

Compare Source

v5.0.6

Compare Source

  • Persist child listeners through hot reload (#​715 by @​dsgkirkby)
  • Update hoist-non-react-statics to 2.x (#​759 by @​danez)
  • Move ref context binding to fix object freezing middleware (#​733 by @​gpoitch)
  • Remove explicit Provider.displayName in favor of the inferred name (#​728 by @​Andarist)
  • Move create-react-class back to devDependencies
  • Switch build process back to npm@5

v5.0.5

Compare Source

v5.0.4

Compare Source

v5.0.3

Compare Source

v5.0.2

Compare Source

v5.0.1

Compare Source

  • Use the correct filename for the UMD build. It is now properly published as dist/react-redux.js and dist/react-redux.min.js.
  • Fix HMR error #​513 (#​567 by @​jimbolla)

v5.0.0

Compare Source

This release is brought to you by contributions from the following people: @​jimbolla, @​vhmth, @​btd, @​roncohen, @​ynonp, and @​appden. In addition, there were many non-code contributions in discussions on issues and testing the alpha, beta, and rc versions by many other folks (too many to list!). Thank you to everyone who made this a very positive, inclusive, well-critiqued, community-driven release!

TL;DR

  • Backwards compatible API
  • Major internal changes
  • Significant performance improvements in common usage patterns
  • Bugs fixed
  • Additional features added to connect()
  • New connectAdvanced() API
  • What's next?
API Compatibility

Version 5.0 maintains API compatibility with v4.x but due to major internal changes and potential behavior differences across nearly all API surfaces, semver dictates a major version bump. Also, it's good marketing! 💰 Store state change notifications sent to components are now guaranteed to occur top-down, so if your code may behave differently if it relied on notifications happening out of order.

Internal Changes

Internally, the code for connect has been rewritten from the ground-up to be more modular, with the intention of greater maintainability and extensibility. This has also led to some new features and performance improvements.

Performance improvements

Significant performance gains were achieved by avoiding extra calls to setState() and render() by ensuring the order of change notifications to occur top-down, matching React's natural flow. Performance tests and benchmarks are discussed in #​416.

Bugfixes

Some bugs/issues are resolved, related to performance loss and also impure components not re-rendering.

New features added to connect()

The behavior of connect() is now more customizable, by passing additional properties in the options arg. These will be described in the API docs.

New top level API: connectAdvanced()

The new implementation of connect() splits its behavior such that it is now a wrapper around a more-generalized connectAdvanced(). This connectAdvanced() method can be called directly if you have extreme performance needs or want to craft an API different than that of connect(). This will be described in the API docs.

What's next?

We're looking at removing the shouldComponentUpdate optimization. Since this version is much more performant on its own, that isn't needed. This will fix long-standing problems with other libraries that use React's context API. There are workarounds, but things should work without either library authors having to bend over backwards or React having to make API changes.

We will accept bugfixes on the 4.x branch (the 3.x branch will be going away; but the tags to 3.x versions will remain!), but new features should be built against the next branch. We love PRs, so keep them coming!

v4.4.10

Compare Source

  • Update hoist-non-react-statics to 3.x

v4.4.9

Compare Source

  • Update hoist-non-react-statics to 2.x

v4.4.8

Compare Source

v4.4.7

Compare Source

v4.4.6

Compare Source

  • Update React peer dependency to allow React 15.4.0 RC

v4.4.5

Compare Source

  • Fixes a regression introduced in 4.4.4 where cleaning up the state in parent’s componentWillUnmount caused an error in child’s mapStateToProps (#​351, ea53d6f)

v4.4.4

Compare Source

v4.4.3

Compare Source

  • State shape warning now has a more descriptive message (#​335, #​309)
  • State shape check is now a warning rather than a hard error, and is disabled in production for better performance (90f427b)

v4.4.2

Compare Source

  • Custom mergeProps now works correctly with components that have pure: false (#​337, #​338)

v4.4.1

Compare Source

v4.4.0

Compare Source

  • Removes the broken jsnext:main. It is supposed to point to the ES module build but we mistakingly pointed it to the src, so it never worked for anyone anyway. For now, we don’t provide an ES module build in React Redux, so if you use Rollup, you need to use the CommonJS plugin for it. Realistically, it doesn’t make a big difference because React Redux assumes you use React anyway (which uses CommonJS), and it also doesn’t benefit from tree shaking because there are only two exports (connect and <Provider>) and you will need both pretty much any time.

This is a minor bump because we couldn’t break anybody with this (it was broken before), but it seems to deserve more than a patch bump as it’s a change in the build configuration.

v4.3.0

Compare Source

  • Adds per-instance memoization API. If your mapStateToProps or mapDispatchToProps returns a function, that function will be used instead for the given component instance. Most apps never need this, but it can be handy for custom memoization logic in apps with large component trees. It can bring significant performance improvements when used together with Reselect. (#​279, 7ee928b, #​179)

v4.2.1

Compare Source

v4.2.0

Compare Source

  • isPlainObject that we use internally is now outsourced to Lodash 4.1 (rackt/redux#​1339). Note that this does not mean we depend on Lodash itself. We only use a tiny module from it. We also use the same module in Redux >= 3.2.0.

v4.1.2

Compare Source

v4.1.1

Compare Source

  • Adds loose-envify as a dependency to fix builds for Browserify users. (#​1304 & #​1306)

v4.1.0

Compare Source

  • For Browserify users, Redux should now be properly envified without extra configuration (#​274)

v4.0.6

Compare Source

v4.0.5

Compare Source

v4.0.4

Compare Source

v4.0.3

Compare Source

v4.0.2

Compare Source

v4.0.1

Compare Source

  • Removes .babelrc in the compiled package beca

Configuration

📅 Schedule: 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, click this checkbox.

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

@renovate renovate bot force-pushed the renovate/react-redux-7.x branch from 61970bf to 75a20eb Compare August 24, 2020 17:00
@renovate renovate bot force-pushed the renovate/react-redux-7.x branch from 17a6877 to 7ba25b8 Compare April 26, 2021 17:01
@renovate renovate bot force-pushed the renovate/react-redux-7.x branch from 196a31e to d22bc2e Compare March 7, 2022 08:34
@renovate renovate bot changed the title Update dependency react-redux to v7 Update dependency react-redux to v7 - autoclosed Apr 25, 2022
@renovate renovate bot closed this Apr 25, 2022
@renovate renovate bot deleted the renovate/react-redux-7.x branch April 25, 2022 01:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@renovate-bot