test({react,preact}-query/useMutation): add tests for 'MutationFunctionContext' passed to mutationFn and callbacks by sukvvon · Pull Request #11440 · TanStack/query

sukvvon · 2026-09-08T00:43:34Z

🎯 Changes

Adds test coverage for MutationFunctionContext (the { client, meta, mutationKey } object passed as the last argument to mutationFn and every mutation callback) in useMutation.test.tsx and useMutation.test-d.tsx, for both react-query and preact-query.

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

Type tests added:

context typed as MutationFunctionContext for mutationFn and every hook-level callback
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 coverage for mutation context handling across React and Preact integrations.
- Verified that mutation functions and callbacks receive query client, metadata, mutation key, and mutation result context.
- Added type checks to ensure mutation context arguments are correctly inferred for hook-level and per-call callbacks.
- Confirmed successful callbacks can use the provided query client to invalidate related queries.

nx-cloud · 2026-09-08T00:44:01Z

View your CI Pipeline Execution ↗ for commit fc6622a

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

☁️ Nx Cloud last updated this comment at 2026-09-08 00:53:03 UTC

github-actions · 2026-09-08T00:44:38Z

🚀 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-08T00:45:12Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: f54b8527-2a47-4235-838e-73d4c9648852

📥 Commits

Reviewing files that changed from the base of the PR and between e57f816 and fc6622a.

📒 Files selected for processing (4)

packages/preact-query/src/__tests__/useMutation.test-d.tsx
packages/preact-query/src/__tests__/useMutation.test.tsx
packages/react-query/src/__tests__/useMutation.test-d.tsx
packages/react-query/src/__tests__/useMutation.test.tsx

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

📝 Walkthrough

Walkthrough

The change adds React and Preact type and runtime tests for useMutation context propagation, including client, meta, mutationKey, onMutateResult, and query invalidation.

Changes

Mutation context coverage

Layer / File(s)	Summary
Mutation context type coverage `packages/react-query/src/__tests__/useMutation.test-d.tsx`, `packages/preact-query/src/__tests__/useMutation.test-d.tsx`	Type tests verify `MutationFunctionContext` in mutation functions and hook-level and per-call callbacks. They also verify the `client` and `mutationKey` property types.
Mutation context runtime coverage `packages/react-query/src/__tests__/useMutation.test.tsx`, `packages/preact-query/src/__tests__/useMutation.test.tsx`	Runtime tests verify context propagation, `onMutateResult`, `QueryClient` access, `mutationKey`, and query invalidation through `context.client`.

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

Merge Risk: ⚪ Minimal · up to d345f

This change adds regression coverage for mutation callback context behavior across React and Preact without changing published runtime code. No merge-blocking risk is identified.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ 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%. Docstring coverage is scoped to functions touched by this diff. Analyzed 8 functions across 4 files.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
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.
Title check	✅ Passed	The title clearly identifies the added tests for MutationFunctionContext in react-query and preact-query useMutation functions and callbacks.
Description check	✅ Passed	The description follows the required template, explains the runtime and type tests, completes the checklist, and correctly identifies the change as dev-only with no release impact.

Fix all pre-merge checks with AI

✨ Finishing Touches 💡 1

📝 Generate docstrings 💡

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch test/react-preact-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-08T00:45:55Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: d345fc2

github-actions · 2026-09-08T00:46:17Z

size-limit report 📦

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

…onContext' passed to mutationFn and callbacks

sukvvon self-assigned this Sep 8, 2026

sukvvon mentioned this pull request Sep 8, 2026

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

Merged

5 tasks

test({react,preact}-query/useMutation): add tests for 'MutationFuncti…

d345fc2

…onContext' passed to mutationFn and callbacks

sukvvon force-pushed the test/react-preact-mutation-context-coverage branch from fc6622a to d345fc2 Compare September 8, 2026 00:49

sukvvon changed the title ~~test({react,preact}-query/useMutation): add coverage for 'MutationFunctionContext' passed to mutationFn and callbacks~~ test({react,preact}-query/useMutation): add tests for 'MutationFunctionContext' passed to mutationFn and callbacks Sep 8, 2026

sukvvon merged commit 0b326b6 into main Sep 8, 2026
9 checks passed

sukvvon deleted the test/react-preact-mutation-context-coverage branch September 8, 2026 10:31

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({react,preact}-query/useMutation): add tests for 'MutationFunctionContext' passed to mutationFn and callbacks - #11440

test({react,preact}-query/useMutation): add tests for 'MutationFunctionContext' passed to mutationFn and callbacks#11440
sukvvon merged 1 commit into
mainfrom
test/react-preact-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

❌ Failed checks (1 warning)

Uh oh!

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

edited

Loading

Uh oh!

github-actions Bot commented Sep 8, 2026

Uh oh!

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

❌ Failed checks (1 warning)

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!

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