Skip to content

Comments

test(react-query/useQuery): add test for not fetching during restoring period when 'isRestoring' is true#10166

Open
sukvvon wants to merge 3 commits intoTanStack:mainfrom
sukvvon:test/react-query-useBaseQuery-isRestoring
Open

test(react-query/useQuery): add test for not fetching during restoring period when 'isRestoring' is true#10166
sukvvon wants to merge 3 commits intoTanStack:mainfrom
sukvvon:test/react-query-useBaseQuery-isRestoring

Conversation

@sukvvon
Copy link
Contributor

@sukvvon sukvvon commented Feb 22, 2026

🎯 Changes

Add a test to cover the isRestoring branch in useBaseQuery.ts (line 78).

When IsRestoringProvider provides true, the query should remain in pending status with fetchStatus: 'idle' and never call queryFn, even after the query's sleep duration has elapsed.

✅ 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
    • Added test coverage verifying that queries remain idle and do not fetch during the restoration state, ensuring expected behavior is maintained.

@changeset-bot
Copy link

changeset-bot bot commented Feb 22, 2026

⚠️ No Changeset found

Latest commit: 9c52153

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
Copy link
Contributor

coderabbitai bot commented Feb 22, 2026

No actionable comments were generated in the recent review. 🎉


📝 Walkthrough

Walkthrough

A new test case is added to verify that useQuery respects the isRestoring state, ensuring queries remain idle and don't trigger fetches when the restoring provider indicates an active restoration period.

Changes

Cohort / File(s) Summary
useQuery Test Suite
packages/react-query/src/__tests__/useQuery.test.tsx
Added test scenario importing IsRestoringProvider to verify that useQuery does not initiate fetches during the restoring window, with assertions confirming pending status, idle fetchStatus, undefined data, and no queryFn invocation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested reviewers

  • TkDodo
  • manudeli

Poem

🐰 A test hops in with restoring grace,
To keep the queries in their place,
No fetches while the state's restored,
The idle fetchStatus is adored!

🚥 Pre-merge checks | ✅ 2 | ❌ 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 (2 passed)
Check name Status Explanation
Title check ✅ Passed The PR title accurately describes the main change: adding a test for the isRestoring behavior in useQuery, which directly corresponds to the test file modifications.
Description check ✅ Passed The PR description follows the template structure with all required sections completed: Changes section explains the test's purpose clearly, Checklist items are marked appropriately, and Release Impact correctly identifies it as dev-only.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

@nx-cloud
Copy link

nx-cloud bot commented Feb 22, 2026

View your CI Pipeline Execution ↗ for commit 9c52153

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

☁️ Nx Cloud last updated this comment at 2026-02-22 13:02:25 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Feb 22, 2026

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/preact-query

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 9c52153

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant