node-red/nodes/core/core/58-debug.html

<!--
  Copyright 2013 IBM Corp.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
-->

<script type="text/x-red" data-template-name="debug">
    <div class="form-row">
        <label for="node-input-select-complete"><i class="fa fa-list"></i> Output</label>
        <select type="text" id="node-input-select-complete" style="display: inline-block; width: 250px; vertical-align: top;">
            <option value="false">message property</option>
            <option value="true">complete msg object</option>
        </select>
    </div>
    <div class="form-row" id="node-prop-row">
        <label for="node-input-complete">&nbsp;</label>msg.<input type="text" style="width:208px" id="node-input-complete">
    </div>
    <div class="form-row">
        <label for="node-input-console"><i class="fa fa-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">
        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="Name">
    </div>
</script>

<script type="text/x-red" data-help-name="debug">
    <p>The Debug node can be connected to the output of any node. It can be used to display the output of any message property in the debug tab of the sidebar. The default is to display <b>msg.payload</b>.</p>
    <p>Each message will also display the timestamp, <b>msg.topic</b> and the property chosen to output.</p>
    <p>The sidebar can be accessed under the options drop-down in the top right corner.</p>
    <p>The button to the right of the node will toggle it's output on and off so you can de-clutter the debug window.</p>
    <p>If the payload is an object or buffer it will be stringified first for display and indicate that by saying "(Object)" or "(Buffer)".</p>
    <p>Selecting any particular message will highlight (in red) the debug node that reported it. This is useful if you wire up multiple debug nodes.</p>
    <p>Optionally can show the complete <b>msg</b> object.</p>
    <p>In addition any calls to node.warn or node.error will appear here.</p>
</script>

