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

request-response.test.ts

205 lines6.7 KB

1import { describe, expect, it } from 'vitest'
2import {
3 getResponseHeader,
4 getResponseHeaders,
5 requestHandler,
6 setResponseHeader,
7 setResponseHeaders,
8} from '../src/request-response'
9​
10describe('setResponseHeaders', () => {
11 it('should set a single header via Headers object', async () => {
12 const headers = new Headers()
13 headers.set('X-Custom-Header', 'test-value')
14​
15 const handler = requestHandler(() => {
16 setResponseHeaders(headers)
17 const responseHeaders = getResponseHeaders()
18 expect(responseHeaders.get('X-Custom-Header')).toBe('test-value')
19 return new Response('OK')
20 })
21​
22 const request = new Request('http://localhost:3000/test')
23 await handler(request, {})
24 })
25​
26 it('should set multiple headers via Headers object', async () => {
27 const headers = new Headers()
28 headers.set('X-Custom-Header', 'test-value')
29 headers.set('X-Another-Header', 'another-value')
30 headers.set('Content-Type', 'application/json')
31​
32 const handler = requestHandler(() => {
33 setResponseHeaders(headers)
34 const responseHeaders = getResponseHeaders()
35 expect(responseHeaders.get('X-Custom-Header')).toBe('test-value')
36 expect(responseHeaders.get('X-Another-Header')).toBe('another-value')
37 expect(responseHeaders.get('Content-Type')).toBe('application/json')
38 return new Response('OK')
39 })
40​
41 const request = new Request('http://localhost:3000/test')
42 await handler(request, {})
43 })
44​
45 it('should handle empty Headers object', async () => {
46 const handler = requestHandler(() => {
47 const headers = new Headers()
48 setResponseHeaders(headers)
49 const responseHeaders = getResponseHeaders()
50 expect(responseHeaders).toBeDefined()
51 expect(Array.from(responseHeaders.entries()).length).toEqual(0)
52 return new Response('OK')
53 })
54​
55 const request = new Request('http://localhost:3000/test')
56 await handler(request, {})
57 })
58​
59 it('should preserve the live response headers when passed back to itself', async () => {
60 const cookies = ['session=abc123; Path=/', 'user=john; Path=/']
61 const handler = requestHandler(() => {
62 setResponseHeader('set-cookie', cookies)
63 setResponseHeader('x-custom', 'keep')
64 const headers = getResponseHeaders()
65 const entries = Array.from(headers)
66​
67 setResponseHeaders(headers)
68​
69 expect(getResponseHeaders()).toBe(headers)
70 expect(Array.from(headers)).toEqual(entries)
71 expect(headers.getSetCookie()).toEqual(cookies)
72 return new Response('OK')
73 })
74​
75 const response = await handler(
76 new Request('http://localhost:3000/test'),
77 {},
78 )
79 expect(response.headers.getSetCookie()).toEqual(cookies)
80 expect(response.headers.get('x-custom')).toBe('keep')
81 })
82​
83 it('should replace existing headers with the same name', async () => {
84 const handler = requestHandler(() => {
85 setResponseHeaders(
86 new Headers({
87 'X-Custom-Header': 'old-value',
88 }),
89 )
90 expect(getResponseHeader('X-Custom-Header')).toEqual('old-value')
91 setResponseHeaders(
92 new Headers({
93 'X-Custom-Header': 'new-value',
94 }),
95 )
96 expect(getResponseHeader('X-Custom-Header')).toEqual('new-value')
97​
98 return new Response('OK')
99 })
100​
101 const request = new Request('http://localhost:3000/test')
102 await handler(request, {})
103 })
104​
105 it('should handle multiple headers with the same name added via headers.append()', async () => {
106 const headers = new Headers()
107 headers.append('Set-Cookie', 'session=abc123; Path=/; HttpOnly')
108 headers.append('Set-Cookie', 'user=john; Path=/; Secure')
109​
110 const handler = requestHandler(() => {
111 setResponseHeaders(headers)
112​
113 // Set-Cookie values remain separate during Headers iteration.
114 const setCookieValue = getResponseHeader('Set-Cookie')
115​
116 expect(setCookieValue).toBeDefined()
117​
118 // Both cookie values should be present in the result
119 expect(setCookieValue).toContain('session=abc123')
120 expect(setCookieValue).toContain('user=john')
121 expect(getResponseHeaders().getSetCookie()).toEqual([
122 'session=abc123; Path=/; HttpOnly',
123 'user=john; Path=/; Secure',
124 ])
125​
126 return new Response('OK')
127 })
128​
129 const request = new Request('http://localhost:3000/test')
130 await handler(request, {})
131 })
132​
133 it.each(['constructor', '__proto__'])(
134 'should replace the %s header',
135 async (name) => {
136 const handler = requestHandler(() => {
137 setResponseHeader(name, 'old-value')
138 setResponseHeaders(new Headers([[name, 'new-value']]))
139 expect(getResponseHeader(name)).toBe('new-value')
140 return new Response('OK')
141 })
142​
143 await handler(new Request('http://localhost:3000/test'), {})
144 },
145 )
146​
147 it('should replace cookies on each call while preserving unrelated headers', async () => {
148 const cookies = [
149 'session=new; Expires=Wed, 21 Oct 2030 07:28:00 GMT; Path=/',
150 'user=john; Path=/',
151 'user=john; Path=/',
152 ] as const
153 const headers = new Headers([
154 ['X-Last', 'last'],
155 ['Set-Cookie', cookies[0]],
156 ['X-First', 'first'],
157 ['set-cookie', cookies[1]],
158 ['SET-COOKIE', cookies[2]],
159 ])
160 const handler = requestHandler(() => {
161 setResponseHeader('set-cookie', ['old=1', 'old=2'])
162 setResponseHeader('x-keep', 'keep')
163 setResponseHeaders(headers)
164​
165 expect(getResponseHeaders().getSetCookie()).toEqual(cookies)
166 expect(headers.getSetCookie()).toEqual(cookies)
167 expect(getResponseHeader('x-first')).toBe('first')
168 expect(getResponseHeader('x-last')).toBe('last')
169 expect(getResponseHeader('x-keep')).toBe('keep')
170​
171 setResponseHeaders(new Headers({ 'set-cookie': 'next=1' }))
172 expect(getResponseHeaders().getSetCookie()).toEqual(['next=1'])
173 expect(getResponseHeader('x-keep')).toBe('keep')
174​
175 setResponseHeaders(new Headers())
176 expect(getResponseHeaders().getSetCookie()).toEqual(['next=1'])
177 return new Response('OK')
178 })
179​
180 const response = await handler(
181 new Request('http://localhost:3000/test'),
182 {},
183 )
184 expect(response.headers.getSetCookie()).toEqual(['next=1'])
185 expect(response.headers.get('x-keep')).toBe('keep')
186 })
187​
188 it('should replace combined values for ordinary headers', async () => {
189 const handler = requestHandler(() => {
190 setResponseHeader('x-custom', 'old-value')
191 setResponseHeaders(
192 new Headers([
193 ['X-Custom', 'first'],
194 ['x-custom', 'second'],
195 ['x-empty', ''],
196 ]),
197 )
198 expect(getResponseHeader('x-custom')).toBe('first, second')
199 expect(getResponseHeaders().get('x-empty')).toBe('')
200 return new Response('OK')
201 })
202​
203 await handler(new Request('http://localhost:3000/test'), {})
204 })
205})