Unverified Commit 785e9660 authored by Jude Gao's avatar Jude Gao Committed by GitHub

Fix: Build error causes infinite loop on new dev overlay in Turbopack (#75984)

### What?

When you enable both Turbopack, and the new dev overlay, you will see
that the dev overlay is frozen and the network tab shows that it is
fetching the stack frames API indefinitely.

### Why?

​During our migration to the new development overlay, we implemented a
refactor to ensure that logic for handling runtime errors is executed
consistently, even in the case of build-time errors. This change
involves invoking the getErrorByType function for build errors. However,
this function attempts to retrieve stack frames for the build-time
error, inadvertently triggering Turbopack to initiate a rebuild.

Once Turbopack completes the rebuild process, it dispatches a Hot Module
Replacement (HMR) event to indicate the presence of a new error. This
event prompts getErrorByType to attempt fetching the stack frames again,
which in turn causes Turbopack to rebuild once more. This creates an
endless loop of rebuilding and error signaling.

You can repro it by running
```
__NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY='true' TURBOPACK=1 pnpm testonly-dev test/development/acceptance-app/editor-links.test.ts
```
with the test file change in this PR. (Important to add that. Otherwise
the test would still complete successfully)

### How?

Do not run the runtime error logic for build errors.


Closes NDX-816
parent 26bf7344
...@@ -10,7 +10,7 @@ import { CssReset } from '../internal/styles/css-reset' ...@@ -10,7 +10,7 @@ import { CssReset } from '../internal/styles/css-reset'
import { Colors } from '../internal/styles/colors' import { Colors } from '../internal/styles/colors'
import { ErrorOverlay } from '../internal/components/errors/error-overlay/error-overlay' import { ErrorOverlay } from '../internal/components/errors/error-overlay/error-overlay'
import { DevToolsIndicator } from '../internal/components/errors/dev-tools-indicator/dev-tools-indicator' import { DevToolsIndicator } from '../internal/components/errors/dev-tools-indicator/dev-tools-indicator'
import { useErrorHook } from '../internal/container/runtime-error/use-error-hook' import { RenderError } from '../internal/container/runtime-error/render-error'
export default function ReactDevOverlay({ export default function ReactDevOverlay({
state, state,
...@@ -21,15 +21,7 @@ export default function ReactDevOverlay({ ...@@ -21,15 +21,7 @@ export default function ReactDevOverlay({
globalError: [GlobalErrorComponent, React.ReactNode] globalError: [GlobalErrorComponent, React.ReactNode]
children: React.ReactNode children: React.ReactNode
}) { }) {
const [_isErrorOverlayOpen, setIsErrorOverlayOpen] = useState(false) const [isErrorOverlayOpen, setIsErrorOverlayOpen] = useState(false)
const { readyErrors, totalErrorCount } = useErrorHook({
state,
isAppDir: true,
})
// Build errors cannot be dismissed. If one is triggered, we ignore the
// user's preference and open the error overlay.
const isErrorOverlayOpen = Boolean(state.buildError) || _isErrorOverlayOpen
const devOverlay = ( const devOverlay = (
<ShadowPortal> <ShadowPortal>
...@@ -38,18 +30,26 @@ export default function ReactDevOverlay({ ...@@ -38,18 +30,26 @@ export default function ReactDevOverlay({
<Colors /> <Colors />
<ComponentStyles /> <ComponentStyles />
<DevToolsIndicator <RenderError state={state} isAppDir={true}>
state={state} {({ readyErrors, totalErrorCount }) => {
errorCount={totalErrorCount} return (
setIsErrorOverlayOpen={setIsErrorOverlayOpen} <>
/> <DevToolsIndicator
state={state}
errorCount={totalErrorCount}
setIsErrorOverlayOpen={setIsErrorOverlayOpen}
/>
<ErrorOverlay <ErrorOverlay
state={state} state={state}
readyErrors={readyErrors} readyErrors={readyErrors}
isErrorOverlayOpen={isErrorOverlayOpen} isErrorOverlayOpen={isErrorOverlayOpen}
setIsErrorOverlayOpen={setIsErrorOverlayOpen} setIsErrorOverlayOpen={setIsErrorOverlayOpen}
/> />
</>
)
}}
</RenderError>
</ShadowPortal> </ShadowPortal>
) )
......
...@@ -509,7 +509,13 @@ function useMeasureWidth(ref: React.RefObject<HTMLDivElement | null>) { ...@@ -509,7 +509,13 @@ function useMeasureWidth(ref: React.RefObject<HTMLDivElement | null>) {
function NextMark({ isLoading }: { isLoading?: boolean }) { function NextMark({ isLoading }: { isLoading?: boolean }) {
return ( return (
<svg width="40" height="40" viewBox="0 0 40 40" fill="none"> <svg
width="40"
height="40"
viewBox="0 0 40 40"
fill="none"
data-next-mark-loading={isLoading}
>
<g transform="translate(8.5, 13)"> <g transform="translate(8.5, 13)">
<path <path
className={isLoading ? 'path0' : 'paused'} className={isLoading ? 'path0' : 'paused'}
......
...@@ -44,7 +44,7 @@ export function ErrorOverlay({ ...@@ -44,7 +44,7 @@ export function ErrorOverlay({
return ( return (
<RootLayoutMissingTagsError <RootLayoutMissingTagsError
{...commonProps} {...commonProps}
// This is a runtime error, forcedly display error overlay // This is not a runtime error, forcedly display error overlay
rendered rendered
missingTags={state.rootLayoutMissingTags} missingTags={state.rootLayoutMissingTags}
/> />
...@@ -52,7 +52,14 @@ export function ErrorOverlay({ ...@@ -52,7 +52,14 @@ export function ErrorOverlay({
} }
if (state.buildError !== null) { if (state.buildError !== null) {
return <BuildError {...commonProps} message={state.buildError} /> return (
<BuildError
{...commonProps}
message={state.buildError}
// This is not a runtime error, forcedly display error overlay
rendered
/>
)
} }
// No Runtime Errors. // No Runtime Errors.
......
...@@ -30,18 +30,34 @@ function getErrorSignature(ev: SupportedErrorEvent): string { ...@@ -30,18 +30,34 @@ function getErrorSignature(ev: SupportedErrorEvent): string {
} }
} }
export function useErrorHook({ type Props = {
state, children: (params: {
isAppDir, readyErrors: ReadyRuntimeError[]
}: { totalErrorCount: number
}) => React.ReactNode
state: OverlayState state: OverlayState
isAppDir: boolean isAppDir: boolean
}) { }
const { errors, rootLayoutMissingTags, buildError } = state
export const RenderError = (props: Props) => {
const { state } = props
const isBuildError =
!!state.rootLayoutMissingTags?.length || !!state.buildError
if (isBuildError) {
return <RenderBuildError {...props} />
} else {
return <RenderRuntimeError {...props} />
}
}
const RenderRuntimeError = ({ children, state, isAppDir }: Props) => {
const { errors } = state
const [lookups, setLookups] = useState<{ const [lookups, setLookups] = useState<{
[eventId: string]: ReadyRuntimeError [eventId: string]: ReadyRuntimeError
}>({}) }>({})
const [readyErrors, nextError] = useMemo< const [readyErrors, nextError] = useMemo<
[ReadyRuntimeError[], SupportedErrorEvent | null] [ReadyRuntimeError[], SupportedErrorEvent | null]
>(() => { >(() => {
...@@ -93,16 +109,14 @@ export function useErrorHook({ ...@@ -93,16 +109,14 @@ export function useErrorHook({
} }
}, [nextError, isAppDir]) }, [nextError, isAppDir])
return { return children({ readyErrors, totalErrorCount: readyErrors.length })
readyErrors, }
// Total number of errors are based on the priority that
// will be displayed. Since build error and root layout const RenderBuildError = ({ children }: Props) => {
// missing tags won't be dismissed until resolved, the return children({
// total number of errors may be fixed to their length. readyErrors: [],
totalErrorCount: rootLayoutMissingTags?.length // Build errors and missing root layout tags persist until fixed,
? 1 // so we can set a fixed error count of 1
: !!buildError totalErrorCount: 1,
? 1 })
: readyErrors.length,
}
} }
...@@ -11,7 +11,7 @@ import { usePagesReactDevOverlay } from '../../pages/hooks' ...@@ -11,7 +11,7 @@ import { usePagesReactDevOverlay } from '../../pages/hooks'
import { Colors } from '../internal/styles/colors' import { Colors } from '../internal/styles/colors'
import { ErrorOverlay } from '../internal/components/errors/error-overlay/error-overlay' import { ErrorOverlay } from '../internal/components/errors/error-overlay/error-overlay'
import { DevToolsIndicator } from '../internal/components/errors/dev-tools-indicator/dev-tools-indicator' import { DevToolsIndicator } from '../internal/components/errors/dev-tools-indicator/dev-tools-indicator'
import { useErrorHook } from '../internal/container/runtime-error/use-error-hook' import { RenderError } from '../internal/container/runtime-error/render-error'
export type ErrorType = 'runtime' | 'build' export type ErrorType = 'runtime' | 'build'
...@@ -23,11 +23,6 @@ export default function ReactDevOverlay({ children }: ReactDevOverlayProps) { ...@@ -23,11 +23,6 @@ export default function ReactDevOverlay({ children }: ReactDevOverlayProps) {
const { state, onComponentError, hasRuntimeErrors, hasBuildError } = const { state, onComponentError, hasRuntimeErrors, hasBuildError } =
usePagesReactDevOverlay() usePagesReactDevOverlay()
const { readyErrors, totalErrorCount } = useErrorHook({
state,
isAppDir: false,
})
const [isErrorOverlayOpen, setIsErrorOverlayOpen] = useState(true) const [isErrorOverlayOpen, setIsErrorOverlayOpen] = useState(true)
return ( return (
...@@ -42,20 +37,26 @@ export default function ReactDevOverlay({ children }: ReactDevOverlayProps) { ...@@ -42,20 +37,26 @@ export default function ReactDevOverlay({ children }: ReactDevOverlayProps) {
<Colors /> <Colors />
<ComponentStyles /> <ComponentStyles />
<DevToolsIndicator <RenderError state={state} isAppDir={false}>
state={state} {({ readyErrors, totalErrorCount }) => (
errorCount={totalErrorCount} <>
setIsErrorOverlayOpen={setIsErrorOverlayOpen} <DevToolsIndicator
/> state={state}
errorCount={totalErrorCount}
{(hasRuntimeErrors || hasBuildError) && ( setIsErrorOverlayOpen={setIsErrorOverlayOpen}
<ErrorOverlay />
state={state}
readyErrors={readyErrors} {(hasRuntimeErrors || hasBuildError) && (
isErrorOverlayOpen={isErrorOverlayOpen} <ErrorOverlay
setIsErrorOverlayOpen={setIsErrorOverlayOpen} state={state}
/> readyErrors={readyErrors}
)} isErrorOverlayOpen={isErrorOverlayOpen}
setIsErrorOverlayOpen={setIsErrorOverlayOpen}
/>
)}
</>
)}
</RenderError>
</ShadowPortal> </ShadowPortal>
</> </>
) )
......
import { check } from 'next-test-utils' import { check, retry } from 'next-test-utils'
import { FileRef, nextTestSetup } from 'e2e-utils' import { FileRef, nextTestSetup } from 'e2e-utils'
import path from 'path' import path from 'path'
import { createSandbox } from 'development-sandbox' import { createSandbox } from 'development-sandbox'
...@@ -65,6 +65,25 @@ describe('Error overlay - editor links', () => { ...@@ -65,6 +65,25 @@ describe('Error overlay - editor links', () => {
` `
) )
const isNewDevOverlay =
process.env.__NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY === 'true'
// Ensure the Next Logo is not loading. This is to assert that the build did stop.
if (isNewDevOverlay) {
await retry(async () => {
const loaded = await browser.eval(() => {
return Boolean(
[].slice
.call(document.querySelectorAll('nextjs-portal'))
.find((p) =>
p.shadowRoot.querySelector('[data-next-mark-loading="false"]')
)
)
})
expect(loaded).toBe(true)
})
}
await session.assertHasRedbox() await session.assertHasRedbox()
await clickSourceFile(browser) await clickSourceFile(browser)
await check(() => editorRequestsCount, /1/) await check(() => editorRequestsCount, /1/)
......
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