@tanstack/solid-query 4.35.0 → 4.35.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/build/umd/index.development.js +24 -14
  2. package/build/umd/index.development.js.map +1 -1
  3. package/build/umd/index.production.js +1 -1
  4. package/build/umd/index.production.js.map +1 -1
  5. package/package.json +2 -2
  6. package/build/lib/QueryClientProvider.d.ts.map +0 -1
  7. package/build/lib/__tests__/QueryClientProvider.test.d.ts.map +0 -1
  8. package/build/lib/__tests__/createInfiniteQuery.test.d.ts.map +0 -1
  9. package/build/lib/__tests__/createMutation.test.d.ts.map +0 -1
  10. package/build/lib/__tests__/createQueries.test.d.ts.map +0 -1
  11. package/build/lib/__tests__/createQuery.test.d.ts.map +0 -1
  12. package/build/lib/__tests__/createQuery.types.test.d.ts.map +0 -1
  13. package/build/lib/__tests__/suspense.test.d.ts.map +0 -1
  14. package/build/lib/__tests__/transition.test.d.ts.map +0 -1
  15. package/build/lib/__tests__/useIsFetching.test.d.ts.map +0 -1
  16. package/build/lib/__tests__/useIsMutating.test.d.ts.map +0 -1
  17. package/build/lib/__tests__/utils.d.ts.map +0 -1
  18. package/build/lib/createBaseQuery.d.ts.map +0 -1
  19. package/build/lib/createInfiniteQuery.d.ts.map +0 -1
  20. package/build/lib/createMutation.d.ts.map +0 -1
  21. package/build/lib/createQueries.d.ts.map +0 -1
  22. package/build/lib/createQuery.d.ts.map +0 -1
  23. package/build/lib/index.d.ts.map +0 -1
  24. package/build/lib/types.d.ts.map +0 -1
  25. package/build/lib/useIsFetching.d.ts.map +0 -1
  26. package/build/lib/useIsMutating.d.ts.map +0 -1
  27. package/build/lib/utils.d.ts.map +0 -1
  28. package/build/solid/QueryClientProvider.jsx +0 -49
  29. package/build/solid/__tests__/QueryClientProvider.test.jsx +0 -185
  30. package/build/solid/__tests__/createInfiniteQuery.test.jsx +0 -1458
  31. package/build/solid/__tests__/createMutation.test.jsx +0 -857
  32. package/build/solid/__tests__/createQueries.test.jsx +0 -958
  33. package/build/solid/__tests__/createQuery.test.jsx +0 -4559
  34. package/build/solid/__tests__/createQuery.types.test.jsx +0 -124
  35. package/build/solid/__tests__/suspense.test.jsx +0 -691
  36. package/build/solid/__tests__/transition.test.jsx +0 -39
  37. package/build/solid/__tests__/useIsFetching.test.jsx +0 -209
  38. package/build/solid/__tests__/useIsMutating.test.jsx +0 -216
  39. package/build/solid/__tests__/utils.jsx +0 -55
  40. package/build/solid/createBaseQuery.js +0 -81
  41. package/build/solid/createInfiniteQuery.js +0 -16
  42. package/build/solid/createMutation.js +0 -40
  43. package/build/solid/createQueries.js +0 -39
  44. package/build/solid/createQuery.js +0 -16
  45. package/build/solid/index.js +0 -12
  46. package/build/solid/types.js +0 -2
  47. package/build/solid/useIsFetching.js +0 -23
  48. package/build/solid/useIsMutating.js +0 -16
  49. package/build/solid/utils.js +0 -45
