@@ -91,20 +91,20 @@ type CacheKeyParts =
9191 | [ buildId : string , id : string , args : unknown [ ] ]
9292 | [ buildId : string , id : string , args : unknown [ ] , hmrRefreshHash : string ]
9393
94- interface UseCacheInnerPageComponentProps {
94+ interface UseCachePageInnerProps {
9595 params : Promise < Params >
9696 searchParams ?: Promise < SearchParams >
9797}
9898
99- export interface UseCachePageComponentProps {
99+ export interface UseCachePageProps {
100100 params : Promise < Params >
101101 searchParams : Promise < SearchParams >
102- $$isPageComponent : true
102+ $$isPage : true
103103}
104104
105- export type UseCacheLayoutComponentProps = {
105+ export type UseCacheLayoutProps = {
106106 params : Promise < Params >
107- $$isLayoutComponent : true
107+ $$isLayout : true
108108} & {
109109 // The value type should be React.ReactNode. But such an index signature would
110110 // be incompatible with the other two props.
@@ -995,25 +995,26 @@ export function cache(
995995 }
996996 }
997997
998- let isPageOrLayout = false
999-
1000- // For page and layout components, the cache function is overwritten,
1001- // which allows us to apply special handling for params and searchParams.
1002- // For pages and layouts we're using the outer params prop, and not the
1003- // inner one that was serialized/deserialized. While it's not generally
1004- // true for "use cache" args, in the case of `params` the inner and outer
1005- // object are essentially equivalent, so this is safe to do (including
1006- // fallback params that are hanging promises). It allows us to avoid
1007- // waiting for the timeout, when prerendering a fallback shell of a cached
1008- // page or layout that awaits params.
1009- if ( isPageComponent ( args ) ) {
1010- isPageOrLayout = true
998+ let isPageOrLayoutSegmentFunction = false
999+
1000+ // For page and layout segment functions (i.e. the page/layout component,
1001+ // or generateMetadata/generateViewport), the cache function is
1002+ // overwritten, which allows us to apply special handling for params and
1003+ // searchParams. For pages and layouts we're using the outer params prop,
1004+ // and not the inner one that was serialized/deserialized. While it's not
1005+ // generally true for "use cache" args, in the case of `params` the inner
1006+ // and outer object are essentially equivalent, so this is safe to do
1007+ // (including fallback params that are hanging promises). It allows us to
1008+ // avoid waiting for the timeout, when prerendering a fallback shell of a
1009+ // cached page or layout that awaits params.
1010+ if ( isPageSegmentFunction ( args ) ) {
1011+ isPageOrLayoutSegmentFunction = true
10111012
10121013 const [ { params : outerParams , searchParams : outerSearchParams } ] = args
10131014
1014- const props : UseCacheInnerPageComponentProps = {
1015+ const props : UseCachePageInnerProps = {
10151016 params : outerParams ,
1016- // Omit searchParams and $$isPageComponent .
1017+ // Omit searchParams and $$isPage .
10171018 }
10181019
10191020 if ( isPrivate ) {
@@ -1028,7 +1029,7 @@ export function cache(
10281029 [ name ] : async ( {
10291030 params : _innerParams ,
10301031 searchParams : innerSearchParams ,
1031- } : UseCacheInnerPageComponentProps ) =>
1032+ } : UseCachePageInnerProps ) =>
10321033 originalFn . apply ( null , [
10331034 {
10341035 params : outerParams ,
@@ -1045,19 +1046,22 @@ export function cache(
10451046 } ,
10461047 ] ) ,
10471048 } [ name ] as ( ...args : unknown [ ] ) => Promise < unknown >
1048- } else if ( isLayoutComponent ( args ) ) {
1049- isPageOrLayout = true
1050-
1051- const [ { params : outerParams , $$isLayoutComponent, ...outerSlots } ] =
1052- args
1053- // Overwrite the props to omit $$isLayoutComponent.
1049+ } else if ( isLayoutSegmentFunction ( args ) ) {
1050+ isPageOrLayoutSegmentFunction = true
1051+
1052+ const [ { params : outerParams , $$isLayout, ...outerSlots } ] = args
1053+ // Overwrite the props to omit $$isLayout. Note that slots are only
1054+ // passed to the layout component (if any are defined), and not to
1055+ // generateMetadata nor generateViewport. For those functions,
1056+ // outerSlots/innerSlots is an empty object, which is fine because we're
1057+ // just spreading it into the props.
10541058 args = [ { params : outerParams , ...outerSlots } ]
10551059
10561060 fn = {
10571061 [ name ] : async ( {
10581062 params : _innerParams ,
10591063 ...innerSlots
1060- } : Omit < UseCacheLayoutComponentProps , '$$isLayoutComponent ' > ) =>
1064+ } : Omit < UseCacheLayoutProps , '$$isLayout ' > ) =>
10611065 originalFn . apply ( null , [ { params : outerParams , ...innerSlots } ] ) ,
10621066 } [ name ] as ( ...args : unknown [ ] ) => Promise < unknown >
10631067 }
@@ -1120,14 +1124,14 @@ export function cache(
11201124 //
11211125 // fallthrough
11221126 case 'prerender' :
1123- if ( ! isPageOrLayout ) {
1124- // If the "use cache" function is not a page or a layout, we need to
1125- // track dynamic access already when encoding the arguments. If
1126- // params are passed explicitly into a "use cache" function (as
1127- // opposed to receiving them automatically in a page or layout), we
1128- // assume that the params are also accessed. This allows us to abort
1129- // early, and treat the function as dynamic, instead of waiting for
1130- // the timeout to be reached.
1127+ if ( ! isPageOrLayoutSegmentFunction ) {
1128+ // If the "use cache" function is not a page or layout segment
1129+ // function, we need to track dynamic access already when encoding
1130+ // the arguments. If params are passed explicitly into a "use cache"
1131+ // function (as opposed to receiving them automatically in a page or
1132+ // layout), we assume that the params are also accessed. This allows
1133+ // us to abort early, and treat the function as dynamic, instead of
1134+ // waiting for the timeout to be reached.
11311135 const dynamicAccessAbortController = new AbortController ( )
11321136
11331137 encodedCacheKeyParts = await dynamicAccessAsyncStorage . run (
@@ -1600,37 +1604,31 @@ export function cache(
16001604 return React . cache ( cachedFn )
16011605}
16021606
1603- function isPageComponent (
1604- args : any [ ]
1605- ) : args is [ UseCachePageComponentProps , undefined ] {
1606- if ( args . length !== 2 ) {
1607- return false
1608- }
1609-
1610- const [ props , ref ] = args
1607+ /**
1608+ * Returns `true` if the `'use cache'` function is the page component itself,
1609+ * or `generateMetadata`/`generateViewport` in a page file.
1610+ */
1611+ function isPageSegmentFunction ( args : any [ ] ) : args is [ UseCachePageProps ] {
1612+ const [ maybeProps ] = args
16111613
16121614 return (
1613- ref === undefined && // server components receive an undefined ref arg
1614- props !== null &&
1615- typeof props === 'object' &&
1616- ( props as UseCachePageComponentProps ) . $$isPageComponent
1615+ maybeProps !== null &&
1616+ typeof maybeProps === 'object' &&
1617+ ( maybeProps as UseCachePageProps ) . $$isPage === true
16171618 )
16181619}
16191620
1620- function isLayoutComponent (
1621- args : any [ ]
1622- ) : args is [ UseCacheLayoutComponentProps , undefined ] {
1623- if ( args . length !== 2 ) {
1624- return false
1625- }
1626-
1627- const [ props , ref ] = args
1621+ /**
1622+ * Returns `true` if the `'use cache'` function is the layout component itself,
1623+ * or `generateMetadata`/`generateViewport` in a layout file.
1624+ */
1625+ function isLayoutSegmentFunction ( args : any [ ] ) : args is [ UseCacheLayoutProps ] {
1626+ const [ maybeProps ] = args
16281627
16291628 return (
1630- ref === undefined && // server components receive an undefined ref arg
1631- props !== null &&
1632- typeof props === 'object' &&
1633- ( props as UseCacheLayoutComponentProps ) . $$isLayoutComponent
1629+ maybeProps !== null &&
1630+ typeof maybeProps === 'object' &&
1631+ ( maybeProps as UseCacheLayoutProps ) . $$isLayout === true
16341632 )
16351633}
16361634
0 commit comments