Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DevOverlay]: render indicator in pages router #75918

Merged
merged 1 commit into from
Feb 11, 2025
+49 −69
Merged

[DevOverlay]: render indicator in pages router #75918

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion packages/next/src/client/components/react-dev-overlay/_experimental/pages/error-boundary.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 }

Expand Down
47 changes: 20 additions & 27 deletions ...es/next/src/client/components/react-dev-overlay/_experimental/pages/react-dev-overlay.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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>
</>
)
}
1 change: 0 additions & 1 deletion packages/next/src/client/components/react-dev-overlay/pages/error-boundary.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 }

Expand Down
7 changes: 0 additions & 7 deletions packages/next/src/client/components/react-dev-overlay/pages/hooks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
12 changes: 4 additions & 8 deletions packages/next/src/client/components/react-dev-overlay/pages/old-react-dev-overlay.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ? (
Expand Down
50 changes: 25 additions & 25 deletions test/development/acceptance/hydration-error.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -505,27 +505,27 @@ 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={[...]}>
<Head>
<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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
Loading