Preserve plain-object rejection reasons in global error handlers #181
+334
−85
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| import Sanitizer from '../modules/sanitizer'; | ||
|
|
||
| /** | ||
| * Represents a captured error in a normalized form. | ||
| * | ||
| * Motivation: | ||
| * - `Error | string` is unclear and hard to work with. | ||
| * - Fields can be filled from an event or from the error itself. | ||
| */ | ||
| export type CapturedError = { | ||
| /** Human-readable error message used as a title in the dashboard */ | ||
| title: string; | ||
| /** Error type (e.g. 'TypeError', 'NetworkError'), or null if unknown */ | ||
| type: string | null; | ||
| /** The original (unsanitized) value — use for instanceof checks and backtrace parsing only */ | ||
| rawError: unknown; | ||
| }; | ||
|
|
||
| /** | ||
| * Extracts a human-readable title from an unknown sanitized error. | ||
| * Prefers `.message` on objects, falls back to the value itself for strings, | ||
| * and serializes everything else. | ||
| * | ||
| * @param safeError - Sanitized error value (any shape) | ||
|
FeironoX5 marked this conversation as resolved.
Outdated
|
||
| * @returns A non-empty string title, or undefined if the value is nullish or empty | ||
| */ | ||
| function getTitleFromError(safeError: unknown): string | undefined { | ||
| if (safeError == null) { | ||
| return undefined; | ||
| } | ||
|
|
||
| const message = | ||
| typeof safeError === 'object' && 'message' in safeError ? (safeError as Error).message : safeError; | ||
|
|
||
| if (typeof message === 'string') { | ||
| return message || undefined; | ||
| } | ||
|
|
||
| try { | ||
| return JSON.stringify(message); | ||
| } catch { | ||
| // If no JSON global is available, fall back to string conversion | ||
| return String(message); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Extracts an error type name from an unknown sanitized error. | ||
| * Returns `.name` only when it is a non-empty string (e.g. 'TypeError'). | ||
| * | ||
| * @param safeError - Sanitized error value (any shape) | ||
| * @returns The error name string, or undefined if absent or empty | ||
| */ | ||
| function getTypeFromError(safeError: unknown): string | undefined { | ||
| const name = (safeError as Error)?.name; | ||
|
|
||
| return name || undefined; | ||
| } | ||
|
|
||
| /** | ||
| * Constructs a CapturedError from an unknown error value and optional fallbacks. | ||
| * | ||
| * @param error - Any value thrown or rejected | ||
| * @param fallbackValues - Fallback values from event if they can't be extracted from the error | ||
| * @returns A normalized `CapturedError` object | ||
| */ | ||
| export function fillCapturedError( | ||
|
FeironoX5 marked this conversation as resolved.
Outdated
|
||
| error: unknown, | ||
| fallbackValues: { title?: string; type?: string } = {} | ||
| ): CapturedError { | ||
| const sanitizedError = Sanitizer.sanitize(error); | ||
|
|
||
| return { | ||
| title: getTitleFromError(sanitizedError) || fallbackValues.title || '<unknown error>', | ||
| type: getTypeFromError(sanitizedError) || fallbackValues.type || null, | ||
| rawError: error, | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Extracts and normalizes error from ErrorEvent or PromiseRejectionEvent. | ||
| * Handles CORS-restricted errors (where event.error is undefined) by falling back to event.message. | ||
| * | ||
| * @param event - The error or promise rejection event | ||
| * @returns A normalized CapturedError object | ||
| */ | ||
| export function getErrorFromErrorEvent(event: ErrorEvent | PromiseRejectionEvent): CapturedError { | ||
| if (event.type === 'error') { | ||
| event = event as ErrorEvent; | ||
|
Member
There was a problem hiding this comment. I know that it's no-op, but const errorEvent = event as ErrorEvent;
return {
rawError: errorEvent.error,
fallbackTitle: ...,
};Same for |
||
|
|
||
| return fillCapturedError(event.error, { | ||
| title: event.message && `'${event.message}' at ${event.filename || '<unknown file>'}:${event.lineno}:${event.colno}`, | ||
|
neSpecc marked this conversation as resolved.
Outdated
|
||
| }); | ||
| } | ||
|
|
||
| if (event.type === 'unhandledrejection') { | ||
|
FeironoX5 marked this conversation as resolved.
|
||
| event = event as PromiseRejectionEvent; | ||
|
|
||
| return fillCapturedError(event.reason, { | ||
| type: 'UnhandledRejection', | ||
| }); | ||
| } | ||
|
|
||
| return fillCapturedError(undefined); | ||
|
FeironoX5 marked this conversation as resolved.
Outdated
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't we use here
const typefrom 202 line?