Skip to content

fix(vue-query): unify shallow flag behaviour #9050

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
DamianOsipiuk merged 1 commit into from
Apr 22, 2025
Merged

fix(vue-query): unify shallow flag behaviour #9050

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
17 changes: 9 additions & 8 deletions packages/vue-query/src/useBaseQuery.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import {
computed,
getCurrentScope,
onScopeDispose,
reactive,
readonly,
shallowReactive,
shallowReadonly,
Expand Down Expand Up @@ -106,7 +107,10 @@ export function useBaseQuery<
})

const observer = new Observer(client, defaultedOptions.value)
const state = shallowReactive(observer.getCurrentResult())
// @ts-expect-error
const state = defaultedOptions.value.shallow
? shallowReactive(observer.getCurrentResult())
: reactive(observer.getCurrentResult())

let unsubscribe = () => {
// noop
Expand Down Expand Up @@ -202,13 +206,10 @@ export function useBaseQuery<
},
)

const readonlyState =
process.env.NODE_ENV === 'production'
? state
: // @ts-expect-error
defaultedOptions.value.shallow
? shallowReadonly(state)
: readonly(state)
// @ts-expect-error
const readonlyState = defaultedOptions.value.shallow
? shallowReadonly(state)
: readonly(state)

const object: any = toRefs(readonlyState)
for (const key in state) {
Expand Down
14 changes: 7 additions & 7 deletions packages/vue-query/src/useMutation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import {
computed,
getCurrentScope,
onScopeDispose,
reactive,
readonly,
shallowReactive,
shallowReadonly,
Expand Down Expand Up @@ -87,7 +88,9 @@ export function useMutation<
return client.defaultMutationOptions(cloneDeepUnref(mutationOptions))
})
const observer = new MutationObserver(client, options.value)
const state = shallowReactive(observer.getCurrentResult())
const state = options.value.shallow
? shallowReactive(observer.getCurrentResult())
: reactive(observer.getCurrentResult())

const unsubscribe = observer.subscribe((result) => {
updateState(state, result)
Expand All @@ -110,12 +113,9 @@ export function useMutation<
unsubscribe()
})

const readonlyState =
process.env.NODE_ENV === 'production'
? state
: options.value.shallow
? shallowReadonly(state)
: readonly(state)
const readonlyState = options.value.shallow
? shallowReadonly(state)
: readonly(state)

const resultRefs = toRefs(readonlyState) as ToRefs<
Readonly<MutationResult<TData, TError, TVariables, TContext>>
Expand Down
8 changes: 3 additions & 5 deletions packages/vue-query/src/useQueries.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,9 +344,7 @@ export function useQueries<
unsubscribe()
})

return process.env.NODE_ENV === 'production'
? state
: options.shallow
? shallowReadonly(state)
: (readonly(state) as Readonly<Ref<TCombinedResult>>)
return options.shallow
? shallowReadonly(state)
: (readonly(state) as Readonly<Ref<TCombinedResult>>)
}