Unverified Commit 7a47ed51 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

[metadata] Merge the metadata resolve apis into one api (#74191)

parent 75a9dfac
...@@ -21,10 +21,9 @@ import { ...@@ -21,10 +21,9 @@ import {
} from './generate/opengraph' } from './generate/opengraph'
import { IconsMetadata } from './generate/icons' import { IconsMetadata } from './generate/icons'
import { import {
resolveMetadataItems,
accumulateMetadata,
accumulateViewport,
type MetadataErrorType, type MetadataErrorType,
resolveMetadata,
resolveViewport,
} from './resolve-metadata' } from './resolve-metadata'
import { MetaFilter } from './generate/meta' import { MetaFilter } from './generate/meta'
import type { import type {
...@@ -196,24 +195,14 @@ async function getResolvedMetadataImpl( ...@@ -196,24 +195,14 @@ async function getResolvedMetadataImpl(
errorType?: MetadataErrorType | 'redirect' errorType?: MetadataErrorType | 'redirect'
): Promise<React.ReactNode> { ): Promise<React.ReactNode> {
const errorConvention = errorType === 'redirect' ? undefined : errorType const errorConvention = errorType === 'redirect' ? undefined : errorType
return renderMetadata(
const metadataItems = await resolveMetadataItems(
tree, tree,
searchParams, searchParams,
errorConvention,
getDynamicParamFromSegment, getDynamicParamFromSegment,
metadataContext,
createServerParamsForMetadata, createServerParamsForMetadata,
workStore workStore,
) errorConvention
const elements: Array<React.ReactNode> = createMetadataElements(
await accumulateMetadata(metadataItems, metadataContext)
)
return (
<>
{elements.map((el, index) => {
return cloneElement(el as React.ReactElement, { key: index })
})}
</>
) )
} }
...@@ -227,24 +216,14 @@ async function getNotFoundMetadataImpl( ...@@ -227,24 +216,14 @@ async function getNotFoundMetadataImpl(
workStore: WorkStore workStore: WorkStore
): Promise<React.ReactNode> { ): Promise<React.ReactNode> {
const notFoundErrorConvention = 'not-found' const notFoundErrorConvention = 'not-found'
const notFoundMetadataItems = await resolveMetadataItems( return renderMetadata(
tree, tree,
searchParams, searchParams,
notFoundErrorConvention,
getDynamicParamFromSegment, getDynamicParamFromSegment,
metadataContext,
createServerParamsForMetadata, createServerParamsForMetadata,
workStore workStore,
) notFoundErrorConvention
const elements: Array<React.ReactNode> = createMetadataElements(
await accumulateMetadata(notFoundMetadataItems, metadataContext)
)
return (
<>
{elements.map((el, index) => {
return cloneElement(el as React.ReactElement, { key: index })
})}
</>
) )
} }
...@@ -258,18 +237,55 @@ async function getResolvedViewportImpl( ...@@ -258,18 +237,55 @@ async function getResolvedViewportImpl(
errorType?: MetadataErrorType | 'redirect' errorType?: MetadataErrorType | 'redirect'
): Promise<React.ReactNode> { ): Promise<React.ReactNode> {
const errorConvention = errorType === 'redirect' ? undefined : errorType const errorConvention = errorType === 'redirect' ? undefined : errorType
return renderViewport(
tree,
searchParams,
getDynamicParamFromSegment,
createServerParamsForMetadata,
workStore,
errorConvention
)
}
const metadataItems = await resolveMetadataItems( const getNotFoundViewport = cache(getNotFoundViewportImpl)
async function getNotFoundViewportImpl(
tree: LoaderTree,
searchParams: Promise<ParsedUrlQuery>,
getDynamicParamFromSegment: GetDynamicParamFromSegment,
createServerParamsForMetadata: CreateServerParamsForMetadata,
workStore: WorkStore
): Promise<React.ReactNode> {
const notFoundErrorConvention = 'not-found'
return renderViewport(
tree, tree,
searchParams, searchParams,
errorConvention,
getDynamicParamFromSegment, getDynamicParamFromSegment,
createServerParamsForMetadata, createServerParamsForMetadata,
workStore workStore,
notFoundErrorConvention
) )
const elements: Array<React.ReactNode> = createViewportElements( }
await accumulateViewport(metadataItems)
async function renderMetadata(
tree: LoaderTree,
searchParams: Promise<ParsedUrlQuery>,
getDynamicParamFromSegment: GetDynamicParamFromSegment,
metadataContext: MetadataContext,
createServerParamsForMetadata: CreateServerParamsForMetadata,
workStore: WorkStore,
errorConvention?: MetadataErrorType
) {
const resolvedMetadata = await resolveMetadata(
tree,
searchParams,
errorConvention,
getDynamicParamFromSegment,
createServerParamsForMetadata,
workStore,
metadataContext
) )
const elements: Array<React.ReactNode> =
createMetadataElements(resolvedMetadata)
return ( return (
<> <>
{elements.map((el, index) => { {elements.map((el, index) => {
...@@ -279,26 +295,25 @@ async function getResolvedViewportImpl( ...@@ -279,26 +295,25 @@ async function getResolvedViewportImpl(
) )
} }
const getNotFoundViewport = cache(getNotFoundViewportImpl) async function renderViewport(
async function getNotFoundViewportImpl(
tree: LoaderTree, tree: LoaderTree,
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
getDynamicParamFromSegment: GetDynamicParamFromSegment, getDynamicParamFromSegment: GetDynamicParamFromSegment,
createServerParamsForMetadata: CreateServerParamsForMetadata, createServerParamsForMetadata: CreateServerParamsForMetadata,
workStore: WorkStore workStore: WorkStore,
): Promise<React.ReactNode> { errorConvention?: MetadataErrorType
const notFoundErrorConvention = 'not-found' ) {
const notFoundMetadataItems = await resolveMetadataItems( const notFoundResolvedViewport = await resolveViewport(
tree, tree,
searchParams, searchParams,
notFoundErrorConvention, errorConvention,
getDynamicParamFromSegment, getDynamicParamFromSegment,
createServerParamsForMetadata, createServerParamsForMetadata,
workStore workStore
) )
const elements: Array<React.ReactNode> = createViewportElements( const elements: Array<React.ReactNode> = createViewportElements(
await accumulateViewport(notFoundMetadataItems) notFoundResolvedViewport
) )
return ( return (
<> <>
......
...@@ -470,9 +470,7 @@ async function collectMetadata({ ...@@ -470,9 +470,7 @@ async function collectMetadata({
} }
} }
const cachedResolveMetadataItems = cache(resolveMetadataItems) const resolveMetadataItems = cache(async function (
export { cachedResolveMetadataItems as resolveMetadataItems }
async function resolveMetadataItems(
tree: LoaderTree, tree: LoaderTree,
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
errorConvention: MetadataErrorType | undefined, errorConvention: MetadataErrorType | undefined,
...@@ -496,7 +494,7 @@ async function resolveMetadataItems( ...@@ -496,7 +494,7 @@ async function resolveMetadataItems(
createServerParamsForMetadata, createServerParamsForMetadata,
workStore workStore
) )
} })
async function resolveMetadataItemsImpl( async function resolveMetadataItemsImpl(
metadataItems: MetadataItems, metadataItems: MetadataItems,
...@@ -901,3 +899,44 @@ export async function accumulateViewport( ...@@ -901,3 +899,44 @@ export async function accumulateViewport(
} }
return resolvedViewport return resolvedViewport
} }
// Exposed API for metadata component, that directly resolve the loader tree and related context as resolved metadata.
export async function resolveMetadata(
tree: LoaderTree,
searchParams: Promise<ParsedUrlQuery>,
errorConvention: MetadataErrorType | undefined,
getDynamicParamFromSegment: GetDynamicParamFromSegment,
createServerParamsForMetadata: CreateServerParamsForMetadata,
workStore: WorkStore,
metadataContext: MetadataContext
): Promise<ResolvedMetadata> {
const metadataItems = await resolveMetadataItems(
tree,
searchParams,
errorConvention,
getDynamicParamFromSegment,
createServerParamsForMetadata,
workStore
)
return accumulateMetadata(metadataItems, metadataContext)
}
// Exposed API for viewport component, that directly resolve the loader tree and related context as resolved viewport.
export async function resolveViewport(
tree: LoaderTree,
searchParams: Promise<ParsedUrlQuery>,
errorConvention: MetadataErrorType | undefined,
getDynamicParamFromSegment: GetDynamicParamFromSegment,
createServerParamsForMetadata: CreateServerParamsForMetadata,
workStore: WorkStore
): Promise<ResolvedViewport> {
const metadataItems = await resolveMetadataItems(
tree,
searchParams,
errorConvention,
getDynamicParamFromSegment,
createServerParamsForMetadata,
workStore
)
return accumulateViewport(metadataItems)
}
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