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

document-navigation.spec.ts

68 lines2.5 KB

1import { expect } from '@playwright/test'
2import { apiTest as test } from '@tanstack/router-e2e-utils'
3​
4const appPort = Number(process.env.E2E_APP_PORT ?? 0)
5const adminHref = `http://127.0.0.1:${appPort}/external.html`
6​
7for (const role of ['button', 'link'] as const) {
8 for (const { name, href, replace } of [
9 { name: 'Navigate to admin', href: adminHref, replace: false },
10 { name: 'Replace with admin', href: adminHref, replace: true },
11 { name: 'Reload admin', href: adminHref, replace: false },
12 { name: 'Navigate with external mask', href: adminHref, replace: false },
13 { name: 'Replace with external mask', href: adminHref, replace: true },
14 {
15 name: 'Navigate to absolute href',
16 href: `${adminHref}?value=a+b&value=a%20b#raw%2f`,
17 replace: false,
18 },
19 ]) {
20 test(`${role}: ${name}`, async ({ page }) => {
21 const errors: Array<Error> = []
22 page.on('pageerror', (error) => errors.push(error))
23 await page.goto('/')
24 await page.goto('/document-navigation')
25 const historyLength = await page.evaluate(() => window.history.length)
26 const response = page.waitForResponse(href.split('#')[0])
27​
28 const control = page.getByRole(role, { name, exact: true })
29 if (role === 'link') {
30 await expect(control).toHaveAttribute('href', href)
31 }
32 await control.click()
33​
34 expect((await response).request().isNavigationRequest()).toBe(true)
35 await expect(page).toHaveURL(href)
36 await expect(page.locator('body')).toHaveText('Hello World')
37 // Cross-origin Links use native anchors, which push even with replace=true.
38 const replacesHistory = role === 'button' && replace
39 expect(await page.evaluate(() => window.history.length)).toBe(
40 historyLength + (replacesHistory ? 0 : 1),
41 )
42 expect(errors).toEqual([])
43​
44 await page.goBack()
45​
46 await expect(page).toHaveURL(
47 replacesHistory ? '/' : '/document-navigation',
48 )
49 })
50 }
51​
52 test(`${role}: explicit reload resolves a raw relative href in the browser`, async ({
53 page,
54 }) => {
55 await page.goto('/document-navigation')
56 const response = page.waitForResponse((candidate) =>
57 candidate.request().isNavigationRequest(),
58 )
59​
60 await page
61 .getByRole(role, { name: 'Reload relative href', exact: true })
62 .click()
63​
64 expect((await response).request().resourceType()).toBe('document')
65 await expect(page).toHaveURL('/?value=a+b&value=a%20b#raw%2f')
66 await expect(page.getByRole('heading')).toContainText('Welcome Home!')
67 })