From a05df6aefb0e2489ec2c879ae16e2ee7cb3123ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Dorfmeister=20=F0=9F=94=AE?= Date: Tue, 25 Aug 2026 23:17:25 +0200 Subject: [PATCH] fix(query-core): Avoid scheduling stale timeouts for disabled query observers (#11293) * fix(query-core): Avoid scheduling stale timeouts for disabled query observers. * ref: do the cheap thing first --- .changeset/quiet-timers-rest.md | 5 +++++ .../src/__tests__/queryObserver.test.tsx | 22 ++++++++++++++++++- packages/query-core/src/queryObserver.ts | 20 +++++++++-------- 3 files changed, 37 insertions(+), 10 deletions(-) create mode 100644 .changeset/quiet-timers-rest.md diff --git a/.changeset/quiet-timers-rest.md b/.changeset/quiet-timers-rest.md new file mode 100644 index 0000000000..64ba646af0 --- /dev/null +++ b/.changeset/quiet-timers-rest.md @@ -0,0 +1,5 @@ +--- +'@tanstack/query-core': patch +--- + +Avoid scheduling stale timeouts for disabled query observers. diff --git a/packages/query-core/src/__tests__/queryObserver.test.tsx b/packages/query-core/src/__tests__/queryObserver.test.tsx index f3cc66c260..7c649089c9 100644 --- a/packages/query-core/src/__tests__/queryObserver.test.tsx +++ b/packages/query-core/src/__tests__/queryObserver.test.tsx @@ -8,7 +8,7 @@ import { vi, } from 'vitest' import { queryKey, sleep } from '@tanstack/query-test-utils' -import { QueryClient, QueryObserver, focusManager } from '..' +import { QueryClient, QueryObserver, focusManager, timeoutManager } from '..' import type { QueryObserverResult } from '..' describe('queryObserver', () => { @@ -1405,6 +1405,26 @@ describe('queryObserver', () => { expect(result.isStale).toBe(false) }) + it('should not schedule a stale timeout for disabled observers', () => { + const key = queryKey() + queryClient.setQueryData(key, 'data', { + updatedAt: Date.now() - 20, + }) + + const observer = new QueryObserver(queryClient, { + queryKey: key, + enabled: false, + staleTime: 10, + }) + const setTimeoutSpy = vi.spyOn(timeoutManager, 'setTimeout') + + const unsubscribe = observer.subscribe(vi.fn()) + + expect(setTimeoutSpy).not.toHaveBeenCalled() + + unsubscribe() + }) + it('should allow staleTime as a function', async () => { const key = queryKey() const observer = new QueryObserver(queryClient, { diff --git a/packages/query-core/src/queryObserver.ts b/packages/query-core/src/queryObserver.ts index 36ab6e9efe..105a3b376a 100644 --- a/packages/query-core/src/queryObserver.ts +++ b/packages/query-core/src/queryObserver.ts @@ -369,6 +369,14 @@ export class QueryObserver< return promise } + #shouldScheduleTimer(timeout: unknown): timeout is number { + return ( + !environmentManager.isServer() && + resolveQueryBoolean(this.options.enabled, this.#currentQuery) !== false && + isValidTimeout(timeout) + ) + } + #updateStaleTimeout(): void { this.#clearStaleTimeout() const staleTime = resolveStaleTime( @@ -376,11 +384,7 @@ export class QueryObserver< this.#currentQuery, ) - if ( - environmentManager.isServer() || - this.#currentResult.isStale || - !isValidTimeout(staleTime) - ) { + if (this.#currentResult.isStale || !this.#shouldScheduleTimer(staleTime)) { return } @@ -411,10 +415,8 @@ export class QueryObserver< this.#currentRefetchInterval = nextInterval if ( - environmentManager.isServer() || - resolveQueryBoolean(this.options.enabled, this.#currentQuery) === false || - !isValidTimeout(this.#currentRefetchInterval) || - this.#currentRefetchInterval === 0 + this.#currentRefetchInterval === 0 || + !this.#shouldScheduleTimer(this.#currentRefetchInterval) ) { return }