Unverified Commit 0d81c3c6 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Fix presentation when onerror receives an event without error (#74643)

parent a0eab62e
import { useEffect } from 'react'
import { attachHydrationErrorState } from './attach-hydration-error-state'
import { isNextRouterError } from '../../../../is-next-router-error'
import { storeHydrationErrorStateFromConsoleArgs } from './hydration-error-info'
import { formatConsoleArgs } from '../../../../../lib/console'
import isError from '../../../../../../lib/is-error'
import { createUnhandledError } from './console-error'
import { enqueueConsecutiveDedupedError } from './enqueue-client-error'
import { getReactStitchedError } from './stitched-error'
const queueMicroTask =
globalThis.queueMicrotask || ((cb: () => void) => Promise.resolve().then(cb))
export type ErrorHandler = (error: Error) => void
const errorQueue: Array<Error> = []
const errorHandlers: Array<ErrorHandler> = []
const rejectionQueue: Array<Error> = []
const rejectionHandlers: Array<ErrorHandler> = []
export function handleClientError(
originError: unknown,
consoleErrorArgs: any[],
capturedFromConsole: boolean = false
) {
let error: Error
if (!originError || !isError(originError)) {
// If it's not an error, format the args into an error
const formattedErrorMessage = formatConsoleArgs(consoleErrorArgs)
error = createUnhandledError(formattedErrorMessage)
} else {
error = capturedFromConsole
? createUnhandledError(originError)
: originError
}
error = getReactStitchedError(error)
storeHydrationErrorStateFromConsoleArgs(...consoleErrorArgs)
attachHydrationErrorState(error)
enqueueConsecutiveDedupedError(errorQueue, error)
for (const handler of errorHandlers) {
// Delayed the error being passed to React Dev Overlay,
// avoid the state being synchronously updated in the component.
queueMicroTask(() => {
handler(error)
})
}
}
export function useErrorHandler(
handleOnUnhandledError: ErrorHandler,
handleOnUnhandledRejection: ErrorHandler
) {
useEffect(() => {
// Handle queued errors.
errorQueue.forEach(handleOnUnhandledError)
rejectionQueue.forEach(handleOnUnhandledRejection)
// Listen to new errors.
errorHandlers.push(handleOnUnhandledError)
rejectionHandlers.push(handleOnUnhandledRejection)
return () => {
// Remove listeners.
errorHandlers.splice(errorHandlers.indexOf(handleOnUnhandledError), 1)
rejectionHandlers.splice(
rejectionHandlers.indexOf(handleOnUnhandledRejection),
1
)
}
}, [handleOnUnhandledError, handleOnUnhandledRejection])
}
function onUnhandledError(event: WindowEventMap['error']): void | boolean {
if (isNextRouterError(event.error)) {
event.preventDefault()
return false
}
handleClientError(event.error, [])
}
function onUnhandledRejection(ev: WindowEventMap['unhandledrejection']): void {
const reason = ev?.reason
if (isNextRouterError(reason)) {
ev.preventDefault()
return
}
let error = reason
if (error && !isError(error)) {
error = createUnhandledError(error + '')
}
rejectionQueue.push(error)
for (const handler of rejectionHandlers) {
handler(error)
}
}
export function handleGlobalErrors() {
if (typeof window !== 'undefined') {
try {
// Increase the number of stack frames on the client
Error.stackTraceLimit = 50
} catch {}
window.addEventListener('error', onUnhandledError)
window.addEventListener('unhandledrejection', onUnhandledRejection)
}
}
...@@ -77,7 +77,11 @@ function onUnhandledError(event: WindowEventMap['error']): void | boolean { ...@@ -77,7 +77,11 @@ function onUnhandledError(event: WindowEventMap['error']): void | boolean {
event.preventDefault() event.preventDefault()
return false return false
} }
handleClientError(event.error, []) // When there's an error property present, we log the error to error overlay.
// Otherwise we don't do anything as it's not logging in the console either.
if (event.error) {
handleClientError(event.error, [])
}
} }
function onUnhandledRejection(ev: WindowEventMap['unhandledrejection']): void { function onUnhandledRejection(ev: WindowEventMap['unhandledrejection']): void {
......
'use client'
export default function Page() {
return (
<button
onClick={() => {
// Create an ErrorEvent with only a message
const errorEvent = new ErrorEvent('error', {
message: 'dummy error message', // Message for the event
// Omit the `error` property to ensure it is not included
})
// Dispatch the event
window.dispatchEvent(errorEvent)
}}
>
click to trigger error event
</button>
)
}
...@@ -7,6 +7,8 @@ import { ...@@ -7,6 +7,8 @@ import {
getRedboxTotalErrorCount, getRedboxTotalErrorCount,
openRedbox, openRedbox,
hasRedboxCallStack, hasRedboxCallStack,
assertNoRedbox,
assertNoConsoleErrors,
} from 'next-test-utils' } from 'next-test-utils'
async function getRedboxResult(browser: any) { async function getRedboxResult(browser: any) {
...@@ -315,4 +317,12 @@ describe('app-dir - capture-console-error', () => { ...@@ -315,4 +317,12 @@ describe('app-dir - capture-console-error', () => {
`) `)
} }
}) })
it('should display the error message in error event when event.error is not present', async () => {
const browser = await next.browser('/browser/error-event')
await browser.elementByCss('button').click()
await assertNoRedbox(browser)
await assertNoConsoleErrors(browser)
})
}) })
...@@ -1545,3 +1545,18 @@ export function createNowRouteMatches( ...@@ -1545,3 +1545,18 @@ export function createNowRouteMatches(
return urlSearchParams return urlSearchParams
} }
export async function assertNoConsoleErrors(browser: BrowserInterface) {
const logs = await browser.log()
const warningsAndErrors = logs.filter((log) => {
return (
log.source === 'warning' ||
(log.source === 'error' &&
// These are expected when we visit 404 pages.
log.message !==
'Failed to load resource: the server responded with a status of 404 (Not Found)')
)
})
expect(warningsAndErrors).toEqual([])
}
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