<script type="text/javascript">

    function oneditprepare() {
        if (this.complete === "true" || this.complete === true) {
            // show complete message object
            $("#node-input-select-complete").val("true");
            $("#node-prop-row").hide();
        } else {
            // show msg.[   ]
            var property = (!this.complete||(this.complete === "false")) ? "payload" : this.complete+"";
            $("#node-input-select-complete").val("false");
            $("#node-input-complete").val(property);
            $("#node-prop-row").show();
        }
        $("#node-input-select-complete").change(function() {
            var v = $("#node-input-select-complete option:selected").val();
            $("#node-input-complete").val(v);
            if (v !== "true") {
                $("#node-input-complete").val("payload");
                $("#node-prop-row").show();
                $("#node-input-complete").focus();
            } else {
                $("#node-prop-row").hide();
            }
        });
    }

    RED.nodes.registerType('debug',{
        category: 'output',
        defaults: {
            name: {value:""},
            active: {value:true},
            console: {value:"false"},
            complete: {value:"false", required:true}
        },
        label: function() {
            if (this.complete === true || this.complete === "true") {
                return this.name||"msg";
            } else {
                return this.name || "msg." + ((!this.complete || this.complete === "false") ? "payload" : this.complete);
            }
        },
        labelStyle: function() {
            return this.name?"node_label_italic":"";
        },
        color:"#87a980",
        inputs:1,
        outputs:0,
        icon: "debug.png",
        align: "right",
        button: {
            toggle: "active",
            onclick: function() {
                var label = this.name||"debug";
                d3.xhr("debug/"+this.id+"/"+(this.active?"enable":"disable")).post(function(err,resp) {
                    if (err) {
                        if (err.status == 404) {
                            RED.notify("<strong>Error</strong>: debug node not deployed","error");
                        } else if (err.status == 0) {
                            RED.notify("<strong>Error</strong>: no response from server","error");
                        } else {
                            RED.notify("<strong>Error</strong>: unexpected error: ("+err.status+")"+err.response,"error");
                        }
                    } else if (resp.status == 200) {
                        RED.notify("Successfully activated: "+label,"success");
                    } else if (resp.status == 201) {
                        RED.notify("Successfully deactivated: "+label,"success");
                    } else {
                        RED.notify("<strong>Error</strong>: unexpected response: ("+resp.status+") "+resp.response,"error");
                    }
                });
            }
        },
        onpaletteadd: function() {
            var content = document.createElement("div");
            content.id = "tab-debug";

            var toolbar = document.createElement("div");
            toolbar.id = "debug-toolbar";
            content.appendChild(toolbar);

            toolbar.innerHTML = '<div class="btn-group pull-right"><a id="debug-tab-clear" title="clear log" class="btn btn-mini" href="#"><i class="fa fa-trash"></i></a></div> ';

            var messages = document.createElement("div");
            messages.id = "debug-content";
            content.appendChild(messages);

            RED.sidebar.addTab("debug",content);

            function getTimestamp() {
                var d = new Date();
                return d.toLocaleString();
            }

            var sbc = document.getElementById("debug-content");

            var messageCount = 0;
            var that = this;
            RED._debug = function(msg) {
                that.handleDebugMessage("",{
                    name:"debug",
                    msg:msg
                });
            }

            this.handleDebugMessage = function(t,o) {
                var msg = document.createElement("div");
                msg.onmouseover = function() {
                    msg.style.borderRightColor = "#999";
                    var n = RED.nodes.node(o.id);
                    if (n) {
                        n.highlighted = true;
                        n.dirty = true;
                    }
                    RED.view.redraw();
                };
                msg.onmouseout = function() {
                    msg.style.borderRightColor = "";
                    var n = RED.nodes.node(o.id);
                    if (n) {
                        n.highlighted = false;
                        n.dirty = true;
                    }
                    RED.view.redraw();
                };
                msg.onclick = function() {
                    var node = RED.nodes.node(o.id);
                    if (node) {
                        RED.view.showWorkspace(node.z);
                    }

                };
                var name = (o.name?o.name:o.id).toString().replace(/&/g,"&amp;").replace(/</g,"&lt;").replace(/>/g,"&gt;");
                var topic = (o.topic||"").toString().replace(/&/g,"&amp;").replace(/</g,"&lt;").replace(/>/g,"&gt;");
                var property = (o.property?o.property:'').replace(/&/g,"&amp;").replace(/</g,"&lt;").replace(/>/g,"&gt;");
                var payload = (o.msg||"").toString().replace(/&/g,"&amp;").replace(/</g,"&lt;").replace(/>/g,"&gt;");
                msg.className = 'debug-message'+(o.level?(' debug-message-level-'+o.level):'');
                msg.innerHTML = '<span class="debug-message-date">'+
                                getTimestamp()+'</span>'+
                                '<span class="debug-message-name">['+name+']</span>'+
                                '<span class="debug-message-topic">'+
                                (o.topic?topic+' : ':'')+
                                (o.property?'[msg.'+property+']':'[msg]')+
                                '</span>'+'<span class="debug-message-payload">'+
                                payload+'</span>';
                var atBottom = (sbc.scrollHeight-messages.offsetHeight-sbc.scrollTop) < 5;
                messageCount++;
                $(messages).append(msg);

                if (messageCount > 200) {
                    $("#debug-content .debug-message:first").remove();
                    messageCount--;
                }
                if (atBottom) {
                    $(sbc).scrollTop(sbc.scrollHeight);
                }
            };
            RED.comms.subscribe("debug",this.handleDebugMessage);

            $("#debug-tab-clear").click(function() {
                $(".debug-message").remove();
                messageCount = 0;
                RED.nodes.eachNode(function(node) {
                    node.highlighted = false;
                    node.dirty = true;
                });
                RED.view.redraw();
            });
        },
        onpaletteremove: function() {
            RED.comms.unsubscribe("debug",this.handleDebugMessage);
            RED.sidebar.removeTab("debug");
            delete RED._debug;
        },
        oneditprepare: oneditprepare
    });
</script>

<style>
    #debug-content {
        position: absolute;
        top: 30px;
        bottom: 0px;
        left:0px;
        right: 0px;
        overflow-y: scroll;
    }
    #debug-toolbar {
        padding: 3px 10px;
        height: 24px;
        background: #f3f3f3;
    }
    .debug-message {
        cursor: pointer;
        border-bottom: 1px solid #eee;
        border-left: 8px solid #eee;
        border-right: 8px solid #eee;
        padding: 2px;
    }
    .debug-message-date {
        background: #fff;
        font-size: 9px;
        color: #aaa;
        padding: 1px 5px 1px 1px;
    }
    .debug-message-topic {
        display: block;
        background: #fff;
        padding: 1px 5px;
        font-size: 9px;
        color: #a66;
    }
    .debug-message-name {
        background: #fff;
        padding: 1px 5px;
        font-size: 9px;
        color: #aac;
    }
    .debug-message-payload {
        display: block;
        padding: 2px;
        background: #fff;
    }
    .debug-message-level-log {
        border-left-color: #eee;
        border-right-color: #eee;
    }
    .debug-message-level-warn {
        border-left-color: #ffdf9d;
        border-right-color: #ffdf9d;
    }
    .debug-message-level-error {
        border-left-color: #f99;
        border-right-color: #f99;
    }
</style>