warren/jasmine
1
0
Fork 0
Code Issues Pull Requests Actions 9 Packages Projects Releases Wiki Activity

Convert GlobalErrors to an ES6 class

Browse Source
This commit is contained in:
Steve Gravrock
2025-07-11 06:49:09 -07:00
parent adfbd00c75
commit d53d2ff3eb
3 changed files with 359 additions and 275 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
eslint.config.mjs
View File

@@ -22,7 +22,9 @@ export default defineConfig([{
...globals.node, ...globals.node,
}, },
ecmaVersion: 2018, // 2022 isn't exactly right, but it's the earliest version that allows
// private properties.
ecmaVersion: 2022,
sourceType: "commonjs", sourceType: "commonjs",
}, },

315
lib/jasmine-core/jasmine.js
View File

@@ -4302,135 +4302,71 @@ getJasmineRequireObj().formatErrorMsg = function() {
}; };
getJasmineRequireObj().GlobalErrors = function(j$) { getJasmineRequireObj().GlobalErrors = function(j$) {
function GlobalErrors(global) { class GlobalErrors {
global = global || j$.getGlobal(); #global;
#handlers;
#originalHandlers;
#jasmineHandlers;
#overrideHandler;
#onRemoveOverrideHandler;
#onBrowserError;
#onBrowserRejection;
#onNodeError;
#onNodeRejection;
const handlers = []; constructor(global) {
let overrideHandler = null, this.#global = global || j$.getGlobal();
onRemoveOverrideHandler = null;
function onBrowserError(event) { this.#handlers = [];
dispatchBrowserError(event.error, event); this.#overrideHandler = null;
this.#onRemoveOverrideHandler = null;
this.#onBrowserError = event =>
this._dispatchBrowserError(event.error, event);
this.#onBrowserRejection = event => this._browserRejectionHandler(event);
this.#onNodeError = error =>
this._handleNodeEvent(error, 'uncaughtException', 'Uncaught exception');
this.#onNodeRejection = error =>
this._handleNodeEvent(
error,
'unhandledRejection',
'Unhandled promise rejection'
);
this.#originalHandlers = {};
this.#jasmineHandlers = {};
} }
function dispatchBrowserError(error, event) { install() {
if (overrideHandler) {
// See discussion of spyOnGlobalErrorsAsync in base.js
overrideHandler(error);
return;
}
const handler = handlers[handlers.length - 1];
if (handler) {
handler(error, event);
} else {
throw error;
}
}
this.originalHandlers = {};
this.jasmineHandlers = {};
this.installOne_ = function installOne_(errorType, jasmineMessage) {
function taggedOnError(error) {
if (j$.isError_(error)) {
error.jasmineMessage = jasmineMessage + ': ' + error;
} else {
let substituteMsg;
if (error) {
substituteMsg = jasmineMessage + ': ' + error;
} else {
substituteMsg = jasmineMessage + ' with no error or message';
}
if (errorType === 'unhandledRejection') {
substituteMsg +=
'\n' +
'(Tip: to get a useful stack trace, use ' +
'Promise.reject(new Error(...)) instead of Promise.reject(' +
(error ? '...' : '') +
').)';
}
error = new Error(substituteMsg);
}
const handler = handlers[handlers.length - 1];
if (overrideHandler) {
// See discussion of spyOnGlobalErrorsAsync in base.js
overrideHandler(error);
return;
}
if (handler) {
handler(error);
} else {
throw error;
}
}
this.originalHandlers[errorType] = global.process.listeners(errorType);
this.jasmineHandlers[errorType] = taggedOnError;
global.process.removeAllListeners(errorType);
global.process.on(errorType, taggedOnError);
this.uninstall = function uninstall() {
const errorTypes = Object.keys(this.originalHandlers);
for (const errorType of errorTypes) {
global.process.removeListener(
errorType,
this.jasmineHandlers[errorType]
);
for (let i = 0; i < this.originalHandlers[errorType].length; i++) {
global.process.on(errorType, this.originalHandlers[errorType][i]);
}
delete this.originalHandlers[errorType];
delete this.jasmineHandlers[errorType];
}
};
};
this.install = function install() {
if ( if (
global.process && this.#global.process &&
global.process.listeners && this.#global.process.listeners &&
j$.isFunction_(global.process.on) j$.isFunction_(this.#global.process.on)
) { ) {
this.installOne_('uncaughtException', 'Uncaught exception'); this._installNodeHandler('uncaughtException', this.#onNodeError);
this.installOne_('unhandledRejection', 'Unhandled promise rejection'); this._installNodeHandler('unhandledRejection', this.#onNodeRejection);
} else { } else {
global.addEventListener('error', onBrowserError); this.#global.addEventListener('error', this.#onBrowserError);
const browserRejectionHandler = function browserRejectionHandler( this.#global.addEventListener(
event 'unhandledrejection',
) { this.#onBrowserRejection
if (j$.isError_(event.reason)) { );
event.reason.jasmineMessage =
'Unhandled promise rejection: ' + event.reason;
dispatchBrowserError(event.reason, event);
} else {
dispatchBrowserError(
'Unhandled promise rejection: ' + event.reason,
event
);
}
};
global.addEventListener('unhandledrejection', browserRejectionHandler);
this.uninstall = function uninstall() {
global.removeEventListener('error', onBrowserError);
global.removeEventListener(
'unhandledrejection',
browserRejectionHandler
);
};
} }
}; }
uninstall() {
if (
this.#global.process &&
this.#global.process.listeners &&
j$.isFunction_(this.#global.process.on)
) {
this._nodeUninstall();
} else {
this._browserUninstall();
}
}
// The listener at the top of the stack will be called with two arguments: // The listener at the top of the stack will be called with two arguments:
// the error and the event. Either of them may be falsy. // the error and the event. Either of them may be falsy.
@@ -4439,35 +4375,140 @@ getJasmineRequireObj().GlobalErrors = function(j$) {
// browsers but will be falsy in Node. // browsers but will be falsy in Node.
// Listeners that are pushed after spec files have been loaded should be // Listeners that are pushed after spec files have been loaded should be
// able to just use the error parameter. // able to just use the error parameter.
this.pushListener = function pushListener(listener) { pushListener(listener) {
handlers.push(listener); this.#handlers.push(listener);
}; }
this.popListener = function popListener(listener) { popListener(listener) {
if (!listener) { if (!listener) {
throw new Error('popListener expects a listener'); throw new Error('popListener expects a listener');
} }
handlers.pop(); this.#handlers.pop();
}; }
this.setOverrideListener = function(listener, onRemove) { setOverrideListener(listener, onRemove) {
if (overrideHandler) { if (this.#overrideHandler) {
throw new Error("Can't set more than one override listener at a time"); throw new Error("Can't set more than one override listener at a time");
} }
overrideHandler = listener; this.#overrideHandler = listener;
onRemoveOverrideHandler = onRemove; this.#onRemoveOverrideHandler = onRemove;
}; }
this.removeOverrideListener = function() { removeOverrideListener() {
if (onRemoveOverrideHandler) { if (this.#onRemoveOverrideHandler) {
onRemoveOverrideHandler(); this.#onRemoveOverrideHandler();
} }
overrideHandler = null; this.#overrideHandler = null;
onRemoveOverrideHandler = null; this.#onRemoveOverrideHandler = null;
}; }
_nodeUninstall() {
const errorTypes = Object.keys(this.#originalHandlers);
for (const errorType of errorTypes) {
this.#global.process.removeListener(
errorType,
this.#jasmineHandlers[errorType]
);
for (let i = 0; i < this.#originalHandlers[errorType].length; i++) {
this.#global.process.on(
errorType,
this.#originalHandlers[errorType][i]
);
}
delete this.#originalHandlers[errorType];
delete this.#jasmineHandlers[errorType];
}
}
_browserUninstall() {
this.#global.removeEventListener('error', this.#onBrowserError);
this.#global.removeEventListener(
'unhandledrejection',
this.#onBrowserRejection
);
}
_dispatchBrowserError(error, event) {
if (this.#overrideHandler) {
// See discussion of spyOnGlobalErrorsAsync in base.js
this.#overrideHandler(error);
return;
}
const handler = this.#handlers[this.#handlers.length - 1];
if (handler) {
handler(error, event);
} else {
throw error;
}
}
_browserRejectionHandler(event) {
if (j$.isError_(event.reason)) {
event.reason.jasmineMessage =
'Unhandled promise rejection: ' + event.reason;
this._dispatchBrowserError(event.reason, event);
} else {
this._dispatchBrowserError(
'Unhandled promise rejection: ' + event.reason,
event
);
}
}
_installNodeHandler(errorType, handler) {
this.#originalHandlers[errorType] = this.#global.process.listeners(
errorType
);
this.#jasmineHandlers[errorType] = handler;
this.#global.process.removeAllListeners(errorType);
this.#global.process.on(errorType, handler);
}
_handleNodeEvent(error, errorType, jasmineMessage) {
if (j$.isError_(error)) {
error.jasmineMessage = jasmineMessage + ': ' + error;
} else {
let substituteMsg;
if (error) {
substituteMsg = jasmineMessage + ': ' + error;
} else {
substituteMsg = jasmineMessage + ' with no error or message';
}
if (errorType === 'unhandledRejection') {
substituteMsg +=
'\n' +
'(Tip: to get a useful stack trace, use ' +
'Promise.reject(new Error(...)) instead of Promise.reject(' +
(error ? '...' : '') +
').)';
}
error = new Error(substituteMsg);
}
const handler = this.#handlers[this.#handlers.length - 1];
if (this.#overrideHandler) {
// See discussion of spyOnGlobalErrorsAsync in base.js
this.#overrideHandler(error);
return;
}
if (handler) {
handler(error);
} else {
throw error;
}
}
} }
return GlobalErrors; return GlobalErrors;

315
src/core/GlobalErrors.js
View File

@@ -1,133 +1,69 @@
getJasmineRequireObj().GlobalErrors = function(j$) { getJasmineRequireObj().GlobalErrors = function(j$) {
function GlobalErrors(global) { class GlobalErrors {
global = global || j$.getGlobal(); #global;
#handlers;
#originalHandlers;
#jasmineHandlers;
#overrideHandler;
#onRemoveOverrideHandler;
#onBrowserError;
#onBrowserRejection;
#onNodeError;
#onNodeRejection;
const handlers = []; constructor(global) {
let overrideHandler = null, this.#global = global || j$.getGlobal();
onRemoveOverrideHandler = null;
function onBrowserError(event) { this.#handlers = [];
dispatchBrowserError(event.error, event); this.#overrideHandler = null;
this.#onRemoveOverrideHandler = null;
this.#onBrowserError = event =>
this.#dispatchBrowserError(event.error, event);
this.#onBrowserRejection = event => this.#browserRejectionHandler(event);
this.#onNodeError = error =>
this.#handleNodeEvent(error, 'uncaughtException', 'Uncaught exception');
this.#onNodeRejection = error =>
this.#handleNodeEvent(
error,
'unhandledRejection',
'Unhandled promise rejection'
);
this.#originalHandlers = {};
this.#jasmineHandlers = {};
} }
function dispatchBrowserError(error, event) { install() {
if (overrideHandler) {
// See discussion of spyOnGlobalErrorsAsync in base.js
overrideHandler(error);
return;
}
const handler = handlers[handlers.length - 1];
if (handler) {
handler(error, event);
} else {
throw error;
}
}
this.originalHandlers = {};
this.jasmineHandlers = {};
this.installOne_ = function installOne_(errorType, jasmineMessage) {
function taggedOnError(error) {
if (j$.isError_(error)) {
error.jasmineMessage = jasmineMessage + ': ' + error;
} else {
let substituteMsg;
if (error) {
substituteMsg = jasmineMessage + ': ' + error;
} else {
substituteMsg = jasmineMessage + ' with no error or message';
}
if (errorType === 'unhandledRejection') {
substituteMsg +=
'\n' +
'(Tip: to get a useful stack trace, use ' +
'Promise.reject(new Error(...)) instead of Promise.reject(' +
(error ? '...' : '') +
').)';
}
error = new Error(substituteMsg);
}
const handler = handlers[handlers.length - 1];
if (overrideHandler) {
// See discussion of spyOnGlobalErrorsAsync in base.js
overrideHandler(error);
return;
}
if (handler) {
handler(error);
} else {
throw error;
}
}
this.originalHandlers[errorType] = global.process.listeners(errorType);
this.jasmineHandlers[errorType] = taggedOnError;
global.process.removeAllListeners(errorType);
global.process.on(errorType, taggedOnError);
this.uninstall = function uninstall() {
const errorTypes = Object.keys(this.originalHandlers);
for (const errorType of errorTypes) {
global.process.removeListener(
errorType,
this.jasmineHandlers[errorType]
);
for (let i = 0; i < this.originalHandlers[errorType].length; i++) {
global.process.on(errorType, this.originalHandlers[errorType][i]);
}
delete this.originalHandlers[errorType];
delete this.jasmineHandlers[errorType];
}
};
};
this.install = function install() {
if ( if (
global.process && this.#global.process &&
global.process.listeners && this.#global.process.listeners &&
j$.isFunction_(global.process.on) j$.isFunction_(this.#global.process.on)
) { ) {
this.installOne_('uncaughtException', 'Uncaught exception'); this.#installNodeHandler('uncaughtException', this.#onNodeError);
this.installOne_('unhandledRejection', 'Unhandled promise rejection'); this.#installNodeHandler('unhandledRejection', this.#onNodeRejection);
} else { } else {
global.addEventListener('error', onBrowserError); this.#global.addEventListener('error', this.#onBrowserError);
const browserRejectionHandler = function browserRejectionHandler( this.#global.addEventListener(
event 'unhandledrejection',
) { this.#onBrowserRejection
if (j$.isError_(event.reason)) { );
event.reason.jasmineMessage =
'Unhandled promise rejection: ' + event.reason;
dispatchBrowserError(event.reason, event);
} else {
dispatchBrowserError(
'Unhandled promise rejection: ' + event.reason,
event
);
}
};
global.addEventListener('unhandledrejection', browserRejectionHandler);
this.uninstall = function uninstall() {
global.removeEventListener('error', onBrowserError);
global.removeEventListener(
'unhandledrejection',
browserRejectionHandler
);
};
} }
}; }
uninstall() {
if (
this.#global.process &&
this.#global.process.listeners &&
j$.isFunction_(this.#global.process.on)
) {
this.#nodeUninstall();
} else {
this.#browserUninstall();
}
}
// The listener at the top of the stack will be called with two arguments: // The listener at the top of the stack will be called with two arguments:
// the error and the event. Either of them may be falsy. // the error and the event. Either of them may be falsy.
@@ -136,35 +72,140 @@ getJasmineRequireObj().GlobalErrors = function(j$) {
// browsers but will be falsy in Node. // browsers but will be falsy in Node.
// Listeners that are pushed after spec files have been loaded should be // Listeners that are pushed after spec files have been loaded should be
// able to just use the error parameter. // able to just use the error parameter.
this.pushListener = function pushListener(listener) { pushListener(listener) {
handlers.push(listener); this.#handlers.push(listener);
}; }
this.popListener = function popListener(listener) { popListener(listener) {
if (!listener) { if (!listener) {
throw new Error('popListener expects a listener'); throw new Error('popListener expects a listener');
} }
handlers.pop(); this.#handlers.pop();
}; }
this.setOverrideListener = function(listener, onRemove) { setOverrideListener(listener, onRemove) {
if (overrideHandler) { if (this.#overrideHandler) {
throw new Error("Can't set more than one override listener at a time"); throw new Error("Can't set more than one override listener at a time");
} }
overrideHandler = listener; this.#overrideHandler = listener;
onRemoveOverrideHandler = onRemove; this.#onRemoveOverrideHandler = onRemove;
}; }
this.removeOverrideListener = function() { removeOverrideListener() {
if (onRemoveOverrideHandler) { if (this.#onRemoveOverrideHandler) {
onRemoveOverrideHandler(); this.#onRemoveOverrideHandler();
} }
overrideHandler = null; this.#overrideHandler = null;
onRemoveOverrideHandler = null; this.#onRemoveOverrideHandler = null;
}; }
#nodeUninstall() {
const errorTypes = Object.keys(this.#originalHandlers);
for (const errorType of errorTypes) {
this.#global.process.removeListener(
errorType,
this.#jasmineHandlers[errorType]
);
for (let i = 0; i < this.#originalHandlers[errorType].length; i++) {
this.#global.process.on(
errorType,
this.#originalHandlers[errorType][i]
);
}
delete this.#originalHandlers[errorType];
delete this.#jasmineHandlers[errorType];
}
}
#browserUninstall() {
this.#global.removeEventListener('error', this.#onBrowserError);
this.#global.removeEventListener(
'unhandledrejection',
this.#onBrowserRejection
);
}
#dispatchBrowserError(error, event) {
if (this.#overrideHandler) {
// See discussion of spyOnGlobalErrorsAsync in base.js
this.#overrideHandler(error);
return;
}
const handler = this.#handlers[this.#handlers.length - 1];
if (handler) {
handler(error, event);
} else {
throw error;
}
}
#browserRejectionHandler(event) {
if (j$.isError_(event.reason)) {
event.reason.jasmineMessage =
'Unhandled promise rejection: ' + event.reason;
this.#dispatchBrowserError(event.reason, event);
} else {
this.#dispatchBrowserError(
'Unhandled promise rejection: ' + event.reason,
event
);
}
}
#installNodeHandler(errorType, handler) {
this.#originalHandlers[errorType] = this.#global.process.listeners(
errorType
);
this.#jasmineHandlers[errorType] = handler;
this.#global.process.removeAllListeners(errorType);
this.#global.process.on(errorType, handler);
}
#handleNodeEvent(error, errorType, jasmineMessage) {
if (j$.isError_(error)) {
error.jasmineMessage = jasmineMessage + ': ' + error;
} else {
let substituteMsg;
if (error) {
substituteMsg = jasmineMessage + ': ' + error;
} else {
substituteMsg = jasmineMessage + ' with no error or message';
}
if (errorType === 'unhandledRejection') {
substituteMsg +=
'\n' +
'(Tip: to get a useful stack trace, use ' +
'Promise.reject(new Error(...)) instead of Promise.reject(' +
(error ? '...' : '') +
').)';
}
error = new Error(substituteMsg);
}
const handler = this.#handlers[this.#handlers.length - 1];
if (this.#overrideHandler) {
// See discussion of spyOnGlobalErrorsAsync in base.js
this.#overrideHandler(error);
return;
}
if (handler) {
handler(error);
} else {
throw error;
}
}
} }
return GlobalErrors; return GlobalErrors;