@gregoriusrippenstein/node-red-contrib-introspection 0.8.3 → 0.8.5

package/README.md

@@ -82,13 +82,27 @@ The plugin replaces the name with the node Id, resets the nodes info content to
 
 Sometimes it would be nice to observe the flow of messages through a flow. This is possible by using 'Trace Messages' found at the bottom of the 'Lint' tab:
 
-![img](https://cdn.openmindmap.org/content/1728588310213_msgtrace.gif)
+![img](https://cdn.openmindmap.org/content/1728655611060_msgtracer6.gif)
 
-Message tracing can be toggled on & off *without* redeploying the flow. So this can be used as a quick check for observing tricky situation.
+Message tracing can be toggled on & off *without* redeploying the flow. So this can be used as a quick check for observing tricky situations.
 
-The nodes status will be replaced by 'msg received', so if the status should be showing something else, that is lost.
+The nodes status will be replaced by 'msg received', so if the status should be showing something else, that will be replaced.
 
-Also this is an experimental feature liable to be [improved](https://discourse.nodered.org/t/message-tracing-for-beginners/92287).
+Also this is an experimental feature liable to be [enhanced](https://discourse.nodered.org/t/message-tracing-for-beginners/92287).
+
+*UPDATE*: 
+
+This now has a [treeList](https://nodered.org/docs/api/ui/treeList/) of nodes and how often they received a message. Clicking on the node in the list will highlight the node, double-click will open the nodes edit panel.
+
+*UPDATE2*: 
+
+It is now possible to send all messages to the debug panel. By toggling the 'msg to debug' checkbox, *all messages* will be sent to the Node-RED debug panel. This can be toggled on and off independently of the message tracing. That is, as long as message tracing is activated. It is therefore possible (as shown in the animation above) to active message tracing, then activate msg to debug to have msg appear in the debug panel and then deactive the msg to debug. The message tracing continues unabated.
+
+This makes it possible to trace messages, if something critical happens, to activate the msg to debug and then deactivate again. Only those messages that occured in that timeframe are logged.
+
+**But remember** all messages are logged to the debug panel, every single message that is sent within Node-RED will be set to the debug panel. This will cause major disappointments for those wishing to have a responsive editor.
+
+Also this feature causes **no extra overhead** on the backend server if it is *not in use* - the hooks for capturing the data are removed if this feature is deactivated.
 
 ## Palette Nodes
 

package/nodes/60-client-code.js

@@ -4,10 +4,12 @@ module.exports = function(RED) {
 
   const OnReceiveHookName = "onReceive.introspectionMsgTracer"
   const OnPreuninstallHookName = "preUninstall.introspectionMsgTracer"
+  const debugLength = RED.settings.debugMaxLength || 1000 
 
   function msgTracerOnReceiveHook(evnt) {
     try {
       let nde = RED.nodes.getNode(evnt.destination.id)
+
       nde.status({ fill: "green", shape: "ring", text: "msg received" })
       setTimeout(() => { nde.status({}) }, 1000)
 
@@ -16,6 +18,31 @@ module.exports = function(RED) {
           nodeid: evnt.destination.id
         })
       )
+
+      return nde
+    } catch (ex) {
+      console.error(ex)
+    }
+  }
+
+  function msgTracerOnReceiveHookWithDebug(evnt) {
+    try {
+      let nde = msgTracerOnReceiveHook(evnt)
+
+      // taken from the [debug node](https://github.com/node-red/node-red/blob/2854351909dee9f92597faba3f37239134294eec/packages/node_modules/%40node-red/nodes/core/common/21-debug.js#L227)
+      let msg = { 
+        id:     nde.id, 
+        z:      nde.z, 
+        _alias: nde._alias,  
+        path:   nde._flow.path, 
+        name:   nde.name, 
+        topic:  evnt.msg.topic, 
+        msg:    evnt.msg
+      }
+
+      msg = RED.util.encodeObject(msg, { maxLength: debugLength });
+      RED.comms.publish("debug",msg);
+      
     } catch (ex) {
       console.error(ex)
     }
@@ -55,13 +82,22 @@ module.exports = function(RED) {
   }
   RED.nodes.registerType("ClientCode", ClientCodeFunctionality);
 
-
-  RED.httpAdmin.post("/ClientCode/msgtracer/on",
+  /**
+   * These are the two endpoints for the message tracer functionality.
+   * Rather badly placed in the ClientCode node code but the author
+   * didn't find a better place. The world is confusing, why should 
+   * this codebase be any different.
+   */
+  RED.httpAdmin.post("/MsgTracer/msgtracing/on",
     RED.auth.needsPermission("ClientCode.write"),
     (req, res) => {
       try {
         RED.hooks.remove(OnReceiveHookName)
-        RED.hooks.add(OnReceiveHookName, msgTracerOnReceiveHook)
+        if ( req.body.withDebug ) {
+          RED.hooks.add(OnReceiveHookName, msgTracerOnReceiveHookWithDebug)
+        } else {
+          RED.hooks.add(OnReceiveHookName, msgTracerOnReceiveHook)
+        }
 
         // add hook on uninstall package so that the hook for the
         // message tracer is removed on uninstall of this package.
@@ -79,7 +115,7 @@ module.exports = function(RED) {
       }
     });
 
-  RED.httpAdmin.post("/ClientCode/msgtracer/off",
+  RED.httpAdmin.post("/MsgTracer/msgtracing/off",
     RED.auth.needsPermission("ClientCode.write"),
     (req, res) => {
       try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gregoriusrippenstein/node-red-contrib-introspection",
-  "version": "0.8.3",
+  "version": "0.8.5",
   "dependencies": {
     "got": "^13",
     "uglify-js": "^3.17.4",

package/plugins/sidebar.html

@@ -14,7 +14,7 @@
 
    function setupTreelistAllLinksForLinkIn(e){e=collectAllLinksNodes(e);if(0==e.length){RED.notify("No links found",{type:"error",timeout:2e3});try{$("#node-input-orphan-target-container-div").treeList("empty")}catch(e){}}else{try{$("#node-input-orphan-target-container-div").treeList("empty")}catch(e){$("#node-input-orphan-target-container-div").css({width:"100%",height:"calc(100%)"}).treeList({multi:!1}).on("treelistitemmouseover",function(e,t){}).on("treelistitemmouseout",function(e,t){}).on("treelistselect",function(e,t){t.node&&(RED.workspaces.show(t.node.z,!1,!1,!0),RED.view.reveal(t.node.id,!0),RED.view.redraw())}).on("treelistconfirm",function(e,t){var n;t.node&&(n=t.node.id,setTimeout(()=>{var e=RED.nodes.node(n);e&&(RED.view.reveal(e.id),RED.view.select(e.id),RED.editor.edit(e,"editor-tab-description")),n==RED.workspaces.active()&&RED.workspaces.edit()},50))}),$("#node-input-orphan-target-filter").show();var n=$("#node-input-orphan-target-filter").searchBox({style:"compact",delay:300,change:function(){var e,t=$(this).val().trim().toLowerCase();""===t?($("#node-input-orphan-target-container-div").treeList("filter",null),n.searchBox("count","")):(e=$("#node-input-orphan-target-container-div").treeList("filter",function(e){return-1<e.label.toLowerCase().indexOf(t)||-1<e.node.type.toLowerCase().indexOf(t)}),n.searchBox("count",e+" / "+$("#node-input-orphan-target-container-div").treeList("data").length))}})}$("#node-input-orphan-target-container-div").treeList("data",e.sort((e,t)=>e.node.z>t.node.z))}}function collectAllLinksNodes(t){let n=[];RED.nodes.eachNode(e=>{"link call"!=e.type&&"link out"!=e.type||-1<e.links.indexOf(t)&&n.push(e)});var i=[],r={};return n.forEach(function(e){var t=RED.nodes.getType(e.type);if(t){var n,o=t.label,o=("function"==typeof o?o.call(e):o)||"";if(0===(n=e.type).indexOf("subflow:"))return}t&&o||(o=e.type),r[e.id]={node:e,label:o,sublabel:n,selected:!1,checkbox:!1},i.push(r[e.id])}),i}function collectNodeStats(){let t={},n=[],o={workspaces:0,junctions:0,subflows:0,configs:0,groups:0,wires:0,nodes:0},i=(RED.nodes.eachConfig(e=>{o.configs+=1}),RED.nodes.eachLink(e=>{o.wires+=1}),RED.nodes.eachJunction(e=>{o.junctions+=1}),RED.nodes.eachGroup(e=>{o.groups+=1}),RED.nodes.eachWorkspace(e=>{o.workspaces+=1}),RED.nodes.eachSubflow(e=>{o.subflows+=1}),RED.nodes.eachNode(e=>{o.nodes+=1,t[e.type]=(t[e.type]||0)+1}),Object.keys(t).forEach(e=>{n.push({label:e,sublabel:t[e],selected:!1,checkbox:!1})}),[]),r=0;return Object.keys(o).forEach(e=>{r+=o[e],i.push({label:e,sublabel:o[e],selected:!1,checkbox:!1})}),[{label:"__ TOTALS",sublabel:r,selected:!1,checkbox:!1,children:i}].concat(n.sort((e,t)=>e.label>t.label))}function setupTreeListForNodeStats(){var e=collectNodeStats();try{$("#node-input-orphan-target-container-div").treeList("empty")}catch(e){$("#node-input-orphan-target-container-div").css({width:"100%",height:"calc(100%)"}).treeList({multi:!1}).on("treelistitemmouseover",function(e,t){}).on("treelistitemmouseout",function(e,t){}).on("treelistselect",function(e,t){}).on("treelistconfirm",function(e,t){}),$("#node-input-orphan-target-filter").show();var n=$("#node-input-orphan-target-filter").searchBox({style:"compact",delay:300,change:function(){var e,t=$(this).val().trim().toLowerCase();""===t?($("#node-input-orphan-target-container-div").treeList("filter",null),n.searchBox("count","")):(e=$("#node-input-orphan-target-container-div").treeList("filter",function(e){return-1<e.label.toLowerCase().indexOf(t)}),n.searchBox("count",e+" / "+$("#node-input-orphan-target-container-div").treeList("data").length))}})}$("#node-input-orphan-target-container-div").treeList("data",e)}
 
-   function setupTreeMsgTracerlist(){try{$("#node-input-msgtracer-trace-treelist").treeList("empty"),$("#node-input-msgtracer-trace-treelist").treeList("data",[])}catch(e){$("#node-input-msgtracer-trace-treelist").css({width:"100%",height:"calc(100%)"}).treeList({multi:!1}).on("treelistitemmouseover",function(e,t){}).on("treelistitemmouseout",function(e,t){}).on("treelistselect",function(e,t){t.node&&(RED.workspaces.show(t.node.z,!1,!1,!0),RED.view.reveal(t.node.id,!0),RED.view.redraw())}).on("treelistconfirm",function(e,t){var r;t.node&&(r=t.node.id,setTimeout(()=>{var e=RED.nodes.node(r);e&&(RED.view.reveal(e.id),RED.view.select(e.id),RED.editor.edit(e)),r==RED.workspaces.active()&&RED.workspaces.edit()},50))}),$("#node-input-msgtracer-trace-treelist-filter").show();var r=$("#node-input-msgtracer-trace-treelist-filter").searchBox({style:"compact",delay:300,change:function(){var e,t=$(this).val().trim().toLowerCase();""===t?($("#node-input-msgtracer-trace-treelist").treeList("filter",null),r.searchBox("count","")):(e=$("#node-input-msgtracer-trace-treelist").treeList("filter",function(e){return-1<e.label.toLowerCase().indexOf(t)||-1<e.node.type.toLowerCase().indexOf(t)}),r.searchBox("count",e+" / "+$("#node-input-msgtracer-trace-treelist").treeList("data").length))}})}}
+   function setupTreeMsgTracerlist(){try{$("#node-input-msgtracer-trace-treelist").treeList("empty"),$("#node-input-msgtracer-trace-treelist").treeList("data",[])}catch(e){$("#node-input-msgtracer-trace-treelist").css({width:"100%",height:"calc(100%)"}).treeList({multi:!1}).on("treelistitemmouseover",function(e,t){}).on("treelistitemmouseout",function(e,t){}).on("treelistselect",function(e,t){t.node&&(RED.workspaces.show(t.node.z,!1,!1,!0),RED.view.reveal(t.node.id,!0),RED.view.redraw())}).on("treelistconfirm",function(e,t){var r;t.node&&(r=t.node.id,setTimeout(()=>{var e=RED.nodes.node(r);e&&(RED.view.reveal(e.id),RED.view.select(e.id),RED.editor.edit(e)),r==RED.workspaces.active()&&RED.workspaces.edit()},50))}),$("#node-input-msgtracer-trace-treelist-filter").show();var r=$("#node-input-msgtracer-trace-treelist-filter").searchBox({style:"compact",delay:300,change:function(){var e,t=$(this).val().trim().toLowerCase();""===t?($("#node-input-msgtracer-trace-treelist").treeList("filter",null),r.searchBox("count","")):(e=$("#node-input-msgtracer-trace-treelist").treeList("filter",function(e){return-1<e.label.toLowerCase().indexOf(t)||-1<e.node.type.toLowerCase().indexOf(t)}),r.searchBox("count",e+" / "+$("#node-input-msgtracer-trace-treelist").treeList("data").length))}})}}function toggleMsgTracingInBackend(e){let t=$("#node-input-msgtracer-toggle").is(":checked");var r=$("#node-input-msgtracer-msgtodebug").is(":checked");$.ajax({url:"MsgTracer/msgtracing/"+(t?"on":"off"),type:"POST",contentType:"application/json; charset=utf-8",data:JSON.stringify({withDebug:r}),success:function(e){RED.notify("Message tracing is "+(t?"on":"off"),{type:"success",timeout:3e3})},error:function(e,t,r){RED.notify("Message tracing failed: "+t,{type:"error",timeout:3e3})}})}function handleMsgTracerToggles(e){$("#node-input-msgtracer-toggle").is(":checked")&&setupTreeMsgTracerlist(),toggleMsgTracingInBackend(e)}
 
    // Add your plugin as a new tabsheet in the right sidebar AFTER the flow editor is completely started
    var initialiseConfigNodeOnce = () => {
@@ -247,31 +247,8 @@
          $("#node-input-msgtracer-trace-treelist").treeList('data', [])
       })
 
-      $('#node-input-msgtracer-toggle').on("change", function (e) {
-         if ( $('#node-input-msgtracer-toggle').is(":checked") ) {
-            setupTreeMsgTracerlist()
-         }
-         
-         $.ajax({
-               url:         "ClientCode/msgtracer/" + ($('#node-input-msgtracer-toggle').is(":checked") ? "on" : "off"),
-               type:        "POST",
-               contentType: "application/json; charset=utf-8",
-               data:        {},
-               success: function (resp) {
-                  RED.notify("Message tracing succeed", {
-                     type: "success",
-                     timeout: 3000
-                  })
-               },
-
-               error: function (jqXHR, textStatus, errorThrown) {
-               RED.notify("Message tracing failed: " +textStatus, {
-                  type: "error",
-                  timeout: 3000
-               });
-               }
-         });
-      })
+      $('#node-input-msgtracer-msgtodebug').on("change", toggleMsgTracingInBackend)
+      $('#node-input-msgtracer-toggle').on("change", handleMsgTracerToggles)
 
       RED.actions.add( "introspection:show-link-call-links", highlightAllLinkCalls)
       
@@ -395,13 +372,21 @@
       </div>
 
       <div class="form-row" style="margin-left: 10px; margin-top: 40px">
-         <label for="node-input-msgtracer-toggle" class="w-30">
+         <label for="node-input-msgtracer-toggle">
                         <i class="fa fa-tag"></i>
                         <span>Trace Messages?</span>
          </label>
          <input type="checkbox" id="node-input-msgtracer-toggle"
                               style="display:inline-block; width:15px; vertical-align:baseline;">
-         <button id="node-input-msgtrace-clear-trace-btn"
+
+         <label for="node-input-msgtracer-msgtodebug">
+                        <i class="fa fa-bug"></i>
+                        <span>Msg to Debug?</span>
+         </label>
+         <input type="checkbox" id="node-input-msgtracer-msgtodebug"
+                              style="display:inline-block; width:15px; vertical-align:baseline;">
+
+         <button id="node-input-msgtrace-clear-trace-btn" style="margin-left: 10px;"
                        class="red-ui-button">Clear Trace</button>
       </div>