Unverified Commit 5eec6df5 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

[metadata] disable streaming metadata for ppr deployment (#75978)

### What

This PR forcedly disables the streaming metadata on vercel deployment
when PPR is enabled on the target route. There're still some work need
to be done on infra side, so we only let non-PPR mode and self-hosting
PPR (mostly local testing) be controlled by `streamingMetadata` flag.

Once the blocker is gone, then we can re-enable it
parent 7aa6040a
...@@ -2771,7 +2771,11 @@ export default async function build( ...@@ -2771,7 +2771,11 @@ export default async function build(
}, },
// If it's PPR rendered non-static page, bypass the PPR cache when streaming metadata is enabled. // If it's PPR rendered non-static page, bypass the PPR cache when streaming metadata is enabled.
// This will skip the postpone data for those bots requests and instead produce a dynamic render. // This will skip the postpone data for those bots requests and instead produce a dynamic render.
...(isRoutePPREnabled && config.experimental.streamingMetadata ...(isRoutePPREnabled &&
// Disable streaming metadata for PPR on deployment where we don't have the special env.
// TODO: enable streaming metadata in PPR mode by default once it's ready.
process.env.__NEXT_EXPERIMENTAL_PPR === 'true' &&
config.experimental.streamingMetadata
? [ ? [
{ {
type: 'header', type: 'header',
......
...@@ -434,6 +434,17 @@ function NonIndex({ ctx }: { ctx: AppRenderContext }) { ...@@ -434,6 +434,17 @@ function NonIndex({ ctx }: { ctx: AppRenderContext }) {
return null return null
} }
function getServeStreamingMetadata(ctx: AppRenderContext) {
const isRoutePPREnabled = !!ctx.renderOpts.experimental.isRoutePPREnabled
const serveStreamingMetadata = !!ctx.renderOpts.serveStreamingMetadata
// If the route is in PPR and the special env is not set, disable the streaming metadata.
// TODO: enable streaming metadata in PPR mode by default once it's ready.
if (isRoutePPREnabled && process.env.__NEXT_EXPERIMENTAL_PPR !== 'true') {
return false
}
return serveStreamingMetadata
}
/** /**
* This is used by server actions & client-side navigations to generate RSC data from a client-side request. * This is used by server actions & client-side navigations to generate RSC data from a client-side request.
* This function is only called on "dynamic" requests (ie, there wasn't already a static response). * This function is only called on "dynamic" requests (ie, there wasn't already a static response).
...@@ -473,6 +484,8 @@ async function generateDynamicRSCPayload( ...@@ -473,6 +484,8 @@ async function generateDynamicRSCPayload(
url, url,
} = ctx } = ctx
const serveStreamingMetadata = getServeStreamingMetadata(ctx)
if (!options?.skipFlight) { if (!options?.skipFlight) {
const preloadCallbacks: PreloadCallbacks = [] const preloadCallbacks: PreloadCallbacks = []
...@@ -492,7 +505,7 @@ async function generateDynamicRSCPayload( ...@@ -492,7 +505,7 @@ async function generateDynamicRSCPayload(
workStore, workStore,
MetadataBoundary, MetadataBoundary,
ViewportBoundary, ViewportBoundary,
serveStreamingMetadata: !!ctx.renderOpts.serveStreamingMetadata, serveStreamingMetadata,
}) })
const { StreamingMetadata, StaticMetadata } = const { StreamingMetadata, StaticMetadata } =
...@@ -501,7 +514,7 @@ async function generateDynamicRSCPayload( ...@@ -501,7 +514,7 @@ async function generateDynamicRSCPayload(
// Adding requestId as react key to make metadata remount for each render // Adding requestId as react key to make metadata remount for each render
<MetadataTree key={requestId} /> <MetadataTree key={requestId} />
) )
}, !!ctx.renderOpts.serveStreamingMetadata) }, serveStreamingMetadata)
flightData = ( flightData = (
await walkTreeWithFlightRouterState({ await walkTreeWithFlightRouterState({
...@@ -779,6 +792,7 @@ async function getRSCPayload( ...@@ -779,6 +792,7 @@ async function getRSCPayload(
getDynamicParamFromSegment, getDynamicParamFromSegment,
query query
) )
const serveStreamingMetadata = getServeStreamingMetadata(ctx)
const searchParams = createServerSearchParamsForMetadata(query, workStore) const searchParams = createServerSearchParamsForMetadata(query, workStore)
const { ViewportTree, MetadataTree, getViewportReady, getMetadataReady } = const { ViewportTree, MetadataTree, getViewportReady, getMetadataReady } =
...@@ -797,7 +811,7 @@ async function getRSCPayload( ...@@ -797,7 +811,7 @@ async function getRSCPayload(
workStore, workStore,
MetadataBoundary, MetadataBoundary,
ViewportBoundary, ViewportBoundary,
serveStreamingMetadata: !!ctx.renderOpts.serveStreamingMetadata, serveStreamingMetadata: serveStreamingMetadata,
}) })
const preloadCallbacks: PreloadCallbacks = [] const preloadCallbacks: PreloadCallbacks = []
...@@ -808,7 +822,7 @@ async function getRSCPayload( ...@@ -808,7 +822,7 @@ async function getRSCPayload(
// Not add requestId as react key to ensure segment prefetch could result consistently if nothing changed // Not add requestId as react key to ensure segment prefetch could result consistently if nothing changed
<MetadataTree /> <MetadataTree />
) )
}, !!ctx.renderOpts.serveStreamingMetadata) }, serveStreamingMetadata)
const seedData = await createComponentTree({ const seedData = await createComponentTree({
ctx, ctx,
...@@ -910,6 +924,7 @@ async function getErrorRSCPayload( ...@@ -910,6 +924,7 @@ async function getErrorRSCPayload(
workStore, workStore,
} = ctx } = ctx
const serveStreamingMetadata = getServeStreamingMetadata(ctx)
const searchParams = createServerSearchParamsForMetadata(query, workStore) const searchParams = createServerSearchParamsForMetadata(query, workStore)
const { MetadataTree, ViewportTree } = createMetadataComponents({ const { MetadataTree, ViewportTree } = createMetadataComponents({
tree, tree,
...@@ -924,7 +939,7 @@ async function getErrorRSCPayload( ...@@ -924,7 +939,7 @@ async function getErrorRSCPayload(
workStore, workStore,
MetadataBoundary, MetadataBoundary,
ViewportBoundary, ViewportBoundary,
serveStreamingMetadata: !!ctx.renderOpts.serveStreamingMetadata, serveStreamingMetadata: serveStreamingMetadata,
}) })
const { StreamingMetadata, StaticMetadata } = const { StreamingMetadata, StaticMetadata } =
...@@ -935,7 +950,7 @@ async function getErrorRSCPayload( ...@@ -935,7 +950,7 @@ async function getErrorRSCPayload(
<MetadataTree key={requestId} /> <MetadataTree key={requestId} />
</React.Fragment> </React.Fragment>
), ),
!!ctx.renderOpts.serveStreamingMetadata serveStreamingMetadata
) )
const initialHead = ( const initialHead = (
......
...@@ -2,6 +2,9 @@ import { nextTestSetup } from 'e2e-utils' ...@@ -2,6 +2,9 @@ import { nextTestSetup } from 'e2e-utils'
import cheerio from 'cheerio' import cheerio from 'cheerio'
import { assertNoConsoleErrors } from 'next-test-utils' import { assertNoConsoleErrors } from 'next-test-utils'
// TODO: remove this env once streaming metadata is available for ppr
process.env.__NEXT_EXPERIMENTAL_PPR = 'true'
function countSubstring(str: string, substr: string): number { function countSubstring(str: string, substr: string): number {
return str.split(substr).length - 1 return str.split(substr).length - 1
} }
......
import { nextTestSetup } from 'e2e-utils' import { nextTestSetup } from 'e2e-utils'
// TODO: remove this env once streaming metadata is available for ppr
process.env.__NEXT_EXPERIMENTAL_PPR = 'true'
describe('app-dir - metadata-streaming-config-customized', () => { describe('app-dir - metadata-streaming-config-customized', () => {
const { next } = nextTestSetup({ const { next } = nextTestSetup({
files: __dirname, files: __dirname,
......
import { nextTestSetup } from 'e2e-utils' import { nextTestSetup } from 'e2e-utils'
// TODO: remove this env once streaming metadata is available for ppr
process.env.__NEXT_EXPERIMENTAL_PPR = 'true'
describe('app-dir - metadata-streaming-config', () => { describe('app-dir - metadata-streaming-config', () => {
const { next } = nextTestSetup({ const { next } = nextTestSetup({
files: __dirname, files: __dirname,
......
import { Suspense } from 'react'
export default function Root({ children }) {
return <Suspense fallback={<p>Loading...</p>}>{children}</Suspense>
}
import { connection } from 'next/server'
export default async function Page() {
return <p>hello world</p>
}
// Dynamic metadata
export async function generateMetadata() {
await connection()
await new Promise((resolve) => setTimeout(resolve, 1000))
return { title: 'dynamic-title' }
}
import { ReactNode } from 'react'
import Link from 'next/link'
export default function Root({ children }: { children: ReactNode }) {
return (
<html>
<body>
<nav>
<Link href="/ppr">ppr</Link>
<Link href="/dynamic">dynamic</Link>
</nav>
{children}
</body>
</html>
)
}
import { Suspense } from 'react'
export default function Root({ children }) {
return <Suspense fallback={<p>Loading...</p>}>{children}</Suspense>
}
import { connection } from 'next/server'
export default async function Page() {
await connection()
return <p>ppr</p>
}
export async function generateMetadata() {
await connection()
return { title: 'ppr-title' }
}
export const experimental_ppr = true
/**
* @type {import('next').NextConfig}
*/
const nextConfig = {
experimental: {
ppr: 'incremental',
streamingMetadata: true,
},
}
module.exports = nextConfig
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