Unverified Commit cd09f8b8 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Inject preview props into edge manifest (#64108)

### What

Bump the edge runtime manifest version and add `environments` property
to each route for inlining values for deployment build.

### Why

In edge runtime, extract the preview props into edge functions manifest
that holding the non-deterministic inline values, then the output build
will be more deterministic that helps deployment speed

x-ref: https://github.com/vercel/vercel/pull/11390
x-ref: https://github.com/vercel/vercel/pull/11395
Closes NEXT-3012
Closes NEXT-1912
parent b93ead0c
...@@ -340,9 +340,29 @@ async function writePrerenderManifest( ...@@ -340,9 +340,29 @@ async function writePrerenderManifest(
manifest: Readonly<PrerenderManifest> manifest: Readonly<PrerenderManifest>
): Promise<void> { ): Promise<void> {
await writeManifest(path.join(distDir, PRERENDER_MANIFEST), manifest) await writeManifest(path.join(distDir, PRERENDER_MANIFEST), manifest)
await writeEdgePartialPrerenderManifest(distDir, manifest)
}
async function writeEdgePartialPrerenderManifest(
distDir: string,
manifest: Readonly<Partial<PrerenderManifest>>
): Promise<void> {
// We need to write a partial prerender manifest to make preview mode settings available in edge middleware.
// Use env vars in JS bundle and inject the actual vars to edge manifest.
const edgePartialPrerenderManifest: Partial<PrerenderManifest> = {
...manifest,
preview: {
previewModeId: 'process.env.__NEXT_PREVIEW_MODE_ID',
previewModeSigningKey: 'process.env.__NEXT_PREVIEW_MODE_SIGNING_KEY',
previewModeEncryptionKey:
'process.env.__NEXT_PREVIEW_MODE_ENCRYPTION_KEY',
},
}
await writeFileUtf8( await writeFileUtf8(
path.join(distDir, PRERENDER_MANIFEST).replace(/\.json$/, '.js'), path.join(distDir, PRERENDER_MANIFEST.replace(/\.json$/, '.js')),
`self.__PRERENDER_MANIFEST=${JSON.stringify(JSON.stringify(manifest))}` `self.__PRERENDER_MANIFEST=${JSON.stringify(
JSON.stringify(edgePartialPrerenderManifest)
)}`
) )
} }
...@@ -1220,17 +1240,7 @@ export default async function build( ...@@ -1220,17 +1240,7 @@ export default async function build(
.traceChild('write-routes-manifest') .traceChild('write-routes-manifest')
.traceAsyncFn(() => writeManifest(routesManifestPath, routesManifest)) .traceAsyncFn(() => writeManifest(routesManifestPath, routesManifest))
// We need to write a partial prerender manifest to make preview mode settings available in edge middleware await writeEdgePartialPrerenderManifest(distDir, {})
const partialManifest: Partial<PrerenderManifest> = {
preview: previewProps,
}
await writeFileUtf8(
path.join(distDir, PRERENDER_MANIFEST).replace(/\.json$/, '.js'),
`self.__PRERENDER_MANIFEST=${JSON.stringify(
JSON.stringify(partialManifest)
)}`
)
const outputFileTracingRoot = const outputFileTracingRoot =
config.experimental.outputFileTracingRoot || dir config.experimental.outputFileTracingRoot || dir
......
...@@ -152,6 +152,7 @@ export async function webpackBuildImpl( ...@@ -152,6 +152,7 @@ export async function webpackBuildImpl(
middlewareMatchers: entrypoints.middlewareMatchers, middlewareMatchers: entrypoints.middlewareMatchers,
compilerType: COMPILER_NAMES.edgeServer, compilerType: COMPILER_NAMES.edgeServer,
entrypoints: entrypoints.edgeServer, entrypoints: entrypoints.edgeServer,
edgePreviewProps: NextBuildContext.previewProps!,
...info, ...info,
}), }),
]) ])
......
...@@ -303,6 +303,7 @@ export default async function getBaseWebpackConfig( ...@@ -303,6 +303,7 @@ export default async function getBaseWebpackConfig(
supportedBrowsers, supportedBrowsers,
clientRouterFilters, clientRouterFilters,
fetchCacheKeyPrefix, fetchCacheKeyPrefix,
edgePreviewProps,
}: { }: {
buildId: string buildId: string
encryptionKey: string encryptionKey: string
...@@ -323,6 +324,7 @@ export default async function getBaseWebpackConfig( ...@@ -323,6 +324,7 @@ export default async function getBaseWebpackConfig(
jsConfig: any jsConfig: any
resolvedBaseUrl: ResolvedBaseUrl resolvedBaseUrl: ResolvedBaseUrl
supportedBrowsers: string[] | undefined supportedBrowsers: string[] | undefined
edgePreviewProps?: Record<string, string>
clientRouterFilters?: { clientRouterFilters?: {
staticFilter: ReturnType< staticFilter: ReturnType<
import('../shared/lib/bloom-filter').BloomFilter['export'] import('../shared/lib/bloom-filter').BloomFilter['export']
...@@ -1806,6 +1808,7 @@ export default async function getBaseWebpackConfig( ...@@ -1806,6 +1808,7 @@ export default async function getBaseWebpackConfig(
dev, dev,
sriEnabled: !dev && !!config.experimental.sri?.algorithm, sriEnabled: !dev && !!config.experimental.sri?.algorithm,
rewrites, rewrites,
edgeEnvironments: edgePreviewProps || {},
}), }),
isClient && isClient &&
new BuildManifestPlugin({ new BuildManifestPlugin({
......
...@@ -45,10 +45,11 @@ export interface EdgeFunctionDefinition { ...@@ -45,10 +45,11 @@ export interface EdgeFunctionDefinition {
wasm?: AssetBinding[] wasm?: AssetBinding[]
assets?: AssetBinding[] assets?: AssetBinding[]
regions?: string[] | string regions?: string[] | string
environments?: Record<string, string>
} }
export interface MiddlewareManifest { export interface MiddlewareManifest {
version: 2 version: 3
sortedMiddleware: string[] sortedMiddleware: string[]
middleware: { [page: string]: EdgeFunctionDefinition } middleware: { [page: string]: EdgeFunctionDefinition }
functions: { [page: string]: EdgeFunctionDefinition } functions: { [page: string]: EdgeFunctionDefinition }
...@@ -64,6 +65,7 @@ interface EntryMetadata { ...@@ -64,6 +65,7 @@ interface EntryMetadata {
} }
const NAME = 'MiddlewarePlugin' const NAME = 'MiddlewarePlugin'
const MANIFEST_VERSION = 3
/** /**
* Checks the value of usingIndirectEval and when it is a set of modules it * Checks the value of usingIndirectEval and when it is a set of modules it
...@@ -154,10 +156,10 @@ function getCreateAssets(params: { ...@@ -154,10 +156,10 @@ function getCreateAssets(params: {
const { compilation, metadataByEntry, opts } = params const { compilation, metadataByEntry, opts } = params
return (assets: any) => { return (assets: any) => {
const middlewareManifest: MiddlewareManifest = { const middlewareManifest: MiddlewareManifest = {
sortedMiddleware: [], version: MANIFEST_VERSION,
middleware: {}, middleware: {},
functions: {}, functions: {},
version: 2, sortedMiddleware: [],
} }
const hasInstrumentationHook = compilation.entrypoints.has( const hasInstrumentationHook = compilation.entrypoints.has(
...@@ -206,6 +208,7 @@ function getCreateAssets(params: { ...@@ -206,6 +208,7 @@ function getCreateAssets(params: {
}, },
] ]
const isEdgeFunction = !!(metadata.edgeApiFunction || metadata.edgeSSR)
const edgeFunctionDefinition: EdgeFunctionDefinition = { const edgeFunctionDefinition: EdgeFunctionDefinition = {
files: getEntryFiles( files: getEntryFiles(
entrypoint.getFiles(), entrypoint.getFiles(),
...@@ -224,10 +227,11 @@ function getCreateAssets(params: { ...@@ -224,10 +227,11 @@ function getCreateAssets(params: {
name, name,
filePath, filePath,
})), })),
environments: opts.edgeEnvironments,
...(metadata.regions && { regions: metadata.regions }), ...(metadata.regions && { regions: metadata.regions }),
} }
if (metadata.edgeApiFunction || metadata.edgeSSR) { if (isEdgeFunction) {
middlewareManifest.functions[page] = edgeFunctionDefinition middlewareManifest.functions[page] = edgeFunctionDefinition
} else { } else {
middlewareManifest.middleware[page] = edgeFunctionDefinition middlewareManifest.middleware[page] = edgeFunctionDefinition
...@@ -739,17 +743,20 @@ interface Options { ...@@ -739,17 +743,20 @@ interface Options {
dev: boolean dev: boolean
sriEnabled: boolean sriEnabled: boolean
rewrites: CustomRoutes['rewrites'] rewrites: CustomRoutes['rewrites']
edgeEnvironments: Record<string, string>
} }
export default class MiddlewarePlugin { export default class MiddlewarePlugin {
private readonly dev: Options['dev'] private readonly dev: Options['dev']
private readonly sriEnabled: Options['sriEnabled'] private readonly sriEnabled: Options['sriEnabled']
private readonly rewrites: Options['rewrites'] private readonly rewrites: Options['rewrites']
private readonly edgeEnvironments: Record<string, string>
constructor({ dev, sriEnabled, rewrites }: Options) { constructor({ dev, sriEnabled, rewrites, edgeEnvironments }: Options) {
this.dev = dev this.dev = dev
this.sriEnabled = sriEnabled this.sriEnabled = sriEnabled
this.rewrites = rewrites this.rewrites = rewrites
this.edgeEnvironments = edgeEnvironments
} }
public apply(compiler: webpack.Compiler) { public apply(compiler: webpack.Compiler) {
...@@ -795,6 +802,7 @@ export default class MiddlewarePlugin { ...@@ -795,6 +802,7 @@ export default class MiddlewarePlugin {
opts: { opts: {
sriEnabled: this.sriEnabled, sriEnabled: this.sriEnabled,
rewrites: this.rewrites, rewrites: this.rewrites,
edgeEnvironments: this.edgeEnvironments,
}, },
}) })
) )
......
...@@ -505,7 +505,7 @@ export class TurbopackManifestLoader { ...@@ -505,7 +505,7 @@ export class TurbopackManifestLoader {
manifests: Iterable<TurbopackMiddlewareManifest> manifests: Iterable<TurbopackMiddlewareManifest>
): MiddlewareManifest { ): MiddlewareManifest {
const manifest: MiddlewareManifest = { const manifest: MiddlewareManifest = {
version: 2, version: 3,
middleware: {}, middleware: {},
sortedMiddleware: [], sortedMiddleware: [],
functions: {}, functions: {},
......
...@@ -166,20 +166,30 @@ describe('Middleware Runtime', () => { ...@@ -166,20 +166,30 @@ describe('Middleware Runtime', () => {
const manifest = await fs.readJSON( const manifest = await fs.readJSON(
join(next.testDir, '.next/server/middleware-manifest.json') join(next.testDir, '.next/server/middleware-manifest.json')
) )
expect(manifest.middleware).toEqual({ const middlewareWithoutEnvs = {
'/': { ...manifest.middleware['/'],
files: expect.arrayContaining([ }
'server/edge-runtime-webpack.js', const envs = {
'server/middleware.js', ...middlewareWithoutEnvs.environments,
]), }
name: 'middleware', delete middlewareWithoutEnvs.environments
page: '/', expect(middlewareWithoutEnvs).toEqual({
matchers: [{ regexp: '^/.*$', originalSource: '/:path*' }], files: expect.arrayContaining([
wasm: [], 'server/edge-runtime-webpack.js',
assets: [], 'server/middleware.js',
regions: 'auto', ]),
}, name: 'middleware',
page: '/',
matchers: [{ regexp: '^/.*$', originalSource: '/:path*' }],
wasm: [],
assets: [],
regions: 'auto',
}) })
expect(envs).toContainAllKeys([
'previewModeEncryptionKey',
'previewModeId',
'previewModeSigningKey',
])
}) })
it('should have the custom config in the manifest', async () => { it('should have the custom config in the manifest', async () => {
......
...@@ -109,19 +109,21 @@ describe('Middleware Runtime trailing slash', () => { ...@@ -109,19 +109,21 @@ describe('Middleware Runtime trailing slash', () => {
const manifest = await fs.readJSON( const manifest = await fs.readJSON(
join(next.testDir, '.next/server/middleware-manifest.json') join(next.testDir, '.next/server/middleware-manifest.json')
) )
expect(manifest.middleware).toEqual({ const middlewareWithoutEnvs = {
'/': { ...manifest.middleware['/'],
files: expect.arrayContaining([ }
'prerender-manifest.js', delete middlewareWithoutEnvs.environments
'server/edge-runtime-webpack.js', expect(middlewareWithoutEnvs).toEqual({
'server/middleware.js', files: expect.arrayContaining([
]), 'prerender-manifest.js',
name: 'middleware', 'server/edge-runtime-webpack.js',
page: '/', 'server/middleware.js',
matchers: [{ regexp: '^/.*$', originalSource: '/:path*' }], ]),
wasm: [], name: 'middleware',
assets: [], page: '/',
}, matchers: [{ regexp: '^/.*$', originalSource: '/:path*' }],
wasm: [],
assets: [],
}) })
}) })
......
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