Update dependency @reduxjs/toolkit to v2.3.0

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
@reduxjs/toolkit (source)	2.2.3 -> 2.3.0

---

Release Notes

reduxjs/redux-toolkit (@​reduxjs/toolkit)

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 in prepareHeaders, 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 that upsertQueryData had poor performance in those cases. This is because upsertQueryData runs the full async request handling sequence, including dispatching both pending and fulfilled actions, each of which run the main reducer and update store subscribers. That means there's 2N 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 individual upsertQueryData 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 individual getPost(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:

const api = createApi({
  endpoints: (build) => ({
    getPosts: build.query<Post[], void>({
      query: () => '/posts',
      async onQueryStarted(_, { dispatch, queryFulfilled }) {
        const res = await queryFulfilled
        const posts = res.data

        // Pre-fill the individual post entries with the results
        // from the list endpoint query
        dispatch(
          api.util.upsertQueryEntries(
            posts.map((post) => ({
              endpointName: 'getPost',
              arg: { id: post.id },
              value: post,
            })),
          ),
        )
      },
    }),
    getPost: build.query<Post, Pick<Post, 'id'>>({
      query: (post) => `post/${post.id}`,
    }),
  }),
})

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 and upsertQueryEntries, see the upsertQueryEntries API reference.

prepareHeaders Options

The prepareHeaders callback for fetchBaseQuery now receives two additional values in the api argument:

• arg: the URL string or FetchArgs object that was passed in to fetchBaseQuery for this endpoint
• extraOptions: any extra options that were provided to the base query

Additional TS Types

We've added a TypedQueryStateSelector type that can be used to pre-type selectors for use with selectFromResult:

const typedSelectFromResult: TypedQueryStateSelector<
  PostsApiResponse,
  QueryArgument,
  BaseQueryFunction,
  SelectedResult
> = (state) => ({ posts: state.data?.posts ?? EMPTY_ARRAY })

function PostsList() {
  const { posts } = useGetPostsQuery(undefined, {
    selectFromResult: typedSelectFromResult,
  })
}

We've also exported several additional TS types around base queries and tag definitions.

What's Changed

• Fix serializeQueryArgs type by @​Reedgern in https://github.com/reduxjs/redux-toolkit/pull/4658
• Add the TypedQueryStateSelector helper type by @​aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4656
• Pass query args to prepareHeaders function by @​kyletsang in https://github.com/reduxjs/redux-toolkit/pull/4638
• Implement a util function to batch-upsert cache entries by @​markerikson in https://github.com/reduxjs/redux-toolkit/pull/4561
• fetchBaseQuery: expose extraOptions to prepareHeaders by @​phryneas in https://github.com/reduxjs/redux-toolkit/pull/4291

Full 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

• Export QueryExtraOptions and MutationExtraOptions by @​aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4556
• Fix mangleErrors not preserving different error types by @​aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4586
• Add the TypedUseQueryStateOptions helper type by @​aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4604
• feat(baseQuery): expose queryCacheKey in baseQuery by @​HaakonSvane in https://github.com/reduxjs/redux-toolkit/pull/4636
• Fix AbortError being triggered incorrectly on createApi endpoint timeout by @​andrejpavlovic in https://github.com/reduxjs/redux-toolkit/pull/4628
• type: export QueryReturnValue by @​hornta in https://github.com/reduxjs/redux-toolkit/pull/4640
• call initiate to refetch queries from middleware by @​phryneas in https://github.com/reduxjs/redux-toolkit/pull/4651

Full 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:

• #​1806
• #​3962
• #​3983

The error messages are typically along the lines of:

Type error: The inferred type of 'configureStore' cannot be named without a reference to '@​reduxjs/toolkit/node_modules/redux'. This is likely not portable. A type annotation is necessary.

@​aryaemami59 did some deep investigation and concluded these were due to a mixture of using interface instead of type 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 and RetryOptions, per request.

listenerMiddleware.withTypes() methods now allow passing in an ExtraArgument generic.

What's Changed

• Fix: TypeScript Type Portability Issues by @​aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4467
• Export UpdateDefinitions from toolkit/query by @​joekrill in https://github.com/reduxjs/redux-toolkit/pull/4519
• feat: Adds ExtraArgument to withTypes for listenerMiddleware. by @​antondalgren in https://github.com/reduxjs/redux-toolkit/pull/4517
• Improve treeshakeability of build artifacts by @​aryaemami59 in https://github.com/reduxjs/redux-toolkit/pull/4435
• Export RetryOptions by @​markerikson in https://github.com/reduxjs/redux-toolkit/pull/4529

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

• Fix missed spot where use of current may fail if the value is not a draft by @​markerikson in https://github.com/reduxjs/redux-toolkit/pull/4412

Full Changelog: reduxjs/redux-toolkit@v2.2.4...v2.2.5

v2.2.4

Compare Source

---

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 was generated by Mend Renovate. View the repository job log.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 47.26%. Comparing base (d39185f) to head (9759169).

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #35   +/-   ##
=======================================
  Coverage   47.26%   47.26%           
=======================================
  Files          71       71           
  Lines        1794     1794           
  Branches       48       48           
=======================================
  Hits          848      848           
  Misses        944      944           
  Partials        2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.