Unverified Commit 5791cb67 authored by Zack Tanner's avatar Zack Tanner Committed by GitHub

[Backport v14] add additional x-middleware-set-cookie filtering (#75561) (#75870)

Backports:
- #75561
- #73482

---------
Co-authored-by: 's avatarJJ Kasper <jj@jjsweb.site>
parent 8129a618
...@@ -41,6 +41,7 @@ import { getNextPathnameInfo } from '../../shared/lib/router/utils/get-next-path ...@@ -41,6 +41,7 @@ import { getNextPathnameInfo } from '../../shared/lib/router/utils/get-next-path
import { getHostname } from '../../shared/lib/get-hostname' import { getHostname } from '../../shared/lib/get-hostname'
import { detectDomainLocale } from '../../shared/lib/i18n/detect-domain-locale' import { detectDomainLocale } from '../../shared/lib/i18n/detect-domain-locale'
import { normalizedAssetPrefix } from '../../shared/lib/normalized-asset-prefix' import { normalizedAssetPrefix } from '../../shared/lib/normalized-asset-prefix'
import { filterInternalHeaders } from './server-ipc/utils'
const debug = setupDebug('next:router-server:main') const debug = setupDebug('next:router-server:main')
const isNextFont = (pathname: string | null) => const isNextFont = (pathname: string | null) =>
...@@ -149,6 +150,11 @@ export async function initialize(opts: { ...@@ -149,6 +150,11 @@ export async function initialize(opts: {
require('./render-server') as typeof import('./render-server') require('./render-server') as typeof import('./render-server')
const requestHandlerImpl: WorkerRequestHandler = async (req, res) => { const requestHandlerImpl: WorkerRequestHandler = async (req, res) => {
// internal headers should not be honored by the request handler
if (!process.env.NEXT_PRIVATE_TEST_HEADERS) {
filterInternalHeaders(req.headers)
}
if ( if (
!opts.minimalMode && !opts.minimalMode &&
config.i18n && config.i18n &&
......
...@@ -589,6 +589,14 @@ export function getResolveRoutes( ...@@ -589,6 +589,14 @@ export function getResolveRoutes(
) { ) {
continue continue
} }
// for set-cookie, the header shouldn't be added to the response
// as it's only needed for the request to the middleware function.
if (key === 'x-middleware-set-cookie') {
req.headers[key] = value
continue
}
if (value) { if (value) {
resHeaders[key] = value resHeaders[key] = value
req.headers[key] = value req.headers[key] = value
......
...@@ -36,3 +36,26 @@ export const filterReqHeaders = ( ...@@ -36,3 +36,26 @@ export const filterReqHeaders = (
} }
return headers as Record<string, undefined | string | string[]> return headers as Record<string, undefined | string | string[]>
} }
// These are headers that are only used internally and should
// not be honored from the external request
const INTERNAL_HEADERS = [
'x-middleware-rewrite',
'x-middleware-redirect',
'x-middleware-set-cookie',
'x-middleware-skip',
'x-middleware-override-headers',
'x-middleware-next',
'x-now-route-matches',
'x-matched-path',
]
export const filterInternalHeaders = (
headers: Record<string, undefined | string | string[]>
) => {
for (const header in headers) {
if (INTERNAL_HEADERS.includes(header)) {
delete headers[header]
}
}
}
...@@ -25,6 +25,11 @@ export async function sendResponse( ...@@ -25,6 +25,11 @@ export async function sendResponse(
// Copy over the response headers. // Copy over the response headers.
response.headers?.forEach((value, name) => { response.headers?.forEach((value, name) => {
// `x-middleware-set-cookie` is an internal header not needed for the response
if (name.toLowerCase() === 'x-middleware-set-cookie') {
return
}
// The append handling is special cased for `set-cookie`. // The append handling is special cased for `set-cookie`.
if (name.toLowerCase() === 'set-cookie') { if (name.toLowerCase() === 'set-cookie') {
// TODO: (wyattjoh) replace with native response iteration when we can upgrade undici // TODO: (wyattjoh) replace with native response iteration when we can upgrade undici
......
...@@ -174,6 +174,18 @@ createNextDescribe( ...@@ -174,6 +174,18 @@ createNextDescribe(
await browser.deleteCookies() 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 respect cookie options of merged middleware cookies', async () => { it('should respect cookie options of merged middleware cookies', async () => {
const browser = await next.browser('/rsc-cookies/cookie-options') const browser = await next.browser('/rsc-cookies/cookie-options')
......
import { NextResponse } from 'next/server'
export function GET() {
const response = new NextResponse()
response.cookies.set({
name: 'example',
value: 'example',
})
return response
}
import { cookies } from 'next/headers'
export default async function Page() {
const cookieLength = (await cookies()).size
return <div id="cookies">cookies: {cookieLength}</div>
}
...@@ -44,6 +44,7 @@ describe('Required Server Files', () => { ...@@ -44,6 +44,7 @@ describe('Required Server Files', () => {
} }
await fs.rename(join(appDir, 'pages'), join(appDir, 'pages-bak')) await fs.rename(join(appDir, 'pages'), join(appDir, 'pages-bak'))
process.env.NEXT_PRIVATE_TEST_HEADERS = '1'
nextApp = nextServer({ nextApp = nextServer({
conf: {}, conf: {},
dir: appDir, dir: appDir,
...@@ -57,6 +58,7 @@ describe('Required Server Files', () => { ...@@ -57,6 +58,7 @@ describe('Required Server Files', () => {
console.log(`Listening at ::${appPort}`) console.log(`Listening at ::${appPort}`)
}) })
afterAll(async () => { afterAll(async () => {
delete process.env.NEXT_PRIVATE_TEST_HEADERS
if (server) server.close() if (server) server.close()
await fs.rename(join(appDir, 'pages-bak'), join(appDir, 'pages')) await fs.rename(join(appDir, 'pages-bak'), join(appDir, 'pages'))
}) })
......
...@@ -25,6 +25,7 @@ describe('required server files app router', () => { ...@@ -25,6 +25,7 @@ describe('required server files app router', () => {
}) => { }) => {
// test build against environment with next support // test build against environment with next support
process.env.NOW_BUILDER = nextEnv ? '1' : '' process.env.NOW_BUILDER = nextEnv ? '1' : ''
process.env.NEXT_PRIVATE_TEST_HEADERS = '1'
next = await createNext({ next = await createNext({
files: { files: {
...@@ -96,6 +97,7 @@ describe('required server files app router', () => { ...@@ -96,6 +97,7 @@ describe('required server files app router', () => {
await setupNext({ nextEnv: true, minimalMode: true }) await setupNext({ nextEnv: true, minimalMode: true })
}) })
afterAll(async () => { afterAll(async () => {
delete process.env.NEXT_PRIVATE_TEST_HEADERS
await next.destroy() await next.destroy()
if (server) await killApp(server) if (server) await killApp(server)
}) })
......
...@@ -24,6 +24,7 @@ describe('required server files i18n', () => { ...@@ -24,6 +24,7 @@ describe('required server files i18n', () => {
beforeAll(async () => { beforeAll(async () => {
let wasmPkgIsAvailable = false let wasmPkgIsAvailable = false
process.env.NEXT_PRIVATE_TEST_HEADERS = '1'
const res = await nodeFetch( const res = await nodeFetch(
`https://registry.npmjs.com/@next/swc-wasm-nodejs/-/swc-wasm-nodejs-${ `https://registry.npmjs.com/@next/swc-wasm-nodejs/-/swc-wasm-nodejs-${
...@@ -128,6 +129,7 @@ describe('required server files i18n', () => { ...@@ -128,6 +129,7 @@ describe('required server files i18n', () => {
) )
}) })
afterAll(async () => { afterAll(async () => {
delete process.env.NEXT_PRIVATE_TEST_HEADERS
await next.destroy() await next.destroy()
if (server) await killApp(server) if (server) await killApp(server)
}) })
......
...@@ -27,6 +27,7 @@ describe('required server files app router', () => { ...@@ -27,6 +27,7 @@ describe('required server files app router', () => {
}) => { }) => {
// test build against environment with next support // test build against environment with next support
process.env.NOW_BUILDER = nextEnv ? '1' : '' process.env.NOW_BUILDER = nextEnv ? '1' : ''
process.env.NEXT_PRIVATE_TEST_HEADERS = '1'
next = await createNext({ next = await createNext({
files: { files: {
...@@ -106,6 +107,7 @@ describe('required server files app router', () => { ...@@ -106,6 +107,7 @@ describe('required server files app router', () => {
await setupNext({ nextEnv: true, minimalMode: true }) await setupNext({ nextEnv: true, minimalMode: true })
}) })
afterAll(async () => { afterAll(async () => {
delete process.env.NEXT_PRIVATE_TEST_HEADERS
await next.destroy() await next.destroy()
if (server) await killApp(server) if (server) await killApp(server)
}) })
......
...@@ -32,6 +32,7 @@ describe('required server files', () => { ...@@ -32,6 +32,7 @@ describe('required server files', () => {
}) => { }) => {
// test build against environment with next support // test build against environment with next support
process.env.NOW_BUILDER = nextEnv ? '1' : '' process.env.NOW_BUILDER = nextEnv ? '1' : ''
process.env.NEXT_PRIVATE_TEST_HEADERS = '1'
next = await createNext({ next = await createNext({
files: { files: {
...@@ -139,6 +140,7 @@ describe('required server files', () => { ...@@ -139,6 +140,7 @@ describe('required server files', () => {
await setupNext({ nextEnv: true, minimalMode: true }) await setupNext({ nextEnv: true, minimalMode: true })
}) })
afterAll(async () => { afterAll(async () => {
delete process.env.NEXT_PRIVATE_TEST_HEADERS
await next.destroy() await next.destroy()
if (server) await killApp(server) if (server) await killApp(server)
}) })
......
...@@ -22,6 +22,7 @@ describe('minimal-mode-response-cache', () => { ...@@ -22,6 +22,7 @@ describe('minimal-mode-response-cache', () => {
beforeAll(async () => { beforeAll(async () => {
// test build against environment with next support // test build against environment with next support
process.env.NOW_BUILDER = '1' process.env.NOW_BUILDER = '1'
process.env.NEXT_PRIVATE_TEST_HEADERS = '1'
next = await createNext({ next = await createNext({
files: new FileRef(join(__dirname, 'app')), files: new FileRef(join(__dirname, 'app')),
...@@ -84,6 +85,7 @@ describe('minimal-mode-response-cache', () => { ...@@ -84,6 +85,7 @@ describe('minimal-mode-response-cache', () => {
appPort = `http://127.0.0.1:${port}` appPort = `http://127.0.0.1:${port}`
}) })
afterAll(async () => { afterAll(async () => {
delete process.env.NEXT_PRIVATE_TEST_HEADERS
await next.destroy() await next.destroy()
if (server) await killApp(server) if (server) await killApp(server)
}) })
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment