test(lit-query): replace inline 'new Promise' timeouts with 'sleep' from 'query-test-utils' by sukvvon · Pull Request #11104 · TanStack/query

sukvvon · 2026-07-22T02:44:31Z

🎯 Changes

lit-query's tests were the only ones in the repo still writing new Promise((resolve) => setTimeout(resolve, N)) inline instead of using the shared sleep(N) helper from @tanstack/query-test-utils that every other adapter package's tests already use. Added @tanstack/query-test-utils as a devDependency and replaced all 14 occurrences across client-switch-controllers.test.ts, counters-and-state.test.ts, mutation-controller.test.ts, and query-controller.test.ts. No behavior change — sleep is implemented identically to the inlined promise.

Left untouched: promises that resolve manually via a captured resolve reference (e.g. resolveRefetch, resolveOld, resolveFetch), since those aren't fixed-delay timeouts.

✅ Checklist

I have followed the steps in the Contributing guide.
I have tested this code locally with pnpm run test:pr.

🚀 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
- Improved the reliability and consistency of timing-based automated tests.
- Standardized asynchronous wait handling across query and mutation scenarios.
- Enhanced coverage of state transitions, callback ordering, and controller behavior.
Chores
- Consolidated test timing utilities to support more predictable test execution.
- No user-facing functionality or public API changes were introduced.

…rom 'query-test-utils'

coderabbitai · 2026-07-22T02:44:53Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: de184062-a15f-4795-b9d9-e52b723123fc

📥 Commits

Reviewing files that changed from the base of the PR and between 64a8035 and 2857017.

⛔ Files ignored due to path filters (1)

pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (6)

packages/lit-query/package.json
packages/lit-query/src/tests/client-switch-controllers.test.ts
packages/lit-query/src/tests/counters-and-state.test.ts
packages/lit-query/src/tests/mutation-controller.test.ts
packages/lit-query/src/tests/query-controller.test.ts
packages/lit-query/src/tests/testHost.ts

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

packages/lit-query/package.json
packages/lit-query/src/tests/testHost.ts
packages/lit-query/src/tests/mutation-controller.test.ts
packages/lit-query/src/tests/client-switch-controllers.test.ts
packages/lit-query/src/tests/counters-and-state.test.ts
packages/lit-query/src/tests/query-controller.test.ts

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

📝 Walkthrough

Walkthrough

The Lit Query package adds @tanstack/query-test-utils as a development dependency and replaces inline setTimeout-based test delays with the shared sleep helper across controller tests and test helpers.

Changes

Lit Query test timing utility adoption

Layer / File(s)	Summary
Shared sleep utility adoption `packages/lit-query/package.json`, `packages/lit-query/src/tests/client-switch-controllers.test.ts`, `packages/lit-query/src/tests/counters-and-state.test.ts`, `packages/lit-query/src/tests/mutation-controller.test.ts`, `packages/lit-query/src/tests/testHost.ts`	Adds the test utility dependency and replaces inline timer Promises with `sleep` in controller tests and the `waitFor` helper.
Query controller sleep migration `packages/lit-query/src/tests/query-controller.test.ts`	Replaces inline timer Promises with `sleep` across transition, cancellation, lifecycle, retry, provider, zero-delay, and hydration tests.

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

Merge Risk:⚪ Minimal · up to 28570

This change standardizes fixed-delay test code without changing published behavior; no actionable merge-blocking risk remains beyond normal checks and review.

Possibly related PRs

TanStack/query#10910: Both PRs update tests to use the shared sleep utility.
TanStack/query#11209: Both PRs modify packages/lit-query tooling or tests.

Suggested reviewers:tkdodo

🚥 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%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes replacing inline timeout promises with the shared sleep helper in lit-query tests.
Description check	✅ Passed	The description explains the changes and motivation, completes both checklist items, and identifies the change as dev-only with no release impact.
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 💡 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/lit-query-sleep-helper

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

nx-cloud · 2026-07-22T02:44:58Z

View your CI Pipeline Execution ↗ for commit 2857017

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

☁️ Nx Cloud last updated this comment at 2026-08-20 00:44:07 UTC

github-actions · 2026-07-22T02:45:32Z

🚀 Changeset Version Preview

9 package(s) bumped directly, 16 bumped as dependents.

🟨 Minor bumps

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

🟩 Patch bumps

