Merge pull request #5079 from node-red/5068-improve-error-object-debug

Improve debug display of error objects
This commit is contained in:
Nick O'Leary
2025-03-11 16:46:08 +00:00
committed by GitHub
4 changed files with 108 additions and 97 deletions

View File

@@ -1285,7 +1285,6 @@ RED.utils = (function() {
payload = JSON.parse(payload);
} else if (/error/i.test(format)) {
payload = JSON.parse(payload);
payload = (payload.name?payload.name+": ":"")+payload.message;
} else if (format === 'null') {
payload = null;
} else if (format === 'undefined') {

View File

@@ -828,18 +828,25 @@ function encodeObject(msg,opts) {
debuglength = opts.maxLength;
}
var msgType = typeof msg.msg;
if (msg.msg instanceof Error) {
if (msg.msg instanceof Error || /Error/.test(msg.msg?.__proto__?.name)) {
msg.format = "error";
var errorMsg = {};
if (msg.msg.name) {
errorMsg.name = msg.msg.name;
const cause = msg.msg.cause
const value = {
__enc__: true,
type: 'error',
data: {
name: msg.msg.name,
message: hasOwnProperty.call(msg.msg, 'message') ? msg.msg.message : msg.msg.toString(),
cause: cause + "",
stack: msg.msg.stack,
}
}
if (hasOwnProperty.call(msg.msg, 'message')) {
errorMsg.message = msg.msg.message;
} else {
errorMsg.message = msg.msg.toString();
// Remove cause if not defined
if (!cause) {
delete value.data.cause
}
msg.msg = JSON.stringify(errorMsg);
msg.msg = JSON.stringify(value);
} else if (msg.msg instanceof Buffer) {
msg.format = "buffer["+msg.msg.length+"]";
msg.msg = msg.msg.toString('hex');
@@ -857,6 +864,7 @@ function encodeObject(msg,opts) {
msg.format = "Object";
}
if (/error/i.test(msg.format)) {
// TODO: check if this is needed
msg.msg = JSON.stringify({
name: msg.msg.name,
message: msg.msg.message
@@ -904,8 +912,22 @@ function encodeObject(msg,opts) {
__enc__: true,
type: "internal"
}
} else if (value instanceof Error) {
value = value.toString()
} else if (value instanceof Error || /Error/.test(value?.__proto__?.name)) {
const cause = value.cause
value = {
__enc__: true,
type: 'error',
data: {
name: value.name,
message: hasOwnProperty.call(value, 'message') ? value.message : value.toString(),
cause: cause + "",
stack: value.stack,
}
}
// Remove cause if not defined
if (!cause) {
delete value.data.cause
}
} else if (Array.isArray(value) && value.length > debuglength) {
value = {
__enc__: true,
@@ -977,8 +999,19 @@ function encodeObject(msg,opts) {
return value;
});
} else {
try { msg.msg = msg.msg.toString(); }
catch(e) { msg.msg = "[Type not printable]" + util.inspect(msg.msg); }
try {
msg.msg = msg.msg.toString();
} catch(e) {
msg.msg.format = 'error'
msg.msg = JSON.stringify({
__enc__: true,
type: 'error',
data: {
message: "[Type not serializable]",
stack: e.stack
}
})
}
}
}
} else if (msgType === "function") {
@@ -1009,17 +1042,14 @@ function encodeObject(msg,opts) {
return msg;
} catch(e) {
msg.format = "error";
var errorMsg = {};
if (e.name) {
errorMsg.name = e.name;
}
if (hasOwnProperty.call(e, 'message')) {
errorMsg.message = 'encodeObject Error: ['+e.message + '] Value: '+util.inspect(msg.msg);
} else {
errorMsg.message = 'encodeObject Error: ['+e.toString() + '] Value: '+util.inspect(msg.msg);
}
if (errorMsg.message.length > debuglength) {
errorMsg.message = errorMsg.message.substring(0,debuglength);
const errorMsg = {
__enc__: true,
type: 'error',
data: {
name: e.name,
message: 'encodeObject Error: ' + (hasOwnProperty.call(e, 'message') ? e.message : e.toString()),
stack: e.stack,
}
}
msg.msg = JSON.stringify(errorMsg);
return msg;