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

blocker.test.tsx

194 lines4.9 KB

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