Open History to see the last commit
1import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
2import React from 'react'
3import { act, fireEvent } from '@testing-library/react'
4import { queryKey, sleep } from '@tanstack/query-test-utils'
5import {
6 QueryCache,
7 QueryClient,
8 usePrefetchInfiniteQuery,
9 useSuspenseInfiniteQuery,
10} from '..'
11import { renderWithClient } from './utils'
12import type { InfiniteData, UseSuspenseInfiniteQueryOptions } from '..'
13import type { Mock } from 'vitest'
14β
15const createFallback = () =>
16 vi.fn().mockImplementation(() => <div>Loading...</div>)
17β
18const generateInfiniteQueryOptions = (
19 data: Array<{ data: string; currentPage: number; totalPages: number }>,
20) => {
21 let currentPage = 0
22β
23 return {
24 queryFn: vi
25 .fn<(...args: Array<any>) => Promise<(typeof data)[number]>>()
26 .mockImplementation(async () => {
27 const currentPageData = data[currentPage]
28 if (!currentPageData) {
29 throw new Error('No data defined for page ' + currentPage)
30 }
31β
32 await sleep(10)
33 currentPage++
34β
35 return currentPageData
36 }),
37 initialPageParam: 1,
38 getNextPageParam: (lastPage: (typeof data)[number]) =>
39 lastPage.currentPage === lastPage.totalPages
40 ? undefined
41 : lastPage.currentPage + 1,
42 }
43}
44β
45describe('usePrefetchInfiniteQuery', () => {
46 beforeEach(() => {
47 vi.useFakeTimers()
48 })
49β
50 afterEach(() => {
51 vi.useRealTimers()
52 })
53β
54 const queryCache = new QueryCache()
55 const queryClient = new QueryClient({ queryCache })
56β
57 function Suspended<T = unknown>(props: {
58 queryOpts: UseSuspenseInfiniteQueryOptions<
59 T,
60 Error,
61 InfiniteData<T>,
62 Array<string>,
63 any
64 >
65 renderPage: (page: T) => React.JSX.Element
66 }) {
67 const state = useSuspenseInfiniteQuery(props.queryOpts)
68β
69 return (
70 <div>
71 {state.data.pages.map((page, index) => (
72 <div key={index}>{props.renderPage(page)}</div>
73 ))}
74 <button onClick={() => state.fetchNextPage()}>Next Page</button>
75 </div>
76 )
77 }
78β
79 it('should prefetch an infinite query if query state does not exist', async () => {
80 const Fallback = createFallback()
81 const data = [
82 { data: 'Do you fetch on render?', currentPage: 1, totalPages: 3 },
83 { data: 'Or do you render as you fetch?', currentPage: 2, totalPages: 3 },
84 {
85 data: 'Either way, Tanstack Query helps you!',
86 currentPage: 3,
87 totalPages: 3,
88 },
89 ]
90β
91 const queryOpts = {
92 queryKey: queryKey(),
93 ...generateInfiniteQueryOptions(data),
94 }
95β
96 function App() {
97 usePrefetchInfiniteQuery({ ...queryOpts, pages: data.length })
98β
99 return (
100 <React.Suspense fallback={<Fallback />}>
101 <Suspended
102 queryOpts={queryOpts}
103 renderPage={(page) => <div>data: {page.data}</div>}
104 />
105 </React.Suspense>
106 )
107 }
108β
109 const rendered = renderWithClient(queryClient, <App />)
110β
111 await act(() => vi.advanceTimersByTimeAsync(30))
112 rendered.getByText('data: Do you fetch on render?')
113 fireEvent.click(rendered.getByText('Next Page'))
114 expect(
115 rendered.getByText('data: Or do you render as you fetch?'),
116 ).toBeInTheDocument()
117 fireEvent.click(rendered.getByText('Next Page'))
118 expect(
119 rendered.getByText('data: Either way, Tanstack Query helps you!'),
120 ).toBeInTheDocument()
121 expect(Fallback).toHaveBeenCalledTimes(1)
122 expect(queryOpts.queryFn).toHaveBeenCalledTimes(3)
123 })
124β
125 it('should not display fallback if the query cache is already populated', async () => {
126 const Fallback = createFallback()
127 const queryOpts = {
128 queryKey: queryKey(),
129 ...generateInfiniteQueryOptions([
130 { data: 'Prefetch rocks!', currentPage: 1, totalPages: 3 },
131 { data: 'No waterfalls, boy!', currentPage: 2, totalPages: 3 },
132 { data: 'Tanstack Query #ftw', currentPage: 3, totalPages: 3 },
133 ]),
134 }
135β
136 queryClient.prefetchInfiniteQuery({ ...queryOpts, pages: 3 })
137 await vi.advanceTimersByTimeAsync(30)
138 ;(queryOpts.queryFn as Mock).mockClear()
139β
140 function App() {
141 usePrefetchInfiniteQuery(queryOpts)
142β
143 return (
144 <React.Suspense fallback={<Fallback />}>
145 <Suspended
146 queryOpts={queryOpts}
147 renderPage={(page) => <div>data: {page.data}</div>}
148 />
149 </React.Suspense>
150 )
151 }
152β
153 const rendered = renderWithClient(queryClient, <App />)
154β
155 expect(rendered.getByText('data: Prefetch rocks!')).toBeInTheDocument()
156 fireEvent.click(rendered.getByText('Next Page'))
157 expect(rendered.getByText('data: No waterfalls, boy!')).toBeInTheDocument()
158 fireEvent.click(rendered.getByText('Next Page'))
159 expect(rendered.getByText('data: Tanstack Query #ftw')).toBeInTheDocument()
160 expect(queryOpts.queryFn).not.toHaveBeenCalled()
161 expect(Fallback).not.toHaveBeenCalled()
162 })
163β
164 it('should not create an endless loop when using inside a suspense boundary', async () => {
165 const queryOpts = {
166 queryKey: queryKey(),
167 ...generateInfiniteQueryOptions([
168 { data: 'Infinite Page 1', currentPage: 1, totalPages: 3 },
169 { data: 'Infinite Page 2', currentPage: 1, totalPages: 3 },
170 { data: 'Infinite Page 3', currentPage: 1, totalPages: 3 },
171 ]),
172 }
173β
174 function Prefetch({ children }: { children: React.ReactNode }) {
175 usePrefetchInfiniteQuery(queryOpts)
176 return <>{children}</>
177 }
178β
179 function App() {
180 return (
181 <React.Suspense>
182 <Prefetch>
183 <Suspended
184 queryOpts={queryOpts}
185 renderPage={(page) => <div>data: {page.data}</div>}
186 />
187 </Prefetch>
188 </React.Suspense>
189 )
190 }
191β
192 const rendered = renderWithClient(queryClient, <App />)
193β
194 await act(() => vi.advanceTimersByTimeAsync(10))
195 rendered.getByText('data: Infinite Page 1')
196 fireEvent.click(rendered.getByText('Next Page'))
197 await vi.advanceTimersByTimeAsync(11)
198 expect(rendered.getByText('data: Infinite Page 2')).toBeInTheDocument()
199 fireEvent.click(rendered.getByText('Next Page'))
200 await vi.advanceTimersByTimeAsync(11)
201 expect(rendered.getByText('data: Infinite Page 3')).toBeInTheDocument()
202 expect(queryOpts.queryFn).toHaveBeenCalledTimes(3)
203 })
204})