fix(query-core): don't reschedule GC for removed queries by Elehiggle · Pull Request #12036 · TanStack/query · GitHub
Skip to content

fix(query-core): don't reschedule GC for removed queries #12036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Elehiggle wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(query-core): don't reschedule GC for removed queries #12036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/removed-query-gc.md
View file
Open in desktop
72 changes: 72 additions & 0 deletions packages/query-core/src/__tests__/query.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ import {
dehydrate,
hydrate,
noop,
skipToken,
timeoutManager,
} from '..'
import { hashQueryKeyByOptions } from '../utils'
import { mockOnlineManagerIsOnline, setIsServer } from './utils'
Expand All @@ -34,6 +36,76 @@ describe('query', () => {
vi.useRealTimers()
})

describe('garbage collection after removal', () => {
it.each([false, true])(
'does not reschedule GC on unsubscribe (replacement: %s)',
(replace) => {
const key = queryKey()
const gcTime = 30_000
const observer = new QueryObserver(queryClient, {
queryKey: key,
queryFn: skipToken,
initialData: 'data',
gcTime,
staleTime: Infinity,
})
const unsubscribe = observer.subscribe(noop)
const oldQuery = observer.getCurrentQuery()
queryClient.removeQueries({ queryKey: key })
if (replace) {
queryClient.setQueryData(key, 'replacement')
}
const schedule = vi.spyOn(timeoutManager, 'setTimeout')
schedule.mockClear()

unsubscribe()

expect(oldQuery.getObserversCount()).toBe(0)
expect(queryCache.get(oldQuery.queryHash)).not.toBe(oldQuery)
expect(schedule).not.toHaveBeenCalledWith(expect.any(Function), gcTime)
expect(queryClient.getQueryData(key)).toBe(
replace ? 'replacement' : undefined,
)
schedule.mockRestore()
},
)

it.each([false, true])(
'does not reschedule GC when cancellation settles (replacement: %s)',
async (replace) => {
const key = queryKey()
const gcTime = 30_000
let resolve!: (data: string) => void
const request = new Promise<string>((done) => {
resolve = done
})
const fetch = queryClient
.query({
queryKey: key,
queryFn: () => request,
gcTime,
})
.catch(noop)
queryClient.removeQueries({ queryKey: key })
if (replace) {
queryClient.setQueryData(key, 'replacement')
}
const schedule = vi.spyOn(timeoutManager, 'setTimeout')
schedule.mockClear()

await fetch
resolve('late data')
await Promise.resolve()

expect(schedule).not.toHaveBeenCalledWith(expect.any(Function), gcTime)
expect(queryClient.getQueryData(key)).toBe(
replace ? 'replacement' : undefined,
)
schedule.mockRestore()
},
)
})

it('should use the longest garbage collection time it has seen', async () => {
const key = queryKey()
await queryClient
Expand Down
20 changes: 16 additions & 4 deletions packages/query-core/src/query.ts
View file
Open in desktop