Skip to content

fix(vue-query): make vue-query client compatible with query-core #9250

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

Merged
merged 2 commits into from
Jun 4, 2025
Merged

fix(vue-query): make vue-query client compatible with query-core #9250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd5b73c
fix(vue-query): make vue-query client compatible with query-core
DamianOsipiuk Jun 4, 2025
3c6be86
ci: apply automated fixes
autofix-ci[bot] Jun 4, 2025
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
12 changes: 6 additions & 6 deletions packages/vue-query/src/__tests__/vueQueryPlugin.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,11 +269,11 @@ describe('VueQueryPlugin', () => {
],
})

expect(customClient.isRestoring.value).toBeTruthy()
expect(customClient.isRestoring?.value).toBeTruthy()

await sleep(0)

expect(customClient.isRestoring.value).toBeFalsy()
expect(customClient.isRestoring?.value).toBeFalsy()
})

test('should delay useQuery subscription and not call fetcher if data is not stale', async () => {
Expand Down Expand Up @@ -311,14 +311,14 @@ describe('VueQueryPlugin', () => {
customClient,
)

expect(customClient.isRestoring.value).toBeTruthy()
expect(customClient.isRestoring?.value).toBeTruthy()
expect(query.isFetching.value).toBeFalsy()
expect(query.data.value).toStrictEqual(undefined)
expect(fnSpy).toHaveBeenCalledTimes(0)

await sleep(0)

expect(customClient.isRestoring.value).toBeFalsy()
expect(customClient.isRestoring?.value).toBeFalsy()
expect(query.data.value).toStrictEqual({ foo: 'bar' })
expect(fnSpy).toHaveBeenCalledTimes(0)
})
Expand Down Expand Up @@ -373,7 +373,7 @@ describe('VueQueryPlugin', () => {
customClient,
)

expect(customClient.isRestoring.value).toBeTruthy()
expect(customClient.isRestoring?.value).toBeTruthy()

expect(query.isFetching.value).toBeFalsy()
expect(query.data.value).toStrictEqual(undefined)
Expand All @@ -384,7 +384,7 @@ describe('VueQueryPlugin', () => {

await sleep(0)

expect(customClient.isRestoring.value).toBeFalsy()
expect(customClient.isRestoring?.value).toBeFalsy()
expect(query.data.value).toStrictEqual({ foo1: 'bar1' })
expect(queries.value[0].data).toStrictEqual({ foo2: 'bar2' })
expect(fnSpy).toHaveBeenCalledTimes(0)
Expand Down
2 changes: 1 addition & 1 deletion packages/vue-query/src/queryClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export class QueryClient extends QC {
super(vueQueryConfig)
}

isRestoring: Ref<boolean> = ref(false)
isRestoring?: Ref<boolean> = ref(false)

isFetching(filters: MaybeRefDeep<QueryFilters> = {}): number {
return super.isFetching(cloneDeepUnref(filters))
Expand Down
28 changes: 15 additions & 13 deletions packages/vue-query/src/useBaseQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ export function useBaseQuery<
TQueryKey
> = client.defaultQueryOptions(clonedOptions)

defaulted._optimisticResults = client.isRestoring.value
defaulted._optimisticResults = client.isRestoring?.value
? 'isRestoring'
: 'optimistic'

Expand All @@ -110,18 +110,20 @@ export function useBaseQuery<
// noop
}

watch(
client.isRestoring,
(isRestoring) => {
if (!isRestoring) {
unsubscribe()
unsubscribe = observer.subscribe((result) => {
updateState(state, result)
})
}
},
{ immediate: true },
)
if (client.isRestoring) {
watch(
client.isRestoring,
(isRestoring) => {
if (!isRestoring) {
unsubscribe()
unsubscribe = observer.subscribe((result) => {
updateState(state, result)
})
}
},
{ immediate: true },
)
}

const updater = () => {
observer.setOptions(defaultedOptions.value)
Expand Down
30 changes: 16 additions & 14 deletions packages/vue-query/src/useQueries.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ export function useQueries<
}

const defaulted = client.defaultQueryOptions(clonedOptions)
defaulted._optimisticResults = client.isRestoring.value
defaulted._optimisticResults = client.isRestoring?.value
? 'isRestoring'
: 'optimistic'

Expand Down Expand Up @@ -317,20 +317,22 @@ export function useQueries<
// noop
}

watch(
client.isRestoring,
(isRestoring) => {
if (!isRestoring) {
unsubscribe()
unsubscribe = observer.subscribe(() => {
state.value = getOptimisticResult()
})
if (client.isRestoring) {
watch(
client.isRestoring,
(isRestoring) => {
if (!isRestoring) {
unsubscribe()
unsubscribe = observer.subscribe(() => {
state.value = getOptimisticResult()
})

state.value = getOptimisticResult()
}
},
{ immediate: true },
)
state.value = getOptimisticResult()
}
},
{ immediate: true },
)
}

watch(defaultedQueries, (queriesValue) => {
observer.setQueries(
Expand Down
8 changes: 6 additions & 2 deletions packages/vue-query/src/vueQueryPlugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,15 @@ export const VueQueryPlugin = {
}

if (options.clientPersister) {
client.isRestoring.value = true
if (client.isRestoring) {
client.isRestoring.value = true
}
const [unmount, promise] = options.clientPersister(client)
persisterUnmount = unmount
promise.then(() => {
client.isRestoring.value = false
if (client.isRestoring) {
client.isRestoring.value = false
}
options.clientPersisterOnSuccess?.(client)
})
}
Expand Down