node-red-contrib-remote 1.2.3 → 1.3.3

package/README.md

@@ -26,7 +26,7 @@ There is a help page describing how the the nodes work together and how to conne
 
 [Help in English](https://www.remote-red.com/en/help/)
 
-[Hilfe in deutsch](https://www.remote-red.com/de/hilfe/)
+[Hilfe in Deutsch](https://www.remote-red.com/de/hilfe/)
 
 
 ## Contact
@@ -36,6 +36,19 @@ You will find more information on [www.remote-red-com](https://www.remote-red.co
 
 ## Version History
 
+Version 1.3.3:
+- Improved compatibility for Windows.
+
+Version 1.3.2:
+- Changed the method to get the installed node version. Thanks hardillb!
+
+Version 1.3.1:
+- Added timeout handling to the heartbeat function.
+- Catches errors when evaluating the title, body or sound of an notification.
+
+Version 1.3.0:
+- A heartbeat function is added to the remote access node. This will automatically reconnect if the connection is interrupted, e.g. due to an unstable internet connection.
+
 Version 1.2.3:
 - The settings base url and port are filled automatically for new config nodes. This is helpful when using alternative installations such as RedMatic.
 - Notifications and Questions can have a computed sound. So you can include the sound based on the incoming message.

package/nodes/locales/de/remote-access.json

@@ -11,6 +11,9 @@
           "serving": "aktiv",
           "stopping": "stoppe",
           "stopped": "gestoppt",
+          "heartbeaterror": "Kommuniktionsfehler",
+          "heartbeaterroractive": "aktiv - kein Webserver erkannt",
+          "heartbeaterrornotfound": "aktiv - jedoch 404 erhalten",
           "commerror": "Fehler bei der Kommunikation mit dem Server.",
           "noconfig": "Keine Konfiguration gefunden.",
           "incompleteconfig": "Konfiguration unvollständig.",

package/nodes/locales/en-US/remote-access.json

@@ -11,6 +11,9 @@
           "serving": "serving",
           "stopping": "stopping",
           "stopped": "stopped",
+          "heartbeaterror": "communication error",
+          "heartbeaterroractive": "serving - no endpoint detected",
+          "heartbeaterrornotfound": "serving - but received 404 response",
           "commerror": "Error communicating with server.",
           "noconfig": "No configuration found.",
           "incompleteconfig": "Configuration incomplete.",

package/nodes/remote-access.js

@@ -2,10 +2,18 @@ module.exports = function(RED) {
   const commons = require('./remote-commons');
   const child_process = require('child_process');
   const os = require("os");
+  let sshprocess = undefined
+  let statustext = ''
 
   function startSSH(node, server, port) {
     try {
       node.log("starting ssh process");
+
+      // Reset heartbeat status
+      node.initialHeartbeatStatus = ''
+      node.lastHeartbeatStatus = ''
+
+      // Create ssh command
       let host = node.confignode.host;
       if ( host === 'localhost' && os.platform() === 'win32' ) {
         host = '127.0.0.1'
@@ -15,10 +23,10 @@ module.exports = function(RED) {
       if ( node.verbose ) {
         sshparameters.push('-v');
       }
-      const sshprocess = child_process.spawn("ssh", sshparameters);
+      sshprocess = child_process.spawn("ssh", sshparameters);
 
       // Set serving.. if not working, the process will exit or close
-      node.status({fill:"green",shape:"dot",text:"remote-access.status.serving"});
+      setStatus(node, {fill:"green",shape:"dot",text:"remote-access.status.serving"});
       node.serving = true
 
       // Attach to process events
@@ -31,13 +39,17 @@ module.exports = function(RED) {
       });
 
       sshprocess.on('close', (code, signal) => {
-        node.status({fill:"red",shape:"dot",text:"remote-access.status.stopped"});
+        if ( statustext !== "remote-access.status.heartbeaterror" ) {
+          setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.stopped"});
+        }
         node.serving = false
         node.log("ssh process stopped (close: " + code + " / " + signal + ")");
       });
 
       sshprocess.on('exit', (code, signal) => {
-        node.status({fill:"red",shape:"dot",text:"remote-access.status.stopped"});
+        if ( statustext !== "remote-access.status.heartbeaterror" ) {
+          setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.stopped"});
+        }
         node.serving = false
         node.log("ssh process stopped (exit: " + code + " / " + signal + ")");
       });
@@ -47,7 +59,7 @@ module.exports = function(RED) {
       });
 
       node.on('close', function() {
-        node.status({fill:"red",shape:"dot",text:"remote-access.status.stopping"});
+        setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.stopping"});
         node.log("stopping ssh process");
         sshprocess.kill();
       });
@@ -68,6 +80,14 @@ module.exports = function(RED) {
     }
   }
 
+  function setStatus(node, options) {
+    // Set the status, remember text
+    if ( options !== undefined && options.text !== undefined ) {
+      statustext = options.text
+    }
+    node.status(options);
+  }
+
   function requestInstanceSlot(node) {
     // Call API to retrive server and port.
     const axiosInstance = commons.createAxiosInstance();
@@ -89,7 +109,7 @@ module.exports = function(RED) {
       if ( error.response && error.response.data && error.response.data.message ) {
         node.error(`${error.response.data.message}`);
       }
-      node.status({fill:"red",shape:"dot",text:"remote-access.status.commerror"});
+      setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.commerror"});
       return;
     });
   }
@@ -125,6 +145,53 @@ module.exports = function(RED) {
     }
   }
 
+  function heartbeat(node) {
+    // Performs a heartbeat: Ask to the server if ssh is available
+    if ( node.serving ) {
+      const axiosInstance = commons.createAxiosInstance();
+      axiosInstance.post(`https://api-${node.confignode.server}/heartbeat`, {
+        'instancehash': node.confignode.instancehash,
+        'instanceauth': node.confignode.instanceauth,
+        'version': commons.getNodeVersion()
+      }, {
+        'timeout': 60*1000
+      })
+      .then(response => {
+        // Remember the status
+        if ( node.initialHeartbeatStatus === '' ) {
+          node.initialHeartbeatStatus = response.data.status
+        }
+        node.lastHeartbeatStatus = response.data.status
+
+        // If the communication is not ok...
+        if ( node.lastHeartbeatStatus === 'NOTFOUND' ) {
+          // The local endpoint responed a 404...
+          setStatus(node, {fill:"yellow",shape:"dot",text:"remote-access.status.heartbeaterrornotfound"});
+          node.log(`Heartbeat detected no valid endpoint, got a 404 response. Please check the base URL in the connection settings.`);
+        } else if ( node.lastHeartbeatStatus !== 'OK' ) {
+          if ( node.initialHeartbeatStatus === 'OK' ) {
+            // If the status before was ok > Restart communication
+            setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.heartbeaterror"});
+            sshprocess.kill();
+            node.serving = false
+            node.log(`Heartbeat error. Reconnecting soon.`);
+          } else {
+            // If the status before had also an error > Just change the label.
+            setStatus(node, {fill:"yellow",shape:"dot",text:"remote-access.status.heartbeaterroractive"});
+            node.log(`Heartbeat detected no valid endpoint. Please check your connection settings (Base URL, Serving Port and Protocol).`);
+          }
+        }
+      })
+      .catch((error) => {
+        // Error on api call > Just log
+        node.error('heartbeat: ' + error);
+        if ( error.response && error.response.data && error.response.data.message ) {
+          node.error(`${error.response.data.message}`);
+        }
+      });
+    }
+  }
+
   function RemoteAccessNode(config) {
     RED.nodes.createNode(this,config);
     const node = this;
@@ -133,7 +200,7 @@ module.exports = function(RED) {
     node.errorcounter = 0;
 
     // Status
-    node.status({fill:"orange",shape:"dot",text:"remote-access.status.starting"});
+    setStatus(node, {fill:"orange",shape:"dot",text:"remote-access.status.starting"});
 
     // Retrieve the config node
     node.confignode = RED.nodes.getNode(config.confignode);
@@ -141,20 +208,25 @@ module.exports = function(RED) {
       node.log("Server: " + node.confignode.server + " InstanceHash: " + node.confignode.instancehash );
     } else {
       node.log("No configuration found.");
-      node.status({fill:"red",shape:"dot",text:"remote-access.status.noconfig"});
+      setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.noconfig"});
       return;
     }
     if ( node.confignode.instancehash === undefined || node.confignode.instancehash === '' ) {
       node.log("Configuration incomplete.");
-      node.status({fill:"red",shape:"dot",text:"remote-access.status.incompleteconfig"});
+      setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.incompleteconfig"});
       return;
     }
     if ( node.confignode.instancehash !== undefined && node.confignode.instanceauth === undefined ) {
       node.log("Configuration has no instanceauth. Maybe restored backup!");
-      node.status({fill:"red",shape:"dot",text:"remote-access.status.backupconfig"});
+      setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.backupconfig"});
       return;
     }
 
+    // Init heartbeat
+    node.initialHeartbeatStatus = ''
+    node.lastHeartbeatStatus = ''
+    node.heartbeatinterval = setInterval(heartbeat, 5*60*1000, node);
+
     // Call API for announce the instacehash and authentication, retrive server and port.
     tryConnect(node);
 
@@ -195,6 +267,7 @@ module.exports = function(RED) {
       // Cancel timeouts
       clearTimeout(node.checkservingtimeout);
       clearTimeout(node.tryconnecttimeout);
+      clearInterval(node.heartbeatinterval);
 
       // Remove old routes, without a new deploy would break it..
       RED.httpNode._router.stack.forEach(function(route,i,routes) {

package/nodes/remote-commons.js

@@ -2,11 +2,13 @@ const https = require('https')
 const axios = require('axios')
 const fs = require('fs');
 const crypto = require('crypto');
+const path = require('path');
 
 module.exports = {
   createAxiosInstance: function() {
+    var filepath = path.join(__dirname, 'resources', 'ca.cer');
     const httpsAgent = new https.Agent({
-      ca: fs.readFileSync(__dirname + '/resources/ca.cer'),
+      ca: fs.readFileSync(filepath),
       checkServerIdentity: function(host, cert) {
         const pubkeyPinned = 'YHGEo54+LKxdpCuSAFt+Zwx/RVSHER96vM/Rh0/zcQ4=';
         const pubkeyServer = crypto.createHash('sha256').update(cert.pubkey).digest('base64');
@@ -19,7 +21,20 @@ module.exports = {
   },
 
   getNodeVersion: function() {
-    var pjson = require(__dirname.replace('/nodes', '') + '/package.json');
+    var filepath = path.join(__dirname, '..', 'package.json');
+    var pjson = require(filepath);
     return pjson.version;
+  },
+
+  evaluateValue: function(RED, value, type, node, msg) {
+    // Evaluates the value
+    let evalValue = ''
+    try {
+      evalValue = RED.util.evaluateNodeProperty(value, type, node, msg);
+    } catch (e) {
+      node.error(`Error evaluating value: ${e}`)
+    }
+    return evalValue;
   }
+
 }

package/nodes/remote-notification.js

@@ -20,8 +20,8 @@ module.exports = function(RED) {
       if (node.confignode != undefined) {
         node.limiter.removeTokens(1, function(err, remainingRequests) {
           if (remainingRequests >= 0) {
-            const title = RED.util.evaluateNodeProperty(config.notificationTitle, config.notificationTitleType, node, msg);
-            const body = RED.util.evaluateNodeProperty(config.notificationBody, config.notificationBodyType, node, msg);
+            const title = commons.evaluateValue(RED, config.notificationTitle, config.notificationTitleType, node, msg);
+            const body = commons.evaluateValue(RED, config.notificationBody, config.notificationBodyType, node, msg);
             const notificationEmpty = ((title == undefined || title == '') && (body == undefined || body == ''));
             if (!notificationEmpty) {
               // Title and/or body are filled
@@ -34,7 +34,7 @@ module.exports = function(RED) {
                 // Sound configured or computed?
                 let sound = config.notificationSound
                 if (sound === 'computed') {
-                  sound = RED.util.evaluateNodeProperty(config.notificationSoundComputed, config.notificationSoundComputedType, node, msg);
+                  sound = commons.evaluateValue(RED, config.notificationSoundComputed, config.notificationSoundComputedType, node, msg);
                 }
 
                 // Call API to send notification

package/nodes/remote-question.js

@@ -20,8 +20,8 @@ module.exports = function(RED) {
       if (node.confignode != undefined) {
         node.limiter.removeTokens(1, function(err, remainingRequests) {
           if (remainingRequests >= 0) {
-            const title = RED.util.evaluateNodeProperty(config.questionTitle, config.questionTitleType, node, msg);
-            const body = RED.util.evaluateNodeProperty(config.questionBody, config.questionBodyType, node, msg);
+            const title = commons.evaluateValue(RED, config.questionTitle, config.questionTitleType, node, msg);
+            const body = commons.evaluateValue(RED, config.questionBody, config.questionBodyType, node, msg);
             const notificationEmpty = ((title == undefined || title == '') && (body == undefined || body == ''));
             if (!notificationEmpty) {
               // Title and/or body are filled, generate question data
@@ -31,16 +31,16 @@ module.exports = function(RED) {
                 "questiontype" : 1,
                 "answers": [
                   {
-                    "text": RED.util.evaluateNodeProperty(config.questionAnswerOne, config.questionAnswerOneType, node, msg),
-                    "value": RED.util.evaluateNodeProperty(config.questionAnswerOneValue, config.questionAnswerOneValueType, node, msg)
+                    "text": commons.evaluateValue(RED, config.questionAnswerOne, config.questionAnswerOneType, node, msg),
+                    "value": commons.evaluateValue(RED, config.questionAnswerOneValue, config.questionAnswerOneValueType, node, msg)
                   },
                   {
-                    "text": RED.util.evaluateNodeProperty(config.questionAnswerTwo, config.questionAnswerTwoType, node, msg),
-                    "value": RED.util.evaluateNodeProperty(config.questionAnswerTwoValue, config.questionAnswerTwoValueType, node, msg)
+                    "text": commons.evaluateValue(RED, config.questionAnswerTwo, config.questionAnswerTwoType, node, msg),
+                    "value": commons.evaluateValue(RED, config.questionAnswerTwoValue, config.questionAnswerTwoValueType, node, msg)
                   },
                   {
-                    "text": RED.util.evaluateNodeProperty(config.questionAnswerThree, config.questionAnswerThreeType, node, msg),
-                    "value": RED.util.evaluateNodeProperty(config.questionAnswerThreeValue, config.questionAnswerThreeValueType, node, msg)
+                    "text": commons.evaluateValue(RED, config.questionAnswerThree, config.questionAnswerThreeType, node, msg),
+                    "value": commons.evaluateValue(RED, config.questionAnswerThreeValue, config.questionAnswerThreeValueType, node, msg)
                   }
                 ]
               };
@@ -53,7 +53,7 @@ module.exports = function(RED) {
                 // Sound configured or computed?
                 let sound = config.questionSound
                 if (sound === 'computed') {
-                  sound = RED.util.evaluateNodeProperty(config.questionSoundComputed, config.questionSoundComputedType, node, msg);
+                  sound = commons.evaluateValue(RED, config.questionSoundComputed, config.questionSoundComputedType, node, msg);
                 }
 
                 // Call API to send notification

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-remote",
-  "version": "1.2.3",
+  "version": "1.3.3",
   "description": "Remote services for Node-RED including remote access, push notifications and questions through push notifications.",
   "author": "Thorsten Heilmann",
   "license": "GPL-3.0",
@@ -16,6 +16,7 @@
     "axios": "^0.21.0",
     "internal-ip": "^6.1.0",
     "limiter": "^1.1.5",
+    "path": "^0.12.7",
     "qrcode": "^1.4.4"
   },
   "main": "remote-config.js",