Skip to content

test(lit-query/createMutationController): add type tests - #11767

Open
sukvvon wants to merge 2 commits into
mainfrom
test/lit-query-create-mutation-controller-type-tests
Open

sukvvon wants to merge 2 commits into
mainfrom
test/lit-query-create-mutation-controller-type-tests

Conversation

@sukvvon

@sukvvon sukvvon commented Sep 30, 2026 •

Copy link
Copy Markdown
Member

🎯 Changes

Adds createMutationController.test-d.ts with 14 type tests:

  • data, variables, onMutate result, and error types inferred from the options or given explicitly, including a custom error class
  • the accessor type returned by createMutationController
  • mutate and mutateAsync arguments and the mutateAsync return type, including void and optional variables
  • onSettled and onError callback types
  • context as the last argument of mutationFn, of every option callback, and of every mutate callback, and context.mutationKey

✅ 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

  • Tests
    • Added type-checking coverage for mutation controller data, variables, errors, callback contexts, and return types.
    • Verified that mutations with optional or void variables can be called without arguments.

@sukvvon sukvvon self-assigned this Sep 30, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

@nx-cloud

nx-cloud Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 01560fe

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

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

@coderabbitai

coderabbitai Bot commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 7 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 10 included reviews currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Repository: TanStack/query/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 1d35f296-43e3-4cee-9b84-02cc839a03e5

📥 Commits

Reviewing files that changed from the base of the PR and between a8a4290 and 01560fe.

📒 Files selected for processing (1)
  • packages/lit-query/src/__tests__/createMutationController.test-d.ts

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: b392d441-043b-4c8b-8f6a-311e35844fc6

📥 Commits

Reviewing files that changed from the base of the PR and between d374547 and a8a4290.

📒 Files selected for processing (1)
  • packages/lit-query/src/__tests__/createMutationController.test-d.ts

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


📝 Walkthrough

Walkthrough

Adds type-level tests for createMutationController. The tests cover inferred and explicit types, mutation call signatures, callback arguments, and mutation context properties.

Changes

Mutation controller type coverage

Layer / File(s) Summary
Inference and mutation call signatures
packages/lit-query/src/__tests__/createMutationController.test-d.ts
Tests inferred and explicit mutation types, result accessors, promise results, optional variables, and error and settled callback types.
Mutation callback context
packages/lit-query/src/__tests__/createMutationController.test-d.ts
Tests MutationFunctionContext in mutation functions and callbacks, including the types of its client and mutationKey properties.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to a8a42

This change adds mutation-controller type coverage without changing runtime behavior. No merge-blocking issue is established; merge after normal checks pass.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the addition of type tests for createMutationController and matches the main change.
Description check ✅ Passed The description includes the required Changes, Checklist, and Release Impact sections. It summarizes the 14 type tests, reports local testing, confirms AI policy compliance, and identifies the change …
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 1…
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
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


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 30, 2026 •

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 01560fe

@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 11.73 KB (0%)
react minimal 8.58 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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant