Open History to see the last commit
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 },
208]
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
236}
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' })
256}
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})