Ensure upserted cache entries always get written

[markerikson]

This PR:

• Fixes a bug with upsertQueryEntries where updates to an existing cache entry would not actually get completed, leaving the entry in an incorrect pending state indefinitely

Fixes #4749

Investigation

Made a Replay that shows the repro in action:

• https://app.replay.io/recording/rtk-query-4749-repro-upsertqueryentries--08eb2b78-7fc9-4b3a-b9fb-0a944f587fd7

Looks like there was a small flaw in the logic. We already had a check for the fulfilled case that bails out of writing the result if substate.requestId !== meta.requestId, so that we don't end up with conflicting request results being written. However, it also had a check for the older forced upsert logic as well, and it wasn't accounting for this newer approach.

Meanwhile, the pending logic actually keeps around the existing request ID:

      substate.requestId =
        upserting && substate.requestId
          ? // for `upsertQuery` **updates**, keep the current `requestId`
            substate.requestId
          : // for normal queries or `upsertQuery` **inserts** always update the `requestId`
            meta.requestId

So, what was happening was roughly:

• Actual request for ID 2 resolves
• fulfilled action for ID 2 is written, with its request ID
• upsertQueryEntries for ID 2 is dispatched
• Inside the reducer:
  • pending write logic for the upsert sees there's an existing entry, and keeps the old request ID from the actual API response, instead of overwriting it with the fake request ID from the upsert
  • Immediately after that, the fulfilled write logic for the upsert tries to update the entry... but the existing and incoming request IDs don't match, and it wasn't being detected as a forced upsert because that logic only was checking for the older upsertQueryData approach

and so we're left with the existing entry, updated to be in a pending state, and without the upserted data written and marked as fulfilled.

[codesandbox]

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

[netlify]

✅ Deploy Preview for redux-starter-kit-docs ready!

Name	Link
🔨 Latest commit	e101ec6
🔍 Latest deploy log	https://app.netlify.com/sites/redux-starter-kit-docs/deploys/675d25de7e73310008f0d409
😎 Deploy Preview	https://deploy-preview-4768--redux-starter-kit-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[codesandbox-ci]

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

Sandbox	Source
@examples-query-react/basic	Configuration
@examples-query-react/advanced	Configuration
@examples-action-listener/counter	Configuration
rtk-esm-cra	Configuration

[github-actions]

size-limit report 📦

Path	Size
1. entry point: @reduxjs/toolkit/query/react (modern.mjs)	13.55 KB (-0.02% 🔽)
1. entry point: @reduxjs/toolkit/query (cjs, production.min.cjs)	22.43 KB (+0.19% 🔺)
1. entry point: @reduxjs/toolkit/query/react (cjs, production.min.cjs)	24.51 KB (+0.17% 🔺)
2. entry point: @reduxjs/toolkit/query (without dependencies) (cjs, production.min.cjs)	9.22 KB (+0.07% 🔺)
3. createApi (.modern.mjs)	13.95 KB (-0.01% 🔽)
3. createApi (react) (.modern.mjs)	15.67 KB (-0.05% 🔽)

[ceisele-r]

@markerikson it's been a while since you fixed this without a new version being released since then - would it be possible to craft a release that includes this? That would be great!

[markerikson]

Ah, yeah, this didn't get released. I'll try to find time to put out a new build.

[ceisele-r]

Great, thank you for the release @markerikson !

[markerikson]

Oh yeah, forgot to comment back here :) Out in https://github.com/reduxjs/redux-toolkit/releases/tag/v2.5.1 !