Skip to content

test(angular-query-experimental/inject-mutation): add tests for 'MutationFunctionContext' passed to mutationFn and callbacks - #11443

Merged
sukvvon merged 1 commit into
mainfrom
test/angular-mutation-context-coverage
Sep 8, 2026
Merged

test(angular-query-experimental/inject-mutation): add tests for 'MutationFunctionContext' passed to mutationFn and callbacks#11443
sukvvon merged 1 commit into
mainfrom
test/angular-mutation-context-coverage

Conversation

@sukvvon

@sukvvon sukvvon commented Sep 8, 2026

Copy link
Copy Markdown
Member

🎯 Changes

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

This adds 5 runtime tests (one more than react/preact/solid, matching svelte). Four use this file's TestBed.runInInjectionContext + vi.fn() "side effects" convention; the mutationFn-reads-context.client test uses @Component + render() + getByText, matching this file's own convention for tests that assert rendered state rather than a mock's calls:

  • hook-level onSuccess receiving a non-undefined onMutateResult alongside context
  • mutationFn accessing the same QueryClient instance via context.client, rendered into the template and asserted with getByText
  • context.mutationKey reflecting the mutationKey passed to injectMutation
  • context.client.invalidateQueries() actually invalidating the cache from within onSuccess
  • a per-call onSuccess receiving the same QueryClient instance via context — the existing should call onSuccess when passed as an argument of mutate function test already exercises this call shape but never asserted context, so this fills that gap rather than duplicating it

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 callbacks and mutation functions receiving the expected context.
    • Added validation for access to the query client, mutation keys, and mutation results across hook-level and per-call callbacks.
    • Added type checks ensuring mutation context values are correctly typed, including optional mutation keys.
    • Verified that mutation callbacks can use context to invalidate queries and share query client access.

@nx-cloud

nx-cloud Bot commented Sep 8, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 8054b78

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

☁️ Nx Cloud last updated this comment at 2026-09-08 01:25:17 UTC

@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

🚀 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

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: eb870fa2-3f56-4a4e-96ef-9e1d0f9eda67

📥 Commits

Reviewing files that changed from the base of the PR and between 8054b78 and 8ee77db.

📒 Files selected for processing (1)
  • packages/angular-query-experimental/src/__tests__/inject-mutation.test.ts

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


📝 Walkthrough

Walkthrough

The changes add type and runtime tests for MutationFunctionContext in Angular mutation hooks. The tests cover callback signatures, QueryClient access, mutation keys, onMutate results, query invalidation, and per-call callbacks.

Changes

Mutation context validation

Layer / File(s) Summary
Mutation context type contracts
packages/angular-query-experimental/src/__tests__/inject-mutation.test-d.ts
Type tests validate context parameters for mutation functions, hook-level callbacks, and per-call callbacks. They also validate context.client and context.mutationKey.
Mutation context runtime propagation
packages/angular-query-experimental/src/__tests__/inject-mutation.test.ts
Runtime tests validate context propagation, QueryClient access, mutation keys, onMutate results, query invalidation, and per-call callback context.

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

Merge Risk: ⚪ Minimal · up to 8ee77

This change expands Angular mutation-context test coverage without altering production behavior. No current merge-blocking risk is identified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Title check ✅ Passed The title clearly identifies the Angular experimental mutation test coverage and the MutationFunctionContext behavior under test. It is specific and directly related to the changes.
Description check ✅ Passed The description follows the required template. It explains the runtime and type test coverage, records the completed checklist items, and identifies the change as docs/CI/dev-only with no release impa…
✨ 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/angular-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

pkg-pr-new Bot commented Sep 8, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 8ee77db

@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

size-limit report 📦

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

…tionFunctionContext' passed to mutationFn and callbacks
@sukvvon
sukvvon force-pushed the test/angular-mutation-context-coverage branch from 8054b78 to 8ee77db Compare September 8, 2026 01:21
@sukvvon
sukvvon merged commit 94d6670 into main Sep 8, 2026
9 checks passed
@sukvvon
sukvvon deleted the test/angular-mutation-context-coverage branch September 8, 2026 10:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant