mirror of
https://github.com/node-red/node-red.git
synced 2023-10-10 13:36:53 +02:00
7b1787fdbb
* Let debug optionally target the status line (32 chars only) * Add batching of messages to debug ws comms * let Debug handle simple case of NaN would also close #1530 * Fixup debug tests for batch comms (no new tests yet) * mixup comms/api test to match new batch mode (no new tests) * Add test for NaN being sent OK. * redo original fix to padding / labels for new debug options * fix debug test (re-add fix from #1444) * Fix up merge issues in debug tests
256 lines
10 KiB
JavaScript
256 lines
10 KiB
JavaScript
|
|
module.exports = function(RED) {
|
|
"use strict";
|
|
var util = require("util");
|
|
var events = require("events");
|
|
var path = require("path");
|
|
var safeJSONStringify = require("json-stringify-safe");
|
|
var debuglength = RED.settings.debugMaxLength || 1000;
|
|
var useColors = RED.settings.debugUseColors || false;
|
|
util.inspect.styles.boolean = "red";
|
|
|
|
function DebugNode(n) {
|
|
RED.nodes.createNode(this,n);
|
|
this.name = n.name;
|
|
this.complete = (n.complete||"payload").toString();
|
|
if (this.complete === "false") { this.complete = "payload"; }
|
|
this.console = ""+(n.console || false);
|
|
this.tostatus = n.tostatus || false;
|
|
this.tosidebar = n.tosidebar;
|
|
if (this.tosidebar === undefined) { this.tosidebar = true; }
|
|
this.severity = n.severity || 40;
|
|
this.active = (n.active === null || typeof n.active === "undefined") || n.active;
|
|
this.status({});
|
|
|
|
var node = this;
|
|
var levels = {
|
|
off: 1,
|
|
fatal: 10,
|
|
error: 20,
|
|
warn: 30,
|
|
info: 40,
|
|
debug: 50,
|
|
trace: 60,
|
|
audit: 98,
|
|
metric: 99
|
|
};
|
|
var colors = {
|
|
"0": "grey",
|
|
"10": "grey",
|
|
"20": "red",
|
|
"30": "yellow",
|
|
"40": "grey",
|
|
"50": "green",
|
|
"60": "blue"
|
|
};
|
|
|
|
this.on("input",function(msg) {
|
|
if (this.complete === "true") {
|
|
// debug complete msg object
|
|
if (this.console === "true") {
|
|
node.log("\n"+util.inspect(msg, {colors:useColors, depth:10}));
|
|
}
|
|
if (this.active && this.tosidebar) {
|
|
sendDebug({id:node.id, name:node.name, topic:msg.topic, msg:msg, _path:msg._path});
|
|
}
|
|
}
|
|
else {
|
|
// debug user defined msg property
|
|
var property = "payload";
|
|
var output = msg[property];
|
|
if (this.complete !== "false" && typeof this.complete !== "undefined") {
|
|
property = this.complete;
|
|
try {
|
|
output = RED.util.getMessageProperty(msg,this.complete);
|
|
} catch(err) {
|
|
output = undefined;
|
|
}
|
|
}
|
|
if (this.console === "true") {
|
|
if (typeof output === "string") {
|
|
node.log((output.indexOf("\n") !== -1 ? "\n" : "") + output);
|
|
} else if (typeof output === "object") {
|
|
node.log("\n"+util.inspect(output, {colors:useColors, depth:10}));
|
|
} else {
|
|
node.log(util.inspect(output, {colors:useColors}));
|
|
}
|
|
}
|
|
if (this.active) {
|
|
if (this.tosidebar == true) {
|
|
sendDebug({id:node.id, z:node.z, name:node.name, topic:msg.topic, property:property, msg:output, _path:msg._path});
|
|
}
|
|
if (this.tostatus === true) {
|
|
var st = util.inspect(output);
|
|
if (st.length > 32) { st = st.substr(0,32) + "..."; }
|
|
node.oldStatus = {fill:colors[node.severity], shape:"dot", text:st};
|
|
node.status(node.oldStatus);
|
|
}
|
|
}
|
|
}
|
|
});
|
|
}
|
|
|
|
RED.nodes.registerType("debug",DebugNode, {
|
|
settings: {
|
|
debugUseColors: {
|
|
value: false,
|
|
},
|
|
debugMaxLength: {
|
|
value: 1000,
|
|
}
|
|
}
|
|
});
|
|
|
|
function sendDebug(msg) {
|
|
// don't put blank errors in sidebar (but do add to logs)
|
|
//if ((msg.msg === "") && (msg.hasOwnProperty("level")) && (msg.level === 20)) { return; }
|
|
if (msg.msg instanceof Error) {
|
|
msg.format = "error";
|
|
var errorMsg = {};
|
|
if (msg.msg.name) {
|
|
errorMsg.name = msg.msg.name;
|
|
}
|
|
if (msg.msg.hasOwnProperty('message')) {
|
|
errorMsg.message = msg.msg.message;
|
|
} else {
|
|
errorMsg.message = msg.msg.toString();
|
|
}
|
|
msg.msg = JSON.stringify(errorMsg);
|
|
} else if (msg.msg instanceof Buffer) {
|
|
msg.format = "buffer["+msg.msg.length+"]";
|
|
msg.msg = msg.msg.toString('hex');
|
|
if (msg.msg.length > debuglength) {
|
|
msg.msg = msg.msg.substring(0,debuglength);
|
|
}
|
|
} else if (msg.msg && typeof msg.msg === 'object') {
|
|
try {
|
|
msg.format = msg.msg.constructor.name || "Object";
|
|
// Handle special case of msg.req/res objects from HTTP In node
|
|
if (msg.format === "IncomingMessage" || msg.format === "ServerResponse") {
|
|
msg.format = "Object";
|
|
}
|
|
} catch(err) {
|
|
msg.format = "Object";
|
|
}
|
|
if (/error/i.test(msg.format)) {
|
|
msg.msg = JSON.stringify({
|
|
name: msg.msg.name,
|
|
message: msg.msg.message
|
|
});
|
|
} else {
|
|
var isArray = util.isArray(msg.msg);
|
|
if (isArray) {
|
|
msg.format = "array["+msg.msg.length+"]";
|
|
if (msg.msg.length > debuglength) {
|
|
// msg.msg = msg.msg.slice(0,debuglength);
|
|
msg.msg = {
|
|
__encoded__: true,
|
|
type: "array",
|
|
data: msg.msg.slice(0,debuglength),
|
|
length: msg.msg.length
|
|
}
|
|
}
|
|
}
|
|
if (isArray || (msg.format === "Object")) {
|
|
msg.msg = safeJSONStringify(msg.msg, function(key, value) {
|
|
if (key === '_req' || key === '_res') {
|
|
value = "[internal]"
|
|
} else if (value instanceof Error) {
|
|
value = value.toString()
|
|
} else if (util.isArray(value) && value.length > debuglength) {
|
|
value = {
|
|
__encoded__: true,
|
|
type: "array",
|
|
data: value.slice(0,debuglength),
|
|
length: value.length
|
|
}
|
|
} else if (typeof value === 'string') {
|
|
if (value.length > debuglength) {
|
|
value = value.substring(0,debuglength)+"...";
|
|
}
|
|
} else if (value && value.constructor) {
|
|
if (value.type === "Buffer") {
|
|
value.__encoded__ = true;
|
|
value.length = value.data.length;
|
|
if (value.length > debuglength) {
|
|
value.data = value.data.slice(0,debuglength);
|
|
}
|
|
} else if (value.constructor.name === "ServerResponse") {
|
|
value = "[internal]"
|
|
} else if (value.constructor.name === "Socket") {
|
|
value = "[internal]"
|
|
}
|
|
}
|
|
return value;
|
|
}," ");
|
|
} else {
|
|
try { msg.msg = msg.msg.toString(); }
|
|
catch(e) { msg.msg = "[Type not printable]"; }
|
|
}
|
|
}
|
|
} else if (typeof msg.msg === "boolean") {
|
|
msg.format = "boolean";
|
|
msg.msg = msg.msg.toString();
|
|
} else if (typeof msg.msg === "number") {
|
|
msg.format = "number";
|
|
msg.msg = msg.msg.toString();
|
|
} else if (msg.msg === 0) {
|
|
msg.format = "number";
|
|
msg.msg = "0";
|
|
} else if (msg.msg === null || typeof msg.msg === "undefined") {
|
|
msg.format = (msg.msg === null)?"null":"undefined";
|
|
msg.msg = "(undefined)";
|
|
} else {
|
|
msg.format = "string["+msg.msg.length+"]";
|
|
if (msg.msg.length > debuglength) {
|
|
msg.msg = msg.msg.substring(0,debuglength)+"...";
|
|
}
|
|
}
|
|
// if (msg.msg.length > debuglength) {
|
|
// msg.msg = msg.msg.substr(0,debuglength) +" ....";
|
|
// }
|
|
RED.comms.publish("debug",msg);
|
|
}
|
|
|
|
DebugNode.logHandler = new events.EventEmitter();
|
|
DebugNode.logHandler.on("log",function(msg) {
|
|
if (msg.level === RED.log.WARN || msg.level === RED.log.ERROR) {
|
|
sendDebug(msg);
|
|
}
|
|
});
|
|
RED.log.addHandler(DebugNode.logHandler);
|
|
|
|
RED.httpAdmin.post("/debug/:id/:state", RED.auth.needsPermission("debug.write"), function(req,res) {
|
|
var node = RED.nodes.getNode(req.params.id);
|
|
var state = req.params.state;
|
|
if (node !== null && typeof node !== "undefined" ) {
|
|
if (state === "enable") {
|
|
node.active = true;
|
|
res.sendStatus(200);
|
|
if (node.tostatus) { node.status({}); }
|
|
} else if (state === "disable") {
|
|
node.active = false;
|
|
res.sendStatus(201);
|
|
if (node.tostatus && node.hasOwnProperty("oldStatus")) {
|
|
node.oldStatus.shape = "ring";
|
|
node.status(node.oldStatus);
|
|
}
|
|
} else {
|
|
res.sendStatus(404);
|
|
}
|
|
} else {
|
|
res.sendStatus(404);
|
|
}
|
|
});
|
|
|
|
// As debug/view/debug-utils.js is loaded via <script> tag, it won't get
|
|
// the auth header attached. So do not use RED.auth.needsPermission here.
|
|
RED.httpAdmin.get("/debug/view/*",function(req,res) {
|
|
var options = {
|
|
root: __dirname + '/lib/debug/',
|
|
dotfiles: 'deny'
|
|
};
|
|
res.sendFile(req.params[0], options);
|
|
});
|
|
};
|