Unverified Commit 35adcd1a authored by Josh Story's avatar Josh Story Committed by GitHub

Replace getDynamicParamFromSegment closure with interpolatedParams in metadata (#90249)

Stacked on #90217

Metadata resolution only needs param names and values to pass to
generateMetadata. It doesn't need treeSegment, staticSiblings, or the
DynamicParam type that getDynamicParamFromSegment produces. Replace the
closure dependency with interpolatedParams (a plain Params object) and
use getSegmentParam to parse segment names inline. This replaces a
closure over request-scoped state with a simple data value, removing
another dependency that blocked making metadata components standalone.
parent 2eeaeb06
import React, { Suspense, cache } from 'react' import React, { Suspense, cache } from 'react'
import type { ParsedUrlQuery } from 'querystring' import type { ParsedUrlQuery } from 'querystring'
import type { GetDynamicParamFromSegment } from '../../server/app-render/app-render' import type { Params } from '../../server/request/params'
import type { LoaderTree } from '../../server/lib/app-dir-module' import type { LoaderTree } from '../../server/lib/app-dir-module'
import type { SearchParams } from '../../server/request/search-params' import type { SearchParams } from '../../server/request/search-params'
import { import {
...@@ -38,7 +38,7 @@ export function createMetadataComponents({ ...@@ -38,7 +38,7 @@ export function createMetadataComponents({
pathname, pathname,
parsedQuery, parsedQuery,
metadataContext, metadataContext,
getDynamicParamFromSegment, interpolatedParams,
errorType, errorType,
serveStreamingMetadata, serveStreamingMetadata,
}: { }: {
...@@ -46,7 +46,7 @@ export function createMetadataComponents({ ...@@ -46,7 +46,7 @@ export function createMetadataComponents({
pathname: string pathname: string
parsedQuery: SearchParams parsedQuery: SearchParams
metadataContext: MetadataContext metadataContext: MetadataContext
getDynamicParamFromSegment: GetDynamicParamFromSegment interpolatedParams: Params
errorType?: MetadataErrorType | 'redirect' errorType?: MetadataErrorType | 'redirect'
serveStreamingMetadata: boolean serveStreamingMetadata: boolean
}): { }): {
...@@ -61,7 +61,7 @@ export function createMetadataComponents({ ...@@ -61,7 +61,7 @@ export function createMetadataComponents({
const tags = await getResolvedViewport( const tags = await getResolvedViewport(
tree, tree,
searchParams, searchParams,
getDynamicParamFromSegment, interpolatedParams,
errorType errorType
).catch((viewportErr) => { ).catch((viewportErr) => {
// When Legacy PPR is enabled viewport can reject with a Postpone type // When Legacy PPR is enabled viewport can reject with a Postpone type
...@@ -74,7 +74,7 @@ export function createMetadataComponents({ ...@@ -74,7 +74,7 @@ export function createMetadataComponents({
return getNotFoundViewport( return getNotFoundViewport(
tree, tree,
searchParams, searchParams,
getDynamicParamFromSegment interpolatedParams
).catch(() => null) ).catch(() => null)
} }
// We're going to throw the error from the metadata outlet so we just render null here instead // We're going to throw the error from the metadata outlet so we just render null here instead
...@@ -98,7 +98,7 @@ export function createMetadataComponents({ ...@@ -98,7 +98,7 @@ export function createMetadataComponents({
tree, tree,
pathnameForMetadata, pathnameForMetadata,
searchParams, searchParams,
getDynamicParamFromSegment, interpolatedParams,
metadataContext, metadataContext,
errorType errorType
).catch((metadataErr) => { ).catch((metadataErr) => {
...@@ -113,7 +113,7 @@ export function createMetadataComponents({ ...@@ -113,7 +113,7 @@ export function createMetadataComponents({
tree, tree,
pathnameForMetadata, pathnameForMetadata,
searchParams, searchParams,
getDynamicParamFromSegment, interpolatedParams,
metadataContext metadataContext
).catch(() => null) ).catch(() => null)
} }
...@@ -153,16 +153,11 @@ export function createMetadataComponents({ ...@@ -153,16 +153,11 @@ export function createMetadataComponents({
tree, tree,
pathnameForMetadata, pathnameForMetadata,
searchParams, searchParams,
getDynamicParamFromSegment, interpolatedParams,
metadataContext, metadataContext,
errorType errorType
), ),
getResolvedViewport( getResolvedViewport(tree, searchParams, interpolatedParams, errorType),
tree,
searchParams,
getDynamicParamFromSegment,
errorType
),
]).then(() => null) ]).then(() => null)
// TODO: We shouldn't change what we render based on whether we are streaming or not. // TODO: We shouldn't change what we render based on whether we are streaming or not.
...@@ -191,7 +186,7 @@ async function getResolvedMetadataImpl( ...@@ -191,7 +186,7 @@ async function getResolvedMetadataImpl(
tree: LoaderTree, tree: LoaderTree,
pathname: Promise<string>, pathname: Promise<string>,
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
getDynamicParamFromSegment: GetDynamicParamFromSegment, interpolatedParams: Params,
metadataContext: MetadataContext, metadataContext: MetadataContext,
errorType?: MetadataErrorType | 'redirect' errorType?: MetadataErrorType | 'redirect'
): Promise<React.ReactNode> { ): Promise<React.ReactNode> {
...@@ -200,7 +195,7 @@ async function getResolvedMetadataImpl( ...@@ -200,7 +195,7 @@ async function getResolvedMetadataImpl(
tree, tree,
pathname, pathname,
searchParams, searchParams,
getDynamicParamFromSegment, interpolatedParams,
metadataContext, metadataContext,
errorConvention errorConvention
) )
...@@ -211,7 +206,7 @@ async function getNotFoundMetadataImpl( ...@@ -211,7 +206,7 @@ async function getNotFoundMetadataImpl(
tree: LoaderTree, tree: LoaderTree,
pathname: Promise<string>, pathname: Promise<string>,
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
getDynamicParamFromSegment: GetDynamicParamFromSegment, interpolatedParams: Params,
metadataContext: MetadataContext metadataContext: MetadataContext
): Promise<React.ReactNode> { ): Promise<React.ReactNode> {
const notFoundErrorConvention = 'not-found' const notFoundErrorConvention = 'not-found'
...@@ -219,7 +214,7 @@ async function getNotFoundMetadataImpl( ...@@ -219,7 +214,7 @@ async function getNotFoundMetadataImpl(
tree, tree,
pathname, pathname,
searchParams, searchParams,
getDynamicParamFromSegment, interpolatedParams,
metadataContext, metadataContext,
notFoundErrorConvention notFoundErrorConvention
) )
...@@ -229,29 +224,24 @@ const getResolvedViewport = cache(getResolvedViewportImpl) ...@@ -229,29 +224,24 @@ const getResolvedViewport = cache(getResolvedViewportImpl)
async function getResolvedViewportImpl( async function getResolvedViewportImpl(
tree: LoaderTree, tree: LoaderTree,
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
getDynamicParamFromSegment: GetDynamicParamFromSegment, interpolatedParams: Params,
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( return renderViewport(tree, searchParams, interpolatedParams, errorConvention)
tree,
searchParams,
getDynamicParamFromSegment,
errorConvention
)
} }
const getNotFoundViewport = cache(getNotFoundViewportImpl) const getNotFoundViewport = cache(getNotFoundViewportImpl)
async function getNotFoundViewportImpl( async function getNotFoundViewportImpl(
tree: LoaderTree, tree: LoaderTree,
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
getDynamicParamFromSegment: GetDynamicParamFromSegment interpolatedParams: Params
): Promise<React.ReactNode> { ): Promise<React.ReactNode> {
const notFoundErrorConvention = 'not-found' const notFoundErrorConvention = 'not-found'
return renderViewport( return renderViewport(
tree, tree,
searchParams, searchParams,
getDynamicParamFromSegment, interpolatedParams,
notFoundErrorConvention notFoundErrorConvention
) )
} }
...@@ -260,7 +250,7 @@ async function renderMetadata( ...@@ -260,7 +250,7 @@ async function renderMetadata(
tree: LoaderTree, tree: LoaderTree,
pathname: Promise<string>, pathname: Promise<string>,
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
getDynamicParamFromSegment: GetDynamicParamFromSegment, interpolatedParams: Params,
metadataContext: MetadataContext, metadataContext: MetadataContext,
errorConvention?: MetadataErrorType errorConvention?: MetadataErrorType
) { ) {
...@@ -269,7 +259,7 @@ async function renderMetadata( ...@@ -269,7 +259,7 @@ async function renderMetadata(
pathname, pathname,
searchParams, searchParams,
errorConvention, errorConvention,
getDynamicParamFromSegment, interpolatedParams,
metadataContext metadataContext
) )
return <>{createMetadataElements(resolvedMetadata)}</> return <>{createMetadataElements(resolvedMetadata)}</>
...@@ -278,14 +268,14 @@ async function renderMetadata( ...@@ -278,14 +268,14 @@ async function renderMetadata(
async function renderViewport( async function renderViewport(
tree: LoaderTree, tree: LoaderTree,
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
getDynamicParamFromSegment: GetDynamicParamFromSegment, interpolatedParams: Params,
errorConvention?: MetadataErrorType errorConvention?: MetadataErrorType
) { ) {
const resolvedViewport = await resolveViewport( const resolvedViewport = await resolveViewport(
tree, tree,
searchParams, searchParams,
errorConvention, errorConvention,
getDynamicParamFromSegment interpolatedParams
) )
return <>{createViewportElements(resolvedViewport)}</> return <>{createViewportElements(resolvedViewport)}</>
} }
......
...@@ -8,7 +8,7 @@ import type { ...@@ -8,7 +8,7 @@ import type {
WithStringifiedURLs, WithStringifiedURLs,
} from './types/metadata-interface' } from './types/metadata-interface'
import type { MetadataImageModule } from '../../build/webpack/loaders/metadata/types' import type { MetadataImageModule } from '../../build/webpack/loaders/metadata/types'
import type { GetDynamicParamFromSegment } from '../../server/app-render/app-render' import { getSegmentParam } from '../../shared/lib/router/utils/get-segment-param'
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 { AppDirModules } from '../../build/webpack/loaders/next-app-loader' import type { AppDirModules } from '../../build/webpack/loaders/next-app-loader'
...@@ -709,7 +709,7 @@ const resolveMetadataItems = cache(async function ( ...@@ -709,7 +709,7 @@ const resolveMetadataItems = cache(async function (
tree: LoaderTree, tree: LoaderTree,
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
errorConvention: MetadataErrorType | undefined, errorConvention: MetadataErrorType | undefined,
getDynamicParamFromSegment: GetDynamicParamFromSegment interpolatedParams: Params
) { ) {
const parentParams = {} const parentParams = {}
const metadataItems: MetadataItems = [] const metadataItems: MetadataItems = []
...@@ -723,7 +723,7 @@ const resolveMetadataItems = cache(async function ( ...@@ -723,7 +723,7 @@ const resolveMetadataItems = cache(async function (
searchParams, searchParams,
errorConvention, errorConvention,
errorMetadataItem, errorMetadataItem,
getDynamicParamFromSegment interpolatedParams
) )
}) })
...@@ -736,7 +736,7 @@ async function resolveMetadataItemsImpl( ...@@ -736,7 +736,7 @@ async function resolveMetadataItemsImpl(
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
errorConvention: MetadataErrorType | undefined, errorConvention: MetadataErrorType | undefined,
errorMetadataItem: MetadataItems[number], errorMetadataItem: MetadataItems[number],
getDynamicParamFromSegment: GetDynamicParamFromSegment interpolatedParams: Params
): Promise<MetadataItems> { ): Promise<MetadataItems> {
const [segment, parallelRoutes, { page }] = tree const [segment, parallelRoutes, { page }] = tree
const currentTreePrefix = const currentTreePrefix =
...@@ -744,15 +744,15 @@ async function resolveMetadataItemsImpl( ...@@ -744,15 +744,15 @@ async function resolveMetadataItemsImpl(
const isPage = typeof page !== 'undefined' const isPage = typeof page !== 'undefined'
// Handle dynamic segment params. // Handle dynamic segment params.
const segmentParam = getDynamicParamFromSegment(tree)
/**
* Create object holding the parent params and current params
*/
let currentParams = parentParams let currentParams = parentParams
if (segmentParam && segmentParam.value !== null) { const segmentParam = getSegmentParam(segment)
if (segmentParam) {
const value = interpolatedParams[segmentParam.paramName]
if (value !== null && value !== undefined) {
currentParams = { currentParams = {
...parentParams, ...parentParams,
[segmentParam.param]: segmentParam.value, [segmentParam.paramName]: value,
}
} }
} }
...@@ -781,7 +781,7 @@ async function resolveMetadataItemsImpl( ...@@ -781,7 +781,7 @@ async function resolveMetadataItemsImpl(
searchParams, searchParams,
errorConvention, errorConvention,
errorMetadataItem, errorMetadataItem,
getDynamicParamFromSegment interpolatedParams
) )
} }
...@@ -799,7 +799,7 @@ const resolveViewportItems = cache(async function ( ...@@ -799,7 +799,7 @@ const resolveViewportItems = cache(async function (
tree: LoaderTree, tree: LoaderTree,
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
errorConvention: MetadataErrorType | undefined, errorConvention: MetadataErrorType | undefined,
getDynamicParamFromSegment: GetDynamicParamFromSegment interpolatedParams: Params
) { ) {
const parentParams = {} const parentParams = {}
const viewportItems: ViewportItems = [] const viewportItems: ViewportItems = []
...@@ -815,7 +815,7 @@ const resolveViewportItems = cache(async function ( ...@@ -815,7 +815,7 @@ const resolveViewportItems = cache(async function (
searchParams, searchParams,
errorConvention, errorConvention,
errorViewportItemRef, errorViewportItemRef,
getDynamicParamFromSegment interpolatedParams
) )
}) })
...@@ -828,7 +828,7 @@ async function resolveViewportItemsImpl( ...@@ -828,7 +828,7 @@ async function resolveViewportItemsImpl(
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
errorConvention: MetadataErrorType | undefined, errorConvention: MetadataErrorType | undefined,
errorViewportItemRef: ErrorViewportItemRef, errorViewportItemRef: ErrorViewportItemRef,
getDynamicParamFromSegment: GetDynamicParamFromSegment interpolatedParams: Params
): Promise<ViewportItems> { ): Promise<ViewportItems> {
const [segment, parallelRoutes, { page }] = tree const [segment, parallelRoutes, { page }] = tree
const currentTreePrefix = const currentTreePrefix =
...@@ -836,15 +836,15 @@ async function resolveViewportItemsImpl( ...@@ -836,15 +836,15 @@ async function resolveViewportItemsImpl(
const isPage = typeof page !== 'undefined' const isPage = typeof page !== 'undefined'
// Handle dynamic segment params. // Handle dynamic segment params.
const segmentParam = getDynamicParamFromSegment(tree)
/**
* Create object holding the parent params and current params
*/
let currentParams = parentParams let currentParams = parentParams
if (segmentParam && segmentParam.value !== null) { const segmentParam = getSegmentParam(segment)
if (segmentParam) {
const value = interpolatedParams[segmentParam.paramName]
if (value !== null && value !== undefined) {
currentParams = { currentParams = {
...parentParams, ...parentParams,
[segmentParam.param]: segmentParam.value, [segmentParam.paramName]: value,
}
} }
} }
...@@ -884,7 +884,7 @@ async function resolveViewportItemsImpl( ...@@ -884,7 +884,7 @@ async function resolveViewportItemsImpl(
searchParams, searchParams,
errorConvention, errorConvention,
errorViewportItemRef, errorViewportItemRef,
getDynamicParamFromSegment interpolatedParams
) )
} }
...@@ -1252,14 +1252,14 @@ export async function resolveMetadata( ...@@ -1252,14 +1252,14 @@ export async function resolveMetadata(
pathname: Promise<string>, pathname: Promise<string>,
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
errorConvention: MetadataErrorType | undefined, errorConvention: MetadataErrorType | undefined,
getDynamicParamFromSegment: GetDynamicParamFromSegment, interpolatedParams: Params,
metadataContext: MetadataContext metadataContext: MetadataContext
): Promise<ResolvedMetadata> { ): Promise<ResolvedMetadata> {
const metadataItems = await resolveMetadataItems( const metadataItems = await resolveMetadataItems(
tree, tree,
searchParams, searchParams,
errorConvention, errorConvention,
getDynamicParamFromSegment interpolatedParams
) )
const workStore = workAsyncStorage.getStore() const workStore = workAsyncStorage.getStore()
if (!workStore) { if (!workStore) {
...@@ -1278,13 +1278,13 @@ export async function resolveViewport( ...@@ -1278,13 +1278,13 @@ export async function resolveViewport(
tree: LoaderTree, tree: LoaderTree,
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
errorConvention: MetadataErrorType | undefined, errorConvention: MetadataErrorType | undefined,
getDynamicParamFromSegment: GetDynamicParamFromSegment interpolatedParams: Params
): Promise<ResolvedViewport> { ): Promise<ResolvedViewport> {
const viewportItems = await resolveViewportItems( const viewportItems = await resolveViewportItems(
tree, tree,
searchParams, searchParams,
errorConvention, errorConvention,
getDynamicParamFromSegment interpolatedParams
) )
return accumulateViewport(viewportItems) return accumulateViewport(viewportItems)
} }
......
...@@ -269,6 +269,7 @@ export type AppRenderContext = { ...@@ -269,6 +269,7 @@ export type AppRenderContext = {
renderOpts: RenderOpts renderOpts: RenderOpts
parsedRequestHeaders: ParsedRequestHeaders parsedRequestHeaders: ParsedRequestHeaders
getDynamicParamFromSegment: GetDynamicParamFromSegment getDynamicParamFromSegment: GetDynamicParamFromSegment
interpolatedParams: Params
query: NextParsedUrlQuery query: NextParsedUrlQuery
isPrefetch: boolean isPrefetch: boolean
isPossibleServerAction: boolean isPossibleServerAction: boolean
...@@ -523,7 +524,6 @@ async function generateDynamicRSCPayload( ...@@ -523,7 +524,6 @@ async function generateDynamicRSCPayload(
createMetadataComponents, createMetadataComponents,
Fragment, Fragment,
}, },
getDynamicParamFromSegment,
query, query,
requestId, requestId,
flightRouterState, flightRouterState,
...@@ -549,7 +549,7 @@ async function generateDynamicRSCPayload( ...@@ -549,7 +549,7 @@ async function generateDynamicRSCPayload(
parsedQuery: query, parsedQuery: query,
pathname: url.pathname, pathname: url.pathname,
metadataContext: createMetadataContext(ctx.renderOpts), metadataContext: createMetadataContext(ctx.renderOpts),
getDynamicParamFromSegment, interpolatedParams: ctx.interpolatedParams,
serveStreamingMetadata, serveStreamingMetadata,
}) })
...@@ -1442,7 +1442,7 @@ async function getRSCPayload( ...@@ -1442,7 +1442,7 @@ async function getRSCPayload(
parsedQuery: query, parsedQuery: query,
pathname: url.pathname, pathname: url.pathname,
metadataContext: createMetadataContext(ctx.renderOpts), metadataContext: createMetadataContext(ctx.renderOpts),
getDynamicParamFromSegment, interpolatedParams: ctx.interpolatedParams,
serveStreamingMetadata, serveStreamingMetadata,
}) })
...@@ -1562,7 +1562,7 @@ async function getErrorRSCPayload( ...@@ -1562,7 +1562,7 @@ async function getErrorRSCPayload(
pathname: url.pathname, pathname: url.pathname,
metadataContext: createMetadataContext(ctx.renderOpts), metadataContext: createMetadataContext(ctx.renderOpts),
errorType, errorType,
getDynamicParamFromSegment, interpolatedParams: ctx.interpolatedParams,
serveStreamingMetadata: serveStreamingMetadata, serveStreamingMetadata: serveStreamingMetadata,
}) })
...@@ -2020,6 +2020,7 @@ async function renderToHTMLOrFlightImpl( ...@@ -2020,6 +2020,7 @@ async function renderToHTMLOrFlightImpl(
workStore, workStore,
parsedRequestHeaders, parsedRequestHeaders,
getDynamicParamFromSegment, getDynamicParamFromSegment,
interpolatedParams,
query, query,
isPrefetch: isPrefetchRequest, isPrefetch: isPrefetchRequest,
isPossibleServerAction: isPossibleActionRequest, isPossibleServerAction: isPossibleActionRequest,
......
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