Skip to content

Commit

Permalink
fix(vue-query): ensure that invalidateQueries trigger queryFn wit…
Browse files Browse the repository at this point in the history
…h updated ref values (#6561)
  • Loading branch information
DamianOsipiuk committed Dec 19, 2023
1 parent 7a61733 commit abb72ba
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
3 changes: 3 additions & 0 deletions packages/vue-query/src/__tests__/queryClient.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { describe, expect, test, vi } from 'vitest'
import { ref } from 'vue-demi'
import { QueryClient as QueryClientOrigin } from '@tanstack/query-core'
import { QueryClient } from '../queryClient'
import { flushPromises } from './test-utils'

vi.mock('@tanstack/query-core')

Expand Down Expand Up @@ -196,6 +197,8 @@ describe('QueryCache', () => {
{ cancelRefetch: ref(false) },
)

await flushPromises()

expect(QueryClientOrigin.prototype.invalidateQueries).toBeCalledWith(
{
queryKey: queryKeyUnref,
Expand Down
15 changes: 11 additions & 4 deletions packages/vue-query/src/queryClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -171,10 +171,17 @@ export class QueryClient extends QC {
filters: MaybeRefDeep<InvalidateQueryFilters> = {},
options: MaybeRefDeep<InvalidateOptions> = {},
): Promise<void> {
return super.invalidateQueries(
cloneDeepUnref(filters),
cloneDeepUnref(options),
)
// (dosipiuk): We need to delay `invalidate` execution to next macro task for all reactive values to be updated.
// This ensures that `context` in `queryFn` while `invalidating` along reactive variable change has correct value.
return new Promise((resolve) => {
setTimeout(async () => {
await super.invalidateQueries(
cloneDeepUnref(filters),
cloneDeepUnref(options),
)
resolve()
}, 0)
})
}

refetchQueries(
Expand Down

0 comments on commit abb72ba

Please sign in to comment.