-
Notifications
You must be signed in to change notification settings - Fork 0
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.
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
Update Major Updates (major) #29
base: main
Are you sure you want to change the base?
Conversation
❌ Deploy Preview for sir-david-attenbowwow failed.
|
f280138
to
2ee59c7
Compare
2ee59c7
to
1651663
Compare
1651663
to
506fbc5
Compare
⚠ Artifact update problemRenovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is. ♻ Renovate will retry this branch, including artifacts, only when one of the following happens:
The artifact failure details are included below: File name: package-lock.json
|
506fbc5
to
750a1c3
Compare
750a1c3
to
a80748b
Compare
|
a80748b
to
e8caa39
Compare
e8caa39
to
6fd0ffb
Compare
bcd4bc2
to
1c29d30
Compare
1c29d30
to
93e2de7
Compare
98e1ad1
to
a766871
Compare
d73f6da
to
4b33e3f
Compare
4b33e3f
to
bda0d18
Compare
bda0d18
to
57a71ea
Compare
This PR contains the following updates:
^1.8.2
->^2.0.0
^14.0.0
->^16.0.0
^8.0.0
->^9.0.0
^8.53.0
->^9.0.0
^9.0.0
->^10.0.0
^8.0.0
->^9.0.0
21.2.0
->22.14.0
^18.2.0
->^19.0.0
^18.2.0
->^19.0.0
^4.4.0
->^5.0.0
^8.0.2
->^9.0.0
^6.0.0
->^7.0.0
^4.2.0
->^5.0.0
^3.0.0
->^4.0.0
Release Notes
reduxjs/redux-toolkit (@reduxjs/toolkit)
v2.5.1
Compare Source
This bugfix release fixes a logic issue with the new
upsertQueryEntries
util that sometimes kept entries in apending
state indefinitely.Changelog
upsertQueryEntries
fixesUsers reported that in some cases, use of
upsertQueryEntries
to insert RTKQ cache entries prevented any further refetches of that data from happening. After investigation, we found a logic mismatch for how we handle upserts vs the existingupsertQueryData
util, which meant that sometimes the entry would be left in apending
state expecting afulfilled
action from a request ID that would never happen.This release fixes that issue and ensures the updates and refetches happen correctly.
What's Changed
Full Changelog: reduxjs/redux-toolkit@v2.5.0...v2.5.1
v2.5.0
Compare Source
This feature release updates the React peer dependency to work with React 19, and fixes an additional skip token issue.
Changelog
React 19 Compat
React 19 was just released! We've updated our peer dep to accept React 19, and updated our runtime and type tests to check against both React 18 and 19.
Also see React-Redux v9.2.0 for the same peer dep update.
Other Fixes
We previously fixed an issue with the RTKQ core where
serializeQueryArgs
callbacks could be called withskipToken
, potentially leading to errors. We've fixed an additional location in theuseQuery
hooks where that could happen as well.What's Changed
serializeQueryArgs
+skipToken
case by @markerikson in https://github.com/reduxjs/redux-toolkit/pull/4762Full Changelog: reduxjs/redux-toolkit@v2.4.0...v2.5.0
v2.4.0
Compare Source
This feature release includes multiple tweaks and fixes to RTK Query functionality, additional exported TS types, and drops support for TS versions earlier than 5.0.
Changelog
RTK Query Improvements
Lazy query hooks can now be reset.
retry.fail
now acceptsmeta
as a second argument.Tag invalidation arrays now ignore nullish values.
We did some small internal refactoring around Maps and default values that shrank bundle size slightly.
Bugfixes
Passing
skipToken
to a query hook now bails out before running any other logic, which fixes cases whereserializeQueryArgs
previously threw an error because there were no args to process.The
autoBatchEnhancer
now readswindow.requestAnimationFrame
later, which it to work properly with Jest fake timers.We fixed cases where the hook result
isSuccess
flag would briefly flicker tofalse
when switched to a different cache entry that was uninitialized, and would briefly flicker totrue
when refetching a query that previously errored.The listener middleware previously had inconsistent logic checks for comparing against existing listener entries (effect + type, vs effect only). It now always checks both effect + type.
Additional TS Types
We now export
Typed[Query|Mutation]OnQueryStarted
helpers to let you defineonQueryStarted
callbacks outside ofcreateApi
if desired.We also now export a
CreateAsyncThunkFunction
type that can be used to type userland wrappers aroundcreateAsyncThunk
.TS Support Matrix Updates
We've historically tried to maintain TS backwards compatibility as long as possible, and made occasional updates to our TS support matrix in minor versions over time. As of RTK 2.3.0, we officially supported back through TS 4.7.
As of this release, we're tweaking that support policy to match the policy used by DefinitelyTyped:
Given that, we've dropped official support for TS versions earlier than 5.0. (RTK may work with those versions, but we no longer test against them and won't try to fix issues with those versions.)
We'll continue to update our TS support matrix over time based on that 2-year rolling window.
What's Changed
window.rAF
later to allow fake timers to work correctly by @ensconced in https://github.com/reduxjs/redux-toolkit/pull/4701OnQueryStarted
callbacks by @aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4713createAsyncThunk
without thewithTypes
method by @EskiMojo14 in https://github.com/reduxjs/redux-toolkit/pull/4667isSuccess: true
when switching to an uninitialized cache entry by @markerikson in https://github.com/reduxjs/redux-toolkit/pull/4731isSuccess
consistent when refetching after an error by @markerikson in https://github.com/reduxjs/redux-toolkit/pull/4732Full Changelog: reduxjs/redux-toolkit@v2.3.0...v2.4.0
v2.3.0
Compare Source
This feature release adds a new RTK Query
upsertQueryEntries
util to batch-upsert cache entries more efficiently, passes through additional values for use inprepareHeaders
, and exports additional TS types around query options and selectors.Changelog
upsertQueryEntries
RTK Query already had an
upsertQueryData
thunk that would upsert a single cache entry. However, some users wanted to upsert many cache entries (potentially hundreds or thousands), and found thatupsertQueryData
had poor performance in those cases. This is becauseupsertQueryData
runs the full async request handling sequence, including dispatching bothpending
andfulfilled
actions, each of which run the main reducer and update store subscribers. That means there's2N
store / UI updates per item, so upserting hundreds of items becomes extremely perf-intensive.RTK Query now includes an
api.util.upsertQueryEntries
action that is meant to handle the batched upsert use case more efficiently. It's a single synchronous action that accepts an array of many{endpointName, arg, value}
entries to upsert. This results in a single store update, making this vastly better for performance vs many individualupsertQueryData
calls.We see this as having two main use cases. The first is prefilling the cache with data retrieved from storage on app startup (and it's worth noting that
upsertQueryEntries
can accept entries for many different endpoints as part of the same array).The second is to act as a "pseudo-normalization" tool. RTK Query is not a "normalized" cache. However, there are times when you may want to prefill other cache entries with the contents of another endpoint, such as taking the results of a
getPosts
list endpoint response and prefilling the individualgetPost(id)
endpoint cache entries, so that components that reference an individual item endpoint already have that data available.Currently, you can implement the "pseudo-normalization" approach by dispatching
upsertQueryEntries
in an endpoint lifecycle, like this:Down the road we may add a new option to query endpoints that would let you provide the mapping function and have it automatically update the corresponding entries.
For additional comparisons between
upsertQueryData
andupsertQueryEntries
, see theupsertQueryEntries
API reference.prepareHeaders
OptionsThe
prepareHeaders
callback forfetchBaseQuery
now receives two additional values in theapi
argument:arg
: the URL string orFetchArgs
object that was passed in tofetchBaseQuery
for this endpointextraOptions
: any extra options that were provided to the base queryAdditional TS Types
We've added a
TypedQueryStateSelector
type that can be used to pre-type selectors for use withselectFromResult
:We've also exported several additional TS types around base queries and tag definitions.
What's Changed
TypedQueryStateSelector
helper type by @aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4656Full Changelog: reduxjs/redux-toolkit@v2.2.8...v2.3.0
v2.2.8
Compare Source
This bugfix release fixes a long-standing issue with RTK Query lazy query triggers returning stale data in some cases, fixes an error handling issue in RTK Query, and exports additional TS types.
Changelog
Lazy Query Trigger Handling
We'd had a couple long-standing issues reporting that
const result = await someLazyQueryTrigger()
sometimes returned stale data, especially if a mutation had just invalidated that query's tag.We finally got a good repro of this issue and identified it as a mis-written call inside of the middleware that skipped past the necessary handling to activate the correct query status tracking in that scenario. This should now be fixed.
Other Changes
Timeout handling in RTKQ endpoints should now correctly throw a timeout-related error instead of an
AbortError
.Base queries now have access to the current
queryCacheKey
value so it can be used in deciding query logic.We've exported several more TS types related to query options, as some users have been depending on those even though they previously weren't part of the public API.
What's Changed
QueryExtraOptions
andMutationExtraOptions
by @aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4556mangleErrors
not preserving different error types by @aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4586TypedUseQueryStateOptions
helper type by @aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4604AbortError
being triggered incorrectly oncreateApi
endpoint timeout by @andrejpavlovic in https://github.com/reduxjs/redux-toolkit/pull/4628initiate
to refetch queries from middleware by @phryneas in https://github.com/reduxjs/redux-toolkit/pull/4651Full Changelog: reduxjs/redux-toolkit@v2.2.7...v2.2.8
v2.2.7
Compare Source
This bugfix release fixes issues with "TS type portability" errors, improves build artifact tree shaking behavior, and exports some additional TS types.
Changelog
TS Type Portability
We've had a slew of issues reported around "TS type portability" errors, such as:
The error messages are typically along the lines of:
@aryaemami59 did some deep investigation and concluded these were due to a mixture of using
interface
instead oftype
in most places, not pre-bundling our TS typedefs, and not exporting some of the unique symbols we use internally.Arya put together a highly detailed writeup and set of fixes in #4467: Fix: TypeScript Type Portability Issues, and that appears to resolve all of those issues we've seen. Thank you!
Other Changes
Arya also did significant work to improve RTK's treeshaking, tweaking internal definitions to let bundlers better separate out unused code.
We've exported additional types like
UpdateDefinitions
andRetryOptions
, per request.listenerMiddleware.withTypes()
methods now allow passing in anExtraArgument
generic.What's Changed
Full Changelog: reduxjs/redux-toolkit@v2.2.6...v2.2.7
v2.2.6
Compare Source
v2.2.5
Compare Source
This bugfix release fixes an issue in the recent
createEntityAdapter
sorting perf improvements that could (in specific cases) cause Immer to throw an error when trying to read a plain JS value instead of a proxy-wrapped value.What's Changed
current
may fail if the value is not a draft by @markerikson in https://github.com/reduxjs/redux-toolkit/pull/4412Full Changelog: reduxjs/redux-toolkit@v2.2.4...v2.2.5
v2.2.4
Compare Source
v2.2.3
Compare Source
This minor release fixes the types for functions that accept a React Context instance to match the changes in React Redux v9.
What's Changed
.withTypes
by @aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4308Full Changelog: reduxjs/redux-toolkit@v2.2.2...v2.2.3
v2.2.2
Compare Source
This patch release fixes an incorrect build setting for the
legacy-esm
artifacts, and fixes an issue with RTKQ query hooks didn't always remove the cache entries if arguments were changed rapidly.Changes
legacy-esm
Artifact TranspilationThe
legacy-esm
build artifacts are intended for use by Webpack 4. Those were supposed to be transpiled to target"es2017"
, but were in fact still set to target"esnext"
- an oversight during the 2.0 development cycle. This release fixes that setting, so those artifacts are now correctly transpiled.Other Fixes
RTKQ query hooks now handle additional actions around argument changes that should result in cache entries being removed.
Additionally, 2.2.1 contained a fix to an incorrectly named type:
TypedUseMutationTrigger
is nowTypedMutationTrigger
.What's Changed
Full Changelog: reduxjs/redux-toolkit@v2.2.0...v2.2.2
v2.2.1
Compare Source
v2.2.0
Compare Source
This minor release:
entityAdapter.getInitialState(additionalProps, entities)
to allow prefilling stateentityAdapter.setAll(entityAdapter.getInitialState(additionalProps), entities)
undefined
if no additional properties are desiredcombineSlices
with no static reducersconst combinedReducer = combineSlices().withLazyLoadedSlices<LazyLoadedSlices>()
would have thrown an error'throw'
value foroverrideExisting
ininjectEndpoints
, which throws an error if a definition is injected with a name which is already usedenhanceEndpoints
LazyLoadedSlices
)action.meta.arg.isPrefetch
value to query thunk actions when prefetchedWhat's Changed
cli.js
tocli.mjs
by @aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4169withLazyLoadedSlices
by @aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4172overrideExisting
by @ffluk3 in https://github.com/reduxjs/redux-toolkit/pull/4189tsconfig.json
files of all CodesandBox examples by @aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4190New Contributors
Full Changelog: reduxjs/redux-toolkit@v2.1.0...v2.2.0
v2.1.0
Compare Source
This minor release:
listenerMiddleware
andcreateDraftSafeSelector
skipPollingIfUnfocused
option to RTK QuerycreateSelector
instance used by RTK Querythis
valuecreate.asyncThunk
type parametersqueryFn
sWhat's Changed
listenerMiddleware.withTypes<RootState, AppDispatch>()
method by @aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4049.withTypes
tocreateDraftSafeSelector
by @aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4080this
in createSlice by @EskiMojo14 in https://github.com/reduxjs/redux-toolkit/pull/4071tsconfig.typetests.json
to include all TS files by @aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4091composeWithDevTools
spy by @aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4093New Contributors
Full Changelog: reduxjs/redux-toolkit@v2.0.1...v2.1.0
v2.0.1
Compare Source
v2.0.0
Compare Source
This major release :
createSlice
andcreateReducer
middleware
andenhancers
options ofconfigureStore
to require callbackscombineSlices
method with support for lazy-loading slice reducerscreateSlice.reducers
, with optional support for defining thunks inside ofcreateSlice
autoBatchEnhancer
toconfigureStore
by defaultThis release has breaking changes. (Note: v2.0.1 was released with a couple hotfixes for Reselect and Redux Thunk right as this was being finalized.)
This release is part of a wave of major versions of all the Redux packages: Redux Toolkit 2.0, Redux core 5.0, React-Redux 9.0, Reselect 5.0, and Redux Thunk 3.0.
For full details on all of the breaking changes and other significant changes to all of those packages, see the "Migrating to RTK 2.0 and Redux 5.0" migration guide in the Redux docs.
Changelog
Object syntax for
createSlice.extraReducers
andcreateReducer
removedRTK's
createReducer
API was originally designed to accept a lookup table of action type strings to case reducers, like{ "ADD_TODO": (state, action) => {} }
. We later added the "builder callback" form to allow more flexibility in adding "matchers" and a default handler, and did the same forcreateSlice.extraReducers
.We have removed the "object" form for both
createReducer
andcreateSlice.extraReducers
in RTK 2.0, as the builder callback form is effectively the same number of lines of code, and works much better with TypeScript.As an example, this: