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'
type DevOverlayErrorBoundaryProps = {
children?: React.ReactNode
onError: (error: Error, componentStack: string | null) => void
isMounted?: boolean
}
type DevOverlayErrorBoundaryState = { error: Error | null }
......
......@@ -20,13 +20,8 @@ interface ReactDevOverlayProps {
}
export default function ReactDevOverlay({ children }: ReactDevOverlayProps) {
const {
isMounted,
state,
onComponentError,
hasRuntimeErrors,
hasBuildError,
} = usePagesReactDevOverlay()
const { state, onComponentError, hasRuntimeErrors, hasBuildError } =
usePagesReactDevOverlay()
const { readyErrors, totalErrorCount } = useErrorHook({
state,
......@@ -37,33 +32,31 @@ export default function ReactDevOverlay({ children }: ReactDevOverlayProps) {
return (
<>
<DevOverlayErrorBoundary isMounted={isMounted} onError={onComponentError}>
<DevOverlayErrorBoundary onError={onComponentError}>
{children ?? null}
</DevOverlayErrorBoundary>
{isMounted && (
<ShadowPortal>
<CssReset />
<Base />
<Colors />
<ComponentStyles />
<ShadowPortal>
<CssReset />
<Base />
<Colors />
<ComponentStyles />
<DevToolsIndicator
state={state}
errorCount={totalErrorCount}
setIsErrorOverlayOpen={setIsErrorOverlayOpen}
/>
<DevToolsIndicator
{(hasRuntimeErrors || hasBuildError) && (
<ErrorOverlay
state={state}
errorCount={totalErrorCount}
readyErrors={readyErrors}
isErrorOverlayOpen={isErrorOverlayOpen}
setIsErrorOverlayOpen={setIsErrorOverlayOpen}
/>
{(hasRuntimeErrors || hasBuildError) && (
<ErrorOverlay
state={state}
readyErrors={readyErrors}
isErrorOverlayOpen={isErrorOverlayOpen}
setIsErrorOverlayOpen={setIsErrorOverlayOpen}
/>
)}
</ShadowPortal>
)}
)}
</ShadowPortal>
</>
)
}
......@@ -3,7 +3,6 @@ import * as React from 'react'
type ErrorBoundaryProps = {
children?: React.ReactNode
onError: (error: Error, componentStack: string | null) => void
isMounted?: boolean
}
type ErrorBoundaryState = { error: Error | null }
......
......@@ -21,15 +21,8 @@ export const usePagesReactDevOverlay = () => {
const hasBuildError = state.buildError != null
const hasRuntimeErrors = Boolean(state.errors.length)
const errorType = hasBuildError
? 'build'
: hasRuntimeErrors
? 'runtime'
: null
const isMounted = errorType !== null
return {
isMounted,
hasBuildError,
hasRuntimeErrors,
state,
......
......@@ -16,17 +16,13 @@ export default function ReactDevOverlay({
}: {
children?: React.ReactNode
}) {
const {
isMounted,
hasBuildError,
hasRuntimeErrors,
state,
onComponentError,
} = usePagesReactDevOverlay()
const { hasBuildError, hasRuntimeErrors, state, onComponentError } =
usePagesReactDevOverlay()
const isMounted = hasBuildError || hasRuntimeErrors
return (
<>
<ErrorBoundary isMounted={isMounted} onError={onComponentError}>
<ErrorBoundary onError={onComponentError}>
{children ?? null}
</ErrorBoundary>
{isMounted ? (
......
......@@ -123,7 +123,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer>
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<ErrorBoundary onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Mismatch>
......@@ -192,7 +192,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer>
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<ErrorBoundary onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Mismatch>
......@@ -256,7 +256,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer>
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<ErrorBoundary onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Mismatch>
......@@ -316,7 +316,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer>
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<ErrorBoundary onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Mismatch>
......@@ -382,7 +382,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer>
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<ErrorBoundary onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Mismatch>
......@@ -449,7 +449,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer>
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<ErrorBoundary onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Page} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Page>
......@@ -505,19 +505,19 @@ describe('Error overlay for hydration errors in Pages router', () => {
const pseudoHtml = await session.getRedboxComponentStack()
if (isTurbopack) {
expect(pseudoHtml).toMatchInlineSnapshot(`
"<Root callbacks={[...]}>
<Head>
<AppContainer>
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Page} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Page>
+ <table>
- {" 123"}
..."
`)
"<Root callbacks={[...]}>
<Head>
<AppContainer>
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Page} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Page>
+ <table>
- {" 123"}
..."
`)
} else {
expect(pseudoHtml).toMatchInlineSnapshot(`
"<Root callbacks={[...]}>
......@@ -525,7 +525,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer>
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<ErrorBoundary onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Page} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Page>
......@@ -576,7 +576,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
expect(pseudoHtml).toMatchInlineSnapshot(`
"...
<ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<ErrorBoundary onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Mismatch} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Mismatch>
......@@ -686,7 +686,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer>
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<ErrorBoundary onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Page} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Page>
......@@ -752,7 +752,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
"...
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<ErrorBoundary onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Page} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Page>
......@@ -812,7 +812,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer>
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<ErrorBoundary onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Page} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<Page>
......@@ -876,7 +876,7 @@ describe('Error overlay for hydration errors in Pages router', () => {
<AppContainer>
<Container fn={function fn}>
<ReactDevOverlay>
<ErrorBoundary isMounted={false} onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<ErrorBoundary onError={function usePagesReactDevOverlay.useCallback[onComponentError]}>
<PathnameContextProviderAdapter router={{sdc:{},sbc:{}, ...}} isAutoExport={true}>
<App pageProps={{}} Component={function Page} err={undefined} router={{sdc:{},sbc:{}, ...}}>
<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