Unverified Commit b8a7d931 authored by Niklas Mischkulnig's avatar Niklas Mischkulnig Committed by GitHub

Always use generateBuildId if set explicitly (#99147)

https://github.com/vercel/next.js/pull/89325 changed the build id to be
a hardcoded constant if `config.deploymentId` is set (= skew protection
is enabled)
This was done as an optimization (more deterministic build outputs)

Instead, always use generateBuildId if set explicitly and only use the
new behavior if `generateBuildId` isn't set.

Closes https://github.com/vercel/next.js/issues/92154

---------
Co-authored-by: 's avatarvercel-fleet-prod[bot] <318278635+vercel-fleet-prod[bot]@users.noreply.github.com>
parent a8ada873
...@@ -184,7 +184,7 @@ module.exports = { ...@@ -184,7 +184,7 @@ module.exports = {
} }
``` ```
> **Good to know:** When [`deploymentId`](/docs/app/api-reference/config/next-config-js/deploymentId) is set, Next.js uses a constant build ID and `generateBuildId` has no effect. [Version skew](#version-skew) is detected from the deployment ID instead. > **Good to know:** When [`deploymentId`](/docs/app/api-reference/config/next-config-js/deploymentId) is set, Next.js uses a constant build ID unless you explicitly configure `generateBuildId`. [Version skew](#version-skew) is detected from the deployment ID instead.
## Multi-Server Deployments ## Multi-Server Deployments
......
...@@ -18,4 +18,4 @@ module.exports = { ...@@ -18,4 +18,4 @@ module.exports = {
} }
``` ```
> **Good to know:** When [`deploymentId`](/docs/app/api-reference/config/next-config-js/deploymentId) is set, Next.js uses a constant build ID and `generateBuildId` has no effect. [Version skew](/docs/app/guides/self-hosting#version-skew) is detected from the deployment ID instead. > **Good to know:** When [`deploymentId`](/docs/app/api-reference/config/next-config-js/deploymentId) is set, Next.js uses a constant build ID unless you explicitly configure `generateBuildId`. [Version skew](/docs/app/guides/self-hosting#version-skew) is detected from the deployment ID instead.
export async function generateBuildId( export async function generateBuildId(
generate: () => string | null | Promise<string | null>, generate: (() => string | null | Promise<string | null>) | undefined,
fallback: () => string fallback: () => string
): Promise<string> { ): Promise<string> {
let buildId = await generate() let buildId = generate ? await generate() : null
// If there's no buildId defined we'll fall back // If there's no buildId defined we'll fall back
if (buildId === null) { if (buildId === null) {
// We also create a new buildId if it contains the word `ad` to avoid false // We also create a new buildId if it contains the word `ad` to avoid false
......
...@@ -1083,16 +1083,15 @@ async function getBuildId( ...@@ -1083,16 +1083,15 @@ async function getBuildId(
if (isGenerateMode) { if (isGenerateMode) {
return await fs.readFile(path.join(distDir, BUILD_ID_FILE), 'utf8') return await fs.readFile(path.join(distDir, BUILD_ID_FILE), 'utf8')
} }
if (config.deploymentId) { if (config.deploymentId && !config.generateBuildId) {
// Skew protection is enabled and NEXT_NAV_DEPLOYMENT_ID_HEADER will be used instead. Set a // Skew protection is enabled and NEXT_NAV_DEPLOYMENT_ID_HEADER will be used instead. Set a
// constant but "random" string because various tools perform `.replace(escapedBuildId, ....)` // constant but "random" string because various tools perform `.replace(escapedBuildId, ....)`
// which would fail if this were something like "build-id" instead. // which would fail if this were something like "build-id" instead.
return 'build-TfctsWXpff2fKS' return 'build-TfctsWXpff2fKS'
} else {
return await nextBuildSpan
.traceChild('generate-buildid')
.traceAsyncFn(() => generateBuildId(config.generateBuildId, nanoid))
} }
return await nextBuildSpan
.traceChild('generate-buildid')
.traceAsyncFn(() => generateBuildId(config.generateBuildId, nanoid))
} }
export default async function build( export default async function build(
......
...@@ -41,6 +41,7 @@ export type NextConfigComplete = Required< ...@@ -41,6 +41,7 @@ export type NextConfigComplete = Required<
Omit< Omit<
NextConfig, NextConfig,
| 'configFile' | 'configFile'
| 'generateBuildId'
| 'cacheLife' | 'cacheLife'
| 'expireTime' | 'expireTime'
| 'output' | 'output'
...@@ -52,6 +53,7 @@ export type NextConfigComplete = Required< ...@@ -52,6 +53,7 @@ export type NextConfigComplete = Required<
// Don't apply `Required<>` for these properties. They really can be undefined in the finalized config. // Don't apply `Required<>` for these properties. They really can be undefined in the finalized config.
Pick< Pick<
NextConfig, NextConfig,
| 'generateBuildId'
| 'cacheLife' | 'cacheLife'
| 'expireTime' | 'expireTime'
| 'output' | 'output'
...@@ -2277,7 +2279,6 @@ export const defaultConfig = Object.freeze({ ...@@ -2277,7 +2279,6 @@ export const defaultConfig = Object.freeze({
cacheMaxMemorySize: 50 * 1024 * 1024, cacheMaxMemorySize: 50 * 1024 * 1024,
configOrigin: 'default', configOrigin: 'default',
useFileSystemPublicRoutes: true, useFileSystemPublicRoutes: true,
generateBuildId: () => null,
generateEtags: true, generateEtags: true,
pageExtensions: ['tsx', 'ts', 'jsx', 'js'], pageExtensions: ['tsx', 'ts', 'jsx', 'js'],
instrumentationClientInject: [], instrumentationClientInject: [],
......
...@@ -3,6 +3,9 @@ module.exports = { ...@@ -3,6 +3,9 @@ module.exports = {
deploymentId: deploymentId:
process.env.NEXT_DEPLOYMENT_ID_IMMUTABLE ?? process.env.NEXT_DEPLOYMENT_ID_IMMUTABLE ??
process.env.CUSTOM_DEPLOYMENT_ID, process.env.CUSTOM_DEPLOYMENT_ID,
...(process.env.CUSTOM_BUILD_ID
? { generateBuildId: async () => process.env.CUSTOM_BUILD_ID }
: {}),
experimental: { experimental: {
useSkewCookie: Boolean(process.env.COOKIE_SKEW), useSkewCookie: Boolean(process.env.COOKIE_SKEW),
runtimeServerDeploymentId: !!process.env.RUNTIME_SERVER_DEPLOYMENT_ID, runtimeServerDeploymentId: !!process.env.RUNTIME_SERVER_DEPLOYMENT_ID,
......
...@@ -54,6 +54,13 @@ describe.each([ ...@@ -54,6 +54,13 @@ describe.each([
} }
} }
it('uses the constant build ID when generateBuildId is not configured', async () => {
const $ = await next.render$('/')
expect(JSON.parse($('script#__NEXT_DATA__').html()!).buildId).toBe(
'build-TfctsWXpff2fKS'
)
})
it.each([ it.each([
{ urlPath: '/' }, { urlPath: '/' },
{ urlPath: '/pages-edge' }, { urlPath: '/pages-edge' },
...@@ -215,12 +222,38 @@ describe.each([ ...@@ -215,12 +222,38 @@ describe.each([
} }
) )
describe('deployment-id-handling with generateBuildId', () => {
const { next } = nextTestSetup({
files: join(__dirname, 'app'),
env: {
CUSTOM_DEPLOYMENT_ID: 'test-deployment-id',
CUSTOM_BUILD_ID: 'custom-build-id',
},
disableAutoSkewProtection: true,
})
it('uses the explicitly configured build ID', async () => {
const $ = await next.render$('/')
expect(JSON.parse($('script#__NEXT_DATA__').html()!).buildId).toBe(
'custom-build-id'
)
})
})
describe('deployment-id-handling disabled', () => { describe('deployment-id-handling disabled', () => {
const deploymentId = Date.now() + '' const deploymentId = Date.now() + ''
const { next } = nextTestSetup({ const { next } = nextTestSetup({
files: join(__dirname, 'app'), files: join(__dirname, 'app'),
disableAutoSkewProtection: true, disableAutoSkewProtection: true,
}) })
it('generates a build ID without a configured callback', async () => {
const $ = await next.render$('/')
const buildId = JSON.parse($('script#__NEXT_DATA__').html()!).buildId
expect(buildId).toBeTruthy()
expect(buildId).not.toBe('build-TfctsWXpff2fKS')
})
it.each([ it.each([
{ urlPath: '/' }, { urlPath: '/' },
{ urlPath: '/pages-edge' }, { urlPath: '/pages-edge' },
......
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