Open History to see the last commit
1import * as fs from 'node:fs'
2import { expect } from '@playwright/test'
3import { test } from '@tanstack/router-e2e-utils'
4import { PORT } from '../playwright.config'
5import type { Page } from '@playwright/test'
6β
7test('Server function URLs correctly include constant ids', async ({
8 page,
9}) => {
10 for (const currentPage of ['/submit-post-formdata', '/formdata-redirect']) {
11 await page.goto(currentPage)
12 await page.waitForLoadState('networkidle')
13β
14 const form = page.locator('form')
15 const actionUrl = await form.getAttribute('action')
16β
17 expect(actionUrl).toMatch(/^\/_serverFn\/constant_id/)
18 }
19})
20β
21test('invoking a server function with custom response status code', async ({
22 page,
23}) => {
24 await page.goto('/status')
25β
26 await page.waitForLoadState('networkidle')
27β
28 const requestPromise = new Promise<void>((resolve) => {
29 page.on('response', (response) => {
30 expect(response.status()).toBe(225)
31 expect(response.statusText()).toBe('hello')
32 expect(response.headers()['content-type']).toContain('application/json')
33 resolve()
34 })
35 })
36 await page.getByTestId('invoke-server-fn').click()
37 await requestPromise
38})
39β
40test('Consistent server function returns both on client and server for GET and POST calls', async ({
41 page,
42}) => {
43 await page.goto('/consistent')
44β
45 await page.waitForLoadState('networkidle')
46 const expected =
47 (await page
48 .getByTestId('expected-consistent-server-fns-result')
49 .textContent()) || ''
50 expect(expected).not.toBe('')
51β
52 await page.getByTestId('test-consistent-server-fn-calls-btn').click()
53 await page.waitForLoadState('networkidle')
54β
55 // GET calls
56 await expect(page.getByTestId('cons_serverGetFn1-response')).toContainText(
57 expected,
58 )
59 await expect(page.getByTestId('cons_getFn1-response')).toContainText(expected)
60β
61 // POST calls
62 await expect(page.getByTestId('cons_serverPostFn1-response')).toContainText(
63 expected,
64 )
65 await expect(page.getByTestId('cons_postFn1-response')).toContainText(
66 expected,
67 )
68})
69β
70test('submitting multipart/form-data as server function input', async ({
71 page,
72}) => {
73 await page.goto('/multipart')
74β
75 await page.waitForLoadState('networkidle')
76 const expected =
77 (await page
78 .getByTestId('expected-multipart-server-fn-result')
79 .textContent()) || ''
80 expect(expected).not.toBe('')
81β
82 const fileChooserPromise = page.waitForEvent('filechooser')
83 await page.getByTestId('multipart-form-file-input').click()
84 const fileChooser = await fileChooserPromise
85 await fileChooser.setFiles({
86 name: 'my_file.txt',
87 mimeType: 'text/plain',
88 buffer: Buffer.from('test data', 'utf-8'),
89 })
90 await page.getByText('Submit (onClick)').click()
91 await page.waitForLoadState('networkidle')
92β
93 await expect(page.getByTestId('multipart-form-response')).toContainText(
94 expected,
95 )
96})
97β
98test('isomorphic functions can have different implementations on client and server', async ({
99 page,
100}) => {
101 await page.goto('/isomorphic-fns')
102β
103 await page.waitForLoadState('networkidle')
104β
105 await page.getByTestId('test-isomorphic-results-btn').click()
106 await page.waitForLoadState('networkidle')
107β
108 await expect(page.getByTestId('server-result')).toContainText('server')
109 await expect(page.getByTestId('client-result')).toContainText('client')
110 await expect(page.getByTestId('ssr-result')).toContainText('server')
111β
112 await expect(page.getByTestId('server-echo-result')).toContainText(
113 'server received hello',
114 )
115 await expect(page.getByTestId('client-echo-result')).toContainText(
116 'client received hello',
117 )
118})
119β
120test('env-only functions can only be called on the server or client respectively', async ({
121 page,
122}) => {
123 await page.goto('/env-only')
124β
125 await page.waitForLoadState('networkidle')
126β
127 await page.getByTestId('test-env-only-results-btn').click()
128 await page.waitForLoadState('networkidle')
129β
130 await expect(page.getByTestId('server-on-server')).toContainText(
131 'server got: hello',
132 )
133 await expect(page.getByTestId('server-on-client')).toContainText(
134 'serverEcho threw an error: createServerOnlyFn() functions can only be called on the server!',
135 )
136β
137 await expect(page.getByTestId('client-on-server')).toContainText(
138 'clientEcho threw an error: createClientOnlyFn() functions can only be called on the client!',
139 )
140 await expect(page.getByTestId('client-on-client')).toContainText(
141 'client got: hello',
142 )
143})
144β
145test('Server function can return null for GET and POST calls', async ({
146 page,
147}) => {
148 await page.goto('/return-null')
149β
150 await page.waitForLoadState('networkidle')
151 await page.getByTestId('test-allow-server-fn-return-null-btn').click()
152 await page.waitForLoadState('networkidle')
153β
154 // GET call
155 await expect(
156 page.getByTestId('allow_return_null_getFn-response'),
157 ).toContainText(JSON.stringify(null))
158β
159 // POST call
160 await expect(
161 page.getByTestId('allow_return_null_postFn-response'),
162 ).toContainText(JSON.stringify(null))
163})
164β
165test('Server function can correctly send and receive FormData', async ({
166 page,
167}) => {
168 await page.goto('/serialize-form-data')
169β
170 await page.waitForLoadState('networkidle')
171 const expected =
172 (await page
173 .getByTestId('expected-serialize-formdata-server-fn-result')
174 .textContent()) || ''
175 expect(expected).not.toBe('')
176β
177 await page.getByTestId('test-serialize-formdata-fn-calls-btn').click()
178 await page.waitForLoadState('networkidle')
179β
180 await expect(
181 page.getByTestId('serialize-formdata-form-response'),
182 ).toContainText(expected)
183})
184β
185test('server function can correctly send and receive headers', async ({
186 page,
187}) => {
188 await page.goto('/headers')
189β
190 await page.waitForLoadState('networkidle')
191 let headers = JSON.parse(
192 await page.getByTestId('initial-headers-result').innerText(),
193 )
194 expect(headers['host']).toBe(`localhost:${PORT}`)
195 expect(headers['user-agent']).toContain('Mozilla/5.0')
196 expect(headers['sec-fetch-mode']).toBe('navigate')
197β
198 await page.getByTestId('test-headers-btn').click()
199 await page.waitForSelector('[data-testid="updated-headers-result"]')
200β
201 headers = JSON.parse(
202 await page.getByTestId('updated-headers-result').innerText(),
203 )
204β
205 expect(headers['host']).toBe(`localhost:${PORT}`)
206 expect(headers['user-agent']).toContain('Mozilla/5.0')
207 expect(headers['sec-fetch-mode']).toBe('cors')
208 expect(headers['referer']).toBe(`http://localhost:${PORT}/headers`)
209})
210β
211test('Direct POST submitting FormData to a Server function returns the correct message', async ({
212 page,
213}) => {
214 await page.goto('/submit-post-formdata')
215β
216 await page.waitForLoadState('networkidle')
217β
218 const expected =
219 (await page
220 .getByTestId('expected-submit-post-formdata-server-fn-result')
221 .textContent()) || ''
222 expect(expected).not.toBe('')
223β
224 await page.getByTestId('test-submit-post-formdata-fn-calls-btn').click()
225 await page.waitForLoadState('networkidle')
226β
227 const result = await page.innerText('body')
228 expect(result).toBe(expected)
229})
230β
231test("server function's dead code is preserved if already there", async ({
232 page,
233}) => {
234 await page.goto('/dead-code-preserve')
235β
236 await page.waitForLoadState('networkidle')
237 await page.getByTestId('test-dead-code-fn-call-btn').click()
238 await page.waitForLoadState('networkidle')
239β
240 await expect(page.getByTestId('dead-code-fn-call-response')).toContainText(
241 '1',
242 )
243β
244 await fs.promises.rm('count-effect.txt')
245})
246β
247test.describe('server function sets cookies', () => {
248 async function runCookieTest(page: Page, expectedCookieValue: string) {
249 for (let i = 1; i <= 4; i++) {
250 const key = `cookie-${i}-${expectedCookieValue}`
251β
252 const actualValue = await page.getByTestId(key).textContent()
253 expect(actualValue).toBe(expectedCookieValue)
254 }
255 }
256 test('SSR', async ({ page }) => {
257 const expectedCookieValue = `SSR-${Date.now()}`
258 await page.goto(`/cookies/set?value=${expectedCookieValue}`)
259 await runCookieTest(page, expectedCookieValue)
260 })
261β
262 test('client side navigation', async ({ page }) => {
263 const expectedCookieValue = `CLIENT-${Date.now()}`
264 await page.goto(`/cookies?value=${expectedCookieValue}`)
265 await page.getByTestId('link-to-set').click()
266 await runCookieTest(page, expectedCookieValue)
267 })
268})
269;['GET', 'POST'].forEach((method) => {
270 test.describe(`aborting a server function call: method ${method}`, () => {
271 test('without aborting', async ({ page }) => {
272 await page.goto('/abort-signal/' + method)
273β
274 await page.waitForLoadState('networkidle')
275β
276 await page.getByTestId('run-without-abort-btn').click()
277 await page.waitForLoadState('networkidle')
278 await page.waitForSelector(
279 '[data-testid="result"]:has-text("server function result")',
280 )
281 await page.waitForSelector(
282 '[data-testid="errorMessage"]:has-text("$undefined")',
283 )
284β
285 const result = (await page.getByTestId('result').textContent()) || ''
286 expect(result).toBe('server function result')
287β
288 const errorMessage =
289 (await page.getByTestId('errorMessage').textContent()) || ''
290 expect(errorMessage).toBe('$undefined')
291 })
292β
293 test('aborting', async ({ page }) => {
294 await page.goto('/abort-signal/' + method)
295 await page.waitForLoadState('networkidle')
296β
297 await page.getByTestId('run-with-abort-btn').click()
298 await page.waitForLoadState('networkidle')
299 await page.waitForSelector(
300 '[data-testid="result"]:has-text("$undefined")',
301 )
302 await page.waitForSelector(
303 '[data-testid="errorMessage"]:has-text("aborted")',
304 )
305β
306 const result = (await page.getByTestId('result').textContent()) || ''
307 expect(result).toBe('$undefined')
308β
309 const errorMessage =
310 (await page.getByTestId('errorMessage').textContent()) || ''
311 expect(errorMessage).toContain('abort')
312 })
313 })
314})
315β
316test('raw response', async ({ page }) => {
317 await page.goto('/raw-response')
318β
319 await page.waitForLoadState('networkidle')
320β
321 const expectedValue = (await page.getByTestId('expected').textContent()) || ''
322 expect(expectedValue).not.toBe('')
323β
324 await page.getByTestId('button').click()
325 await page.waitForLoadState('networkidle')
326β
327 await expect(page.getByTestId('response')).toContainText(expectedValue)
328})
329β
330test.describe('formdata redirect modes', () => {
331 for (const mode of ['js', 'no-js']) {
332 test(`Server function can redirect when sending formdata: mode = ${mode}`, async ({
333 page,
334 }) => {
335 await page.goto('/formdata-redirect?mode=' + mode)
336β
337 await page.waitForLoadState('networkidle')
338 const expected =
339 (await page
340 .getByTestId('expected-submit-post-formdata-server-fn-result')
341 .textContent()) || ''
342 expect(expected).not.toBe('')
343β
344 await page.getByTestId('test-submit-post-formdata-fn-calls-btn').click()
345β
346 await page.waitForLoadState('networkidle')
347β
348 await expect(
349 page.getByTestId('formdata-redirect-target-name'),
350 ).toContainText(expected)
351β
352 expect(page.url().endsWith(`/formdata-redirect/target/${expected}`))
353 })
354 }
355})
356β
357test.describe('middleware', () => {
358 test.describe('client middleware should have access to router context via the router instance', () => {
359 async function runTest(page: Page) {
360 await page.waitForLoadState('networkidle')
361β
362 const expected =
363 (await page.getByTestId('expected-server-fn-result').textContent()) ||
364 ''
365 expect(expected).not.toBe('')
366β
367 await page.getByTestId('btn-serverFn').click()
368 await page.waitForLoadState('networkidle')
369 await expect(page.getByTestId('serverFn-loader-result')).toContainText(
370 expected,
371 )
372 await expect(page.getByTestId('serverFn-client-result')).toContainText(
373 expected,
374 )
375 }
376β
377 test('direct visit', async ({ page }) => {
378 await page.goto('/middleware/client-middleware-router')
379 await runTest(page)
380 })
381β
382 test('client navigation', async ({ page }) => {
383 await page.goto('/middleware')
384 await page.getByTestId('client-middleware-router-link').click()
385 await runTest(page)
386 })
387 })
388β
389 test('server function in combination with request middleware', async ({
390 page,
391 }) => {
392 await page.goto('/middleware/request-middleware')
393β
394 await page.waitForLoadState('networkidle')
395β
396 async function checkEqual(prefix: string) {
397 const requestParam = await page
398 .getByTestId(`${prefix}-data-request-param`)
399 .textContent()
400 expect(requestParam).not.toBe('')
401 const requestFunc = await page
402 .getByTestId(`${prefix}-data-request-func`)
403 .textContent()
404 expect(requestParam).toBe(requestFunc)
405 }
406β
407 await checkEqual('loader')
408β
409 await page.getByTestId('client-call-button').click()
410 await page.waitForLoadState('networkidle')
411β
412 await checkEqual('client')
413 })
414})
415β
416test('factory', async ({ page }) => {
417 await page.goto('/factory')
418β
419 await expect(page.getByTestId('factory-route-component')).toBeInViewport()
420β
421 const buttons = await page
422 .locator('[data-testid^="btn-fn-"]')
423 .elementHandles()
424 for (const button of buttons) {
425 const testId = await button.getAttribute('data-testid')
426β
427 if (!testId) {
428 throw new Error('Button is missing data-testid')
429 }
430β
431 const suffix = testId.replace('btn-fn-', '')
432β
433 const expected =
434 (await page.getByTestId(`expected-fn-result-${suffix}`).textContent()) ||
435 ''
436 expect(expected).not.toBe('')
437β
438 await button.click()
439β
440 await expect(page.getByTestId(`fn-result-${suffix}`)).toContainText(
441 expected,
442 )
443β
444 await expect(page.getByTestId(`fn-comparison-${suffix}`)).toContainText(
445 'equal',
446 )
447 }
448})
449β
450test('primitives', async ({ page }) => {
451 await page.goto('/primitives')
452β
453 await page.waitForLoadState('networkidle')
454β
455 // Wait for client-side hydration to complete
456 await expect(page.locator('[data-testid^="expected-"]').first()).toBeVisible()
457β
458 const testCases = await page
459 .locator('[data-testid^="expected-"]')
460 .elementHandles()
461 expect(testCases.length).not.toBe(0)
462β
463 for (const testCase of testCases) {
464 const testId = await testCase.getAttribute('data-testid')
465β
466 if (!testId) {
467 throw new Error('testcase is missing data-testid')
468 }
469β
470 const suffix = testId.replace('expected-', '')
471β
472 const expected =
473 (await page.getByTestId(`expected-${suffix}`).textContent()) || ''
474 expect(expected).not.toBe('')
475β
476 await expect(page.getByTestId(`result-${suffix}`)).toContainText(expected)
477 }
478})
479β
480test('redirect in server function on direct navigation', async ({ page }) => {
481 // Test direct navigation to a route with a server function that redirects
482 await page.goto('/redirect-test')
483β
484 // Should redirect to target page
485 await expect(page.getByTestId('redirect-target')).toBeVisible()
486 expect(page.url()).toContain('/redirect-test/target')
487})
488β
489test('redirect in server function called in query during SSR', async ({
490 page,
491}) => {
492 // Test direct navigation to a route with a server function that redirects
493 // when called inside a query with ssr: true
494 await page.goto('/redirect-test-ssr')
495β
496 // Should redirect to target page
497 await expect(page.getByTestId('redirect-target-ssr')).toBeVisible()
498 expect(page.url()).toContain('/redirect-test-ssr/target')
499})
500β
501test('server function is called with correct method option', async ({
502 page,
503}) => {
504 await page.goto('/function-method', { waitUntil: 'networkidle' })
505β
506 await expect(page.getByTestId('method-route-component')).toBeInViewport()
507β
508 const buttons = await page
509 .locator('[data-testid^="btn-fn-"]')
510 .elementHandles()
511 for (const button of buttons) {
512 const testId = await button.getAttribute('data-testid')
513β
514 if (!testId) {
515 throw new Error('Button is missing data-testid')
516 }
517β
518 const suffix = testId.replace('btn-fn-', '')
519β
520 const expected =
521 (await page.getByTestId(`expected-fn-result-${suffix}`).textContent()) ||
522 ''
523 expect(expected).not.toBe('')
524β
525 await button.click()
526β
527 await expect(page.getByTestId(`fn-result-${suffix}`)).toContainText(
528 expected,
529 )
530β
531 await expect(page.getByTestId(`fn-comparison-${suffix}`)).toContainText(
532 'equal',
533 )
534 }
535})
536β
537test('server function receives serverFnMeta in options', async ({ page }) => {
538 // This test verifies that:
539 // 1. Server functions receive `serverFnMeta` with full { id, name, filename }
540 // 2. No1 works even when the said server function is called from another server function
541β
542 await page.goto('/function-metadata', { waitUntil: 'networkidle' })
543β
544 await expect(page.getByTestId('metadata-route-component')).toBeInViewport()
545β
546 // Test for no1
547 const loaderNormalGet = await page
548 .getByTestId('loader-normal-get-function-metadata')
549 .textContent()
550 const loaderNormalPost = await page
551 .getByTestId('loader-normal-post-function-metadata')
552 .textContent()
553β
554 // stringified metadata should not be empty string
555 expect(loaderNormalGet).toBeTruthy()
556 // metadata should have `id`, `name`, and `filename` property, with all of them being a non-empty string
557 const normalGetMetadata = JSON.parse(loaderNormalGet!)
558 expect(normalGetMetadata).toHaveProperty('id')
559 expect(normalGetMetadata).toHaveProperty('name')
560 expect(normalGetMetadata).toHaveProperty('filename')
561 expect(typeof normalGetMetadata.id).toBe('string')
562 expect(normalGetMetadata.id.length).toBeGreaterThan(0)
563 expect(typeof normalGetMetadata.name).toBe('string')
564 expect(normalGetMetadata.name.length).toBeGreaterThan(0)
565 expect(typeof normalGetMetadata.filename).toBe('string')
566 expect(normalGetMetadata.filename.length).toBeGreaterThan(0)
567β
568 // stringified metadata should not be empty string
569 expect(loaderNormalPost).toBeTruthy()
570 // metadata should have `id`, `name`, and `filename` property, with all of them being a non-empty string
571 const normalPostMetadata = JSON.parse(loaderNormalPost!)
572 expect(normalPostMetadata).toHaveProperty('id')
573 expect(normalPostMetadata).toHaveProperty('name')
574 expect(normalPostMetadata).toHaveProperty('filename')
575 expect(typeof normalPostMetadata.id).toBe('string')
576 expect(normalPostMetadata.id.length).toBeGreaterThan(0)
577 expect(typeof normalPostMetadata.name).toBe('string')
578 expect(normalPostMetadata.name.length).toBeGreaterThan(0)
579 expect(typeof normalPostMetadata.filename).toBe('string')
580 expect(normalPostMetadata.filename.length).toBeGreaterThan(0)
581β
582 // Test for no2
583 const loaderNestingGet = await page
584 .getByTestId('loader-nesting-get-function-metadata')
585 .textContent()
586 const loaderNestingPost = await page
587 .getByTestId('loader-nesting-post-function-metadata')
588 .textContent()
589β
590 // metadata should have `id`, `name`, and `filename` property, with all of them being a non-empty string
591 const nestingGetMetadata = JSON.parse(loaderNestingGet!)
592 expect(nestingGetMetadata).toHaveProperty('meta.id')
593 expect(nestingGetMetadata).toHaveProperty('meta.name')
594 expect(nestingGetMetadata).toHaveProperty('meta.filename')
595 expect(typeof nestingGetMetadata.meta.id).toBe('string')
596 expect(nestingGetMetadata.meta.id.length).toBeGreaterThan(0)
597 expect(typeof nestingGetMetadata.meta.name).toBe('string')
598 expect(nestingGetMetadata.meta.name.length).toBeGreaterThan(0)
599 expect(typeof nestingGetMetadata.meta.filename).toBe('string')
600 expect(nestingGetMetadata.meta.filename.length).toBeGreaterThan(0)
601 expect(nestingGetMetadata).toHaveProperty('inner.get.id')
602 expect(nestingGetMetadata).toHaveProperty('inner.get.name')
603 expect(nestingGetMetadata).toHaveProperty('inner.get.filename')
604 expect(nestingGetMetadata.inner.get.id.length).toBeGreaterThan(0)
605 expect(nestingGetMetadata.inner.get.name.length).toBeGreaterThan(0)
606 expect(nestingGetMetadata.inner.get.filename.length).toBeGreaterThan(0)
607 expect(nestingGetMetadata).toHaveProperty('inner.post.id')
608 expect(nestingGetMetadata).toHaveProperty('inner.post.name')
609 expect(nestingGetMetadata).toHaveProperty('inner.post.filename')
610 expect(nestingGetMetadata.inner.post.id.length).toBeGreaterThan(0)
611 expect(nestingGetMetadata.inner.post.name.length).toBeGreaterThan(0)
612 expect(nestingGetMetadata.inner.post.filename.length).toBeGreaterThan(0)
613β
614 // metadata should have `id`, `name`, and `filename` property, with all of them being a non-empty string
615 const nestingPostMetadata = JSON.parse(loaderNestingPost!)
616 expect(nestingPostMetadata).toHaveProperty('meta.id')
617 expect(nestingPostMetadata).toHaveProperty('meta.name')
618 expect(nestingPostMetadata).toHaveProperty('meta.filename')
619 expect(typeof nestingPostMetadata.meta.id).toBe('string')
620 expect(nestingPostMetadata.meta.id.length).toBeGreaterThan(0)
621 expect(typeof nestingPostMetadata.meta.name).toBe('string')
622 expect(nestingPostMetadata.meta.name.length).toBeGreaterThan(0)
623 expect(typeof nestingPostMetadata.meta.filename).toBe('string')
624 expect(nestingPostMetadata.meta.filename.length).toBeGreaterThan(0)
625 expect(nestingPostMetadata).toHaveProperty('inner.get.id')
626 expect(nestingPostMetadata).toHaveProperty('inner.get.name')
627 expect(nestingPostMetadata).toHaveProperty('inner.get.filename')
628 expect(nestingPostMetadata.inner.get.id.length).toBeGreaterThan(0)
629 expect(nestingPostMetadata.inner.get.name.length).toBeGreaterThan(0)
630 expect(nestingPostMetadata.inner.get.filename.length).toBeGreaterThan(0)
631 expect(nestingPostMetadata).toHaveProperty('inner.post.id')
632 expect(nestingPostMetadata).toHaveProperty('inner.post.name')
633 expect(nestingPostMetadata).toHaveProperty('inner.post.filename')
634 expect(nestingPostMetadata.inner.post.id.length).toBeGreaterThan(0)
635 expect(nestingPostMetadata.inner.post.name.length).toBeGreaterThan(0)
636 expect(nestingPostMetadata.inner.post.filename.length).toBeGreaterThan(0)
637})