Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

usePrefetchInfiniteQuery.test.tsx

188 lines5.7 KB

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