From 069f42f0c51ee85f8674a12048b90e8064c9d392 Mon Sep 17 00:00:00 2001
From: Dave C-J <dave@conway-jones.co.uk>
Date: Tue, 8 Apr 2014 11:31:22 +0100
Subject: [PATCH] Add console.log option to debug node Fixes #194

---
 nodes/core/core/58-debug.html |  14 ++-
 nodes/core/core/58-debug.js   | 169 ++++++++++++++++++----------------
 2 files changed, 103 insertions(+), 80 deletions(-)

diff --git a/nodes/core/core/58-debug.html b/nodes/core/core/58-debug.html
index 7f010948b..58fe19374 100644
--- a/nodes/core/core/58-debug.html
+++ b/nodes/core/core/58-debug.html
@@ -17,9 +17,16 @@
 <script type="text/x-red" data-template-name="debug">
     <div class="form-row">
         <label for="node-input-complete"><i class="icon-list"></i> Output</label>
-        <select type="text" id="node-input-complete" style="display: inline-block; width: auto; vertical-align: top;">
-            <option value=false>Payload only</option>
-            <option value=true>Complete msg object</option>
+        <select type="text" id="node-input-complete" style="display: inline-block; width: 250px; vertical-align: top;">
+            <option value=false>payload only</option>
+            <option value=true>complete msg object</option>
+        </select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-console"><i class="icon-random"></i> to</label>
+        <select type="text" id="node-input-console" style="display: inline-block; width: 250px; vertical-align: top;">
+            <option value=false>debug tab</option>
+            <option value=true>debug tab and console</option>
         </select>
     </div>
     <div class="form-row">
@@ -45,6 +52,7 @@
         defaults: {
             name: {value:""},
             active: {value:true},
+            console: {value:false},
             complete: {value:false}
         },
         label: function() {
diff --git a/nodes/core/core/58-debug.js b/nodes/core/core/58-debug.js
index 68a2e5f77..6538e6199 100644
--- a/nodes/core/core/58-debug.js
+++ b/nodes/core/core/58-debug.js
@@ -15,67 +15,82 @@
  **/
 
 var RED = require(process.env.NODE_RED_HOME+"/red/red");
-
 var util = require("util");
 var ws = require('ws');
 var events = require("events");
 var debuglength = RED.settings.debugMaxLength||1000;
+var useColors = false;
+
+util.inspect.styles.boolean = "red";
 
 function DebugNode(n) {
-	RED.nodes.createNode(this,n);
-	this.name = n.name;
-	this.complete = n.complete;
-	this.active = (n.active == null)||n.active;
+    RED.nodes.createNode(this,n);
+    this.name = n.name;
+    this.complete = n.complete;
+    this.console = n.console;
+    this.active = (n.active == null)||n.active;
+    var node = this;
 
-	this.on("input",function(msg) {
-		if (this.active) {
-			if (msg.payload instanceof Buffer) {
-				msg.payload = "(Buffer) "+msg.payload.toString();
-			}
-			if (this.complete == "true") {
-				DebugNode.send({id:this.id,name:this.name,topic:msg.topic,msg:msg,_path:msg._path});
-			} else {
-				if (typeof msg.payload !== "undefined") {
-					DebugNode.send({id:this.id,name:this.name,topic:msg.topic,msg:msg.payload,_path:msg._path});
-				}
-			}
-		}
-	});
+    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 (msg.payload instanceof Buffer) { msg.payload = "(Buffer) "+msg.payload.toString('hex'); }
+            if (this.active) {
+                DebugNode.send({id:this.id,name:this.name,topic:msg.topic,msg:msg,_path:msg._path});
+            }
+        } else { // debug just the msg.payload
+            if (this.console == "true") {
+                if (typeof msg.payload === "string") {
+                    if (msg.payload.indexOf("\n") != -1) { msg.payload = "\n"+msg.payload; }
+                    node.log(msg.payload);
+                }
+                else if (typeof msg.payload === "object") { node.log("\n"+util.inspect(msg.payload, {colors:useColors, depth:10})); }
+                else { node.log(util.inspect(msg.payload, {colors:useColors})); }
+            }
+            if (typeof msg.payload === "undefined") { msg.payload = "(undefined)"; }
+            if (msg.payload instanceof Buffer) { msg.payload = "(Buffer) "+msg.payload.toString('hex'); }
+            if (this.active) {
+                DebugNode.send({id:this.id,name:this.name,topic:msg.topic,msg:msg.payload,_path:msg._path});
+            }
+        }
+    });
 }
 
 RED.nodes.registerType("debug",DebugNode);
 
 DebugNode.send = function(msg) {
-	if (msg.msg instanceof Error) {
-		msg.msg = msg.msg.toString();
-	}
-	else if (typeof msg.msg === 'object') {
-		var seen = [];
-		msg.msg = "(Object) " + JSON.stringify(msg.msg, function(key, value) {
-			if (typeof value === 'object' && value !== null) {
-				if (seen.indexOf(value) !== -1) { return "[circular]"; }
-				seen.push(value);
-			}
-			return value;
-		}," ");
-		seen = null;
-	}
-	else if (typeof msg.msg === "boolean") msg.msg = "(boolean) "+msg.msg.toString();
-	else if (msg.msg === 0) msg.msg = "0";
+    if (msg.msg instanceof Error) {
+        msg.msg = msg.msg.toString();
+    }
+    else if (typeof msg.msg === 'object') {
+        var seen = [];
+        msg.msg = "(Object) " + JSON.stringify(msg.msg, function(key, value) {
+            if (typeof value === 'object' && value !== null) {
+                if (seen.indexOf(value) !== -1) { return "[circular]"; }
+                seen.push(value);
+            }
+            return value;
+        }," ");
+        seen = null;
+    }
+    else if (typeof msg.msg === "boolean") msg.msg = "(boolean) "+msg.msg.toString();
+    else if (msg.msg === 0) msg.msg = "0";
 
-	if (msg.msg.length > debuglength) {
-		msg.msg = msg.msg.substr(0,debuglength) +" ....";
-	}
+    if (msg.msg.length > debuglength) {
+        msg.msg = msg.msg.substr(0,debuglength) +" ....";
+    }
 
-	for (var i in DebugNode.activeConnections) {
-		var ws = DebugNode.activeConnections[i];
-		try {
-			var p = JSON.stringify(msg);
-			ws.send(p);
-		} catch(err) {
-			util.log("[debug] ws error : "+err);
-		}
-	}
+    for (var i in DebugNode.activeConnections) {
+        var ws = DebugNode.activeConnections[i];
+        try {
+            var p = JSON.stringify(msg);
+            ws.send(p);
+        } catch(err) {
+            util.log("[debug] ws error : "+err);
+        }
+    }
 }
 
 DebugNode.activeConnections = [];
