fix(solid-query/useMutationState): recompute the result when the filters or the 'queryClient' change by sukvvon · Pull Request #12231 · TanStack/query · GitHub
Skip to content

fix(solid-query/useMutationState): recompute the result when the filters or the 'queryClient' change - #12231

Open
sukvvon wants to merge 1 commit into
mainfrom
fix/solid-query-use-mutation-state-recompute-on-change
Open

fix(solid-query/useMutationState): recompute the result when the filters or the 'queryClient' change#12231
sukvvon wants to merge 1 commit into
mainfrom
fix/solid-query-use-mutation-state-recompute-on-change

Conversation

@sukvvon

@sukvvon sukvvon commented Oct 21, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

🎯 Changes

useMutationState computed its result once and afterwards only on mutation cache events, so changing the filters (or select) or the queryClient kept returning the previous result until the next mutation event.

  • Add an effect that recomputes the result from the current mutation cache and options, keeping the reference via replaceEqualDeep.
  • Add tests for changing the filters and the queryClient.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
  • I fully understand the code in this pull request, including any code generated with AI assistance.

🚀 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

    • Fixed useMutationState so mutation results update when filters or the supplied query client change.
    • Improved updates when the mutation cache changes, while avoiding unnecessary updates when results remain equal.

  • Tests

    • Added coverage for changes to mutation-key filters and query clients.

@sukvvon sukvvon self-assigned this Oct 21, 2026
@changeset-bot

changeset-bot Bot commented Oct 21, 2026

Copy link
Copy Markdown

@nx-cloud

nx-cloud Bot commented Oct 21, 2026 •
edited
Loading

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 3b4b9e8

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

☁️ Nx Cloud last updated this comment at 2026-10-21 04:56:59 UTC

@github-actions

github-actions Bot commented Oct 21, 2026

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

1 package(s) bumped directly, 23 bumped as dependents.

🟩 Patch bumps

Package Version Reason
@tanstack/solid-query 5.104.5 → 5.104.6 Changeset
@tanstack/angular-query-experimental 5.104.5 → 5.104.6 Dependent
@tanstack/eslint-plugin-query 5.104.5 → 5.104.6 Dependent
@tanstack/lit-query 0.2.30 → 0.2.31 Dependent
@tanstack/preact-query 5.104.5 → 5.104.6 Dependent
@tanstack/preact-query-devtools 5.104.5 → 5.104.6 Dependent
@tanstack/preact-query-persist-client 5.104.5 → 5.104.6 Dependent
@tanstack/query-async-storage-persister 5.104.5 → 5.104.6 Dependent
@tanstack/query-broadcast-client-experimental 5.104.5 → 5.104.6 Dependent
@tanstack/query-core 5.104.5 → 5.104.6 Dependent
@tanstack/query-devtools 5.104.5 → 5.104.6 Dependent
@tanstack/query-persist-client-core 5.104.5 → 5.104.6 Dependent
@tanstack/query-sync-storage-persister 5.104.5 → 5.104.6 Dependent
@tanstack/react-query 5.104.5 → 5.104.6 Dependent
@tanstack/react-query-devtools 5.104.5 → 5.104.6 Dependent
@tanstack/react-query-next-experimental 5.104.5 → 5.104.6 Dependent
@tanstack/react-query-persist-client 5.104.5 → 5.104.6 Dependent
@tanstack/solid-query-devtools 5.104.5 → 5.104.6 Dependent
@tanstack/solid-query-persist-client 5.104.5 → 5.104.6 Dependent
@tanstack/svelte-query 6.3.5 → 6.3.6 Dependent
@tanstack/svelte-query-devtools 6.3.5 → 6.3.6 Dependent
@tanstack/svelte-query-persist-client 6.3.5 → 6.3.6 Dependent
@tanstack/vue-query 5.104.5 → 5.104.6 Dependent
@tanstack/vue-query-devtools 6.3.5 → 6.3.6 Dependent

@coderabbitai

coderabbitai Bot commented Oct 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: TanStack/query/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 89b523ba-f1d0-407b-8c09-6b0da1be2e6b
📥 Commits

Reviewing files that changed from the base of the PR and between 01703ec and 3b4b9e8.

📒 Files selected for processing: 3
  • .changeset/solid-use-mutation-state-recompute.md
  • packages/solid-query/src/__tests__/useMutationState.test.tsx
  • packages/solid-query/src/useMutationState.ts

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.

📝 Walkthrough

useMutationState now recomputes results when its reactive options or mutation cache changes. Tests cover changes to the mutation-key filter and supplied QueryClient.

Changes: Solid mutation state recomputation

Layer / File(s) Summary
Recompute and verify mutation state
packages/solid-query/src/useMutationState.ts, packages/solid-query/src/__tests__/useMutationState.test.tsx, .changeset/solid-use-mutation-state-recompute.md		 A reactive effect recalculates filtered mutation results and updates the stored result with structural sharing. Tests cover changing the mutation-key filter and switching QueryClient. A patch changeset records the update.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Bug fix

Suggested reviewers: brenelz

Merge Risk: ⚪ Minimal · up to 3b4b9

The reviewed change has no identified merge-blocking issue; it is ready for normal checks.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 2 files. (1 skipped: 1… Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks: 4 passed
Check name Status Explanation
Title check Passed The title clearly and concisely identifies the main fix: recomputing useMutationState when filters or queryClient change.
Description check Passed The description follows the repository template, explains the issue and implementation, lists tests, confirms contribution-policy compliance, and documents the changeset.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 2 files. (1 skipped: 1 unsupported.)

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

✨ Finishing Touches: 💡 1
📝 Generate docstrings: 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@pkg-pr-new

pkg-pr-new Bot commented Oct 21, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

npm i https://pkg.pr.new/@tanstack/lit-query@12231

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@12231

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@12231

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 3b4b9e8

@github-actions

github-actions Bot commented Oct 21, 2026

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 11.76 KB (0%)
react minimal 8.59 KB (0%)

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@sukvvon sukvvon

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@sukvvon