@@ -1,1458 +0,0 @@
1
- import { fireEvent, render, screen, waitFor } from 'solid-testing-library';
2
- import { For, Index, Match, Switch, createEffect, createRenderEffect, createSignal, } from 'solid-js';
3
- import { QueryCache, QueryClientProvider, createInfiniteQuery } from '..';
4
- import { createQueryClient, sleep } from './utils';
5
- import { Blink, queryKey, setActTimeout } from './utils';
6
- const pageSize = 10;
7
- const fetchItems = async (page, ts, noNext, noPrev) => {
8
- await sleep(10);
9
- return {
10
- items: [...new Array(10)].fill(null).map((_, d) => page * pageSize + d),
11
- nextId: noNext ? undefined : page + 1,
12
- prevId: noPrev ? undefined : page - 1,
13
- ts,
14
- };
15
- };
16
- describe('useInfiniteQuery', () => {
17
- const queryCache = new QueryCache();
18
- const queryClient = createQueryClient({ queryCache });
19
- it('should return the correct states for a successful query', async () => {
20
- const key = queryKey();
21
- const states = [];
22
- function Page() {
23
- const state = createInfiniteQuery(key, ({ pageParam = 0 }) => Number(pageParam), {
24
- getNextPageParam: (lastPage) => lastPage + 1,
25
- });
26
- createRenderEffect(() => {
27
- states.push({ ...state });
28
- });
29
- return null;
30
- }
31
- render(() => (<QueryClientProvider client={queryClient}>
32
- <Page />
33
- </QueryClientProvider>));
34
- await sleep(100);
35
- expect(states.length).toBe(2);
36
- expect(states[0]).toEqual({
37
- data: undefined,
38
- dataUpdatedAt: 0,
39
- error: null,
40
- errorUpdatedAt: 0,
41
- failureCount: 0,
42
- failureReason: null,
43
- errorUpdateCount: 0,
44
- fetchNextPage: expect.any(Function),
45
- fetchPreviousPage: expect.any(Function),
46
- hasNextPage: undefined,
47
- hasPreviousPage: undefined,
48
- isError: false,
49
- isFetched: false,
50
- isFetchedAfterMount: false,
51
- isFetching: true,
52
- isPaused: false,
53
- isFetchingNextPage: false,
54
- isFetchingPreviousPage: false,
55
- isLoading: true,
56
- isInitialLoading: true,
57
- isLoadingError: false,
58
- isPlaceholderData: false,
59
- isPreviousData: false,
60
- isRefetchError: false,
61
- isRefetching: false,
62
- isStale: true,
63
- isSuccess: false,
64
- refetch: expect.any(Function),
65
- remove: expect.any(Function),
66
- status: 'loading',
67
- fetchStatus: 'fetching',
68
- });
69
- expect(states[1]).toEqual({
70
- data: { pages: [0], pageParams: [undefined] },
71
- dataUpdatedAt: expect.any(Number),
72
- error: null,
73
- errorUpdatedAt: 0,
74
- failureCount: 0,
75
- failureReason: null,
76
- errorUpdateCount: 0,
77
- fetchNextPage: expect.any(Function),
78
- fetchPreviousPage: expect.any(Function),
79
- hasNextPage: true,
80
- hasPreviousPage: undefined,
81
- isError: false,
82
- isFetched: true,
83
- isFetchedAfterMount: true,
84
- isFetching: false,
85
- isPaused: false,
86
- isFetchingNextPage: false,
87
- isFetchingPreviousPage: false,
88
- isLoading: false,
89
- isInitialLoading: false,
90
- isLoadingError: false,
91
- isPlaceholderData: false,
92
- isPreviousData: false,
93
- isRefetchError: false,
94
- isRefetching: false,
95
- isStale: true,
96
- isSuccess: true,
97
- refetch: expect.any(Function),
98
- remove: expect.any(Function),
99
- status: 'success',
100
- fetchStatus: 'idle',
101
- });
102
- });
103
- it('should not throw when fetchNextPage returns an error', async () => {
104
- const key = queryKey();
105
- let noThrow;
106
- function Page() {
107
- const start = 1;
108
- const state = createInfiniteQuery(key, async ({ pageParam = start }) => {
109
- if (pageParam === 2) {
110
- throw new Error('error');
111
- }
112
- return Number(pageParam);
113
- }, {
114
- retry: 1,
115
- retryDelay: 10,
116
- getNextPageParam: (lastPage) => lastPage + 1,
117
- });
118
- createEffect(() => {
119
- const fetchNextPage = state.fetchNextPage;
120
- setActTimeout(() => {
121
- fetchNextPage()
122
- .then(() => {
123
- noThrow = true;
124
- })
125
- .catch(() => undefined);
126
- }, 20);
127
- });
128
- return null;
129
- }
130
- render(() => (<QueryClientProvider client={queryClient}>
131
- <Page />
132
- </QueryClientProvider>));
133
- await waitFor(() => expect(noThrow).toBe(true));
134
- });
135
- it('should keep the previous data when keepPreviousData is set', async () => {
136
- const key = queryKey();
137
- const states = [];
138
- function Page() {
139
- const [order, setOrder] = createSignal('desc');
140
- const state = createInfiniteQuery(() => [key(), order()], async ({ pageParam = 0 }) => {
141
- await sleep(10);
142
- return `${pageParam}-${order()}`;
143
- }, {
144
- getNextPageParam: () => 1,
145
- keepPreviousData: true,
146
- notifyOnChangeProps: 'all',
147
- });
148
- createRenderEffect(() => {
149
- states.push({ ...state });
150
- });
151
- return (<div>
152
- <button onClick={() => state.fetchNextPage()}>fetchNextPage</button>
153
- <button onClick={() => setOrder('asc')}>order</button>
154
- <div>data: {state.data?.pages.join(',') ?? 'null'}</div>
155
- <div>isFetching: {String(state.isFetching)}</div>
156
- </div>);
157
- }
158
- render(() => (<QueryClientProvider client={queryClient}>
159
- <Page />
160
- </QueryClientProvider>));
161
- await waitFor(() => screen.getByText('data: 0-desc'));
162
- fireEvent.click(screen.getByRole('button', { name: /fetchNextPage/i }));
163
- await waitFor(() => screen.getByText('data: 0-desc,1-desc'));
164
- fireEvent.click(screen.getByRole('button', { name: /order/i }));
165
- await waitFor(() => screen.getByText('data: 0-asc'));
166
- await waitFor(() => screen.getByText('isFetching: false'));
167
- await waitFor(() => expect(states.length).toBe(6));
168
- expect(states[0]).toMatchObject({
169
- data: undefined,
170
- isFetching: true,
171
- isFetchingNextPage: false,
172
- isSuccess: false,
173
- isPreviousData: false,
174
- });
175
- expect(states[1]).toMatchObject({
176
- data: { pages: ['0-desc'] },
177
- isFetching: false,
178
- isFetchingNextPage: false,
179
- isSuccess: true,
180
- isPreviousData: false,
181
- });
182
- expect(states[2]).toMatchObject({
183
- data: { pages: ['0-desc'] },
184
- isFetching: true,
185
- isFetchingNextPage: true,
186
- isSuccess: true,
187
- isPreviousData: false,
188
- });
189
- expect(states[3]).toMatchObject({
190
- data: { pages: ['0-desc', '1-desc'] },
191
- isFetching: false,
192
- isFetchingNextPage: false,
193
- isSuccess: true,
194
- isPreviousData: false,
195
- });
196
- // Set state
197
- expect(states[4]).toMatchObject({
198
- data: { pages: ['0-desc', '1-desc'] },
199
- isFetching: true,
200
- isFetchingNextPage: false,
201
- isSuccess: true,
202
- isPreviousData: true,
203
- });
204
- expect(states[5]).toMatchObject({
205
- data: { pages: ['0-asc'] },
206
- isFetching: false,
207
- isFetchingNextPage: false,
208
- isSuccess: true,
209
- isPreviousData: false,
210
- });
211
- });
212
- it('should be able to select a part of the data', async () => {
213
- const key = queryKey();
214
- const states = [];
215
- function Page() {
216
- const state = createInfiniteQuery(key, () => ({ count: 1 }), {
217
- select: (data) => ({
218
- pages: data.pages.map((x) => `count: ${x.count}`),
219
- pageParams: data.pageParams,
220
- }),
221
- });
222
- createRenderEffect(() => {
223
- states.push({ ...state });
224
- });
225
- return null;
226
- }
227
- render(() => (<QueryClientProvider client={queryClient}>
228
- <Page />
229
- </QueryClientProvider>));
230
- await sleep(10);
231
- expect(states.length).toBe(2);
232
- expect(states[0]).toMatchObject({
233
- data: undefined,
234
- isSuccess: false,
235
- });
236
- expect(states[1]).toMatchObject({
237
- data: { pages: ['count: 1'] },
238
- isSuccess: true,
239
- });
240
- });
241
- it('should be able to select a new result and not cause infinite renders', async () => {
242
- const key = queryKey();
243
- const states = [];
244
- let selectCalled = 0;
245
- function Page() {
246
- const state = createInfiniteQuery(key, () => ({ count: 1 }), {
247
- select: (data) => {
248
- selectCalled++;
249
- return {
250
- pages: data.pages.map((x) => ({ ...x, id: Math.random() })),
251
- pageParams: data.pageParams,
252
- };
253
- },
254
- });
255
- createRenderEffect(() => {
256
- states.push({ ...state });
257
- });
258
- return null;
259
- }
260
- render(() => (<QueryClientProvider client={queryClient}>
261
- <Page />
262
- </QueryClientProvider>));
263
- await sleep(20);
264
- expect(states.length).toBe(2);
265
- expect(selectCalled).toBe(1);
266
- expect(states[0]).toMatchObject({
267
- data: undefined,
268
- isSuccess: false,
269
- });
270
- expect(states[1]).toMatchObject({
271
- data: { pages: [{ count: 1 }] },
272
- isSuccess: true,
273
- });
274
- });
275
- it('should be able to reverse the data', async () => {
276
- const key = queryKey();
277
- const states = [];
278
- function Page() {
279
- const state = createInfiniteQuery(key, async ({ pageParam = 0 }) => {
280
- await sleep(10);
281
- return Number(pageParam);
282
- }, {
283
- select: (data) => ({
284
- pages: [...data.pages].reverse(),
285
- pageParams: [...data.pageParams].reverse(),
286
- }),
287
- notifyOnChangeProps: 'all',
288
- });
289
- createRenderEffect(() => {
290
- states.push({ ...state });
291
- });
292
- return (<div>
293
- <button onClick={() => state.fetchNextPage({ pageParam: 1 })}>
294
- fetchNextPage
295
- </button>
296
- <div>data: {state.data?.pages.join(',') ?? 'null'}</div>
297
- <div>isFetching: {state.isFetching}</div>
298
- </div>);
299
- }
300
- render(() => (<QueryClientProvider client={queryClient}>
301
- <Page />
302
- </QueryClientProvider>));
303
- await waitFor(() => screen.getByText('data: 0'));
304
- fireEvent.click(screen.getByRole('button', { name: /fetchNextPage/i }));
305
- await waitFor(() => screen.getByText('data: 1,0'));
306
- await waitFor(() => expect(states.length).toBe(4));
307
- expect(states[0]).toMatchObject({
308
- data: undefined,
309
- isSuccess: false,
310
- });
311
- expect(states[1]).toMatchObject({
312
- data: { pages: [0] },
313
- isSuccess: true,
314
- });
315
- expect(states[2]).toMatchObject({
316
- data: { pages: [0] },
317
- isSuccess: true,
318
- });
319
- expect(states[3]).toMatchObject({
320
- data: { pages: [1, 0] },
321
- isSuccess: true,
322
- });
323
- });
324
- it('should be able to fetch a previous page', async () => {
325
- const key = queryKey();
326
- const states = [];
327
- function Page() {
328
- const start = 10;
329
- const state = createInfiniteQuery(key, async ({ pageParam = start }) => {
330
- await sleep(10);
331
- return Number(pageParam);
332
- }, {
333
- getPreviousPageParam: (firstPage) => firstPage - 1,
334
- notifyOnChangeProps: 'all',
335
- });
336
- createRenderEffect(() => {
337
- states.push({ ...state });
338
- });
339
- createEffect(() => {
340
- const fetchPreviousPage = state.fetchPreviousPage;
341
- setActTimeout(() => {
342
- fetchPreviousPage();
343
- }, 20);
344
- });
345
- return null;
346
- }
347
- render(() => (<QueryClientProvider client={queryClient}>
348
- <Page />
349
- </QueryClientProvider>));
350
- await sleep(100);
351
- expect(states.length).toBe(4);
352
- expect(states[0]).toMatchObject({
353
- data: undefined,
354
- hasNextPage: undefined,
355
- hasPreviousPage: undefined,
356
- isFetching: true,
357
- isFetchingNextPage: false,
358
- isFetchingPreviousPage: false,
359
- isSuccess: false,
360
- });
361
- expect(states[1]).toMatchObject({
362
- data: { pages: [10] },
363
- hasNextPage: undefined,
364
- hasPreviousPage: true,
365
- isFetching: false,
366
- isFetchingNextPage: false,
367
- isFetchingPreviousPage: false,
368
- isSuccess: true,
369
- });
370
- expect(states[2]).toMatchObject({
371
- data: { pages: [10] },
372
- hasNextPage: undefined,
373
- hasPreviousPage: true,
374
- isFetching: true,
375
- isFetchingNextPage: false,
376
- isFetchingPreviousPage: true,
377
- isSuccess: true,
378
- });
379
- expect(states[3]).toMatchObject({
380
- data: { pages: [9, 10] },
381
- hasNextPage: undefined,
382
- hasPreviousPage: true,
383
- isFetching: false,
384
- isFetchingNextPage: false,
385
- isFetchingPreviousPage: false,
386
- isSuccess: true,
387
- });
388
- });
389
- it('should be able to refetch when providing page params manually', async () => {
390
- const key = queryKey();
391
- const states = [];
392
- function Page() {
393
- const state = createInfiniteQuery(key, async ({ pageParam = 10 }) => {
394
- await sleep(10);
395
- return Number(pageParam);
396
- });
397
- createRenderEffect(() => {
398
- states.push({ ...state });
399
- });
400
- return (<div>
401
- <button onClick={() => state.fetchNextPage({ pageParam: 11 })}>
402
- fetchNextPage
403
- </button>
404
- <button onClick={() => state.fetchPreviousPage({ pageParam: 9 })}>
405
- fetchPreviousPage
406
- </button>
407
- <button onClick={() => state.refetch()}>refetch</button>
408
- <div>data: {state.data?.pages.join(',') ?? 'null'}</div>
409
- <div>isFetching: {String(state.isFetching)}</div>
410
- </div>);
411
- }
412
- render(() => (<QueryClientProvider client={queryClient}>
413
- <Page />
414
- </QueryClientProvider>));
415
- await waitFor(() => screen.getByText('data: 10'));
416
- fireEvent.click(screen.getByRole('button', { name: /fetchNextPage/i }));
417
- await waitFor(() => screen.getByText('data: 10,11'));
418
- fireEvent.click(screen.getByRole('button', { name: /fetchPreviousPage/i }));
419
- await waitFor(() => screen.getByText('data: 9,10,11'));
420
- fireEvent.click(screen.getByRole('button', { name: /refetch/i }));
421
- await waitFor(() => screen.getByText('isFetching: false'));
422
- await waitFor(() => expect(states.length).toBe(8));
423
- // Initial fetch
424
- expect(states[0]).toMatchObject({
425
- data: undefined,
426
- isFetching: true,
427
- isFetchingNextPage: false,
428
- isRefetching: false,
429
- });
430
- // Initial fetch done
431
- expect(states[1]).toMatchObject({
432
- data: { pages: [10] },
433
- isFetching: false,
434
- isFetchingNextPage: false,
435
- isRefetching: false,
436
- });
437
- // Fetch next page
438
- expect(states[2]).toMatchObject({
439
- data: { pages: [10] },
440
- isFetching: true,
441
- isFetchingNextPage: true,
442
- isRefetching: false,
443
- });
444
- // Fetch next page done
445
- expect(states[3]).toMatchObject({
446
- data: { pages: [10, 11] },
447
- isFetching: false,
448
- isFetchingNextPage: false,
449
- isRefetching: false,
450
- });
451
- // Fetch previous page
452
- expect(states[4]).toMatchObject({
453
- data: { pages: [10, 11] },
454
- isFetching: true,
455
- isFetchingNextPage: false,
456
- isFetchingPreviousPage: true,
457
- isRefetching: false,
458
- });
459
- // Fetch previous page done
460
- expect(states[5]).toMatchObject({
461
- data: { pages: [9, 10, 11] },
462
- isFetching: false,
463
- isFetchingNextPage: false,
464
- isFetchingPreviousPage: false,
465
- isRefetching: false,
466
- });
467
- // Refetch
468
- expect(states[6]).toMatchObject({
469
- data: { pages: [9, 10, 11] },
470
- isFetching: true,
471
- isFetchingNextPage: false,
472
- isFetchingPreviousPage: false,
473
- isRefetching: true,
474
- });
475
- // Refetch done
476
- expect(states[7]).toMatchObject({
477
- data: { pages: [9, 10, 11] },
478
- isFetching: false,
479
- isFetchingNextPage: false,
480
- isFetchingPreviousPage: false,
481
- isRefetching: false,
482
- });
483
- });
484
- it('should be able to refetch when providing page params automatically', async () => {
485
- const key = queryKey();
486
- const states = [];
487
- function Page() {
488
- const state = createInfiniteQuery(key, async ({ pageParam = 10 }) => {
489
- await sleep(10);
490
- return Number(pageParam);
491
- }, {
492
- getPreviousPageParam: (firstPage) => firstPage - 1,
493
- getNextPageParam: (lastPage) => lastPage + 1,
494
- notifyOnChangeProps: 'all',
495
- });
496
- createRenderEffect(() => {
497
- states.push({ ...state });
498
- });
499
- return (<div>
500
- <button onClick={() => state.fetchNextPage()}>fetchNextPage</button>
501
- <button onClick={() => state.fetchPreviousPage()}>
502
- fetchPreviousPage
503
- </button>
504
- <button onClick={() => state.refetch()}>refetch</button>
505
- <div>data: {state.data?.pages.join(',') ?? 'null'}</div>
506
- <div>isFetching: {String(state.isFetching)}</div>
507
- </div>);
508
- }
509
- render(() => (<QueryClientProvider client={queryClient}>
510
- <Page />
511
- </QueryClientProvider>));
512
- await waitFor(() => screen.getByText('data: 10'));
513
- fireEvent.click(screen.getByRole('button', { name: /fetchNextPage/i }));
514
- await waitFor(() => screen.getByText('data: 10,11'));
515
- fireEvent.click(screen.getByRole('button', { name: /fetchPreviousPage/i }));
516
- await waitFor(() => screen.getByText('data: 9,10,11'));
517
- fireEvent.click(screen.getByRole('button', { name: /refetch/i }));
518
- await waitFor(() => screen.getByText('isFetching: false'));
519
- await waitFor(() => expect(states.length).toBe(8));
520
- // Initial fetch
521
- expect(states[0]).toMatchObject({
522
- data: undefined,
523
- isFetching: true,
524
- isFetchingNextPage: false,
525
- isRefetching: false,
526
- });
527
- // Initial fetch done
528
- expect(states[1]).toMatchObject({
529
- data: { pages: [10] },
530
- isFetching: false,
531
- isFetchingNextPage: false,
532
- isRefetching: false,
533
- });
534
- // Fetch next page
535
- expect(states[2]).toMatchObject({
536
- data: { pages: [10] },
537
- isFetching: true,
538
- isFetchingNextPage: true,
539
- isRefetching: false,
540
- });
541
- // Fetch next page done
542
- expect(states[3]).toMatchObject({
543
- data: { pages: [10, 11] },
544
- isFetching: false,
545
- isFetchingNextPage: false,
546
- isRefetching: false,
547
- });
548
- // Fetch previous page
549
- expect(states[4]).toMatchObject({
550
- data: { pages: [10, 11] },
551
- isFetching: true,
552
- isFetchingNextPage: false,
553
- isFetchingPreviousPage: true,
554
- isRefetching: false,
555
- });
556
- // Fetch previous page done
557
- expect(states[5]).toMatchObject({
558
- data: { pages: [9, 10, 11] },
559
- isFetching: false,
560
- isFetchingNextPage: false,
561
- isFetchingPreviousPage: false,
562
- isRefetching: false,
563
- });
564
- // Refetch
565
- expect(states[6]).toMatchObject({
566
- data: { pages: [9, 10, 11] },
567
- isFetching: true,
568
- isFetchingNextPage: false,
569
- isFetchingPreviousPage: false,
570
- isRefetching: true,
571
- });
572
- // Refetch done
573
- expect(states[7]).toMatchObject({
574
- data: { pages: [9, 10, 11] },
575
- isFetching: false,
576
- isFetchingNextPage: false,
577
- isFetchingPreviousPage: false,
578
- isRefetching: false,
579
- });
580
- });
581
- it('should be able to refetch only specific pages when refetchPages is provided', async () => {
582
- const key = queryKey();
583
- const states = [];
584
- function Page() {
585
- let multiplier = 1;
586
- const state = createInfiniteQuery(key, async ({ pageParam = 10 }) => {
587
- await sleep(10);
588
- return Number(pageParam) * multiplier;
589
- }, {
590
- getNextPageParam: (lastPage) => lastPage + 1,
591
- notifyOnChangeProps: 'all',
592
- });
593
- createRenderEffect(() => {
594
- states.push({ ...state });
595
- });
596
- return (<div>
597
- <button onClick={() => state.fetchNextPage()}>fetchNextPage</button>
598
- <button onClick={() => {
599
- multiplier = 2;
600
- state.refetch({
601
- refetchPage: (_, index) => index === 0,
602
- });
603
- }}>
604
- refetchPage
605
- </button>
606
- <div>data: {state.data?.pages.join(',') ?? 'null'}</div>
607
- <div>isFetching: {String(state.isFetching)}</div>
608
- </div>);
609
- }
610
- render(() => (<QueryClientProvider client={queryClient}>
611
- <Page />
612
- </QueryClientProvider>));
613
- await waitFor(() => screen.getByText('data: 10'));
614
- fireEvent.click(screen.getByRole('button', { name: /fetchNextPage/i }));
615
- await waitFor(() => screen.getByText('data: 10,11'));
616
- fireEvent.click(screen.getByRole('button', { name: /refetchPage/i }));
617
- await waitFor(() => screen.getByText('data: 20,11'));
618
- await waitFor(() => screen.getByText('isFetching: false'));
619
- await waitFor(() => expect(states.length).toBe(6));
620
- // Initial fetch
621
- expect(states[0]).toMatchObject({
622
- data: undefined,
623
- isFetching: true,
624
- isFetchingNextPage: false,
625
- });
626
- // Initial fetch done
627
- expect(states[1]).toMatchObject({
628
- data: { pages: [10] },
629
- isFetching: false,
630
- isFetchingNextPage: false,
631
- });
632
- // Fetch next page
633
- expect(states[2]).toMatchObject({
634
- data: { pages: [10] },
635
- isFetching: true,
636
- isFetchingNextPage: true,
637
- });
638
- // Fetch next page done
639
- expect(states[3]).toMatchObject({
640
- data: { pages: [10, 11] },
641
- isFetching: false,
642
- isFetchingNextPage: false,
643
- });
644
- // Refetch
645
- expect(states[4]).toMatchObject({
646
- data: { pages: [10, 11] },
647
- isFetching: true,
648
- isFetchingNextPage: false,
649
- });
650
- // Refetch done, only page one has been refetched and multiplied
651
- expect(states[5]).toMatchObject({
652
- data: { pages: [20, 11] },
653
- isFetching: false,
654
- isFetchingNextPage: false,
655
- });
656
- });
657
- it('should silently cancel any ongoing fetch when fetching more', async () => {
658
- const key = queryKey();
659
- const states = [];
660
- function Page() {
661
- const start = 10;
662
- const state = createInfiniteQuery(key, async ({ pageParam = start }) => {
663
- await sleep(50);
664
- return Number(pageParam);
665
- }, {
666
- getNextPageParam: (lastPage) => lastPage + 1,
667
- notifyOnChangeProps: 'all',
668
- });
669
- createRenderEffect(() => {
670
- states.push({ ...state });
671
- });
672
- createEffect(() => {
673
- const { refetch, fetchNextPage } = state;
674
- setActTimeout(() => {
675
- refetch();
676
- }, 100);
677
- setActTimeout(() => {
678
- fetchNextPage();
679
- }, 110);
680
- });
681
- return null;
682
- }
683
- render(() => (<QueryClientProvider client={queryClient}>
684
- <Page />
685
- </QueryClientProvider>));
686
- await sleep(300);
687
- expect(states.length).toBe(5);
688
- expect(states[0]).toMatchObject({
689
- hasNextPage: undefined,
690
- data: undefined,
691
- isFetching: true,
692
- isFetchingNextPage: false,
693
- isSuccess: false,
694
- });
695
- expect(states[1]).toMatchObject({
696
- hasNextPage: true,
697
- data: { pages: [10] },
698
- isFetching: false,
699
- isFetchingNextPage: false,
700
- isSuccess: true,
701
- });
702
- expect(states[2]).toMatchObject({
703
- hasNextPage: true,
704
- data: { pages: [10] },
705
- isFetching: true,
706
- isFetchingNextPage: false,
707
- isSuccess: true,
708
- });
709
- expect(states[3]).toMatchObject({
710
- hasNextPage: true,
711
- data: { pages: [10] },
712
- isFetching: true,
713
- isFetchingNextPage: true,
714
- isSuccess: true,
715
- });
716
- expect(states[4]).toMatchObject({
717
- hasNextPage: true,
718
- data: { pages: [10, 11] },
719
- isFetching: false,
720
- isFetchingNextPage: false,
721
- isSuccess: true,
722
- });
723
- });
724
- it('should silently cancel an ongoing fetchNextPage request when another fetchNextPage is invoked', async () => {
725
- const key = queryKey();
726
- const start = 10;
727
- const onAborts = [];
728
- const abortListeners = [];
729
- const fetchPage = jest.fn(async ({ pageParam = start, signal }) => {
730
- if (signal) {
731
- const onAbort = jest.fn();
732
- const abortListener = jest.fn();
733
- onAborts.push(onAbort);
734
- abortListeners.push(abortListener);
735
- signal.onabort = onAbort;
736
- signal.addEventListener('abort', abortListener);
737
- }
738
- await sleep(50);
739
- return Number(pageParam);
740
- });
741
- function Page() {
742
- const state = createInfiniteQuery(key, fetchPage, {
743
- getNextPageParam: (lastPage) => lastPage + 1,
744
- });
745
- createEffect(() => {
746
- const { fetchNextPage } = state;
747
- setActTimeout(() => {
748
- fetchNextPage();
749
- }, 100);
750
- setActTimeout(() => {
751
- fetchNextPage();
752
- }, 110);
753
- });
754
- return null;
755
- }
756
- render(() => (<QueryClientProvider client={queryClient}>
757
- <Page />
758
- </QueryClientProvider>));
759
- await sleep(300);
760
- const expectedCallCount = 3;
761
- expect(fetchPage).toBeCalledTimes(expectedCallCount);
762
- expect(onAborts).toHaveLength(expectedCallCount);
763
- expect(abortListeners).toHaveLength(expectedCallCount);
764
- let callIndex = 0;
765
- const firstCtx = fetchPage.mock.calls[callIndex][0];
766
- expect(firstCtx.pageParam).toBeUndefined();
767
- expect(firstCtx.queryKey).toEqual(key());
768
- expect(firstCtx.signal).toBeInstanceOf(AbortSignal);
769
- expect(firstCtx.signal?.aborted).toBe(false);
770
- expect(onAborts[callIndex]).not.toHaveBeenCalled();
771
- expect(abortListeners[callIndex]).not.toHaveBeenCalled();
772
- callIndex = 1;
773
- const secondCtx = fetchPage.mock.calls[callIndex][0];
774
- expect(secondCtx.pageParam).toBe(11);
775
- expect(secondCtx.queryKey).toEqual(key());
776
- expect(secondCtx.signal).toBeInstanceOf(AbortSignal);
777
- expect(secondCtx.signal?.aborted).toBe(true);
778
- expect(onAborts[callIndex]).toHaveBeenCalledTimes(1);
779
- expect(abortListeners[callIndex]).toHaveBeenCalledTimes(1);
780
- callIndex = 2;
781
- const thirdCtx = fetchPage.mock.calls[callIndex][0];
782
- expect(thirdCtx.pageParam).toBe(11);
783
- expect(thirdCtx.queryKey).toEqual(key());
784
- expect(thirdCtx.signal).toBeInstanceOf(AbortSignal);
785
- expect(thirdCtx.signal?.aborted).toBe(false);
786
- expect(onAborts[callIndex]).not.toHaveBeenCalled();
787
- expect(abortListeners[callIndex]).not.toHaveBeenCalled();
788
- });
789
- it('should not cancel an ongoing fetchNextPage request when another fetchNextPage is invoked if `cancelRefetch: false` is used ', async () => {
790
- const key = queryKey();
791
- const start = 10;
792
- const onAborts = [];
793
- const abortListeners = [];
794
- const fetchPage = jest.fn(async ({ pageParam = start, signal }) => {
795
- if (signal) {
796
- const onAbort = jest.fn();
797
- const abortListener = jest.fn();
798
- onAborts.push(onAbort);
799
- abortListeners.push(abortListener);
800
- signal.onabort = onAbort;
801
- signal.addEventListener('abort', abortListener);
802
- }
803
- await sleep(50);
804
- return Number(pageParam);
805
- });
806
- function Page() {
807
- const state = createInfiniteQuery(key, fetchPage, {
808
- getNextPageParam: (lastPage) => lastPage + 1,
809
- });
810
- createEffect(() => {
811
- const { fetchNextPage } = state;
812
- setActTimeout(() => {
813
- fetchNextPage();
814
- }, 100);
815
- setActTimeout(() => {
816
- fetchNextPage({ cancelRefetch: false });
817
- }, 110);
818
- });
819
- return null;
820
- }
821
- render(() => (<QueryClientProvider client={queryClient}>
822
- <Page />
823
- </QueryClientProvider>));
824
- await sleep(300);
825
- const expectedCallCount = 2;
826
- expect(fetchPage).toBeCalledTimes(expectedCallCount);
827
- expect(onAborts).toHaveLength(expectedCallCount);
828
- expect(abortListeners).toHaveLength(expectedCallCount);
829
- let callIndex = 0;
830
- const firstCtx = fetchPage.mock.calls[callIndex][0];
831
- expect(firstCtx.pageParam).toBeUndefined();
832
- expect(firstCtx.queryKey).toEqual(key());
833
- expect(firstCtx.signal).toBeInstanceOf(AbortSignal);
834
- expect(firstCtx.signal?.aborted).toBe(false);
835
- expect(onAborts[callIndex]).not.toHaveBeenCalled();
836
- expect(abortListeners[callIndex]).not.toHaveBeenCalled();
837
- callIndex = 1;
838
- const secondCtx = fetchPage.mock.calls[callIndex][0];
839
- expect(secondCtx.pageParam).toBe(11);
840
- expect(secondCtx.queryKey).toEqual(key());
841
- expect(secondCtx.signal).toBeInstanceOf(AbortSignal);
842
- expect(secondCtx.signal?.aborted).toBe(false);
843
- expect(onAborts[callIndex]).not.toHaveBeenCalled();
844
- expect(abortListeners[callIndex]).not.toHaveBeenCalled();
845
- });
846
- it('should keep fetching first page when not loaded yet and triggering fetch more', async () => {
847
- const key = queryKey();
848
- const states = [];
849
- function Page() {
850
- const start = 10;
851
- const state = createInfiniteQuery(key, async ({ pageParam = start }) => {
852
- await sleep(50);
853
- return Number(pageParam);
854
- }, {
855
- getNextPageParam: (lastPage) => lastPage + 1,
856
- notifyOnChangeProps: 'all',
857
- });
858
- createRenderEffect(() => {
859
- states.push({ ...state });
860
- });
861
- createEffect(() => {
862
- const { fetchNextPage } = state;
863
- setActTimeout(() => {
864
- fetchNextPage();
865
- }, 10);
866
- });
867
- return null;
868
- }
869
- render(() => (<QueryClientProvider client={queryClient}>
870
- <Page />
871
- </QueryClientProvider>));
872
- await sleep(100);
873
- expect(states.length).toBe(2);
874
- expect(states[0]).toMatchObject({
875
- hasNextPage: undefined,
876
- data: undefined,
877
- isFetching: true,
878
- isFetchingNextPage: false,
879
- isSuccess: false,
880
- });
881
- expect(states[1]).toMatchObject({
882
- hasNextPage: true,
883
- data: { pages: [10] },
884
- isFetching: false,
885
- isFetchingNextPage: false,
886
- isSuccess: true,
887
- });
888
- });
889
- it('should stop fetching additional pages when the component is unmounted and AbortSignal is consumed', async () => {
890
- const key = queryKey();
891
- let fetches = 0;
892
- const initialData = { pages: [1, 2, 3, 4], pageParams: [0, 1, 2, 3] };
893
- function List() {
894
- createInfiniteQuery(key, async ({ pageParam = 0, signal: _ }) => {
895
- fetches++;
896
- await sleep(50);
897
- return Number(pageParam) * 10;
898
- }, {
899
- initialData,
900
- getNextPageParam: (_, allPages) => {
901
- return allPages.length === 4 ? undefined : allPages.length;
902
- },
903
- });
904
- return null;
905
- }
906
- function Page() {
907
- const [show, setShow] = createSignal(true);
908
- createEffect(() => {
909
- setActTimeout(() => {
910
- setShow(false);
911
- }, 75);
912
- });
913
- return <>{show() ? <List /> : null}</>;
914
- }
915
- render(() => (<QueryClientProvider client={queryClient}>
916
- <Page />
917
- </QueryClientProvider>));
918
- await sleep(300);
919
- expect(fetches).toBe(2);
920
- expect(queryClient.getQueryState(key())).toMatchObject({
921
- data: initialData,
922
- status: 'success',
923
- error: null,
924
- });
925
- });
926
- it('should be able to override the cursor in the fetchNextPage callback', async () => {
927
- const key = queryKey();
928
- const states = [];
929
- function Page() {
930
- const state = createInfiniteQuery(key, async ({ pageParam = 0 }) => {
931
- await sleep(10);
932
- return Number(pageParam);
933
- }, {
934
- getNextPageParam: (lastPage) => lastPage + 1,
935
- notifyOnChangeProps: 'all',
936
- });
937
- createRenderEffect(() => {
938
- states.push({ ...state });
939
- });
940
- createEffect(() => {
941
- const { fetchNextPage } = state;
942
- setActTimeout(() => {
943
- fetchNextPage({ pageParam: 5 });
944
- }, 20);
945
- });
946
- return null;
947
- }
948
- render(() => (<QueryClientProvider client={queryClient}>
949
- <Page />
950
- </QueryClientProvider>));
951
- await sleep(100);
952
- expect(states.length).toBe(4);
953
- expect(states[0]).toMatchObject({
954
- hasNextPage: undefined,
955
- data: undefined,
956
- isFetching: true,
957
- isFetchingNextPage: false,
958
- isSuccess: false,
959
- });
960
- expect(states[1]).toMatchObject({
961
- hasNextPage: true,
962
- data: { pages: [0] },
963
- isFetching: false,
964
- isFetchingNextPage: false,
965
- isSuccess: true,
966
- });
967
- expect(states[2]).toMatchObject({
968
- hasNextPage: true,
969
- data: { pages: [0] },
970
- isFetching: true,
971
- isFetchingNextPage: true,
972
- isSuccess: true,
973
- });
974
- expect(states[3]).toMatchObject({
975
- hasNextPage: true,
976
- data: { pages: [0, 5] },
977
- isFetching: false,
978
- isFetchingNextPage: false,
979
- isSuccess: true,
980
- });
981
- });
982
- it('should be able to set new pages with the query client', async () => {
983
- const key = queryKey();
984
- const states = [];
985
- function Page() {
986
- const [firstPage, setFirstPage] = createSignal(0);
987
- const state = createInfiniteQuery(key, async ({ pageParam = firstPage() }) => {
988
- await sleep(10);
989
- return Number(pageParam);
990
- }, {
991
- getNextPageParam: (lastPage) => lastPage + 1,
992
- notifyOnChangeProps: 'all',
993
- });
994
- createRenderEffect(() => {
995
- states.push({ ...state });
996
- });
997
- createEffect(() => {
998
- const { refetch } = state;
999
- setActTimeout(() => {
1000
- queryClient.setQueryData(key(), { pages: [7, 8], pageParams: [7, 8] });
1001
- setFirstPage(7);
1002
- }, 20);
1003
- setActTimeout(() => {
1004
- refetch();
1005
- }, 50);
1006
- });
1007
- return null;
1008
- }
1009
- render(() => (<QueryClientProvider client={queryClient}>
1010
- <Page />
1011
- </QueryClientProvider>));
1012
- await sleep(100);
1013
- expect(states.length).toBe(5);
1014
- expect(states[0]).toMatchObject({
1015
- hasNextPage: undefined,
1016
- data: undefined,
1017
- isFetching: true,
1018
- isFetchingNextPage: false,
1019
- isSuccess: false,
1020
- });
1021
- // After first fetch
1022
- expect(states[1]).toMatchObject({
1023
- hasNextPage: true,
1024
- data: { pages: [0] },
1025
- isFetching: false,
1026
- isFetchingNextPage: false,
1027
- isSuccess: true,
1028
- });
1029
- // Set state
1030
- expect(states[2]).toMatchObject({
1031
- hasNextPage: true,
1032
- data: { pages: [7, 8] },
1033
- isFetching: false,
1034
- isFetchingNextPage: false,
1035
- isSuccess: true,
1036
- });
1037
- // Refetch
1038
- expect(states[3]).toMatchObject({
1039
- hasNextPage: true,
1040
- data: { pages: [7, 8] },
1041
- isFetching: true,
1042
- isFetchingNextPage: false,
1043
- isSuccess: true,
1044
- });
1045
- // Refetch done
1046
- expect(states[4]).toMatchObject({
1047
- hasNextPage: true,
1048
- data: { pages: [7, 8] },
1049
- isFetching: false,
1050
- isFetchingNextPage: false,
1051
- isSuccess: true,
1052
- });
1053
- });
1054
- it('should only refetch the first page when initialData is provided', async () => {
1055
- const key = queryKey();
1056
- const states = [];
1057
- function Page() {
1058
- const state = createInfiniteQuery(key, async ({ pageParam }) => {
1059
- await sleep(10);
1060
- return pageParam;
1061
- }, {
1062
- initialData: { pages: [1], pageParams: [1] },
1063
- getNextPageParam: (lastPage) => lastPage + 1,
1064
- notifyOnChangeProps: 'all',
1065
- });
1066
- createRenderEffect(() => {
1067
- states.push({ ...state });
1068
- });
1069
- createEffect(() => {
1070
- const { fetchNextPage } = state;
1071
- setActTimeout(() => {
1072
- fetchNextPage();
1073
- }, 20);
1074
- });
1075
- return null;
1076
- }
1077
- render(() => (<QueryClientProvider client={queryClient}>
1078
- <Page />
1079
- </QueryClientProvider>));
1080
- await sleep(100);
1081
- expect(states.length).toBe(4);
1082
- expect(states[0]).toMatchObject({
1083
- data: { pages: [1] },
1084
- hasNextPage: true,
1085
- isFetching: true,
1086
- isFetchingNextPage: false,
1087
- isSuccess: true,
1088
- });
1089
- expect(states[1]).toMatchObject({
1090
- data: { pages: [1] },
1091
- hasNextPage: true,
1092
- isFetching: false,
1093
- isFetchingNextPage: false,
1094
- isSuccess: true,
1095
- });
1096
- expect(states[2]).toMatchObject({
1097
- data: { pages: [1] },
1098
- hasNextPage: true,
1099
- isFetching: true,
1100
- isFetchingNextPage: true,
1101
- isSuccess: true,
1102
- });
1103
- expect(states[3]).toMatchObject({
1104
- data: { pages: [1, 2] },
1105
- hasNextPage: true,
1106
- isFetching: false,
1107
- isFetchingNextPage: false,
1108
- isSuccess: true,
1109
- });
1110
- });
1111
- it('should set hasNextPage to false if getNextPageParam returns undefined', async () => {
1112
- const key = queryKey();
1113
- const states = [];
1114
- function Page() {
1115
- const state = createInfiniteQuery(key, ({ pageParam = 1 }) => Number(pageParam), {
1116
- getNextPageParam: () => undefined,
1117
- });
1118
- createRenderEffect(() => {
1119
- states.push({ ...state });
1120
- });
1121
- return null;
1122
- }
1123
- render(() => (<QueryClientProvider client={queryClient}>
1124
- <Page />
1125
- </QueryClientProvider>));
1126
- await sleep(100);
1127
- expect(states.length).toBe(2);
1128
- expect(states[0]).toMatchObject({
1129
- data: undefined,
1130
- hasNextPage: undefined,
1131
- isFetching: true,
1132
- isFetchingNextPage: false,
1133
- isSuccess: false,
1134
- });
1135
- expect(states[1]).toMatchObject({
1136
- data: { pages: [1] },
1137
- hasNextPage: false,
1138
- isFetching: false,
1139
- isFetchingNextPage: false,
1140
- isSuccess: true,
1141
- });
1142
- });
1143
- it('should compute hasNextPage correctly using initialData', async () => {
1144
- const key = queryKey();
1145
- const states = [];
1146
- function Page() {
1147
- const state = createInfiniteQuery(key, ({ pageParam = 10 }) => pageParam, {
1148
- initialData: { pages: [10], pageParams: [undefined] },
1149
- getNextPageParam: (lastPage) => (lastPage === 10 ? 11 : undefined),
1150
- });
1151
- createRenderEffect(() => {
1152
- states.push({ ...state });
1153
- });
1154
- return null;
1155
- }
1156
- render(() => (<QueryClientProvider client={queryClient}>
1157
- <Page />
1158
- </QueryClientProvider>));
1159
- await sleep(100);
1160
- expect(states.length).toBe(2);
1161
- expect(states[0]).toMatchObject({
1162
- data: { pages: [10] },
1163
- hasNextPage: true,
1164
- isFetching: true,
1165
- isFetchingNextPage: false,
1166
- isSuccess: true,
1167
- });
1168
- expect(states[1]).toMatchObject({
1169
- data: { pages: [10] },
1170
- hasNextPage: true,
1171
- isFetching: false,
1172
- isFetchingNextPage: false,
1173
- isSuccess: true,
1174
- });
1175
- });
1176
- it('should compute hasNextPage correctly for falsy getFetchMore return value using initialData', async () => {
1177
- const key = queryKey();
1178
- const states = [];
1179
- function Page() {
1180
- const state = createInfiniteQuery(key, ({ pageParam = 10 }) => pageParam, {
1181
- initialData: { pages: [10], pageParams: [undefined] },
1182
- getNextPageParam: () => undefined,
1183
- });
1184
- createRenderEffect(() => {
1185
- states.push({ ...state });
1186
- });
1187
- return null;
1188
- }
1189
- render(() => (<QueryClientProvider client={queryClient}>
1190
- <Page />
1191
- </QueryClientProvider>));
1192
- await sleep(100);
1193
- expect(states.length).toBe(2);
1194
- expect(states[0]).toMatchObject({
1195
- data: { pages: [10] },
1196
- hasNextPage: false,
1197
- isFetching: true,
1198
- isFetchingNextPage: false,
1199
- isSuccess: true,
1200
- });
1201
- expect(states[1]).toMatchObject({
1202
- data: { pages: [10] },
1203
- hasNextPage: false,
1204
- isFetching: false,
1205
- isFetchingNextPage: false,
1206
- isSuccess: true,
1207
- });
1208
- });
1209
- it('should not use selected data when computing hasNextPage', async () => {
1210
- const key = queryKey();
1211
- const states = [];
1212
- function Page() {
1213
- const state = createInfiniteQuery(key, ({ pageParam = 1 }) => Number(pageParam), {
1214
- getNextPageParam: (lastPage) => (lastPage === 1 ? 2 : false),
1215
- select: (data) => ({
1216
- pages: data.pages.map((x) => x.toString()),
1217
- pageParams: data.pageParams,
1218
- }),
1219
- });
1220
- createRenderEffect(() => {
1221
- states.push({ ...state });
1222
- });
1223
- return null;
1224
- }
1225
- render(() => (<QueryClientProvider client={queryClient}>
1226
- <Page />
1227
- </QueryClientProvider>));
1228
- await sleep(100);
1229
- expect(states.length).toBe(2);
1230
- expect(states[0]).toMatchObject({
1231
- data: undefined,
1232
- hasNextPage: undefined,
1233
- isFetching: true,
1234
- isFetchingNextPage: false,
1235
- isSuccess: false,
1236
- });
1237
- expect(states[1]).toMatchObject({
1238
- data: { pages: ['1'] },
1239
- hasNextPage: true,
1240
- isFetching: false,
1241
- isFetchingNextPage: false,
1242
- isSuccess: true,
1243
- });
1244
- });
1245
- it('should build fresh cursors on refetch', async () => {
1246
- const key = queryKey();
1247
- const genItems = (size) => [...new Array(size)].fill(null).map((_, d) => d);
1248
- const items = genItems(15);
1249
- const limit = 3;
1250
- const fetchItemsWithLimit = async (cursor = 0, ts) => {
1251
- await sleep(10);
1252
- return {
1253
- nextId: cursor + limit,
1254
- items: items.slice(cursor, cursor + limit),
1255
- ts,
1256
- };
1257
- };
1258
- function Page() {
1259
- let fetchCountRef = 0;
1260
- const state = createInfiniteQuery(key, ({ pageParam = 0 }) => fetchItemsWithLimit(pageParam, fetchCountRef++), {
1261
- getNextPageParam: (lastPage) => lastPage.nextId,
1262
- });
1263
- return (<div>
1264
- <h1>Pagination</h1>
1265
- <Switch fallback={<>
1266
- <div>Data:</div>
1267
- <For each={state.data?.pages ?? []}>
1268
- {(page, i) => (<div>
1269
- <div>
1270
- Page {i()}: {page.ts}
1271
- </div>
1272
- <div>
1273
- <Index each={page.items}>
1274
- {(item) => <p>Item: {item()}</p>}
1275
- </Index>
1276
- </div>
1277
- </div>)}
1278
- </For>
1279
- <div>
1280
- <button onClick={() => state.fetchNextPage()} disabled={!state.hasNextPage || Boolean(state.isFetchingNextPage)}>
1281
- <Switch fallback={<>Nothing more to load</>}>
1282
- <Match when={state.isFetchingNextPage}>
1283
- Loading more...
1284
- </Match>
1285
- <Match when={state.hasNextPage}>Load More</Match>
1286
- </Switch>
1287
- </button>
1288
- <button onClick={() => state.refetch()}>Refetch</button>
1289
- <button onClick={() => {
1290
- // Imagine that this mutation happens somewhere else
1291
- // makes an actual network request
1292
- // and calls invalidateQueries in an onSuccess
1293
- items.splice(4, 1);
1294
- queryClient.invalidateQueries(key());
1295
- }}>
1296
- Remove item
1297
- </button>
1298
- </div>
1299
- <div>
1300
- {!state.isFetchingNextPage ? 'Background Updating...' : null}
1301
- </div>
1302
- </>}>
1303
- <Match when={state.status === 'loading'}>Loading...</Match>
1304
- <Match when={state.status === 'error'}>
1305
- <span>Error: {state.error.message}</span>
1306
- </Match>
1307
- </Switch>
1308
- </div>);
1309
- }
1310
- render(() => (<QueryClientProvider client={queryClient}>
1311
- <Page />
1312
- </QueryClientProvider>));
1313
- screen.getByText('Loading...');
1314
- await waitFor(() => screen.getByText('Item: 2'));
1315
- await waitFor(() => screen.getByText('Page 0: 0'));
1316
- fireEvent.click(screen.getByText('Load More'));
1317
- await waitFor(() => screen.getByText('Loading more...'));
1318
- await waitFor(() => screen.getByText('Item: 5'));
1319
- await waitFor(() => screen.getByText('Page 0: 0'));
1320
- await waitFor(() => screen.getByText('Page 1: 1'));
1321
- fireEvent.click(screen.getByText('Load More'));
1322
- await waitFor(() => screen.getByText('Loading more...'));
1323
- await waitFor(() => screen.getByText('Item: 8'));
1324
- await waitFor(() => screen.getByText('Page 0: 0'));
1325
- await waitFor(() => screen.getByText('Page 1: 1'));
1326
- await waitFor(() => screen.getByText('Page 2: 2'));
1327
- fireEvent.click(screen.getByText('Refetch'));
1328
- await waitFor(() => screen.getByText('Background Updating...'));
1329
- await waitFor(() => screen.getByText('Item: 8'));
1330
- await waitFor(() => screen.getByText('Page 0: 3'));
1331
- await waitFor(() => screen.getByText('Page 1: 4'));
1332
- await waitFor(() => screen.getByText('Page 2: 5'));
1333
- // ensure that Item: 4 is rendered before removing it
1334
- expect(screen.queryAllByText('Item: 4')).toHaveLength(1);
1335
- // remove Item: 4
1336
- fireEvent.click(screen.getByText('Remove item'));
1337
- await waitFor(() => screen.getByText('Background Updating...'));
1338
- // ensure that an additional item is rendered (it means that cursors were properly rebuilt)
1339
- await waitFor(() => screen.getByText('Item: 9'));
1340
- await waitFor(() => screen.getByText('Page 0: 6'));
1341
- await waitFor(() => screen.getByText('Page 1: 7'));
1342
- await waitFor(() => screen.getByText('Page 2: 8'));
1343
- // ensure that Item: 4 is no longer rendered
1344
- expect(screen.queryAllByText('Item: 4')).toHaveLength(0);
1345
- });
1346
- it('should compute hasNextPage correctly for falsy getFetchMore return value on refetching', async () => {
1347
- const key = queryKey();
1348
- const MAX = 2;
1349
- function Page() {
1350
- let fetchCountRef = 0;
1351
- const [isRemovedLastPage, setIsRemovedLastPage] = createSignal(false);
1352
- const state = createInfiniteQuery(key, ({ pageParam = 0 }) => fetchItems(pageParam, fetchCountRef++, pageParam === MAX || (pageParam === MAX - 1 && isRemovedLastPage())), {
1353
- getNextPageParam: (lastPage) => lastPage.nextId,
1354
- });
1355
- return (<div>
1356
- <h1>Pagination</h1>
1357
- <Switch fallback={<>
1358
- <div>Data:</div>
1359
- <For each={state.data.pages}>
1360
- {(page, i) => (<div>
1361
- <div>
1362
- Page {i()}: {page.ts}
1363
- </div>
1364
- <div>
1365
- <Index each={page.items}>
1366
- {(item) => <p>Item: {item()}</p>}
1367
- </Index>
1368
- </div>
1369
- </div>)}
1370
- </For>
1371
- <div>
1372
- <button onClick={() => state.fetchNextPage()} disabled={!state.hasNextPage || Boolean(state.isFetchingNextPage)}>
1373
- {state.isFetchingNextPage
1374
- ? 'Loading more...'
1375
- : state.hasNextPage
1376
- ? 'Load More'
1377
- : 'Nothing more to load'}
1378
- </button>
1379
- <button onClick={() => state.refetch()}>Refetch</button>
1380
- <button onClick={() => setIsRemovedLastPage(true)}>
1381
- Remove Last Page
1382
- </button>
1383
- </div>
1384
- <div>
1385
- {state.isFetching && !state.isFetchingNextPage
1386
- ? 'Background Updating...'
1387
- : null}
1388
- </div>
1389
- </>}>
1390
- <Match when={state.status === 'loading'}>Loading...</Match>
1391
- <Match when={state.status === 'error'}>
1392
- <span>Error: {state.error.message}</span>
1393
- </Match>
1394
- </Switch>
1395
- </div>);
1396
- }
1397
- render(() => (<QueryClientProvider client={queryClient}>
1398
- <Page />
1399
- </QueryClientProvider>));
1400
- screen.getByText('Loading...');
1401
- await waitFor(() => {
1402
- screen.getByText('Item: 9');
1403
- screen.getByText('Page 0: 0');
1404
- });
1405
- fireEvent.click(screen.getByText('Load More'));
1406
- await waitFor(() => screen.getByText('Loading more...'));
1407
- await waitFor(() => {
1408
- screen.getByText('Item: 19');
1409
- screen.getByText('Page 0: 0');
1410
- screen.getByText('Page 1: 1');
1411
- });
1412
- fireEvent.click(screen.getByText('Load More'));
1413
- await waitFor(() => screen.getByText('Loading more...'));
1414
- await waitFor(() => {
1415
- screen.getByText('Item: 29');
1416
- screen.getByText('Page 0: 0');
1417
- screen.getByText('Page 1: 1');
1418
- screen.getByText('Page 2: 2');
1419
- });
1420
- screen.getByText('Nothing more to load');
1421
- fireEvent.click(screen.getByText('Remove Last Page'));
1422
- await sleep(10);
1423
- fireEvent.click(screen.getByText('Refetch'));
1424
- await waitFor(() => screen.getByText('Background Updating...'));
1425
- await waitFor(() => {
1426
- screen.getByText('Page 0: 3');
1427
- screen.getByText('Page 1: 4');
1428
- });
1429
- expect(screen.queryByText('Item: 29')).toBeNull();
1430
- expect(screen.queryByText('Page 2: 5')).toBeNull();
1431
- screen.getByText('Nothing more to load');
1432
- });
1433
- it('should cancel the query function when there are no more subscriptions', async () => {
1434
- const key = queryKey();
1435
- let cancelFn = jest.fn();
1436
- const queryFn = ({ signal }) => {
1437
- const promise = new Promise((resolve, reject) => {
1438
- cancelFn = jest.fn(() => reject('Cancelled'));
1439
- signal?.addEventListener('abort', cancelFn);
1440
- sleep(20).then(() => resolve('OK'));
1441
- });
1442
- return promise;
1443
- };
1444
- function Page() {
1445
- const state = createInfiniteQuery(key, queryFn);
1446
- return (<div>
1447
- <h1>Status: {state.status}</h1>
1448
- </div>);
1449
- }
1450
- render(() => (<QueryClientProvider client={queryClient}>
1451
- <Blink duration={5}>
1452
- <Page />
1453
- </Blink>
1454
- </QueryClientProvider>));
1455
- await waitFor(() => screen.getByText('off'));
1456
- expect(cancelFn).toHaveBeenCalled();
1457
- });
1458
- });