Unverified Commit c663876c authored by Josh Story's avatar Josh Story Committed by GitHub

Refactor metadata and viewport preloading (#77400)

metadata and viewport are attempted to be resolved concurrently even
when async functions are used via `generateMetadata` and
`generateViewport`. We call this preloading because we initiate the
generation ahead of time but if it turns out that any particular
generator requires the parent resolved values we can progressively
reveal these to each pending generator. This PR refactors the code a bit
to simplify and clarify this process. This is setting the stage to later
separate out the resolution of viewport from metadata since only
viewport is now blocking the root.
parent 3468f10c
import type { ResolvedMetadata } from './types/metadata-interface' import type {
ResolvedMetadata,
ResolvedViewport,
} from './types/metadata-interface'
const TYPE_URL = '__METADATA_URL' const TYPE_URL = '__METADATA_URL'
...@@ -17,7 +20,9 @@ function reviver(_key: string, val: any) { ...@@ -17,7 +20,9 @@ function reviver(_key: string, val: any) {
return val return val
} }
export function cloneMetadata(metadata: ResolvedMetadata): ResolvedMetadata { export function cloneMetadata<T extends ResolvedMetadata | ResolvedViewport>(
metadata: T
): T {
const jsonString = JSON.stringify(metadata, replacer) const jsonString = JSON.stringify(metadata, replacer)
return JSON.parse(jsonString, reviver) return JSON.parse(jsonString, reviver)
} }
...@@ -682,21 +682,47 @@ function postProcessMetadata( ...@@ -682,21 +682,47 @@ function postProcessMetadata(
return metadata return metadata
} }
type DataResolver<Data, ResolvedData> = ( type Result<T> = null | T | Promise<null | T> | PromiseLike<null | T>
parent: Promise<ResolvedData>
) => Data | Promise<Data> function prerenderMetadata(metadataItems: MetadataItems) {
// If the index is a function then it is a resolver and the next slot
function collectMetadataExportPreloading<Data, ResolvedData>( // is the corresponding result. If the index is not a function it is the result
results: (Data | Promise<Data>)[], // itself.
dynamicMetadataExportFn: DataResolver<Data, ResolvedData>, const resolversAndResults: Array<
resolvers: ((value: ResolvedData) => void)[] ((value: ResolvedMetadata) => void) | Result<Metadata>
> = []
for (let i = 0; i < metadataItems.length; i++) {
const metadataExport = metadataItems[i][0]
getResult(resolversAndResults, metadataExport)
}
return resolversAndResults
}
function prerenderViewport(metadataItems: MetadataItems) {
// If the index is a function then it is a resolver and the next slot
// is the corresponding result. If the index is not a function it is the result
// itself.
const resolversAndResults: Array<
((value: ResolvedViewport) => void) | Result<Viewport>
> = []
for (let i = 0; i < metadataItems.length; i++) {
const viewportExport = metadataItems[i][2]
getResult(resolversAndResults, viewportExport)
}
return resolversAndResults
}
type Resolved<T> = T extends Metadata ? ResolvedMetadata : ResolvedViewport
function getResult<T extends Metadata | Viewport>(
resolversAndResults: Array<((value: Resolved<T>) => void) | Result<T>>,
exportForResult: null | T | ((parent: Promise<Resolved<T>>) => Result<T>)
) { ) {
const result = dynamicMetadataExportFn( if (typeof exportForResult === 'function') {
new Promise<any>((resolve) => { const result = exportForResult(
resolvers.push(resolve) new Promise<Resolved<T>>((resolve) => resolversAndResults.push(resolve))
})
) )
resolversAndResults.push(result)
if (result instanceof Promise) { if (result instanceof Promise) {
// since we eager execute generateMetadata and // since we eager execute generateMetadata and
// they can reject at anytime we need to ensure // they can reject at anytime we need to ensure
...@@ -708,72 +734,28 @@ function collectMetadataExportPreloading<Data, ResolvedData>( ...@@ -708,72 +734,28 @@ function collectMetadataExportPreloading<Data, ResolvedData>(
} }
}) })
} }
results.push(result) } else if (typeof exportForResult === 'object') {
} resolversAndResults.push(exportForResult)
} else {
async function getMetadataFromExport<Data, ResolvedData>( resolversAndResults.push(null)
getPreloadMetadataExport: (
metadataItem: NonNullable<MetadataItems[number]>
) => Data | DataResolver<Data, ResolvedData> | null,
dynamicMetadataResolveState: {
resolvers: ((value: ResolvedData) => void)[]
resolvingIndex: number
},
metadataItems: MetadataItems,
currentIndex: number,
resolvedMetadata: ResolvedData,
metadataResults: (Data | Promise<Data>)[]
) {
const metadataExport = getPreloadMetadataExport(metadataItems[currentIndex])
const dynamicMetadataResolvers = dynamicMetadataResolveState.resolvers
let metadata: Data | null = null
if (typeof metadataExport === 'function') {
// Only preload at the beginning when resolves are empty
if (!dynamicMetadataResolvers.length) {
for (let j = currentIndex; j < metadataItems.length; j++) {
const preloadMetadataExport = getPreloadMetadataExport(metadataItems[j])
// call each `generateMetadata function concurrently and stash their resolver
if (typeof preloadMetadataExport === 'function') {
collectMetadataExportPreloading<Data, ResolvedData>(
metadataResults,
preloadMetadataExport as DataResolver<Data, ResolvedData>,
dynamicMetadataResolvers
)
}
}
} }
}
const resolveParent = function resolvePendingResult<
dynamicMetadataResolvers[dynamicMetadataResolveState.resolvingIndex] ResolvedType extends ResolvedMetadata | ResolvedViewport,
const metadataResult = >(
metadataResults[dynamicMetadataResolveState.resolvingIndex++] parentResult: ResolvedType,
resolveParentResult: (value: ResolvedType) => void
): void {
// In dev we clone and freeze to prevent relying on mutating resolvedMetadata directly. // In dev we clone and freeze to prevent relying on mutating resolvedMetadata directly.
// In prod we just pass resolvedMetadata through without any copying. // In prod we just pass resolvedMetadata through without any copying.
const currentResolvedMetadata = if (process.env.NODE_ENV === 'development') {
process.env.NODE_ENV === 'development' parentResult = require('../../shared/lib/deep-freeze').deepFreeze(
? Object.freeze( require('./clone-metadata').cloneMetadata(parentResult)
require('./clone-metadata').cloneMetadata(resolvedMetadata)
) )
: resolvedMetadata
// This resolve should unblock the generateMetadata function if it awaited the parent
// argument. If it didn't await the parent argument it might already have a value since it was
// called concurrently. Regardless we await the return value before continuing on to the next layer
resolveParent(currentResolvedMetadata)
metadata =
metadataResult instanceof Promise ? await metadataResult : metadataResult
if (metadata && typeof metadata === 'object' && '__nextError' in metadata) {
// re-throw caught metadata error from preloading
throw metadata['__nextError']
}
} else if (metadataExport !== null && typeof metadataExport === 'object') {
// This metadataExport is the object form
metadata = metadataExport
} }
return metadata resolveParentResult(parentResult)
} }
export async function accumulateMetadata( export async function accumulateMetadata(
...@@ -781,7 +763,6 @@ export async function accumulateMetadata( ...@@ -781,7 +763,6 @@ export async function accumulateMetadata(
metadataContext: MetadataContext metadataContext: MetadataContext
): Promise<ResolvedMetadata> { ): Promise<ResolvedMetadata> {
const resolvedMetadata = createDefaultMetadata() const resolvedMetadata = createDefaultMetadata()
const metadataResults: (Metadata | Promise<Metadata>)[] = []
let titleTemplates: TitleTemplates = { let titleTemplates: TitleTemplates = {
title: null, title: null,
...@@ -789,12 +770,6 @@ export async function accumulateMetadata( ...@@ -789,12 +770,6 @@ export async function accumulateMetadata(
openGraph: null, openGraph: null,
} }
// Loop over all metadata items again, merging synchronously any static object exports,
// awaiting any static promise exports, and resolving parent metadata and awaiting any generated metadata
const dynamicMetadataResolvers = {
resolvers: [],
resolvingIndex: 0,
}
const buildState = { const buildState = {
warnings: new Set<string>(), warnings: new Set<string>(),
} }
...@@ -807,9 +782,12 @@ export async function accumulateMetadata( ...@@ -807,9 +782,12 @@ export async function accumulateMetadata(
icon: [], icon: [],
apple: [], apple: [],
} }
const resolversAndResults = prerenderMetadata(metadataItems)
let resultIndex = 0
for (let i = 0; i < metadataItems.length; i++) { for (let i = 0; i < metadataItems.length; i++) {
const staticFilesMetadata = metadataItems[i][1] const staticFilesMetadata = metadataItems[i][1]
// Treat favicon as special case, it should be the first icon in the list // Treat favicon as special case, it should be the first icon in the list
// i <= 1 represents root layout, and if current page is also at root // i <= 1 represents root layout, and if current page is also at root
if (i <= 1 && isFavicon(staticFilesMetadata?.icon?.[0])) { if (i <= 1 && isFavicon(staticFilesMetadata?.icon?.[0])) {
...@@ -817,14 +795,26 @@ export async function accumulateMetadata( ...@@ -817,14 +795,26 @@ export async function accumulateMetadata(
if (i === 0) favicon = iconMod if (i === 0) favicon = iconMod
} }
const metadata = await getMetadataFromExport<Metadata, ResolvedMetadata>( let pendingMetadata = resolversAndResults[resultIndex++]
(metadataItem) => metadataItem[0], if (typeof pendingMetadata === 'function') {
dynamicMetadataResolvers, // This metadata item had a `generateMetadata` and
metadataItems, // we need to provide the currently resolved metadata
i, // to it before we continue;
resolvedMetadata, const resolveParentMetadata = pendingMetadata
metadataResults // we know that the next item is a result if this item
) // was a resolver
pendingMetadata = resolversAndResults[resultIndex++] as Result<Metadata>
resolvePendingResult(resolvedMetadata, resolveParentMetadata)
}
// Otherwise the item was either null or a static export
let metadata: Metadata | null
if (isPromiseLike(pendingMetadata)) {
metadata = await pendingMetadata
} else {
metadata = pendingMetadata
}
mergeMetadata({ mergeMetadata({
target: resolvedMetadata, target: resolvedMetadata,
...@@ -885,20 +875,30 @@ export async function accumulateViewport( ...@@ -885,20 +875,30 @@ export async function accumulateViewport(
): Promise<ResolvedViewport> { ): Promise<ResolvedViewport> {
const resolvedViewport: ResolvedViewport = createDefaultViewport() const resolvedViewport: ResolvedViewport = createDefaultViewport()
const viewportResults: (Viewport | Promise<Viewport>)[] = [] const resolversAndResults = prerenderViewport(metadataItems)
const dynamicMetadataResolvers = { let i = 0
resolvers: [],
resolvingIndex: 0, while (i < resolversAndResults.length) {
let pendingViewport = resolversAndResults[i++]
if (typeof pendingViewport === 'function') {
// this viewport item had a `generateViewport` and
// we need to provide the currently resolved viewport
// to it before we continue;
const resolveParentViewport = pendingViewport
// we know that the next item is a result if this item
// was a resolver
pendingViewport = resolversAndResults[i++] as Result<Viewport>
resolvePendingResult(resolvedViewport, resolveParentViewport)
}
// Otherwise the item was either null or a static export
let viewport: Viewport | null
if (isPromiseLike(pendingViewport)) {
viewport = await pendingViewport
} else {
viewport = pendingViewport
} }
for (let i = 0; i < metadataItems.length; i++) {
const viewport = await getMetadataFromExport<Viewport, ResolvedViewport>(
(metadataItem) => metadataItem[2],
dynamicMetadataResolvers,
metadataItems,
i,
resolvedViewport,
viewportResults
)
mergeViewport({ mergeViewport({
target: resolvedViewport, target: resolvedViewport,
...@@ -948,3 +948,13 @@ export async function resolveViewport( ...@@ -948,3 +948,13 @@ export async function resolveViewport(
) )
return accumulateViewport(metadataItems) return accumulateViewport(metadataItems)
} }
function isPromiseLike<T>(
value: unknown | PromiseLike<T>
): value is PromiseLike<T> {
return (
typeof value === 'object' &&
value !== null &&
typeof (value as PromiseLike<unknown>).then === 'function'
)
}
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