Commit 1f299870 authored by JJ Kasper's avatar JJ Kasper Committed by Janka Uryga

Add draft mode flag for multi-zone (#68997)

When an application is running in multi-zone API endpoints can have
differing draft mode IDs on the same domain so we need to avoid clearing
the original when we see a mismatch as that can break the current
applications draft mode. This is behind a flag initially to validate but
it should be safe to make the default in the future as an invalid draft
mode ID just gets ignored.

x-ref: [slack
thread](https://vercel.slack.com/archives/C052BQ8F9EJ/p1723844164102539)
parent 79177b7b
...@@ -41,6 +41,7 @@ type ApiContext = __ApiPreviewProps & { ...@@ -41,6 +41,7 @@ type ApiContext = __ApiPreviewProps & {
allowedRevalidateHeaderKeys?: string[] allowedRevalidateHeaderKeys?: string[]
hostname?: string hostname?: string
revalidate?: RevalidateFn revalidate?: RevalidateFn
multiZoneDraftMode?: boolean
} }
function getMaxContentLength(responseLimit?: ResponseLimit) { function getMaxContentLength(responseLimit?: ResponseLimit) {
...@@ -346,7 +347,7 @@ export async function apiResolver( ...@@ -346,7 +347,7 @@ export async function apiResolver(
apiReq.query = query apiReq.query = query
// Parsing preview data // Parsing preview data
setLazyProp({ req: apiReq }, 'previewData', () => setLazyProp({ req: apiReq }, 'previewData', () =>
tryGetPreviewData(req, res, apiContext) tryGetPreviewData(req, res, apiContext, !!apiContext.multiZoneDraftMode)
) )
// Checking if preview mode is enabled // Checking if preview mode is enabled
setLazyProp({ req: apiReq }, 'preview', () => setLazyProp({ req: apiReq }, 'preview', () =>
......
...@@ -17,7 +17,8 @@ import { HeadersAdapter } from '../../web/spec-extension/adapters/headers' ...@@ -17,7 +17,8 @@ import { HeadersAdapter } from '../../web/spec-extension/adapters/headers'
export function tryGetPreviewData( export function tryGetPreviewData(
req: IncomingMessage | BaseNextRequest | Request, req: IncomingMessage | BaseNextRequest | Request,
res: ServerResponse | BaseNextResponse, res: ServerResponse | BaseNextResponse,
options: __ApiPreviewProps options: __ApiPreviewProps,
multiZoneDraftMode: boolean
): PreviewData { ): PreviewData {
// if an On-Demand revalidation is being done preview mode // if an On-Demand revalidation is being done preview mode
// is disabled // is disabled
...@@ -61,13 +62,17 @@ export function tryGetPreviewData( ...@@ -61,13 +62,17 @@ export function tryGetPreviewData(
// Case: one cookie is set, but not the other. // Case: one cookie is set, but not the other.
if (!previewModeId || !tokenPreviewData) { if (!previewModeId || !tokenPreviewData) {
clearPreviewData(res as NextApiResponse) if (!multiZoneDraftMode) {
clearPreviewData(res as NextApiResponse)
}
return false return false
} }
// Case: preview session is for an old build. // Case: preview session is for an old build.
if (previewModeId !== options.previewModeId) { if (previewModeId !== options.previewModeId) {
clearPreviewData(res as NextApiResponse) if (!multiZoneDraftMode) {
clearPreviewData(res as NextApiResponse)
}
return false return false
} }
......
...@@ -1959,7 +1959,12 @@ export default abstract class Server<ServerOptions extends Options = Options> { ...@@ -1959,7 +1959,12 @@ export default abstract class Server<ServerOptions extends Options = Options> {
if (process.env.NEXT_RUNTIME !== 'edge') { if (process.env.NEXT_RUNTIME !== 'edge') {
const { tryGetPreviewData } = const { tryGetPreviewData } =
require('./api-utils/node/try-get-preview-data') as typeof import('./api-utils/node/try-get-preview-data') require('./api-utils/node/try-get-preview-data') as typeof import('./api-utils/node/try-get-preview-data')
previewData = tryGetPreviewData(req, res, this.renderOpts.previewProps) previewData = tryGetPreviewData(
req,
res,
this.renderOpts.previewProps,
!!this.nextConfig.experimental.multiZoneDraftMode
)
isPreviewMode = previewData !== false isPreviewMode = previewData !== false
} }
} }
...@@ -2181,6 +2186,7 @@ export default abstract class Server<ServerOptions extends Options = Options> { ...@@ -2181,6 +2186,7 @@ export default abstract class Server<ServerOptions extends Options = Options> {
locale, locale,
locales, locales,
defaultLocale, defaultLocale,
multiZoneDraftMode: this.nextConfig.experimental.multiZoneDraftMode,
// For getServerSideProps and getInitialProps we need to ensure we use the original URL // For getServerSideProps and getInitialProps we need to ensure we use the original URL
// and not the resolved URL to prevent a hydration mismatch on // and not the resolved URL to prevent a hydration mismatch on
// asPath // asPath
......
...@@ -297,6 +297,7 @@ export const configSchema: zod.ZodType<NextConfig> = z.lazy(() => ...@@ -297,6 +297,7 @@ export const configSchema: zod.ZodType<NextConfig> = z.lazy(() =>
linkNoTouchStart: z.boolean().optional(), linkNoTouchStart: z.boolean().optional(),
manualClientBasePath: z.boolean().optional(), manualClientBasePath: z.boolean().optional(),
middlewarePrefetch: z.enum(['strict', 'flexible']).optional(), middlewarePrefetch: z.enum(['strict', 'flexible']).optional(),
multiZoneDraftMode: z.boolean().optional(),
cssChunking: z.enum(['strict', 'loose']).optional(), cssChunking: z.enum(['strict', 'loose']).optional(),
nextScriptWorkers: z.boolean().optional(), nextScriptWorkers: z.boolean().optional(),
// The critter option is unknown, use z.any() here // The critter option is unknown, use z.any() here
......
...@@ -181,6 +181,7 @@ export interface NextJsWebpackConfig { ...@@ -181,6 +181,7 @@ export interface NextJsWebpackConfig {
} }
export interface ExperimentalConfig { export interface ExperimentalConfig {
multiZoneDraftMode?: boolean
prerenderEarlyExit?: boolean prerenderEarlyExit?: boolean
linkNoTouchStart?: boolean linkNoTouchStart?: boolean
caseSensitiveRoutes?: boolean caseSensitiveRoutes?: boolean
...@@ -877,6 +878,7 @@ export const defaultConfig: NextConfig = { ...@@ -877,6 +878,7 @@ export const defaultConfig: NextConfig = {
output: !!process.env.NEXT_PRIVATE_STANDALONE ? 'standalone' : undefined, output: !!process.env.NEXT_PRIVATE_STANDALONE ? 'standalone' : undefined,
modularizeImports: undefined, modularizeImports: undefined,
experimental: { experimental: {
multiZoneDraftMode: false,
prerenderEarlyExit: false, prerenderEarlyExit: false,
serverMinification: true, serverMinification: true,
serverSourceMaps: false, serverSourceMaps: false,
......
...@@ -93,6 +93,11 @@ type PagesAPIRouteHandlerContext = RouteModuleHandleContext & { ...@@ -93,6 +93,11 @@ type PagesAPIRouteHandlerContext = RouteModuleHandleContext & {
* The page that's being rendered. * The page that's being rendered.
*/ */
page: string page: string
/**
* whether multi-zone flag is enabled for draft mode
*/
multiZoneDraftMode?: boolean
} }
export type PagesAPIRouteModuleOptions = RouteModuleOptions< export type PagesAPIRouteModuleOptions = RouteModuleOptions<
...@@ -144,6 +149,7 @@ export class PagesAPIRouteModule extends RouteModule< ...@@ -144,6 +149,7 @@ export class PagesAPIRouteModule extends RouteModule<
trustHostHeader: context.trustHostHeader, trustHostHeader: context.trustHostHeader,
allowedRevalidateHeaderKeys: context.allowedRevalidateHeaderKeys, allowedRevalidateHeaderKeys: context.allowedRevalidateHeaderKeys,
hostname: context.hostname, hostname: context.hostname,
multiZoneDraftMode: context.multiZoneDraftMode,
}, },
context.minimalMode, context.minimalMode,
context.dev, context.dev,
......
...@@ -67,6 +67,7 @@ export type LoadComponentsReturnType<NextModule = any> = { ...@@ -67,6 +67,7 @@ export type LoadComponentsReturnType<NextModule = any> = {
routeModule?: RouteModule routeModule?: RouteModule
isAppPath?: boolean isAppPath?: boolean
page: string page: string
multiZoneDraftMode?: boolean
} }
/** /**
......
...@@ -535,6 +535,7 @@ export default class NextNodeServer extends BaseServer { ...@@ -535,6 +535,7 @@ export default class NextNodeServer extends BaseServer {
query, query,
params: match.params, params: match.params,
page: match.definition.pathname, page: match.definition.pathname,
multiZoneDraftMode: this.nextConfig.experimental.multiZoneDraftMode,
} }
) )
......
...@@ -648,7 +648,12 @@ export async function renderToHTMLImpl( ...@@ -648,7 +648,12 @@ export async function renderToHTMLImpl(
// Reads of this are cached on the `req` object, so this should resolve // Reads of this are cached on the `req` object, so this should resolve
// instantly. There's no need to pass this data down from a previous // instantly. There's no need to pass this data down from a previous
// invoke. // invoke.
previewData = tryGetPreviewData(req, res, previewProps) previewData = tryGetPreviewData(
req,
res,
previewProps,
!!renderOpts.multiZoneDraftMode
)
isPreview = previewData !== false isPreview = previewData !== false
} }
......
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