Unverified Commit 0383d0be authored by Jiwon Choi's avatar Jiwon Choi Committed by GitHub

[DevOverlay] Display Correct Number of Errors on Indicator (#75395)

### Why?

The indicator has displayed only the number of Runtime errors.

### How?

If there is a build error or a missing HTML tag error, display the length of the errors as they need to be resolved before the runtime errors.

### Before

![CleanShot 2025-01-28 at 21 42 51](https://github.com/user-attachments/assets/dcbb284a-023f-4853-ac4a-64603a80a2be)

### After

![CleanShot 2025-01-28 at 21 42 33](https://github.com/user-attachments/assets/0adeda65-205a-497e-90ac-f41d3a1ab5c8)

Closes NDX-691
parent 2950dae1
...@@ -22,7 +22,10 @@ export default function ReactDevOverlay({ ...@@ -22,7 +22,10 @@ export default function ReactDevOverlay({
children: React.ReactNode children: React.ReactNode
}) { }) {
const [isErrorOverlayOpen, setIsErrorOverlayOpen] = useState(false) const [isErrorOverlayOpen, setIsErrorOverlayOpen] = useState(false)
const { readyErrors } = useErrorHook({ errors: state.errors, isAppDir: true }) const { readyErrors, totalErrorCount } = useErrorHook({
state,
isAppDir: true,
})
const devOverlay = ( const devOverlay = (
<ShadowPortal> <ShadowPortal>
...@@ -33,7 +36,7 @@ export default function ReactDevOverlay({ ...@@ -33,7 +36,7 @@ export default function ReactDevOverlay({
<DevToolsIndicator <DevToolsIndicator
state={state} state={state}
readyErrorsLength={readyErrors.length} errorCount={totalErrorCount}
setIsErrorOverlayOpen={setIsErrorOverlayOpen} setIsErrorOverlayOpen={setIsErrorOverlayOpen}
/> />
......
...@@ -57,7 +57,7 @@ const state: OverlayState = { ...@@ -57,7 +57,7 @@ const state: OverlayState = {
export const NoErrors: Story = { export const NoErrors: Story = {
args: { args: {
readyErrorsLength: 0, errorCount: 0,
state, state,
setIsErrorOverlayOpen: () => {}, setIsErrorOverlayOpen: () => {},
}, },
...@@ -65,7 +65,7 @@ export const NoErrors: Story = { ...@@ -65,7 +65,7 @@ export const NoErrors: Story = {
export const SingleError: Story = { export const SingleError: Story = {
args: { args: {
readyErrorsLength: 1, errorCount: 1,
state, state,
setIsErrorOverlayOpen: () => {}, setIsErrorOverlayOpen: () => {},
}, },
...@@ -73,7 +73,7 @@ export const SingleError: Story = { ...@@ -73,7 +73,7 @@ export const SingleError: Story = {
export const MultipleErrors: Story = { export const MultipleErrors: Story = {
args: { args: {
readyErrorsLength: 3, errorCount: 3,
state, state,
setIsErrorOverlayOpen: () => {}, setIsErrorOverlayOpen: () => {},
}, },
...@@ -81,7 +81,7 @@ export const MultipleErrors: Story = { ...@@ -81,7 +81,7 @@ export const MultipleErrors: Story = {
export const WithStaticIndicator: Story = { export const WithStaticIndicator: Story = {
args: { args: {
readyErrorsLength: 3, errorCount: 3,
state: { state: {
...state, ...state,
staticIndicator: true, staticIndicator: true,
......
...@@ -14,11 +14,11 @@ import { MODIFIERS } from '../../../hooks/use-keyboard-shortcut' ...@@ -14,11 +14,11 @@ import { MODIFIERS } from '../../../hooks/use-keyboard-shortcut'
export function DevToolsIndicator({ export function DevToolsIndicator({
state, state,
readyErrorsLength, errorCount,
setIsErrorOverlayOpen, setIsErrorOverlayOpen,
}: { }: {
state: OverlayState state: OverlayState
readyErrorsLength: number errorCount: number
setIsErrorOverlayOpen: Dispatch<SetStateAction<boolean>> setIsErrorOverlayOpen: Dispatch<SetStateAction<boolean>>
}) { }) {
const [isDevToolsIndicatorOpen, setIsDevToolsIndicatorOpen] = useState(true) const [isDevToolsIndicatorOpen, setIsDevToolsIndicatorOpen] = useState(true)
...@@ -36,7 +36,7 @@ export function DevToolsIndicator({ ...@@ -36,7 +36,7 @@ export function DevToolsIndicator({
isDevToolsIndicatorOpen && ( isDevToolsIndicatorOpen && (
<DevToolsPopover <DevToolsPopover
semver={state.versionInfo.installed} semver={state.versionInfo.installed}
issueCount={readyErrorsLength} issueCount={errorCount}
isStaticRoute={state.staticIndicator} isStaticRoute={state.staticIndicator}
hide={() => { hide={() => {
setIsDevToolsIndicatorOpen(false) setIsDevToolsIndicatorOpen(false)
......
import type { ReadyRuntimeError } from '../../helpers/get-error-by-type' import type { ReadyRuntimeError } from '../../helpers/get-error-by-type'
import type { import type {
OverlayState,
UnhandledErrorAction, UnhandledErrorAction,
UnhandledRejectionAction, UnhandledRejectionAction,
} from '../../../../shared' } from '../../../../shared'
...@@ -33,12 +34,14 @@ function getErrorSignature(ev: SupportedErrorEvent): string { ...@@ -33,12 +34,14 @@ function getErrorSignature(ev: SupportedErrorEvent): string {
} }
export function useErrorHook({ export function useErrorHook({
errors, state,
isAppDir, isAppDir,
}: { }: {
errors: SupportedErrorEvent[] state: OverlayState
isAppDir: boolean isAppDir: boolean
}) { }) {
const { errors, rootLayoutMissingTags, buildError } = state
const [lookups, setLookups] = useState<{ const [lookups, setLookups] = useState<{
[eventId: string]: ReadyRuntimeError [eventId: string]: ReadyRuntimeError
}>({}) }>({})
...@@ -99,5 +102,14 @@ export function useErrorHook({ ...@@ -99,5 +102,14 @@ export function useErrorHook({
return { return {
readyErrors, readyErrors,
// Total number of errors are based on the priority that
// will be displayed. Since build error and root layout
// missing tags won't be dismissed until resolved, the
// total number of errors may be fixed to their length.
totalErrorCount: rootLayoutMissingTags?.length
? rootLayoutMissingTags.length
: !!buildError
? 1
: errors.length,
} }
} }
...@@ -28,8 +28,8 @@ export default function ReactDevOverlay({ children }: ReactDevOverlayProps) { ...@@ -28,8 +28,8 @@ export default function ReactDevOverlay({ children }: ReactDevOverlayProps) {
hasBuildError, hasBuildError,
} = usePagesReactDevOverlay() } = usePagesReactDevOverlay()
const { readyErrors } = useErrorHook({ const { readyErrors, totalErrorCount } = useErrorHook({
errors: state.errors, state,
isAppDir: false, isAppDir: false,
}) })
...@@ -50,7 +50,7 @@ export default function ReactDevOverlay({ children }: ReactDevOverlayProps) { ...@@ -50,7 +50,7 @@ export default function ReactDevOverlay({ children }: ReactDevOverlayProps) {
<DevToolsIndicator <DevToolsIndicator
state={state} state={state}
readyErrorsLength={readyErrors.length} errorCount={totalErrorCount}
setIsErrorOverlayOpen={setIsErrorOverlayOpen} setIsErrorOverlayOpen={setIsErrorOverlayOpen}
/> />
......
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