fix(vue-query/queryClient): preserve union narrowing in 'setQueryData' updaters for tagged query keys by sukvvon · Pull Request #12226 · TanStack/query · GitHub
Skip to content

fix(vue-query/queryClient): preserve union narrowing in 'setQueryData' updaters for tagged query keys - #12226

Open
sukvvon wants to merge 2 commits into
mainfrom
fix/vue-query-set-query-data-union-narrowing
Open

fix(vue-query/queryClient): preserve union narrowing in 'setQueryData' updaters for tagged query keys#12226
sukvvon wants to merge 2 commits into
mainfrom
fix/vue-query-set-query-data-union-narrowing

Conversation

@sukvvon

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

Copy link
Copy Markdown
Member

🎯 Changes

  • Type the updater input of the tagged query key overload of setQueryData in packages/vue-query/src/queryClient.ts as InferDataFromTag<NoInfer<TQueryFnData>, TTaggedQueryKey> | undefined, the same as @tanstack/query-core. With NoInfer<TInferredQueryFnData>, a discriminated union narrowed inside the updater did not match the overload (No overload matches this call).
  • Add the should preserve discriminated union narrowing in setQueryData updaterFn type test to packages/vue-query/src/__tests__/queryOptions.test-d.ts.
  • Add a patch changeset for @tanstack/vue-query.

✅ 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 have followed the AI contribution policy and 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

    • Improved TypeScript type inference for setQueryData updater functions in Vue Query.
    • Discriminated-union types are now preserved when using tagged query keys, providing more accurate editor guidance and compile-time validation.

  • Tests

    • Added regression coverage for union narrowing and incompatible updater inputs.

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

changeset-bot Bot commented Oct 21, 2026 •
edited
Loading

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 532ba90

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

☁️ Nx Cloud last updated this comment at 2026-10-21 03:27:29 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/vue-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 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-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 →

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

⚙️ Run configuration
  • Configuration used: Repository: TanStack/query/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 39977047-be6f-4d72-8c88-9d04c2f1e6bb
📥 Commits

Reviewing files that changed from the base of the PR and between 7e1d57c and 532ba90.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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: b64b765f-01f0-4e66-83b6-961aface0306
📥 Commits

Reviewing files that changed from the base of the PR and between d28d4d2 and 7e1d57c.

📒 Files selected for processing: 3
  • .changeset/vue-set-query-data-union-narrowing.md
  • packages/vue-query/src/__tests__/queryOptions.test-d.ts
  • packages/vue-query/src/queryClient.ts

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

📝 Walkthrough

QueryClient.setQueryData now derives the updater input type from the tagged query key. A type-level regression test checks union narrowing and incompatible updater rejection. A patch changeset records the fix.

Changes: Vue Query setQueryData narrowing

Layer / File(s) Summary
Tagged updater type and regression coverage
packages/vue-query/src/queryClient.ts, packages/vue-query/src/__tests__/queryOptions.test-d.ts, .changeset/vue-set-query-data-union-narrowing.md		 setQueryData now uses InferDataFromTag to type updater input from TQueryFnData and the tagged query key. The test checks discriminated-union narrowing and rejects an incompatible updater type. The changeset records a patch release.

Priority: ⬇️ Low

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

Change: Bug fix

Suggested reviewers: tkdodo

Merge Risk: ⚪ Minimal · up to 7e1d5

This change fixes TypeScript narrowing for setQueryData updaters in Vue Query and does not alter runtime behavior. No merge-blocking risk is evident.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly identifies the Vue Query API, the affected method, and the primary fix for union narrowing in tagged query key updaters.
Description check Passed The description follows the required template. It explains the change and motivation, lists the test and changeset, and marks all applicable checklist items as complete.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 2…
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

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 2 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
📝 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 •
edited
Loading

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 532ba90

@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