fix(query-core): fix combine not updating when queries change with stable reference #9954

minseong0324 · 2025-12-07T18:27:27Z

🎯 Changes

Problem

With stable combine, results lag one step behind when queries change.
This happens because getOptimisticResult runs before setQueries updates this.#result.

Solution

Pass queryHashes to #combineResult to detect query changes before this.#result is updated.

✅ Checklist

I have followed the steps in the Contributing guide.
I have tested this code locally with pnpm run test:pr.

🚀 Release Impact

This change affects published code, and I have generated a changeset.
This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

Bug Fixes
- Combined query results now reliably update when the set of queries changes (add/remove/replace), ensuring aggregated results stay accurate.
Tests
- Added coverage for dynamic query counts and stable combine behavior to prevent regressions.
Chores
- Release patch entry added documenting the fix.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

… with dynamic queries

changeset-bot · 2025-12-07T18:27:30Z

🦋 Changeset detected

Latest commit: 291afec

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 19 packages

Name	Type
@tanstack/query-core	Patch
@tanstack/angular-query-experimental	Patch
@tanstack/query-async-storage-persister	Patch
@tanstack/query-broadcast-client-experimental	Patch
@tanstack/query-persist-client-core	Patch
@tanstack/query-sync-storage-persister	Patch
@tanstack/react-query	Patch
@tanstack/solid-query	Patch
@tanstack/svelte-query	Patch
@tanstack/vue-query	Patch
@tanstack/angular-query-persist-client	Patch
@tanstack/react-query-persist-client	Patch
@tanstack/solid-query-persist-client	Patch
@tanstack/svelte-query-persist-client	Patch
@tanstack/react-query-devtools	Patch
@tanstack/react-query-next-experimental	Patch
@tanstack/solid-query-devtools	Patch
@tanstack/svelte-query-devtools	Patch
@tanstack/vue-query-devtools	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai · 2025-12-07T18:27:36Z

📝 Walkthrough

Walkthrough

Adds tracking of query hashes in QueriesObserver to detect structural changes and force re-evaluation of a stable combine function; updates optimistic result flow and tests to cover dynamic add/remove/replace scenarios and duplicate keys.

Changes

