svelte-query: query subscriptions survive effect-root disposal after async Svelte update #11587
Send to my agentDescribe the bug#
After #9810, a query created inside $effect.root with an explicit QueryClient can remain subscribed after the root's disposer runs. This affects both createQuery and createInfiniteQuery when the client/restoration subscription has not changed.
The retained observer prevents normal garbage collection. Interval refetches continue after disposal, and a pending request that consumes its AbortSignal is not aborted. Normal component unmount still cleans up in the control test.
Your minimal, reproducible example#
Test-only reproducer, pinned commit
A minimal client-side .svelte.ts example is:
import { flushSync } from 'svelte'
import { QueryClient, createQuery } from '@tanstack/svelte-query'
const client = new QueryClient()
const queryKey = ['root-cleanup']
const dispose = $effect.root(() => {
createQuery(
() => ({ queryKey, queryFn: () => Promise.resolve('data') }),
() => client,
)
})
flushSync()
const query = client.getQueryCache().find({ queryKey })!
console.log(query.getObserversCount()) // 1
dispose()
console.log(query.getObserversCount()) // expected 0, currently 1
client.clear()
Steps to reproduce#
From a clean checkout of the linked reproduction branch, use Node 24.16.0 and pnpm 12.4.2, install dependencies with pnpm install --frozen-lockfile, then run:
NX_DAEMON=false NX_NO_CLOUD=true NX_ISOLATE_PLUGINS=false \
pnpm nx run @tanstack/svelte-query:test:lib --skip-nx-cache -- \
tests/createQuery/observer-cleanup.svelte.test.ts
The test-only commit is based on main 848b42129eef0dd7f55c99d2d3d1418bda4853eb. It deliberately fails: 10 failed, 2 passed.
| Check | Current result |
|---|---|
| Success, error, disabled state, for query and infinite query | Observer remains; cache entry survives gcTime |
| Disposal before the first effect runs, for both query types | Observer remains |
| Pending request consuming its signal | Signal is not aborted |
| Interval refetch after disposal | Mock query-function call count grows from 1 to 4 over 30ms of fake time |
| Normal component unmount | Passes |
| Disposal after switching query clients | Passes |
Expected behavior#
Root disposal should unsubscribe its observers, allowing normal GC and cancellation behavior and stopping interval refetches.
How often does this bug happen?#
Every time in the local reproduction. The tests use fake timers and local promises, without network requests.
Platform#
macOS ARM64, Node 24.16.0, Vitest 4.1.2 with jsdom. Not reproduced in a real browser or an SSR application yet.
TanStack Query adapter and version#
@tanstack/svelte-query 6.2.4, tested from the main checkout above; Svelte 5.55.1, TypeScript 5.9.3 in the Svelte package.
Additional context#
With the same current dependencies, replacing only createBaseQuery.svelte.ts with its pre-#9810 version makes all 12 checks pass. This is a single-file comparison, not a claim that the complete historical checkout was tested. The existing Svelte suite passes all 214 tests on the initial audit main 8a5e385f67a192b308057c4873b2d550a731f42b; the relevant subscription code is unchanged on the newer base.
The initial subscription is created eagerly in createBaseQuery.svelte.ts. Its watchChanges callback supplies cleanup only after a later change, because the helper skips its first invocation. Outside component initialization, the onDestroy registration throws and is caught. This leaves the initial subscription without a working root teardown path.
This differs from #11542 and #11557: no reactive option update or query-function state write is needed. The repository's existing withEffectRoot helper also uses this non-component execution pattern, but does not assert observer disposal.
The scope should preserve #9810's eager async/SSR subscription behavior rather than revert it. A cleanup registered only once an effect executes would also need to account for the early-disposal case above. Is effect-root usage with an explicit client intended to remain supported? If so, would a lifecycle-only fix with these regression cases be in scope?
DogPawHat added labelspackage: svelte-query
DogPawHat assignedDogPawHat
Neekoras(GitHub profile, opens in a new tab) linked this to #11597
Sign in to join this conversation.
We ran into this too. in an app we have a .svelte.ts state class that creates its queries inside $effect.root, so their lifetime isn't tied to a component. After 6.2 those queries never unsubscribed, and requests we expected to be cancelled kept running.
Workaround in case it helps anyone else: create a QueryObserver yourself and call observer.subscribe() inside an $effect, so the effect's teardown unsubscribes it.