Skip to content
Open
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/tidy-pandas-wait.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/react-query': patch
---

fix(react-query): don't show optimistic fetching for unsubscribed useQueries
28 changes: 28 additions & 0 deletions packages/react-query/src/__tests__/useQueries.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,34 @@ describe('useQueries', () => {
expect(results[2]).toMatchObject([{ data: 1 }, { data: 2 }])
})

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

function Page() {
const [query] = useQueries({
queries: [{ queryKey: key, queryFn }],
subscribed: false,
})

return (
<div>
<span>isFetching: {String(query.isFetching)}</span>
<span>fetchStatus: {query.fetchStatus}</span>
</div>
)
}

const rendered = renderWithClient(queryClient, <Page />)

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

it('should track results', async () => {
const key1 = queryKey()
const results: Array<Array<UseQueryResult>> = []
Expand Down
9 changes: 6 additions & 3 deletions packages/react-query/src/useQueries.ts
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,7 @@ export function useQueries<
const client = useQueryClient(queryClient)
const isRestoring = useIsRestoring()
const errorResetBoundary = useQueryErrorResetBoundary()
const subscribed = options.subscribed !== false

const defaultedQueries = React.useMemo(
() =>
Expand All @@ -234,11 +235,13 @@ export function useQueries<
// Make sure the results are already in fetching state before subscribing or updating options
defaultedOptions._optimisticResults = isRestoring
? 'isRestoring'
: 'optimistic'
: subscribed
? 'optimistic'
: undefined

return defaultedOptions
}),
[queries, client, isRestoring],
[queries, client, isRestoring, subscribed],
)

defaultedQueries.forEach((queryOptions) => {
Expand All @@ -265,7 +268,7 @@ export function useQueries<
(options as QueriesObserverOptions<TCombinedResult>).combine,
)

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