Debug to status option (#1499)

* 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

nodes/core/core/58-debug.html

@@ -6,11 +6,22 @@
         <input id="node-input-complete" type="hidden">
     </div>
     <div class="form-row">
-        <label for="node-input-console"><i class="fa fa-random"></i> <span data-i18n="debug.to"></span></label>
-        <select type="text" id="node-input-console" style="display: inline-block; width: 250px; vertical-align: top;">
-            <option value="false" data-i18n="debug.debtab"></option>
-            <option value="true" data-i18n="debug.tabcon"></option>
-        </select>
+        <label for="node-input-tosidebar"><i class="fa fa-random"></i> <span data-i18n="debug.to"></span></label>
+        <label for="node-input-tosidebar" style="width:70%">
+        <input type="checkbox" id="node-input-tosidebar" style="display:inline-block; width:22px; vertical-align:baseline;"><span data-i18n="debug.toSidebar"></span>
+        </label>
+    </div>
+    <div class="form-row">
+        <label for="node-input-console"> </label>
+        <label for="node-input-console" style="width:70%">
+        <input type="checkbox" id="node-input-console" style="display:inline-block; width:22px; vertical-align:baseline;"><span data-i18n="debug.toConsole"></span>
+        </label>
+    </div>
+    <div class="form-row" id="node-tostatus-line">
+    <label for="node-input-tostatus"> </label>
+    <label for="node-input-tostatus" style="width:70%">
+        <input type="checkbox" id="node-input-tostatus" style="display:inline-block; width:22px; vertical-align:baseline;"><span data-i18n="debug.toStatus"></span>
+    </label>
     </div>
     <div class="form-row">
         <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="common.label.name"></span></label>
@@ -26,7 +37,7 @@
     <p>Alongside each message, the debug sidebar includes information about the time the message was received, the node that sent it and the type of the message.
        Clicking on the source node id will reveal that node within the workspace.</p>
     <p>The button on the node can be used to enable or disable its output. It is recommended to disable or remove any Debug nodes that are not being used.</p>
-    <p>The node can also be configured to send all messages to the runtime log.</p>
+    <p>The node can also be configured to send all messages to the runtime log, or to send short (32 characters) to the status text under the debug node.</p>
 </script>
 <script src="debug/view/debug-utils.js"></script>
 
@@ -38,7 +49,9 @@
         defaults: {
             name: {value:""},
             active: {value:true},
-            console: {value:"false"},
+            tosidebar: {value:true},
+            console: {value:false},
+            tostatus: {value:false},
             complete: {value:"false", required:true}
         },
         label: function() {
@@ -100,7 +113,6 @@
             }
         },
         onpaletteadd: function() {
-
             var options = {
                 messageMouseEnter: function(sourceId) {
                     if (sourceId) {
@@ -148,7 +160,7 @@
 
             var that = this;
             RED._debug = function(msg) {
-                that.handleDebugMessage("",{
+                that.handleDebugMessage("", {
                     name:"debug",
                     msg:msg
                 });
@@ -170,7 +182,6 @@
                 var sourceNode = RED.nodes.node(o.id) || RED.nodes.node(o.z);
                 if (sourceNode) {
                     o._source = {id:sourceNode.id,z:sourceNode.z,name:sourceNode.name};
-
                 }
                 RED.debug.handleDebugMessage(o);
                 if (subWindow) {
@@ -225,6 +236,15 @@
             delete RED._debug;
         },
         oneditprepare: function() {
+            if (this.tosidebar === undefined) {
+                this.tosidebar = true;
+                $("#node-input-tosidebar").prop('checked', true);
+            }
+            if (typeof this.console === "string") {
+                this.console = (this.console == 'true');
+                $("#node-input-console").prop('checked', this.console);
+                $("#node-input-tosidebar").prop('checked', true);
+            }
             $("#node-input-typed-complete").typedInput({types:['msg', {value:"full",label:RED._("node-red:debug.msgobj"),hasValue:false}]});
             if (this.complete === "true" || this.complete === true) {
                 // show complete message object
@@ -240,6 +260,16 @@
                 ) {
                     $("#node-input-typed-complete").typedInput('value','payload');
                 }
+                if ($("#node-input-typed-complete").typedInput('type') === 'msg') {
+                    $("#node-tostatus-line").show();
+                }
+                else { $("#node-tostatus-line").hide(); }
+            });
+            $("#node-input-complete").on('change',function() {
+                if ($("#node-input-typed-complete").typedInput('type') === 'msg') {
+                    $("#node-tostatus-line").show();
+                }
+                else { $("#node-tostatus-line").hide(); }
             });
         },
         oneditsave: function() {
@@ -250,7 +280,6 @@
                 $("#node-input-complete").val($("#node-input-typed-complete").typedInput('value'));
             }
         }
-
     });
 })();
 </script>

nodes/core/core/58-debug.js

@@ -5,7 +5,7 @@ module.exports = function(RED) {
     var events = require("events");
     var path = require("path");
     var safeJSONStringify = require("json-stringify-safe");
-    var debuglength = RED.settings.debugMaxLength||1000;
+    var debuglength = RED.settings.debugMaxLength || 1000;
     var useColors = RED.settings.debugUseColors || false;
     util.inspect.styles.boolean = "red";
 
@@ -13,26 +13,49 @@ module.exports = function(RED) {
         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;
+        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
+                // debug complete msg object
                 if (this.console === "true") {
                     node.log("\n"+util.inspect(msg, {colors:useColors, depth:10}));
                 }
-                if (this.active) {
-                    sendDebug({id:node.id,name:node.name,topic:msg.topic,msg:msg,_path:msg._path});
+                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
+            }
+            else {
+                // debug user defined msg property
                 var property = "payload";
                 var output = msg[property];
                 if (this.complete !== "false" && typeof this.complete !== "undefined") {
@@ -53,7 +76,15 @@ module.exports = function(RED) {
                     }
                 }
                 if (this.active) {
-                    sendDebug({id:node.id,z:node.z,name:node.name,topic:msg.topic,property:property,msg:output,_path:msg._path});
+                    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);
+                    }
                 }
             }
         });
@@ -196,9 +227,14 @@ module.exports = function(RED) {
             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);
             }

nodes/core/core/lib/debug/debug-utils.js

@@ -439,7 +439,9 @@ RED.debug = (function() {
             $('<span class="debug-message-name">'+name+'</span>').appendTo(metaRow);
         }
 
-        if (format === 'Object' || /^array/.test(format) || format === 'boolean' || format === 'number' ) {
+        if ((format === 'number') && (payload === "NaN")) {
+            payload = Number.NaN;
+        } else if (format === 'Object' || /^array/.test(format) || format === 'boolean' || format === 'number' ) {
             payload = JSON.parse(payload);
         } else if (/error/i.test(format)) {
             payload = JSON.parse(payload);

nodes/core/locales/en-US/messages.json

@@ -103,9 +103,13 @@
         "output": "Output",
         "msgprop": "message property",
         "msgobj": "complete msg object",
-        "to": "to",
+        "to": "To",
         "debtab": "debug tab",
         "tabcon": "debug tab and console",
+        "toSidebar": "debug window",
+        "toConsole": "system console",
+        "toStatus": "node status (32 characters)",
+        "severity": "Level",
         "notification": {
             "activated": "Successfully activated: __label__",
             "deactivated": "Successfully deactivated: __label__"