Open History to see the last commit
TanStack DB SSR Release Plan#
Release Goal#
Ship TanStack DB SSR as a single coherent story:
- explicit collection-row hydration and live-query result snapshots through
DbClient - React and Svelte provider and descriptor resolution
- derived live query identity with
queryKeyonly when necessary - backwards-compatible dependency arrays with dev warnings until 1.0
- a working TanStack Start demo and E2E proof
Pre-release Validation#
- Run
pnpm --filter @tanstack/db test. - Run
pnpm --filter @tanstack/react-db test. - Run
pnpm --filter @tanstack/svelte-db test. - Run
pnpm --filter @tanstack/react-router-with-db test(includes type tests). - Run
pnpm --filter @tanstack/query-db-collection test. - Run
pnpm --filter @tanstack/db-sqlite-persistence-core test. - Run
pnpm --filter @tanstack/db-example-react-start-ssr-e2e test:e2e. - Run
pnpm --filter @tanstack/db-example-react-next-ssr-e2e test:e2e. - Run
pnpm test:docs. - Run
pnpm test:sherif. - Run
pnpm build.
Demo#
- Live URL: https://tanstack-db-ssr-demo.netlify.app/ssr-db
- Deploy
examples/react/start-ssr-e2eto an SSR-capable host. - Verify the deployed
/ssr-dbroute serves SSR HTML with hydrated rows. - Verify browser hydration succeeds without console/page errors.
- Verify the streamed collection chunk updates the live query.
- Verify
/ssr-db-streamstreams a projected result, omits source-only data, and hands off to browser sync. - Run
PLAYWRIGHT_BASE_URL=https://tanstack-db-ssr-demo.netlify.app pnpm --filter @tanstack/db-example-react-start-ssr-e2e test:e2e:hosted. - Add the live URL to the PR description and release notes.
Docs#
- Publish the SSR and Hydration guide.
- Link the guide from overview, quick start, live queries, and React overview.
- Regenerate API reference docs in a dedicated docs-maintenance pass if broad TypeDoc output churn is acceptable.
- Confirm docs explain when
queryKeyis necessary and when it should be omitted. - Confirm docs say dependency arrays warn now and are removed in 1.0.
Migration Messaging#
- Lead with: explicit collection preloads transport normalized rows; live-query preloads transport only their result snapshot.
- Emphasize that existing apps keep working.
- State that
createCollection(...)remains available, but SSR apps should usecollectionOptions(...)plusDbClient. - Explain that React dependency arrays are deprecated with a 1.0 removal path.
- Show
queryKeyonly for opaque functional query logic or hot render paths.
Announcement Checklist#
- PR description includes high-level summary, migration cheat sheet, and test commands.
- Release notes include a "No removals in this release" compatibility section.
- Discord announcement links the SSR guide and live demo.
- Example migration diff is available from the Start SSR demo.
- Follow-up issues are filed for the remaining framework adapters and API reference generation if they are not part of the shipping PR.