986ba078a6
Unit and integration tests have been failing due to failed logging of `Error` objects. These were creating an issue where `mocha` was not properly returning right exit codes, leading to test pipelines incorrectly passing despite test failures. - Fix runtime behavior of failing to retrieve error stacks. - Add tests for error handling. - Add more robust custom error handling. Related issues: babel/babel#14273, vuejs/vue-cli#6994.
51 lines
1.8 KiB
TypeScript
51 lines
1.8 KiB
TypeScript
/*
|
|
Provides a unified and resilient way to extend errors across platforms.
|
|
|
|
Rationale:
|
|
- Babel:
|
|
> "Built-in classes cannot be properly subclassed due to limitations in ES5"
|
|
> https://web.archive.org/web/20230810014108/https://babeljs.io/docs/caveats#classes
|
|
- TypeScript:
|
|
> "Extending built-ins like Error, Array, and Map may no longer work"
|
|
> https://web.archive.org/web/20230810014143/https://github.com/Microsoft/TypeScript-wiki/blob/main/Breaking-Changes.md#extending-built-ins-like-error-array-and-map-may-no-longer-work
|
|
*/
|
|
export abstract class CustomError extends Error {
|
|
constructor(message?: string, options?: ErrorOptions) {
|
|
super(message, options);
|
|
|
|
fixPrototype(this, new.target.prototype);
|
|
ensureStackTrace(this);
|
|
|
|
this.name = this.constructor.name;
|
|
}
|
|
}
|
|
|
|
export const Environment = {
|
|
getSetPrototypeOf: () => Object.setPrototypeOf,
|
|
getCaptureStackTrace: () => Error.captureStackTrace,
|
|
};
|
|
|
|
function fixPrototype(target: Error, prototype: CustomError) {
|
|
// https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
|
|
const setPrototypeOf = Environment.getSetPrototypeOf();
|
|
if (!functionExists(setPrototypeOf)) {
|
|
return;
|
|
}
|
|
setPrototypeOf(target, prototype);
|
|
}
|
|
|
|
function ensureStackTrace(target: Error) {
|
|
const captureStackTrace = Environment.getCaptureStackTrace();
|
|
if (!functionExists(captureStackTrace)) {
|
|
// captureStackTrace is only available on V8, if it's not available
|
|
// modern JS engines will usually generate a stack trace on error objects when they're thrown.
|
|
return;
|
|
}
|
|
captureStackTrace(target, target.constructor);
|
|
}
|
|
|
|
function functionExists(func: unknown): boolean {
|
|
// Not doing truthy/falsy check i.e. if(func) as most values are truthy in JS for robustness
|
|
return typeof func === 'function';
|
|
}
|