Unverified Commit a415f34a authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

refactor dev overlay into hot reloader (#41231)

Move react-dev-overlay into hot reloader client components, and let it imported by app router. So then we don't need to have hot reloader and react tree as adjacent sibilings but the overlay with error boundary is wrapping the react tree
Co-authored-by: 's avatarTim Neutkens <6324199+timneutkens@users.noreply.github.com>
parent ce820e2a
...@@ -185,12 +185,6 @@ const nextAppLoader: webpack.LoaderDefinitionFunction<{ ...@@ -185,12 +185,6 @@ const nextAppLoader: webpack.LoaderDefinitionFunction<{
export const AppRouter = require('next/dist/client/components/app-router.client.js').default export const AppRouter = require('next/dist/client/components/app-router.client.js').default
export const LayoutRouter = require('next/dist/client/components/layout-router.client.js').default export const LayoutRouter = require('next/dist/client/components/layout-router.client.js').default
export const RenderFromTemplateContext = require('next/dist/client/components/render-from-template-context.client.js').default export const RenderFromTemplateContext = require('next/dist/client/components/render-from-template-context.client.js').default
export const HotReloader = ${
// Disable HotReloader component in production
this.mode === 'development'
? `require('next/dist/client/components/hot-reloader.client.js').default`
: 'null'
}
export const staticGenerationAsyncStorage = require('next/dist/client/components/static-generation-async-storage.js').staticGenerationAsyncStorage export const staticGenerationAsyncStorage = require('next/dist/client/components/static-generation-async-storage.js').staticGenerationAsyncStorage
export const requestAsyncStorage = require('next/dist/client/components/request-async-storage.js').requestAsyncStorage export const requestAsyncStorage = require('next/dist/client/components/request-async-storage.js').requestAsyncStorage
......
'client' 'client'
import type { PropsWithChildren, ReactElement, ReactNode } from 'react' import type { ReactNode } from 'react'
import React, { useEffect, useMemo, useCallback } from 'react' import React, { useEffect, useMemo, useCallback } from 'react'
import { createFromFetch } from 'next/dist/compiled/react-server-dom-webpack' import { createFromFetch } from 'next/dist/compiled/react-server-dom-webpack'
import { import {
...@@ -35,6 +35,12 @@ function urlToUrlWithoutFlightMarker(url: string): URL { ...@@ -35,6 +35,12 @@ function urlToUrlWithoutFlightMarker(url: string): URL {
return urlWithoutFlightParameters return urlWithoutFlightParameters
} }
const HotReloader: typeof import('./hot-reloader').default | null =
process.env.NODE_ENV === 'production'
? null
: (require('./hot-reloader')
.default as typeof import('./hot-reloader').default)
/** /**
* Fetch the flight data for the provided url. Takes in the current router state to decide what to render server-side. * Fetch the flight data for the provided url. Takes in the current router state to decide what to render server-side.
*/ */
...@@ -78,20 +84,6 @@ export async function fetchServerResponse( ...@@ -78,20 +84,6 @@ export async function fetchServerResponse(
return [flightData, canonicalUrl] return [flightData, canonicalUrl]
} }
/**
* Renders development error overlay when NODE_ENV is development.
*/
function ErrorOverlay({ children }: PropsWithChildren<{}>): ReactElement {
if (process.env.NODE_ENV === 'production') {
return <>{children}</>
} else {
const {
ReactDevOverlay,
} = require('next/dist/compiled/@next/react-dev-overlay/dist/client')
return <ReactDevOverlay globalOverlay>{children}</ReactDevOverlay>
}
}
// Ensure the initialParallelRoutes are not combined because of double-rendering in the browser with Strict Mode. // Ensure the initialParallelRoutes are not combined because of double-rendering in the browser with Strict Mode.
// TODO-APP: move this back into AppRouter // TODO-APP: move this back into AppRouter
let initialParallelRoutes: CacheNode['parallelRoutes'] = let initialParallelRoutes: CacheNode['parallelRoutes'] =
...@@ -106,12 +98,12 @@ export default function AppRouter({ ...@@ -106,12 +98,12 @@ export default function AppRouter({
initialTree, initialTree,
initialCanonicalUrl, initialCanonicalUrl,
children, children,
hotReloader, assetPrefix,
}: { }: {
initialTree: FlightRouterState initialTree: FlightRouterState
initialCanonicalUrl: string initialCanonicalUrl: string
children: ReactNode children: ReactNode
hotReloader?: ReactNode assetPrefix: string
}) { }) {
const initialState = useMemo(() => { const initialState = useMemo(() => {
return { return {
...@@ -361,16 +353,13 @@ export default function AppRouter({ ...@@ -361,16 +353,13 @@ export default function AppRouter({
url: canonicalUrl, url: canonicalUrl,
}} }}
> >
<ErrorOverlay> {HotReloader ? (
{ <HotReloader assetPrefix={assetPrefix}>
// ErrorOverlay intentionally only wraps the children of app-router. {cache.subTreeData}
cache.subTreeData </HotReloader>
} ) : (
</ErrorOverlay> cache.subTreeData
{ )}
// HotReloader uses the router tree and router.reload() in order to apply Server Component changes.
hotReloader
}
</LayoutRouterContext.Provider> </LayoutRouterContext.Provider>
</AppRouterContext.Provider> </AppRouterContext.Provider>
</GlobalLayoutRouterContext.Provider> </GlobalLayoutRouterContext.Provider>
......
'client' import type { ReactNode } from 'react'
import React, {
import {
useCallback, useCallback,
useContext, useContext,
useEffect, useEffect,
...@@ -15,6 +14,7 @@ import { ...@@ -15,6 +14,7 @@ import {
onBuildError, onBuildError,
onBuildOk, onBuildOk,
onRefresh, onRefresh,
ReactDevOverlay,
} from 'next/dist/compiled/@next/react-dev-overlay/dist/client' } from 'next/dist/compiled/@next/react-dev-overlay/dist/client'
import stripAnsi from 'next/dist/compiled/strip-ansi' import stripAnsi from 'next/dist/compiled/strip-ansi'
import formatWebpackMessages from '../dev/error-overlay/format-webpack-messages' import formatWebpackMessages from '../dev/error-overlay/format-webpack-messages'
...@@ -398,7 +398,13 @@ function processMessage( ...@@ -398,7 +398,13 @@ function processMessage(
} }
} }
export default function HotReload({ assetPrefix }: { assetPrefix: string }) { export default function HotReload({
assetPrefix,
children,
}: {
assetPrefix: string
children?: ReactNode
}) {
const { tree } = useContext(GlobalLayoutRouterContext) const { tree } = useContext(GlobalLayoutRouterContext)
const router = useRouter() const router = useRouter()
...@@ -429,7 +435,7 @@ export default function HotReload({ assetPrefix }: { assetPrefix: string }) { ...@@ -429,7 +435,7 @@ export default function HotReload({ assetPrefix }: { assetPrefix: string }) {
} }
const { hostname, port } = window.location const { hostname, port } = window.location
const protocol = getSocketProtocol(assetPrefix || '') const protocol = getSocketProtocol(assetPrefix)
const normalizedAssetPrefix = assetPrefix.replace(/^\/+/, '') const normalizedAssetPrefix = assetPrefix.replace(/^\/+/, '')
let url = `${protocol}://${hostname}:${port}${ let url = `${protocol}://${hostname}:${port}${
...@@ -494,5 +500,6 @@ export default function HotReload({ assetPrefix }: { assetPrefix: string }) { ...@@ -494,5 +500,6 @@ export default function HotReload({ assetPrefix }: { assetPrefix: string }) {
// return () => clearInterval(interval) // return () => clearInterval(interval)
// }) // })
return null
return <ReactDevOverlay globalOverlay>{children}</ReactDevOverlay>
} }
...@@ -810,9 +810,6 @@ export async function renderToHTMLOrFlight( ...@@ -810,9 +810,6 @@ export async function renderToHTMLOrFlight(
ComponentMod.LayoutRouter as typeof import('../client/components/layout-router.client').default ComponentMod.LayoutRouter as typeof import('../client/components/layout-router.client').default
const RenderFromTemplateContext = const RenderFromTemplateContext =
ComponentMod.RenderFromTemplateContext as typeof import('../client/components/render-from-template-context.client').default ComponentMod.RenderFromTemplateContext as typeof import('../client/components/render-from-template-context.client').default
const HotReloader = ComponentMod.HotReloader as
| typeof import('../client/components/hot-reloader.client').default
| null
/** /**
* Server Context is specifically only available in Server Components. * Server Context is specifically only available in Server Components.
...@@ -1373,11 +1370,7 @@ export async function renderToHTMLOrFlight( ...@@ -1373,11 +1370,7 @@ export async function renderToHTMLOrFlight(
return ( return (
<AppRouter <AppRouter
hotReloader={ assetPrefix={renderOpts.assetPrefix || ''}
HotReloader && (
<HotReloader assetPrefix={renderOpts.assetPrefix || ''} />
)
}
initialCanonicalUrl={initialCanonicalUrl} initialCanonicalUrl={initialCanonicalUrl}
initialTree={initialTree} initialTree={initialTree}
> >
......
...@@ -1751,6 +1751,7 @@ export async function ncc_mini_css_extract_plugin(task, opts) { ...@@ -1751,6 +1751,7 @@ export async function ncc_mini_css_extract_plugin(task, opts) {
}) })
.target('compiled/mini-css-extract-plugin') .target('compiled/mini-css-extract-plugin')
} }
// eslint-disable-next-line camelcase // eslint-disable-next-line camelcase
externals['ua-parser-js'] = 'next/dist/compiled/ua-parser-js' externals['ua-parser-js'] = 'next/dist/compiled/ua-parser-js'
export async function ncc_ua_parser_js(task, opts) { export async function ncc_ua_parser_js(task, opts) {
......
...@@ -60,69 +60,68 @@ const shouldPreventDisplay = ( ...@@ -60,69 +60,68 @@ const shouldPreventDisplay = (
return preventType.includes(errorType) return preventType.includes(errorType)
} }
const ReactDevOverlay: React.FunctionComponent = function ReactDevOverlay({ type ReactDevOverlayProps = {
children,
preventDisplay,
globalOverlay,
}: {
children?: React.ReactNode children?: React.ReactNode
preventDisplay?: ErrorType[] preventDisplay?: ErrorType[]
globalOverlay?: boolean globalOverlay?: boolean
}) { }
const [state, dispatch] = React.useReducer<
React.Reducer<OverlayState, Bus.BusEvent>
>(reducer, {
nextId: 1,
buildError: null,
errors: [],
})
React.useEffect(() => { const ReactDevOverlay: React.FunctionComponent<ReactDevOverlayProps> =
Bus.on(dispatch) function ReactDevOverlay({ children, preventDisplay, globalOverlay }) {
return function () { const [state, dispatch] = React.useReducer<
Bus.off(dispatch) React.Reducer<OverlayState, Bus.BusEvent>
} >(reducer, {
}, [dispatch]) nextId: 1,
buildError: null,
errors: [],
})
React.useEffect(() => {
Bus.on(dispatch)
return function () {
Bus.off(dispatch)
}
}, [dispatch])
const onComponentError = React.useCallback( const onComponentError = React.useCallback(
(_error: Error, _componentStack: string | null) => { (_error: Error, _componentStack: string | null) => {
// TODO: special handling // TODO: special handling
}, },
[] []
) )
const hasBuildError = state.buildError != null const hasBuildError = state.buildError != null
const hasRuntimeErrors = Boolean(state.errors.length) const hasRuntimeErrors = Boolean(state.errors.length)
const isMounted = hasBuildError || hasRuntimeErrors const isMounted = hasBuildError || hasRuntimeErrors
return ( return (
<React.Fragment> <React.Fragment>
<ErrorBoundary <ErrorBoundary
globalOverlay={globalOverlay} globalOverlay={globalOverlay}
isMounted={isMounted} isMounted={isMounted}
onError={onComponentError} onError={onComponentError}
> >
{children ?? null} {children ?? null}
</ErrorBoundary> </ErrorBoundary>
{isMounted ? ( {isMounted ? (
<ShadowPortal globalOverlay={globalOverlay}> <ShadowPortal globalOverlay={globalOverlay}>
<CssReset /> <CssReset />
<Base /> <Base />
<ComponentStyles /> <ComponentStyles />
{shouldPreventDisplay( {shouldPreventDisplay(
hasBuildError ? 'build' : hasRuntimeErrors ? 'runtime' : null, hasBuildError ? 'build' : hasRuntimeErrors ? 'runtime' : null,
preventDisplay preventDisplay
) ? null : hasBuildError ? ( ) ? null : hasBuildError ? (
<BuildError message={state.buildError!} /> <BuildError message={state.buildError!} />
) : hasRuntimeErrors ? ( ) : hasRuntimeErrors ? (
<Errors errors={state.errors} /> <Errors errors={state.errors} />
) : undefined} ) : undefined}
</ShadowPortal> </ShadowPortal>
) : undefined} ) : undefined}
</React.Fragment> </React.Fragment>
) )
} }
export default ReactDevOverlay export default ReactDevOverlay
import dataUriToBuffer, { MimeBuffer } from 'data-uri-to-buffer' import dataUriToBuffer, { MimeBuffer } from 'data-uri-to-buffer'
import { RawSourceMap } from 'source-map' import type { RawSourceMap } from 'source-map'
import { getSourceMapUrl } from './getSourceMapUrl' import { getSourceMapUrl } from './getSourceMapUrl'
export function getRawSourceMap(fileContents: string): RawSourceMap | null { export function getRawSourceMap(fileContents: string): RawSourceMap | null {
......
...@@ -2,11 +2,8 @@ import { codeFrameColumns } from '@babel/code-frame' ...@@ -2,11 +2,8 @@ import { codeFrameColumns } from '@babel/code-frame'
import { constants as FS, promises as fs } from 'fs' import { constants as FS, promises as fs } from 'fs'
import { IncomingMessage, ServerResponse } from 'http' import { IncomingMessage, ServerResponse } from 'http'
import path from 'path' import path from 'path'
import { import type { NullableMappedPosition, RawSourceMap } from 'source-map'
NullableMappedPosition, import { SourceMapConsumer } from 'source-map'
RawSourceMap,
SourceMapConsumer,
} from 'source-map'
import { StackFrame } from 'stacktrace-parser' import { StackFrame } from 'stacktrace-parser'
import url from 'url' import url from 'url'
// @ts-ignore // @ts-ignore
......
...@@ -12209,7 +12209,10 @@ packages: ...@@ -12209,7 +12209,10 @@ packages:
dev: true dev: true
/css.escape/1.5.1: /css.escape/1.5.1:
resolution: { integrity: sha1-QuJ9T6BK4y+TGktNQZH6nN3ul8s= } resolution:
{
integrity: sha512-YUifsXXuknHlUsmlgyY0PKzgPOr7/FjCePfHNt0jxm83wHZi44VDMQ7/fGNkjY3/jV1MC+1CmZbaHzugyeRtpg==,
}
dev: false dev: false
/css/3.0.0: /css/3.0.0:
......
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