Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/strong-toes-knock.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/react-query': patch
---

fix(react-query): do not go into optimistic fetching state when not subscribed
36 changes: 36 additions & 0 deletions packages/react-query/src/__tests__/useQuery.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5916,6 +5916,42 @@ describe('useQuery', () => {
).toBe(1)
})

it('should not optimistically show fetching when unsubscribed', async () => {
const key = queryKey()
const queryFn = vi.fn(() => Promise.resolve('data'))

function Page() {
const [subscribed, setSubscribed] = React.useState(true)
const query = useQuery({
queryKey: key,
queryFn,
subscribed,
})

return (
<div>
<span>isFetching: {String(query.isFetching)}</span>
<span>fetchStatus: {query.fetchStatus}</span>
<button onClick={() => setSubscribed(false)}>unsubscribe</button>
</div>
)
}

const rendered = renderWithClient(queryClient, <Page />)
await vi.advanceTimersByTimeAsync(0)
rendered.getByText('isFetching: false')
rendered.getByText('fetchStatus: idle')

fireEvent.click(rendered.getByRole('button', { name: 'unsubscribe' }))

expect(queryFn).toHaveBeenCalledTimes(1)
expect(
queryClient.getQueryCache().find({ queryKey: key })!.observers.length,
).toBe(0)
rendered.getByText('isFetching: false')
rendered.getByText('fetchStatus: idle')
})

it('should not be attached to the query when subscribed is false', async () => {
const key = queryKey()
const queryFn = vi.fn(() => Promise.resolve('data'))
Expand Down
8 changes: 6 additions & 2 deletions packages/react-query/src/useBaseQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,14 @@ export function useBaseQuery<
}
}

const subscribed = options.subscribed !== false

// Make sure results are optimistically set in fetching state before subscribing or updating options
defaultedOptions._optimisticResults = isRestoring
? 'isRestoring'
: 'optimistic'
: subscribed
? 'optimistic'
: undefined

ensureSuspenseTimers(defaultedOptions)
ensurePreventErrorBoundaryRetry(defaultedOptions, errorResetBoundary, query)
Expand All @@ -99,7 +103,7 @@ export function useBaseQuery<
// note: this must be called before useSyncExternalStore
const result = observer.getOptimisticResult(defaultedOptions)

const shouldSubscribe = !isRestoring && options.subscribed !== false
const shouldSubscribe = !isRestoring && subscribed
React.useSyncExternalStore(
React.useCallback(
(onStoreChange) => {
Expand Down
Loading