Unverified Commit 9ffd729e authored by Zack Tanner's avatar Zack Tanner Committed by GitHub

[DevOverlay]: render indicator in pages router (#75918)

We weren't rendering the new indicator when used in pages router -- `isMounted` was only true when there was an error. This PR keeps the `isMounted` logic for the old overlay but removes it for the new one.
parent 281a8b3d
...@@ -3,7 +3,6 @@ import * as React from 'react' ...@@ -3,7 +3,6 @@ import * as React from 'react'
type DevOverlayErrorBoundaryProps = { type DevOverlayErrorBoundaryProps = {
children?: React.ReactNode children?: React.ReactNode
onError: (error: Error, componentStack: string | null) => void onError: (error: Error, componentStack: string | null) => void
isMounted?: boolean
} }
type DevOverlayErrorBoundaryState = { error: Error | null } type DevOverlayErrorBoundaryState = { error: Error | null }
......
...@@ -20,13 +20,8 @@ interface ReactDevOverlayProps { ...@@ -20,13 +20,8 @@ interface ReactDevOverlayProps {
} }
export default function ReactDevOverlay({ children }: ReactDevOverlayProps) { export default function ReactDevOverlay({ children }: ReactDevOverlayProps) {
const { const { state, onComponentError, hasRuntimeErrors, hasBuildError } =
isMounted, usePagesReactDevOverlay()
state,
onComponentError,
hasRuntimeErrors,
hasBuildError,
} = usePagesReactDevOverlay()
const { readyErrors, totalErrorCount } = useErrorHook({ const { readyErrors, totalErrorCount } = useErrorHook({
state, state,
...@@ -37,11 +32,10 @@ export default function ReactDevOverlay({ children }: ReactDevOverlayProps) { ...@@ -37,11 +32,10 @@ export default function ReactDevOverlay({ children }: ReactDevOverlayProps) {
return ( return (
<> <>
<DevOverlayErrorBoundary isMounted={isMounted} onError={onComponentError}> <DevOverlayErrorBoundary onError={onComponentError}>
{children ?? null} {children ?? null}
</DevOverlayErrorBoundary> </DevOverlayErrorBoundary>
{isMounted && (
<ShadowPortal> <ShadowPortal>
<CssReset /> <CssReset />
<Base /> <Base />
...@@ -63,7 +57,6 @@ export default function ReactDevOverlay({ children }: ReactDevOverlayProps) { ...@@ -63,7 +57,6 @@ export default function ReactDevOverlay({ children }: ReactDevOverlayProps) {
/> />
)} )}
</ShadowPortal> </ShadowPortal>
)}
</> </>
) )
} }
...@@ -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
isMounted?: boolean
} }
type ErrorBoundaryState = { error: Error | null } type ErrorBoundaryState = { error: Error | null }
......
...@@ -21,15 +21,8 @@ export const usePagesReactDevOverlay = () => { ...@@ -21,15 +21,8 @@ export const usePagesReactDevOverlay = () => {
const hasBuildError = state.buildError != null const hasBuildError = state.buildError != null
const hasRuntimeErrors = Boolean(state.errors.length) const hasRuntimeErrors = Boolean(state.errors.length)
const errorType = hasBuildError
? 'build'
: hasRuntimeErrors
? 'runtime'
: null
const isMounted = errorType !== null
return { return {
isMounted,
hasBuildError, hasBuildError,
hasRuntimeErrors, hasRuntimeErrors,
state, state,
......
...@@ -16,17 +16,13 @@ export default function ReactDevOverlay({ ...@@ -16,17 +16,13 @@ export default function ReactDevOverlay({
}: { }: {
children?: React.ReactNode children?: React.ReactNode
}) { }) {
const { const { hasBuildError, hasRuntimeErrors, state, onComponentError } =
isMounted, usePagesReactDevOverlay()
hasBuildError, const isMounted = hasBuildError || hasRuntimeErrors
hasRuntimeErrors,
state,
onComponentError,
} = usePagesReactDevOverlay()
return ( return (
<> <>
<ErrorBoundary isMounted={isMounted} onError={onComponentError}> <ErrorBoundary onError={onComponentError}>
{children ?? null} {children ?? null}
</ErrorBoundary> </ErrorBoundary>
{isMounted ? ( {isMounted ? (
......
...@@ -123,7 +123,7 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -123,7 +123,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer> <AppContainer>
<Container fn={function fn}> <Container fn={function fn}>
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}> <ErrorBoundary 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>
...@@ -192,7 +192,7 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -192,7 +192,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer> <AppContainer>
<Container fn={function fn}> <Container fn={function fn}>
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}> <ErrorBoundary 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>
...@@ -256,7 +256,7 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -256,7 +256,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer> <AppContainer>
<Container fn={function fn}> <Container fn={function fn}>
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}> <ErrorBoundary 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>
...@@ -316,7 +316,7 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -316,7 +316,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer> <AppContainer>
<Container fn={function fn}> <Container fn={function fn}>
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}> <ErrorBoundary 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>
...@@ -382,7 +382,7 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -382,7 +382,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer> <AppContainer>
<Container fn={function fn}> <Container fn={function fn}>
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}> <ErrorBoundary 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>
...@@ -449,7 +449,7 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -449,7 +449,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer> <AppContainer>
<Container fn={function fn}> <Container fn={function fn}>
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}> <ErrorBoundary 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>
...@@ -510,7 +510,7 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -510,7 +510,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer> <AppContainer>
<Container fn={function fn}> <Container fn={function fn}>
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}> <ErrorBoundary 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>
...@@ -525,7 +525,7 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -525,7 +525,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer> <AppContainer>
<Container fn={function fn}> <Container fn={function fn}>
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}> <ErrorBoundary 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>
...@@ -576,7 +576,7 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -576,7 +576,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
expect(pseudoHtml).toMatchInlineSnapshot(` expect(pseudoHtml).toMatchInlineSnapshot(`
"... "...
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}> <ErrorBoundary 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>
...@@ -686,7 +686,7 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -686,7 +686,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer> <AppContainer>
<Container fn={function fn}> <Container fn={function fn}>
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}> <ErrorBoundary 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>
...@@ -752,7 +752,7 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -752,7 +752,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
"... "...
<Container fn={function fn}> <Container fn={function fn}>
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}> <ErrorBoundary 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>
...@@ -812,7 +812,7 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -812,7 +812,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer> <AppContainer>
<Container fn={function fn}> <Container fn={function fn}>
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}> <ErrorBoundary 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>
...@@ -876,7 +876,7 @@ describe('Error overlay for hydration errors in Pages router', () => { ...@@ -876,7 +876,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer> <AppContainer>
<Container fn={function fn}> <Container fn={function fn}>
<ReactDevOverlay> <ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}> <ErrorBoundary 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>
......
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