Commit 2f7fa989 authored by Jiachi Liu's avatar Jiachi Liu Committed by Zack Tanner

Add deployment id header for rsc payload if present (#67255)

Add deployment id for skew protection into RSC payload

---------
Co-authored-by: 's avatarJJ Kasper <jj@jjsweb.site>
parent 545746e0
...@@ -56,6 +56,7 @@ export async function fetchServerResponse( ...@@ -56,6 +56,7 @@ export async function fetchServerResponse(
[NEXT_ROUTER_STATE_TREE]: string [NEXT_ROUTER_STATE_TREE]: string
[NEXT_URL]?: string [NEXT_URL]?: string
[NEXT_ROUTER_PREFETCH_HEADER]?: '1' [NEXT_ROUTER_PREFETCH_HEADER]?: '1'
'x-deployment-id'?: string
} = { } = {
// Enable flight response // Enable flight response
[RSC_HEADER]: '1', [RSC_HEADER]: '1',
...@@ -79,6 +80,10 @@ export async function fetchServerResponse( ...@@ -79,6 +80,10 @@ export async function fetchServerResponse(
headers[NEXT_URL] = nextUrl headers[NEXT_URL] = nextUrl
} }
if (process.env.NEXT_DEPLOYMENT_ID) {
headers['x-deployment-id'] = process.env.NEXT_DEPLOYMENT_ID
}
const uniqueCacheQuery = hexHash( const uniqueCacheQuery = hexHash(
[ [
headers[NEXT_ROUTER_PREFETCH_HEADER] || '0', headers[NEXT_ROUTER_PREFETCH_HEADER] || '0',
......
'use client' 'use client'
import testImage from '../../public/test.jpg'
import Link from 'next/link'
import Image from 'next/image' import Image from 'next/image'
import testImage from '../../public/test.jpg'
export default function Page() { export default function Page() {
return ( return (
...@@ -19,6 +21,9 @@ export default function Page() { ...@@ -19,6 +21,9 @@ export default function Page() {
> >
click me click me
</button> </button>
<Link id="other-app" href="/other-app">
other app
</Link>
</> </>
) )
} }
'use client'
import testImage from '../../public/test.jpg'
import Image from 'next/image'
export default function Page() {
return (
<>
<h1>other app</h1>
<Image src={testImage} alt="test" />
<p id="deploymentId">{process.env.NEXT_DEPLOYMENT_ID}</p>
<button
onClick={() => {
import('../../data').then((mod) => {
console.log('loaded data', mod)
})
}}
id="dynamic-import"
>
click me
</button>
</>
)
}
html { html {
font-size: 14rem; font-size: 1.4rem;
color: white; color: white;
background: black; background: black;
} }
import { nextTestSetup } from 'e2e-utils' import { nextTestSetup } from 'e2e-utils'
import { check } from 'next-test-utils' import { check, retry } from 'next-test-utils'
import { join } from 'node:path' import { join } from 'node:path'
describe.each(['NEXT_DEPLOYMENT_ID', 'CUSTOM_DEPLOYMENT_ID'])( describe.each(['NEXT_DEPLOYMENT_ID', 'CUSTOM_DEPLOYMENT_ID'])(
...@@ -51,7 +51,9 @@ describe.each(['NEXT_DEPLOYMENT_ID', 'CUSTOM_DEPLOYMENT_ID'])( ...@@ -51,7 +51,9 @@ describe.each(['NEXT_DEPLOYMENT_ID', 'CUSTOM_DEPLOYMENT_ID'])(
const requests = [] const requests = []
browser.on('request', (req) => { browser.on('request', (req) => {
requests.push(req.url()) if (req.url().includes('/_next/static')) {
requests.push(req.url())
}
}) })
await browser.elementByCss('#dynamic-import').click() await browser.elementByCss('#dynamic-import').click()
...@@ -81,8 +83,37 @@ describe.each(['NEXT_DEPLOYMENT_ID', 'CUSTOM_DEPLOYMENT_ID'])( ...@@ -81,8 +83,37 @@ describe.each(['NEXT_DEPLOYMENT_ID', 'CUSTOM_DEPLOYMENT_ID'])(
}) })
} }
) )
it('should contain deployment id in RSC payload request headers', async () => {
const rscHeaders = []
const browser = await next.browser('/from-app', {
beforePageLoad(page) {
page.on('request', async (req) => {
const headers = await req.allHeaders()
if (headers['rsc']) {
rscHeaders.push(headers)
}
})
},
})
await browser.elementByCss('#other-app').click()
await retry(async () => {
expect(await browser.elementByCss('h1').text()).toBe('other app')
expect(await browser.url()).toContain('/other-app')
expect(rscHeaders.length).toBeGreaterThan(0)
})
expect(
rscHeaders.every(
(headers) => headers['x-deployment-id'] === deploymentId
)
).toBe(true)
})
} }
) )
describe('deployment-id-handling disabled', () => { describe('deployment-id-handling disabled', () => {
const deploymentId = Date.now() + '' const deploymentId = Date.now() + ''
const { next } = nextTestSetup({ const { next } = nextTestSetup({
......
...@@ -14779,10 +14779,12 @@ ...@@ -14779,10 +14779,12 @@
"deployment-id-handling enabled with CUSTOM_DEPLOYMENT_ID should append dpl query to all assets correctly for /from-app", "deployment-id-handling enabled with CUSTOM_DEPLOYMENT_ID should append dpl query to all assets correctly for /from-app",
"deployment-id-handling enabled with CUSTOM_DEPLOYMENT_ID should append dpl query to all assets correctly for /from-app/edge", "deployment-id-handling enabled with CUSTOM_DEPLOYMENT_ID should append dpl query to all assets correctly for /from-app/edge",
"deployment-id-handling enabled with CUSTOM_DEPLOYMENT_ID should append dpl query to all assets correctly for /pages-edge", "deployment-id-handling enabled with CUSTOM_DEPLOYMENT_ID should append dpl query to all assets correctly for /pages-edge",
"deployment-id-handling enabled with CUSTOM_DEPLOYMENT_ID should contain deployment id in RSC payload request headers",
"deployment-id-handling enabled with NEXT_DEPLOYMENT_ID should append dpl query to all assets correctly for /", "deployment-id-handling enabled with NEXT_DEPLOYMENT_ID should append dpl query to all assets correctly for /",
"deployment-id-handling enabled with NEXT_DEPLOYMENT_ID should append dpl query to all assets correctly for /from-app", "deployment-id-handling enabled with NEXT_DEPLOYMENT_ID should append dpl query to all assets correctly for /from-app",
"deployment-id-handling enabled with NEXT_DEPLOYMENT_ID should append dpl query to all assets correctly for /from-app/edge", "deployment-id-handling enabled with NEXT_DEPLOYMENT_ID should append dpl query to all assets correctly for /from-app/edge",
"deployment-id-handling enabled with NEXT_DEPLOYMENT_ID should append dpl query to all assets correctly for /pages-edge" "deployment-id-handling enabled with NEXT_DEPLOYMENT_ID should append dpl query to all assets correctly for /pages-edge",
"deployment-id-handling enabled with NEXT_DEPLOYMENT_ID should contain deployment id in RSC payload request headers"
], ],
"pending": [], "pending": [],
"flakey": [], "flakey": [],
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