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

Remove workStore from metadata resolution chain (#90217)

Stacked on #90215

workStore was threaded through 6 functions in resolve-metadata.ts and
the entire createMetadataComponents closure but only used once for
workStore.route in accumulateMetadata. It now reads from
workAsyncStorage.getStore() at that single usage site instead. This
eliminates workStore from the createMetadataComponents parameter list
entirely, bringing it one step closer to being replaceable with plain
components.
parent 468de5d1
...@@ -14,7 +14,6 @@ import type { ...@@ -14,7 +14,6 @@ import type {
} from './types/metadata-interface' } from './types/metadata-interface'
import { isHTTPAccessFallbackError } from '../../client/components/http-access-fallback/http-access-fallback' import { isHTTPAccessFallbackError } from '../../client/components/http-access-fallback/http-access-fallback'
import type { MetadataContext } from './types/resolvers' import type { MetadataContext } from './types/resolvers'
import type { WorkStore } from '../../server/app-render/work-async-storage.external'
import { createServerSearchParamsForMetadata } from '../../server/request/search-params' import { createServerSearchParamsForMetadata } from '../../server/request/search-params'
import { createServerPathnameForMetadata } from '../../server/request/pathname' import { createServerPathnameForMetadata } from '../../server/request/pathname'
import { isPostpone } from '../../server/lib/router-utils/is-postpone' import { isPostpone } from '../../server/lib/router-utils/is-postpone'
...@@ -41,7 +40,6 @@ export function createMetadataComponents({ ...@@ -41,7 +40,6 @@ export function createMetadataComponents({
metadataContext, metadataContext,
getDynamicParamFromSegment, getDynamicParamFromSegment,
errorType, errorType,
workStore,
serveStreamingMetadata, serveStreamingMetadata,
}: { }: {
tree: LoaderTree tree: LoaderTree
...@@ -50,7 +48,6 @@ export function createMetadataComponents({ ...@@ -50,7 +48,6 @@ export function createMetadataComponents({
metadataContext: MetadataContext metadataContext: MetadataContext
getDynamicParamFromSegment: GetDynamicParamFromSegment getDynamicParamFromSegment: GetDynamicParamFromSegment
errorType?: MetadataErrorType | 'redirect' errorType?: MetadataErrorType | 'redirect'
workStore: WorkStore
serveStreamingMetadata: boolean serveStreamingMetadata: boolean
}): { }): {
Viewport: React.ComponentType Viewport: React.ComponentType
...@@ -65,7 +62,6 @@ export function createMetadataComponents({ ...@@ -65,7 +62,6 @@ export function createMetadataComponents({
tree, tree,
searchParams, searchParams,
getDynamicParamFromSegment, getDynamicParamFromSegment,
workStore,
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
...@@ -78,8 +74,7 @@ export function createMetadataComponents({ ...@@ -78,8 +74,7 @@ export function createMetadataComponents({
return getNotFoundViewport( return getNotFoundViewport(
tree, tree,
searchParams, searchParams,
getDynamicParamFromSegment, getDynamicParamFromSegment
workStore
).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
...@@ -105,7 +100,6 @@ export function createMetadataComponents({ ...@@ -105,7 +100,6 @@ export function createMetadataComponents({
searchParams, searchParams,
getDynamicParamFromSegment, getDynamicParamFromSegment,
metadataContext, metadataContext,
workStore,
errorType errorType
).catch((metadataErr) => { ).catch((metadataErr) => {
// When Legacy PPR is enabled metadata can reject with a Postpone type // When Legacy PPR is enabled metadata can reject with a Postpone type
...@@ -120,8 +114,7 @@ export function createMetadataComponents({ ...@@ -120,8 +114,7 @@ export function createMetadataComponents({
pathnameForMetadata, pathnameForMetadata,
searchParams, searchParams,
getDynamicParamFromSegment, getDynamicParamFromSegment,
metadataContext, metadataContext
workStore
).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
...@@ -162,14 +155,12 @@ export function createMetadataComponents({ ...@@ -162,14 +155,12 @@ export function createMetadataComponents({
searchParams, searchParams,
getDynamicParamFromSegment, getDynamicParamFromSegment,
metadataContext, metadataContext,
workStore,
errorType errorType
), ),
getResolvedViewport( getResolvedViewport(
tree, tree,
searchParams, searchParams,
getDynamicParamFromSegment, getDynamicParamFromSegment,
workStore,
errorType errorType
), ),
]).then(() => null) ]).then(() => null)
...@@ -202,7 +193,6 @@ async function getResolvedMetadataImpl( ...@@ -202,7 +193,6 @@ async function getResolvedMetadataImpl(
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
getDynamicParamFromSegment: GetDynamicParamFromSegment, getDynamicParamFromSegment: GetDynamicParamFromSegment,
metadataContext: MetadataContext, metadataContext: MetadataContext,
workStore: WorkStore,
errorType?: MetadataErrorType | 'redirect' errorType?: MetadataErrorType | 'redirect'
): Promise<React.ReactNode> { ): Promise<React.ReactNode> {
const errorConvention = errorType === 'redirect' ? undefined : errorType const errorConvention = errorType === 'redirect' ? undefined : errorType
...@@ -212,7 +202,6 @@ async function getResolvedMetadataImpl( ...@@ -212,7 +202,6 @@ async function getResolvedMetadataImpl(
searchParams, searchParams,
getDynamicParamFromSegment, getDynamicParamFromSegment,
metadataContext, metadataContext,
workStore,
errorConvention errorConvention
) )
} }
...@@ -223,8 +212,7 @@ async function getNotFoundMetadataImpl( ...@@ -223,8 +212,7 @@ async function getNotFoundMetadataImpl(
pathname: Promise<string>, pathname: Promise<string>,
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
getDynamicParamFromSegment: GetDynamicParamFromSegment, getDynamicParamFromSegment: GetDynamicParamFromSegment,
metadataContext: MetadataContext, metadataContext: MetadataContext
workStore: WorkStore
): Promise<React.ReactNode> { ): Promise<React.ReactNode> {
const notFoundErrorConvention = 'not-found' const notFoundErrorConvention = 'not-found'
return renderMetadata( return renderMetadata(
...@@ -233,7 +221,6 @@ async function getNotFoundMetadataImpl( ...@@ -233,7 +221,6 @@ async function getNotFoundMetadataImpl(
searchParams, searchParams,
getDynamicParamFromSegment, getDynamicParamFromSegment,
metadataContext, metadataContext,
workStore,
notFoundErrorConvention notFoundErrorConvention
) )
} }
...@@ -243,7 +230,6 @@ async function getResolvedViewportImpl( ...@@ -243,7 +230,6 @@ async function getResolvedViewportImpl(
tree: LoaderTree, tree: LoaderTree,
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
getDynamicParamFromSegment: GetDynamicParamFromSegment, getDynamicParamFromSegment: GetDynamicParamFromSegment,
workStore: WorkStore,
errorType?: MetadataErrorType | 'redirect' errorType?: MetadataErrorType | 'redirect'
): Promise<React.ReactNode> { ): Promise<React.ReactNode> {
const errorConvention = errorType === 'redirect' ? undefined : errorType const errorConvention = errorType === 'redirect' ? undefined : errorType
...@@ -251,7 +237,6 @@ async function getResolvedViewportImpl( ...@@ -251,7 +237,6 @@ async function getResolvedViewportImpl(
tree, tree,
searchParams, searchParams,
getDynamicParamFromSegment, getDynamicParamFromSegment,
workStore,
errorConvention errorConvention
) )
} }
...@@ -260,15 +245,13 @@ const getNotFoundViewport = cache(getNotFoundViewportImpl) ...@@ -260,15 +245,13 @@ const getNotFoundViewport = cache(getNotFoundViewportImpl)
async function getNotFoundViewportImpl( async function getNotFoundViewportImpl(
tree: LoaderTree, tree: LoaderTree,
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
getDynamicParamFromSegment: GetDynamicParamFromSegment, getDynamicParamFromSegment: GetDynamicParamFromSegment
workStore: WorkStore
): Promise<React.ReactNode> { ): Promise<React.ReactNode> {
const notFoundErrorConvention = 'not-found' const notFoundErrorConvention = 'not-found'
return renderViewport( return renderViewport(
tree, tree,
searchParams, searchParams,
getDynamicParamFromSegment, getDynamicParamFromSegment,
workStore,
notFoundErrorConvention notFoundErrorConvention
) )
} }
...@@ -279,7 +262,6 @@ async function renderMetadata( ...@@ -279,7 +262,6 @@ async function renderMetadata(
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
getDynamicParamFromSegment: GetDynamicParamFromSegment, getDynamicParamFromSegment: GetDynamicParamFromSegment,
metadataContext: MetadataContext, metadataContext: MetadataContext,
workStore: WorkStore,
errorConvention?: MetadataErrorType errorConvention?: MetadataErrorType
) { ) {
const resolvedMetadata = await resolveMetadata( const resolvedMetadata = await resolveMetadata(
...@@ -288,7 +270,6 @@ async function renderMetadata( ...@@ -288,7 +270,6 @@ async function renderMetadata(
searchParams, searchParams,
errorConvention, errorConvention,
getDynamicParamFromSegment, getDynamicParamFromSegment,
workStore,
metadataContext metadataContext
) )
return <>{createMetadataElements(resolvedMetadata)}</> return <>{createMetadataElements(resolvedMetadata)}</>
...@@ -298,15 +279,13 @@ async function renderViewport( ...@@ -298,15 +279,13 @@ async function renderViewport(
tree: LoaderTree, tree: LoaderTree,
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
getDynamicParamFromSegment: GetDynamicParamFromSegment, getDynamicParamFromSegment: GetDynamicParamFromSegment,
workStore: WorkStore,
errorConvention?: MetadataErrorType errorConvention?: MetadataErrorType
) { ) {
const resolvedViewport = await resolveViewport( const resolvedViewport = await resolveViewport(
tree, tree,
searchParams, searchParams,
errorConvention, errorConvention,
getDynamicParamFromSegment, getDynamicParamFromSegment
workStore
) )
return <>{createViewportElements(resolvedViewport)}</> return <>{createViewportElements(resolvedViewport)}</>
} }
......
...@@ -21,7 +21,8 @@ import type { ...@@ -21,7 +21,8 @@ import type {
} from './types/metadata-types' } from './types/metadata-types'
import type { ParsedUrlQuery } from 'querystring' import type { ParsedUrlQuery } from 'querystring'
import type { StaticMetadata } from './types/icons' import type { StaticMetadata } from './types/icons'
import type { WorkStore } from '../../server/app-render/work-async-storage.external' import { workAsyncStorage } from '../../server/app-render/work-async-storage.external'
import { InvariantError } from '../../shared/lib/invariant-error'
import type { Params } from '../../server/request/params' import type { Params } from '../../server/request/params'
import type { SearchParams } from '../../server/request/search-params' import type { SearchParams } from '../../server/request/search-params'
...@@ -708,8 +709,7 @@ const resolveMetadataItems = cache(async function ( ...@@ -708,8 +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, getDynamicParamFromSegment: GetDynamicParamFromSegment
workStore: WorkStore
) { ) {
const parentParams = {} const parentParams = {}
const metadataItems: MetadataItems = [] const metadataItems: MetadataItems = []
...@@ -723,8 +723,7 @@ const resolveMetadataItems = cache(async function ( ...@@ -723,8 +723,7 @@ const resolveMetadataItems = cache(async function (
searchParams, searchParams,
errorConvention, errorConvention,
errorMetadataItem, errorMetadataItem,
getDynamicParamFromSegment, getDynamicParamFromSegment
workStore
) )
}) })
...@@ -737,8 +736,7 @@ async function resolveMetadataItemsImpl( ...@@ -737,8 +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, getDynamicParamFromSegment: GetDynamicParamFromSegment
workStore: WorkStore
): Promise<MetadataItems> { ): Promise<MetadataItems> {
const [segment, parallelRoutes, { page }] = tree const [segment, parallelRoutes, { page }] = tree
const currentTreePrefix = const currentTreePrefix =
...@@ -783,8 +781,7 @@ async function resolveMetadataItemsImpl( ...@@ -783,8 +781,7 @@ async function resolveMetadataItemsImpl(
searchParams, searchParams,
errorConvention, errorConvention,
errorMetadataItem, errorMetadataItem,
getDynamicParamFromSegment, getDynamicParamFromSegment
workStore
) )
} }
...@@ -802,8 +799,7 @@ const resolveViewportItems = cache(async function ( ...@@ -802,8 +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, getDynamicParamFromSegment: GetDynamicParamFromSegment
workStore: WorkStore
) { ) {
const parentParams = {} const parentParams = {}
const viewportItems: ViewportItems = [] const viewportItems: ViewportItems = []
...@@ -819,8 +815,7 @@ const resolveViewportItems = cache(async function ( ...@@ -819,8 +815,7 @@ const resolveViewportItems = cache(async function (
searchParams, searchParams,
errorConvention, errorConvention,
errorViewportItemRef, errorViewportItemRef,
getDynamicParamFromSegment, getDynamicParamFromSegment
workStore
) )
}) })
...@@ -833,8 +828,7 @@ async function resolveViewportItemsImpl( ...@@ -833,8 +828,7 @@ async function resolveViewportItemsImpl(
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
errorConvention: MetadataErrorType | undefined, errorConvention: MetadataErrorType | undefined,
errorViewportItemRef: ErrorViewportItemRef, errorViewportItemRef: ErrorViewportItemRef,
getDynamicParamFromSegment: GetDynamicParamFromSegment, getDynamicParamFromSegment: GetDynamicParamFromSegment
workStore: WorkStore
): Promise<ViewportItems> { ): Promise<ViewportItems> {
const [segment, parallelRoutes, { page }] = tree const [segment, parallelRoutes, { page }] = tree
const currentTreePrefix = const currentTreePrefix =
...@@ -890,8 +884,7 @@ async function resolveViewportItemsImpl( ...@@ -890,8 +884,7 @@ async function resolveViewportItemsImpl(
searchParams, searchParams,
errorConvention, errorConvention,
errorViewportItemRef, errorViewportItemRef,
getDynamicParamFromSegment, getDynamicParamFromSegment
workStore
) )
} }
...@@ -1260,16 +1253,18 @@ export async function resolveMetadata( ...@@ -1260,16 +1253,18 @@ export async function resolveMetadata(
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
errorConvention: MetadataErrorType | undefined, errorConvention: MetadataErrorType | undefined,
getDynamicParamFromSegment: GetDynamicParamFromSegment, getDynamicParamFromSegment: GetDynamicParamFromSegment,
workStore: WorkStore,
metadataContext: MetadataContext metadataContext: MetadataContext
): Promise<ResolvedMetadata> { ): Promise<ResolvedMetadata> {
const metadataItems = await resolveMetadataItems( const metadataItems = await resolveMetadataItems(
tree, tree,
searchParams, searchParams,
errorConvention, errorConvention,
getDynamicParamFromSegment, getDynamicParamFromSegment
workStore
) )
const workStore = workAsyncStorage.getStore()
if (!workStore) {
throw new InvariantError('Expected workStore to be initialized')
}
return accumulateMetadata( return accumulateMetadata(
workStore.route, workStore.route,
metadataItems, metadataItems,
...@@ -1283,15 +1278,13 @@ export async function resolveViewport( ...@@ -1283,15 +1278,13 @@ export async function resolveViewport(
tree: LoaderTree, tree: LoaderTree,
searchParams: Promise<ParsedUrlQuery>, searchParams: Promise<ParsedUrlQuery>,
errorConvention: MetadataErrorType | undefined, errorConvention: MetadataErrorType | undefined,
getDynamicParamFromSegment: GetDynamicParamFromSegment, getDynamicParamFromSegment: GetDynamicParamFromSegment
workStore: WorkStore
): Promise<ResolvedViewport> { ): Promise<ResolvedViewport> {
const viewportItems = await resolveViewportItems( const viewportItems = await resolveViewportItems(
tree, tree,
searchParams, searchParams,
errorConvention, errorConvention,
getDynamicParamFromSegment, getDynamicParamFromSegment
workStore
) )
return accumulateViewport(viewportItems) return accumulateViewport(viewportItems)
} }
......
...@@ -550,7 +550,6 @@ async function generateDynamicRSCPayload( ...@@ -550,7 +550,6 @@ async function generateDynamicRSCPayload(
pathname: url.pathname, pathname: url.pathname,
metadataContext: createMetadataContext(ctx.renderOpts), metadataContext: createMetadataContext(ctx.renderOpts),
getDynamicParamFromSegment, getDynamicParamFromSegment,
workStore,
serveStreamingMetadata, serveStreamingMetadata,
}) })
...@@ -1444,7 +1443,6 @@ async function getRSCPayload( ...@@ -1444,7 +1443,6 @@ async function getRSCPayload(
pathname: url.pathname, pathname: url.pathname,
metadataContext: createMetadataContext(ctx.renderOpts), metadataContext: createMetadataContext(ctx.renderOpts),
getDynamicParamFromSegment, getDynamicParamFromSegment,
workStore,
serveStreamingMetadata, serveStreamingMetadata,
}) })
...@@ -1565,7 +1563,6 @@ async function getErrorRSCPayload( ...@@ -1565,7 +1563,6 @@ async function getErrorRSCPayload(
metadataContext: createMetadataContext(ctx.renderOpts), metadataContext: createMetadataContext(ctx.renderOpts),
errorType, errorType,
getDynamicParamFromSegment, getDynamicParamFromSegment,
workStore,
serveStreamingMetadata: serveStreamingMetadata, serveStreamingMetadata: serveStreamingMetadata,
}) })
......
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