node-red-contrib-logger/logger.js

Node-RED implements logger and debug/logging for control for any insert.

const loggerStatusActive={fill: 'yellow',shape:'ring',text:'Logging'};
const loggerStatusOff={fill: 'green',shape:'ring',text:''};
const { inspect } = require('util');

function Logger(label="***",active=true,count=111,msg) {
	this.consoleFunction=console.log;
	this.onStack=[]
	this.offStack=[]
	this.sendFunction=this.sendConsole;
	this.type="debug";
	if(label instanceof Object)	Object.assign(this,label);
	else this.label=label;
	if(this.active==undefined) this.active=active;
	if(this.count==undefined) this.count=count;
	this.set(this.active,this.count);
	return msg?this.sendInfo(msg):this;
};
Logger.prototype.objectDump=function(o) {
	return o?this.send(inspect(o, {showHidden: true, depth: null})):this;
};
Logger.prototype.send=function(message,type,node,sendFunction=this.sendFunction) {
	if (--this.count) {
		try {
			sendFunction.apply(this, [(message instanceof Object ? JSON.stringify(message) : message), type, node])
		} catch (ex) {
			sendFunction.apply(this, [ex.message, type, node])
		}
	} else {
		this.setOff();
	}
	return this;
};
Logger.prototype.sendConsole=function(message,type=this.type,consoleFunction=this.consoleFunction) {
	const ts = (new Date().toString()).split(' ');
	consoleFunction.apply(this,[([parseInt(ts[2], 10), ts[1], ts[4]].join(" ") + " - ["+type+"] "+this.label+" "+message)]);
	return this;
};
Logger.prototype.sendDebug=function(message,values) {
	if(values) return this.send(Object.assign({},{label:message},values),"debug");
	return this.send(message,"debug");
}
Logger.prototype.debug=Logger.prototype.sendDebug;
Logger.prototype.sendError=function(message) {
	return this.send(message,"error");
}
Logger.prototype.error=Logger.prototype.sendError;
Logger.prototype.sendErrorAndDump=function(message,o,ex) {
	return this.sendError(message).objectDump(o).stackDump(ex);
}
Logger.prototype.sendErrorAndStackDump=function(message,ex) {
	return this.sendError(message).stackDump(ex);
}
Logger.prototype.sendInfo=function(message) {
	return this.send(message,"info");
}
Logger.prototype.info=Logger.prototype.sendInfo;
Logger.prototype.sendNode=function(message,node=this.node,type=this.noderedLogType) {
	return node[type](message);
}
Logger.prototype.sendWarn=function(message) {
	return this.send(message,"warn");
}
Logger.prototype.sendWarning=Logger.prototype.sendWarn;
Logger.prototype.warn=Logger.prototype.sendWarn;
Logger.prototype.warning=Logger.prototype.sendWarn;
Logger.prototype.setNodeStatus=function(node) {
	if(node) this.node=node;
	if(this.node==null) throw Error("No node set");
	this.showNodeStatus();
	return this;
};
Logger.prototype.runStack=function(stack) {
	for (const action of stack) {
		try {
		  action.callFunction(...action.args)
		} catch (ex) {
		  if( action.onError ) action.onError(ex)
		  else throw ex
		}
	  }
	return this;
};
Logger.prototype.add2Stack = function(stack,callFunction, ...args) {
    if (typeof callFunction === 'object') {
      if(!callFunction.callFunction) throw Error("no callFunction property in "+JSON.stringify(callFunction))
      if(callFunction.args) callFunction.args = callFunction.args = callFunction.args.concat(args)
      else callFunction.args = args
      stack.push(callFunction) 
    } else {
      if (typeof callFunction !== 'function') throw Error('expected function')
      stack.push({ callFunction: callFunction, args: args })
    }
    return this
}
Logger.prototype.onOff=function(...action) {
	this.add2Stack(this.offStack,...action)
	return this;
};
Logger.prototype.onOn=function(...action) {
	this.add2Stack(this.onStack,...action)
	return this;
};
Logger.prototype.set=function(active,count) {
	if(count!==undefined) {
		this.count=count;
		this.countDefault=count
	}
	if(active!==undefined) this.active=active;
	this.active?this.runStack(this.onStack):this.runStack(this.offStack)
	this.showNodeStatus();
	this.sendConsole('logging turning '+(this.active?"on logging next " + this.count + " log points":"off"));
	return this;
};
Logger.prototype.setOff=function() {
	this.set(false)
	return this;
};
Logger.prototype.setOn=function(count=this.countDefault) {
	return this.set(true,count);
};
Logger.prototype.showNodeStatus=function() {
	if(this.node) this.node.status(this.active?loggerStatusActive:loggerStatusOff);
};
Logger.prototype.stackDump=function(ex) {
	if(ex) console.log(ex.stack) 
	else console.trace();
	return this;
};

module.exports = Logger;