Skip to content

test(query-codemods): replace 'async' arrow functions without 'await' with 'Promise.resolve' in the fixtures - #12286

Merged
sukvvon merged 1 commit into
mainfrom
test/query-codemods-fixtures-use-promise-resolve
Oct 22, 2026
Merged

sukvvon merged 1 commit into
mainfrom
test/query-codemods-fixtures-use-promise-resolve

Conversation

@sukvvon

@sukvvon sukvvon commented Oct 22, 2026 •

Copy link
Copy Markdown
Member

🎯 Changes

Replace the async arrow functions without await in the codemod fixtures with Promise.resolve, which keeps the same Promise return value and clears the typescript/require-await warnings in query-codemods:

  • src/v4/__testfixtures__/*-import.{input,output}.tsx: async () => null → () => Promise.resolve(null) for queryFn and mutationFn.
  • src/v5/remove-overloads/__testfixtures__/bug-reports.{input,output}.tsx: async () => 'foo' → () => Promise.resolve('foo').

✅ 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
    • Updated migration examples to show callbacks returning promises across default, named, and namespaced imports, including query and mutation defaults.
    • Updated an overload-removal example to use the same promise-returning callback style.
    • These updates affect examples only; they do not change application behavior.

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

changeset-bot Bot commented Oct 22, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 0bfd0ba

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@nx-cloud

nx-cloud Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 0bfd0ba

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

☁️ Nx Cloud last updated this comment at 2026-10-22 12:53:01 UTC

@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.

@coderabbitai

coderabbitai Bot commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
📥 Commits

Reviewing files that changed from the base of the PR and between 4071cd5 and 0bfd0ba.

📒 Files selected for processing: 8
  • packages/query-codemods/src/v4/__testfixtures__/default-import.input.tsx
  • packages/query-codemods/src/v4/__testfixtures__/default-import.output.tsx
  • packages/query-codemods/src/v4/__testfixtures__/named-import.input.tsx
  • packages/query-codemods/src/v4/__testfixtures__/named-import.output.tsx
  • packages/query-codemods/src/v4/__testfixtures__/namespaced-import.input.tsx
  • packages/query-codemods/src/v4/__testfixtures__/namespaced-import.output.tsx
  • packages/query-codemods/src/v5/remove-overloads/__testfixtures__/bug-reports.input.tsx
  • packages/query-codemods/src/v5/remove-overloads/__testfixtures__/bug-reports.output.tsx

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

📝 Walkthrough

The v4 and v5 codemod fixtures replace async query and mutation callbacks with non-async callbacks that return Promise.resolve(...).

Changes: Promise-returning callback fixtures

Layer / File(s) Summary
Update callback examples
packages/query-codemods/src/v4/__testfixtures__/*, packages/query-codemods/src/v5/remove-overloads/__testfixtures__/bug-reports.*.tsx
The fixtures use Promise.resolve(null) for v4 query and mutation defaults and Promise.resolve('foo') for the v5 query callback, replacing async callbacks. Other shown query-client operations are unchanged.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 0bfd0

No actionable merge risk was identified in these dev-only fixture changes.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly and concisely describes the main fixture changes: replacing async arrow functions without await with Promise.resolve in query-codemods.
Description check Passed The description explains the changes and motivation, includes all required checklist sections, reports testing, confirms AI policy compliance, and identifies the change as dev-only with no release imp…
Docstring Coverage Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 8 files.
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: Description check

Explanation

The description explains the changes and motivation, includes all required checklist sections, reports testing, confirms AI policy compliance, and identifies the change as dev-only with no release impact.

✨ 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 22, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 0bfd0ba

@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 11.76 KB (0%)
react minimal 8.59 KB (0%)

@sukvvon
sukvvon merged commit 0064fe8 into main Oct 22, 2026
9 checks passed
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