test(vue-query/useMutation): add tests for 'MutationFunctionContext' passed to mutationFn and callbacks by sukvvon · Pull Request #11444 · TanStack/query

sukvvon · 2026-09-08T01:18:29Z

🎯 Changes

Adds test coverage for MutationFunctionContext (the { client, meta, mutationKey } object passed as the last argument to mutationFn and every mutation callback) in vue-query's useMutation.test.ts and useMutation.test-d.tsx, mirroring the coverage added for react-query/preact-query (#11440), solid-query (#11441), svelte-query (#11442), and angular-query-experimental (#11443).

Runtime tests added:

hook-level onSuccess receiving a non-undefined onMutateResult alongside context
mutationFn accessing the same QueryClient instance via context.client
context.mutationKey reflecting the mutationKey passed to useMutation
context.client.invalidateQueries() actually invalidating the cache from within onSuccess

Also strengthens an existing test (should only fire the per-call onSuccess for the last mutate() call), which already asserted the context argument's presence with expect.anything(), to check context.client by identity instead.

Type gap found, not fixed here: mutationFn's own context parameter type-checks as implicit any in this package only — onMutate/onError/onSettled/onSuccess and every per-call callback are unaffected, and runtime behavior is unaffected (core still passes the real object regardless of typing). UseMutationOptions' MaybeRefDeep wrapper is the suspected cause, unconfirmed. injectMutation in angular-query-experimental, which also takes an options-returning function, does not have this problem, so it looks vue-specific rather than inherent to the accessor pattern. The type test below excludes mutationFn from its assertion and documents the gap with a comment.

Type tests added:

context typed as MutationFunctionContext for every hook-level callback except mutationFn (see gap above)
context typed as MutationFunctionContext for every per-call mutate option
context.mutationKey typed as MutationKey | undefined

✅ 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

Tests
- Expanded mutation coverage to verify consistent callback context delivery.
- Confirmed context includes the mutation client, mutation key, result data, and mutation callback results.
- Added type checks for correctly typed mutation-function and callback context.
- Verified mutation callbacks can use the provided client to invalidate related queries without relying on an external client reference.
- Added coverage for concurrent mutations and non-undefined results passed to success callbacks.

…passed to mutationFn and callbacks

nx-cloud · 2026-09-08T01:19:03Z

View your CI Pipeline Execution ↗ for commit 921e4a1

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

☁️ Nx Cloud last updated this comment at 2026-09-08 12:13:23 UTC

github-actions · 2026-09-08T01:19:41Z

🚀 Changeset Version Preview

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

🟨 Minor bumps

Package	Version	Reason
`@tanstack/query-core`	5.102.8 → 5.103.0	Changeset
`@tanstack/svelte-query`	6.1.48 → 6.2.0	Changeset
`@tanstack/angular-query-experimental`	5.102.8 → 5.103.0	Dependent
`@tanstack/angular-query-persist-client`	5.102.8 → 5.103.0	Dependent
`@tanstack/eslint-plugin-query`	5.102.8 → 5.103.0	Dependent
`@tanstack/preact-query`	5.102.8 → 5.103.0	Dependent
`@tanstack/preact-query-devtools`	5.102.8 → 5.103.0	Dependent
`@tanstack/preact-query-persist-client`	5.102.8 → 5.103.0	Dependent
`@tanstack/query-async-storage-persister`	5.102.8 → 5.103.0	Dependent
`@tanstack/query-broadcast-client-experimental`	5.102.8 → 5.103.0	Dependent
`@tanstack/query-devtools`	5.102.8 → 5.103.0	Dependent
`@tanstack/query-persist-client-core`	5.102.8 → 5.103.0	Dependent
`@tanstack/query-sync-storage-persister`	5.102.8 → 5.103.0	Dependent
`@tanstack/react-query`	5.102.8 → 5.103.0	Dependent
`@tanstack/react-query-devtools`	5.102.8 → 5.103.0	Dependent
`@tanstack/react-query-next-experimental`	5.102.8 → 5.103.0	Dependent
`@tanstack/react-query-persist-client`	5.102.8 → 5.103.0	Dependent
`@tanstack/solid-query`	5.102.8 → 5.103.0	Dependent
`@tanstack/solid-query-devtools`	5.102.8 → 5.103.0	Dependent
`@tanstack/solid-query-persist-client`	5.102.8 → 5.103.0	Dependent
`@tanstack/svelte-query-devtools`	6.1.48 → 6.2.0	Dependent
`@tanstack/svelte-query-persist-client`	6.1.48 → 6.2.0	Dependent
`@tanstack/vue-query`	5.102.8 → 5.103.0	Dependent
`@tanstack/vue-query-devtools`	6.1.48 → 6.2.0	Dependent

🟩 Patch bumps

Package	Version	Reason
`@tanstack/lit-query`	0.2.20 → 0.2.21	Dependent

coderabbitai · 2026-09-08T01:20:06Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: c6449abd-7f81-42ad-bd04-e10d63251474

📥 Commits

Reviewing files that changed from the base of the PR and between 3874bdc and 921e4a1.

📒 Files selected for processing (1)

packages/vue-query/src/__tests__/useMutation.test-d.tsx

🚧 Files skipped from review as they are similar to previous changes (1)

packages/vue-query/src/tests/useMutation.test-d.tsx

Included review availability: Your plan provides up to 10 included reviews per hour; 8 remain after this review.

📝 Walkthrough

Walkthrough

The changes expand Vue mutation tests for MutationFunctionContext. They verify callback arguments, mutationKey, client, meta, onMutateResult, and query invalidation through the context.

Changes

Mutation context

Layer / File(s)	Summary
Context callback type coverage `packages/vue-query/src/__tests__/useMutation.test-d.tsx`	Type tests verify `MutationFunctionContext`, the `QueryClient` client type, per-call options, and `mutationKey` typing.
Runtime context behavior `packages/vue-query/src/__tests__/useMutation.test.ts`	Runtime tests verify callback arguments, `context.client`, `context.mutationKey`, `context.meta`, `onMutateResult`, and query invalidation through `context.client`.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Merge Risk: ⚪ Minimal · up to 921e4

This change adds mutation-context test coverage without changing product behavior, and no current merge-blocking risk is identified.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description follows the required template. It explains the test changes, documents the known type gap, completes the checklist, and identifies the change as docs/CI/dev-only with no release impact…
Title check	✅ Passed	The title clearly and concisely describes the primary change: adding Vue Query tests for MutationFunctionContext in useMutation.
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.

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch test/vue-mutation-context-coverage

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 · 2026-09-08T01:21:03Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 921e4a1

github-actions · 2026-09-08T01:21:29Z

size-limit report 📦

Path	Size
react full	11.85 KB (0%)
react minimal	8.84 KB (0%)

…s well

…ationFn' params in context test

…' for consistency

test(vue-query/useMutation): add tests for 'MutationFunctionContext' …

6f853aa

…passed to mutationFn and callbacks

sukvvon self-assigned this Sep 8, 2026

sukvvon added 4 commits September 8, 2026 19:48

Merge branch 'main' into test/vue-mutation-context-coverage

3db7f9f

test(vue-query/useMutation): assert 'context' type for 'mutationFn' a…

db88c60

…s well

test(vue-query/useMutation): drop redundant type annotation from 'mut…

3874bdc

…ationFn' params in context test

test(vue-query/useMutation): rename 'mutationFn' param to '_variables…

921e4a1

…' for consistency

sukvvon mentioned this pull request Sep 8, 2026

test({react,preact,solid,svelte}-query,angular-query-experimental): rename 'mutationFn' param to '_variables' in 'MutationFunctionContext' tests #11448

Merged

5 tasks

Navigation Menu

Uh oh!

Uh oh!

test(vue-query/useMutation): add tests for 'MutationFunctionContext' passed to mutationFn and callbacks - #11444

test(vue-query/useMutation): add tests for 'MutationFunctionContext' passed to mutationFn and callbacks#11444
sukvvon wants to merge 5 commits into
mainfrom
test/vue-mutation-context-coverage

sukvvon commented Sep 8, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

nx-cloud Bot commented Sep 8, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Sep 8, 2026

Uh oh!

coderabbitai Bot commented Sep 8, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

pkg-pr-new Bot commented Sep 8, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Sep 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Uh oh!

Conversation

sukvvon commented Sep 8, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Changes

✅ Checklist

🚀 Release Impact

Summary by CodeRabbit

Uh oh!

nx-cloud Bot commented Sep 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Sep 8, 2026

🚀 Changeset Version Preview

🟨 Minor bumps

🟩 Patch bumps

Uh oh!

coderabbitai Bot commented Sep 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

pkg-pr-new Bot commented Sep 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Sep 8, 2026

size-limit report 📦

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Sep 8, 2026 •

edited by coderabbitai Bot

Loading

nx-cloud Bot commented Sep 8, 2026 •

edited

Loading

coderabbitai Bot commented Sep 8, 2026 •

edited

Loading

pkg-pr-new Bot commented Sep 8, 2026 •

edited

Loading