Unverified Commit 89bccd05 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Refactor metadata og and twitter title to be always presented (#52320)

Follow up for #52196 

The og title should be always resolved as `AbsoluteTemplate`. Move all the title resolving inside the og metadata resolving, so that it's aligned with type. And we don't have to check title everywhere, when og/twitter metadata is resolved, `title` is always presented as a property with `AbsoluteTemplate` type

Closes NEXT-1399
parent a3d5a855
...@@ -31,7 +31,7 @@ export async function MetadataTree({ ...@@ -31,7 +31,7 @@ export async function MetadataTree({
searchParams: { [key: string]: any } searchParams: { [key: string]: any }
getDynamicParamFromSegment: GetDynamicParamFromSegment getDynamicParamFromSegment: GetDynamicParamFromSegment
}) { }) {
const options = { const metadataContext = {
pathname, pathname,
} }
const resolvedMetadata = await resolveMetadata({ const resolvedMetadata = await resolveMetadata({
...@@ -41,7 +41,7 @@ export async function MetadataTree({ ...@@ -41,7 +41,7 @@ export async function MetadataTree({
searchParams, searchParams,
getDynamicParamFromSegment, getDynamicParamFromSegment,
}) })
const metadata = await accumulateMetadata(resolvedMetadata, options) const metadata = await accumulateMetadata(resolvedMetadata, metadataContext)
const elements = MetaFilter([ const elements = MetaFilter([
BasicMetadata({ metadata }), BasicMetadata({ metadata }),
......
...@@ -8,7 +8,7 @@ import type { GetDynamicParamFromSegment } from '../../server/app-render/app-ren ...@@ -8,7 +8,7 @@ import type { GetDynamicParamFromSegment } from '../../server/app-render/app-ren
import type { Twitter } from './types/twitter-types' import type { Twitter } from './types/twitter-types'
import type { OpenGraph } from './types/opengraph-types' import type { OpenGraph } from './types/opengraph-types'
import type { ComponentsType } from '../../build/webpack/loaders/next-app-loader' import type { ComponentsType } from '../../build/webpack/loaders/next-app-loader'
import type { MetadataAccumulationOptions } from './types/resolvers' import type { MetadataContext } from './types/resolvers'
import { createDefaultMetadata } from './default-metadata' import { createDefaultMetadata } from './default-metadata'
import { resolveOpenGraph, resolveTwitter } from './resolvers/resolve-opengraph' import { resolveOpenGraph, resolveTwitter } from './resolvers/resolve-opengraph'
import { resolveTitle } from './resolvers/resolve-title' import { resolveTitle } from './resolvers/resolve-title'
...@@ -44,10 +44,17 @@ export type MetadataItems = [ ...@@ -44,10 +44,17 @@ export type MetadataItems = [
StaticMetadata StaticMetadata
][] ][]
type TitleTemplates = {
title: string | null
twitter: string | null
openGraph: string | null
}
function mergeStaticMetadata( function mergeStaticMetadata(
metadata: ResolvedMetadata, metadata: ResolvedMetadata,
staticFilesMetadata: StaticMetadata, staticFilesMetadata: StaticMetadata,
{ pathname }: MetadataAccumulationOptions metadataContext: MetadataContext,
titleTemplates: TitleTemplates
) { ) {
if (!staticFilesMetadata) return if (!staticFilesMetadata) return
const { icon, apple, openGraph, twitter, manifest } = staticFilesMetadata const { icon, apple, openGraph, twitter, manifest } = staticFilesMetadata
...@@ -60,7 +67,8 @@ function mergeStaticMetadata( ...@@ -60,7 +67,8 @@ function mergeStaticMetadata(
if (twitter) { if (twitter) {
const resolvedTwitter = resolveTwitter( const resolvedTwitter = resolveTwitter(
{ ...metadata.twitter, images: twitter } as Twitter, { ...metadata.twitter, images: twitter } as Twitter,
metadata.metadataBase metadata.metadataBase,
titleTemplates.twitter
) )
metadata.twitter = resolvedTwitter metadata.twitter = resolvedTwitter
} }
...@@ -69,7 +77,8 @@ function mergeStaticMetadata( ...@@ -69,7 +77,8 @@ function mergeStaticMetadata(
const resolvedOpenGraph = resolveOpenGraph( const resolvedOpenGraph = resolveOpenGraph(
{ ...metadata.openGraph, images: openGraph } as OpenGraph, { ...metadata.openGraph, images: openGraph } as OpenGraph,
metadata.metadataBase, metadata.metadataBase,
{ pathname } metadataContext,
titleTemplates.openGraph
) )
metadata.openGraph = resolvedOpenGraph metadata.openGraph = resolvedOpenGraph
} }
...@@ -86,17 +95,13 @@ function merge({ ...@@ -86,17 +95,13 @@ function merge({
source, source,
staticFilesMetadata, staticFilesMetadata,
titleTemplates, titleTemplates,
options, metadataContext,
}: { }: {
target: ResolvedMetadata target: ResolvedMetadata
source: Metadata | null source: Metadata | null
staticFilesMetadata: StaticMetadata staticFilesMetadata: StaticMetadata
titleTemplates: { titleTemplates: TitleTemplates
title: string | null metadataContext: MetadataContext
twitter: string | null
openGraph: string | null
}
options: MetadataAccumulationOptions
}) { }) {
// If there's override metadata, prefer it otherwise fallback to the default metadata. // If there's override metadata, prefer it otherwise fallback to the default metadata.
const metadataBase = const metadataBase =
...@@ -115,7 +120,7 @@ function merge({ ...@@ -115,7 +120,7 @@ function merge({
target.alternates = resolveAlternates( target.alternates = resolveAlternates(
source.alternates, source.alternates,
metadataBase, metadataBase,
options metadataContext
) )
break break
} }
...@@ -123,24 +128,17 @@ function merge({ ...@@ -123,24 +128,17 @@ function merge({
target.openGraph = resolveOpenGraph( target.openGraph = resolveOpenGraph(
source.openGraph, source.openGraph,
metadataBase, metadataBase,
options metadataContext,
titleTemplates.openGraph
) )
if (target.openGraph) {
target.openGraph.title = resolveTitle(
target.openGraph.title,
titleTemplates.openGraph
)
}
break break
} }
case 'twitter': { case 'twitter': {
target.twitter = resolveTwitter(source.twitter, metadataBase) target.twitter = resolveTwitter(
if (target.twitter) { source.twitter,
target.twitter.title = resolveTitle( metadataBase,
target.twitter.title, titleTemplates.twitter
titleTemplates.twitter )
)
}
break break
} }
case 'verification': case 'verification':
...@@ -180,7 +178,11 @@ function merge({ ...@@ -180,7 +178,11 @@ function merge({
break break
} }
case 'itunes': { case 'itunes': {
target[key] = resolveItunes(source.itunes, metadataBase, options) target[key] = resolveItunes(
source.itunes,
metadataBase,
metadataContext
)
break break
} }
// directly assign fields that fallback to null // directly assign fields that fallback to null
...@@ -208,7 +210,12 @@ function merge({ ...@@ -208,7 +210,12 @@ function merge({
break break
} }
} }
mergeStaticMetadata(target, staticFilesMetadata, options) mergeStaticMetadata(
target,
staticFilesMetadata,
metadataContext,
titleTemplates
)
} }
async function getDefinedMetadata( async function getDefinedMetadata(
...@@ -368,7 +375,10 @@ export async function resolveMetadata({ ...@@ -368,7 +375,10 @@ export async function resolveMetadata({
} }
const commonOgKeys = ['title', 'description', 'images'] as const const commonOgKeys = ['title', 'description', 'images'] as const
function postProcessMetadata(metadata: ResolvedMetadata): ResolvedMetadata { function postProcessMetadata(
metadata: ResolvedMetadata,
titleTemplates: TitleTemplates
): ResolvedMetadata {
const { openGraph, twitter } = metadata const { openGraph, twitter } = metadata
if (openGraph) { if (openGraph) {
let autoFillProps: Partial<{ let autoFillProps: Partial<{
...@@ -376,7 +386,7 @@ function postProcessMetadata(metadata: ResolvedMetadata): ResolvedMetadata { ...@@ -376,7 +386,7 @@ function postProcessMetadata(metadata: ResolvedMetadata): ResolvedMetadata {
ResolvedMetadata['openGraph'] ResolvedMetadata['openGraph']
>[Key] >[Key]
}> = {} }> = {}
const hasTwTitle = twitter?.title?.absolute const hasTwTitle = twitter?.title.absolute
const hasTwDescription = twitter?.description const hasTwDescription = twitter?.description
const hasTwImages = twitter?.images const hasTwImages = twitter?.images
if (!hasTwTitle) autoFillProps.title = openGraph.title if (!hasTwTitle) autoFillProps.title = openGraph.title
...@@ -386,7 +396,8 @@ function postProcessMetadata(metadata: ResolvedMetadata): ResolvedMetadata { ...@@ -386,7 +396,8 @@ function postProcessMetadata(metadata: ResolvedMetadata): ResolvedMetadata {
if (Object.keys(autoFillProps).length > 0) { if (Object.keys(autoFillProps).length > 0) {
const partialTwitter = resolveTwitter( const partialTwitter = resolveTwitter(
autoFillProps, autoFillProps,
metadata.metadataBase metadata.metadataBase,
titleTemplates.twitter
) )
if (metadata.twitter) { if (metadata.twitter) {
metadata.twitter = Object.assign({}, metadata.twitter, { metadata.twitter = Object.assign({}, metadata.twitter, {
...@@ -406,17 +417,13 @@ function postProcessMetadata(metadata: ResolvedMetadata): ResolvedMetadata { ...@@ -406,17 +417,13 @@ function postProcessMetadata(metadata: ResolvedMetadata): ResolvedMetadata {
export async function accumulateMetadata( export async function accumulateMetadata(
metadataItems: MetadataItems, metadataItems: MetadataItems,
options: MetadataAccumulationOptions metadataContext: MetadataContext
): Promise<ResolvedMetadata> { ): Promise<ResolvedMetadata> {
const resolvedMetadata = createDefaultMetadata() const resolvedMetadata = createDefaultMetadata()
const resolvers: ((value: ResolvedMetadata) => void)[] = [] const resolvers: ((value: ResolvedMetadata) => void)[] = []
const generateMetadataResults: (Metadata | Promise<Metadata>)[] = [] const generateMetadataResults: (Metadata | Promise<Metadata>)[] = []
let titleTemplates: { let titleTemplates: TitleTemplates = {
title: string | null
twitter: string | null
openGraph: string | null
} = {
title: null, title: null,
twitter: null, twitter: null,
openGraph: null, openGraph: null,
...@@ -472,7 +479,7 @@ export async function accumulateMetadata( ...@@ -472,7 +479,7 @@ export async function accumulateMetadata(
} }
merge({ merge({
options, metadataContext,
target: resolvedMetadata, target: resolvedMetadata,
source: metadata, source: metadata,
staticFilesMetadata, staticFilesMetadata,
...@@ -484,11 +491,11 @@ export async function accumulateMetadata( ...@@ -484,11 +491,11 @@ export async function accumulateMetadata(
if (i < metadataItems.length - 2) { if (i < metadataItems.length - 2) {
titleTemplates = { titleTemplates = {
title: resolvedMetadata.title?.template || null, title: resolvedMetadata.title?.template || null,
openGraph: resolvedMetadata.openGraph?.title?.template || null, openGraph: resolvedMetadata.openGraph?.title.template || null,
twitter: resolvedMetadata.twitter?.title?.template || null, twitter: resolvedMetadata.twitter?.title.template || null,
} }
} }
} }
return postProcessMetadata(resolvedMetadata) return postProcessMetadata(resolvedMetadata, titleTemplates)
} }
...@@ -6,8 +6,8 @@ import type { Metadata, ResolvedMetadata } from '../types/metadata-interface' ...@@ -6,8 +6,8 @@ import type { Metadata, ResolvedMetadata } from '../types/metadata-interface'
import type { ResolvedVerification } from '../types/metadata-types' import type { ResolvedVerification } from '../types/metadata-types'
import type { import type {
FieldResolver, FieldResolver,
FieldResolverWithMetadataBase, FieldResolverExtraArgs,
MetadataAccumulationOptions, MetadataContext,
} from '../types/resolvers' } from '../types/resolvers'
import type { Viewport } from '../types/extra-types' import type { Viewport } from '../types/extra-types'
import { resolveAsArrayOrUndefined } from '../generate/utils' import { resolveAsArrayOrUndefined } from '../generate/utils'
...@@ -114,9 +114,9 @@ function resolveCanonicalUrl( ...@@ -114,9 +114,9 @@ function resolveCanonicalUrl(
} }
} }
export const resolveAlternates: FieldResolverWithMetadataBase< export const resolveAlternates: FieldResolverExtraArgs<
'alternates', 'alternates',
MetadataAccumulationOptions [ResolvedMetadata['metadataBase'], MetadataContext]
> = (alternates, metadataBase, { pathname }) => { > = (alternates, metadataBase, { pathname }) => {
if (!alternates) return null if (!alternates) return null
...@@ -252,9 +252,9 @@ export const resolveAppLinks: FieldResolver<'appLinks'> = (appLinks) => { ...@@ -252,9 +252,9 @@ export const resolveAppLinks: FieldResolver<'appLinks'> = (appLinks) => {
return appLinks as ResolvedMetadata['appLinks'] return appLinks as ResolvedMetadata['appLinks']
} }
export const resolveItunes: FieldResolverWithMetadataBase< export const resolveItunes: FieldResolverExtraArgs<
'itunes', 'itunes',
MetadataAccumulationOptions [ResolvedMetadata['metadataBase'], MetadataContext]
> = (itunes, metadataBase, { pathname }) => { > = (itunes, metadataBase, { pathname }) => {
if (!itunes) return null if (!itunes) return null
return { return {
......
import type { Metadata, ResolvedMetadata } from '../types/metadata-interface' import type { ResolvedMetadata } from '../types/metadata-interface'
import type { import type {
OpenGraphType, OpenGraphType,
OpenGraph, OpenGraph,
ResolvedOpenGraph, ResolvedOpenGraph,
} from '../types/opengraph-types' } from '../types/opengraph-types'
import type { import type {
FieldResolverWithMetadataBase, FieldResolverExtraArgs,
MetadataAccumulationOptions, MetadataContext,
} from '../types/resolvers' } from '../types/resolvers'
import type { ResolvedTwitterMetadata, Twitter } from '../types/twitter-types' import type { ResolvedTwitterMetadata, Twitter } from '../types/twitter-types'
import { resolveAsArrayOrUndefined } from '../generate/utils' import { resolveAsArrayOrUndefined } from '../generate/utils'
...@@ -16,6 +16,7 @@ import { ...@@ -16,6 +16,7 @@ import {
resolveUrl, resolveUrl,
resolveAbsoluteUrlWithPathname, resolveAbsoluteUrlWithPathname,
} from './resolve-url' } from './resolve-url'
import { resolveTitle } from './resolve-title'
const OgTypeFields = { const OgTypeFields = {
article: ['authors', 'tags'], article: ['authors', 'tags'],
...@@ -92,19 +93,13 @@ function getFieldsByOgType(ogType: OpenGraphType | undefined) { ...@@ -92,19 +93,13 @@ function getFieldsByOgType(ogType: OpenGraphType | undefined) {
} }
} }
export const resolveOpenGraph: FieldResolverWithMetadataBase< export const resolveOpenGraph: FieldResolverExtraArgs<
'openGraph', 'openGraph',
MetadataAccumulationOptions [ResolvedMetadata['metadataBase'], MetadataContext, string | null]
> = ( > = (openGraph, metadataBase, { pathname }, titleTemplate) => {
openGraph: Metadata['openGraph'],
metadataBase: ResolvedMetadata['metadataBase'],
{ pathname }
) => {
if (!openGraph) return null if (!openGraph) return null
const resolved = { ...openGraph } as ResolvedOpenGraph function resolveProps(target: ResolvedOpenGraph, og: OpenGraph) {
function assignProps(og: OpenGraph) {
const ogType = og && 'type' in og ? og.type : undefined const ogType = og && 'type' in og ? og.type : undefined
const keys = getFieldsByOgType(ogType) const keys = getFieldsByOgType(ogType)
for (const k of keys) { for (const k of keys) {
...@@ -114,16 +109,20 @@ export const resolveOpenGraph: FieldResolverWithMetadataBase< ...@@ -114,16 +109,20 @@ export const resolveOpenGraph: FieldResolverWithMetadataBase<
if (value) { if (value) {
const arrayValue = resolveAsArrayOrUndefined(value) const arrayValue = resolveAsArrayOrUndefined(value)
/// TODO: improve typing inferring /// TODO: improve typing inferring
;(resolved as any)[key] = arrayValue ;(target as any)[key] = arrayValue
} }
} }
} }
const imageMetadataBase = getSocialImageFallbackMetadataBase(metadataBase) const imageMetadataBase = getSocialImageFallbackMetadataBase(metadataBase)
resolved.images = resolveImages(og.images, imageMetadataBase) target.images = resolveImages(og.images, imageMetadataBase)
} }
assignProps(openGraph) const resolved = {
...openGraph,
title: resolveTitle(openGraph.title, titleTemplate),
} as ResolvedOpenGraph
resolveProps(resolved, openGraph)
resolved.url = openGraph.url resolved.url = openGraph.url
? resolveAbsoluteUrlWithPathname(openGraph.url, metadataBase, pathname) ? resolveAbsoluteUrlWithPathname(openGraph.url, metadataBase, pathname)
...@@ -140,14 +139,15 @@ const TwitterBasicInfoKeys = [ ...@@ -140,14 +139,15 @@ const TwitterBasicInfoKeys = [
'description', 'description',
] as const ] as const
export const resolveTwitter: FieldResolverWithMetadataBase<'twitter'> = ( export const resolveTwitter: FieldResolverExtraArgs<
twitter, 'twitter',
metadataBase [ResolvedMetadata['metadataBase'], string | null]
) => { > = (twitter, metadataBase, titleTemplate) => {
if (!twitter) return null if (!twitter) return null
const resolved = { const resolved = {
...twitter, ...twitter,
card: 'card' in twitter ? twitter.card : 'summary', card: 'card' in twitter ? twitter.card : 'summary',
title: resolveTitle(twitter.title, titleTemplate),
} as ResolvedTwitterMetadata } as ResolvedTwitterMetadata
for (const infoKey of TwitterBasicInfoKeys) { for (const infoKey of TwitterBasicInfoKeys) {
resolved[infoKey] = twitter[infoKey] || null resolved[infoKey] = twitter[infoKey] || null
......
...@@ -163,7 +163,7 @@ export type ResolvedOpenGraph = ...@@ -163,7 +163,7 @@ export type ResolvedOpenGraph =
type ResolvedOpenGraphMetadata = { type ResolvedOpenGraphMetadata = {
determiner?: 'a' | 'an' | 'the' | 'auto' | '' determiner?: 'a' | 'an' | 'the' | 'auto' | ''
title?: AbsoluteTemplateString title: AbsoluteTemplateString
description?: string description?: string
emails?: Array<string> emails?: Array<string>
phoneNumbers?: Array<string> phoneNumbers?: Array<string>
......
...@@ -3,20 +3,11 @@ import { Metadata, ResolvedMetadata } from './metadata-interface' ...@@ -3,20 +3,11 @@ import { Metadata, ResolvedMetadata } from './metadata-interface'
export type FieldResolver<Key extends keyof Metadata> = ( export type FieldResolver<Key extends keyof Metadata> = (
T: Metadata[Key] T: Metadata[Key]
) => ResolvedMetadata[Key] ) => ResolvedMetadata[Key]
export type FieldResolverWithMetadataBase< export type FieldResolverExtraArgs<
Key extends keyof Metadata, Key extends keyof Metadata,
Options = undefined ExtraArgs extends unknown[] = any[]
> = Options extends undefined > = (T: Metadata[Key], ...args: ExtraArgs) => ResolvedMetadata[Key]
? (
T: Metadata[Key],
metadataBase: ResolvedMetadata['metadataBase']
) => ResolvedMetadata[Key]
: (
T: Metadata[Key],
metadataBase: ResolvedMetadata['metadataBase'],
options: Options
) => ResolvedMetadata[Key]
export type MetadataAccumulationOptions = { export type MetadataContext = {
pathname: string pathname: string
} }
...@@ -77,7 +77,7 @@ type ResolvedTwitterSummary = { ...@@ -77,7 +77,7 @@ type ResolvedTwitterSummary = {
creator: string | null creator: string | null
creatorId: string | null creatorId: string | null
description: string | null description: string | null
title?: AbsoluteTemplateString title: AbsoluteTemplateString
images?: Array<ResolvedTwitterImage> images?: Array<ResolvedTwitterImage>
} }
type ResolvedTwitterPlayer = ResolvedTwitterSummary & { type ResolvedTwitterPlayer = ResolvedTwitterSummary & {
......
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