test(react-query/ssr): add 'useIsFetching' test for SSR by sukvvon · Pull Request #9994 · TanStack/query

sukvvon · 2025-12-28T06:28:20Z

🎯 Changes

Add useIsFetching test for SSR in ssr.test.tsx.

✅ 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

New Features
- useIsFetching hook is now exported from the public API and available for use.
Tests
- Added server-side rendering test coverage for useIsFetching to validate fetching state behavior.

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

changeset-bot · 2025-12-28T06:28:25Z

⚠️ No Changeset found

Latest commit: 29aa8fb

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-12-28T06:28:37Z

📝 Walkthrough

Walkthrough

A new SSR test case was added to validate the useIsFetching hook behavior after query prefetching in server-side rendering. The test imports useIsFetching into the public API usage and verifies that the fetching state correctly reflects zero after a prefetch operation completes.

Changes

Cohort / File(s)	Summary
SSR Test Updates `packages/react-query/src/__tests__/ssr.test.tsx`	Added import of `useIsFetching` hook from public API; introduced new test case that creates a Page component using `useQuery` and `useIsFetching`, prefetches a query, renders to string, and asserts that the rendered output contains data and `isFetching` equals 0 after prefetch completes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A fetch hook now dances in SSR's light,
useIsFetching tested, the state burns bright,
Prefetch, render, assert—all done just right,
Queries hop forward through the server's night! ✨

Pre-merge checks and finishing touches

❌ 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%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: adding a useIsFetching test for SSR scenarios.
Description check	✅ Passed	The description follows the template with all required sections completed, including changes, checklist items marked, and release impact clarification.

✨ Finishing touches

📝 Generate docstrings

🧪 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 · 2025-12-28T06:28:47Z

View your CI Pipeline Execution ↗ for commit 29aa8fb

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

☁️ Nx Cloud last updated this comment at 2025-12-28 06:33:40 UTC

pkg-pr-new · 2025-12-28T06:30:09Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 29aa8fb

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/react-query/src/__tests__/ssr.test.tsx (1)
178-207: Excellent test coverage for useIsFetching in SSR!

The test correctly validates that useIsFetching returns 0 after a prefetch completes in server-side rendering. The logic follows the established pattern: prefetch → wait → render → assert.

Consider wrapping queryFn with vi.fn() for consistency with similar tests (lines 33, 78, 141) and to add a call-count assertion:
Optional refactor for consistency
-    const queryFn = () => sleep(10).then(() => 'data')
+    const queryFn = vi.fn(() => sleep(10).then(() => 'data'))
Then add after line 204:
     expect(markup).toContain('data')
     expect(markup).toContain('isFetching: 0')
+    expect(queryFn).toHaveBeenCalledTimes(1)
This would verify that the query was prefetched exactly once and not re-fetched during render.

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5810292 and 29aa8fb.

📒 Files selected for processing (1)

packages/react-query/src/__tests__/ssr.test.tsx

🧰 Additional context used

🧠 Learnings (1)

📚 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/src/__tests__/ssr.test.tsx

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

GitHub Check: Test
GitHub Check: Preview

🔇 Additional comments (1)

packages/react-query/src/__tests__/ssr.test.tsx (1)

10-10: LGTM! Clean import addition.

The useIsFetching import is correctly placed and necessary for the new test case.

codecov · 2025-12-28T06:33:54Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.91%. Comparing base (f64ac77) to head (29aa8fb).
⚠️ Report is 9 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #9994       +/-   ##
===========================================
+ Coverage   45.89%   83.91%   +38.02%     
===========================================
  Files         200       26      -174     
  Lines        8437      373     -8064     
  Branches     1933      110     -1823     
===========================================
- Hits         3872      313     -3559     
+ Misses       4116       51     -4065     
+ Partials      449        9      -440

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	`96.34% <ø> (+0.33%)`	⬆️
@tanstack/react-query-devtools	`9.25% <ø> (ø)`
@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.

test(react-query/ssr): add 'useIsFetching' test for SSR

29aa8fb

github-actions bot added the package: react-query label Dec 28, 2025

coderabbitai bot reviewed Dec 28, 2025

View reviewed changes

TkDodo merged commit 642f72d into TanStack:main Dec 28, 2025
9 checks passed

coderabbitai bot mentioned this pull request Jan 11, 2026

feat: Preact Adapter #9935

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Comments

test(react-query/ssr): add 'useIsFetching' test for SSR#9994

test(react-query/ssr): add 'useIsFetching' test for SSR#9994
TkDodo merged 1 commit intoTanStack:mainfrom
sukvvon:test/react-query-use-is-fetching-ssr

sukvvon commented Dec 28, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Dec 28, 2025

Uh oh!

coderabbitai bot commented Dec 28, 2025 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

nx-cloud bot commented Dec 28, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Dec 28, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

codecov bot commented Dec 28, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Comments

Conversation

sukvvon commented Dec 28, 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 Dec 28, 2025

⚠️ No Changeset found

Uh oh!

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

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Pre-merge checks and finishing touches

Uh oh!

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

Uh oh!

Uh oh!

pkg-pr-new bot commented Dec 28, 2025

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sukvvon commented Dec 28, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 28, 2025 •

edited

Loading

nx-cloud bot commented Dec 28, 2025 •

edited

Loading

codecov bot commented Dec 28, 2025 •

edited

Loading