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

app.spec.ts

317 lines10.9 KB

1import { expect } from '@playwright/test'
2import { apiTest as test } from '@tanstack/router-e2e-utils'
3import type { Page } from '@playwright/test'
4​
5test.beforeEach(async ({ page }) => {
6 await page.goto('/')
7})
8​
9test('Navigating to a post page', async ({ page }) => {
10 await page.getByRole('link', { name: 'Posts' }).click()
11 await page.getByRole('link', { name: 'sunt aut facere repe' }).click()
12 await expect(page.getByRole('heading')).toContainText('sunt aut facere')
13})
14​
15test('Navigating nested layouts', async ({ page }) => {
16 await page.getByRole('link', { name: 'Layout', exact: true }).click()
17​
18 await expect(page.locator('#app')).toContainText("I'm a layout")
19 await expect(page.locator('#app')).toContainText("I'm a nested layout")
20​
21 await page.getByRole('link', { name: 'Layout A' }).click()
22 await expect(page.locator('#app')).toContainText("I'm layout A!")
23​
24 await page.getByRole('link', { name: 'Layout B' }).click()
25 await expect(page.locator('#app')).toContainText("I'm layout B!")
26})
27​
28test('Navigating to a not-found route', async ({ page }) => {
29 await page.getByRole('link', { name: 'This Route Does Not Exist' }).click()
30 await expect(page.getByRole('paragraph')).toContainText(
31 'This is the notFoundComponent configured on root route',
32 )
33 await page.getByRole('link', { name: 'Start Over' }).click()
34 await expect(page.getByRole('heading')).toContainText('Welcome Home!')
35})
36​
37test("useBlocker doesn't block navigation if condition is not met", async ({
38 page,
39}) => {
40 await page.goto('/editing-a')
41 await expect(page.getByRole('heading')).toContainText('Editing A')
42​
43 await page.getByRole('button', { name: 'Go to next step' }).click()
44 await expect(page.getByRole('heading')).toContainText('Editing B')
45})
46​
47test('useBlocker does block navigation if condition is met', async ({
48 page,
49}) => {
50 await page.goto('/editing-a')
51 await expect(page.getByRole('heading')).toContainText('Editing A')
52​
53 await page.getByLabel('Enter your name:').fill('foo')
54​
55 await page.getByRole('button', { name: 'Go to next step' }).click()
56 await expect(page.getByRole('heading')).toContainText('Editing A')
57​
58 await expect(page.getByRole('button', { name: 'Proceed' })).toBeVisible()
59})
60​
61test('Proceeding through blocked navigation works', async ({ page }) => {
62 await page.goto('/editing-a')
63 await expect(page.getByRole('heading')).toContainText('Editing A')
64​
65 await page.getByLabel('Enter your name:').fill('foo')
66​
67 await page.getByRole('button', { name: 'Go to next step' }).click()
68 await expect(page.getByRole('heading')).toContainText('Editing A')
69​
70 await page.getByRole('button', { name: 'Proceed' }).click()
71 await expect(page.getByRole('heading')).toContainText('Editing B')
72})
73​
74test("legacy useBlocker doesn't block navigation if condition is not met", async ({
75 page,
76}) => {
77 await page.goto('/editing-b')
78 await expect(page.getByRole('heading')).toContainText('Editing B')
79​
80 await page.getByRole('button', { name: 'Go back' }).click()
81 await expect(page.getByRole('heading')).toContainText('Editing A')
82})
83​
84test('legacy useBlocker does block navigation if condition is met', async ({
85 page,
86}) => {
87 await page.goto('/editing-b')
88 await expect(page.getByRole('heading')).toContainText('Editing B')
89​
90 await page.getByLabel('Enter your name:').fill('foo')
91​
92 await page.getByRole('button', { name: 'Go back' }).click()
93 await expect(page.getByRole('heading')).toContainText('Editing B')
94​
95 await expect(page.getByRole('button', { name: 'Proceed' })).toBeVisible()
96})
97​
98test('legacy Proceeding through blocked navigation works', async ({ page }) => {
99 await page.goto('/editing-b')
100 await expect(page.getByRole('heading')).toContainText('Editing B')
101​
102 await page.getByLabel('Enter your name:').fill('foo')
103​
104 await page.getByRole('button', { name: 'Go back' }).click()
105 await expect(page.getByRole('heading')).toContainText('Editing B')
106​
107 await page.getByRole('button', { name: 'Proceed' }).click()
108 await expect(page.getByRole('heading')).toContainText('Editing A')
109})
110​
111test('useCanGoBack correctly disables back button', async ({ page }) => {
112 const getBackButtonDisabled = async () => {
113 const backButton = page.getByTestId('back-button')
114 const isDisabled = (await backButton.getAttribute('disabled')) !== null
115 return isDisabled
116 }
117​
118 expect(await getBackButtonDisabled()).toBe(true)
119​
120 await page.getByRole('link', { name: 'Posts' }).click()
121 await expect(page.getByTestId('posts-links')).toBeInViewport()
122 expect(await getBackButtonDisabled()).toBe(false)
123​
124 await page.getByRole('link', { name: 'sunt aut facere repe' }).click()
125 await expect(page.getByTestId('post-title')).toBeInViewport()
126 expect(await getBackButtonDisabled()).toBe(false)
127​
128 await page.reload()
129 expect(await getBackButtonDisabled()).toBe(false)
130​
131 await page.goBack()
132 expect(await getBackButtonDisabled()).toBe(false)
133​
134 await page.goForward()
135 expect(await getBackButtonDisabled()).toBe(false)
136​
137 await page.goBack()
138 expect(await getBackButtonDisabled()).toBe(false)
139​
140 await page.goBack()
141 expect(await getBackButtonDisabled()).toBe(true)
142​
143 await page.reload()
144 expect(await getBackButtonDisabled()).toBe(true)
145})
146​
147test('useCanGoBack correctly disables back button, using router.history and window.history', async ({
148 page,
149}) => {
150 const getBackButtonDisabled = async () => {
151 const backButton = page.getByTestId('back-button')
152 const isDisabled = (await backButton.getAttribute('disabled')) !== null
153 return isDisabled
154 }
155​
156 await page.getByRole('link', { name: 'Posts' }).click()
157 await expect(page.getByTestId('posts-links')).toBeInViewport()
158 await page.getByRole('link', { name: 'sunt aut facere repe' }).click()
159 await expect(page.getByTestId('post-title')).toBeInViewport()
160 await page.getByTestId('back-button').click()
161 expect(await getBackButtonDisabled()).toBe(false)
162​
163 await page.reload()
164 expect(await getBackButtonDisabled()).toBe(false)
165​
166 await page.getByTestId('back-button').click()
167 expect(await getBackButtonDisabled()).toBe(true)
168​
169 await page.evaluate('window.history.forward()')
170 expect(await getBackButtonDisabled()).toBe(false)
171​
172 await page.evaluate('window.history.forward()')
173 expect(await getBackButtonDisabled()).toBe(false)
174​
175 await page.evaluate('window.history.back()')
176 expect(await getBackButtonDisabled()).toBe(false)
177​
178 await page.evaluate('window.history.back()')
179 expect(await getBackButtonDisabled()).toBe(true)
180​
181 await page.reload()
182 expect(await getBackButtonDisabled()).toBe(true)
183})
184​
185const testCases = [
186 {
187 description: 'Navigating to a route inside a route group',
188 testId: 'link-to-route-inside-group',
189 },
190 {
191 description:
192 'Navigating to a route inside a subfolder inside a route group ',
193 testId: 'link-to-route-inside-group-inside-subfolder',
194 },
195 {
196 description: 'Navigating to a route inside a route group inside a layout',
197 testId: 'link-to-route-inside-group-inside-layout',
198 },
199 {
200 description: 'Navigating to a lazy route inside a route group',
201 testId: 'link-to-lazy-route-inside-group',
202 },
203​
204 {
205 description: 'Navigating to the only route inside a route group ',
206 testId: 'link-to-only-route-inside-group',
207 },
209​
210testCases.forEach(({ description, testId }) => {
211 test(description, async ({ page }) => {
212 await page.getByTestId(testId).click()
213 await expect(page.getByTestId('search-via-hook')).toContainText('world')
214 await expect(page.getByTestId('search-via-route-hook')).toContainText(
215 'world',
216 )
217 await expect(page.getByTestId('search-via-route-api')).toContainText(
218 'world',
219 )
220 })
221})
222​
223test('navigating to an unnested route', async ({ page }) => {
224 const postId = 'hello-world'
225 page.goto(`/posts/${postId}/edit`)
226 await expect(page.getByTestId('params-via-hook')).toContainText(postId)
227 await expect(page.getByTestId('params-via-route-hook')).toContainText(postId)
228 await expect(page.getByTestId('params-via-route-api')).toContainText(postId)
229})
230​
231async function getRenderCount(page: Page) {
232 const renderCount = parseInt(
233 await page.getByTestId('render-count').innerText(),
234 )
235 return renderCount
237async function structuralSharingTest(page: Page, enabled: boolean) {
238 page.goto(`/structural-sharing/${enabled}/?foo=f1&bar=b1`)
239 await expect(page.getByTestId('enabled')).toHaveText(JSON.stringify(enabled))
240​
241 async function checkSearch({ foo, bar }: { foo: string; bar: string }) {
242 expect(page.url().endsWith(`?foo=${foo}&bar=${bar}`)).toBe(true)
243 const expectedSearch = JSON.stringify({ values: [foo, bar] })
244 await expect(page.getByTestId('search-via-hook')).toHaveText(expectedSearch)
245 await expect(page.getByTestId('search-via-route-hook')).toHaveText(
246 expectedSearch,
247 )
248 await expect(page.getByTestId('search-via-route-api-hook')).toHaveText(
249 expectedSearch,
250 )
251 }
252​
253 await checkSearch({ bar: 'b1', foo: 'f1' })
254 await page.getByTestId('link').click()
255 await checkSearch({ bar: 'b2', foo: 'f2' })
257​
258test('Should change title on client side navigation', async ({ page }) => {
259 await page.goto('/')
260​
261 await page.getByRole('link', { name: 'Posts' }).click()
262​
263 await expect(page).toHaveTitle('Posts page')
264})
265​
266test('Should change post navigating back and forth', async ({ page }) => {
267 await page.goto('/posts/1')
268 await page.getByRole('link', { name: 'sunt aut facere repe' }).click()
269​
270 await page.getByRole('link', { name: 'qui est esse' }).click()
271 await expect(page.getByTestId('post-title')).toContainText('qui est esse')
272​
273 await page.getByRole('link', { name: 'sunt aut facere repe' }).click()
274 await expect(page.getByTestId('post-title')).toContainText('sunt aut facere')
275})
276​
277test('Should not remount deps when remountDeps does not change ', async ({
278 page,
279}) => {
280 await page.goto('/notRemountDeps')
281 await expect(page.getByTestId('component-mounts')).toContainText(
282 'Page component mounts: 1',
283 )
284 await page.getByRole('button', { name: 'Regenerate search param' }).click()
285 await expect(page.getByTestId('component-mounts')).toContainText(
286 'Page component mounts: 1',
287 )
288 await page.getByRole('button', { name: 'Regenerate search param' }).click()
289 await expect(page.getByTestId('component-mounts')).toContainText(
290 'Page component mounts: 1',
291 )
292})
293​
294test('Should remount deps when remountDeps does change ', async ({ page }) => {
295 await page.goto('/remountDeps')
296 await expect(page.getByTestId('component-mounts')).toContainText(
297 'Page component mounts: 1',
298 )
299 await page.getByRole('button', { name: 'Regenerate search param' }).click()
300 await expect(page.getByTestId('component-mounts')).toContainText(
301 'Page component mounts: 2',
302 )
303 await page.getByRole('button', { name: 'Regenerate search param' }).click()
304 await expect(page.getByTestId('component-mounts')).toContainText(
305 'Page component mounts: 3',
306 )
307})
308​
309test.describe('Unicode route rendering', () => {
310 test('should render non-latin route correctly', async ({ page, baseURL }) => {
311 await page.goto('/λŒ€ν•œλ―Όκ΅­')
312​
313 await expect(page.locator('body')).toContainText('Hello "/λŒ€ν•œλ―Όκ΅­"!')
314​
315 expect(page.url()).toBe(`${baseURL}/%EB%8C%80%ED%95%9C%EB%AF%BC%EA%B5%AD`)
316 })
317})