Skip to content

ref: switch to use() - #11237

Open
TkDodo wants to merge 3 commits into
mainfrom
tkdodo/ref/use-over-throw
Open

ref: switch to use()#11237
TkDodo wants to merge 3 commits into
mainfrom
tkdodo/ref/use-over-throw

Conversation

@TkDodo

@TkDodo TkDodo commented Aug 20, 2026

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Bug Fixes

    • Improved Suspense behavior across queries, including promise reuse, parallel loading, fallback handling, and error recovery.
    • Improved support for transitioned queries and cached or stale data.
    • Enhanced compatibility across React versions when handling Suspense-enabled queries.
  • Tests

    • Expanded coverage for Suspense queries, infinite queries, prefetching, retries, skip tokens, and error boundaries.
    • Improved validation of asynchronous rendering and loading states.

@nx-cloud

nx-cloud Bot commented Aug 20, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit c0c7462

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

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

@coderabbitai

coderabbitai Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: 6f8c2966-dbd7-49ba-9c65-b44c9085a5fa

📥 Commits

Reviewing files that changed from the base of the PR and between 64e861f and c0c7462.

📒 Files selected for processing (8)
  • packages/react-query/src/__tests__/QueryResetErrorBoundary.test.tsx
  • packages/react-query/src/__tests__/suspense.test.tsx
  • packages/react-query/src/__tests__/usePrefetchInfiniteQuery.test.tsx
  • packages/react-query/src/__tests__/usePrefetchQuery.test.tsx
  • packages/react-query/src/__tests__/useSuspenseInfiniteQuery.test.tsx
  • packages/react-query/src/__tests__/useSuspenseQueries.test.tsx
  • packages/react-query/src/__tests__/useSuspenseQuery.test.tsx
  • packages/react-query/src/__tests__/utils.tsx

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


📝 Walkthrough

Walkthrough

React Query now caches suspense promises, consumes them through React's use, and starts multiple suspense queries before suspension. Tests use an asynchronous suspense renderer and asynchronous act for retries and query updates.

Changes

Suspense integration

Layer / File(s) Summary
Suspense promise handling and query hook flow
packages/react-query/src/suspense.ts, packages/react-query/src/useBaseQuery.ts, packages/react-query/src/useQueries.ts
Added React-compatible thenable handling and per-query promise caching. Query hooks now consume suspense promises with use(), and useQueries starts all suspense fetches before suspension.
Suspense test renderer and query suites
packages/react-query/src/__tests__/utils.tsx, packages/react-query/src/__tests__/suspense.test.tsx, packages/react-query/src/__tests__/useSuspenseQuery.test.tsx, packages/react-query/src/__tests__/useSuspenseQueries.test.tsx, packages/react-query/src/__tests__/useSuspenseInfiniteQuery.test.tsx
Renamed and expanded the suspense renderer. Tests now use configurable fallbacks, await suspense rendering, and wrap asynchronous interactions in act.
Prefetch and error-boundary test updates
packages/react-query/src/__tests__/QueryResetErrorBoundary.test.tsx, packages/react-query/src/__tests__/usePrefetchQuery.test.tsx, packages/react-query/src/__tests__/usePrefetchInfiniteQuery.test.tsx
Updated suspense rendering helpers and asynchronous retry interactions while preserving existing assertions.
Release metadata
.changeset/tasty-ears-study.md
Added a patch Changeset for the suspense implementation change.

Estimated code review effort: 4 (Complex) | ~45 minutes

Merge Risk: ⚪ Minimal · up to c0c74

This PR refactors suspense query handling to use use() and updates the related tests; no actionable merge-blocking risk is present in the supplied evidence.

Sequence Diagram(s)

sequenceDiagram
  participant QueryHook
  participant SuspenseUtilities
  participant React
  QueryHook->>SuspenseUtilities: request suspense promise
  SuspenseUtilities-->>QueryHook: return cached or new promise
  QueryHook->>React: call use with thenable
  React-->>QueryHook: suspend until settlement
  React-->>QueryHook: render data or throw error
Loading
🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Description check ⚠️ Warning No pull request description was provided, so the required changes, checklist, and release impact sections are missing. Add a description with the required Changes, Checklist, and Release Impact sections, including test and changeset status.
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 (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: switching React Suspense handling to use().
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 tkdodo/ref/use-over-throw

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.

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

10 package(s) bumped directly, 15 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-broadcast-client-experimental 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-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

pkg-pr-new Bot commented Aug 20, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: c0c7462

@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 12.12 KB (+1.2% 🔺)
react minimal 9.1 KB (+1.98% 🔺)

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