Skip to content
Source
Sign inSign up
TanStack/router
Open History to see the last commit

errorComponent.test.tsx

147 lines4.2 KB

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