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