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

usePrefetchInfiniteQuery.test.tsx

213 lines6.2 KB

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