import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'
import { cleanup, fireEvent, render, screen } from '@testing-library/react'
import {
Link,
RouterProvider,
createBrowserHistory,
createRootRoute,
createRoute,
createRouter,
} from '../src'
import type { ErrorComponentProps, RouterHistory } from '../src'
function MyErrorComponent(props: ErrorComponentProps) {
return
Error: {props.error.message}
}
async function asyncToThrowFn() {
await new Promise((resolve) => setTimeout(resolve, 500))
throw new Error('error thrown')
}
function throwFn() {
throw new Error('error thrown')
}
let history: RouterHistory
beforeEach(() => {
history = createBrowserHistory()
expect(window.location.pathname).toBe('/')
})
afterEach(() => {
history.destroy()
vi.resetAllMocks()
window.history.replaceState(null, 'root', '/')
cleanup()
})
describe.each([{ preload: false }, { preload: 'intent' }] as const)(
'errorComponent is rendered when the preload=$preload',
(options) => {
describe.each([true, false])('with async=%s', (isAsync) => {
const throwableFn = isAsync ? asyncToThrowFn : throwFn
const callers = [
{ caller: 'beforeLoad', testFn: throwableFn },
{ caller: 'loader', testFn: throwableFn },
]
test.each(callers)(
'an Error is thrown on navigate in the route $caller function',
async ({ caller, testFn }) => {
const rootRoute = createRootRoute()
const indexRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/',
component: function Home() {
return (
link to about
)
},
})
const aboutRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/about',
beforeLoad: caller === 'beforeLoad' ? testFn : undefined,
loader: caller === 'loader' ? testFn : undefined,
component: function Home() {
return About route content
},
errorComponent: MyErrorComponent,
})
const routeTree = rootRoute.addChildren([indexRoute, aboutRoute])
const router = createRouter({
routeTree,
defaultPreload: options.preload,
history,
})
render()
const linkToAbout = await screen.findByRole('link', {
name: 'link to about',
})
expect(linkToAbout).toBeInTheDocument()
fireEvent.mouseOver(linkToAbout)
fireEvent.focus(linkToAbout)
fireEvent.click(linkToAbout)
const errorComponent = await screen.findByText(
`Error: error thrown`,
undefined,
{ timeout: 1500 },
)
await expect(
screen.findByText('About route content'),
).rejects.toThrow()
expect(errorComponent).toBeInTheDocument()
},
)
test.each(callers)(
'an Error is thrown on first load in the route $caller function',
async ({ caller, testFn }) => {
const rootRoute = createRootRoute()
const indexRoute = createRoute({
getParentRoute: () => rootRoute,
path: '/',
beforeLoad: caller === 'beforeLoad' ? testFn : undefined,
loader: caller === 'loader' ? testFn : undefined,
component: function Home() {
return Index route content
},
errorComponent: MyErrorComponent,
})
const routeTree = rootRoute.addChildren([indexRoute])
const router = createRouter({
routeTree,
defaultPreload: options.preload,
history,
})
render()
const errorComponent = await screen.findByText(
`Error: error thrown`,
undefined,
{ timeout: 750 },
)
await expect(
screen.findByText('Index route content'),
).rejects.toThrow()
expect(errorComponent).toBeInTheDocument()
},
)
})
},
)