Unverified Commit a0e2b5dc authored by Hendrik Liebau's avatar Hendrik Liebau Committed by GitHub

Fix prerendering of caught `'use cache'` errors (#100956)

The error handler records errors thrown inside `'use cache'` functions
in the work store's digest lookup. The page renderer uses that lookup to
recover original errors for logging (#86500). Prerendering also uses it
to detect render failures, so errors caught by the page can still fail
the build or on-demand generation.

This change collects errors reported by the page's RSC renderer
separately and preserves the shared lookup for logging. The regression
covers caught errors from `'use cache'` functions during build-time and
on-demand prerendering and verifies that the fallback remains cacheable.

This follows the reproduction, investigation, and proposed fix in
#100841. We need to run deploy tests for this change. Those tests cannot
run on fork PRs, so we are opening a branch PR in `vercel/next.js`.

Fixes #100829.
Closes #100841.
Co-authored-by: 's avatarIkram-Maulana <hey@ikram.is-a.dev>
parent e8e020ca
...@@ -9047,6 +9047,11 @@ async function prerenderToStream( ...@@ -9047,6 +9047,11 @@ async function prerenderToStream(
} }
const { reactServerErrorsByDigest } = workStore const { reactServerErrorsByDigest } = workStore
// Collect errors reported by the page's RSC renderer to detect prerender
// failures. The work store's `reactServerErrorsByDigest` map also records
// errors from cached functions for logging, even when the page catches them.
// Those caught errors must not fail prerendering.
const renderErrorsByDigest = new Map<string, DigestedError>()
// We don't report errors during prerendering through our instrumentation hooks // We don't report errors during prerendering through our instrumentation hooks
const reportErrors = !experimental.isRoutePPREnabled const reportErrors = !experimental.isRoutePPREnabled
function onHTMLRenderRSCError(err: DigestedError, silenceLog: boolean) { function onHTMLRenderRSCError(err: DigestedError, silenceLog: boolean) {
...@@ -9062,7 +9067,9 @@ async function prerenderToStream( ...@@ -9062,7 +9067,9 @@ async function prerenderToStream(
process.env.NODE_ENV === 'development', process.env.NODE_ENV === 'development',
isBuildTimePrerendering, isBuildTimePrerendering,
reactServerErrorsByDigest, reactServerErrorsByDigest,
onHTMLRenderRSCError onHTMLRenderRSCError,
undefined,
renderErrorsByDigest
) )
function onHTMLRenderSSRError(err: DigestedError) { function onHTMLRenderSSRError(err: DigestedError) {
...@@ -10133,7 +10140,7 @@ async function prerenderToStream( ...@@ -10133,7 +10140,7 @@ async function prerenderToStream(
reactServerResult.consume() reactServerResult.consume()
return { return {
error: undefined, error: undefined,
digestErrorsMap: reactServerErrorsByDigest, digestErrorsMap: renderErrorsByDigest,
ssrErrors: allCapturedErrors, ssrErrors: allCapturedErrors,
stream: await continueDynamicPrerender(htmlStream, { stream: await continueDynamicPrerender(htmlStream, {
getServerInsertedHTML, getServerInsertedHTML,
...@@ -10207,7 +10214,7 @@ async function prerenderToStream( ...@@ -10207,7 +10214,7 @@ async function prerenderToStream(
return { return {
error: undefined, error: undefined,
digestErrorsMap: reactServerErrorsByDigest, digestErrorsMap: renderErrorsByDigest,
ssrErrors: allCapturedErrors, ssrErrors: allCapturedErrors,
stream, stream,
dynamicAccess: consumeDynamicAccess( dynamicAccess: consumeDynamicAccess(
...@@ -10305,7 +10312,7 @@ async function prerenderToStream( ...@@ -10305,7 +10312,7 @@ async function prerenderToStream(
}) })
return { return {
error: undefined, error: undefined,
digestErrorsMap: reactServerErrorsByDigest, digestErrorsMap: renderErrorsByDigest,
ssrErrors: allCapturedErrors, ssrErrors: allCapturedErrors,
stream: await continueFizzStream(htmlStream, { stream: await continueFizzStream(htmlStream, {
inlinedDataStream: createInlinedDataStream( inlinedDataStream: createInlinedDataStream(
...@@ -10697,7 +10704,7 @@ async function prerenderToStream( ...@@ -10697,7 +10704,7 @@ async function prerenderToStream(
errorServerResult.consume() errorServerResult.consume()
return { return {
error: errorType !== undefined ? undefined : { thrownValue: err }, error: errorType !== undefined ? undefined : { thrownValue: err },
digestErrorsMap: reactServerErrorsByDigest, digestErrorsMap: renderErrorsByDigest,
ssrErrors: allCapturedErrors, ssrErrors: allCapturedErrors,
stream: await continueDynamicPrerender(errorHtmlStream, { stream: await continueDynamicPrerender(errorHtmlStream, {
getServerInsertedHTML, getServerInsertedHTML,
...@@ -10771,7 +10778,7 @@ async function prerenderToStream( ...@@ -10771,7 +10778,7 @@ async function prerenderToStream(
errorServerResult.consume() errorServerResult.consume()
return { return {
error: errorType !== undefined ? undefined : { thrownValue: err }, error: errorType !== undefined ? undefined : { thrownValue: err },
digestErrorsMap: reactServerErrorsByDigest, digestErrorsMap: renderErrorsByDigest,
ssrErrors: allCapturedErrors, ssrErrors: allCapturedErrors,
stream, stream,
dynamicAccess: consumeDynamicAccess( dynamicAccess: consumeDynamicAccess(
...@@ -10878,7 +10885,7 @@ async function prerenderToStream( ...@@ -10878,7 +10885,7 @@ async function prerenderToStream(
return { return {
error: undefined, error: undefined,
digestErrorsMap: reactServerErrorsByDigest, digestErrorsMap: renderErrorsByDigest,
ssrErrors: allCapturedErrors, ssrErrors: allCapturedErrors,
stream: await continueFizzStream(errorHtmlStream, { stream: await continueFizzStream(errorHtmlStream, {
inlinedDataStream: createInlinedDataStream( inlinedDataStream: createInlinedDataStream(
......
...@@ -57,7 +57,8 @@ export function createReactServerErrorHandler( ...@@ -57,7 +57,8 @@ export function createReactServerErrorHandler(
isBuildTimePrerendering: boolean, isBuildTimePrerendering: boolean,
reactServerErrors: Map<string, DigestedError>, reactServerErrors: Map<string, DigestedError>,
onReactServerRenderError: (err: DigestedError, silenceLog: boolean) => void, onReactServerRenderError: (err: DigestedError, silenceLog: boolean) => void,
spanToRecordOn?: any spanToRecordOn?: any,
renderErrorsByDigest?: Map<string, DigestedError>
): RSCErrorHandler { ): RSCErrorHandler {
return (thrownValue: unknown) => { return (thrownValue: unknown) => {
// If the response was closed, we don't need to log the error. // If the response was closed, we don't need to log the error.
...@@ -115,6 +116,8 @@ export function createReactServerErrorHandler( ...@@ -115,6 +116,8 @@ export function createReactServerErrorHandler(
reactServerErrors.set(err.digest, err) reactServerErrors.set(err.digest, err)
} }
renderErrorsByDigest?.set(err.digest, err)
// Format server errors in development to add more helpful error messages // Format server errors in development to add more helpful error messages
if (shouldFormatError) { if (shouldFormatError) {
formatServerError(err) formatServerError(err)
......
async function getValue(id: string) {
'use cache'
throw new Error(`Cached function failed: ${id}`)
}
export function generateStaticParams() {
return [{ id: 'static' }]
}
export default async function Page({
params,
}: {
params: Promise<{ id: string }>
}) {
const { id } = await params
try {
await getValue(id)
} catch {
return <p>fallback</p>
}
}
import type { ReactNode } from 'react'
export default function Root({ children }: { children: ReactNode }) {
return (
<html>
<body>{children}</body>
</html>
)
}
export default {
cacheComponents: true,
}
import { nextTestSetup } from 'e2e-utils'
describe('use-cache-caught-error', () => {
const { next, isNextStart } = nextTestSetup({
files: __dirname,
})
it.each(['static', 'runtime'])(
'should cache the fallback for /%s when a cached function throws',
async (id) => {
const response = await next.fetch(`/${id}`)
expect(response.status).toBe(200)
expect(await response.text()).toContain('<p>fallback</p>')
if (isNextStart) {
const cachedResponse = await next.fetch(`/${id}`)
expect(cachedResponse.headers.get('x-nextjs-cache')).toBe('HIT')
}
}
)
})
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