Unverified Commit 15aa25f2 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Refactor freezing metadata while resolving and fix title merging (#45965)

Addressing @gnoff 's comments from #45923

* Only freezing for the parentMetadata `argument`
* Group dev specific code in one place for less branches and better DEC
* Concurrently run the metadata resolving promises

Fix title merging: should use the parent layout instead of adjacent
layout
parent e6c9f514
......@@ -60,7 +60,7 @@ async function createAppRouteCode({
return `
import 'next/dist/server/node-polyfill-headers'
export * as handlers from ${JSON.stringify(resolvedPagePath)}
export const resolvedPagePath = ${JSON.stringify(resolvedPagePath)}
......
......@@ -7,7 +7,7 @@ export function BasicMetadata({ metadata }: { metadata: ResolvedMetadata }) {
return (
<>
<meta charSet="utf-8" />
{metadata.title !== null ? (
{metadata.title !== null && metadata.title.absolute ? (
<title>{metadata.title.absolute}</title>
) : null}
<Meta name="description" content={metadata.description} />
......
import { accumulateMetadata, MetadataItems } from './resolve-metadata'
describe('accumulateMetadata', () => {
describe('merge title', () => {
it('should merge title with page title', async () => {
const metadataItems: MetadataItems = [
[{ title: 'root' }, null],
[{ title: 'layout' }, null],
[{ title: 'page' }, null],
]
const metadata = await accumulateMetadata(metadataItems)
expect(metadata).toMatchObject({
title: { absolute: 'page', template: null },
})
})
it('should merge title with parent layout ', async () => {
const metadataItems: MetadataItems = [
[{ title: 'root' }, null],
[
{ title: { absolute: 'layout', template: '1st parent layout %s' } },
null,
],
[
{ title: { absolute: 'layout', template: '2nd parent layout %s' } },
null,
],
[null, null], // same level layout
[{ title: 'page' }, null],
]
const metadata = await accumulateMetadata(metadataItems)
expect(metadata).toMatchObject({
title: { absolute: '2nd parent layout page', template: null },
})
})
})
})
......@@ -3,11 +3,10 @@ import type {
ResolvedMetadata,
ResolvingMetadata,
} from './types/metadata-interface'
import type { AbsoluteTemplateString } from './types/metadata-types'
import type { MetadataImageModule } from '../../build/webpack/loaders/metadata/types'
import { createDefaultMetadata } from './default-metadata'
import { resolveOpenGraph, resolveTwitter } from './resolvers/resolve-opengraph'
import { mergeTitle } from './resolvers/resolve-title'
import { resolveTitle } from './resolvers/resolve-title'
import { resolveAsArrayOrUndefined } from './generate/utils'
import { isClientReference } from '../../build/is-client-reference'
import {
......@@ -76,10 +75,10 @@ function merge(
target: ResolvedMetadata,
source: Metadata | null,
staticFilesMetadata: StaticMetadata,
templateStrings: {
titleTemplates: {
title: string | null
openGraph: string | null
twitter: string | null
openGraph: string | null
}
) {
const metadataBase = source?.metadataBase || null
......@@ -88,10 +87,7 @@ function merge(
switch (key) {
case 'title': {
if (source.title) {
target.title = source.title as AbsoluteTemplateString
mergeTitle(target, templateStrings.title)
}
target.title = resolveTitle(source.title, titleTemplates.title)
break
}
case 'alternates': {
......@@ -99,16 +95,23 @@ function merge(
break
}
case 'openGraph': {
if (target.openGraph) console.log('override')
target.openGraph = resolveOpenGraph(source.openGraph, metadataBase)
if (target.openGraph) {
mergeTitle(target.openGraph, templateStrings.openGraph)
target.openGraph.title = resolveTitle(
target.openGraph.title,
titleTemplates.openGraph
)
}
break
}
case 'twitter': {
target.twitter = resolveTwitter(source.twitter, metadataBase)
if (target.twitter) {
mergeTitle(target.twitter, templateStrings.twitter)
target.twitter.title = resolveTitle(
target.twitter.title,
titleTemplates.twitter
)
}
break
}
......@@ -248,40 +251,84 @@ export async function collectMetadata(
export async function accumulateMetadata(
metadataItems: MetadataItems
): Promise<ResolvedMetadata> {
const deepClone: <T>(v: T) => T =
process.env.NODE_ENV === 'development'
? require('next/dist/compiled/@edge-runtime/primitives/structured-clone')
.structuredClone
: (v) => v
const resolvedMetadata = createDefaultMetadata()
let parentPromise = Promise.resolve(resolvedMetadata)
const resolvers: ((value: ResolvedMetadata) => void)[] = []
const generateMetadataResults: (Metadata | Promise<Metadata>)[] = []
let titleTemplates: {
title: string | null
twitter: string | null
openGraph: string | null
} = {
title: null,
twitter: 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
for (const item of metadataItems) {
const [metadataExport, staticFilesMetadata] = item
const currentMetadata =
typeof metadataExport === 'function'
? metadataExport(parentPromise)
: metadataExport
const layerMetadataPromise =
currentMetadata instanceof Promise
? currentMetadata
: Promise.resolve(currentMetadata)
let resolvingIndex = 0
for (let i = 0; i < metadataItems.length; i++) {
const [metadataExport, staticFilesMetadata] = metadataItems[i]
let metadata: Metadata | null = null
if (typeof metadataExport === 'function') {
if (!resolvers.length) {
for (let j = i; j < metadataItems.length; j++) {
const [preloadMetadataExport] = metadataItems[j]
// call each `generateMetadata function concurrently and stash their resolver
if (typeof preloadMetadataExport === 'function') {
generateMetadataResults.push(
preloadMetadataExport(
new Promise((resolve) => {
resolvers.push(resolve)
})
)
)
}
}
}
const resolveParent = resolvers[resolvingIndex]
const generatedMetadata = generateMetadataResults[resolvingIndex++]
parentPromise = parentPromise.then((resolved) => {
return layerMetadataPromise.then((metadata) => {
resolved = deepClone(resolved)
merge(resolved, metadata, staticFilesMetadata, {
title: resolved.title?.template || null,
openGraph: resolved.openGraph?.title?.template || null,
twitter: resolved.twitter?.title?.template || null,
})
return process.env.NODE_ENV === 'development'
? Object.freeze(resolved)
: resolved
})
})
// In dev we clone and freeze to prevent relying on mutating resolvedMetadata directly.
// In prod we just pass resolvedMetadata through without any copying.
const currentResolvedMetadata: ResolvedMetadata =
process.env.NODE_ENV === 'development'
? Object.freeze(
require('next/dist/compiled/@edge-runtime/primitives/structured-clone').structuredClone(
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 =
generatedMetadata instanceof Promise
? await generatedMetadata
: generatedMetadata
} else if (metadataExport !== null && typeof metadataExport === 'object') {
// This metadataExport is the object form
metadata = metadataExport
}
merge(resolvedMetadata, metadata, staticFilesMetadata, titleTemplates)
// If the layout is the same layer with page, skip the leaf layout and leaf page
// The leaf layout and page are the last two items
if (i < metadataItems.length - 2) {
titleTemplates = {
title: resolvedMetadata.title?.template || null,
openGraph: resolvedMetadata.openGraph?.title?.template || null,
twitter: resolvedMetadata.twitter?.title?.template || null,
}
}
}
return await parentPromise
return resolvedMetadata
}
import { resolveTitle } from './resolve-title'
describe('resolveTitle', () => {
it('should resolve nullable template as empty string title', () => {
expect(resolveTitle('', null)).toEqual({ absolute: '', template: null })
expect(resolveTitle(null, null)).toEqual({ absolute: '', template: null })
})
it('should resolve title with template', () => {
// returned template should equal the input title's template
expect(resolveTitle('title', 'dash %s')).toEqual({
absolute: 'dash title',
template: null,
})
expect(
resolveTitle({ default: 'title', template: '%s | absolute' }, 'dash %s')
).toEqual({ absolute: 'dash title', template: '%s | absolute' })
expect(
resolveTitle({ default: '', template: '%s | absolute' }, 'fake template')
).toEqual({ absolute: 'fake template', template: '%s | absolute' })
})
})
import type { Metadata } from '../types/metadata-interface'
import type { AbsoluteTemplateString } from '../types/metadata-types'
function resolveTitleTemplate(template: string | null, title: string) {
function resolveTitleTemplate(
template: string | null | undefined,
title: string
) {
return template ? template.replace(/%s/g, title) : title
}
export function mergeTitle<T extends { title?: Metadata['title'] }>(
source: T,
stashedTemplate: string | null
) {
const { title } = source
export function resolveTitle(
title: Metadata['title'],
stashedTemplate: string | null | undefined
): AbsoluteTemplateString {
let resolved
const template =
typeof source.title !== 'string' &&
source.title &&
'template' in source.title
? source.title.template
typeof title !== 'string' && title && 'template' in title
? title.template
: null
if (typeof title === 'string') {
......@@ -30,12 +29,12 @@ export function mergeTitle<T extends { title?: Metadata['title'] }>(
}
}
const target = source
if (title && typeof title !== 'string') {
const targetTitle = title as AbsoluteTemplateString
targetTitle.template = template
targetTitle.absolute = resolved || ''
return {
template,
absolute: resolved || '',
}
} else {
target.title = { absolute: resolved || title || '', template }
return { absolute: resolved || title || '', template }
}
}
export default function Page() {
return 'deep'
}
......@@ -5,5 +5,6 @@ export default function Layout(props) {
export const metadata = {
title: {
template: '%s | Extra Layout',
default: 'extra layout default',
},
}
......@@ -5,5 +5,6 @@ export default function Layout(props) {
export const metadata = {
title: {
template: '%s | Layout',
default: 'title template layout default',
},
}
export default function Page() {
return 'use layout title template'
}
......@@ -81,20 +81,30 @@ createNextDescribe(
it('should support title template', async () => {
const browser = await next.browser('/title-template')
expect(await browser.eval(`document.title`)).toBe('Page | Layout')
// Use the parent layout (root layout) instead of app/title-template/layout.tsx
expect(await browser.eval(`document.title`)).toBe('Page')
})
it('should support stashed title in one layer of page and layout', async () => {
const browser = await next.browser('/title-template/extra')
// Use the parent layout (app/title-template/layout.tsx) instead of app/title-template/extra/layout.tsx
expect(await browser.eval(`document.title`)).toBe('Extra Page | Layout')
})
it('should use parent layout title when no title is defined in page', async () => {
const browser = await next.browser('/title-template/use-layout-title')
expect(await browser.eval(`document.title`)).toBe(
'Extra Page | Extra Layout'
'title template layout default'
)
})
it('should support stashed title in two layers of page and layout', async () => {
const browser = await next.browser('/title-template/extra/inner')
expect(await browser.eval(`document.title`)).toBe(
'Inner Page | Extra Layout'
const $inner = await next.render$('/title-template/extra/inner')
expect(await $inner('title').text()).toBe('Inner Page | Extra Layout')
const $deep = await next.render$('/title-template/extra/inner/deep')
expect(await $deep('title').text()).toBe(
'extra layout default | Layout'
)
})
......
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