@gregoriusrippenstein/node-red-contrib-introspection 0.6.17 → 0.7.1

package/README.md

@@ -99,6 +99,12 @@ Inspired by the [dsm](https://flows.nodered.org/node/node-red-contrib-dsm) packa
 
 Send a flow to another Node-RED instance. This will replace **any existing** flows on the other server, use with care. Under the hood this uses the [Node-RED API](https://nodered.org/docs/api/admin/methods/post/flows/) to post a new flow to the server. This node also supports authentication if the other server happens to have some.
 
+### InstallPackage
+
+Node used to install packages on other Node-RED installations. Can be used to install existing modules using or .tgz files that can installed on the instance. To install an existing package, use `msg.payload = { module: '@fubar/example' }` with an optional `version`, this defaults to 'latest'.
+
+To install a package on the fly, generate a .tgz as a Buffer and set the the payload to: `msg.payload = { data: Buffer[...]}` where buffer contains the .tgz contents.
+
 ### ClientCode
 
 ClientCode is a node for executing client side, i.e., in the editor, Javascript code triggered by a server side event. Any code that can be executed in the browseer console can be executed in the ClientCode node. A ClientCode node can also send a message back to the server using `node.send(...)` which becomes the server side output of the node.
@@ -165,6 +171,7 @@ There are [example flows](/examples) contained in the package, examples can also
 - [Orphans](https://flowhub.org/f/2401c255b056e0e1)
 - [Sink and Seeker](https://flowhub.org/f/139a816449acd89f)
 - [Obfuscation](https://flowhub.org/f/825ddf24d98eb011)
+- [InstallPackage](https://flowhub.org/f/6dcbd2643ea80615)
 
 ## License
 

package/nodes/45-get-flows.js

@@ -42,7 +42,7 @@ module.exports = function(RED) {
 
         }).catch( err => {
           node.status({fill:"red",shape:"dot",text:"Failed"});
-          node.error(err)
+          node.error("error occurred", { ...msg, _err: err})
         });
       };
 
@@ -56,7 +56,7 @@ module.exports = function(RED) {
                                       node, msg, (err, result) => {
           if (err) {
             node.status({fill:"red",shape:"dot",text:"Failed"});
-            node.error(err)
+            node.error("error occurred", {...msg, _err:err})
           } else {
             username = result;
 
@@ -64,7 +64,7 @@ module.exports = function(RED) {
                                           node, msg, (err, result) => {
               if (err) {
                 node.status({fill:"red",shape:"dot",text:"Failed"});
-                node.error(err)
+                node.error("error occurred", { ...msg, _err: err })
               } else {
                 password = result;
 
@@ -94,7 +94,7 @@ module.exports = function(RED) {
 
                   }).catch((err) => {
                     node.status({fill:"red",shape:"dot",text:"Failed"});
-                    node.error( err );
+                    node.error( "error occurred", {...msg, _err: err });
                   });
                 });
               }

package/nodes/50-send-flow.js

@@ -34,7 +34,7 @@ module.exports = function(RED) {
 
         }).catch( err => {
           node.status({fill:"red",shape:"dot",text:"Failed"});
-          node.error(err)
+          node.error("error occurred", { ...msg, _err: err})
         });
       };
 
@@ -51,7 +51,7 @@ module.exports = function(RED) {
                                       node, msg, (err, result) => {
           if (err) {
             node.status({fill:"red",shape:"dot",text:"Failed"});
-            node.error(err)
+            node.error("error occurred", { ...msg, _err: err})
           } else {
             username = result;
 
@@ -59,7 +59,7 @@ module.exports = function(RED) {
                                           node, msg, (err, result) => {
               if (err) {
                 node.status({fill:"red",shape:"dot",text:"Failed"});
-                node.error(err)
+                node.error("error occurred", {...msg, _err: err})
               } else {
                 password = result;
 
@@ -89,7 +89,7 @@ module.exports = function(RED) {
 
                   }).catch((err) => {
                     node.status({fill:"red",shape:"dot",text:"Failed"});
-                    node.error( err );
+                    node.error( "error occurred", { ...msg, _err: err });
                   });
                 });
               }

package/nodes/51-install-package.html

@@ -0,0 +1,111 @@
+<script type="text/javascript">
+  RED.nodes.registerType('InstallPackage',{
+    color: '#e5e4ef',
+    icon: "introspesubflow.svg",
+    category: 'introspection',
+    defaults: {
+      name: {
+        value:"",
+      },
+      hostUrl: {
+        value: ""
+      },
+      useAuthentication: {
+        value:false
+      },
+      apiUsername: {
+        value: "",
+      },
+      apiUsernameType: {
+        value: "env",
+      },
+      apiPassword: {
+        value: "",
+      },
+      apiPasswordType: {
+        value: "env",
+      },
+    },
+    inputs:1,
+    outputs:1,
+
+    label: function() {
+      return (this.name || this._def.paletteLabel);
+    },
+
+    labelStyle: function() {
+      return this.name?"node_label_italic":"";
+    },
+    oneditprepare: function() {
+      $("#node-input-apiUsername").typedInput({
+        types:["env", "msg", "flow","global", "cred"],
+        typeField: "#node-input-apiUsernameType"
+      });
+
+      $("#node-input-apiPassword").typedInput({
+        types:["env", "msg", "flow","global", "env", "cred"],
+        typeField: "#node-input-apiPasswordType"
+      });
+
+      if ( $('#node-input-useAuthentication').is(":checked") ) {
+        $('#useAuthentication-input-fields').show();
+      } else {
+        $('#useAuthentication-input-fields').hide()
+      }
+
+      $('#node-input-useAuthentication').on( 'change', function() {
+        if ( $('#node-input-useAuthentication').is(":checked") ) {
+          $('#useAuthentication-input-fields').show();
+        } else {
+          $('#useAuthentication-input-fields').hide()
+        }
+      });
+    },
+  });
+</script>
+
+<script type="text/html" data-template-name="InstallPackage">
+    <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>
+
+    <div class="form-row">
+        <label for="node-input-hostUrl"><i class="fa fa-tag"></i> Host</label>
+        <input type="text" id="node-input-hostUrl" placeholder="Host URL">
+    </div>
+
+    <div class="form-row">
+      <label for="node-input-useAuthentication">
+        <i class="fa "></i>
+        <span>Use Authentication?</span>
+      </label>
+
+      <input type="checkbox" id="node-input-useAuthentication"
+             style="display:inline-block; width:15px; vertical-align:baseline;">
+    </div>
+
+    <div id="useAuthentication-input-fields" class="hidden">
+      <div class="form-row">
+        <label for="node-input-apiUsername">
+          <i class="fa fa-tag"></i>
+          Username
+        </label>
+        <input type="text" id="node-input-apiUsername">
+        <input type="hidden" id="node-input-apiUsernameType">
+      </div>
+
+      <div class="form-row">
+        <label for="node-input-apiPassword">
+          <i class="fa fa-tag"></i>
+          Password
+        </label>
+        <input type="text" id="node-input-apiPassword">
+        <input type="hidden" id="node-input-apiPasswordType">
+      </div>
+    </div>
+</script>
+
+<script type="text/html" data-help-name="InstallPackage">
+  <p>Send flow to another Node-RED instance.</p>
+</script>

package/nodes/51-install-package.js

@@ -0,0 +1,137 @@
+module.exports = function(RED) {
+  function InstallPackageFunctionality(config) {
+    RED.nodes.createNode(this,config);
+
+    var node = this;
+    var cfg = config;
+
+    node.on('close', function() {
+      node.status({});
+    });
+
+    node.on("input", function(msg, send, done) {
+
+      if (!msg.payload || Object.prototype.toString.call(msg.payload) !== '[object Object]') {
+        return node.error("msg.payload missing or payload not hash", msg)
+      }
+
+      var installPackage = (hdrs, got) => {
+        let body = undefined
+        let headers = {}
+
+        if ( msg.payload.module  ) {
+          body = JSON.stringify({
+            module: msg.payload.module,
+            version: msg.payload.version || "latest"
+          })
+
+          headers = {
+            "Content-Type": "application/json"
+          }
+        } else if ( msg.payload.data && Buffer.isBuffer(msg.payload.data) ) {
+
+          let formData = require('form-data')
+          body = new formData();
+          body.append("tarball", msg.payload.data, "tarball.tgz");
+          headers = body.getHeaders()
+          body = body.getBuffer()
+
+        } else {
+          return node.error("msg.payload not well defined", msg)
+        }
+
+        got.post( cfg.hostUrl + "/nodes", {
+          headers: {
+            ...headers,
+            ...hdrs
+          },          
+          body: body
+        }).then( res => {
+          send({
+            ...msg,
+            payload: JSON.parse(res.body)
+          });
+
+          node.status({fill:"green",shape:"dot",text:"Good"});
+          setTimeout( function() {
+            node.status({})
+          }, 450);
+
+        }).catch( err => {
+          node.status({fill:"red",shape:"dot",text:"Failed"});
+          node.error("error occurred", { ...msg, _err: err })
+        });
+      };
+
+      /**
+      * Authentication
+      **/
+      if ( cfg.useAuthentication ) {
+        var username = undefined;
+        var password = undefined;
+
+        node.status({fill:"blue",shape:"dot",text:"Requesting token"});
+
+        RED.util.evaluateNodeProperty(cfg.apiUsername, cfg.apiUsernameType,
+                                      node, msg, (err, result) => {
+          if (err) {
+            node.status({fill:"red",shape:"dot",text:"Failed"});
+            node.error("error occurred", { ...msg, _err: err})
+          } else {
+            username = result;
+
+            RED.util.evaluateNodeProperty(cfg.apiPassword, cfg.apiPasswordType,
+                                          node, msg, (err, result) => {
+              if (err) {
+                node.status({fill:"red",shape:"dot",text:"Failed"});
+                node.error("error occurred", { ...msg, _err: err} )
+              } else {
+                password = result;
+
+                var data = {
+                      "client_id":  "node-red-admin",
+                      "grant_type": "password",
+                      "scope":      "*",
+                      "username":   username,
+                      "password":   password
+                }
+
+                import('got').then( (module) => {
+                  module.got.post( cfg.hostUrl + "/auth/token", {
+                    json: data
+                  }).then( res => {
+                    node.status({
+                      fill:"blue",
+                      shape:"dot",
+                      text:"Sending flow"
+                    });
+
+                    var access_token = JSON.parse(res.body).access_token;
+
+                    installPackage({
+                      "Authorization": "Bearer " + access_token
+                    }, module.got);
+
+                  }).catch((err) => {
+                    node.status({fill:"red",shape:"dot",text:"Failed"});
+                    node.error( "error occured", { ...msg, _err: err } );
+                  });
+                });
+              }
+            })
+          }
+        })
+      } else {
+        /*
+         * Authentication free zone...
+         */
+        node.status({fill:"blue",shape:"dot",text:"Sending flow"});
+        import('got').then( (module) => {
+          installPackage({}, module.got);
+        });
+      }
+    });
+  }
+
+  RED.nodes.registerType("InstallPackage", InstallPackageFunctionality);
+}

package/nodes/60-client-code.js

@@ -42,8 +42,6 @@ module.exports = function(RED) {
           }
         } catch(err) {
           res.sendStatus(500);
-          node.error("ClientCode: Submission failed: " +
-                    err.toString())
         }
       } else {
         res.sendStatus(404);
@@ -64,8 +62,6 @@ module.exports = function(RED) {
           }
         } catch (err) {
           res.sendStatus(500);
-          node.error("ClientCode: Submission failed: " +
-            err.toString())
         }
       } else {
         res.sendStatus(404);
@@ -135,8 +131,6 @@ module.exports = function(RED) {
         }
       } catch (err) {
         res.sendStatus(500);
-        node.error("ClientCode: Submission failed: " +
-          err.toString())
       }
     });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gregoriusrippenstein/node-red-contrib-introspection",
-  "version": "0.6.17",
+  "version": "0.7.1",
   "dependencies": {
     "got": "^13",
     "uglify-js": "^3.17.4",
@@ -28,11 +28,12 @@
       "screenshot": "plugins/sidebar.html"
     },
     "nodes": {
-      "seeker":        "nodes/05-seeker.js",
-      "sink":          "nodes/10-sink.js",
-      "getflows":      "nodes/45-get-flows.js",
-      "sendflow":      "nodes/50-send-flow.js",
-      "clientcode":    "nodes/60-client-code.js"
+      "seeker":         "nodes/05-seeker.js",
+      "sink":           "nodes/10-sink.js",
+      "getflows":       "nodes/45-get-flows.js",
+      "sendflow":       "nodes/50-send-flow.js",
+      "installpackage": "nodes/51-install-package.js",
+      "clientcode":     "nodes/60-client-code.js"
     }
   },