Open History to see the last commit
1import {
2 render,
3 waitFor,
4 fireEvent,
5 cleanup,
6} from '@testing-library/react'
7import * as React from 'react'
8β
9import {
10 useInfiniteQuery,
11 ReactQueryCacheProvider,
12 useQueryCache,
13} from '../index'
14import { sleep } from './utils'
15β
16const pageSize = 10
17β
18const initialItems = page => {
19 return {
20 items: [...new Array(10)].fill(null).map((_, d) => page * pageSize + d),
21 nextId: page + 1,
22 ts: page,
23 }
24}
25β
26const fetchItems = async (page, ts) => {
27 await sleep(10)
28 return {
29 items: [...new Array(10)].fill(null).map((_, d) => page * pageSize + d),
30 nextId: page + 1,
31 ts,
32 }
33}
34β
35describe('useInfiniteQuery', () => {
36 afterEach(() => {
37 cleanup()
38 })
39β
40 it('should allow you to fetch more pages', async () => {
41 function Page() {
42 const fetchCountRef = React.useRef(0)
43 const {
44 status,
45 data,
46 error,
47 isFetching,
48 isFetchingMore,
49 fetchMore,
50 canFetchMore,
51 refetch,
52 } = useInfiniteQuery(
53 'items',
54 (key, nextId = 0) => fetchItems(nextId, fetchCountRef.current++),
55 {
56 getFetchMore: (lastGroup, allGroups) => lastGroup.nextId,
57 }
58 )
59β
60 return (
61 <div>
62 <h1>Pagination</h1>
63 {status === 'loading' ? (
64 'Loading...'
65 ) : status === 'error' ? (
66 <span>Error: {error.message}</span>
67 ) : (
68 <>
69 <div>Data:</div>
70 {data.map((page, i) => (
71 <div key={i}>
72 <div>
73 Page {i}: {page.ts}
74 </div>
75 <div key={i}>
76 {page.items.map(item => (
77 <p key={item}>Item: {item}</p>
78 ))}
79 </div>
80 </div>
81 ))}
82 <div>
83 <button
84 onClick={() => fetchMore()}
85 disabled={!canFetchMore || isFetchingMore}
86 >
87 {isFetchingMore
88 ? 'Loading more...'
89 : canFetchMore
90 ? 'Load More'
91 : 'Nothing more to load'}
92 </button>
93 <button onClick={() => refetch()}>Refetch</button>
94 </div>
95 <div>
96 {isFetching && !isFetchingMore
97 ? 'Background Updating...'
98 : null}
99 </div>
100 </>
101 )}
102 </div>
103 )
104 }
105β
106 const rendered = render(
107 <ReactQueryCacheProvider>
108 <Page />
109 </ReactQueryCacheProvider>
110 )
111β
112 rendered.getByText('Loading...')
113β
114 await waitFor(() => {
115 rendered.getByText('Item: 9')
116 rendered.getByText('Page 0: 0')
117 })
118β
119 fireEvent.click(rendered.getByText('Load More'))
120β
121 await waitFor(() => rendered.getByText('Loading more...'))
122β
123 await waitFor(() => {
124 rendered.getByText('Item: 19')
125 rendered.getByText('Page 0: 0')
126 rendered.getByText('Page 1: 1')
127 })
128β
129 fireEvent.click(rendered.getByText('Refetch'))
130β
131 await waitFor(() => rendered.getByText('Background Updating...'))
132 await waitFor(() => {
133 rendered.getByText('Item: 19')
134 rendered.getByText('Page 0: 2')
135 rendered.getByText('Page 1: 3')
136 })
137 })
138β
139 it('should compute canFetchMore correctly using initialData', async () => {
140 function Page() {
141 const fetchCountRef = React.useRef(0)
142 const {
143 status,
144 data,
145 error,
146 isFetching,
147 isFetchingMore,
148 fetchMore,
149 canFetchMore,
150 refetch,
151 } = useInfiniteQuery(
152 'items',
153 (key, nextId = 0) => fetchItems(nextId, fetchCountRef.current++),
154 {
155 initialData: [initialItems(0)],
156 getFetchMore: (lastGroup, allGroups) => lastGroup.nextId,
157 }
158 )
159β
160 return (
161 <div>
162 <h1>Pagination</h1>
163 {status === 'loading' ? (
164 'Loading...'
165 ) : status === 'error' ? (
166 <span>Error: {error.message}</span>
167 ) : (
168 <>
169 <div>Data:</div>
170 {data.map((page, i) => (
171 <div key={i}>
172 <div>
173 Page {i}: {page.ts}
174 </div>
175 <div key={i}>
176 {page.items.map(item => (
177 <p key={item}>Item: {item}</p>
178 ))}
179 </div>
180 </div>
181 ))}
182 <div>
183 <button
184 onClick={() => fetchMore()}
185 disabled={!canFetchMore || isFetchingMore}
186 >
187 {isFetchingMore
188 ? 'Loading more...'
189 : canFetchMore
190 ? 'Load More'
191 : 'Nothing more to load'}
192 </button>
193 <button onClick={() => refetch()}>Refetch</button>
194 </div>
195 <div>
196 {isFetching && !isFetchingMore
197 ? 'Background Updating...'
198 : null}
199 </div>
200 </>
201 )}
202 </div>
203 )
204 }
205β
206 const rendered = render(
207 <ReactQueryCacheProvider>
208 <Page />
209 </ReactQueryCacheProvider>
210 )
211β
212 rendered.getByText('Item: 9')
213 rendered.getByText('Page 0: 0')
214β
215 fireEvent.click(rendered.getByText('Load More'))
216β
217 await waitFor(() => rendered.getByText('Loading more...'))
218β
219 await waitFor(() => {
220 rendered.getByText('Item: 19')
221 rendered.getByText('Page 1: 0')
222 })
223β
224 fireEvent.click(rendered.getByText('Refetch'))
225β
226 await waitFor(() => rendered.getByText('Background Updating...'))
227 await waitFor(() => {
228 rendered.getByText('Item: 19')
229 rendered.getByText('Page 0: 1')
230 rendered.getByText('Page 1: 2')
231 })
232 })
233β
234 it('should build fresh cursors on refetch', async () => {
235 const genItems = size => [...new Array(size)].fill(null).map((_, d) => d)
236 const items = genItems(15)
237 const limit = 3
238β
239 const fetchItems = async (cursor = 0, ts) => {
240 await sleep(10)
241 return {
242 nextId: cursor + limit,
243 items: items.slice(cursor, cursor + limit),
244 ts,
245 }
246 }
247β
248 function Page() {
249 const queryCache = useQueryCache()
250 const fetchCountRef = React.useRef(0)
251 const {
252 status,
253 data,
254 error,
255 isFetchingMore,
256 fetchMore,
257 canFetchMore,
258 refetch,
259 } = useInfiniteQuery(
260 'items',
261 (key, nextId = 0) => fetchItems(nextId, fetchCountRef.current++),
262 {
263 getFetchMore: (lastGroup, allGroups) => lastGroup.nextId,
264 }
265 )
266β
267 return (
268 <div>
269 <h1>Pagination</h1>
270 {status === 'loading' ? (
271 'Loading...'
272 ) : status === 'error' ? (
273 <span>Error: {error.message}</span>
274 ) : (
275 <>
276 <div>Data:</div>
277 {data.map((page, i) => (
278 <div key={i}>
279 <div>
280 Page {i}: {page.ts}
281 </div>
282 <div key={i}>
283 {page.items.map(item => (
284 <p key={item}>Item: {item}</p>
285 ))}
286 </div>
287 </div>
288 ))}
289 <div>
290 <button
291 onClick={() => fetchMore()}
292 disabled={!canFetchMore || isFetchingMore}
293 >
294 {isFetchingMore
295 ? 'Loading more...'
296 : canFetchMore
297 ? 'Load More'
298 : 'Nothing more to load'}
299 </button>
300 <button onClick={() => refetch()}>Refetch</button>
301 <button
302 onClick={() => {
303 // Imagine that this mutation happens somewhere else
304 // makes an actual network request
305 // and calls refetchQueries in an onSuccess
306 items.splice(4, 1)
307 queryCache.refetchQueries('items')
308 }}
309 >
310 Remove item
311 </button>
312 </div>
313 <div>{!isFetchingMore ? 'Background Updating...' : null}</div>
314 </>
315 )}
316 </div>
317 )
318 }
319β
320 const rendered = render(
321 <ReactQueryCacheProvider>
322 <Page />
323 </ReactQueryCacheProvider>
324 )
325β
326 rendered.getByText('Loading...')
327β
328 await rendered.findByText('Item: 2')
329 await rendered.findByText('Page 0: 0')
330β
331 fireEvent.click(rendered.getByText('Load More'))
332β
333 await rendered.findByText('Loading more...')
334 await rendered.findByText('Item: 5')
335 await rendered.findByText('Page 0: 0')
336 await rendered.findByText('Page 1: 1')
337β
338 fireEvent.click(rendered.getByText('Load More'))
339β
340 await rendered.findByText('Loading more...')
341 await rendered.findByText('Item: 8')
342 await rendered.findByText('Page 0: 0')
343 await rendered.findByText('Page 1: 1')
344 await rendered.findByText('Page 2: 2')
345β
346 fireEvent.click(rendered.getByText('Refetch'))
347β
348 await rendered.findByText('Background Updating...')
349 await rendered.findByText('Item: 8')
350 await rendered.findByText('Page 0: 3')
351 await rendered.findByText('Page 1: 4')
352 await rendered.findByText('Page 2: 5')
353β
354 // ensure that Item: 4 is rendered before removing it
355 expect(rendered.queryAllByText('Item: 4')).toHaveLength(1)
356β
357 // remove Item: 4
358 fireEvent.click(rendered.getByText('Remove item'))
359β
360 await rendered.findByText('Background Updating...')
361 // ensure that an additional item is rendered (it means that cursors were properly rebuilt)
362 await rendered.findByText('Item: 9')
363 await rendered.findByText('Page 0: 6')
364 await rendered.findByText('Page 1: 7')
365 await rendered.findByText('Page 2: 8')
366β
367 // ensure that Item: 4 is no longer rendered
368 expect(rendered.queryAllByText('Item: 4')).toHaveLength(0)
369 })
370})