Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions .changeset/quiet-ducks-begin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
"@tanstack/query-core": patch

fix(query-core): `resetQueries` now correctly refetches queries even when the filter predicate depends on mutable state (`status`, `data`, etc.). Previously, `query.reset()` mutated the query state before `refetchQueries` could match the same queries, causing them to be skipped.
51 changes: 51 additions & 0 deletions packages/query-core/src/__tests__/queryClient.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -1692,6 +1692,57 @@ describe('queryClient', () => {
expect(queryFn2).toHaveBeenCalledTimes(0)
expect(didSkipTokenRun).toBe(false)
})

it('should refetch queries matched by a state-dependent predicate even though reset() mutates state', async () => {
const key1 = queryKey()
const key2 = queryKey()
const queryFn1 = vi
.fn<(...args: Array<unknown>) => string>()
.mockReturnValue('data')
const queryFn2 = vi
.fn<(...args: Array<unknown>) => string>()
.mockRejectedValue('error')

const observer1 = new QueryObserver(queryClient, {
queryKey: key1,
queryFn: queryFn1,
})
const observer2 = new QueryObserver(queryClient, {
queryKey: key2,
queryFn: queryFn2,
retry: false,
})

observer1.subscribe(() => undefined)
observer2.subscribe(() => undefined)

await vi.waitFor(() => {
expect(queryClient.getQueryState(key1)?.status).toBe('success')
expect(queryClient.getQueryState(key2)?.status).toBe('error')
})

expect(queryFn1).toHaveBeenCalledTimes(1)
expect(queryFn2).toHaveBeenCalledTimes(1)

// reset + refetch only success queries by predicate
await queryClient.resetQueries({
predicate: (query) => query.state.status === 'success',
})

expect(queryFn1).toHaveBeenCalledTimes(2)
expect(queryFn2).toHaveBeenCalledTimes(1)

// reset + refetch only error queries by predicate
await queryClient.resetQueries({
predicate: (query) => query.state.status === 'error',
})

expect(queryFn1).toHaveBeenCalledTimes(2)
expect(queryFn2).toHaveBeenCalledTimes(2)

observer1.destroy()
observer2.destroy()
})
})

describe('focusManager and onlineManager', () => {
Expand Down
5 changes: 4 additions & 1 deletion packages/query-core/src/queryClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -260,13 +260,16 @@ export class QueryClient {
const queryCache = this.#queryCache

return notifyManager.batch(() => {
queryCache.findAll(filters).forEach((query) => {
const matched = queryCache.findAll(filters)
const matchedHashes = new Set(matched.map((query) => query.queryHash))
matched.forEach((query) => {
query.reset()
})
return this.refetchQueries(
{
type: 'active',
...filters,
predicate: (query) => matchedHashes.has(query.queryHash),
},
options,
)
Expand Down