Unverified Commit aa7ae420 authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Fix generateMetadata race condition (#63169)

This ensures we properly catch/handle `generateMetadata` errors during
eager evaluating of nested `generateMetadata` functions in the tree.
Previously if we eager evaluated a child metadata function that threw an
error e.g. `notFound()` and but the parent metadata function took longer
the thrown error would be an unhandled rejection causing the process to
crash depending on the environment.

Fixes: NEXT-2588


Closes NEXT-2786
parent fb119042
...@@ -620,13 +620,24 @@ function collectMetadataExportPreloading<Data, ResolvedData>( ...@@ -620,13 +620,24 @@ function collectMetadataExportPreloading<Data, ResolvedData>(
dynamicMetadataExportFn: DataResolver<Data, ResolvedData>, dynamicMetadataExportFn: DataResolver<Data, ResolvedData>,
resolvers: ((value: ResolvedData) => void)[] resolvers: ((value: ResolvedData) => void)[]
) { ) {
results.push( const result = dynamicMetadataExportFn(
dynamicMetadataExportFn(
new Promise<any>((resolve) => { new Promise<any>((resolve) => {
resolvers.push(resolve) resolvers.push(resolve)
}) })
) )
)
if (result instanceof Promise) {
// since we eager execute generateMetadata and
// they can reject at anytime we need to ensure
// we attach the catch handler right away to
// prevent unhandled rejections crashing the process
result.catch((err) => {
return {
__nextError: err,
}
})
}
results.push(result)
} }
async function getMetadataFromExport<Data, ResolvedData>( async function getMetadataFromExport<Data, ResolvedData>(
...@@ -681,6 +692,11 @@ async function getMetadataFromExport<Data, ResolvedData>( ...@@ -681,6 +692,11 @@ async function getMetadataFromExport<Data, ResolvedData>(
resolveParent(currentResolvedMetadata) resolveParent(currentResolvedMetadata)
metadata = metadata =
metadataResult instanceof Promise ? await metadataResult : metadataResult metadataResult instanceof Promise ? await metadataResult : metadataResult
if (metadata && typeof metadata === 'object' && '__nextError' in metadata) {
// re-throw caught metadata error from preloading
throw metadata['__nextError']
}
} else if (metadataExport !== null && typeof metadataExport === 'object') { } else if (metadataExport !== null && typeof metadataExport === 'object') {
// This metadataExport is the object form // This metadataExport is the object form
metadata = metadataExport metadata = metadataExport
......
import type { ResolvingMetadata } from 'next'
import { notFound } from 'next/navigation'
process.on('unhandledRejection', (rej) => {
console.log('unhandledRejection', rej)
process.exit(1)
})
export const revalidate = 0
export default function Page() {
return notFound()
}
export async function generateMetadata(_, __: ResolvingMetadata) {
return notFound()
}
process.on('unhandledRejection', (rej) => {
console.log('unhandledRejection', rej)
process.exit(1)
})
export const revalidate = 0
export default function Layout({ children }) {
return (
<>
<p>Layout</p>
{children}
</>
)
}
export async function generateMetadata() {
await new Promise((resolve) => {
setTimeout(() => {
process.nextTick(resolve)
}, 2_000)
})
return {}
}
...@@ -1000,5 +1000,10 @@ createNextDescribe( ...@@ -1000,5 +1000,10 @@ createNextDescribe(
expect(iconHtml).toContain('pages-icon-page') expect(iconHtml).toContain('pages-icon-page')
expect(ogHtml).toContain('pages-opengraph-image-page') expect(ogHtml).toContain('pages-opengraph-image-page')
}) })
it('should not crash from error thrown during preloading nested generateMetadata', async () => {
const res = await next.fetch('/dynamic-meta')
expect(res.status).toBe(404)
})
} }
) )
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