@@ -85,18 +100,18 @@ path = path + (path.slice(-1) == "/" ? "":"/") + "debug/ws";
 
 DebugNode.wsServer = new ws.Server({server:RED.server,path:path});
 DebugNode.wsServer.on('connection',function(ws) {
-	DebugNode.activeConnections.push(ws);
-	ws.on('close',function() {
-		for (var i in DebugNode.activeConnections) {
-			if (DebugNode.activeConnections[i] === ws) {
-				DebugNode.activeConnections.splice(i,1);
-				break;
-			}
-		}
-	});
-	ws.on('error', function(err) {
-	    util.log("[debug] ws error : "+err);
-	});
+    DebugNode.activeConnections.push(ws);
+    ws.on('close',function() {
+        for (var i in DebugNode.activeConnections) {
+            if (DebugNode.activeConnections[i] === ws) {
+                DebugNode.activeConnections.splice(i,1);
+                break;
+            }
+        }
+    });
+    ws.on('error', function(err) {
+        util.log("[debug] ws error : "+err);
+    });
 });
 
 DebugNode.wsServer.on('error', function(err) {
@@ -105,26 +120,26 @@ DebugNode.wsServer.on('error', function(err) {
 
 DebugNode.logHandler = new events.EventEmitter();
 DebugNode.logHandler.on("log",function(msg) {
-	if (msg.level == "warn" || msg.level == "error") {
-		DebugNode.send(msg);
-	}
+    if (msg.level == "warn" || msg.level == "error") {
+        DebugNode.send(msg);
+    }
 });
 RED.nodes.addLogHandler(DebugNode.logHandler);
 
 RED.httpAdmin.post("/debug/:id/:state", function(req,res) {
-	var node = RED.nodes.getNode(req.params.id);
-	var state = req.params.state;
-	if (node != null) {
-	    if (state === "enable") {
-	        node.active = true;
-			res.send(200);
-	    } else if (state === "disable") {
-	        node.active = false;
-			res.send(201);
-	    } else {
-	        res.send(404);
-	    }
-	} else {
-		res.send(404);
-	}
+    var node = RED.nodes.getNode(req.params.id);
+    var state = req.params.state;
+    if (node != null) {
+        if (state === "enable") {
+            node.active = true;
+            res.send(200);
+        } else if (state === "disable") {
+            node.active = false;
+            res.send(201);
+        } else {
+            res.send(404);
+        }
+    } else {
+        res.send(404);
+    }
 });