Cohort / File(s)	Summary
Changeset `\`.changeset/swift-brooms-teach.md``	New changeset added: patch bump for `@tanstack/query-core` with description "fix stable combine reference not updating when queries change dynamically."
Query Core Implementation `\`packages/query-core/src/queriesObserver.ts``	Adds private `#lastQueryHashes?: string[]`; threads query-hash computation through `getOptimisticResult` into `#combineResult(queryHashes?)`; compares and updates `#lastQueryHashes` to trigger recompute when hashes change. Method signature of `#combineResult` updated.
Query Core Tests `\`packages/query-core/src/tests/queriesObserver.test.tsx``	Adds tests exercising optimistic results and stable `combine` behavior across adding, removing, replacing queries, duplicate keys, and early-return update scenarios.
React Query Tests `\`packages/react-query/src/tests/useQueries.test.tsx``	Adds a test ensuring `useQueries` with a stable `combine` reference returns correct results as the number of queries changes.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Possibly related PRs

fix(query-core): ensure combine re-executes after cache restoration with memoized combine #9592 — Related changes ensuring memoized combine re-runs when queries or their results change (per-index and overall change-detection overlap).
fix(query-core, react-query): infinite re-renders in useQueries #9639 — Related refinements to queriesObserver change-detection and observer reconfiguration to avoid incorrect/infinite updates.
fix: Prevent infinite render loops when useSuspenseQueries has duplicate queryKeys #9886 — Additional modifications around queryHash handling and observer matching in QueriesObserver.

Suggested reviewers

TkDodo

Poem

🐰 I tracked the hashes, one by one,
So combines wake when queries run.
Adding, swapping, left or right,
The results now hop into sight.
A cheeky fix — makes everything fun! 🥕✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main fix: ensuring the combine function updates when queries change with a stable reference.
Description check	✅ Passed	The description follows the template, explains the problem and solution clearly, and includes all required checklist items completed.
Linked Issues check	✅ Passed	The PR successfully addresses issue #8781 by detecting query changes via queryHashes before result updates, preventing the one-render lag with stable combine references.
Out of Scope Changes check	✅ Passed	All changes are scoped to fixing the stable combine reference bug: test additions, queryHashes tracking implementation, and changeset file.

✨ Finishing touches

📝 Generate docstrings

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 89db791 and 291afec.

📒 Files selected for processing (1)

packages/query-core/src/queriesObserver.ts

🧰 Additional context used

🧬 Code graph analysis (1)

packages/query-core/src/queriesObserver.ts (1)

packages/query-core/src/types.ts (1)

QueryObserverResult (903-908)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

GitHub Check: Preview
GitHub Check: Test

🔇 Additional comments (4)

packages/query-core/src/queriesObserver.ts (4)

46-46: LGTM!

The new #lastQueryHashes field follows the naming convention of other caching fields (#lastCombine, #lastResult) and is appropriately typed as optional.

184-191: LGTM! Correctly captures query state before #result is updated.

Computing queryHashes from the freshly matched observers and passing them to #combineResult ensures that structural changes to the queries array are detected immediately during the optimistic result phase, before setQueries updates this.#result.

222-240: LGTM! The query hash comparison logic correctly detects structural changes.

The implementation properly handles the key scenarios:

First call: #lastQueryHashes is undefined → queryHashesChanged is false, but #combinedResult is also undefined, so recomputation happens anyway.

Subsequent optimistic calls: Both hash arrays are defined, enabling detection of query additions/removals/replacements.

#notify() path: Called without queryHashes, so #lastQueryHashes is preserved. This is correct since #notify() runs after setQueries has already updated #result, and the this.#result !== this.#lastResult check handles that path.

295-309: Verify the intentional asymmetry between update paths.

The #notify() method calls #combineResult without queryHashes, which is correct because:

By the time #notify() executes, setQueries has already updated this.#result

Changes are detected via this.#result !== this.#lastResult

This intentional asymmetry preserves #lastQueryHashes for subsequent optimistic calls. Just confirming this design choice is understood for future maintainers.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

nx-cloud · 2025-12-07T18:28:01Z

View your CI Pipeline Execution ↗ for commit 291afec

Command	Status	Duration	Result
`nx affected --targets=test:sherif,test:knip,tes...`	✅ Succeeded	4m 42s	View ↗
`nx run-many --target=build --exclude=examples/*...`	✅ Succeeded	2s	View ↗

☁️ Nx Cloud last updated this comment at 2026-01-05 14:24:03 UTC

pkg-pr-new · 2025-12-07T18:30:27Z

More templates

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@9954

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@9954

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@9954

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@9954

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@9954

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@9954

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@9954

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@9954

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@9954

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@9954

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@9954

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@9954

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@9954

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@9954

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@9954

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@9954

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@9954

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@9954

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@9954

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@9954

commit: 291afec

codecov · 2025-12-07T18:34:52Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 59.83%. Comparing base (f616474) to head (291afec).

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #9954       +/-   ##
===========================================
+ Coverage   45.82%   59.83%   +14.00%     
===========================================
  Files         200      129       -71     
  Lines        8525     5749     -2776     
  Branches     1977     1581      -396     
===========================================
- Hits         3907     3440      -467     
+ Misses       4158     1994     -2164     
+ Partials      460      315      -145

Components	Coverage Δ
@tanstack/angular-query-experimental	`93.85% <ø> (ø)`
@tanstack/eslint-plugin-query	`∅ <ø> (∅)`
@tanstack/query-async-storage-persister	`43.85% <ø> (ø)`
@tanstack/query-broadcast-client-experimental	`24.39% <ø> (ø)`
@tanstack/query-codemods	`∅ <ø> (∅)`
@tanstack/query-core	`97.88% <100.00%> (+0.50%)`	⬆️
@tanstack/query-devtools	`3.38% <ø> (ø)`
@tanstack/query-persist-client-core	`80.00% <ø> (ø)`
@tanstack/query-sync-storage-persister	`84.61% <ø> (ø)`
@tanstack/query-test-utils	`∅ <ø> (∅)`
@tanstack/react-query	`96.40% <ø> (ø)`
@tanstack/react-query-devtools	`9.25% <ø> (ø)`
@tanstack/react-query-next-experimental	`∅ <ø> (∅)`
@tanstack/react-query-persist-client	`100.00% <ø> (ø)`
@tanstack/solid-query	`77.81% <ø> (ø)`
@tanstack/solid-query-devtools	`64.17% <ø> (ø)`
@tanstack/solid-query-persist-client	`100.00% <ø> (ø)`
@tanstack/svelte-query	`∅ <ø> (∅)`
@tanstack/svelte-query-devtools	`∅ <ø> (∅)`
@tanstack/svelte-query-persist-client	`∅ <ø> (∅)`
@tanstack/vue-query	`71.91% <ø> (ø)`
@tanstack/vue-query-devtools	`∅ <ø> (∅)`

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

minseong0324 added 3 commits December 8, 2025 03:23

test(query-core, react-query): add tests for stable combine reference…

4f794b2

… with dynamic queries

fix(query-core): fix combine cache invalidation with stable reference

ce349f5

chore: add changesets

89db791

github-actions bot added package: react-query package: query-core labels Dec 7, 2025

minseong0324 added 2 commits December 29, 2025 00:00

Merge branch 'main' into fix/combine-bug

b0b1028

Merge branch 'main' into fix/combine-bug

291afec

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(query-core): fix combine not updating when queries change with stable reference #9954

fix(query-core): fix combine not updating when queries change with stable reference #9954

Uh oh!

minseong0324 commented Dec 7, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Dec 7, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Dec 7, 2025 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Uh oh!

nx-cloud bot commented Dec 7, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Dec 7, 2025 •

edited

Loading

Uh oh!

codecov bot commented Dec 7, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

fix(query-core): fix combine not updating when queries change with stable reference #9954

Are you sure you want to change the base?

fix(query-core): fix combine not updating when queries change with stable reference #9954

Uh oh!

Conversation

minseong0324 commented Dec 7, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Changes

Problem

Solution

✅ Checklist

🚀 Release Impact

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Dec 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

coderabbitai bot commented Dec 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

nx-cloud bot commented Dec 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new bot commented Dec 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Dec 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

minseong0324 commented Dec 7, 2025 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Dec 7, 2025 •

edited

Loading

coderabbitai bot commented Dec 7, 2025 •

edited

Loading

nx-cloud bot commented Dec 7, 2025 •

edited

Loading

pkg-pr-new bot commented Dec 7, 2025 •

edited

Loading

codecov bot commented Dec 7, 2025 •

edited

Loading