Unverified Commit 7da911d6 authored by Jude Gao's avatar Jude Gao Committed by GitHub

chore: remove dead code from ReactDevOverlay (#74702)

### What?
Removes unused props and simplifies the error boundary implementation in
the React Dev Overlay component.

### Why?
The overlay had unnecessary complexity with unused props like
`preventDisplay` and `globalOverlay` that weren't providing value.
Simplifying the implementation makes the code more maintainable and
easier to understand.

### How?
- Removed `preventDisplay` and `globalOverlay` props from
ReactDevOverlay
- Simplified ErrorBoundary component by removing global overlay handling
- Updated type definitions for ErrorDebug component
- Cleaned up error display logic in hooks
- Updated tests to reflect new component structure
parent 07e636f9
...@@ -15,31 +15,20 @@ export type ErrorType = 'runtime' | 'build' ...@@ -15,31 +15,20 @@ export type ErrorType = 'runtime' | 'build'
interface ReactDevOverlayProps { interface ReactDevOverlayProps {
children?: React.ReactNode children?: React.ReactNode
preventDisplay?: ErrorType[]
globalOverlay?: boolean
} }
export default function ReactDevOverlay({ export default function ReactDevOverlay({ children }: ReactDevOverlayProps) {
children,
preventDisplay,
globalOverlay,
}: ReactDevOverlayProps) {
const { const {
isMounted, isMounted,
displayPrevented,
hasBuildError, hasBuildError,
hasRuntimeErrors, hasRuntimeErrors,
state, state,
onComponentError, onComponentError,
} = usePagesReactDevOverlay(preventDisplay) } = usePagesReactDevOverlay()
return ( return (
<> <>
<ErrorBoundary <ErrorBoundary isMounted={isMounted} onError={onComponentError}>
globalOverlay={globalOverlay}
isMounted={isMounted}
onError={onComponentError}
>
{children ?? null} {children ?? null}
</ErrorBoundary> </ErrorBoundary>
{isMounted ? ( {isMounted ? (
...@@ -49,7 +38,7 @@ export default function ReactDevOverlay({ ...@@ -49,7 +38,7 @@ export default function ReactDevOverlay({
<Colors /> <Colors />
<ComponentStyles /> <ComponentStyles />
{displayPrevented ? null : hasBuildError ? ( {hasBuildError ? (
<BuildError <BuildError
message={state.buildError!} message={state.buildError!}
versionInfo={state.versionInfo} versionInfo={state.versionInfo}
......
...@@ -3,7 +3,6 @@ import * as React from 'react' ...@@ -3,7 +3,6 @@ import * as React from 'react'
type ErrorBoundaryProps = { type ErrorBoundaryProps = {
children?: React.ReactNode children?: React.ReactNode
onError: (error: Error, componentStack: string | null) => void onError: (error: Error, componentStack: string | null) => void
globalOverlay?: boolean
isMounted?: boolean isMounted?: boolean
} }
type ErrorBoundaryState = { error: Error | null } type ErrorBoundaryState = { error: Error | null }
...@@ -25,26 +24,12 @@ export class ErrorBoundary extends React.PureComponent< ...@@ -25,26 +24,12 @@ export class ErrorBoundary extends React.PureComponent<
errorInfo?: { componentStack?: string | null } errorInfo?: { componentStack?: string | null }
) { ) {
this.props.onError(error, errorInfo?.componentStack || null) this.props.onError(error, errorInfo?.componentStack || null)
if (!this.props.globalOverlay) { this.setState({ error })
this.setState({ error })
}
} }
// Explicit type is needed to avoid the generated `.d.ts` having a wide return type that could be specific to the `@types/react` version. // Explicit type is needed to avoid the generated `.d.ts` having a wide return type that could be specific to the `@types/react` version.
render(): React.ReactNode { render(): React.ReactNode {
// The component has to be unmounted or else it would continue to error // The component has to be unmounted or else it would continue to error
return this.state.error || return this.state.error ? null : this.props.children
(this.props.globalOverlay && this.props.isMounted) ? (
// When the overlay is global for the application and it wraps a component rendering `<html>`
// we have to render the html shell otherwise the shadow root will not be able to attach
this.props.globalOverlay ? (
<html>
<head></head>
<body></body>
</html>
) : null
) : (
this.props.children
)
} }
} }
...@@ -11,33 +11,22 @@ import { usePagesReactDevOverlay } from './hooks' ...@@ -11,33 +11,22 @@ import { usePagesReactDevOverlay } from './hooks'
export type ErrorType = 'runtime' | 'build' export type ErrorType = 'runtime' | 'build'
interface ReactDevOverlayProps {
children?: React.ReactNode
preventDisplay?: ErrorType[]
globalOverlay?: boolean
}
export default function ReactDevOverlay({ export default function ReactDevOverlay({
children, children,
preventDisplay, }: {
globalOverlay, children?: React.ReactNode
}: ReactDevOverlayProps) { }) {
const { const {
isMounted, isMounted,
displayPrevented,
hasBuildError, hasBuildError,
hasRuntimeErrors, hasRuntimeErrors,
state, state,
onComponentError, onComponentError,
} = usePagesReactDevOverlay(preventDisplay) } = usePagesReactDevOverlay()
return ( return (
<> <>
<ErrorBoundary <ErrorBoundary isMounted={isMounted} onError={onComponentError}>
globalOverlay={globalOverlay}
isMounted={isMounted}
onError={onComponentError}
>
{children ?? null} {children ?? null}
</ErrorBoundary> </ErrorBoundary>
{isMounted ? ( {isMounted ? (
...@@ -46,7 +35,7 @@ export default function ReactDevOverlay({ ...@@ -46,7 +35,7 @@ export default function ReactDevOverlay({
<Base /> <Base />
<ComponentStyles /> <ComponentStyles />
{displayPrevented ? null : hasBuildError ? ( {hasBuildError ? (
<BuildError <BuildError
message={state.buildError!} message={state.buildError!}
versionInfo={state.versionInfo} versionInfo={state.versionInfo}
......
import OldReactDevOverlay from './OldReactDevOverlay' import OldReactDevOverlay from './OldReactDevOverlay'
import NewReactDevOverlay from '../_experimental/pages/ReactDevOverlay' import NewReactDevOverlay from '../_experimental/pages/ReactDevOverlay'
export default Boolean(process.env.__NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY) const ReactDevOverlay = Boolean(process.env.__NEXT_EXPERIMENTAL_NEW_DEV_OVERLAY)
? NewReactDevOverlay ? NewReactDevOverlay
: OldReactDevOverlay : OldReactDevOverlay
export type ReactDevOverlayType = typeof ReactDevOverlay
export default ReactDevOverlay
import type { ErrorType } from './OldReactDevOverlay'
import React from 'react' import React from 'react'
import * as Bus from './bus' import * as Bus from './bus'
import { useErrorOverlayReducer } from '../shared' import { useErrorOverlayReducer } from '../shared'
const shouldPreventDisplay = ( export const usePagesReactDevOverlay = () => {
errorType?: ErrorType | null,
preventType?: ErrorType[] | null
) => {
if (!preventType || !errorType) {
return false
}
return preventType.includes(errorType)
}
export const usePagesReactDevOverlay = (
preventDisplay: ErrorType[] | undefined
) => {
const [state, dispatch] = useErrorOverlayReducer() const [state, dispatch] = useErrorOverlayReducer()
React.useEffect(() => { React.useEffect(() => {
...@@ -41,10 +28,8 @@ export const usePagesReactDevOverlay = ( ...@@ -41,10 +28,8 @@ export const usePagesReactDevOverlay = (
: null : null
const isMounted = errorType !== null const isMounted = errorType !== null
const displayPrevented = shouldPreventDisplay(errorType, preventDisplay)
return { return {
isMounted, isMounted,
displayPrevented,
hasBuildError, hasBuildError,
hasRuntimeErrors, hasRuntimeErrors,
state, state,
......
...@@ -6,7 +6,6 @@ import type { ParsedUrl } from '../../shared/lib/router/utils/parse-url' ...@@ -6,7 +6,6 @@ import type { ParsedUrl } from '../../shared/lib/router/utils/parse-url'
import type { ParsedUrlQuery } from 'querystring' import type { ParsedUrlQuery } from 'querystring'
import type { UrlWithParsedQuery } from 'url' import type { UrlWithParsedQuery } from 'url'
import type { MiddlewareRoutingItem } from '../base-server' import type { MiddlewareRoutingItem } from '../base-server'
import type { FunctionComponent } from 'react'
import type { RouteDefinition } from '../route-definitions/route-definition' import type { RouteDefinition } from '../route-definitions/route-definition'
import type { RouteMatcherManager } from '../route-matcher-managers/route-matcher-manager' import type { RouteMatcherManager } from '../route-matcher-managers/route-matcher-manager'
import { import {
...@@ -70,10 +69,11 @@ import type { ServerOnInstrumentationRequestError } from '../app-render/types' ...@@ -70,10 +69,11 @@ import type { ServerOnInstrumentationRequestError } from '../app-render/types'
import type { ServerComponentsHmrCache } from '../response-cache' import type { ServerComponentsHmrCache } from '../response-cache'
import { logRequests } from './log-requests' import { logRequests } from './log-requests'
import { FallbackMode } from '../../lib/fallback' import { FallbackMode } from '../../lib/fallback'
import type { ReactDevOverlayType } from '../../client/components/react-dev-overlay/pages/ReactDevOverlay'
// Load ReactDevOverlay only when needed // Load ReactDevOverlay only when needed
let ReactDevOverlayImpl: FunctionComponent let ReactDevOverlayImpl: ReactDevOverlayType
const ReactDevOverlay = (props: any) => { const ReactDevOverlay: ReactDevOverlayType = (props) => {
if (ReactDevOverlayImpl === undefined) { if (ReactDevOverlayImpl === undefined) {
ReactDevOverlayImpl = ReactDevOverlayImpl =
require('../../client/components/react-dev-overlay/pages/client').ReactDevOverlay require('../../client/components/react-dev-overlay/pages/client').ReactDevOverlay
......
...@@ -103,6 +103,7 @@ import { ReflectAdapter } from './web/spec-extension/adapters/reflect' ...@@ -103,6 +103,7 @@ import { ReflectAdapter } from './web/spec-extension/adapters/reflect'
import { formatRevalidate } from './lib/revalidate' import { formatRevalidate } from './lib/revalidate'
import { getErrorSource } from '../shared/lib/error-source' import { getErrorSource } from '../shared/lib/error-source'
import type { DeepReadonly } from '../shared/lib/deep-readonly' import type { DeepReadonly } from '../shared/lib/deep-readonly'
import type { ReactDevOverlayType } from '../client/components/react-dev-overlay/pages/ReactDevOverlay'
let tryGetPreviewData: typeof import('./api-utils/node/try-get-preview-data').tryGetPreviewData let tryGetPreviewData: typeof import('./api-utils/node/try-get-preview-data').tryGetPreviewData
let warn: typeof import('../build/output/log').warn let warn: typeof import('../build/output/log').warn
...@@ -240,7 +241,7 @@ export type RenderOptsPartial = { ...@@ -240,7 +241,7 @@ export type RenderOptsPartial = {
nextExport?: boolean nextExport?: boolean
dev?: boolean dev?: boolean
ampPath?: string ampPath?: string
ErrorDebug?: React.ComponentType<{ error: Error }> ErrorDebug?: ReactDevOverlayType
ampValidator?: (html: string, pathname: string) => Promise<void> ampValidator?: (html: string, pathname: string) => Promise<void>
ampSkipValidation?: boolean ampSkipValidation?: boolean
ampOptimizerConfig?: { [key: string]: any } ampOptimizerConfig?: { [key: string]: any }
...@@ -1298,7 +1299,7 @@ export async function renderToHTMLImpl( ...@@ -1298,7 +1299,7 @@ export async function renderToHTMLImpl(
const html = await renderToString( const html = await renderToString(
<Body> <Body>
<ErrorDebug error={ctx.err} /> <ErrorDebug />
</Body> </Body>
) )
return { html, head } return { html, head }
...@@ -1343,7 +1344,7 @@ export async function renderToHTMLImpl( ...@@ -1343,7 +1344,7 @@ export async function renderToHTMLImpl(
return ctx.err && ErrorDebug ? ( return ctx.err && ErrorDebug ? (
<Body> <Body>
<ErrorDebug error={ctx.err} /> <ErrorDebug />
</Body> </Body>
) : ( ) : (
<Body> <Body>
......
...@@ -124,18 +124,18 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -124,18 +124,18 @@ describe('Error overlay for hydration errors in Pages router', () => {
`) `)
} else { } else {
expect(pseudoHtml).toMatchInlineSnapshot(` expect(pseudoHtml).toMatchInlineSnapshot(`
"... "...
<AppContainer> <AppContainer>
<Container fn={function fn}> <Container fn={function fn}>
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary globalOverlay={undefined} isMounted={false} ...> <ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}> <PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}> <App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Mismatch> <Mismatch>
<div className="parent"> <div className="parent">
<main className="child"> <main className="child">
+ client + client
- server" - server"
`) `)
} }
} else { } else {
...@@ -217,17 +217,17 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -217,17 +217,17 @@ describe('Error overlay for hydration errors in Pages router', () => {
`) `)
} else { } else {
expect(pseudoHtml).toMatchInlineSnapshot(` expect(pseudoHtml).toMatchInlineSnapshot(`
"... "...
<AppContainer> <AppContainer>
<Container fn={function fn}> <Container fn={function fn}>
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary globalOverlay={undefined} isMounted={false} ...> <ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}> <PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}> <App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Mismatch> <Mismatch>
<div className="parent"> <div className="parent">
... ...
+ <main className="only">" + <main className="only">"
`) `)
} }
} else { } else {
...@@ -305,17 +305,17 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -305,17 +305,17 @@ describe('Error overlay for hydration errors in Pages router', () => {
`) `)
} else { } else {
expect(pseudoHtml).toMatchInlineSnapshot(` expect(pseudoHtml).toMatchInlineSnapshot(`
"... "...
<AppContainer> <AppContainer>
<Container fn={function fn}> <Container fn={function fn}>
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary globalOverlay={undefined} isMounted={false} ...> <ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}> <PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}> <App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Mismatch> <Mismatch>
<div className="parent"> <div className="parent">
+ second + second
- <footer className="3">" - <footer className="3">"
`) `)
} }
} else { } else {
...@@ -379,16 +379,16 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -379,16 +379,16 @@ describe('Error overlay for hydration errors in Pages router', () => {
`) `)
} else { } else {
expect(pseudoHtml).toMatchInlineSnapshot(` expect(pseudoHtml).toMatchInlineSnapshot(`
"<Root callbacks={[...]}> "<Root callbacks={[...]}>
<AppContainer> <AppContainer>
<Container fn={function fn}> <Container fn={function fn}>
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary globalOverlay={undefined} isMounted={false} ...> <ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}> <PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}> <App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Mismatch> <Mismatch>
<div className="parent"> <div className="parent">
- <main className="only">" - <main className="only">"
`) `)
} }
} else { } else {
...@@ -463,16 +463,16 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -463,16 +463,16 @@ describe('Error overlay for hydration errors in Pages router', () => {
`) `)
} else { } else {
expect(pseudoHtml).toMatchInlineSnapshot(` expect(pseudoHtml).toMatchInlineSnapshot(`
"<Root callbacks={[...]}> "<Root callbacks={[...]}>
<AppContainer> <AppContainer>
<Container fn={function fn}> <Container fn={function fn}>
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary globalOverlay={undefined} isMounted={false} ...> <ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}> <PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}> <App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Mismatch> <Mismatch>
<div className="parent"> <div className="parent">
- only" - only"
`) `)
} }
} else { } else {
...@@ -548,17 +548,17 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -548,17 +548,17 @@ describe('Error overlay for hydration errors in Pages router', () => {
`) `)
} else { } else {
expect(pseudoHtml).toMatchInlineSnapshot(` expect(pseudoHtml).toMatchInlineSnapshot(`
"<Root callbacks={[...]}> "<Root callbacks={[...]}>
<AppContainer> <AppContainer>
<Container fn={function fn}> <Container fn={function fn}>
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary globalOverlay={undefined} isMounted={false} ...> <ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}> <PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Page} err={undefined} router={{sdc:{},sbc:{}, ...}}> <App pageProps={{}} Component={function Page} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Page> <Page>
... ...
+ <table> + <table>
- test" - test"
`) `)
} }
} else { } else {
......
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