Unverified Commit 224ca189 authored by Zack Tanner's avatar Zack Tanner Committed by GitHub

remove unnecessary internal middleware header from response (#73482)

x-middleware-set-cookie is an internal header used by the middleware
handler and doesn't need to be forwarded onto the response.

this also adds handling to filter out internal request headers as they
aren't intended to be used externally.

---------
Co-authored-by: 's avatarJJ Kasper <jj@jjsweb.site>
parent 22daa8ed
...@@ -47,6 +47,7 @@ import { ...@@ -47,6 +47,7 @@ import {
import { normalizedAssetPrefix } from '../../shared/lib/normalized-asset-prefix' import { normalizedAssetPrefix } from '../../shared/lib/normalized-asset-prefix'
import { NEXT_PATCH_SYMBOL } from './patch-fetch' import { NEXT_PATCH_SYMBOL } from './patch-fetch'
import type { ServerInitResult } from './render-server' import type { ServerInitResult } from './render-server'
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) =>
...@@ -164,6 +165,11 @@ export async function initialize(opts: { ...@@ -164,6 +165,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 &&
......
...@@ -585,6 +585,14 @@ export function getResolveRoutes( ...@@ -585,6 +585,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]
}
}
}
...@@ -6,7 +6,7 @@ import { nextTestSetup, FileRef } from 'e2e-utils' ...@@ -6,7 +6,7 @@ import { nextTestSetup, FileRef } from 'e2e-utils'
import type { Response } from 'node-fetch' import type { Response } from 'node-fetch'
describe('app-dir with middleware', () => { describe('app-dir with middleware', () => {
const { next } = nextTestSetup({ const { next, isNextDeploy } = nextTestSetup({
files: __dirname, files: __dirname,
}) })
...@@ -187,6 +187,29 @@ describe('app-dir with middleware', () => { ...@@ -187,6 +187,29 @@ describe('app-dir with middleware', () => {
await browser.deleteCookies() await browser.deleteCookies()
}) })
// TODO: Re-enable this test in deploy mode once Vercel has proper handling
if (!isNextDeploy) {
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()
})
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 () => { 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 browser = await next.browser('/rsc-cookies')
const initialRandom1 = await browser.elementById('rsc-cookie-1').text() const initialRandom1 = await browser.elementById('rsc-cookie-1').text()
......
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'))
}) })
......
...@@ -26,6 +26,7 @@ describe('required server files app router', () => { ...@@ -26,6 +26,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: {
...@@ -97,6 +98,7 @@ describe('required server files app router', () => { ...@@ -97,6 +98,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)
}) })
......
...@@ -25,6 +25,7 @@ describe('required server files i18n', () => { ...@@ -25,6 +25,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-${
...@@ -131,6 +132,7 @@ describe('required server files i18n', () => { ...@@ -131,6 +132,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)
}) })
......
...@@ -28,6 +28,7 @@ describe('required server files app router', () => { ...@@ -28,6 +28,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: {
...@@ -107,6 +108,7 @@ describe('required server files app router', () => { ...@@ -107,6 +108,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)
}) })
......
...@@ -29,6 +29,7 @@ describe('required server files', () => { ...@@ -29,6 +29,7 @@ describe('required server files', () => {
const setupNext = async ({ nextEnv }: { nextEnv?: boolean }) => { const setupNext = async ({ nextEnv }: { nextEnv?: boolean }) => {
// 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: {
...@@ -152,6 +153,7 @@ describe('required server files', () => { ...@@ -152,6 +153,7 @@ describe('required server files', () => {
}) })
afterAll(async () => { afterAll(async () => {
delete process.env.NEXT_PRIVATE_TEST_HEADERS
await next.destroy() await next.destroy()
}) })
......
...@@ -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