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

usePaginatedQuery.test.js

230 lines6.3 KB

1import {
2 cleanup,
3 render,
4 fireEvent,
5 waitFor,
6} from '@testing-library/react'
7import * as React from 'react'
8import { sleep } from './utils'
9​
10import { usePaginatedQuery, ReactQueryCacheProvider } from '../index'
11​
12describe('usePaginatedQuery', () => {
13 afterEach(() => {
14 cleanup()
15 })
16​
17 it('should use previous page data while fetching the next page', async () => {
18 function Page() {
19 const [page, setPage] = React.useState(1)
20 const { resolvedData = 'undefined' } = usePaginatedQuery(
21 ['data', page],
22 async (queryName, page) => {
23 await sleep(1)
24 return page
25 }
26 )
27​
28 return (
29 <div>
30 <h1 data-testid="title">Data {resolvedData}</h1>
31 <button onClick={() => setPage(page + 1)}>next</button>
32 </div>
33 )
34 }
35​
36 const rendered = render(
37 <ReactQueryCacheProvider>
38 <Page />
39 </ReactQueryCacheProvider>
40 )
41​
42 rendered.getByText('Data undefined')
43 await waitFor(() => rendered.getByText('Data 1'))
44​
45 fireEvent.click(rendered.getByText('next'))
46 rendered.getByText('Data 1')
47 await waitFor(() => rendered.getByText('Data 2'))
48​
49 fireEvent.click(rendered.getByText('next'))
50 rendered.getByText('Data 2')
51 await waitFor(() => rendered.getByText('Data 3'))
52 })
53​
54 it('should use initialData only on the first page, then use previous page data while fetching the next page', async () => {
55 function Page() {
56 const [page, setPage] = React.useState(1)
57​
58 const { resolvedData } = usePaginatedQuery(
59 ['data', { page }],
60 async (queryName, { page }) => {
61 await sleep(1)
62 return page
63 },
64 { initialData: 0 }
65 )
66​
67 return (
68 <div>
69 <h1 data-testid="title">Data {resolvedData}</h1>
70 <button onClick={() => setPage(page + 1)}>next</button>
71 </div>
72 )
73 }
74​
75 const rendered = render(
76 <ReactQueryCacheProvider>
77 <Page />
78 </ReactQueryCacheProvider>
79 )
80​
81 rendered.getByText('Data 0')
82​
83 fireEvent.click(rendered.getByText('next'))
84 rendered.getByText('Data 0')
85 await waitFor(() => rendered.getByText('Data 2'))
86​
87 fireEvent.click(rendered.getByText('next'))
88 rendered.getByText('Data 2')
89 await waitFor(() => rendered.getByText('Data 3'))
90​
91 fireEvent.click(rendered.getByText('next'))
92 rendered.getByText('Data 3')
93 await waitFor(() => rendered.getByText('Data 4'))
94 })
95​
96 // See https://github.com/tannerlinsley/react-query/issues/169
97 it('should not trigger unnecessary loading state', async () => {
98 function Page() {
99 const [page, setPage] = React.useState(1)
100​
101 const { resolvedData, status } = usePaginatedQuery(
102 ['data', { page }],
103 async (queryName, { page }) => {
104 await sleep(1)
105 return page
106 },
107 { initialData: 0 }
108 )
109​
110 return (
111 <div>
112 <h1 data-testid="title">Data {resolvedData}</h1>
113 <h1 data-testid="status">{status}</h1>
114 <button onClick={() => setPage(page + 1)}>next</button>
115 </div>
116 )
117 }
118​
119 const rendered = render(
120 <ReactQueryCacheProvider>
121 <Page />
122 </ReactQueryCacheProvider>
123 )
124​
125 rendered.getByText('Data 0')
126​
127 fireEvent.click(rendered.getByText('next'))
128 fireEvent.click(rendered.getByText('next'))
129 fireEvent.click(rendered.getByText('next'))
130​
131 await waitFor(() => rendered.getByTestId('status'))
132 expect(rendered.getByTestId('status').textContent).toBe('success')
133 expect(rendered.getByTestId('status').textContent).not.toBe('loading')
134 })
135​
136 it('should clear resolvedData data when query is falsy', async () => {
137 function Page() {
138 const [searchTerm, setSearchTerm] = React.useState('')
139 const [page, setPage] = React.useState(1)
140 const { resolvedData = 'undefined' } = usePaginatedQuery(
141 searchTerm && ['data', searchTerm, page],
142 async (queryName, searchTerm, page) => {
143 await sleep(1)
144 return `${searchTerm} ${page}`
145 }
146 )
147​
148 return (
149 <div>
150 <h1 data-testid="title">Data {resolvedData}</h1>
151 <input
152 name="searchTerm"
153 placeholder="Enter a search term"
154 value={searchTerm}
155 onChange={e => setSearchTerm(e.currentTarget.value)}
156 />
157 <button
158 onClick={() => {
159 setSearchTerm('')
160 setPage(1)
161 }}
162 >
163 clear
164 </button>
165 <button onClick={() => setPage(page + 1)}>next</button>
166 </div>
167 )
168 }
169​
170 const rendered = render(<Page />)
171​
172 fireEvent.change(rendered.getByPlaceholderText('Enter a search term'), {
173 target: { value: 'first-search' },
174 })
175 rendered.getByText('Data undefined')
176 await waitFor(() => rendered.getByText('Data first-search 1'))
177​
178 fireEvent.click(rendered.getByText('next'))
179 rendered.getByText('Data first-search 1')
180 await waitFor(() => rendered.getByText('Data first-search 2'))
181​
182 fireEvent.click(rendered.getByText('clear'))
183 rendered.getByText('Data undefined')
184​
185 fireEvent.change(rendered.getByPlaceholderText('Enter a search term'), {
186 target: { value: 'second-search' },
187 })
188 rendered.getByText('Data undefined')
189 await waitFor(() => rendered.getByText('Data second-search 1'))
190​
191 fireEvent.click(rendered.getByText('next'))
192 rendered.getByText('Data second-search 1')
193 await waitFor(() => rendered.getByText('Data second-search 2'))
194 })
195​
196 it('should not suspend while fetching the next page', async () => {
197 function Page() {
198 const [page, setPage] = React.useState(1)
199​
200 const { resolvedData } = usePaginatedQuery(
201 ['data', { page }],
202 async (queryName, { page }) => {
203 await sleep(1)
204 return page
205 },
206 {
207 initialData: 0,
208 suspense: true,
209 }
210 )
211​
212 return (
213 <div>
214 <h1 data-testid="title">Data {resolvedData}</h1>
215 <button onClick={() => setPage(page + 1)}>next</button>
216 </div>
217 )
218 }
219​
220 // render will throw if Page is suspended
221 const rendered = render(
222 <ReactQueryCacheProvider>
223 <Page />
224 </ReactQueryCacheProvider>
225 )
226​
227 fireEvent.click(rendered.getByText('next'))
228 await waitFor(() => rendered.getByText('Data 2'))
229 })
230})