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

migration.spec.ts

163 lines6.1 KB

1import { expect, test } from '@playwright/test'
2​
3test('public URLs, server metadata, search, redirects, and missing pages survive migration', async ({
4 page,
5 request,
6}) => {
7 const response = await request.get('/posts/keeping-your-urls')
8 expect(response.status()).toBe(200)
9 const html = await response.text()
10 expect(html).toContain('<title>Keeping your URLs</title>')
11 expect(html).toMatch(
12 /<meta[^>]+name="description"[^>]+content="Preserve public URLs when changing frameworks\."/,
13 )
14 expect(html).toMatch(
15 /<link[^>]+rel="canonical"[^>]+href="https:\/\/field-notes\.example\/posts\/keeping-your-urls"/,
16 )
17 expect(html).toMatch(
18 /<meta[^>]+property="og:title"[^>]+content="Keeping your URLs"/,
19 )
20 expect(html).toContain(
21 'A framework migration can keep the URLs your readers already use.',
22 )
23​
24 const old = await request.get('/old-notes', { maxRedirects: 0 })
25 expect(old.status()).toBe(308)
26 expect(new URL(old.headers().location, old.url()).pathname).toBe(
27 '/posts/keeping-your-urls',
28 )
29 expect((await request.get('/posts/missing')).status()).toBe(404)
30 const sitemap = await (await request.get('/sitemap.xml')).text()
31 expect(sitemap).toContain(
32 '<loc>https://field-notes.example/posts/keeping-your-urls</loc>',
33 )
34 expect(sitemap).not.toContain('/saved')
35​
36 await page.goto('/?q=metadata')
37 await expect(
38 page.getByRole('link', { name: 'Checking your metadata' }),
39 ).toBeVisible()
40 await expect(
41 page.getByRole('link', { name: 'Keeping your URLs' }),
42 ).toHaveCount(0)
43 await page.getByRole('link', { name: 'Checking your metadata' }).click()
44 await expect(page).toHaveURL(/\/posts\/checking-your-metadata$/)
45 await expect(page).toHaveTitle('Checking your metadata')
46 await expect(page.locator('link[rel="canonical"]')).toHaveAttribute(
47 'href',
48 'https://field-notes.example/posts/checking-your-metadata',
49 )
50})
51​
52test('sessions and protected mutations survive reload but cannot run after sign-out', async ({
53 page,
54}, testInfo) => {
55 await page.goto('/saved')
56 await expect(page).toHaveURL(/\/login$/)
57 await page.getByLabel('Email', { exact: true }).fill('reader@example.com')
58 await page.getByLabel('Password', { exact: true }).fill('wrong-password')
59 await page.getByRole('button', { name: 'Sign in', exact: true }).click()
60 await expect(page.getByRole('main').getByRole('alert')).toHaveText(
61 'Invalid credentials',
62 )
63 await page.getByLabel('Email', { exact: true }).fill('reader@example.com')
64 await page
65 .getByLabel('Password', { exact: true })
66 .fill('migration-test-password')
67 await page.getByRole('button', { name: 'Sign in', exact: true }).click()
68 await expect(page).toHaveURL(/\/saved$/)
69 await expect(page.getByTestId('saved-state')).toHaveText('No saved articles')
70 const mutation = page.waitForRequest((request) => request.method() === 'POST')
71 await page.getByRole('button', { name: 'Save article', exact: true }).click()
72 const savedRequest = await mutation
73 await expect(page.getByTestId('saved-state')).toHaveText(
74 'Keeping your URLs is saved',
75 )
76 // Keep the authenticated cookie jar while replaying a cross-site request.
77 const crossSiteHeaders = await savedRequest.allHeaders()
78 delete crossSiteHeaders.cookie
79 delete crossSiteHeaders['content-length']
80 crossSiteHeaders.origin = 'https://untrusted.example'
81 crossSiteHeaders['sec-fetch-site'] = 'cross-site'
82 const crossSite = await page.request.post(savedRequest.url(), {
83 headers: crossSiteHeaders,
84 data: savedRequest.postData() ?? '',
85 })
86 if (testInfo.project.name === 'start') {
87 expect(crossSite.status()).toBe(403)
88 } else {
89 expect(crossSite.status()).toBeGreaterThanOrEqual(400)
90 }
91​
92 const response = await page.reload()
93 expect(response?.headers()['cache-control']).toMatch(
94 process.env.MIGRATION_PRODUCTION ? /no-store/ : /no-store|no-cache/,
95 )
96 await expect(page.getByTestId('saved-state')).toHaveText(
97 'Keeping your URLs is saved',
98 )
99 await page.getByRole('button', { name: 'Sign out', exact: true }).click()
100 await expect(page).toHaveURL(/\/login$/)
101​
102 // Replay the real mutation with the now-signed-out browser cookie jar.
103 const headers = await savedRequest.allHeaders()
104 delete headers.cookie
105 delete headers['content-length']
106 const denied = await page.request.post(savedRequest.url(), {
107 headers,
108 data: savedRequest.postData() ?? '',
109 })
110 expect(denied.status()).toBeGreaterThanOrEqual(400)
111 await page.goto('/saved')
112 await expect(page).toHaveURL(/\/login$/)
113})
114​
115test('Start serializes saving and signing out so their responses cannot arrive out of order', async ({
116 page,
117}, testInfo) => {
118 test.skip(testInfo.project.name !== 'start', 'Start event-handler regression')
119 await page.goto('/login')
120 await page.getByLabel('Email', { exact: true }).fill('reader@example.com')
121 await page
122 .getByLabel('Password', { exact: true })
123 .fill('migration-test-password')
124 await page.getByRole('button', { name: 'Sign in', exact: true }).click()
125 await expect(page).toHaveURL(/\/saved$/)
126​
127 for (const action of ['Save article', 'Sign out']) {
128 let release = () => {}
129 const held = new Promise<void>((resolve) => {
130 release = resolve
131 })
132 await page.route('**/_serverFn/**', async (route) => {
133 if (route.request().method() === 'POST') {
134 await held
135 }
136 await route.continue()
137 })
138 await page.getByRole('button', { name: action, exact: true }).click()
139 try {
140 await expect(
141 page.getByRole('button', { name: /^(Save|Remove) article$/ }),
142 ).toBeDisabled()
143 await expect(
144 page.getByRole('button', { name: 'Sign out', exact: true }),
145 ).toBeDisabled()
146 } finally {
147 release()
148 }
149 if (action === 'Save article') {
150 await expect(page.getByTestId('saved-state')).toHaveText(
151 'Keeping your URLs is saved',
152 )
153 await expect(
154 page.getByRole('button', { name: 'Sign out', exact: true }),
155 ).toBeEnabled()
156 } else {
157 await expect(page).toHaveURL(/\/login$/)
158 }
159 await page.unrouteAll({ behavior: 'wait' })
160 }
161 await page.goto('/saved')
162 await expect(page).toHaveURL(/\/login$/)
163})