Package	Version	Reason
`@tanstack/lit-query`	0.2.11 → 0.2.12	Changeset
`@tanstack/svelte-query`	6.1.38 → 6.1.39	Changeset
`@tanstack/svelte-query-devtools`	6.1.38 → 6.1.39	Dependent
`@tanstack/svelte-query-persist-client`	6.1.38 → 6.1.39	Dependent
`@tanstack/vue-query-devtools`	6.1.38 → 6.1.39	Dependent

pkg-pr-new · 2026-07-22T02:48:24Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 2857017

github-actions · 2026-07-22T02:49:03Z

size-limit report 📦

Path	Size
react full	12.26 KB (0%)
react minimal	9.21 KB (0%)

TkDodo · 2026-08-18T19:21:14Z

@sukvvon there’s something not quite right here, errors are persistent. do you want to get this over the finish line or should we close it?

sukvvon · 2026-08-19T01:08:21Z

@TkDodo Let's finish it. lit-query is the only package on moduleResolution: NodeNext, tripping TS2835 on query-test-utils's imports. Once #10943 merges and drops that override, this is fixed — verified locally.

… 'testHost.ts'

coderabbitai · 2026-08-20T00:35:17Z

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

test(lit-query): replace inline 'new Promise' timeouts with 'sleep' f…
64ad8e5
…rom 'query-test-utils'

sukvvon self-assigned this Jul 22, 2026

sukvvon marked this pull request as draft July 22, 2026 07:52

TkDodo approved these changes Aug 18, 2026
View reviewed changes

Merge branch 'main' into test/lit-query-sleep-helper
6f08222

Merge branch 'main' into test/lit-query-sleep-helper
844bfec

sukvvon requested a review from TkDodo August 19, 2026 01:10

test(lit-query): replace inline 'new Promise' timeout with 'sleep' in…
9c805d1
… 'testHost.ts'

sukvvon marked this pull request as ready for review August 20, 2026 00:35

Merge branch 'main' into test/lit-query-sleep-helper
2857017

sukvvon merged commit 5e1b866 into mainAug 20, 2026
9 checks passed

sukvvon deleted the test/lit-query-sleep-helper branch August 20, 2026 00:44

Navigation Menu

Uh oh!

Uh oh!

test(lit-query): replace inline 'new Promise' timeouts with 'sleep' from 'query-test-utils' - #11104

test(lit-query): replace inline 'new Promise' timeouts with 'sleep' from 'query-test-utils'#11104
sukvvon merged 5 commits into
mainfrom
test/lit-query-sleep-helper

sukvvon commented Jul 22, 2026•
edited by coderabbitai Bot
Loading

Uh oh!

coderabbitaiBot commented Jul 22, 2026•
edited
Loading

Walkthrough

Changes

❌ Failed checks (1 warning)

Uh oh!

nx-cloudBot commented Jul 22, 2026•
edited
Loading

Uh oh!

github-actionsBot commented Jul 22, 2026•
edited
Loading

Uh oh!

pkg-pr-newBot commented Jul 22, 2026•
edited
Loading

Uh oh!

github-actionsBot commented Jul 22, 2026•
edited
Loading

Uh oh!

TkDodo commented Aug 18, 2026

Uh oh!

sukvvon commented Aug 19, 2026•
edited
Loading

Uh oh!

coderabbitaiBot commented Aug 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Uh oh!

Conversation

sukvvon commented Jul 22, 2026• edited by coderabbitai BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Changes

✅ Checklist

🚀 Release Impact

Summary by CodeRabbit

Uh oh!

coderabbitaiBot commented Jul 22, 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!

nx-cloudBot commented Jul 22, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actionsBot commented Jul 22, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Changeset Version Preview

🟨 Minor bumps

🟩 Patch bumps

Uh oh!

pkg-pr-newBot commented Jul 22, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actionsBot commented Jul 22, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

TkDodo commented Aug 18, 2026

Uh oh!

sukvvon commented Aug 19, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitaiBot commented Aug 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sukvvon commented Jul 22, 2026•
edited by coderabbitai Bot
Loading

coderabbitaiBot commented Jul 22, 2026•
edited
Loading

nx-cloudBot commented Jul 22, 2026•
edited
Loading

github-actionsBot commented Jul 22, 2026•
edited
Loading

pkg-pr-newBot commented Jul 22, 2026•
edited
Loading

github-actionsBot commented Jul 22, 2026•
edited
Loading

sukvvon commented Aug 19, 2026•
edited
Loading