[svelte-query] Reactive options updates can cancel and restart an in-flight refetch without changing the query key or enabled value
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 48/100
- Tipo di issue
- Bug
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Attiva
- Stack tecnologico
- typescript
- Ambito
- frontend
Direzione di ricerca
Start with the provided regression test as a .svelte.test.ts file in a Svelte-enabled Vitest setup using client/browser conditions and jsdom. Trace how createInfiniteQuery recomputes reactive options during the focus-triggered refetch, particularly cancellation and infinite-query page fetching. Done means the test completes without aborting the in-flight request and reports aborted: false with pages [0, 1].
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Describe the bug
With createInfiniteQuery, updating reactive state used by the options accessor can cancel and restart an in-flight refetch, even though:
- The query key stays the same.
enabledremainstrue.- The QueryClient stays the same.
- The component remains mounted.
- No explicit cancellation or invalidation occurs.
For example, replacing reactive state { enabled: true } with a new { enabled: true } object during a focus-triggered refetch can abort the current request and restart fetching from the first page.
With two cached pages, the reproduction fetches pages [0, 0, 1] instead of [0, 1]. The first request's AbortSignal becomes aborted.
Your minimal, reproducible example
See tests below
Steps to reproduce
The regression test below uses only Svelte, TanStack Query and Vitest. Run it as a .svelte.test.ts file in a Svelte-enabled Vitest setup using the client/browser resolution conditions and jsdom.
import { expect, it, vi } from 'vitest'
import { flushSync } from 'svelte'
import {
QueryClient,
InfiniteQueryObserver,
createInfiniteQuery,
infiniteQueryOptions,
focusManager,
} from '@tanstack/svelte-query'
it('does not cancel a refetch when reactive options retain the same values', async () => {
let state = $state({ enabled: true })
let now = Date.now()
vi.spyOn(Date, 'now').mockImplementation(() => now)
const client = new QueryClient({
defaultOptions: {
queries: { staleTime: 60_000, retry: false },
},
})
client.mount()
const key = ['items'] as const
let response: ReturnType<typeof Promise.withResolvers<void>> | undefined
const reads: Array<{ page: number; signal: AbortSignal }> = []
const options = () =>
infiniteQueryOptions({
queryKey: key,
enabled: state.enabled,
initialPageParam: 0,
queryFn: async ({ pageParam, signal }) => {
reads.push({ page: pageParam, signal })
await response?.promise
return {
items: [pageParam],
next: pageParam === 0 ? 1 : undefined,
}
},
getNextPageParam: (page) => page.next,
})
// Load two pages, then leave the query unobserved.
const first = new InfiniteQueryObserver(client, options())
const stop = first.subscribe(() => {})
await vi.waitFor(() =>
expect(first.getCurrentResult().isSuccess).toBe(true),
)
await first.fetchNextPage()
stop()
// Return to the cached query after it becomes stale.
now += 60_001
const dispose = $effect.root(() => {
const query = createInfiniteQuery(options, () => client)
$effect(() => {
void query.data
void query.isFetchingNextPage
void query.fetchStatus
})
})
try {
flushSync()
await vi.waitFor(() => expect(reads).toHaveLength(4))
await vi.waitFor(() =>
expect(client.getQueryState(key)?.fetchStatus).toBe('idle'),
)
flushSync()
now += 60_001
reads.length = 0
response = Promise.withResolvers<void>()
focusManager.setFocused(false)
focusManager.setFocused(true)
await vi.waitFor(() => expect(reads).toHaveLength(1))
// Recompute options without changing enabled or query identity.
state = { enabled: true }
flushSync()
const aborted = reads[0]!.signal.aborted
response.resolve()
await vi.waitFor(() =>
expect(client.getQueryState(key)?.fetchStatus).toBe('idle'),
)
expect({
aborted,
pages: reads.map(({ page }) => page),
}).toEqual({
aborted: false,
pages: [0, 1],
})
} finally {
response?.resolve()
dispose()
client.clear()
client.unmount()
vi.restoreAllMocks()
focusManager.setFocused(true)
}
})
- Load two pages of an infinite query whose query function reads the provided
signal. - Unsubscribe, retaining the cached pages.
- Let the query become stale, mount it through
createInfiniteQuery, and allow its initial refetch to finish. - Let it become stale again and trigger a window-focus refetch.
- While the first page request is pending, replace reactive state read by the options accessor with an equivalent object. Keep the query key and
enabledvalue unchanged. - Observe that the pending request is aborted and the first page is requested again.
Expected behavior
The existing refetch should continue without cancellation or duplicate requests when the query identity and enabled state remain unchanged.
Expected: aborted: false, requested pages [0, 1].
Actual: aborted: true, requested pages [0, 0, 1].
How often does this bug happen?
Every time
Screenshots or Videos
No response
Platform
- OS: Windows
- Reproduced using Vitest 4.1.11 with jsdom 30.0.1
Tanstack Query adapter
svelte-query
TanStack Query version
6.1.48
TypeScript version
6.0.3
Additional context
No response
- Lingua principale
- TypeScript
- Stelle
- 50.3k
- Fork
- 4.2k
- Merge medio
- 22h 33m
- PR unite (30g)
- 214
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di TanStack/query
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 40/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 78/100
Tutte le issue di TanStack/query
Issue simili
-
blocklist removal
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
MetaMask/eth-phishing-detect#296544 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
pastelsky/bundlephobia#1122 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
category/development priority/P2 scope/file-operations scope/testing type/enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Enatega Customer and Rider app: Add-ons price is not visible to customer after order is placed. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100