import { nextTestSetup } from 'e2e-utils'
import { computeCacheBustingSearchParam } from 'next/dist/shared/lib/router/utils/cache-busting-search-param'
const targets = ['x-nextjs-rewritten-path', 'x-nextjs-rewritten-query'] as const
type Target = (typeof targets)[number]
const cases: {
name: string
pathname: string
only?: boolean
debug?: true
headers?: {
rsc?: '1'
'next-router-prefetch'?: '0' | '1' | '2'
'next-router-segment-prefetch'?: string
}
expected: Record<Target, string | null>
}[] = [
{
name: 'static HTML',
pathname: '/',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'static RSC',
pathname: '/',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'static Prefetch RSC',
pathname: '/',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'prerender HTML',
pathname: '/hello/world',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'prerendered RSC',
pathname: '/hello/world',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'prerendered Prefetch RSC',
pathname: '/hello/world',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'middleware rewrite HTML',
pathname: '/hello/wyatt',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'middleware rewrite RSC',
pathname: '/hello/wyatt',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': '/hello/admin',
'x-nextjs-rewritten-query': 'key=value',
},
},
{
name: 'middleware rewrite Prefetch RSC',
pathname: '/hello/wyatt',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
// only: true,
expected: {
'x-nextjs-rewritten-path': '/hello/admin',
'x-nextjs-rewritten-query': 'key=value',
},
},
{
name: 'middleware rewrite dynamic HTML',
pathname: '/hello/bob',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'middleware rewrite dynamic RSC',
pathname: '/hello/bob',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': '/hello/bobby',
'x-nextjs-rewritten-query': null,
},
},
{
name: 'middleware rewrite dynamic Prefetch RSC',
pathname: '/hello/bob',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': '/hello/bobby',
'x-nextjs-rewritten-query': null,
},
},
{
name: 'dynamic HTML',
pathname: '/hello/mary',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'dynamic RSC',
pathname: '/hello/mary',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'dynamic Prefetch RSC',
pathname: '/hello/mary',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'dynamic HTML with query',
pathname: '/hello/mary?key=value',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'dynamic RSC with query',
pathname: '/hello/mary?key=value',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'dynamic Prefetch RSC with query',
pathname: '/hello/mary?key=value',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'next.config.js rewrites HTML',
pathname: '/hello/sam',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'next.config.js rewrites RSC',
pathname: '/hello/sam',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': '/hello/samantha',
'x-nextjs-rewritten-query': null,
},
},
{
name: 'next.config.js rewrites Prefetch RSC',
pathname: '/hello/sam',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': '/hello/samantha',
'x-nextjs-rewritten-query': null,
},
},
{
name: 'next.config.js rewrites static HTML',
pathname: '/hello/other',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'next.config.js rewrites static RSC',
pathname: '/hello/other',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': '/other',
'x-nextjs-rewritten-query': null,
},
},
{
name: 'next.config.js rewrites static Prefetch RSC',
pathname: '/hello/other',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': '/other',
'x-nextjs-rewritten-query': null,
},
},
{
name: 'next.config.js rewrites external URL',
pathname: '/hello/google',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'middleware rewrite query HTML',
pathname: '/hello/john',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'middleware rewrite query RSC',
pathname: '/hello/john',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': 'key=value',
},
},
{
name: 'middleware rewrite query Prefetch RSC',
pathname: '/hello/john',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': 'key=value',
},
},
{
name: 'middleware rewrite external HTML',
pathname: '/hello/vercel',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
// TODO: These next two scenarios are dependent on how the Vercel site has
// configured its rewrites, and thus are prone to be flaky. Figure out what
// Next.js logic this is supposed to test.
// {
// name: 'middleware rewrite external RSC',
// pathname: '/hello/vercel',
// headers: {
// rsc: '1',
// },
// expected: {
// // Vercel matches `/` to `/home`
// 'x-nextjs-rewritten-path': '/home',
// 'x-nextjs-rewritten-query': null,
// },
// },
// {
// name: 'middleware rewrite external Prefetch RSC',
// pathname: '/hello/vercel',
// headers: {
// rsc: '1',
// 'next-router-prefetch': '1',
// },
// expected: {
// // Vercel matches `/` to `/home`
// 'x-nextjs-rewritten-path': '/home',
// 'x-nextjs-rewritten-query': null,
// },
// },
{
name: 'next.config.js rewrites with query HTML',
pathname: '/hello/fred',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'next.config.js rewrites with query RSC',
pathname: '/hello/fred',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': '/other',
'x-nextjs-rewritten-query': 'key=value',
},
},
{
name: 'next.config.js rewrites with query Prefetch RSC',
pathname: '/hello/fred',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': '/other',
'x-nextjs-rewritten-query': 'key=value',
},
},
{
name: 'next.config.js rewrites with path-matched query HTML',
pathname: '/rewrites-to-query/andrew',
expected: {
'x-nextjs-rewritten-path': null,
'x-nextjs-rewritten-query': null,
},
},
{
name: 'next.config.js rewrites with path-matched query RSC',
pathname: '/rewrites-to-query/andrew',
headers: {
rsc: '1',
},
expected: {
'x-nextjs-rewritten-path': '/other',
'x-nextjs-rewritten-query': 'key=andrew',
},
},
{
name: 'next.config.js rewrites with path-matched query Prefetch RSC',
pathname: '/rewrites-to-query/andrew',
headers: {
rsc: '1',
'next-router-prefetch': '1',
...(process.env.__NEXT_CACHE_COMPONENTS === 'true'
? {
'next-router-segment-prefetch': '/_tree',
}
: {}),
},
expected: {
'x-nextjs-rewritten-path': '/other',
'x-nextjs-rewritten-query': 'key=andrew',
},
},
]
describe('rewrite-headers', () => {
const { next } = nextTestSetup({
files: __dirname,
// TODO: re-enable once changes in infrastructure are merged
skipDeployment: true,
})
describe.each(cases)(
'$name ($pathname)',
({ pathname, headers = {}, expected }) => {
let response
beforeAll(async () => {
const url = new URL(pathname, 'http://localhost')
// Add cache busting param for RSC requests
if (headers.rsc === '1') {
const cacheBustingParam = await computeCacheBustingSearchParam(
headers['next-router-prefetch'],
headers['next-router-segment-prefetch'],
undefined,
undefined
)
if (cacheBustingParam) {
// Preserve existing search params if any
const existingSearch = url.search
const rawQuery = existingSearch.startsWith('?')
? existingSearch.slice(1)
: existingSearch
const pairs = rawQuery.split('&').filter(Boolean)
pairs.push(`_rsc=${cacheBustingParam}`)
url.search = pairs.length ? `?${pairs.join('&')}` : ''
}
}
response = await next.fetch(url.toString(), { headers })
if (response.status !== 200) {
throw new Error(
`Expected status 200, got ${response.status} for ${pathname}`
)
}
})
it('should have the expected headers', () => {
const headers = Object.fromEntries(response.headers.entries())
// This is so that the following check works. If we expect that the
// header is null, but it's not present, we need to set it to null.
Object.entries(expected).forEach(([key, value]) => {
if (value === null && !headers[key]) {
headers[key] = null
}
})
// Remove any headers that we're not testing for to simplify the test
// output.
Object.keys(headers).forEach((key) => {
if (!targets.includes(key as Target)) {
delete headers[key]
}
})
expect(headers).toEqual(expected)
})
}
)
})