test(react-query-persist-client/PersistQueryClientProvider): replace 'await sleep' with 'sleep().then()' pattern in restoreClient and add additional timer advance for refetch verification #9901

sukvvon · 2025-11-23T17:36:34Z

🎯 Changes

✅ 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
- Enhanced test coverage to verify that persisted data maintains stability across extended delays.
Bug Fixes
- Refined error handling timing in the persist client to ensure errors are thrown consistently after a short delay, improving reliability of error scenarios.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

…'await sleep' with 'sleep().then()' pattern in restoreClient and add additional timer advance for refetch verification

changeset-bot · 2025-11-23T17:36:37Z

⚠️ No Changeset found

Latest commit: ecc6a51

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

coderabbitai · 2025-11-23T17:36:39Z

Walkthrough

A test file for PersistQueryClientProvider has been modified to adjust error handling behavior in an error persister and add additional timer advancement to verify the stability of hydrated state across extended simulated delays.

Changes

Cohort / File(s)	Summary
PersistQueryClientProvider Tests `packages/react-query-persist-client/src/__tests__/PersistQueryClientProvider.test.tsx`	Modified error persister to return a promise that resolves after a 10ms delay before throwing, replacing async/await pattern. Added additional timer advancement (11ms) in test assertions to verify hydrated state stability.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Verify the promise-based error handling pattern correctly replicates the intended timing behavior
Confirm additional timer advancement value (11ms) aligns with test intent and doesn't introduce flakiness

Possibly related PRs

test(react-query-persist-client/PersistQueryClientProvider): switch to fake timers, replace 'await' with 'advanceTimersByTimeAsync', and use 'sleep().then()' pattern #9859 — Modifies the same test file and adjusts async delay handling patterns (await/sleep vs. timer-based approaches)
test(react-query-persist-client/use-queries-with-persist): switch to fake timers, replace 'waitFor' with 'vi.advanceTimersByTimeAsync', and replace 'setTimeout' with 'sleep' #9850 — Related timing behavior changes in react-query-persist-client tests affecting restoreClient/hydration timing

Suggested reviewers

manudeli

Poem

🐰 A promise delayed by ten small ticks,
Then throws with flair—no async tricks!
Eleven more to check the state,
Hydration holds—our tests are great!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main changes: refactoring async patterns in tests and adding timer verification.
Description check	✅ Passed	The description follows the template structure with all required sections completed, including checklist items and release impact assessment.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c9bc600 and ecc6a51.

📒 Files selected for processing (1)

packages/react-query-persist-client/src/__tests__/PersistQueryClientProvider.test.tsx (2 hunks)

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: sukvvon
Repo: TanStack/query PR: 9892
File: packages/solid-query-persist-client/src/__tests__/PersistQueryClientProvider.test.tsx:331-335
Timestamp: 2025-11-22T09:06:05.219Z
Learning: In TanStack/query test files, when a queryFn contains side effects (e.g., setting flags for test verification), prefer async/await syntax for clarity; when there are no side effects, prefer the .then() pattern for conciseness.

📚 Learning: 2025-11-22T09:06:05.219Z

Learnt from: sukvvon
Repo: TanStack/query PR: 9892
File: packages/solid-query-persist-client/src/__tests__/PersistQueryClientProvider.test.tsx:331-335
Timestamp: 2025-11-22T09:06:05.219Z
Learning: In TanStack/query test files, when a queryFn contains side effects (e.g., setting flags for test verification), prefer async/await syntax for clarity; when there are no side effects, prefer the .then() pattern for conciseness.

Applied to files:

packages/react-query-persist-client/src/__tests__/PersistQueryClientProvider.test.tsx

🔇 Additional comments (2)

packages/react-query-persist-client/src/__tests__/PersistQueryClientProvider.test.tsx (2)

44-46: LGTM! Aligns with coding style preference.

The change from await sleep(10) followed by throw error to sleep(10).then(() => { throw error }) maintains identical behavior while following the preferred pattern for functions without side effects.

Based on learnings, the .then() pattern is preferred for conciseness when there are no side effects to track.

419-420: LGTM! Improves test robustness.

The additional 11ms timer advance with verification that data remains 'hydrated' strengthens the test by confirming that the hydrated state is stable and no refetch occurs even after sufficient time has passed for a potential refetch to complete. This aligns with the test's intent to verify that staleTime: Infinity prevents refetching.

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

nx-cloud · 2025-11-23T17:37:03Z

View your CI Pipeline Execution ↗ for commit ecc6a51

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

☁️ Nx Cloud last updated this comment at 2025-11-23 17:39:55 UTC

pkg-pr-new · 2025-11-23T17:38:06Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: ecc6a51

