Open History to see the last commit
1import React from 'react'
2import ReactDOM from 'react-dom/client'
3import {
4 QueryClient,
5 QueryClientProvider,
6 useMutation,
7 useQuery,
8 useQueryClient,
9} from '@tanstack/react-query'
10import { ReactQueryDevtools } from '@tanstack/react-query-devtools'
11import './styles.css'
12β
13let id = 0
14let list = [
15 'apple',
16 'banana',
17 'pineapple',
18 'grapefruit',
19 'dragonfruit',
20 'grapes',
21].map((d) => ({ id: id++, name: d, notes: 'These are some notes' }))
22β
23type Todos = typeof list
24type Todo = Todos[0]
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))}
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))}
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))}
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))}
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))}
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<number | null>(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({
175 initialFilter = '',
176 setEditingIndex,
177}: {
178 initialFilter: string
179 setEditingIndex: React.Dispatch<React.SetStateAction<number | null>>
180}) {
181 const [filter, setFilter] = React.useState(initialFilter)
182β
183 const { status, data, isFetching, error, failureCount, refetch } = useQuery({
184 queryKey: ['todos', { filter }],
185 queryFn: fetchTodos,
186 })
187β
188 return (
189 <div>
190 <div>
191 <label>
192 Filter:{' '}
193 <input value={filter} onChange={(e) => setFilter(e.target.value)} />
194 </label>
195 </div>
196 {status === 'pending' ? (
197 <span>Loading... (Attempt: {failureCount + 1})</span>
198 ) : status === 'error' ? (
199 <span>
200 Error: {error.message}
201 <br />
202 <button onClick={() => refetch()}>Retry</button>
203 </span>
204 ) : (
205 <>
206 <ul>
207 {data
208 ? data.map((todo) => (
209 <li key={todo.id}>
210 {todo.name}{' '}
211 <button onClick={() => setEditingIndex(todo.id)}>
212 Edit
213 </button>
214 </li>
215 ))
216 : null}
217 </ul>
218 <div>
219 {isFetching ? (
220 <span>
221 Background Refreshing... (Attempt: {failureCount + 1})
222 </span>
223 ) : (
224 <span> </span>
225 )}
226 </div>
227 </>
228 )}
229 </div>
230 )
231}
232β
233function EditTodo({
234 editingIndex,
235 setEditingIndex,
236}: {
237 editingIndex: number
238 setEditingIndex: React.Dispatch<React.SetStateAction<number | null>>
239}) {
240 const queryClient = useQueryClient()
241β
242 // Don't attempt to query until editingIndex is truthy
243 const { status, data, isFetching, error, failureCount, refetch } = useQuery({
244 queryKey: ['todo', { id: editingIndex }],
245 queryFn: () => fetchTodoById({ id: editingIndex }),
246 })
247β
248 const [todo, setTodo] = React.useState(data || {})
249β
250 React.useEffect(() => {
251 if (editingIndex !== null && data) {
252 setTodo(data)
253 } else {
254 setTodo({})
255 }
256 }, [data, editingIndex])
257β
258 const saveMutation = useMutation({
259 mutationFn: patchTodo,
260 onSuccess: (data) => {
261 // Update `todos` and the individual todo queries when this mutation succeeds
262 queryClient.invalidateQueries({ queryKey: ['todos'] })
263 queryClient.setQueryData(['todo', { id: editingIndex }], data)
264 },
265 })
266β
267 const onSave = () => {
268 saveMutation.mutate(todo)
269 }
270β
271 const disableEditSave =
272 status === 'pending' || saveMutation.status === 'pending'
273β
274 return (
275 <div>
276 <div>
277 {data ? (
278 <>
279 <button onClick={() => setEditingIndex(null)}>Back</button> Editing
280 Todo "{data.name}" (#
281 {editingIndex})
282 </>
283 ) : null}
284 </div>
285 {status === 'pending' ? (
286 <span>Loading... (Attempt: {failureCount + 1})</span>
287 ) : error ? (
288 <span>
289 Error! <button onClick={() => refetch()}>Retry</button>
290 </span>
291 ) : (
292 <>
293 <label>
294 Name:{' '}
295 <input
296 value={todo.name}
297 onChange={(e) =>
298 e.persist() ||
299 setTodo((old) => ({ ...old, name: e.target.value }))
300 }
301 disabled={disableEditSave}
302 />
303 </label>
304 <label>
305 Notes:{' '}
306 <input
307 value={todo.notes}
308 onChange={(e) =>
309 e.persist() ||
310 setTodo((old) => ({ ...old, notes: e.target.value }))
311 }
312 disabled={disableEditSave}
313 />
314 </label>
315 <div>
316 <button onClick={onSave} disabled={disableEditSave}>
317 Save
318 </button>
319 </div>
320 <div>
321 {saveMutation.status === 'pending'
322 ? 'Saving...'
323 : saveMutation.status === 'error'
324 ? saveMutation.error.message
325 : 'Saved!'}
326 </div>
327 <div>
328 {isFetching ? (
329 <span>
330 Background Refreshing... (Attempt: {failureCount + 1})
331 </span>
332 ) : (
333 <span> </span>
334 )}
335 </div>
336 </>
337 )}
338 </div>
339 )
340}
341β
342function AddTodo() {
343 const queryClient = useQueryClient()
344 const [name, setName] = React.useState('')
345β
346 const addMutation = useMutation({
347 mutationFn: postTodo,
348 onSuccess: () => {
349 queryClient.invalidateQueries({ queryKey: ['todos'] })
350 },
351 })
352β
353 return (
354 <div>
355 <input
356 value={name}
357 onChange={(e) => setName(e.target.value)}
358 disabled={addMutation.status === 'pending'}
359 />
360 <button
361 onClick={() => {
362 addMutation.mutate({ name, notes: 'These are some notes' })
363 }}
364 disabled={addMutation.status === 'pending' || !name}
365 >
366 Add Todo
367 </button>
368 <div>
369 {addMutation.status === 'pending'
370 ? 'Saving...'
371 : addMutation.status === 'error'
372 ? addMutation.error.message
373 : 'Saved!'}
374 </div>
375 </div>
376 )
377}
378β
379function fetchTodos({ signal, queryKey: [, { filter }] }): Promise<Todos> {
380 console.info('fetchTodos', { filter })
381β
382 if (signal) {
383 signal.addEventListener('abort', () => {
384 console.info('cancelled', filter)
385 })
386 }
387β
388 return new Promise((resolve, reject) => {
389 setTimeout(
390 () => {
391 if (Math.random() < errorRate) {
392 return reject(
393 new Error(JSON.stringify({ fetchTodos: { filter } }, null, 2)),
394 )
395 }
396 resolve(list.filter((d) => d.name.includes(filter)))
397 },
398 queryTimeMin + Math.random() * (queryTimeMax - queryTimeMin),
399 )
400 })
401}
402β
403function fetchTodoById({ id }: { id: number }): Promise<Todo> {
404 console.info('fetchTodoById', { id })
405 return new Promise((resolve, reject) => {
406 setTimeout(
407 () => {
408 if (Math.random() < errorRate) {
409 return reject(
410 new Error(JSON.stringify({ fetchTodoById: { id } }, null, 2)),
411 )
412 }
413 resolve(list.find((d) => d.id === id))
414 },
415 queryTimeMin + Math.random() * (queryTimeMax - queryTimeMin),
416 )
417 })
418}
419β
420function postTodo({ name, notes }: Omit<Todo, 'id'>) {
421 console.info('postTodo', { name, notes })
422 return new Promise((resolve, reject) => {
423 setTimeout(
424 () => {
425 if (Math.random() < errorRate) {
426 return reject(
427 new Error(JSON.stringify({ postTodo: { name, notes } }, null, 2)),
428 )
429 }
430 const todo = { name, notes, id: id++ }
431 list = [...list, todo]
432 resolve(todo)
433 },
434 queryTimeMin + Math.random() * (queryTimeMax - queryTimeMin),
435 )
436 })
437}
438β
439function patchTodo(todo?: Todo): Promise<Todo> {
440 console.info('patchTodo', todo)
441 return new Promise((resolve, reject) => {
442 setTimeout(
443 () => {
444 if (Math.random() < errorRate) {
445 return reject(new Error(JSON.stringify({ patchTodo: todo }, null, 2)))
446 }
447 list = list.map((d) => {
448 if (d.id === todo.id) {
449 return todo
450 }
451 return d
452 })
453 resolve(todo)
454 },
455 queryTimeMin + Math.random() * (queryTimeMax - queryTimeMin),
456 )
457 })
458}
459β
460const rootElement = document.getElementById('root') as HTMLElement
461ReactDOM.createRoot(rootElement).render(<Root />)