import { ACTION_BEFORE_REFRESH, ACTION_BUILD_ERROR, ACTION_BUILD_OK, ACTION_DEBUG_INFO, ACTION_DEV_INDICATOR, ACTION_REFRESH, ACTION_ERROR_OVERLAY_CLOSE, ACTION_ERROR_OVERLAY_OPEN, ACTION_ERROR_OVERLAY_TOGGLE, ACTION_STATIC_INDICATOR, ACTION_UNHANDLED_ERROR, ACTION_UNHANDLED_REJECTION, ACTION_VERSION_INFO, useErrorOverlayReducer, ACTION_BUILDING_INDICATOR_HIDE, ACTION_BUILDING_INDICATOR_SHOW, ACTION_RENDERING_INDICATOR_HIDE, ACTION_RENDERING_INDICATOR_SHOW, ACTION_DEVTOOL_UPDATE_ROUTE_STATE, ACTION_DEVTOOLS_CONFIG, type OverlayState, type DispatcherEvent, } from './dev-overlay/shared' import { createContext, startTransition, useContext, useInsertionEffect, type ActionDispatch, } from 'react' import { createRoot } from 'react-dom/client' import { FontStyles } from './dev-overlay/font/font-styles' import type { HydrationErrorState } from './shared/hydration-error' import type { DebugInfo } from './shared/types' import { DevOverlay } from './dev-overlay/dev-overlay' import type { DevIndicatorServerState } from '../server/dev/dev-indicator-server-state' import type { VersionInfo } from '../server/dev/parse-version-info' import { insertSegmentNode, removeSegmentNode, } from './dev-overlay/segment-explorer-trie' import type { SegmentNodeState } from './userspace/app/segment-explorer-node' import type { DevToolsConfig } from './dev-overlay/shared' export interface Dispatcher { onBuildOk(): void onBuildError(message: string): void onVersionInfo(versionInfo: VersionInfo): void onDebugInfo(debugInfo: DebugInfo): void onBeforeRefresh(): void onRefresh(): void onStaticIndicator(status: boolean): void onDevIndicator(devIndicator: DevIndicatorServerState): void onDevToolsConfig(config: DevToolsConfig): void onUnhandledError(reason: Error): void onUnhandledRejection(reason: Error): void openErrorOverlay(): void closeErrorOverlay(): void toggleErrorOverlay(): void buildingIndicatorHide(): void buildingIndicatorShow(): void renderingIndicatorHide(): void renderingIndicatorShow(): void segmentExplorerNodeAdd(nodeState: SegmentNodeState): void segmentExplorerNodeRemove(nodeState: SegmentNodeState): void segmentExplorerUpdateRouteState(page: string): void } type Dispatch = ReturnType[1] let maybeDispatch: Dispatch | null = null const queue: Array<(dispatch: Dispatch) => void> = [] // Events might be dispatched before we get a `dispatch` from React (e.g. console.error during module eval). // We need to queue them until we have a `dispatch` function available. function createQueuable( queueableFunction: (dispatch: Dispatch, ...args: Args) => void ) { return (...args: Args) => { if (maybeDispatch) { queueableFunction(maybeDispatch, ...args) } else { queue.push((dispatch: Dispatch) => { queueableFunction(dispatch, ...args) }) } } } // TODO: Extract into separate functions that are imported export const dispatcher: Dispatcher = { onBuildOk: createQueuable((dispatch: Dispatch) => { dispatch({ type: ACTION_BUILD_OK }) }), onBuildError: createQueuable((dispatch: Dispatch, message: string) => { dispatch({ type: ACTION_BUILD_ERROR, message }) }), onBeforeRefresh: createQueuable((dispatch: Dispatch) => { dispatch({ type: ACTION_BEFORE_REFRESH }) }), onRefresh: createQueuable((dispatch: Dispatch) => { dispatch({ type: ACTION_REFRESH }) }), onVersionInfo: createQueuable( (dispatch: Dispatch, versionInfo: VersionInfo) => { dispatch({ type: ACTION_VERSION_INFO, versionInfo }) } ), onStaticIndicator: createQueuable((dispatch: Dispatch, status: boolean) => { dispatch({ type: ACTION_STATIC_INDICATOR, staticIndicator: status }) }), onDebugInfo: createQueuable((dispatch: Dispatch, debugInfo: DebugInfo) => { dispatch({ type: ACTION_DEBUG_INFO, debugInfo }) }), onDevIndicator: createQueuable( (dispatch: Dispatch, devIndicator: DevIndicatorServerState) => { dispatch({ type: ACTION_DEV_INDICATOR, devIndicator }) } ), onDevToolsConfig: createQueuable( (dispatch: Dispatch, devToolsConfig: DevToolsConfig) => { dispatch({ type: ACTION_DEVTOOLS_CONFIG, devToolsConfig }) } ), onUnhandledError: createQueuable((dispatch: Dispatch, error: Error) => { dispatch({ type: ACTION_UNHANDLED_ERROR, reason: error, }) }), onUnhandledRejection: createQueuable((dispatch: Dispatch, error: Error) => { dispatch({ type: ACTION_UNHANDLED_REJECTION, reason: error, }) }), openErrorOverlay: createQueuable((dispatch: Dispatch) => { dispatch({ type: ACTION_ERROR_OVERLAY_OPEN }) }), closeErrorOverlay: createQueuable((dispatch: Dispatch) => { dispatch({ type: ACTION_ERROR_OVERLAY_CLOSE }) }), toggleErrorOverlay: createQueuable((dispatch: Dispatch) => { dispatch({ type: ACTION_ERROR_OVERLAY_TOGGLE }) }), buildingIndicatorHide: createQueuable((dispatch: Dispatch) => { dispatch({ type: ACTION_BUILDING_INDICATOR_HIDE }) }), buildingIndicatorShow: createQueuable((dispatch: Dispatch) => { dispatch({ type: ACTION_BUILDING_INDICATOR_SHOW }) }), renderingIndicatorHide: createQueuable((dispatch: Dispatch) => { dispatch({ type: ACTION_RENDERING_INDICATOR_HIDE }) }), renderingIndicatorShow: createQueuable((dispatch: Dispatch) => { dispatch({ type: ACTION_RENDERING_INDICATOR_SHOW }) }), segmentExplorerNodeAdd: createQueuable( (_: Dispatch, nodeState: SegmentNodeState) => { insertSegmentNode(nodeState) } ), segmentExplorerNodeRemove: createQueuable( (_: Dispatch, nodeState: SegmentNodeState) => { removeSegmentNode(nodeState) } ), segmentExplorerUpdateRouteState: createQueuable( (dispatch: Dispatch, page: string) => { dispatch({ type: ACTION_DEVTOOL_UPDATE_ROUTE_STATE, page }) } ), } function replayQueuedEvents(dispatch: NonNullable) { try { for (const queuedFunction of queue) { queuedFunction(dispatch) } } finally { // TODO: What to do with failed events? queue.length = 0 } } function DevOverlayRoot({ getComponentStack, getOwnerStack, getSquashedHydrationErrorDetails, isRecoverableError, routerType, }: { getComponentStack: (error: Error) => string | undefined getOwnerStack: (error: Error) => string | null | undefined getSquashedHydrationErrorDetails: (error: Error) => HydrationErrorState | null isRecoverableError: (error: Error) => boolean routerType: 'app' | 'pages' }) { const [state, dispatch] = useErrorOverlayReducer( routerType, getComponentStack, getOwnerStack, isRecoverableError ) useInsertionEffect(() => { maybeDispatch = dispatch // Can't schedule updates from useInsertionEffect, so we need to defer. // Could move this into a passive Effect but we don't want replaying when // we reconnect. const replayTimeout = setTimeout(() => { replayQueuedEvents(dispatch) }) return () => { maybeDispatch = null clearTimeout(replayTimeout) } }, []) return ( <> {/* Fonts can only be loaded outside the Shadow DOM. */} ) } export const DevOverlayContext = createContext<{ state: OverlayState & { routerType: 'pages' | 'app' } dispatch: ActionDispatch<[action: DispatcherEvent]> getSquashedHydrationErrorDetails: (error: Error) => HydrationErrorState | null }>(null!) export const useDevOverlayContext = () => useContext(DevOverlayContext) let isPagesMounted = false let isAppMounted = false function getSquashedHydrationErrorDetailsApp() { // We don't squash hydration errors in the App Router. return null } export function renderAppDevOverlay( getComponentStack: (error: Error) => string | undefined, getOwnerStack: (error: Error) => string | null | undefined, isRecoverableError: (error: Error) => boolean ): void { if (isPagesMounted) { // Switching between App and Pages Router is always a hard navigation // TODO: Support soft navigation between App and Pages Router throw new Error( 'Next DevTools: Pages Dev Overlay is already mounted. This is a bug in Next.js' ) } if (!isAppMounted) { // React 19 will not throw away `