Open History to see the last commit
1import { afterEach, describe, expect, test, vi } from 'vitest'
2import { cleanup, fireEvent, render, screen } from '@solidjs/testing-library'
3β
4import {
5 Link,
6 RouterProvider,
7 createRootRoute,
8 createRoute,
9 createRouter,
10} from '../src'
11import type { ErrorComponentProps } from '../src'
12β
13function MyErrorComponent(props: ErrorComponentProps) {
14 return <div>Error: {props.error.message}</div>
15}
16β
17async function asyncToThrowFn() {
18 await new Promise((resolve) => setTimeout(resolve, 500))
19 throw new Error('error thrown')
20}
21β
22function throwFn() {
23 throw new Error('error thrown')
24}
25β
26afterEach(() => {
27 vi.resetAllMocks()
28 window.history.replaceState(null, 'root', '/')
29 cleanup()
30})
31β
32describe.each([{ preload: false }, { preload: 'intent' }] as const)(
33 'errorComponent is rendered when the preload=$preload',
34 (options) => {
35 describe.each([true, false])('with async=%s', (isAsync) => {
36 const throwableFn = isAsync ? asyncToThrowFn : throwFn
37β
38 const callers = [
39 { caller: 'beforeLoad', testFn: throwableFn },
40 { caller: 'loader', testFn: throwableFn },
41 ]
42β
43 test.each(callers)(
44 'an Error is thrown on navigate in the route $caller function',
45 async ({ caller, testFn }) => {
46 const rootRoute = createRootRoute()
47 const indexRoute = createRoute({
48 getParentRoute: () => rootRoute,
49 path: '/',
50 component: function Home() {
51 return (
52 <div>
53 <Link to="/about">link to about</Link>
54 </div>
55 )
56 },
57 })
58 const aboutRoute = createRoute({
59 getParentRoute: () => rootRoute,
60 path: '/about',
61 beforeLoad: caller === 'beforeLoad' ? testFn : undefined,
62 loader: caller === 'loader' ? testFn : undefined,
63 component: function Home() {
64 return <div>About route content</div>
65 },
66 errorComponent: MyErrorComponent,
67 })
68β
69 const routeTree = rootRoute.addChildren([indexRoute, aboutRoute])
70β
71 const router = createRouter({
72 routeTree,
73 defaultPreload: options.preload,
74 })
75β
76 render(() => <RouterProvider router={router} />)
77β
78 const linkToAbout = await screen.findByRole('link', {
79 name: 'link to about',
80 })
81β
82 expect(linkToAbout).toBeInTheDocument()
83 fireEvent.mouseOver(linkToAbout)
84 fireEvent.focus(linkToAbout)
85 fireEvent.click(linkToAbout)
86β
87 const errorComponent = await screen.findByText(
88 `Error: error thrown`,
89 undefined,
90 { timeout: 1500 },
91 )
92 await expect(
93 screen.findByText('About route content'),
94 ).rejects.toThrow()
95 expect(errorComponent).toBeInTheDocument()
96 },
97 )
98β
99 test.each(callers)(
100 'an Error is thrown on first load in the route $caller function',
101 async ({ caller, testFn }) => {
102 const rootRoute = createRootRoute()
103 const indexRoute = createRoute({
104 getParentRoute: () => rootRoute,
105 path: '/',
106 beforeLoad: caller === 'beforeLoad' ? testFn : undefined,
107 loader: caller === 'loader' ? testFn : undefined,
108 component: function Home() {
109 return <div>Index route content</div>
110 },
111 errorComponent: MyErrorComponent,
112 })
113β
114 const routeTree = rootRoute.addChildren([indexRoute])
115β
116 const router = createRouter({
117 routeTree,
118 defaultPreload: options.preload,
119 })
120β
121 render(() => <RouterProvider router={router} />)
122β
123 const errorComponent = await screen.findByText(
124 `Error: error thrown`,
125 undefined,
126 { timeout: 750 },
127 )
128 await expect(
129 screen.findByText('Index route content'),
130 ).rejects.toThrow()
131 expect(errorComponent).toBeInTheDocument()
132 },
133 )
134 })
135 },
136)