Skip to content

feat(solid-query): built-in single-flight consumer via FLIGHT_DATA_SOURCE - #11326

Open
ryansolid wants to merge 3 commits into
TanStack:solid-query-v6-prefrom
ryansolid:feat/flight-data-source
Open

feat(solid-query): built-in single-flight consumer via FLIGHT_DATA_SOURCE#11326
ryansolid wants to merge 3 commits into
TanStack:solid-query-v6-prefrom
ryansolid:feat/flight-data-source

Conversation

@ryansolid

@ryansolid ryansolid commented Aug 29, 2026

Copy link
Copy Markdown

Draft — depends on the unreleased @solidjs/web multi-source single-flight protocol (solidjs/solid@653dd41e). Ready to land once that ships and the peer range bumps.

Summary

Solid's single-flight channel is becoming multi-source: a mutation response can carry a keyed envelope of per-cache slices, each routed to the consumer subscribed under its source id. Independent caches — Solid Router's route data and the TanStack Query cache — refresh from one round trip without competing for the single legacy consumer slot (which previously meant whichever library subscribed last silently displaced the other).

This PR internalizes the query cache's half:

  • QueryClientProvider subscribes a consumer under the new exported FLIGHT_DATA_SOURCE id ("sq", matching the sq: hydration-registry namespace). A mutation response carrying that slice — a DehydratedState — hydrates the provider's client before the mutation's promise resolves: mounted queries on those keys update in the same beat, with no follow-up refetches.
  • The server half stays app/framework territory (producing the data requires the app's router/loaders), registered additively under the same id. With TanStack Router the collector is a two-primitive composition — the router's trigger, the cache's extraction:
import { registerFlightDataSource } from '@solidjs/web/server-functions/server'
import { loadFlightTarget } from '@tanstack/solid-router/ssr/server'
import { FLIGHT_DATA_SOURCE, dehydrateSettled } from '@tanstack/solid-query'

registerFlightDataSource(FLIGHT_DATA_SOURCE, (event, outcome) => {
  if (!outcome.targetUrl) return undefined
  const queryClient = createQueryClient()
  return loadFlightTarget({
    router: createAppRouter(queryClient),
    event,
    outcome,
    collect: async () => {
      const state = await dehydrateSettled(queryClient)
      return state.queries.length > 0 ? state : undefined
    },
  })
})

Apps delete their hand-rolled subscribeFlightData(...) + hydrate(...) client wiring entirely. Subscribing is inert when no server collector exists (the server folds nothing for the source), client-only (the server-side consumer registry is module state shared across requests), and torn down with the provider.

New: dehydrateSettled, SSR teardown, dehydrate filtering

Three additions that complete the native SSR/flight story (covering everything router-ssr-query-core's transport provided, on the query side):

  • dehydrateSettled(client, options?) — the extraction half of a flight collector. Route loaders commonly fire prefetches without awaiting them; plain dehydrate() would snapshot those mid-fetch and ship nothing. Waits for every in-flight fetch, chased to quiescence (a settled batch can dispatch dependent fetches), then dehydrates.
  • SSR teardown — the provider cancels and clears the per-request cache when the server render disposes. Query-core defaults gcTime to Infinity on the server, but any app setting a finite gcTime in defaultOptions would otherwise pin the per-request client (and everything its queries closed over) until the timers fire.
  • Dehydrate filtering — the registry serializer now respects defaultOptions.dehydrate.shouldDehydrateQuery, so apps keep sensitive or oversized queries out of the HTML payload with the same knob they'd pass any other transport. Consulted per cache event until it passes, so a filter rejecting pending queries still admits the settled value if it lands while the request's serialization context is live.

Before landing (once @solidjs/web 2.0.0-rc.5 ships)

  • Delete the subscribeFlightSource typed shim in QueryClientProvider.tsx — call the named-source subscribeFlightData(FLIGHT_DATA_SOURCE, ...) overload directly.
  • Bump the @solidjs/web peer floor to rc.5.

This PR deliberately waits for the release rather than landing with the shim: the whole stack (this, TanStack/router#8192, solidjs/templates#287) ships in lockstep, so landing early buys nothing and leaves cleanup to forget.

Notes

  • A typed shim bridges the installed @solidjs/web declarations until the named-source overload ships and the peer range bumps; it should be removed at that point.
  • Tests drive the registered consumer directly (registration lifecycle, hydration of mounted queries without refetch, seeding never-mounted entries); the wire protocol itself — request-leg source negotiation, keyed envelope, slice routing, per-source error containment, legacy degradation — is tested in @solidjs/web's suite.
  • Pairs with the SSR story already in v6: initial-load transfer is content-addressed through the hydration registry (sq:<queryHash>), post-mutation transfer is source-addressed through the flight envelope (sq) — the same recognition model at two moments.

Verification

  • flightData.test.tsx (consumer) and dehydrateSettled.test.tsx (settling, quiescence-chasing, failure settling + option forwarding) passing; the SSR fixture suite gained teardown (cacheEmptyAfterDispose on both string and streaming renders) and filter assertions (the filtered query's registry entry stays off the wire while others — including a never-rendered prefetch — still ship).
  • Full solid-query suite: 28 files, 352 passed / 1 intentionally skipped, type check clean, against a locally built @solidjs/web carrying the protocol.

Made with Cursor

…URCE

Solid's single-flight channel is becoming multi-source (solidjs/solid
653dd41e): mutation responses carry a keyed envelope of per-cache
slices, each routed to the consumer subscribed under its source id, so
independent caches (Solid Router's route data, the query cache) refresh
from one round trip without competing for the single legacy slot.

QueryClientProvider now subscribes the query cache's consumer under the
exported FLIGHT_DATA_SOURCE id ("sq", matching the sq: hydration-registry
namespace): a mutation response carrying that slice — a DehydratedState
produced by a server collector registered with
registerFlightDataSource(FLIGHT_DATA_SOURCE, hook) — hydrates the
provider's client before the mutation's promise resolves. Mounted
queries on those keys update with no follow-up refetches, and apps
delete the hand-rolled subscribeFlightData/hydrate wiring entirely.
Subscribing is inert when no server collector exists (the server folds
nothing), client-only (the server registry is cross-request module
state), and torn down with the provider.

Requires the @solidjs/web release following 2.0.0-rc.4 for the
named-source protocol; a typed shim bridges the installed declarations
until the peer range bumps.

Co-authored-by: Cursor <cursoragent@cursor.com>
@coderabbitai

coderabbitai Bot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: a353b061-5117-4d1c-8694-3d7314b5b1d4

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

…ering

Fills the gaps the router-ssr-query transport used to cover, natively:

- dehydrateSettled(client): the extraction half of a single-flight
  collector — waits for every in-flight fetch (chased to quiescence) so
  loaders' fire-and-forget prefetches land before dehydrating.
- SSR teardown: the provider cancels and clears the per-request cache on
  render disposal, so user-configured finite gcTime timers cannot pin the
  client after the response.
- The registry serializer now respects defaultOptions.dehydrate
  .shouldDehydrateQuery, the same knob apps use on any other transport.

Co-authored-by: Cursor <cursoragent@cursor.com>
ryansolid added a commit to solidjs/solid that referenced this pull request Sep 1, 2026
…ainst workspace-built core

Core-side suites structurally cannot represent the adapter's composed
shapes — rc.5 shipped a settle-walk regression (#3181's fix waking parked
readers into uninitialized projections) that only the adapter's own suite
could see: premature wakes are self-healing for ordinary async nodes and
corrupt only through an empty-seed projection over a stable chained
promise with boundary-parked readers.

The gate packs signals/solid/web from the tree, downloads the adapter
repo, forces resolution through pnpm-workspace.yaml overrides (pnpm 11
ignores package.json pnpm.overrides), asserts the tarballs actually
resolved via file+ store realpaths (a version compare cannot tell tarball
from registry), builds the TS reference graph, and runs the full suite.
Wired into scripts/release.mjs before publish so a candidate that breaks
the flagship adapter fails on the runner, not on npm. Tracks the PR head
carrying the Solid 2.0 pairing until TanStack/query#11326 merges to main.

Co-authored-by: Cursor <cursoragent@cursor.com>
ryansolid added a commit to ryansolid/tanstack-router that referenced this pull request Sep 2, 2026
Solid's single-flight channel is becoming multi-source (solidjs/solid
653dd41e): mutation responses carry a keyed envelope of per-cache
slices, each routed to the consumer subscribed under its source id.
Today Start claims the single unnamed slot on both halves, which means
any other cache wanting mutation-response data (e.g. solid-query, whose
provider subscribes under "sq" in TanStack/query#11326) displaces the
router's — whichever registers last wins, silently.

The router's flight data now rides its own source id ("tsr"): the
server collector registers additively with registerFlightDataSource and
the client subscribes its consumer under the same id, so router
loader/match state and other caches' slices coexist on one round trip.
A user-supplied collectFlightData hook keeps the unnamed slot to itself,
adding data alongside the router's instead of displacing it.

Both halves feature-detect the protocol on the installed @solidjs/web
(it ships in the release after 2.0.0-rc.4) and fall back to the exact
previous unnamed-slot behavior on older versions; since client and
server resolve the same install, the halves cannot disagree.

Co-authored-by: Cursor <cursoragent@cursor.com>
ryansolid added a commit to ryansolid/tanstack-router that referenced this pull request Sep 2, 2026
Solid's single-flight channel is becoming multi-source (solidjs/solid
653dd41e): mutation responses carry a keyed envelope of per-cache
slices, each routed to the consumer subscribed under its source id.
Today Start claims the single unnamed slot on both halves, which means
any other cache wanting mutation-response data (e.g. solid-query, whose
provider subscribes under "sq" in TanStack/query#11326) displaces the
router's — whichever registers last wins, silently.

The router's flight data now rides its own source id ("tsr"): the
server collector registers additively with registerFlightDataSource and
the client subscribes its consumer under the same id, so router
loader/match state and other caches' slices coexist on one round trip.
A user-supplied collectFlightData hook keeps the unnamed slot to itself,
adding data alongside the router's instead of displacing it.

Both halves feature-detect the protocol on the installed @solidjs/web
(it ships in the release after 2.0.0-rc.4) and fall back to the exact
previous unnamed-slot behavior on older versions; since client and
server resolve the same install, the halves cannot disagree.

Co-authored-by: Cursor <cursoragent@cursor.com>
… bridge

rc.6 publishes the named flight-data source API with real types, so the
subscribeFlightData cast goes away; the peer floor moves to rc.6 because
rc.5's settle-walk regression breaks query hydration. Also adds the
missing changeset for dehydrateSettled and the SSR teardown work.

Co-authored-by: Cursor <cursoragent@cursor.com>
@socket-security

Copy link
Copy Markdown

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Updated@​solidjs/​web@​2.0.0-rc.3 ⏵ 2.0.0-rc.6100 +110083 +197 +1100
Updatedsolid-js@​2.0.0-rc.4 ⏵ 2.0.0-rc.6100 +110095 +196 +1100
Updated@​solidjs/​signals@​2.0.0-rc.4 ⏵ 2.0.0-rc.6100 +1100100 +198100

View full report

@ryansolid
ryansolid marked this pull request as ready for review September 2, 2026 21:24
@nx-cloud

nx-cloud Bot commented Sep 2, 2026

Copy link
Copy Markdown

🤖 Nx Cloud AI Fix Eligible

An automatically generated fix could have helped fix failing tasks for this run, but Self-healing CI is disabled for this workspace. Visit workspace settings to enable it and get automatic fixes in future runs.

To disable these notifications, a workspace admin can disable them in workspace settings.


View your CI Pipeline Execution ↗ for commit 5f2f3fe

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

☁️ Nx Cloud last updated this comment at 2026-09-02 21:33:58 UTC

@pkg-pr-new

pkg-pr-new Bot commented Sep 2, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 5f2f3fe

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