Repository navigation
Conversation
A query whose callback returns undefined has no collection, so the server never captures or streams a record for it. The browser hydration read still waited on its hash: it suspended while the DB stream was open and threw error 253 once the stream ended, so React fell back to client rendering. Skip the hydration wait when the observer has no collection. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: 2d11707 The changes in this PR will be included in the next version bump. This PR includes changesets to release 24 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Browser SSR wait and stream-state coverage packages/db/src/live-query-observer-client.ts, packages/db/tests/ssr-stream-record-wait-oracle.test.ts, docs/contributing/oracle-coverage.md, .changeset/disabled-query-hydration.md |
The browser SSR wait now requires a collection. Oracle coverage checks that a disabled observer remains disabled across stream states. The docs and changeset describe the behavior. |
React SSR end-to-end coverage examples/react/start-ssr-e2e/src/routes/disabled-query.tsx, examples/react/start-ssr-e2e/src/routeTree.gen.ts, examples/react/start-ssr-e2e/e2e/ssr-db.spec.ts |
The example adds and registers /disabled-query. The end-to-end test checks hydration completion, disabled query status, and browser errors. |
Estimated code review effort: 2 (Simple) | ~10 minutes
Change: Bug fix · Severity of issue fixed: Medium
Possibly related PRs
- TanStack/db#2168: Introduced the live-query status model and disabled-query result semantics used by this change.
- TanStack/db#2229: Updated SSR snapshot preparation and subscription demand; this change also modifies the browser SSR snapshot path.
Suggested reviewers: kyleamathews, tannerlinsley
Merge Risk: 
2d117
-
The disabled-query hydration change is ready to merge with no established blocking risk.
Pre-merge checks: 
-
Check name Status Explanation Resolution Docstring Coverage Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat… Write docstrings for the functions missing them to satisfy the coverage threshold. -
Check name Status Explanation Title check The title "fix(db): hydrate disabled live queries without a stream record" matches the main change. The PR makes LiveQueryObserverClient.getServerSnapshot skip the hydration wait when a live query has… Description check The description follows the repository template. It includes the Changes section with the motivation and the fix (one condition in getServerSnapshot). It includes the Oracle Coverage section, which na… Linked Issues check Issue [ #2322] requires a disableduseLiveQueryto hydrate withstatus: 'disabled'without waiting for a server record.LiveQueryObserverClient.getServerSnapshotnow skips the SSR wait when `this…Out of Scope Changes check The production guard directly fixes [ #2322]. The core oracle, end-to-end route and test, generated route metadata, coverage documentation, and patch changeset support or document that fix. No unrelate…Full details: Title check
-
Explanation
The title "fix(db): hydrate disabled live queries without a stream record" matches the main change. The PR makes LiveQueryObserverClient.getServerSnapshot skip the hydration wait when a live query has no collection (its query callback returns undefined), so disabled queries hydrate with status 'disabled' and no server record. The title is specific, uses a conventional prefix, and names the affected package and behavior.
Full details: Description check
-
Explanation
The description follows the repository template. It includes the Changes section with the motivation and the fix (one condition in getServerSnapshot). It includes the Oracle Coverage section, which names the violated law, the core owner test file, the RED/GREEN results for the unit property test and the Start e2e host, and the remaining limits. It also includes the Checklist with the test run and the Release Impact section with the changeset box checked. The description has a few minor gaps: it does not state the coverage-map owner by its exact name in the template's terms, and the Oracle Coverage section is long for a single condition change. These gaps do not reduce completeness.
Full details: Linked Issues check
-
Explanation
Issue [
#2322] requires a disableduseLiveQueryto hydrate withstatus: 'disabled'without waiting for a server record.LiveQueryObserverClient.getServerSnapshotnow skips the SSR wait whenthis.collectionis absent. The new core oracle checks disabled status while transport is open, after terminal events, and on a fresh stream. The new/disabled-queryPlaywright test checks hydration,disabledstatus, and no browser errors.
Full details: Out of Scope Changes check
-
Explanation
The production guard directly fixes [
#2322]. The core oracle, end-to-end route and test, generated route metadata, coverage documentation, and patch changeset support or document that fix. No unrelated change is demonstrated.
-
Full details: Docstring Coverage
-
Explanation
Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 2 functions across 5 files. (2 skipped: 2 unsupported.)
Resolution
Write docstrings for the functions missing them to satisfy the coverage threshold.
-
Finishing Touches
-
Generate unit tests (beta)
-
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
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.
Fixes #2322
🎯 Changes
A live query whose
querycallback returnsundefinedhas no collection. The server returns the disabled snapshot and never captures or streams a record for its hash. On the browser,LiveQueryObserverClient.getServerSnapshotstill waited for that record. The read suspended while the DB stream was open and threw error 253 after the stream ended, so hydration fell back to client rendering.The fix skips the hydration wait when the observer has no collection (one condition in
getServerSnapshot). Every framework adapter goes through this shared binding.🔬 Oracle Coverage
Violated law: a reader's first hydration view reproduces its server view. A disabled reader rendered
disabledon the server and has no record, so it owes no wait.packages/db/tests/ssr-stream-record-wait-oracle.test.ts): adds a disabled peer reader, with a portable hash, to every generated history (missing, pending, or local record × arrival, close, error, or cleanup × late attempt, peer-first, undefined cause, restart).getServerSnapshot().statusmust bedisabledwhile transport is open, after each terminal event, and on a fresh stream after cleanup.closehistory fails with "The DB stream ended before the server-rendered query snapshot arrived."examples/react/start-ssr-e2e): a new/disabled-queryroute and a case ine2e/ssr-db.spec.ts. They use the real Start serializer, the Router DB stream receiver,hydrateRoot, and Chromium.vite preview(production build) andvite dev. The error event's cause is error 253 from_setSsrStreamingEnabled.Limits: server/browser disagreement on whether a query is enabled is a separate hydration mismatch and is not covered here.
✅ Checklist
pnpm test. I ran thedbSSR, observer andDbClientsuites, the fullreact-dbsuite,react-router-with-db, and the Start e2e spec.🚀 Release Impact
🤖 Generated with Claude Code
Summary by CodeRabbit