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
6 changes: 6 additions & 0 deletions .changeset/useSuspenseInfiniteQuery-placeholderData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@tanstack/react-query': patch
'@tanstack/preact-query': patch
---

fix: remove placeholderData from suspense infinite query
1 change: 1 addition & 0 deletions packages/preact-query/src/useSuspenseInfiniteQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export function useSuspenseInfiniteQuery<
enabled: true,
suspense: true,
throwOnError: defaultThrowOnError,
placeholderData: undefined,
},
InfiniteQueryObserver as typeof QueryObserver,
queryClient,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -182,4 +182,55 @@ describe('useSuspenseInfiniteQuery', () => {
consoleErrorSpy.mockRestore()
process.env.NODE_ENV = envCopy
})

it('should still suspense if queryClient has placeholderData config', async () => {
const key = queryKey()
const queryClientWithPlaceholder = new QueryClient({
defaultOptions: {
queries: {
placeholderData: (previousData: any) => previousData,
},
},
})
const states: Array<UseSuspenseInfiniteQueryResult<InfiniteData<number>>> =
[]

let count = 0

function Page() {
const [stateKey, setStateKey] = React.useState(key)

const state = useSuspenseInfiniteQuery({
queryKey: stateKey,
queryFn: () => sleep(10).then(() => ++count),
initialPageParam: 1,
getNextPageParam: () => undefined,
})

states.push(state)

return (
<div>
<button aria-label="toggle" onClick={() => setStateKey(queryKey())} />
data: {String(state.data?.pages.join(','))}
</div>
)
}

const rendered = renderWithClient(
queryClientWithPlaceholder,
<React.Suspense fallback="loading">
<Page />
</React.Suspense>,
)

expect(rendered.getByText('loading')).toBeInTheDocument()
await act(() => vi.advanceTimersByTimeAsync(10))
expect(rendered.getByText('data: 1')).toBeInTheDocument()

fireEvent.click(rendered.getByLabelText('toggle'))
expect(rendered.getByText('loading')).toBeInTheDocument()
await act(() => vi.advanceTimersByTimeAsync(10))
expect(rendered.getByText('data: 2')).toBeInTheDocument()
})
})
1 change: 1 addition & 0 deletions packages/react-query/src/useSuspenseInfiniteQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export function useSuspenseInfiniteQuery<
enabled: true,
suspense: true,
throwOnError: defaultThrowOnError,
placeholderData: undefined,
},
InfiniteQueryObserver as typeof QueryObserver,
queryClient,
Expand Down