Skip to content

fix(tanstack-query): default enabled option not working #840

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
dinwwwh merged 1 commit into from
Aug 7, 2025
Merged

fix(tanstack-query): default enabled option not working #840

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
6 changes: 3 additions & 3 deletions packages/react-query/src/procedure-utils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ describe('createProcedureUtils', () => {
it('without skipToken', async () => {
const options = utils.queryOptions({ input: { search: '__search__' }, context: { batch: '__batch__' } })

expect(options.enabled).toBe(true)
expect(options.enabled).toBe(undefined)

expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(1)
Expand Down Expand Up @@ -72,7 +72,7 @@ describe('createProcedureUtils', () => {
queryFnOptions: { refetchMode: 'replace' },
})

expect(options.enabled).toBe(true)
expect(options.enabled).toBe(undefined)

expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(1)
Expand Down Expand Up @@ -130,7 +130,7 @@ describe('createProcedureUtils', () => {
initialPageParam: '__initialPageParam__',
})

expect(options.enabled).toBe(true)
expect(options.enabled).toBe(undefined)

expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(1)
Expand Down
6 changes: 3 additions & 3 deletions packages/react-query/src/procedure-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,14 @@ export function createProcedureUtils<TClientContext extends ClientContext, TInpu

return client(optionsIn.input, { signal, context: optionsIn.context })
},
enabled: optionsIn.input !== skipToken,
enabled: optionsIn.input === skipToken ? false : undefined,
...optionsIn,
}
},

experimental_streamedOptions(...[optionsIn = {} as any]) {
return {
enabled: optionsIn.input !== skipToken,
enabled: optionsIn.input === skipToken ? false : undefined,
queryKey: generateOperationKey(options.path, { type: 'streamed', input: optionsIn.input, fnOptions: optionsIn.queryFnOptions }),
queryFn: streamedQuery({
queryFn: async ({ signal }) => {
Expand Down Expand Up @@ -129,7 +129,7 @@ export function createProcedureUtils<TClientContext extends ClientContext, TInpu

return client(optionsIn.input(pageParam as any), { signal, context: optionsIn.context as any })
},
enabled: optionsIn.input !== skipToken,
enabled: optionsIn.input === skipToken ? false : undefined,
...(optionsIn as any),
}
},
Expand Down
4 changes: 2 additions & 2 deletions packages/react-query/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export interface QueryOptionsBase<TOutput, TError> {
queryFn(ctx: QueryFunctionContext): Promise<TOutput>
throwOnError?(error: TError): boolean // Help TQ infer TError
retryDelay?: (count: number, error: TError) => number // Help TQ infer TError (suspense hooks)
enabled: boolean
enabled: boolean | undefined
}

type experimental_StreamedQueryOptions = Omit<Parameters<typeof experimental_streamedQuery>[0], 'queryFn'>
Expand All @@ -36,7 +36,7 @@ export interface InfiniteOptionsBase<TOutput, TError, TPageParam> {
queryFn(ctx: QueryFunctionContext<QueryKey, TPageParam>): Promise<TOutput>
throwOnError?(error: TError): boolean // Help TQ infer TError
retryDelay?: (count: number, error: TError) => number // Help TQ infer TError (suspense hooks)
enabled: boolean
enabled: boolean | undefined
}

export type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext>
Expand Down
6 changes: 3 additions & 3 deletions packages/solid-query/src/procedure-utils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ describe('createProcedureUtils', () => {
it('without skipToken', async () => {
const options = utils.queryOptions({ input: { search: '__search__' }, context: { batch: '__batch__' } })

expect(options.enabled).toBe(true)
expect(options.enabled).toBe(undefined)

expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(1)
Expand Down Expand Up @@ -72,7 +72,7 @@ describe('createProcedureUtils', () => {
queryFnOptions: { refetchMode: 'replace' },
})

expect(options.enabled).toBe(true)
expect(options.enabled).toBe(undefined)

expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(1)
Expand Down Expand Up @@ -130,7 +130,7 @@ describe('createProcedureUtils', () => {
initialPageParam: '__initialPageParam__',
})

expect(options.enabled).toBe(true)
expect(options.enabled).toBe(undefined)

expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(1)
Expand Down
6 changes: 3 additions & 3 deletions packages/solid-query/src/procedure-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,14 +77,14 @@ export function createProcedureUtils<TClientContext extends ClientContext, TInpu

return client(optionsIn.input, { signal, context: optionsIn.context })
},
enabled: optionsIn.input !== skipToken,
enabled: optionsIn.input === skipToken ? false : undefined,
...optionsIn,
}
},

experimental_streamedOptions(...[optionsIn = {} as any]) {
return {
enabled: optionsIn.input !== skipToken,
enabled: optionsIn.input === skipToken ? false : undefined,
queryKey: generateOperationKey(options.path, { type: 'streamed', input: optionsIn.input, fnOptions: optionsIn.queryFnOptions }),
queryFn: experimental_streamedQuery({
queryFn: async ({ signal }) => {
Expand Down Expand Up @@ -119,7 +119,7 @@ export function createProcedureUtils<TClientContext extends ClientContext, TInpu

return client(optionsIn.input(pageParam as any), { signal, context: optionsIn.context as any })
},
enabled: optionsIn.input !== skipToken,
enabled: optionsIn.input === skipToken ? false : undefined,
...(optionsIn as any),
}
},
Expand Down
4 changes: 2 additions & 2 deletions packages/solid-query/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export interface QueryOptionsBase<TOutput, TError> {
queryFn(ctx: QueryFunctionContext): Promise<TOutput>
throwOnError?(error: TError): boolean // Help TQ infer TError
retryDelay?: (count: number, error: TError) => number // Help TQ infer TError (suspense hooks)
enabled: boolean
enabled: boolean | undefined
}

type experimental_StreamedQueryOptions = Omit<Parameters<typeof streamedQuery>[0]['refetchMode'], 'queryFn'>
Expand All @@ -44,7 +44,7 @@ export interface InfiniteOptionsBase<TOutput, TError, TPageParam> {
queryFn(ctx: QueryFunctionContext<QueryKey, TPageParam>): Promise<TOutput>
throwOnError?(error: TError): boolean // Help TQ infer TError
retryDelay?: (count: number, error: TError) => number // Help TQ infer TError (suspense hooks)
enabled: boolean
enabled: boolean | undefined
}

export type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext>
Expand Down
6 changes: 3 additions & 3 deletions packages/svelte-query/src/procedure-utils.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ describe('createProcedureUtils', () => {
it('without skipToken', async () => {
const options = utils.queryOptions({ input: { search: '__search__' }, context: { batch: '__batch__' } })

expect(options.enabled).toBe(true)
expect(options.enabled).toBe(undefined)

expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(1)
Expand Down Expand Up @@ -72,7 +72,7 @@ describe('createProcedureUtils', () => {
queryFnOptions: { refetchMode: 'replace' },
})

expect(options.enabled).toBe(true)
expect(options.enabled).toBe(undefined)

expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(1)
Expand Down Expand Up @@ -130,7 +130,7 @@ describe('createProcedureUtils', () => {
initialPageParam: '__initialPageParam__',
})

expect(options.enabled).toBe(true)
expect(options.enabled).toBe(undefined)

expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(1)
Expand Down
6 changes: 3 additions & 3 deletions packages/svelte-query/src/procedure-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,14 +77,14 @@ export function createProcedureUtils<TClientContext extends ClientContext, TInpu

return client(optionsIn.input, { signal, context: optionsIn.context })
},
enabled: optionsIn.input !== skipToken,
enabled: optionsIn.input === skipToken ? false : undefined,
...optionsIn,
}
},

experimental_streamedOptions(...[optionsIn = {} as any]) {
return {
enabled: optionsIn.input !== skipToken,
enabled: optionsIn.input === skipToken ? false : undefined,
queryKey: generateOperationKey(options.path, { type: 'streamed', input: optionsIn.input, fnOptions: optionsIn.queryFnOptions }),
queryFn: experimental_streamedQuery({
queryFn: async ({ signal }) => {
Expand Down Expand Up @@ -119,7 +119,7 @@ export function createProcedureUtils<TClientContext extends ClientContext, TInpu

return client(optionsIn.input(pageParam as any), { signal, context: optionsIn.context as any })
},
enabled: optionsIn.input !== skipToken,
enabled: optionsIn.input === skipToken ? false : undefined,
...(optionsIn as any),
}
},
Expand Down
4 changes: 2 additions & 2 deletions packages/svelte-query/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export interface QueryOptionsBase<TOutput, TError> {
queryFn(ctx: QueryFunctionContext): Promise<TOutput>
throwOnError?(error: TError): boolean // Help TQ infer TError
retryDelay?: (count: number, error: TError) => number // Help TQ infer TError (suspense hooks)
enabled: boolean
enabled: boolean | undefined
}

type experimental_StreamedQueryOptions = Omit<Parameters<typeof experimental_streamedQuery>[0], 'queryFn'>
Expand All @@ -44,7 +44,7 @@ export interface InfiniteOptionsBase<TOutput, TError, TPageParam> {
queryFn(ctx: QueryFunctionContext<QueryKey, TPageParam>): Promise<TOutput>
throwOnError?(error: TError): boolean // Help TQ infer TError
retryDelay?: (count: number, error: TError) => number // Help TQ infer TError (suspense hooks)
enabled: boolean
enabled: boolean | undefined
}

export type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext>
Expand Down
8 changes: 4 additions & 4 deletions packages/tanstack-query/src/procedure-utils.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ describe('ProcedureUtils', () => {
maxPages: number
queryFn: QueryFunction<UtilsOutput>
throwOnError?(error: UtilsError): boolean
enabled: boolean
enabled: boolean | undefined
}>()
})

Expand Down Expand Up @@ -281,7 +281,7 @@ describe('ProcedureUtils', () => {
maxPages: number
queryFn: QueryFunction<UtilsOutput>
throwOnError?(error: UtilsError): boolean
enabled: boolean
enabled: boolean | undefined
}>()
})

Expand Down Expand Up @@ -410,7 +410,7 @@ describe('ProcedureUtils', () => {
maxPages: number
queryFn: QueryFunction<UtilsOutput[number]>
throwOnError?(error: UtilsError): boolean
enabled: boolean
enabled: boolean | undefined
}>()
})

Expand Down Expand Up @@ -661,7 +661,7 @@ describe('ProcedureUtils', () => {
maxPages: number
queryFn: QueryFunction<UtilsOutput>
throwOnError?(error: UtilsError): boolean
enabled: boolean
enabled: boolean | undefined
}>()
})

Expand Down
8 changes: 4 additions & 4 deletions packages/tanstack-query/src/procedure-utils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ describe('createProcedureUtils', () => {
it('without skipToken', async () => {
const options = utils.queryOptions({ input: { search: '__search__' }, context: { batch: '__batch__' } })

expect(options.enabled).toBe(true)
expect(options.enabled).toBe(undefined)

expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(1)
Expand Down Expand Up @@ -97,7 +97,7 @@ describe('createProcedureUtils', () => {
},
})

expect(options.enabled).toBe(true)
expect(options.enabled).toBe(undefined)

expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(1)
Expand Down Expand Up @@ -182,7 +182,7 @@ describe('createProcedureUtils', () => {
context: { batch: '__batch__' },
})

expect(options.enabled).toBe(true)
expect(options.enabled).toBe(undefined)

expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(1)
Expand Down Expand Up @@ -268,7 +268,7 @@ describe('createProcedureUtils', () => {
initialPageParam: '__initialPageParam__',
})

expect(options.enabled).toBe(true)
expect(options.enabled).toBe(undefined)

expect(options.queryKey).toBe(generateOperationKeySpy.mock.results[0]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(1)
Expand Down
8 changes: 4 additions & 4 deletions packages/tanstack-query/src/procedure-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ export function createProcedureUtils<TClientContext extends ClientContext, TInpu
} satisfies OperationContext,
})
},
enabled: optionsIn.input !== skipToken,
enabled: optionsIn.input === skipToken ? false : undefined,
Comment thread
dinwwwh marked this conversation as resolved.
...optionsIn,
queryKey,
}
Expand All @@ -200,7 +200,7 @@ export function createProcedureUtils<TClientContext extends ClientContext, TInpu
const queryKey = utils.experimental_streamedKey(optionsIn)

return {
enabled: optionsIn.input !== skipToken,
enabled: optionsIn.input === skipToken ? false : undefined,
queryFn: experimental_streamedQuery({
queryFn: async ({ signal }) => {
if (optionsIn.input === skipToken) {
Expand Down Expand Up @@ -241,7 +241,7 @@ export function createProcedureUtils<TClientContext extends ClientContext, TInpu
const queryKey = utils.experimental_liveKey(optionsIn)

return {
enabled: optionsIn.input !== skipToken,
enabled: optionsIn.input === skipToken ? false : undefined,
queryFn: experimental_liveQuery(async ({ signal }) => {
if (optionsIn.input === skipToken) {
throw new Error('queryFn should not be called with skipToken used as input')
Expand Down Expand Up @@ -298,7 +298,7 @@ export function createProcedureUtils<TClientContext extends ClientContext, TInpu
} as any,
})
},
enabled: optionsIn.input !== skipToken,
enabled: optionsIn.input === skipToken ? false : undefined,
...(optionsIn as any),
queryKey,
}
Expand Down
4 changes: 2 additions & 2 deletions packages/tanstack-query/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export interface QueryOptionsBase<TOutput, TError> {
queryFn: QueryFunction<TOutput>
throwOnError?: (error: TError) => boolean // Help TQ infer TError
retryDelay?: (count: number, error: TError) => number // Help TQ infer TError (suspense hooks)
enabled: boolean
enabled: boolean | undefined
}

export type experimental_StreamedKeyOptions<TInput>
Expand All @@ -75,7 +75,7 @@ export interface InfiniteOptionsBase<TOutput, TError, TPageParam> {
select?(): InfiniteData<TOutput, TPageParam> // Help TQ infer TPageParam
throwOnError?: (error: TError) => boolean // Help TQ infer TError
retryDelay?: (count: number, error: TError) => number // Help TQ infer TError (suspense hooks)
enabled: boolean
enabled: boolean | undefined
}

export type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError, TMutationContext>
Expand Down
12 changes: 6 additions & 6 deletions packages/vue-query/src/procedure-utils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ describe('createProcedureUtils', () => {
it('without skipToken', async () => {
const options = utils.queryOptions({ input: computed(() => ({ search: ref('__search__') })), context: { batch: '__batch__' } })

expect(options.enabled.value).toBe(true)
expect(options.enabled.value).toBe(undefined)

expect(options.queryKey.value).toBe(generateOperationKeySpy.mock.results[0]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(1)
Expand Down Expand Up @@ -74,7 +74,7 @@ describe('createProcedureUtils', () => {

input.value = computed(() => ({ search: ref('__search__') }))

expect(options.enabled.value).toBe(true)
expect(options.enabled.value).toBe(undefined)

expect(options.queryKey.value).toBe(generateOperationKeySpy.mock.results[1]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(2)
Expand Down Expand Up @@ -102,7 +102,7 @@ describe('createProcedureUtils', () => {
},
})

expect(options.enabled.value).toBe(true)
expect(options.enabled.value).toBe(undefined)

expect(options.queryKey.value).toBe(generateOperationKeySpy.mock.results[0]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(1)
Expand Down Expand Up @@ -166,7 +166,7 @@ describe('createProcedureUtils', () => {

input.value = computed(() => ({ search: ref('__search__') }))

expect(options.enabled.value).toBe(true)
expect(options.enabled.value).toBe(undefined)

expect(options.queryKey.value).toBe(generateOperationKeySpy.mock.results[1]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(2)
Expand Down Expand Up @@ -206,7 +206,7 @@ describe('createProcedureUtils', () => {
initialPageParam: '__initialPageParam__',
})

expect(options.enabled.value).toBe(true)
expect(options.enabled.value).toBe(undefined)

expect(options.queryKey.value).toBe(generateOperationKeySpy.mock.results[0]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(1)
Expand Down Expand Up @@ -268,7 +268,7 @@ describe('createProcedureUtils', () => {

input.value = (pageParam: any) => (computed(() => ({ search: '__search__', pageParam })))

expect(options.enabled.value).toBe(true)
expect(options.enabled.value).toBe(undefined)

expect(options.queryKey.value).toBe(generateOperationKeySpy.mock.results[1]!.value)
expect(generateOperationKeySpy).toHaveBeenCalledTimes(2)
Expand Down
Loading