Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
N
next.js
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Alex
next.js
Commits
4ab6eba5
Unverified
Commit
4ab6eba5
authored
May 27, 2025
by
Sebastian "Sebbie" Silbermann
Committed by
GitHub
May 27, 2025
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
[dev-overlay] Move Redbox open/close into dispatcher (#79698)
parent
826da1f7
Hide whitespace changes
Inline
Side-by-side
Showing
11 changed files
with
117 additions
and
67 deletions
+117
-67
app-dev-overlay.tsx
...ient/components/react-dev-overlay/app/app-dev-overlay.tsx
+11
-10
hot-reloader-client.tsx
.../components/react-dev-overlay/app/hot-reloader-client.tsx
+1
-1
hooks.ts
...xt/src/client/components/react-dev-overlay/pages/hooks.ts
+1
-0
pages-dev-overlay.tsx
.../components/react-dev-overlay/pages/pages-dev-overlay.tsx
+2
-9
shared.ts
...es/next/src/client/components/react-dev-overlay/shared.ts
+35
-1
dev-tools-indicator.stories.tsx
...rrors/dev-tools-indicator/dev-tools-indicator.stories.tsx
+5
-4
dev-tools-indicator.tsx
...onents/errors/dev-tools-indicator/dev-tools-indicator.tsx
+13
-12
error-overlay.tsx
...rlay/ui/components/errors/error-overlay/error-overlay.tsx
+9
-7
dev-overlay.stories.tsx
...t/components/react-dev-overlay/ui/dev-overlay.stories.tsx
+32
-10
dev-overlay.tsx
...rc/client/components/react-dev-overlay/ui/dev-overlay.tsx
+5
-10
hydration-error.test.ts
test/development/acceptance-app/hydration-error.test.ts
+3
-3
No files found.
packages/next/src/client/components/react-dev-overlay/app/app-dev-overlay.tsx
View file @
4ab6eba5
import
type
{
OverlayState
}
from
'../shared'
import
{
ACTION_ERROR_OVERLAY_OPEN
,
type
OverlayDispatch
,
type
OverlayState
,
}
from
'../shared'
import
type
{
GlobalErrorComponent
}
from
'../../global-error'
import
{
useCallback
,
useEffect
,
useState
}
from
'react'
import
{
useCallback
,
useEffect
}
from
'react'
import
{
AppDevOverlayErrorBoundary
}
from
'./app-dev-overlay-error-boundary'
import
{
FontStyles
}
from
'../font/font-styles'
import
{
DevOverlay
}
from
'../ui/dev-overlay'
...
...
@@ -70,17 +74,18 @@ function ReplaySsrOnlyErrors({
export
function
AppDevOverlay
({
state
,
dispatch
,
globalError
,
children
,
}:
{
state
:
OverlayState
dispatch
:
OverlayDispatch
globalError
:
[
GlobalErrorComponent
,
React
.
ReactNode
]
children
:
React
.
ReactNode
})
{
const
[
isErrorOverlayOpen
,
setIsErrorOverlayOpen
]
=
useState
(
false
)
const
openOverlay
=
useCallback
(()
=>
{
setIsErrorOverlayOpen
(
true
)
},
[])
dispatch
({
type
:
ACTION_ERROR_OVERLAY_OPEN
}
)
},
[
dispatch
])
return
(
<>
...
...
@@ -94,11 +99,7 @@ export function AppDevOverlay({
<>
{
/* Fonts can only be loaded outside the Shadow DOM. */
}
<
FontStyles
/>
<
DevOverlay
state=
{
state
}
isErrorOverlayOpen=
{
isErrorOverlayOpen
}
setIsErrorOverlayOpen=
{
setIsErrorOverlayOpen
}
/>
<
DevOverlay
state=
{
state
}
dispatch=
{
dispatch
}
/>
</>
</>
)
...
...
packages/next/src/client/components/react-dev-overlay/app/hot-reloader-client.tsx
View file @
4ab6eba5
...
...
@@ -624,7 +624,7 @@ export default function HotReload({
])
return
(
<
AppDevOverlay
state=
{
state
}
globalError=
{
globalError
}
>
<
AppDevOverlay
state=
{
state
}
dispatch=
{
dispatch
}
globalError=
{
globalError
}
>
{
children
}
</
AppDevOverlay
>
)
...
...
packages/next/src/client/components/react-dev-overlay/pages/hooks.ts
View file @
4ab6eba5
...
...
@@ -30,5 +30,6 @@ export const usePagesDevOverlay = () => {
return
{
state
,
onComponentError
,
dispatch
,
}
}
packages/next/src/client/components/react-dev-overlay/pages/pages-dev-overlay.tsx
View file @
4ab6eba5
import
{
useState
}
from
'react'
import
{
PagesDevOverlayErrorBoundary
}
from
'./pages-dev-overlay-error-boundary'
import
{
usePagesDevOverlay
}
from
'./hooks'
import
{
FontStyles
}
from
'../font/font-styles'
...
...
@@ -13,9 +12,7 @@ interface PagesDevOverlayProps {
}
export
function
PagesDevOverlay
({
children
}:
PagesDevOverlayProps
)
{
const
{
state
,
onComponentError
}
=
usePagesDevOverlay
()
const
[
isErrorOverlayOpen
,
setIsErrorOverlayOpen
]
=
useState
(
true
)
const
{
state
,
dispatch
,
onComponentError
}
=
usePagesDevOverlay
()
return
(
<>
...
...
@@ -25,11 +22,7 @@ export function PagesDevOverlay({ children }: PagesDevOverlayProps) {
{
/* Fonts can only be loaded outside the Shadow DOM. */
}
<
FontStyles
/>
<
DevOverlay
state=
{
state
}
isErrorOverlayOpen=
{
isErrorOverlayOpen
}
setIsErrorOverlayOpen=
{
setIsErrorOverlayOpen
}
/>
<
DevOverlay
state=
{
state
}
dispatch=
{
dispatch
}
/>
</>
)
}
packages/next/src/client/components/react-dev-overlay/shared.ts
View file @
4ab6eba5
...
...
@@ -27,7 +27,9 @@ export interface OverlayState {
disableDevIndicator
:
boolean
debugInfo
:
DebugInfo
routerType
:
'pages'
|
'app'
isErrorOverlayOpen
:
boolean
}
export
type
OverlayDispatch
=
React
.
Dispatch
<
BusEvent
>
export
const
ACTION_STATIC_INDICATOR
=
'static-indicator'
export
const
ACTION_BUILD_OK
=
'build-ok'
...
...
@@ -39,6 +41,9 @@ export const ACTION_UNHANDLED_ERROR = 'unhandled-error'
export
const
ACTION_UNHANDLED_REJECTION
=
'unhandled-rejection'
export
const
ACTION_DEBUG_INFO
=
'debug-info'
export
const
ACTION_DEV_INDICATOR
=
'dev-indicator'
export
const
ACTION_ERROR_OVERLAY_OPEN
=
'error-overlay-open'
export
const
ACTION_ERROR_OVERLAY_CLOSE
=
'error-overlay-close'
export
const
ACTION_ERROR_OVERLAY_TOGGLE
=
'error-overlay-toggle'
export
const
STORAGE_KEY_THEME
=
'__nextjs-dev-tools-theme'
export
const
STORAGE_KEY_POSITION
=
'__nextjs-dev-tools-position'
...
...
@@ -90,6 +95,16 @@ interface DevIndicatorAction {
devIndicator
:
DevIndicatorServerState
}
export
interface
ErrorOverlayOpenAction
{
type
:
typeof
ACTION_ERROR_OVERLAY_OPEN
}
export
interface
ErrorOverlayCloseAction
{
type
:
typeof
ACTION_ERROR_OVERLAY_CLOSE
}
export
interface
ErrorOverlayToggleAction
{
type
:
typeof
ACTION_ERROR_OVERLAY_TOGGLE
}
export
type
BusEvent
=
|
BuildOkAction
|
BuildErrorAction
...
...
@@ -101,6 +116,9 @@ export type BusEvent =
|
StaticIndicatorAction
|
DebugInfoAction
|
DevIndicatorAction
|
ErrorOverlayOpenAction
|
ErrorOverlayCloseAction
|
ErrorOverlayToggleAction
const
REACT_ERROR_STACK_BOTTOM_FRAME_REGEX
=
// 1st group: v8
...
...
@@ -136,7 +154,10 @@ function pushErrorFilterDuplicates(
const
shouldDisableDevIndicator
=
process
.
env
.
__NEXT_DEV_INDICATOR
?.
toString
()
===
'false'
export
const
INITIAL_OVERLAY_STATE
:
Omit
<
OverlayState
,
'routerType'
>
=
{
export
const
INITIAL_OVERLAY_STATE
:
Omit
<
OverlayState
,
'isErrorOverlayOpen'
|
'routerType'
>
=
{
nextId
:
1
,
buildError
:
null
,
errors
:
[],
...
...
@@ -159,6 +180,10 @@ function getInitialState(
):
OverlayState
&
{
routerType
:
'pages'
|
'app'
}
{
return
{
...
INITIAL_OVERLAY_STATE
,
// Pages Router only listenes to thrown errors which
// always open the overlay.
// TODO: Should be the same default as App Router once we surface console.error in Pages Router.
isErrorOverlayOpen
:
routerType
===
'pages'
,
routerType
,
}
}
...
...
@@ -239,6 +264,15 @@ export function useErrorOverlayReducer(routerType: 'pages' | 'app') {
shouldDisableDevIndicator
||
!!
action
.
devIndicator
.
disabledUntil
,
}
}
case
ACTION_ERROR_OVERLAY_OPEN
:
{
return
{
...
state
,
isErrorOverlayOpen
:
true
}
}
case
ACTION_ERROR_OVERLAY_CLOSE
:
{
return
{
...
state
,
isErrorOverlayOpen
:
false
}
}
case
ACTION_ERROR_OVERLAY_TOGGLE
:
{
return
{
...
state
,
isErrorOverlayOpen
:
!
state
.
isErrorOverlayOpen
}
}
default
:
{
return
state
}
...
...
packages/next/src/client/components/react-dev-overlay/ui/components/errors/dev-tools-indicator/dev-tools-indicator.stories.tsx
View file @
4ab6eba5
...
...
@@ -56,13 +56,14 @@ const state: OverlayState = {
notFound
:
false
,
staticIndicator
:
true
,
debugInfo
:
{
devtoolsFrontendUrl
:
undefined
},
isErrorOverlayOpen
:
false
,
}
export
const
StaticRoute
:
Story
=
{
args
:
{
errorCount
:
0
,
state
,
setIsErrorOverlayOpen
:
()
=>
{},
dispatch
:
()
=>
{},
},
}
...
...
@@ -73,7 +74,7 @@ export const DynamicRoute: Story = {
...
state
,
staticIndicator
:
false
,
},
setIsErrorOverlayOpen
:
()
=>
{},
dispatch
:
()
=>
{},
},
}
...
...
@@ -81,7 +82,7 @@ export const SingleError: Story = {
args
:
{
errorCount
:
1
,
state
,
setIsErrorOverlayOpen
:
()
=>
{},
dispatch
:
()
=>
{},
},
}
...
...
@@ -89,6 +90,6 @@ export const MultipleErrors: Story = {
args
:
{
errorCount
:
3
,
state
,
setIsErrorOverlayOpen
:
()
=>
{},
dispatch
:
()
=>
{},
},
}
packages/next/src/client/components/react-dev-overlay/ui/components/errors/dev-tools-indicator/dev-tools-indicator.tsx
View file @
4ab6eba5
import
type
{
CSSProperties
,
Dispatch
,
SetStateAction
}
from
'react'
import
{
STORAGE_KEY_POSITION
,
type
OverlayState
}
from
'../../../../shared'
import
{
ACTION_ERROR_OVERLAY_OPEN
,
ACTION_ERROR_OVERLAY_TOGGLE
,
STORAGE_KEY_POSITION
,
type
OverlayDispatch
,
type
OverlayState
,
}
from
'../../../../shared'
import
{
useState
,
useEffect
,
useRef
,
createContext
,
useContext
}
from
'react'
import
{
Toast
}
from
'../../toast'
...
...
@@ -30,15 +36,13 @@ export function DevToolsIndicator({
state
,
errorCount
,
isBuildError
,
setIsErrorOverlayOpen
,
...
props
}:
{
state
:
OverlayState
dispatch
:
OverlayDispatch
errorCount
:
number
isBuildError
:
boolean
setIsErrorOverlayOpen
:
(
isErrorOverlayOpen
:
boolean
|
((
prev
:
boolean
)
=>
boolean
)
)
=>
void
scale
:
DevToolsScale
setScale
:
(
value
:
DevToolsScale
)
=>
void
})
{
...
...
@@ -57,7 +61,6 @@ export function DevToolsIndicator({
method
:
'POST'
,
})
}
}
setIsErrorOverlayOpen=
{
setIsErrorOverlayOpen
}
isTurbopack=
{
!!
process
.
env
.
TURBOPACK
}
disabled=
{
state
.
disableDevIndicator
||
!
isDevToolsIndicatorVisible
}
isBuildError=
{
isBuildError
}
...
...
@@ -96,7 +99,7 @@ function DevToolsPopover({
isTurbopack
,
isBuildError
,
hide
,
setIsErrorOverlayOpen
,
dispatch
,
scale
,
setScale
,
}:
{
...
...
@@ -108,9 +111,7 @@ function DevToolsPopover({
isTurbopack
:
boolean
isBuildError
:
boolean
hide
:
()
=>
void
setIsErrorOverlayOpen
:
(
isOverlayOpen
:
boolean
|
((
prev
:
boolean
)
=>
boolean
)
)
=>
void
dispatch
:
OverlayDispatch
scale
:
DevToolsScale
setScale
:
(
value
:
DevToolsScale
)
=>
void
})
{
...
...
@@ -210,12 +211,12 @@ function DevToolsPopover({
function
openErrorOverlay
()
{
setOpen
(
null
)
if
(
issueCount
>
0
)
{
setIsErrorOverlayOpen
(
true
)
dispatch
({
type
:
ACTION_ERROR_OVERLAY_OPEN
}
)
}
}
function
toggleErrorOverlay
()
{
setIsErrorOverlayOpen
((
prev
)
=>
!
prev
)
dispatch
({
type
:
ACTION_ERROR_OVERLAY_TOGGLE
}
)
}
function
openRootMenu
()
{
...
...
packages/next/src/client/components/react-dev-overlay/ui/components/errors/error-overlay/error-overlay.tsx
View file @
4ab6eba5
import
type
{
OverlayState
}
from
'../../../../shared'
import
{
ACTION_ERROR_OVERLAY_CLOSE
,
type
OverlayDispatch
,
type
OverlayState
,
}
from
'../../../../shared'
import
{
Suspense
}
from
'react'
import
{
BuildError
}
from
'../../../container/build-error'
...
...
@@ -18,21 +22,19 @@ export interface ErrorBaseProps {
export
function
ErrorOverlay
({
state
,
dispatch
,
runtimeErrors
,
isErrorOverlayOpen
,
setIsErrorOverlayOpen
,
errorCount
,
}:
{
state
:
OverlayState
dispatch
:
OverlayDispatch
runtimeErrors
:
ReadyRuntimeError
[]
isErrorOverlayOpen
:
boolean
setIsErrorOverlayOpen
:
(
value
:
boolean
)
=>
void
errorCount
:
number
})
{
const
isTurbopack
=
!!
process
.
env
.
TURBOPACK
// This hook lets us do an exit animation before unmounting the component
const
{
mounted
,
rendered
}
=
useDelayedRender
(
isErrorOverlayOpen
,
{
const
{
mounted
,
rendered
}
=
useDelayedRender
(
state
.
isErrorOverlayOpen
,
{
exitDelay
:
transitionDurationMs
,
})
...
...
@@ -74,7 +76,7 @@ export function ErrorOverlay({
debugInfo=
{
state
.
debugInfo
}
runtimeErrors=
{
runtimeErrors
}
onClose=
{
()
=>
{
setIsErrorOverlayOpen
(
false
)
dispatch
({
type
:
ACTION_ERROR_OVERLAY_CLOSE
}
)
}
}
/>
)
...
...
packages/next/src/client/components/react-dev-overlay/ui/dev-overlay.stories.tsx
View file @
4ab6eba5
import
type
{
Meta
,
StoryObj
}
from
'@storybook/react'
import
type
{
OverlayState
}
from
'../shared'
import
type
{
BusEvent
,
OverlayState
}
from
'../shared'
// @ts-expect-error
import
imgApp
from
'./app.png'
import
{
use
State
}
from
'react'
import
{
use
Reducer
}
from
'react'
import
{
DevOverlay
}
from
'./dev-overlay'
import
{
ACTION_UNHANDLED_ERROR
}
from
'../shared'
import
{
ACTION_ERROR_OVERLAY_CLOSE
,
ACTION_ERROR_OVERLAY_OPEN
,
ACTION_ERROR_OVERLAY_TOGGLE
,
ACTION_UNHANDLED_ERROR
,
}
from
'../shared'
const
meta
:
Meta
<
typeof
DevOverlay
>
=
{
component
:
DevOverlay
,
...
...
@@ -18,7 +23,7 @@ const meta: Meta<typeof DevOverlay> = {
export
default
meta
type
Story
=
StoryObj
<
typeof
DevOverlay
>
const
s
tate
:
OverlayState
=
{
const
initialS
tate
:
OverlayState
=
{
nextId
:
0
,
routerType
:
'app'
,
buildError
:
null
,
...
...
@@ -81,11 +86,32 @@ const state: OverlayState = {
installed
:
'15.2.0'
,
staleness
:
'fresh'
,
},
isErrorOverlayOpen
:
true
,
}
function
useOverlayReducer
()
{
return
useReducer
<
OverlayState
,
[
BusEvent
]
>
((
state
,
action
):
OverlayState
=>
{
switch
(
action
.
type
)
{
case
ACTION_ERROR_OVERLAY_CLOSE
:
{
return
{
...
state
,
isErrorOverlayOpen
:
false
}
}
case
ACTION_ERROR_OVERLAY_OPEN
:
{
return
{
...
state
,
isErrorOverlayOpen
:
true
}
}
case
ACTION_ERROR_OVERLAY_TOGGLE
:
{
return
{
...
state
,
isErrorOverlayOpen
:
!
state
.
isErrorOverlayOpen
}
}
default
:
{
return
state
}
}
return
state
},
initialState
)
}
export
const
Default
:
Story
=
{
render
:
function
DevOverlayStory
()
{
const
[
isErrorOverlayOpen
,
setIsErrorOverlayOpen
]
=
useState
(
true
)
const
[
state
,
dispatch
]
=
useOverlayReducer
(
)
return
(
<>
<
img
...
...
@@ -96,11 +122,7 @@ export const Default: Story = {
objectFit
:
'contain'
,
}
}
/>
<
DevOverlay
state=
{
state
}
isErrorOverlayOpen=
{
isErrorOverlayOpen
}
setIsErrorOverlayOpen=
{
setIsErrorOverlayOpen
}
/>
<
DevOverlay
state=
{
state
}
dispatch=
{
dispatch
}
/>
</>
)
},
...
...
packages/next/src/client/components/react-dev-overlay/ui/dev-overlay.tsx
View file @
4ab6eba5
import
type
{
OverlayState
}
from
'../shared'
import
type
{
Overlay
Dispatch
,
Overlay
State
}
from
'../shared'
import
{
ShadowPortal
}
from
'./components/shadow-portal'
import
{
Base
}
from
'./styles/base'
...
...
@@ -13,14 +13,10 @@ import { useDevToolsScale } from './components/errors/dev-tools-indicator/dev-to
export
function
DevOverlay
({
state
,
isErrorOverlayOpen
,
setIsErrorOverlayOpen
,
dispatch
,
}:
{
state
:
OverlayState
isErrorOverlayOpen
:
boolean
setIsErrorOverlayOpen
:
(
isErrorOverlayOpen
:
boolean
|
((
prev
:
boolean
)
=>
boolean
)
)
=>
void
dispatch
:
OverlayDispatch
})
{
const
[
scale
,
setScale
]
=
useDevToolsScale
()
return
(
...
...
@@ -41,18 +37,17 @@ export function DevOverlay({
scale=
{
scale
}
setScale=
{
setScale
}
state=
{
state
}
dispatch=
{
dispatch
}
errorCount=
{
totalErrorCount
}
isBuildError=
{
isBuildError
}
setIsErrorOverlayOpen=
{
setIsErrorOverlayOpen
}
/>
)
}
<
ErrorOverlay
state=
{
state
}
dispatch=
{
dispatch
}
runtimeErrors=
{
runtimeErrors
}
errorCount=
{
totalErrorCount
}
isErrorOverlayOpen=
{
isErrorOverlayOpen
}
setIsErrorOverlayOpen=
{
setIsErrorOverlayOpen
}
/>
</>
)
...
...
test/development/acceptance-app/hydration-error.test.ts
View file @
4ab6eba5
...
...
@@ -209,7 +209,7 @@ describe('Error overlay for hydration errors in App router', () => {
{
"componentStack": "...
<HotReload assetPrefix="" globalError={[...]}>
<AppDevOverlay state={{nextId:1, ...}} globalError={[...]}>
<AppDevOverlay state={{nextId:1, ...}}
dispatch={function bound dispatchReducerAction}
globalError={[...]}>
<AppDevOverlayErrorBoundary globalError={[...]} onError={function}>
<ReplaySsrOnlyErrors>
<DevRootHTTPAccessFallbackBoundary>
...
...
@@ -245,7 +245,7 @@ describe('Error overlay for hydration errors in App router', () => {
{
"componentStack": "...
<HotReload assetPrefix="" globalError={[...]}>
<AppDevOverlay state={{nextId:1, ...}} globalError={[...]}>
<AppDevOverlay state={{nextId:1, ...}}
dispatch={function bound dispatchReducerAction}
globalError={[...]}>
<AppDevOverlayErrorBoundary globalError={[...]} onError={function}>
<ReplaySsrOnlyErrors>
<DevRootHTTPAccessFallbackBoundary>
...
...
@@ -1045,7 +1045,7 @@ describe('Error overlay for hydration errors in App router', () => {
{
"componentStack": "...
<HotReload assetPrefix="" globalError={[...]}>
<AppDevOverlay state={{nextId:1, ...}} globalError={[...]}>
<AppDevOverlay state={{nextId:1, ...}}
dispatch={function bound dispatchReducerAction}
globalError={[...]}>
<AppDevOverlayErrorBoundary globalError={[...]} onError={function}>
<ReplaySsrOnlyErrors>
<DevRootHTTPAccessFallbackBoundary>
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment