-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Expand file tree
/
Copy pathloaders.test.tsx
More file actions
1038 lines (883 loc) · 27.9 KB
/
loaders.test.tsx
File metadata and controls
1038 lines (883 loc) · 27.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import {
act,
cleanup,
configure,
fireEvent,
render,
screen,
waitFor,
} from '@testing-library/react'
import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'
import { z } from 'zod'
import { useEffect } from 'react'
import {
Link,
Outlet,
RouterProvider,
createBrowserHistory,
createRootRoute,
createRoute,
createRouter,
useRouter,
} from '../src'
import { sleep } from './utils'
import type { RouterHistory } from '../src'
let history: RouterHistory
beforeEach(() => {
history = createBrowserHistory()
expect(window.location.pathname).toBe('/')
})
afterEach(() => {
history.destroy()
vi.resetAllMocks()
window.history.replaceState(null, 'root', '/')
cleanup()
})
const WAIT_TIME = 100
describe('loaders are being called', () => {
configure({ reactStrictMode: true })
test('called on /', async () => {
const indexLoaderMock = vi.fn()
const rootRoute = createRootRoute({})
const indexRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/',
loader: async () => {
await sleep(WAIT_TIME)
indexLoaderMock('foo')
},
component: () => <div>Index page</div>,
})
const routeTree = rootRoute.addChildren([indexRoute])
const router = createRouter({ routeTree, history })
render(<RouterProvider router={router} />)
const indexElement = await screen.findByText('Index page')
expect(indexElement).toBeInTheDocument()
expect(router.state.location.href).toBe('/')
expect(window.location.pathname).toBe('/')
expect(indexLoaderMock).toHaveBeenCalled()
})
test('both are called on /nested/foo', async () => {
const nestedLoaderMock = vi.fn()
const nestedFooLoaderMock = vi.fn()
const rootRoute = createRootRoute({})
const indexRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/',
component: () => {
return (
<div>
<h1>Index page</h1>
<Link to="/nested/foo">link to foo</Link>
</div>
)
},
})
const nestedRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/nested',
loader: async () => {
await sleep(WAIT_TIME)
nestedLoaderMock('nested')
},
})
const fooRoute = createRoute({
getParentRoute: () => nestedRoute,
path: '/foo',
loader: async () => {
await sleep(WAIT_TIME)
nestedFooLoaderMock('foo')
},
component: () => <div>Nested Foo page</div>,
})
const routeTree = rootRoute.addChildren([
nestedRoute.addChildren([fooRoute]),
indexRoute,
])
const router = createRouter({ routeTree, history })
render(<RouterProvider router={router} />)
const linkToAbout = await screen.findByText('link to foo')
fireEvent.click(linkToAbout)
const fooElement = await screen.findByText('Nested Foo page')
expect(fooElement).toBeInTheDocument()
expect(router.state.location.href).toBe('/nested/foo')
expect(window.location.pathname).toBe('/nested/foo')
expect(nestedLoaderMock).toHaveBeenCalled()
expect(nestedFooLoaderMock).toHaveBeenCalled()
})
})
describe('loaders parentMatchPromise', () => {
test('parentMatchPromise is defined in a child route', async () => {
const nestedLoaderMock = vi.fn()
const rootRoute = createRootRoute({})
const indexRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/',
component: () => (
<div>
Index page
<Link to="/nested/foo">link to foo</Link>
</div>
),
})
const nestedRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/nested',
loader: async () => {
await sleep(WAIT_TIME)
return 'nested'
},
component: () => <Outlet />,
})
const fooRoute = createRoute({
getParentRoute: () => nestedRoute,
path: '/foo',
loader: async ({ parentMatchPromise }) => {
nestedLoaderMock(parentMatchPromise)
const parentMatch = await parentMatchPromise
expect(parentMatch.loaderData).toBe('nested')
},
component: () => <div>Nested Foo page</div>,
})
const routeTree = rootRoute.addChildren([
nestedRoute.addChildren([fooRoute]),
indexRoute,
])
const router = createRouter({ routeTree, history })
render(<RouterProvider router={router} />)
const linkToFoo = await screen.findByRole('link', { name: 'link to foo' })
expect(linkToFoo).toBeInTheDocument()
fireEvent.click(linkToFoo)
const fooElement = await screen.findByText('Nested Foo page')
expect(fooElement).toBeInTheDocument()
expect(nestedLoaderMock).toHaveBeenCalled()
expect(nestedLoaderMock.mock.calls[0]?.[0]).toBeInstanceOf(Promise)
})
})
test('reproducer for #2031', async () => {
const rootRoute = createRootRoute({
beforeLoad: () => {
console.log('beforeload called')
},
})
const searchSchema = z.object({
data: z.string().array().default([]),
})
const indexRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/',
component: () => <div>Index page</div>,
validateSearch: searchSchema,
})
const routeTree = rootRoute.addChildren([indexRoute])
const router = createRouter({ routeTree, history })
render(<RouterProvider router={router} />)
const indexElement = await screen.findByText('Index page')
expect(indexElement).toBeInTheDocument()
})
test('reproducer for #2053', async () => {
const rootRoute = createRootRoute({
beforeLoad: () => {
console.log('beforeload called')
},
})
const fooRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/foo/$fooId',
component: () => {
const { fooId } = fooRoute.useParams()
return <div>fooId: {fooId}</div>
},
})
window.history.replaceState(null, 'root', '/foo/3ΚΑΠΠΑ')
const routeTree = rootRoute.addChildren([fooRoute])
const router = createRouter({
routeTree,
history,
})
render(<RouterProvider router={router} />)
const fooElement = await screen.findByText('fooId: 3ΚΑΠΠΑ')
expect(fooElement).toBeInTheDocument()
})
test('reproducer for #2198 - throw error from beforeLoad upon initial load', async () => {
const rootRoute = createRootRoute({})
const indexRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/',
component: () => <div>Index page</div>,
beforeLoad: () => {
throw new Error('Test!')
},
errorComponent: () => <div>indexErrorComponent</div>,
})
const routeTree = rootRoute.addChildren([indexRoute])
const router = createRouter({
routeTree,
history,
defaultErrorComponent: () => {
return <div>defaultErrorComponent</div>
},
})
render(<RouterProvider router={router} />)
const errorElement = await screen.findByText('indexErrorComponent')
expect(errorElement).toBeInTheDocument()
})
test('throw error from loader upon initial load', async () => {
const rootRoute = createRootRoute({})
const indexRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/',
component: () => <div>Index page</div>,
loader: () => {
throw new Error('Test!')
},
errorComponent: () => <div>indexErrorComponent</div>,
})
const routeTree = rootRoute.addChildren([indexRoute])
const router = createRouter({
routeTree,
history,
defaultErrorComponent: () => {
return <div>defaultErrorComponent</div>
},
})
render(<RouterProvider router={router} />)
const errorElement = await screen.findByText('indexErrorComponent')
expect(errorElement).toBeInTheDocument()
})
test('throw error from beforeLoad when navigating to route', async () => {
const rootRoute = createRootRoute({})
const indexRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/',
component: () => (
<div>
<h1>Index page</h1> <Link to="/foo">link to foo</Link>
</div>
),
errorComponent: () => <div>indexErrorComponent</div>,
})
const fooRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/foo',
component: () => <div>Foo page</div>,
beforeLoad: () => {
throw new Error('Test!')
},
errorComponent: () => <div>fooErrorComponent</div>,
})
const routeTree = rootRoute.addChildren([indexRoute, fooRoute])
const router = createRouter({
routeTree,
history,
defaultErrorComponent: () => {
return <div>defaultErrorComponent</div>
},
})
render(<RouterProvider router={router} />)
const linkToFoo = await screen.findByRole('link', { name: 'link to foo' })
expect(linkToFoo).toBeInTheDocument()
fireEvent.click(linkToFoo)
const indexElement = await screen.findByText('fooErrorComponent')
expect(indexElement).toBeInTheDocument()
})
test('reproducer #4245', async () => {
const LOADER_WAIT_TIME = 500
const rootRoute = createRootRoute({})
const indexRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/',
loader: async () => {
await sleep(LOADER_WAIT_TIME)
return 'index'
},
component: () => {
const data = indexRoute.useLoaderData()
return (
<div>
<Link to="/foo" data-testid="link-to-foo">
foo
</Link>
{data}
</div>
)
},
})
const fooRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/foo',
component: () => (
<Link to="/" data-testid="link-to-index">
index
</Link>
),
})
const routeTree = rootRoute.addChildren([indexRoute, fooRoute])
const router = createRouter({ routeTree })
render(<RouterProvider router={router} />)
// We wait for the initial loader to complete
await act(() => router.load())
const fooLink = await screen.findByTestId('link-to-foo')
expect(fooLink).toBeInTheDocument()
// We navigate to the foo route
fireEvent.click(fooLink)
// We immediately see the content of the foo route
const indexLink = await screen.findByTestId('link-to-index', undefined, {
timeout: WAIT_TIME,
})
expect(indexLink).toBeInTheDocument()
// We navigate to the index route
fireEvent.click(indexLink)
// We immediately see the content of the index route because the stale data is still available
const fooLink2 = await screen.findByTestId('link-to-foo', undefined, {
timeout: WAIT_TIME,
})
expect(fooLink2).toBeInTheDocument()
// We navigate to the foo route again
fireEvent.click(fooLink2)
// We immediately see the content of the foo route
const indexLink2 = await screen.findByTestId('link-to-index', undefined, {
timeout: WAIT_TIME,
})
expect(indexLink2).toBeInTheDocument()
// We navigate to the index route again
fireEvent.click(indexLink2)
// We now should see the content of the index route immediately because the stale data is still available
const fooLink3 = await screen.findByTestId('link-to-foo', undefined, {
timeout: WAIT_TIME,
})
expect(fooLink3).toBeInTheDocument()
})
test('reproducer #4546', async () => {
const rootRoute = createRootRoute({
component: () => {
return (
<>
<div className="flex gap-2 p-2 text-lg">
<Link
data-testid="link-to-index"
to="/"
activeProps={{
className: 'font-bold',
}}
activeOptions={{ exact: true }}
>
Home
</Link>{' '}
<Link
data-testid="link-to-id"
to="$id"
params={{
id: '1',
}}
activeProps={{
className: 'font-bold',
}}
>
/1
</Link>
</div>
<hr />
<Outlet />
</>
)
},
})
let counter = 0
const appRoute = createRoute({
getParentRoute: () => rootRoute,
id: '_app',
beforeLoad: () => {
counter += 1
return {
counter,
}
},
component: () => {
return (
<div>
<Header />
<Outlet />
</div>
)
},
})
function Header() {
const router = useRouter()
const { counter } = appRoute.useRouteContext()
return (
<div>
Header Counter: <p data-testid="header-counter">{counter}</p>
<button
onClick={() => {
router.invalidate()
}}
data-testid="invalidate-router"
style={{
border: '1px solid blue',
}}
>
Invalidate router
</button>
</div>
)
}
const indexRoute = createRoute({
getParentRoute: () => appRoute,
path: '/',
loader: ({ context }) => {
return {
counter: context.counter,
}
},
component: () => {
const data = indexRoute.useLoaderData()
const ctx = indexRoute.useRouteContext()
return (
<div
style={{
display: 'flex',
flexDirection: 'column',
}}
>
<div>Index route</div>
<div>
route context:{' '}
<p data-testid="index-route-context">{ctx.counter}</p>
</div>
<div>
loader data: <p data-testid="index-loader-data">{data.counter}</p>
</div>
</div>
)
},
})
const idRoute = createRoute({
getParentRoute: () => appRoute,
path: '$id',
loader: ({ context }) => {
return {
counter: context.counter,
}
},
component: () => {
const data = idRoute.useLoaderData()
const ctx = idRoute.useRouteContext()
return (
<div
style={{
display: 'flex',
flexDirection: 'column',
}}
>
<div>$id route</div>
<div>
route context: <p data-testid="id-route-context">{ctx.counter}</p>
</div>
<div>
loader data: <p data-testid="id-loader-data">{data.counter}</p>
</div>
</div>
)
},
})
const routeTree = rootRoute.addChildren([
appRoute.addChildren([indexRoute, idRoute]),
])
const router = createRouter({ routeTree })
render(<RouterProvider router={router} />)
const indexLink = await screen.findByTestId('link-to-index')
expect(indexLink).toBeInTheDocument()
const idLink = await screen.findByTestId('link-to-id')
expect(idLink).toBeInTheDocument()
const invalidateRouterButton = await screen.findByTestId('invalidate-router')
expect(invalidateRouterButton).toBeInTheDocument()
{
const headerCounter = await screen.findByTestId('header-counter')
expect(headerCounter).toHaveTextContent('1')
const routeContext = await screen.findByTestId('index-route-context')
expect(routeContext).toHaveTextContent('1')
const loaderData = await screen.findByTestId('index-loader-data')
expect(loaderData).toHaveTextContent('1')
}
fireEvent.click(idLink)
{
const headerCounter = await screen.findByTestId('header-counter')
expect(headerCounter).toHaveTextContent('2')
const routeContext = await screen.findByTestId('id-route-context')
expect(routeContext).toHaveTextContent('2')
const loaderData = await screen.findByTestId('id-loader-data')
expect(loaderData).toHaveTextContent('2')
}
fireEvent.click(indexLink)
{
const headerCounter = await screen.findByTestId('header-counter')
expect(headerCounter).toHaveTextContent('3')
const routeContext = await screen.findByTestId('index-route-context')
expect(routeContext).toHaveTextContent('3')
const loaderData = await screen.findByTestId('index-loader-data')
expect(loaderData).toHaveTextContent('3')
}
fireEvent.click(invalidateRouterButton)
{
const headerCounter = await screen.findByTestId('header-counter')
expect(headerCounter).toHaveTextContent('4')
const routeContext = await screen.findByTestId('index-route-context')
expect(routeContext).toHaveTextContent('4')
const loaderData = await screen.findByTestId('index-loader-data')
expect(loaderData).toHaveTextContent('4')
}
fireEvent.click(idLink)
{
const headerCounter = await screen.findByTestId('header-counter')
expect(headerCounter).toHaveTextContent('5')
const routeContext = await screen.findByTestId('id-route-context')
expect(routeContext).toHaveTextContent('5')
const loaderData = await screen.findByTestId('id-loader-data')
expect(loaderData).toHaveTextContent('5')
}
})
test('clears pendingTimeout when match resolves', async () => {
const defaultPendingComponentOnMountMock = vi.fn()
const nestedPendingComponentOnMountMock = vi.fn()
const fooPendingComponentOnMountMock = vi.fn()
function getPendingComponent(onMount: () => void) {
const PendingComponent = () => {
useEffect(() => {
onMount()
}, [])
return <div>Pending...</div>
}
return PendingComponent
}
const rootRoute = createRootRoute({})
const indexRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/',
component: () => {
return (
<div>
<h1>Index page</h1>
<Link data-testid="link-to-foo" to="/nested/foo">
link to foo
</Link>
</div>
)
},
})
const nestedRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/nested',
// this route does not specify pendingMinMs, so it will use the defaultPendingMs from the router
// which is set to WAIT_TIME * 2
// since the loader immediately resolves, the pending component must NOT be shown
pendingComponent: getPendingComponent(nestedPendingComponentOnMountMock),
loader: () => {
return 'nested'
},
})
const fooRoute = createRoute({
getParentRoute: () => nestedRoute,
path: '/foo',
// this route's loader takes WAIT_TIME * 5, so it will take longer than the defaultPendingMs
// however, this route specifies pendingMs as WAIT_TIME * 10,
// so this route's pending component must also NOT be shown
pendingComponent: getPendingComponent(fooPendingComponentOnMountMock),
pendingMs: WAIT_TIME * 10,
loader: async () => {
await sleep(WAIT_TIME * 5)
},
component: () => <div>Nested Foo page</div>,
})
const routeTree = rootRoute.addChildren([
nestedRoute.addChildren([fooRoute]),
indexRoute,
])
const router = createRouter({
routeTree,
history,
defaultPendingMs: WAIT_TIME * 2,
defaultPendingComponent: getPendingComponent(
defaultPendingComponentOnMountMock,
),
})
render(<RouterProvider router={router} />)
await act(() => router.latestLoadPromise)
const linkToFoo = await screen.findByTestId('link-to-foo')
fireEvent.click(linkToFoo)
const fooElement = await screen.findByText('Nested Foo page')
expect(fooElement).toBeInTheDocument()
expect(router.state.location.href).toBe('/nested/foo')
// none of the pending components should have been called
expect(defaultPendingComponentOnMountMock).not.toHaveBeenCalled()
expect(nestedPendingComponentOnMountMock).not.toHaveBeenCalled()
expect(fooPendingComponentOnMountMock).not.toHaveBeenCalled()
})
test('throw abortError from loader upon initial load with basepath', async () => {
window.history.replaceState(null, 'root', '/app')
const rootRoute = createRootRoute({})
const indexRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/',
loader: async () => {
return Promise.reject(new DOMException('Aborted', 'AbortError'))
},
component: () => <div>Index route content</div>,
errorComponent: () => (
<div data-testid="index-error">indexErrorComponent</div>
),
})
const routeTree = rootRoute.addChildren([indexRoute])
const router = createRouter({ routeTree, history, basepath: '/app' })
render(<RouterProvider router={router} />)
const indexElement = await screen.findByText('Index route content')
expect(indexElement).toBeInTheDocument()
expect(screen.queryByTestId('index-error')).not.toBeInTheDocument()
expect(window.location.pathname.startsWith('/app')).toBe(true)
})
test('cancelMatches after pending timeout', async () => {
function getPendingComponent(onMount: () => void) {
const PendingComponent = () => {
useEffect(() => {
onMount()
}, [])
return <div>Pending...</div>
}
return PendingComponent
}
const onAbortMock = vi.fn()
const fooPendingComponentOnMountMock = vi.fn()
const rootRoute = createRootRoute({
component: () => (
<div>
<h1>Index page</h1>
<Link data-testid="link-to-foo" to="/foo">
link to foo
</Link>
<Link data-testid="link-to-bar" to="/bar">
link to bar
</Link>
<Outlet />
</div>
),
})
const fooRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/foo',
pendingMs: WAIT_TIME * 20,
loader: async ({ abortController }) => {
await new Promise<void>((resolve) => {
const timer = setTimeout(() => {
resolve()
}, WAIT_TIME * 40)
abortController.signal.addEventListener('abort', () => {
onAbortMock()
clearTimeout(timer)
resolve()
})
})
},
pendingComponent: getPendingComponent(fooPendingComponentOnMountMock),
component: () => <div>Foo page</div>,
})
const barRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/bar',
component: () => <div>Bar page</div>,
})
const routeTree = rootRoute.addChildren([fooRoute, barRoute])
const router = createRouter({ routeTree, history })
render(<RouterProvider router={router} />)
await act(() => router.latestLoadPromise)
const fooLink = await screen.findByTestId('link-to-foo')
fireEvent.click(fooLink)
await sleep(WAIT_TIME * 30)
const pendingElement = await screen.findByText('Pending...')
expect(pendingElement).toBeInTheDocument()
const barLink = await screen.findByTestId('link-to-bar')
fireEvent.click(barLink)
const barElement = await screen.findByText('Bar page')
expect(barElement).toBeInTheDocument()
expect(fooPendingComponentOnMountMock).toHaveBeenCalled()
expect(onAbortMock).toHaveBeenCalled()
})
test('reproducer for #6388 - rapid navigation between parameterized routes should not trigger errorComponent', async () => {
const errorComponentRenderCount = vi.fn()
const onAbortMock = vi.fn()
const loaderCompleteMock = vi.fn()
const rootRoute = createRootRoute({
component: () => (
<div>
<Link data-testid="link-to-home" to="/">
Home
</Link>
<Link
data-testid="link-to-param-1"
to="/something/$id"
params={{ id: '1' }}
preload={false}
>
Param 1
</Link>
<Link
data-testid="link-to-param-2"
to="/something/$id"
params={{ id: '2' }}
preload={false}
>
Param 2
</Link>
<Outlet />
</div>
),
})
const indexRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/',
component: () => <div data-testid="home-page">Home page</div>,
})
const paramRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/something/$id',
pendingMs: 0,
loader: async ({ params, abortController }) => {
const result = await new Promise<{ id: string; done: boolean }>(
(resolve, reject) => {
const timer = setTimeout(() => {
loaderCompleteMock(params.id)
resolve({ id: params.id, done: true })
}, WAIT_TIME * 5)
abortController.signal.addEventListener('abort', () => {
clearTimeout(timer)
onAbortMock(params.id)
reject(new DOMException('Aborted', 'AbortError'))
})
},
)
return result
},
component: () => {
const data = paramRoute.useLoaderData()
return (
<div data-testid="param-page">
Param Component {data.id} {data.done ? 'Done' : 'Not done'}
</div>
)
},
errorComponent: ({ error }) => {
errorComponentRenderCount(error)
return (
<div data-testid="error-component">
Error Component: {error.message} | Name: {error.name}
</div>
)
},
pendingComponent: () => <div data-testid="pending-component">Pending</div>,
})
const routeTree = rootRoute.addChildren([indexRoute, paramRoute])
const router = createRouter({
routeTree,
history,
defaultPreload: false,
})
render(<RouterProvider router={router} />)
await act(() => router.latestLoadPromise)
const pendingComponent = screen.findByTestId('pending-component')
expect(await screen.findByTestId('home-page')).toBeInTheDocument()
const param1Link = await screen.findByTestId('link-to-param-1')
fireEvent.click(param1Link)
expect(await pendingComponent).toBeInTheDocument()
const param2Link = await screen.findByTestId('link-to-param-2')
fireEvent.click(param2Link)
expect(await pendingComponent).toBeInTheDocument()
fireEvent.click(param1Link)
expect(await pendingComponent).toBeInTheDocument()
await act(() => router.latestLoadPromise)
expect(onAbortMock).toHaveBeenCalled()
expect(errorComponentRenderCount).not.toHaveBeenCalled()
expect(screen.queryByTestId('error-component')).not.toBeInTheDocument()
expect(await pendingComponent).not.toBeInTheDocument()
const paramPage = await screen.findByTestId('param-page')
expect(paramPage).toBeInTheDocument()
expect(paramPage).toHaveTextContent('Param Component 1 Done')
expect(loaderCompleteMock).toHaveBeenCalled()
})
test('keeps rendering the current pending route when a regular navigation aborts it', async () => {
const firstLoaderAborted = vi.fn()
const firstErrorComponentRenderCount = vi.fn()
let resolveSecondLoader: (() => void) | undefined
const rootRoute = createRootRoute({
component: () => <Outlet />,
})
const indexRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/',
component: () => <div data-testid="home-page">Home page</div>,
})
const firstRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/first',
pendingMs: 0,
loader: async ({ abortController }) => {
await new Promise<void>((_resolve, reject) => {
abortController.signal.addEventListener('abort', () => {
firstLoaderAborted()
reject(new DOMException('Aborted', 'AbortError'))
})
})
return 'first'
},
component: () => (
<div data-testid="first-page">{firstRoute.useLoaderData()}</div>
),
pendingComponent: () => (
<div data-testid="first-pending">Pending first route</div>
),
errorComponent: ({ error }) => {
firstErrorComponentRenderCount(error)
return <div data-testid="first-error">{String(error)}</div>
},
})
const secondRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/second',
loader: async () => {
await new Promise<void>((resolve) => {
resolveSecondLoader = resolve
})
return 'second'
},
component: () => (
<div data-testid="second-page">{secondRoute.useLoaderData()}</div>
),
})