Unverified Commit f880a7a2 authored by Jiwon Choi's avatar Jiwon Choi Committed by GitHub

Create ErrorOverlay component (#74073)

### Why?

This PR refactored overlay to have a common layout as they share much in common and are also better for testing the layout. Will follow up with `Errors` component as it needs some UI break downs.

Note: patched `@storybook/react` for the type error:
- https://github.com/vercel/next.js/actions/runs/12394130672/job/34596896487#step:8:565
parent 21565ff6
...@@ -278,7 +278,8 @@ ...@@ -278,7 +278,8 @@
"scheduler": "0.25.0-rc-372ec00c-20241209" "scheduler": "0.25.0-rc-372ec00c-20241209"
}, },
"patchedDependencies": { "patchedDependencies": {
"webpack-sources@3.2.3": "patches/webpack-sources@3.2.3.patch" "webpack-sources@3.2.3": "patches/webpack-sources@3.2.3.patch",
"@storybook/react@8.4.7": "patches/@storybook__react@8.4.7.patch"
} }
} }
} }
...@@ -11,8 +11,9 @@ function getAbsolutePath(value: string): any { ...@@ -11,8 +11,9 @@ function getAbsolutePath(value: string): any {
} }
const config: StorybookConfig = { const config: StorybookConfig = {
stories: [ stories: [
'../stories/**/*.mdx', // Could to '../src/**/*.stories.@(ts|tsx)', but not sure how much it'll affect perf.
'../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)', // Scoped to experimental dev overlay for now.
'../src/client/components/react-dev-overlay/_experimental/**/*.stories.@(ts|tsx)',
], ],
addons: [ addons: [
getAbsolutePath('@storybook/addon-webpack5-compiler-swc'), getAbsolutePath('@storybook/addon-webpack5-compiler-swc'),
...@@ -23,7 +24,20 @@ const config: StorybookConfig = { ...@@ -23,7 +24,20 @@ const config: StorybookConfig = {
], ],
framework: { framework: {
name: getAbsolutePath('@storybook/react-webpack5'), name: getAbsolutePath('@storybook/react-webpack5'),
options: {}, options: {
builder: {
useSWC: true,
},
},
}, },
swc: () => ({
jsc: {
transform: {
react: {
runtime: 'automatic',
},
},
},
}),
} }
export default config export default config
import type { Meta, StoryObj } from '@storybook/react'
import { ErrorOverlayLayout } from './ErrorOverlayLayout'
import { withShadowPortal } from '../../storybook/with-shadow-portal'
const meta: Meta<typeof ErrorOverlayLayout> = {
title: 'ErrorOverlayLayout',
component: ErrorOverlayLayout,
parameters: {
layout: 'fullscreen',
},
decorators: [withShadowPortal],
}
export default meta
type Story = StoryObj<typeof ErrorOverlayLayout>
export const Default: Story = {
args: {
errorType: 'Build Error',
errorMessage: 'Failed to compile',
versionInfo: {
installed: '15.0.0',
staleness: 'fresh',
},
children: "Module not found: Cannot find module './missing-module'",
},
}
import type { VersionInfo } from '../../../../../../../server/dev/parse-version-info'
import { Dialog, DialogHeader, DialogBody, DialogContent } from '../Dialog'
import { Overlay } from '../Overlay'
import { VersionStalenessInfo } from '../VersionStalenessInfo'
type ErrorOverlayLayoutProps = {
errorType:
| 'Build Error'
| 'Runtime Error'
| 'Console Error'
| 'Unhandled Runtime Error'
| 'Missing Required HTML Tag'
errorMessage: string | React.ReactNode
onClose: () => void
isBuildError?: boolean
versionInfo?: VersionInfo
children?: React.ReactNode
}
export function ErrorOverlayLayout({
errorType,
errorMessage,
onClose,
children,
versionInfo,
isBuildError,
}: ErrorOverlayLayoutProps) {
return (
<Overlay fixed={isBuildError}>
<Dialog
type="error"
aria-labelledby="nextjs__container_errors_label"
aria-describedby="nextjs__container_errors_desc"
onClose={onClose}
>
<DialogContent>
<DialogHeader className="nextjs-container-errors-header">
<h1
id="nextjs__container_errors_label"
className="nextjs__container_errors_label"
>
{errorType}
</h1>
<VersionStalenessInfo versionInfo={versionInfo} />
<p
id="nextjs__container_errors_desc"
className="nextjs__container_errors_desc"
>
{errorMessage}
</p>
</DialogHeader>
<DialogBody className="nextjs-container-errors-body">
{children}
</DialogBody>
</DialogContent>
</Dialog>
</Overlay>
)
}
import * as React from 'react' import * as React from 'react'
import type { VersionInfo } from '../../../../../../server/dev/parse-version-info' import type { VersionInfo } from '../../../../../../server/dev/parse-version-info'
import {
Dialog,
DialogBody,
DialogContent,
DialogHeader,
} from '../components/Dialog'
import { Overlay } from '../components/Overlay'
import { Terminal } from '../components/Terminal' import { Terminal } from '../components/Terminal'
import { VersionStalenessInfo } from '../components/VersionStalenessInfo'
import { noop as css } from '../helpers/noop-template' import { noop as css } from '../helpers/noop-template'
import { ErrorOverlayLayout } from '../components/ErrorOverlayLayout/ErrorOverlayLayout'
export type BuildErrorProps = { message: string; versionInfo?: VersionInfo } export type BuildErrorProps = { message: string; versionInfo?: VersionInfo }
...@@ -19,43 +12,22 @@ export const BuildError: React.FC<BuildErrorProps> = function BuildError({ ...@@ -19,43 +12,22 @@ export const BuildError: React.FC<BuildErrorProps> = function BuildError({
}) { }) {
const noop = React.useCallback(() => {}, []) const noop = React.useCallback(() => {}, [])
return ( return (
<Overlay fixed> <ErrorOverlayLayout
<Dialog errorType="Build Error"
type="error" errorMessage="Failed to compile"
aria-labelledby="nextjs__container_errors_label" onClose={noop}
aria-describedby="nextjs__container_errors_desc" versionInfo={versionInfo}
onClose={noop} >
> <Terminal content={message} />
<DialogContent> <footer>
<DialogHeader className="nextjs-container-errors-header"> <p id="nextjs__container_build_error_desc">
<h1 <small>
id="nextjs__container_errors_label" This error occurred during the build process and can only be
className="nextjs__container_errors_label" dismissed by fixing the error.
> </small>
{'Build Error'} </p>
</h1> </footer>
<VersionStalenessInfo versionInfo={versionInfo} /> </ErrorOverlayLayout>
<p
id="nextjs__container_errors_desc"
className="nextjs__container_errors_desc"
>
Failed to compile
</p>
</DialogHeader>
<DialogBody className="nextjs-container-errors-body">
<Terminal content={message} />
<footer>
<p id="nextjs__container_build_error_desc">
<small>
This error occurred during the build process and can only be
dismissed by fixing the error.
</small>
</p>
</footer>
</DialogBody>
</DialogContent>
</Dialog>
</Overlay>
) )
} }
......
import * as React from 'react'
import type { VersionInfo } from '../../../../../../server/dev/parse-version-info' import type { VersionInfo } from '../../../../../../server/dev/parse-version-info'
import { Dialog, DialogContent, DialogHeader } from '../components/Dialog' import { useCallback } from 'react'
import { Overlay } from '../components/Overlay'
import { VersionStalenessInfo } from '../components/VersionStalenessInfo'
import { HotlinkedText } from '../components/hot-linked-text' import { HotlinkedText } from '../components/hot-linked-text'
import { ErrorOverlayLayout } from '../components/ErrorOverlayLayout/ErrorOverlayLayout'
type RootLayoutMissingTagsErrorProps = { type RootLayoutMissingTagsErrorProps = {
missingTags: string[] missingTags: string[]
versionInfo?: VersionInfo versionInfo?: VersionInfo
} }
export const RootLayoutMissingTagsError: React.FC<RootLayoutMissingTagsErrorProps> = export function RootLayoutMissingTagsError({
function RootLayoutMissingTagsError({ missingTags, versionInfo }) { missingTags,
const noop = React.useCallback(() => {}, []) versionInfo,
return ( }: RootLayoutMissingTagsErrorProps) {
<Overlay> const noop = useCallback(() => {}, [])
<Dialog return (
type="error" <ErrorOverlayLayout
aria-labelledby="nextjs__container_errors_label" errorType="Missing Required HTML Tag"
aria-describedby="nextjs__container_errors_desc" errorMessage={
onClose={noop} <HotlinkedText
> text={`The following tags are missing in the Root Layout: ${missingTags
<DialogContent> .map((tagName) => `<${tagName}>`)
<DialogHeader className="nextjs-container-errors-header"> .join(
<VersionStalenessInfo versionInfo={versionInfo} /> ', '
<h1 )}.\nRead more at https://nextjs.org/docs/messages/missing-root-layout-tags`}
id="nextjs__container_errors_label" />
className="nextjs__container_errors_label" }
> onClose={noop}
Missing required html tags versionInfo={versionInfo}
</h1> />
<p )
id="nextjs__container_errors_desc" }
className="nextjs__container_errors_desc"
>
<HotlinkedText
text={`The following tags are missing in the Root Layout: ${missingTags
.map((tagName) => `<${tagName}>`)
.join(
', '
)}.\nRead more at https://nextjs.org/docs/messages/missing-root-layout-tags`}
/>
</p>
</DialogHeader>
</DialogContent>
</Dialog>
</Overlay>
)
}
import { Base } from '../styles/Base'
import { CssReset } from '../styles/CssReset'
import { ComponentStyles } from '../styles/ComponentStyles'
import { ShadowPortal } from '../components/ShadowPortal'
export const withShadowPortal = (Story: any) => (
<ShadowPortal>
<CssReset />
<Base />
<ComponentStyles />
<Story />
</ShadowPortal>
)
diff --git a/dist/types-a5624094.d.ts b/dist/types-a5624094.d.ts
index 8e1eb5e94642cb7e943fdb09da96606021701921..9958875a5d2026867455238ec44a71f905d758a4 100644
--- a/dist/types-a5624094.d.ts
+++ b/dist/types-a5624094.d.ts
@@ -1,4 +1,4 @@
-import { ComponentType } from 'react';
+import { ComponentType, JSX } from 'react';
import { WebRenderer, Canvas } from 'storybook/internal/types';
interface ReactRenderer extends WebRenderer {
diff --git a/template/components/index.js b/template/components/index.js
deleted file mode 100644
index c473ab7bed22857c051643fc4f0fce5637793adc..0000000000000000000000000000000000000000
diff --git a/template/stories/docgen-components/imported.js b/template/stories/docgen-components/imported.js
deleted file mode 100644
index bd94145261b03fff811e93a3d8f350a03b7a5105..0000000000000000000000000000000000000000
diff --git a/template/stories/docgen-components/js-proptypes/ext.js b/template/stories/docgen-components/js-proptypes/ext.js
deleted file mode 100644
index 11d0ad4810bb77980bc7be0b7697f3a85b15ffd2..0000000000000000000000000000000000000000
...@@ -22,6 +22,9 @@ overrides: ...@@ -22,6 +22,9 @@ overrides:
scheduler: 0.25.0-rc-372ec00c-20241209 scheduler: 0.25.0-rc-372ec00c-20241209
patchedDependencies: patchedDependencies:
'@storybook/react@8.4.7':
hash: 3vtnbaj5dhujyrhznezprlo624
path: patches/@storybook__react@8.4.7.patch
webpack-sources@3.2.3: webpack-sources@3.2.3:
hash: jbynf5dc46ambamq3wuyho6hkq hash: jbynf5dc46ambamq3wuyho6hkq
path: patches/webpack-sources@3.2.3.patch path: patches/webpack-sources@3.2.3.patch
...@@ -1013,7 +1016,7 @@ importers: ...@@ -1013,7 +1016,7 @@ importers:
version: 8.4.7(react-dom@19.0.0-rc-372ec00c-20241209(react@19.0.0-rc-372ec00c-20241209))(react@19.0.0-rc-372ec00c-20241209)(storybook@8.4.7(prettier@3.3.3)) version: 8.4.7(react-dom@19.0.0-rc-372ec00c-20241209(react@19.0.0-rc-372ec00c-20241209))(react@19.0.0-rc-372ec00c-20241209)(storybook@8.4.7(prettier@3.3.3))
'@storybook/react': '@storybook/react':
specifier: ^8.4.7 specifier: ^8.4.7
version: 8.4.7(@storybook/test@8.4.7(storybook@8.4.7(prettier@3.3.3)))(react-dom@19.0.0-rc-372ec00c-20241209(react@19.0.0-rc-372ec00c-20241209))(react@19.0.0-rc-372ec00c-20241209)(storybook@8.4.7(prettier@3.3.3))(typescript@5.7.2) version: 8.4.7(patch_hash=3vtnbaj5dhujyrhznezprlo624)(@storybook/test@8.4.7(storybook@8.4.7(prettier@3.3.3)))(react-dom@19.0.0-rc-372ec00c-20241209(react@19.0.0-rc-372ec00c-20241209))(react@19.0.0-rc-372ec00c-20241209)(storybook@8.4.7(prettier@3.3.3))(typescript@5.7.2)
'@storybook/react-webpack5': '@storybook/react-webpack5':
specifier: ^8.4.7 specifier: ^8.4.7
version: 8.4.7(@storybook/test@8.4.7(storybook@8.4.7(prettier@3.3.3)))(@swc/core@1.9.3(@swc/helpers@0.5.15))(esbuild@0.23.1)(react-dom@19.0.0-rc-372ec00c-20241209(react@19.0.0-rc-372ec00c-20241209))(react@19.0.0-rc-372ec00c-20241209)(storybook@8.4.7(prettier@3.3.3))(typescript@5.7.2) version: 8.4.7(@storybook/test@8.4.7(storybook@8.4.7(prettier@3.3.3)))(@swc/core@1.9.3(@swc/helpers@0.5.15))(esbuild@0.23.1)(react-dom@19.0.0-rc-372ec00c-20241209(react@19.0.0-rc-372ec00c-20241209))(react@19.0.0-rc-372ec00c-20241209)(storybook@8.4.7(prettier@3.3.3))(typescript@5.7.2)
...@@ -20612,7 +20615,7 @@ snapshots: ...@@ -20612,7 +20615,7 @@ snapshots:
'@storybook/preset-react-webpack@8.4.7(@storybook/test@8.4.7(storybook@8.4.7(prettier@3.3.3)))(@swc/core@1.9.3(@swc/helpers@0.5.15))(esbuild@0.23.1)(react-dom@19.0.0-rc-372ec00c-20241209(react@19.0.0-rc-372ec00c-20241209))(react@19.0.0-rc-372ec00c-20241209)(storybook@8.4.7(prettier@3.3.3))(typescript@5.7.2)': '@storybook/preset-react-webpack@8.4.7(@storybook/test@8.4.7(storybook@8.4.7(prettier@3.3.3)))(@swc/core@1.9.3(@swc/helpers@0.5.15))(esbuild@0.23.1)(react-dom@19.0.0-rc-372ec00c-20241209(react@19.0.0-rc-372ec00c-20241209))(react@19.0.0-rc-372ec00c-20241209)(storybook@8.4.7(prettier@3.3.3))(typescript@5.7.2)':
dependencies: dependencies:
'@storybook/core-webpack': 8.4.7(storybook@8.4.7(prettier@3.3.3)) '@storybook/core-webpack': 8.4.7(storybook@8.4.7(prettier@3.3.3))
'@storybook/react': 8.4.7(@storybook/test@8.4.7(storybook@8.4.7(prettier@3.3.3)))(react-dom@19.0.0-rc-372ec00c-20241209(react@19.0.0-rc-372ec00c-20241209))(react@19.0.0-rc-372ec00c-20241209)(storybook@8.4.7(prettier@3.3.3))(typescript@5.7.2) '@storybook/react': 8.4.7(patch_hash=3vtnbaj5dhujyrhznezprlo624)(@storybook/test@8.4.7(storybook@8.4.7(prettier@3.3.3)))(react-dom@19.0.0-rc-372ec00c-20241209(react@19.0.0-rc-372ec00c-20241209))(react@19.0.0-rc-372ec00c-20241209)(storybook@8.4.7(prettier@3.3.3))(typescript@5.7.2)
'@storybook/react-docgen-typescript-plugin': 1.0.6--canary.9.0c3f3b7.0(typescript@5.7.2)(webpack@5.96.1(@swc/core@1.9.3(@swc/helpers@0.5.15))(esbuild@0.23.1)) '@storybook/react-docgen-typescript-plugin': 1.0.6--canary.9.0c3f3b7.0(typescript@5.7.2)(webpack@5.96.1(@swc/core@1.9.3(@swc/helpers@0.5.15))(esbuild@0.23.1))
'@types/node': 20.17.6 '@types/node': 20.17.6
'@types/semver': 7.5.6 '@types/semver': 7.5.6
...@@ -20664,7 +20667,7 @@ snapshots: ...@@ -20664,7 +20667,7 @@ snapshots:
dependencies: dependencies:
'@storybook/builder-webpack5': 8.4.7(@swc/core@1.9.3(@swc/helpers@0.5.15))(esbuild@0.23.1)(storybook@8.4.7(prettier@3.3.3))(typescript@5.7.2) '@storybook/builder-webpack5': 8.4.7(@swc/core@1.9.3(@swc/helpers@0.5.15))(esbuild@0.23.1)(storybook@8.4.7(prettier@3.3.3))(typescript@5.7.2)
'@storybook/preset-react-webpack': 8.4.7(@storybook/test@8.4.7(storybook@8.4.7(prettier@3.3.3)))(@swc/core@1.9.3(@swc/helpers@0.5.15))(esbuild@0.23.1)(react-dom@19.0.0-rc-372ec00c-20241209(react@19.0.0-rc-372ec00c-20241209))(react@19.0.0-rc-372ec00c-20241209)(storybook@8.4.7(prettier@3.3.3))(typescript@5.7.2) '@storybook/preset-react-webpack': 8.4.7(@storybook/test@8.4.7(storybook@8.4.7(prettier@3.3.3)))(@swc/core@1.9.3(@swc/helpers@0.5.15))(esbuild@0.23.1)(react-dom@19.0.0-rc-372ec00c-20241209(react@19.0.0-rc-372ec00c-20241209))(react@19.0.0-rc-372ec00c-20241209)(storybook@8.4.7(prettier@3.3.3))(typescript@5.7.2)
'@storybook/react': 8.4.7(@storybook/test@8.4.7(storybook@8.4.7(prettier@3.3.3)))(react-dom@19.0.0-rc-372ec00c-20241209(react@19.0.0-rc-372ec00c-20241209))(react@19.0.0-rc-372ec00c-20241209)(storybook@8.4.7(prettier@3.3.3))(typescript@5.7.2) '@storybook/react': 8.4.7(patch_hash=3vtnbaj5dhujyrhznezprlo624)(@storybook/test@8.4.7(storybook@8.4.7(prettier@3.3.3)))(react-dom@19.0.0-rc-372ec00c-20241209(react@19.0.0-rc-372ec00c-20241209))(react@19.0.0-rc-372ec00c-20241209)(storybook@8.4.7(prettier@3.3.3))(typescript@5.7.2)
'@types/node': 20.17.6 '@types/node': 20.17.6
react: 19.0.0-rc-372ec00c-20241209 react: 19.0.0-rc-372ec00c-20241209
react-dom: 19.0.0-rc-372ec00c-20241209(react@19.0.0-rc-372ec00c-20241209) react-dom: 19.0.0-rc-372ec00c-20241209(react@19.0.0-rc-372ec00c-20241209)
...@@ -20680,7 +20683,7 @@ snapshots: ...@@ -20680,7 +20683,7 @@ snapshots:
- uglify-js - uglify-js
- webpack-cli - webpack-cli
'@storybook/react@8.4.7(@storybook/test@8.4.7(storybook@8.4.7(prettier@3.3.3)))(react-dom@19.0.0-rc-372ec00c-20241209(react@19.0.0-rc-372ec00c-20241209))(react@19.0.0-rc-372ec00c-20241209)(storybook@8.4.7(prettier@3.3.3))(typescript@5.7.2)': '@storybook/react@8.4.7(patch_hash=3vtnbaj5dhujyrhznezprlo624)(@storybook/test@8.4.7(storybook@8.4.7(prettier@3.3.3)))(react-dom@19.0.0-rc-372ec00c-20241209(react@19.0.0-rc-372ec00c-20241209))(react@19.0.0-rc-372ec00c-20241209)(storybook@8.4.7(prettier@3.3.3))(typescript@5.7.2)':
dependencies: dependencies:
'@storybook/components': 8.4.7(storybook@8.4.7(prettier@3.3.3)) '@storybook/components': 8.4.7(storybook@8.4.7(prettier@3.3.3))
'@storybook/global': 5.0.0 '@storybook/global': 5.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