Open History to see the last commit
1import React from 'react'
2import ReactDOM from 'react-dom/client'
3β
4import {
5 QueryClient,
6 QueryClientProvider,
7 useQuery,
8 useQueryClient,
9 useMutation,
10} from '@tanstack/react-query'
11β
12import { ReactQueryDevtools } from '@tanstack/react-query-devtools'
13β
14import './styles.css'
15β
16let id = 0
17let list = [
18 'apple',
19 'banana',
20 'pineapple',
21 'grapefruit',
22 'dragonfruit',
23 'grapes',
24].map((d) => ({ id: id++, name: d, notes: 'These are some notes' }))
25β
26let errorRate = 0.05
27let queryTimeMin = 1000
28let queryTimeMax = 2000
29β
30const queryClient = new QueryClient()
31β
32function Root() {
33 const [staleTime, setStaleTime] = React.useState(1000)
34 const [gcTime, setgcTime] = React.useState(3000)
35 const [localErrorRate, setErrorRate] = React.useState(errorRate)
36 const [localFetchTimeMin, setLocalFetchTimeMin] = React.useState(queryTimeMin)
37 const [localFetchTimeMax, setLocalFetchTimeMax] = React.useState(queryTimeMax)
38β
39 React.useEffect(() => {
40 errorRate = localErrorRate
41 queryTimeMin = localFetchTimeMin
42 queryTimeMax = localFetchTimeMax
43 }, [localErrorRate, localFetchTimeMax, localFetchTimeMin])
44β
45 React.useEffect(() => {
46 queryClient.setDefaultOptions({
47 queries: {
48 staleTime,
49 gcTime,
50 },
51 })
52 }, [gcTime, staleTime])
53β
54 return (
55 <QueryClientProvider client={queryClient}>
56 <p>
57 The "staleTime" and "gcTime" durations have been altered in this example
58 to show how query stale-ness and query caching work on a granular level
59 </p>
60 <div>
61 Stale Time:{' '}
62 <input
63 type="number"
64 min="0"
65 step="1000"
66 value={staleTime}
67 onChange={(e) => setStaleTime(parseFloat(e.target.value, 10))}
68 style={{ width: '100px' }}
69 />
70 </div>
71 <div>
72 Garbage collection Time:{' '}
73 <input
74 type="number"
75 min="0"
76 step="1000"
77 value={gcTime}
78 onChange={(e) => setgcTime(parseFloat(e.target.value, 10))}
79 style={{ width: '100px' }}
80 />
81 </div>
82 <br />
83 <div>
84 Error Rate:{' '}
85 <input
86 type="number"
87 min="0"
88 max="1"
89 step=".05"
90 value={localErrorRate}
91 onChange={(e) => setErrorRate(parseFloat(e.target.value, 10))}
92 style={{ width: '100px' }}
93 />
94 </div>
95 <div>
96 Fetch Time Min:{' '}
97 <input
98 type="number"
99 min="1"
100 step="500"
101 value={localFetchTimeMin}
102 onChange={(e) => setLocalFetchTimeMin(parseFloat(e.target.value, 10))}
103 style={{ width: '60px' }}
104 />{' '}
105 </div>
106 <div>
107 Fetch Time Max:{' '}
108 <input
109 type="number"
110 min="1"
111 step="500"
112 value={localFetchTimeMax}
113 onChange={(e) => setLocalFetchTimeMax(parseFloat(e.target.value, 10))}
114 style={{ width: '60px' }}
115 />
116 </div>
117 <br />
118 <App />
119 <br />
120 <ReactQueryDevtools initialIsOpen />
121 </QueryClientProvider>
122 )
123}
124β
125function App() {
126 const queryClient = useQueryClient()
127 const [editingIndex, setEditingIndex] = React.useState(null)
128 const [views, setViews] = React.useState(['', 'fruit', 'grape'])
129 // const [views, setViews] = React.useState([""]);
130β
131 return (
132 <div className="App">
133 <div>
134 <button onClick={() => queryClient.invalidateQueries()}>
135 Force Refetch All
136 </button>
137 </div>
138 <br />
139 <hr />
140 {views.map((view, index) => (
141 <div key={index}>
142 <Todos
143 initialFilter={view}
144 setEditingIndex={setEditingIndex}
145 onRemove={() => {
146 setViews((old) => [...old, ''])
147 }}
148 />
149 <br />
150 </div>
151 ))}
152 <button
153 onClick={() => {
154 setViews((old) => [...old, ''])
155 }}
156 >
157 Add Filter List
158 </button>
159 <hr />
160 {editingIndex !== null ? (
161 <>
162 <EditTodo
163 editingIndex={editingIndex}
164 setEditingIndex={setEditingIndex}
165 />
166 <hr />
167 </>
168 ) : null}
169 <AddTodo />
170 </div>
171 )
172}
173β
174function Todos({ initialFilter = '', setEditingIndex }) {
175 const [filter, setFilter] = React.useState(initialFilter)
176β
177 const { status, data, isFetching, error, failureCount, refetch } = useQuery({
178 queryKey: ['todos', { filter }],
179 queryFn: fetchTodos,
180 })
181β
182 return (
183 <div>
184 <div>
185 <label>
186 Filter:{' '}
187 <input value={filter} onChange={(e) => setFilter(e.target.value)} />
188 </label>
189 </div>
190 {status === 'pending' ? (
191 <span>Loading... (Attempt: {failureCount + 1})</span>
192 ) : status === 'error' ? (
193 <span>
194 Error: {error.message}
195 <br />
196 <button onClick={() => refetch()}>Retry</button>
197 </span>
198 ) : (
199 <>
200 <ul>
201 {data
202 ? data.map((todo) => (
203 <li key={todo.id}>
204 {todo.name}{' '}
205 <button onClick={() => setEditingIndex(todo.id)}>
206 Edit
207 </button>
208 </li>
209 ))
210 : null}
211 </ul>
212 <div>
213 {isFetching ? (
214 <span>
215 Background Refreshing... (Attempt: {failureCount + 1})
216 </span>
217 ) : (
218 <span> </span>
219 )}
220 </div>
221 </>
222 )}
223 </div>
224 )
225}
226β
227function EditTodo({ editingIndex, setEditingIndex }) {
228 const queryClient = useQueryClient()
229β
230 // Don't attempt to query until editingIndex is truthy
231 const { status, data, isFetching, error, failureCount, refetch } = useQuery({
232 queryKey: ['todo', { id: editingIndex }],
233 queryFn: () => fetchTodoById({ id: editingIndex }),
234 enabled: editingIndex !== null,
235 })
236β
237 const [todo, setTodo] = React.useState(data || {})
238β
239 React.useEffect(() => {
240 if (editingIndex !== null && data) {
241 setTodo(data)
242 } else {
243 setTodo({})
244 }
245 }, [data, editingIndex])
246β
247 const saveMutation = useMutation({
248 mutationFn: patchTodo,
249 onSuccess: (data) => {
250 // Update `todos` and the individual todo queries when this mutation succeeds
251 queryClient.invalidateQueries({ queryKey: ['todos'] })
252 queryClient.setQueryData(['todo', { id: editingIndex }], data)
253 },
254 })
255β
256 const onSave = () => {
257 saveMutation.mutate(todo)
258 }
259β
260 const disableEditSave =
261 status === 'pending' || saveMutation.status === 'pending'
262β
263 return (
264 <div>
265 <div>
266 {data ? (
267 <>
268 <button onClick={() => setEditingIndex(null)}>Back</button> Editing
269 Todo "{data.name}" (#
270 {editingIndex})
271 </>
272 ) : null}
273 </div>
274 {status === 'pending' ? (
275 <span>Loading... (Attempt: {failureCount + 1})</span>
276 ) : error ? (
277 <span>
278 Error! <button onClick={() => refetch()}>Retry</button>
279 </span>
280 ) : (
281 <>
282 <label>
283 Name:{' '}
284 <input
285 value={todo.name}
286 onChange={(e) =>
287 e.persist() ||
288 setTodo((old) => ({ ...old, name: e.target.value }))
289 }
290 disabled={disableEditSave}
291 />
292 </label>
293 <label>
294 Notes:{' '}
295 <input
296 value={todo.notes}
297 onChange={(e) =>
298 e.persist() ||
299 setTodo((old) => ({ ...old, notes: e.target.value }))
300 }
301 disabled={disableEditSave}
302 />
303 </label>
304 <div>
305 <button onClick={onSave} disabled={disableEditSave}>
306 Save
307 </button>
308 </div>
309 <div>
310 {saveMutation.status === 'pending'
311 ? 'Saving...'
312 : saveMutation.status === 'error'
313 ? saveMutation.error.message
314 : 'Saved!'}
315 </div>
316 <div>
317 {isFetching ? (
318 <span>
319 Background Refreshing... (Attempt: {failureCount + 1})
320 </span>
321 ) : (
322 <span> </span>
323 )}
324 </div>
325 </>
326 )}
327 </div>
328 )
329}
330β
331function AddTodo() {
332 const queryClient = useQueryClient()
333 const [name, setName] = React.useState('')
334β
335 const addMutation = useMutation({
336 mutationFn: postTodo,
337 onSuccess: () => {
338 queryClient.invalidateQueries({ queryKey: ['todos'] })
339 },
340 })
341β
342 return (
343 <div>
344 <input
345 value={name}
346 onChange={(e) => setName(e.target.value)}
347 disabled={addMutation.status === 'pending'}
348 />
349 <button
350 onClick={() => {
351 addMutation.mutate({ name })
352 }}
353 disabled={addMutation.status === 'pending' || !name}
354 >
355 Add Todo
356 </button>
357 <div>
358 {addMutation.status === 'pending'
359 ? 'Saving...'
360 : addMutation.status === 'error'
361 ? addMutation.error.message
362 : 'Saved!'}
363 </div>
364 </div>
365 )
366}
367β
368function fetchTodos({ signal, queryKey: [, { filter }] }) {
369 console.info('fetchTodos', { filter })
370β
371 if (signal) {
372 signal.addEventListener('abort', () => {
373 console.info('cancelled', filter)
374 })
375 }
376β
377 return new Promise((resolve, reject) => {
378 setTimeout(
379 () => {
380 if (Math.random() < errorRate) {
381 return reject(
382 new Error(JSON.stringify({ fetchTodos: { filter } }, null, 2)),
383 )
384 }
385 resolve(list.filter((d) => d.name.includes(filter)))
386 },
387 queryTimeMin + Math.random() * (queryTimeMax - queryTimeMin),
388 )
389 })
390}
391β
392function fetchTodoById({ id }) {
393 console.info('fetchTodoById', { id })
394 return new Promise((resolve, reject) => {
395 setTimeout(
396 () => {
397 if (Math.random() < errorRate) {
398 return reject(
399 new Error(JSON.stringify({ fetchTodoById: { id } }, null, 2)),
400 )
401 }
402 resolve(list.find((d) => d.id === id))
403 },
404 queryTimeMin + Math.random() * (queryTimeMax - queryTimeMin),
405 )
406 })
407}
408β
409function postTodo({ name, notes }) {
410 console.info('postTodo', { name, notes })
411 return new Promise((resolve, reject) => {
412 setTimeout(
413 () => {
414 if (Math.random() < errorRate) {
415 return reject(
416 new Error(JSON.stringify({ postTodo: { name, notes } }, null, 2)),
417 )
418 }
419 const todo = { name, notes, id: id++ }
420 list = [...list, todo]
421 resolve(todo)
422 },
423 queryTimeMin + Math.random() * (queryTimeMax - queryTimeMin),
424 )
425 })
426}
427β
428function patchTodo(todo) {
429 console.info('patchTodo', todo)
430 return new Promise((resolve, reject) => {
431 setTimeout(
432 () => {
433 if (Math.random() < errorRate) {
434 return reject(new Error(JSON.stringify({ patchTodo: todo }, null, 2)))
435 }
436 list = list.map((d) => {
437 if (d.id === todo.id) {
438 return todo
439 }
440 return d
441 })
442 resolve(todo)
443 },
444 queryTimeMin + Math.random() * (queryTimeMax - queryTimeMin),
445 )
446 })
447}
448β
449const rootElement = document.getElementById('root')
450ReactDOM.createRoot(rootElement).render(<Root />)