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

Run fast immediates during prerender abort to fix flaky I/O stack traces (#89969)

Follow-up for #89834.

In `prerenderAndAbortInSequentialTasks`, React's `finishHalt` (scheduled
via `setImmediate` from `abort()`) could race with the component's
pending `setTimeout` callback. When both ended up in the same timer
phase, the component timer would fire after `abort()` but before
`finishHalt`, linking the async graph and producing the more precise
`await` location (21:9). When `finishHalt` won the race, it read an
unlinked graph and fell back to the function declaration (20:16).

Adding `DANGEROUSLY_runPendingImmediatesAfterCurrentTask()` to the abort
task captures `finishHalt` as a fast immediate, ensuring it runs right
after `abort()` before any other timers. This makes the result
deterministic at the cost of always producing the less precise stack
frame (function declaration instead of `await` expression). The resolve
step is split into a separate task because it needs to wait for the
abort's fast immediates to complete.

When using `--debug-prerender`, we're also re-adding the hint to run
`next dev` for even better stack traces, since dev mode can produce the
precise `await` location by running the render to completion and
resolving the I/O promises.

[Flakiness
metric](https://app.datadoghq.com/ci/test/runs?query=test_level%3Atest%20%40git.repository.id%3A%22github.com%2Fvercel%2Fnext.js%22%20%40test.type%3A%22nextjs%22%20%40test.status%3A%22fail%22%20%40test.suite%3A%22Cache%20Components%20Errors%22%20%40git.branch%3Acanary%20-%40ci.pipeline.name%3Atest-e2e-deploy-release&agg_m=count&agg_m_source=base&agg_t=count&currentTab=overview&eventStack=&fromUser=false&index=citest&start=1770404554855&end=1771009354855&paused=false)
parent 69d63edc
......@@ -33,8 +33,15 @@ export function prerenderAndAbortInSequentialTasks<R>(
})
scheduleTimeout(() => {
try {
expectNoPendingImmediates()
DANGEROUSLY_runPendingImmediatesAfterCurrentTask()
abort()
} catch (err) {
reject(err)
}
})
scheduleTimeout(() => {
try {
expectNoPendingImmediates()
resolve(pendingResult)
} catch (err) {
reject(err)
......
......@@ -984,6 +984,10 @@ export function logDisallowedDynamicError(
console.error(`To get a more detailed stack trace and pinpoint the issue, try one of the following:
- Start the app in development mode by running \`next dev\`, then open "${workStore.route}" in your browser to investigate the error.
- Rerun the production build with \`next build --debug-prerender\` to generate better stack traces.`)
} else if (!process.env.__NEXT_DEV_SERVER) {
console.error(
`To debug the issue, start the app in development mode by running \`next dev\`, then open "${workStore.route}" in your browser to investigate the error.`
)
}
}
......
......@@ -21,6 +21,7 @@ describe('build-output-prerender', () => {
"▲ Next.js x.y.z (Turbopack)
- Cache Components enabled
- Experiments (use with caution):
✓ appNewScrollHandler (enabled by \`__NEXT_EXPERIMENTAL_APP_NEW_SCROLL_HANDLER\`)
✓ reactDebugChannel (enabled by \`__NEXT_EXPERIMENTAL_DEBUG_CHANNEL\`)"
`)
} else if (isRspack) {
......@@ -129,6 +130,7 @@ describe('build-output-prerender', () => {
- Cache Components enabled
- Experiments (use with caution):
✓ allowDevelopmentBuild (enabled by \`--debug-prerender\`)
✓ appNewScrollHandler (enabled by \`__NEXT_EXPERIMENTAL_APP_NEW_SCROLL_HANDLER\`)
⨯ prerenderEarlyExit (disabled by \`--debug-prerender\`)
✓ reactDebugChannel (enabled by \`__NEXT_EXPERIMENTAL_DEBUG_CHANNEL\`)
⨯ serverMinification (disabled by \`--debug-prerender\`)
......@@ -200,6 +202,7 @@ describe('build-output-prerender', () => {
| ^
5 | }
6 |
To debug the issue, start the app in development mode by running \`next dev\`, then open "/client" in your browser to investigate the error.
Error occurred prerendering page "/client". Read more: https://nextjs.org/docs/messages/prerender-error
Error: Route "/server" used \`Math.random()\` before accessing either uncached data (e.g. \`fetch()\`) or Request data (e.g. \`cookies()\`, \`headers()\`, \`connection()\`, and \`searchParams\`). Accessing random values synchronously in a Server Component requires reading one of these data sources first. Alternatively, consider moving this expression into a Client Component or Cache Component. See more info here: https://nextjs.org/docs/messages/next-prerender-random
at Page (app/server/page.tsx:13:27)
......@@ -210,6 +213,7 @@ describe('build-output-prerender', () => {
| ^
14 | }
15 |
To debug the issue, start the app in development mode by running \`next dev\`, then open "/server" in your browser to investigate the error.
Error occurred prerendering page "/server". Read more: https://nextjs.org/docs/messages/prerender-error
> Export encountered errors on following paths:
......@@ -228,6 +232,7 @@ describe('build-output-prerender', () => {
| ^
5 | }
6 |
To debug the issue, start the app in development mode by running \`next dev\`, then open "/client" in your browser to investigate the error.
Error occurred prerendering page "/client". Read more: https://nextjs.org/docs/messages/prerender-error
Error: Route "/server" used \`Math.random()\` before accessing either uncached data (e.g. \`fetch()\`) or Request data (e.g. \`cookies()\`, \`headers()\`, \`connection()\`, and \`searchParams\`). Accessing random values synchronously in a Server Component requires reading one of these data sources first. Alternatively, consider moving this expression into a Client Component or Cache Component. See more info here: https://nextjs.org/docs/messages/next-prerender-random
at Page (webpack:///app/server/page.tsx:13:27)
......@@ -238,6 +243,7 @@ describe('build-output-prerender', () => {
| ^
14 | }
15 |
To debug the issue, start the app in development mode by running \`next dev\`, then open "/server" in your browser to investigate the error.
Error occurred prerendering page "/server". Read more: https://nextjs.org/docs/messages/prerender-error
> Export encountered errors on following paths:
......@@ -265,6 +271,7 @@ describe('build-output-prerender', () => {
"▲ Next.js x.y.z (Turbopack)
- Cache Components enabled
- Experiments (use with caution):
✓ appNewScrollHandler (enabled by \`__NEXT_EXPERIMENTAL_APP_NEW_SCROLL_HANDLER\`)
✓ reactDebugChannel (enabled by \`__NEXT_EXPERIMENTAL_DEBUG_CHANNEL\`)"
`)
} else if (isRspack) {
......@@ -339,6 +346,7 @@ describe('build-output-prerender', () => {
- Cache Components enabled
- Experiments (use with caution):
✓ allowDevelopmentBuild (enabled by \`--debug-prerender\`)
✓ appNewScrollHandler (enabled by \`__NEXT_EXPERIMENTAL_APP_NEW_SCROLL_HANDLER\`)
⨯ prerenderEarlyExit (disabled by \`--debug-prerender\`)
✓ reactDebugChannel (enabled by \`__NEXT_EXPERIMENTAL_DEBUG_CHANNEL\`)
⨯ serverMinification (disabled by \`--debug-prerender\`)
......
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