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

blocker.test.tsx

205 lines5.1 KB

1import React from 'react'
2import '@testing-library/jest-dom/vitest'
3import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'
4import { cleanup, fireEvent, render, screen } from '@testing-library/react'
5import combinate from 'combinate'
6import {
7 Link,
8 RouterProvider,
9 createBrowserHistory,
10 createRootRoute,
11 createRoute,
12 createRouter,
13 redirect,
14 useBlocker,
15 useNavigate,
16} from '../src'
17import type { RouterHistory, ShouldBlockFn } from '../src'
18​
19let history: RouterHistory
20​
21beforeEach(() => {
22 history = createBrowserHistory()
23 expect(window.location.pathname).toBe('/')
24})
25​
26afterEach(() => {
27 history.destroy()
28 window.history.replaceState(null, 'root', '/')
29 vi.resetAllMocks()
30 cleanup()
31})
32​
33interface BlockerTestOpts {
34 blockerFn: ShouldBlockFn
35 disabled?: boolean
36 ignoreBlocker?: boolean
38​
39async function setup({ blockerFn, disabled, ignoreBlocker }: BlockerTestOpts) {
40 const _mockBlockerFn = vi.fn(blockerFn)
41 const rootRoute = createRootRoute()
42 const indexRoute = createRoute({
43 getParentRoute: () => rootRoute,
44 path: '/',
45 component: function Setup() {
46 const navigate = useNavigate()
47 useBlocker({ disabled, shouldBlockFn: _mockBlockerFn })
48 return (
49 <>
50 <h1>Index</h1>
51 <Link to="/posts" ignoreBlocker={ignoreBlocker}>
52 link to posts
53 </Link>
54 <Link to="/foo">link to foo</Link>
55 <button onClick={() => navigate({ to: '/posts', ignoreBlocker })}>
56 button
57 </button>
58 </>
59 )
60 },
61 })
62​
63 const postsRoute = createRoute({
64 getParentRoute: () => rootRoute,
65 path: '/posts',
66 component: () => (
67 <>
68 <h1>Posts</h1>
69 </>
70 ),
71 })
72​
73 const fooRoute = createRoute({
74 getParentRoute: () => rootRoute,
75 path: '/foo',
76 beforeLoad: () => {
77 throw redirect({ to: '/bar' })
78 },
79 component: () => (
80 <>
81 <h1>Foo</h1>
82 </>
83 ),
84 })
85​
86 const barRoute = createRoute({
87 getParentRoute: () => rootRoute,
88 path: '/bar',
89 component: () => (
90 <>
91 <h1>Bar</h1>
92 </>
93 ),
94 })
95​
96 const router = createRouter({
97 routeTree: rootRoute.addChildren([
98 indexRoute,
99 postsRoute,
100 fooRoute,
101 barRoute,
102 ]),
103 history,
104 })
105​
106 render(<RouterProvider router={router} />)
107 expect(window.location.pathname).toBe('/')
108​
109 const postsLink = await screen.findByRole('link', { name: 'link to posts' })
110 const fooLink = await screen.findByRole('link', { name: 'link to foo' })
111 const button = await screen.findByRole('button', { name: 'button' })
112​
113 return {
114 router,
115 clickable: { postsLink, fooLink, button },
116 blockerFn: _mockBlockerFn,
117 }
119​
120const clickTarget = ['postsLink' as const, 'button' as const]
121​
122describe('Blocker', () => {
123 const doesNotBlockTextMatrix = combinate({
124 opts: [
125 {
126 blockerFn: () => false,
127 disabled: false,
128 ignoreBlocker: undefined,
129 },
130 {
131 blockerFn: async () =>
132 await new Promise<boolean>((resolve) => resolve(false)),
133 disabled: false,
134 ignoreBlocker: false,
135 },
136 {
137 blockerFn: () => true,
138 disabled: true,
139 ignoreBlocker: false,
140 },
141 {
142 blockerFn: () => true,
143 disabled: false,
144 ignoreBlocker: true,
145 },
146 ],
147 clickTarget,
148 })
149 test.each(doesNotBlockTextMatrix)(
150 'does not block navigation with blockerFn = $flags.blockerFn, ignoreBlocker = $flags.ignoreBlocker, clickTarget = $clickTarget',
151 async ({ opts, clickTarget }) => {
152 const { clickable, blockerFn } = await setup(opts)
153​
154 fireEvent.click(clickable[clickTarget])
155 expect(
156 await screen.findByRole('heading', { name: 'Posts' }),
157 ).toBeInTheDocument()
158 expect(window.location.pathname).toBe('/posts')
159 if (opts.ignoreBlocker || opts.disabled)
160 expect(blockerFn).not.toHaveBeenCalled()
161 },
162 )
163​
164 const blocksTextMatrix = combinate({
165 opts: [
166 {
167 blockerFn: () => true,
168 disabled: false,
169 ignoreBlocker: undefined,
170 },
171 {
172 blockerFn: async () =>
173 await new Promise<boolean>((resolve) => resolve(true)),
174 disabled: false,
175 ignoreBlocker: false,
176 },
177 ],
178 clickTarget,
179 })
180 test.each(blocksTextMatrix)(
181 'blocks navigation with condition = $flags.blockerFn, ignoreBlocker = $flags.ignoreBlocker, clickTarget = $clickTarget',
182 async ({ opts, clickTarget }) => {
183 const { clickable } = await setup(opts)
184​
185 fireEvent.click(clickable[clickTarget])
186 await expect(
187 screen.findByRole('header', { name: 'Posts' }),
188 ).rejects.toThrow()
189 expect(window.location.pathname).toBe('/')
190 },
191 )
192​
193 test('blocker function is only called once when navigating to a route that redirects', async () => {
194 const { clickable, blockerFn } = await setup({
195 blockerFn: () => false,
196 ignoreBlocker: false,
197 })
198 fireEvent.click(clickable.fooLink)
199 expect(
200 await screen.findByRole('heading', { name: 'Bar' }),
201 ).toBeInTheDocument()
202 expect(window.location.pathname).toBe('/bar')
203 expect(blockerFn).toHaveBeenCalledTimes(1)
204 })
205})