File size: 10,281 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
/* eslint-env jest */
import path from 'path'
import cheerio from 'cheerio'
import { check, retry, withQuery } from 'next-test-utils'
import { nextTestSetup, FileRef } from 'e2e-utils'
import type { Response } from 'node-fetch'
describe('app-dir with middleware', () => {
const { next } = nextTestSetup({
files: __dirname,
})
it('should filter correctly after middleware rewrite', async () => {
const browser = await next.browser('/start')
await browser.eval('window.beforeNav = 1')
await browser.eval('window.next.router.push("/rewrite-to-app")')
await check(async () => {
return browser.eval('document.documentElement.innerHTML')
}, /app-dir/)
})
describe.each([
{
title: 'Serverless Functions',
path: '/api/dump-headers-serverless',
toJson: (res: Response) => res.json(),
},
{
title: 'Edge Functions',
path: '/api/dump-headers-edge',
toJson: (res: Response) => res.json(),
},
{
title: 'next/headers',
path: '/headers',
toJson: async (res: Response) => {
const $ = cheerio.load(await res.text())
return JSON.parse($('#headers').text())
},
},
])('Mutate request headers for $title', ({ path, toJson }) => {
it(`Adds new headers`, async () => {
const res = await next.fetch(path, {
headers: {
'x-from-client': 'hello-from-client',
},
})
expect(await toJson(res)).toMatchObject({
'x-from-client': 'hello-from-client',
'x-from-middleware': 'hello-from-middleware',
})
})
it(`Deletes headers`, async () => {
const res = await next.fetch(
withQuery(path, {
'remove-headers': 'x-from-client1,x-from-client2',
}),
{
headers: {
'x-from-client1': 'hello-from-client',
'X-From-Client2': 'hello-from-client',
},
}
)
const json = await toJson(res)
expect(json).not.toHaveProperty('x-from-client1')
expect(json).not.toHaveProperty('X-From-Client2')
expect(json).toMatchObject({
'x-from-middleware': 'hello-from-middleware',
})
// Should not be included in response headers.
expect(res.headers.get('x-middleware-override-headers')).toBeNull()
expect(
res.headers.get('x-middleware-request-x-from-middleware')
).toBeNull()
expect(res.headers.get('x-middleware-request-x-from-client1')).toBeNull()
expect(res.headers.get('x-middleware-request-x-from-client2')).toBeNull()
})
it(`Updates headers`, async () => {
const res = await next.fetch(
withQuery(path, {
'update-headers':
'x-from-client1=new-value1,x-from-client2=new-value2',
}),
{
headers: {
'x-from-client1': 'old-value1',
'X-From-Client2': 'old-value2',
'x-from-client3': 'old-value3',
},
}
)
expect(await toJson(res)).toMatchObject({
'x-from-client1': 'new-value1',
'x-from-client2': 'new-value2',
'x-from-client3': 'old-value3',
'x-from-middleware': 'hello-from-middleware',
})
// Should not be included in response headers.
expect(res.headers.get('x-middleware-override-headers')).toBeNull()
expect(
res.headers.get('x-middleware-request-x-from-middleware')
).toBeNull()
expect(res.headers.get('x-middleware-request-x-from-client1')).toBeNull()
expect(res.headers.get('x-middleware-request-x-from-client2')).toBeNull()
expect(res.headers.get('x-middleware-request-x-from-client3')).toBeNull()
})
it(`Supports draft mode`, async () => {
const res = await next.fetch(`${path}?draft=true`)
const headers: string = res.headers.get('set-cookie') || ''
const bypassCookie = headers
.split(';')
.find((c) => c.startsWith('__prerender_bypass'))
expect(bypassCookie).toBeDefined()
})
})
it('retains a link response header from the middleware', async () => {
const res = await next.fetch('/preloads')
expect(res.headers.get('link')).toContain(
'<https://example.com/page>; rel="alternate"; hreflang="en"'
)
})
it('should be possible to modify cookies & read them in an RSC in a single request', async () => {
const browser = await next.browser('/rsc-cookies')
const initialRandom1 = await browser.elementById('rsc-cookie-1').text()
const initialRandom2 = await browser.elementById('rsc-cookie-2').text()
const totalCookies = await browser.elementById('total-cookies').text()
// cookies were set in middleware, assert they are present and match the Math.random() pattern
expect(initialRandom1).toMatch(/Cookie 1: \d+\.\d+/)
expect(initialRandom2).toMatch(/Cookie 2: \d+\.\d+/)
expect(totalCookies).toBe('Total Cookie Length: 2')
await browser.refresh()
const refreshedRandom1 = await browser.elementById('rsc-cookie-1').text()
const refreshedRandom2 = await browser.elementById('rsc-cookie-2').text()
// the cookies should be refreshed and have new values
expect(refreshedRandom1).toMatch(/Cookie 1: \d+\.\d+/)
expect(refreshedRandom2).toMatch(/Cookie 2: \d+\.\d+/)
expect(refreshedRandom1).not.toBe(initialRandom1)
expect(refreshedRandom2).not.toBe(initialRandom2)
// navigate to delete cookies route
await browser.elementByCss('[href="/rsc-cookies-delete"]').click()
await retry(async () => {
// only the first cookie should be deleted
expect(await browser.elementById('rsc-cookie-1').text()).toBe('Cookie 1:')
expect(await browser.elementById('rsc-cookie-2').text()).toMatch(
/Cookie 2: \d+\.\d+/
)
})
// Cleanup
await browser.deleteCookies()
})
it('should respect cookie options of merged middleware cookies', async () => {
const browser = await next.browser('/rsc-cookies/cookie-options')
const totalCookies = await browser.elementById('total-cookies').text()
// a secure cookie was set in middleware
expect(totalCookies).toBe('Total Cookie Length: 1')
// we don't expect to be able to read it
expect(await browser.eval('document.cookie')).toBeFalsy()
await browser.elementById('submit-server-action').click()
await retry(async () => {
expect(await browser.elementById('action-result').text()).toMatch(
/Action Result: \d+\.\d+/
)
})
// ensure that we still can't read the secure cookie
expect(await browser.eval('document.cookie')).toBeFalsy()
// Cleanup
await browser.deleteCookies()
})
it('should omit internal headers for middleware cookies', async () => {
const response = await next.fetch('/rsc-cookies/cookie-options')
expect(response.status).toBe(200)
expect(response.headers.get('x-middleware-set-cookie')).toBeNull()
const response2 = await next.fetch('/cookies/api')
expect(response2.status).toBe(200)
expect(response2.headers.get('x-middleware-set-cookie')).toBeNull()
expect(response2.headers.get('set-cookie')).toBeDefined()
expect(response2.headers.get('set-cookie')).toContain('example')
})
it('should ignore x-middleware-set-cookie as a request header', async () => {
const $ = await next.render$(
'/cookies',
{},
{
headers: {
'x-middleware-set-cookie': 'test',
},
}
)
expect($('#cookies').text()).toBe('cookies: 0')
})
it('should be possible to read cookies that are set during the middleware handling of a server action', async () => {
const browser = await next.browser('/rsc-cookies')
const initialRandom1 = await browser.elementById('rsc-cookie-1').text()
const initialRandom2 = await browser.elementById('rsc-cookie-2').text()
const totalCookies = await browser.elementById('total-cookies').text()
// cookies were set in middleware, assert they are present and match the Math.random() pattern
expect(initialRandom1).toMatch(/Cookie 1: \d+\.\d+/)
expect(initialRandom2).toMatch(/Cookie 2: \d+\.\d+/)
expect(totalCookies).toBe('Total Cookie Length: 2')
expect(await browser.eval('document.cookie')).toBeTruthy()
await browser.deleteCookies()
// assert that document.cookie is empty
expect(await browser.eval('document.cookie')).toBeFalsy()
await browser.elementById('submit-server-action').click()
await retry(async () => {
expect(await browser.elementById('action-result').text()).toMatch(
/Action Result: \d+\.\d+/
)
})
await browser.deleteCookies()
})
})
describe('app dir - middleware without pages dir', () => {
const { next } = nextTestSetup({
files: {
app: new FileRef(path.join(__dirname, 'app')),
'next.config.js': new FileRef(path.join(__dirname, 'next.config.js')),
'middleware.js': `
import { NextResponse } from 'next/server'
export async function middleware(request) {
return new NextResponse('redirected')
}
export const config = {
matcher: '/headers'
}
`,
},
})
// eslint-disable-next-line jest/no-identical-title
it('Updates headers', async () => {
const html = await next.render('/headers')
expect(html).toContain('redirected')
})
})
describe('app dir - middleware with middleware in src dir', () => {
const { next } = nextTestSetup({
files: {
'src/app': new FileRef(path.join(__dirname, 'app')),
'next.config.js': new FileRef(path.join(__dirname, 'next.config.js')),
'src/middleware.js': `
import { NextResponse } from 'next/server'
import { cookies } from 'next/headers'
export async function middleware(request) {
const cookie = (await cookies()).get('test-cookie')
return NextResponse.json({ cookie })
}
`,
},
})
it('works without crashing when using RequestStore', async () => {
const browser = await next.browser('/')
await browser.addCookie({
name: 'test-cookie',
value: 'test-cookie-response',
})
await browser.refresh()
const html = await browser.eval('document.documentElement.innerHTML')
expect(html).toContain('test-cookie-response')
})
})
|