Unverified Commit 2b514ea8 authored by Wyatt Johnson's avatar Wyatt Johnson Committed by GitHub

Strip internal routing headers (#55114)

This strips the internal routing headers added by the routing server. Based on some of the changes being introduced in https://github.com/vercel/next.js/pull/54813 this strips the headers, but this also adds some internal flags to turn this off during testing to validate correct routing beheviour.
parent 7267538e
...@@ -124,6 +124,7 @@ import { ...@@ -124,6 +124,7 @@ import {
} from './web/spec-extension/adapters/next-request' } from './web/spec-extension/adapters/next-request'
import { matchNextDataPathname } from './lib/match-next-data-pathname' import { matchNextDataPathname } from './lib/match-next-data-pathname'
import getRouteFromAssetPath from '../shared/lib/router/utils/get-route-from-asset-path' import getRouteFromAssetPath from '../shared/lib/router/utils/get-route-from-asset-path'
import { stripInternalHeaders } from './internal-utils'
export type FindComponentsResult = { export type FindComponentsResult = {
components: LoadComponentsReturnType components: LoadComponentsReturnType
...@@ -1538,6 +1539,28 @@ export default abstract class Server<ServerOptions extends Options = Options> { ...@@ -1538,6 +1539,28 @@ export default abstract class Server<ServerOptions extends Options = Options> {
) )
} }
protected stripInternalHeaders(req: BaseNextRequest): void {
// Skip stripping internal headers in test mode while the header stripping
// has been explicitly disabled. This allows tests to verify internal
// routing behavior.
if (
process.env.__NEXT_TEST_MODE &&
process.env.__NEXT_NO_STRIP_INTERNAL_HEADERS === '1'
) {
return
}
// Strip the internal headers from both the request and the original
// request.
stripInternalHeaders(req.headers)
if (
'originalRequest' in req &&
'headers' in (req as NodeNextRequest).originalRequest
) {
stripInternalHeaders((req as NodeNextRequest).originalRequest.headers)
}
}
private async renderToResponseWithComponentsImpl( private async renderToResponseWithComponentsImpl(
{ req, res, pathname, renderOpts: opts }: RequestContext, { req, res, pathname, renderOpts: opts }: RequestContext,
{ components, query }: FindComponentsResult { components, query }: FindComponentsResult
...@@ -1546,6 +1569,10 @@ export default abstract class Server<ServerOptions extends Options = Options> { ...@@ -1546,6 +1569,10 @@ export default abstract class Server<ServerOptions extends Options = Options> {
// For edge runtime 404 page, /_not-found needs to be treated as 404 page // For edge runtime 404 page, /_not-found needs to be treated as 404 page
(process.env.NEXT_RUNTIME === 'edge' && pathname === '/_not-found') || (process.env.NEXT_RUNTIME === 'edge' && pathname === '/_not-found') ||
pathname === '/404' pathname === '/404'
// Strip the internal headers.
this.stripInternalHeaders(req)
const is500Page = pathname === '/500' const is500Page = pathname === '/500'
const isAppPath = components.isAppPath const isAppPath = components.isAppPath
const hasServerProps = !!components.getServerSideProps const hasServerProps = !!components.getServerSideProps
......
import { NEXT_RSC_UNION_QUERY } from '../client/components/app-router-headers' import type { IncomingHttpHeaders } from 'http'
import type { NextParsedUrlQuery } from './request-meta' import type { NextParsedUrlQuery } from './request-meta'
import { NEXT_RSC_UNION_QUERY } from '../client/components/app-router-headers'
const INTERNAL_QUERY_NAMES = [ const INTERNAL_QUERY_NAMES = [
'__nextFallback', '__nextFallback',
'__nextLocale', '__nextLocale',
...@@ -36,3 +38,27 @@ export function stripInternalSearchParams<T extends string | URL>( ...@@ -36,3 +38,27 @@ export function stripInternalSearchParams<T extends string | URL>(
return (isStringUrl ? instance.toString() : instance) as T return (isStringUrl ? instance.toString() : instance) as T
} }
/**
* Headers that are set by the Next.js server and should be stripped from the
* request headers going to the user's application.
*/
const INTERNAL_HEADERS = [
'x-invoke-path',
'x-invoke-status',
'x-invoke-error',
'x-invoke-query',
'x-invoke-output',
'x-middleware-invoke',
] as const
/**
* Strip internal headers from the request headers.
*
* @param headers the headers to strip of internal headers
*/
export function stripInternalHeaders(headers: IncomingHttpHeaders) {
for (const key of INTERNAL_HEADERS) {
delete headers[key]
}
}
...@@ -1585,6 +1585,9 @@ export default class NextNodeServer extends BaseServer { ...@@ -1585,6 +1585,9 @@ export default class NextNodeServer extends BaseServer {
ReturnType<typeof NextNodeServer.prototype.runMiddleware> ReturnType<typeof NextNodeServer.prototype.runMiddleware>
> >
// Strip the internal headers.
this.stripInternalHeaders(req)
try { try {
await this.ensureMiddleware() await this.ensureMiddleware()
......
...@@ -17,6 +17,10 @@ createNextDescribe( ...@@ -17,6 +17,10 @@ createNextDescribe(
'i18n-data-route', 'i18n-data-route',
{ {
files: __dirname, files: __dirname,
env: {
// Disable internal header stripping so we can test the invoke output.
__NEXT_NO_STRIP_INTERNAL_HEADERS: '1',
},
}, },
({ next }) => { ({ next }) => {
describe('with locale prefix', () => { describe('with locale prefix', () => {
......
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