codecov · 2025-11-23T17:40:13Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (ae47807) to head (ecc6a51).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##             main     #9901       +/-   ##
============================================
+ Coverage   45.70%   100.00%   +54.29%     
============================================
  Files         200         1      -199     
  Lines        8437        18     -8419     
  Branches     1936         2     -1934     
============================================
- Hits         3856        18     -3838     
+ Misses       4133         0     -4133     
+ Partials      448         0      -448

Components	Coverage Δ
@tanstack/angular-query-experimental	`∅ <ø> (∅)`
@tanstack/eslint-plugin-query	`∅ <ø> (∅)`
@tanstack/query-async-storage-persister	`∅ <ø> (∅)`
@tanstack/query-broadcast-client-experimental	`∅ <ø> (∅)`
@tanstack/query-codemods	`∅ <ø> (∅)`
@tanstack/query-core	`∅ <ø> (∅)`
@tanstack/query-devtools	`∅ <ø> (∅)`
@tanstack/query-persist-client-core	`∅ <ø> (∅)`
@tanstack/query-sync-storage-persister	`∅ <ø> (∅)`
@tanstack/query-test-utils	`∅ <ø> (∅)`
@tanstack/react-query	`∅ <ø> (∅)`
@tanstack/react-query-devtools	`∅ <ø> (∅)`
@tanstack/react-query-next-experimental	`∅ <ø> (∅)`
@tanstack/react-query-persist-client	`100.00% <ø> (ø)`
@tanstack/solid-query	`∅ <ø> (∅)`
@tanstack/solid-query-devtools	`∅ <ø> (∅)`
@tanstack/solid-query-persist-client	`∅ <ø> (∅)`
@tanstack/svelte-query	`∅ <ø> (∅)`
@tanstack/svelte-query-devtools	`∅ <ø> (∅)`
@tanstack/svelte-query-persist-client	`∅ <ø> (∅)`
@tanstack/vue-query	`∅ <ø> (∅)`
@tanstack/vue-query-devtools	`∅ <ø> (∅)`

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

TkDodo · 2025-11-25T10:37:49Z

packages/react-query-persist-client/src/__tests__/PersistQueryClientProvider.test.tsx

-        await sleep(10)
-        throw error
+        return sleep(10).then(() => {
+          throw error
+        })


same question: why? are there any functional difference ?

@TkDodo If we apply the pattern from #9900 (comment), we could write it like this:

return sleep(10).then(() => Promise.reject(error))

What do you think about this approach?

test(react-query-persist-client/PersistQueryClientProvider): replace …

ecc6a51

…'await sleep' with 'sleep().then()' pattern in restoreClient and add additional timer advance for refetch verification

github-actions bot added the package: react-query-persist-client label Nov 23, 2025

sukvvon marked this pull request as ready for review November 23, 2025 17:40

TkDodo reviewed Nov 25, 2025

View reviewed changes

sukvvon requested a review from TkDodo November 30, 2025 10:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

test(react-query-persist-client/PersistQueryClientProvider): replace 'await sleep' with 'sleep().then()' pattern in restoreClient and add additional timer advance for refetch verification #9901

test(react-query-persist-client/PersistQueryClientProvider): replace 'await sleep' with 'sleep().then()' pattern in restoreClient and add additional timer advance for refetch verification #9901

sukvvon commented Nov 23, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Nov 23, 2025

Uh oh!

coderabbitai bot commented Nov 23, 2025 •

edited

Loading

Uh oh!

nx-cloud bot commented Nov 23, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Nov 23, 2025

Uh oh!

codecov bot commented Nov 23, 2025 •

edited

Loading

Uh oh!

TkDodo Nov 25, 2025

Uh oh!

sukvvon Nov 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

test(react-query-persist-client/PersistQueryClientProvider): replace 'await sleep' with 'sleep().then()' pattern in restoreClient and add additional timer advance for refetch verification #9901

Are you sure you want to change the base?

test(react-query-persist-client/PersistQueryClientProvider): replace 'await sleep' with 'sleep().then()' pattern in restoreClient and add additional timer advance for refetch verification #9901

Conversation

sukvvon commented Nov 23, 2025 • 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!

changeset-bot bot commented Nov 23, 2025

⚠️ No Changeset found

Uh oh!

coderabbitai bot commented Nov 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

nx-cloud bot commented Nov 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new bot commented Nov 23, 2025

Uh oh!

codecov bot commented Nov 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

TkDodo Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

sukvvon Nov 30, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sukvvon commented Nov 23, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 23, 2025 •

edited

Loading

nx-cloud bot commented Nov 23, 2025 •

edited

Loading

codecov bot commented Nov 23, 2025 •

edited

Loading