@gregoriusrippenstein/node-red-contrib-introspection 0.8.0 → 0.8.2

package/README.md

@@ -78,6 +78,18 @@ Sidebar for visually obfuscating flows:
 
 The plugin replaces the name with the node Id, resets the nodes info content to empty and moves all nodes to the same location. The intention is to having a *working* flow but not an *understandable* flow. The generated flow is meant to be only usable and not modifiable nor maintainable.
 
+### Message tracing
+
+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)
+
+Message tracing can be toggled on & off *without* redeploying the flow. So this can be used as a quick check for observing tricky situation.
+
+The nodes status will be replaced by 'msg received', so if the status should be showing something else, that is lost.
+
+Also this is an experimental feature liable to be [improved](https://discourse.nodered.org/t/message-tracing-for-beginners/92287).
+
 ## Palette Nodes
 
 ### Sink & Seeker

package/nodes/60-client-code.js

@@ -2,6 +2,19 @@ module.exports = function(RED) {
   let UglifyJS = require('uglify-js');
   let CleanCSS = require('clean-css');
 
+  const OnReceiveHookName = "onReceive.introspectionMsgTracer"
+  const OnPreuninstallHookName = "preUninstall.introspectionMsgTracer"
+
+  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)
+    } catch (ex) {
+      console.error(ex)
+    }
+  }
+
   function ClientCodeFunctionality(config) {
     RED.nodes.createNode(this,config);
 
@@ -36,6 +49,44 @@ module.exports = function(RED) {
   }
   RED.nodes.registerType("ClientCode", ClientCodeFunctionality);
 
+
+  RED.httpAdmin.post("/ClientCode/msgtracer/on",
+    RED.auth.needsPermission("ClientCode.write"),
+    (req, res) => {
+      try {
+        RED.hooks.remove(OnReceiveHookName)
+        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.
+        RED.hooks.remove(OnPreuninstallHookName)
+        RED.hooks.add(OnPreuninstallHookName, (evnt) => {
+          if (evnt.module == "@gregoriusrippenstein/node-red-contrib-introspection") {
+            RED.hooks.remove(OnReceiveHookName)
+            RED.hooks.remove(OnPreuninstallHookName)
+          }
+        })
+
+        res.sendStatus(200);
+      } catch (err) {
+        res.sendStatus(500);
+      }
+    });
+
+  RED.httpAdmin.post("/ClientCode/msgtracer/off",
+    RED.auth.needsPermission("ClientCode.write"),
+    (req, res) => {
+      try {
+
+        RED.hooks.remove(OnReceiveHookName)
+        RED.hooks.remove(OnPreuninstallHookName)
+
+        res.sendStatus(200);
+      } catch (err) {
+        res.sendStatus(500);
+      }
+    });
+
   RED.httpAdmin.post("/ClientCode/:id",
     RED.auth.needsPermission("ClientCode.write"),
     (req,res) => {

package/package.json

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

package/plugins/sidebar.html

@@ -238,6 +238,28 @@
          $('.red-ui-linkcall-link-indicator').remove()
       })
 
+      $('#node-input-msgtracer-toggle').on("change", function (e) {
+        $.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
+              });
+            }
+       });
+      })
+
       RED.actions.add( "introspection:show-link-call-links", highlightAllLinkCalls)
       
       $('#node-input-linkcalls-find-btn').on('click', (e) => {
@@ -358,6 +380,15 @@
          <button id="node-input-orphan-clear-workspace-btn"
                            class="red-ui-button">Clear dots</button>
       </div>
+
+      <div class="form-row" style="margin-left: 10px; margin-top: 40px">
+         <label for="node-input-msgtracer-toggle" class="w-30">
+                        <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;">
+      </div>
    </div>
 
    <!-- Obfuscation Tab in Sidebar -->