node-red-contrib-remote 2.0.4 → 3.0.0

package/README.md

@@ -29,6 +29,17 @@ There is a help page describing how the the nodes work together and how to conne
 [Hilfe in Deutsch](https://www.remote-red.com/de/hilfe/)
 
 
+## Remote-RED Partner Programm
+
+If you want to scale up, have a look at the Remote-RED Partner Programm. It is made for everyone who does not only use Node-RED for themselves, but builds solutions for others:
+
+- developers of own IoT projects (Node-RED and also pure Linux projects)
+- installers of smart home and control systems
+- manufacturers and platforms looking for a white label solution
+
+As a partner you offer your customers encrypted access to their dashboards, push notifications and geofencing triggers - without developing your own app and without running your own server infrastructure.
+
+
 ## Contact
 
 You will find more information on [www.remote-red-com](https://www.remote-red.com). You can contact me by mail through info@remote-red.com.
@@ -36,11 +47,17 @@ You will find more information on [www.remote-red-com](https://www.remote-red.co
 
 ## Version History
 
+Version 3.0.0
+- Support for the Remote-RED Partner Programm
+
+Version 2.0.5
+- Improved reconnect for Starlink users
+
 Version 2.0.4
--  Fix for 'No endpoint detected' message
+- Fix for 'No endpoint detected' message
 
 Version 2.0.3
--  More stable handling of connection losses
+- More stable handling of connection losses
 
 Version 2.0.2
 - Crash on Node-RED startup fixed, extended error reporting

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

@@ -16,7 +16,13 @@
           "region_dev": "Entwicklung",
           "region_desc": "Der Standort kann nicht mehr geändert werden, sobald eine App registriert wurde.",
           "change_info": "Damit Änderungen aktiv werden führe einen Redeploy durch. Starte danach die App neu oder aktualisiere die Liste der Instanzen, indem Du die Liste nach unten ziehst.",
-          "backup_info": "Diese Konfig-Node wurde aus einem Backup wiederhergestellt. Daher sind sicherheitsrelevante Informationen nicht enthalten. Bitte löschen diese Konfig-Node (über das Zahnrad Icon rechts oben) und die Verbindungen in Deinen Remote-RED Apps. Lege eine neue Konfig-Node an, verbinde diese neu mit den Apps und wähle diese neue Konfig-Node in allen davon abhängigen Nodes aus."
+          "backup_info": "Diese Konfig-Node wurde aus einem Backup wiederhergestellt. Daher sind sicherheitsrelevante Informationen nicht enthalten. Bitte löschen diese Konfig-Node (über das Zahnrad Icon rechts oben) und die Verbindungen in Deinen Remote-RED Apps. Lege eine neue Konfig-Node an, verbinde diese neu mit den Apps und wähle diese neue Konfig-Node in allen davon abhängigen Nodes aus.",
+          "partner_toggle": "Ich bin Teilnehmer am Remote-RED Partner Programm",
+          "customerhash": "CustomerHash",
+          "customerkey": "CustomerKey",
+          "customerkey_desc": "Der CustomerKey wird nur einmalig zur Registrierung verwendet und nicht gespeichert.",
+          "customerreference": "Kunden-Referenz (optional)",
+          "customerreference_desc": "Z.B. Seriennummer oder Endkunden-Nummer, max. 100 Zeichen. Dient der Zuordnung dieser Instanz im Partner-Portal und ist nachträglich nicht mehr änderbar."
         },
         "actions" : {
           "register_app": "Remote-RED App verbinden",
@@ -34,6 +40,12 @@
           "privacypolicyurl": "https://www.remote-red.com/de/datenschutz",
           "termsurl": "https://www.remote-red.com/de/nutzung"
         },
+        "partner": {
+          "title": "Remote-RED Partner Programm",
+          "info1": "Das Remote-RED Partner Programm richtet sich an Hersteller und Integratoren, die Remote-RED in eigene Produkte einbetten und über das Remote-RED Partner Portal eigene Kontingente an Instanzen verwalten und abrechnen. Falls Du Teilnehmer bist, kannst Du hier Deinen CustomerHash und CustomerKey eintragen, um diese Instanz Deinem Partner-Konto zuzuordnen. ",
+          "info1_readonly": "Diese Instanz ist bereits registriert und einem Partner-Konto zugeordnet. Die Zuordnung kann nachträglich nicht mehr geändert werden. Verwaltet wird die Instanz im Remote-RED Partner Portal. ",
+          "link": "Zum Remote-RED Partner Portal"
+        },
         "help": {
           "title": "Hilfe",
           "para1": "Pro Access-Node erstellt Du eine entsprechende Config-Node. In dieser wird hinterlegt, mit welchem Host, Port und URL die Verbindung stattfindet. Die Vorgabewerte zeigen als Beispiel das Dashboard. Es ist aber auch möglich weitere Seiten aus dem lokalen Netzwerk zu konfigurieren, insofern der Server auf dem Node-RED installiert ist darauf zugreifen kann.",

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

@@ -16,7 +16,13 @@
           "region_dev": "Development host",
           "region_desc": "The region can´t be changed after registering an app.",
           "change_info": "To apply changes, first carry out a redeploy. Then restart the app or refresh the list of instances by dragging the list down.",
-          "backup_info": "This config node was restored from a backup. Therefore security relevant information are not included. Please delete this config-node (via the gear icon at the top right) and the connections in your Remote-RED apps. Create a new config-node, connect it to the apps and select this new config node in all dependent nodes."
+          "backup_info": "This config node was restored from a backup. Therefore security relevant information are not included. Please delete this config-node (via the gear icon at the top right) and the connections in your Remote-RED apps. Create a new config-node, connect it to the apps and select this new config node in all dependent nodes.",
+          "partner_toggle": "I'm a participant of the Remote-RED Partner Program",
+          "customerhash": "CustomerHash",
+          "customerkey": "CustomerKey",
+          "customerkey_desc": "The CustomerKey is only used once during registration and is not stored.",
+          "customerreference": "Customer reference (optional)",
+          "customerreference_desc": "E.g. serial number or end customer number, max. 100 characters. Used to identify this instance in the Partner Portal and cannot be changed afterwards."
         },
         "actions" : {
           "register_app": "Connect Remote-RED App",
@@ -34,6 +40,12 @@
           "privacypolicyurl": "https://www.remote-red.com/en/privacypolicy",
           "termsurl": "https://www.remote-red.com/en/terms"
         },
+        "partner": {
+          "title": "Remote-RED Partner Program",
+          "info1": "The Remote-RED Partner Program is aimed at manufacturers and integrators who embed Remote-RED into their own products and manage and bill their own instance quotas via the Remote-RED Partner Portal. If you are a participant, you can enter your CustomerHash and CustomerKey here to assign this instance to your partner account. ",
+          "info1_readonly": "This instance is already registered and assigned to a partner account. The assignment cannot be changed afterwards. The instance is managed in the Remote-RED Partner Portal. ",
+          "link": "Go to the Remote-RED Partner Portal"
+        },
         "help": {
           "title": "Help",
           "para1": "For each Access Node you create a corresponding Config Node. In this Config Node you define with which host, port and URL the connection will be established. The default values shows the dashboard as an example. It is also possible to configure other pages from the local network, as long as the Node-RED server can access them.",

package/nodes/remote-access.js

@@ -15,8 +15,7 @@ module.exports = function(RED) {
         await killSSHProcess(node);
       }
 
-      // Reset heartbeat status
-      node.initialHeartbeatStatus = ''
+      // Reset heartbeat status for current tunnel
       node.lastHeartbeatStatus = ''
 
       // Create ssh command
@@ -76,7 +75,7 @@ module.exports = function(RED) {
       });
     } catch (e) {
       // TODO: Error: socket hang up
-      node.error('startSSH error: ' + error);
+      node.error('startSSH error: ' + e);
     }
   }
 
@@ -170,6 +169,18 @@ module.exports = function(RED) {
     });
   }
 
+  function scheduleCheckServing(node, delay) {
+    // Only one checkServing timer per node: cancel a pending one before scheduling
+    clearTimeout(node.checkservingtimeout);
+    node.checkservingtimeout = setTimeout(checkServing, delay, node);
+  }
+
+  function scheduleTryConnect(node, delay) {
+    // Only one tryConnect timer per node: cancel a pending one before scheduling
+    clearTimeout(node.tryconnecttimeout);
+    node.tryconnecttimeout = setTimeout(tryConnect, delay, node);
+  }
+
   async function tryConnect(node) {
     // Request new instance slot and connect ssh
     try {
@@ -179,7 +190,7 @@ module.exports = function(RED) {
     }
 
     // Create timer to check if ssh process still serving in 10 seconds
-    node.checkservingtimeout = setTimeout(checkServing, 1000*10, node);
+    scheduleCheckServing(node, 1000*10);
   }
 
   function checkServing(node) {
@@ -195,13 +206,13 @@ module.exports = function(RED) {
       } else if (node.errorcounter >= 4) {
         interval = 1000*50;
       }
-      node.tryconnecttimeout = setTimeout(tryConnect, interval, node);
+      scheduleTryConnect(node, interval);
     } else {
       // Running > Reset error counter
       node.errorcounter = 0;
 
       // Schedule timer to check if still serving
-      node.checkservingtimeout = setTimeout(checkServing, 1000*10, node);
+      scheduleCheckServing(node, 1000*10);
     }
   }
 
@@ -218,30 +229,39 @@ module.exports = function(RED) {
       })
       .then(response => {
         // Remember the status
-        if ( node.initialHeartbeatStatus === '' ) {
-          node.initialHeartbeatStatus = response.data.status
-        }
         node.lastHeartbeatStatus = response.data.status
 
         // Based on the status...
         if ( node.lastHeartbeatStatus === 'OK' ) {
-          node.initialHeartbeatStatus = node.lastHeartbeatStatus; // Wenn es jetzt OK ist, zählt es auch wie initial OK
+          // Successful heartbeat
+          node.configurationValidated = true;   // Configuration is definitely OK
+          node.initialRetryCount = 0;           // Reset retry counter on success
           setStatus(node, {fill:"green",shape:"dot",text:"remote-access.status.serving"});
         } else if ( node.lastHeartbeatStatus === 'NOTFOUND' ) {
-          // The local endpoint responed a 404...
+          // The local endpoint responded with 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
+        } else {
+          // Heartbeat error - decide whether to reconnect
+          if ( node.configurationValidated === true ) {
+            // Configuration was validated before → Reconnect
             setStatus(node, {fill:"red",shape:"dot",text:"remote-access.status.heartbeaterror"});
             node.log(`Heartbeat error. Reconnecting soon.`);
             // Set serving to false, checkServing will trigger reconnect and startSSH will kill old process
             node.serving = false;
           } 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).`);
+            // Never worked yet - check if still in startup phase
+            if ( node.initialRetryCount < 3 ) {
+              // Still in startup phase - give it more chances (after reboot with slow network, Starlink reconnect, etc.)
+              node.initialRetryCount++;
+              setStatus(node, {fill:"yellow",shape:"dot",text:"remote-access.status.heartbeaterror"});
+              node.log(`Heartbeat error during startup (attempt ${node.initialRetryCount}/3). Reconnecting soon.`);
+              node.serving = false;  // Trigger reconnect
+            } else {
+              // Too many failed attempts > Misconfiguration > NO reconnect
+              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).`);
+            }
           }
         }
       })
@@ -359,8 +379,9 @@ module.exports = function(RED) {
     }
         
     // Init heartbeat
-    node.initialHeartbeatStatus = ''
-    node.lastHeartbeatStatus = ''
+    node.configurationValidated = false;  // Was the configuration EVER successfully validated?
+    node.lastHeartbeatStatus = '';
+    node.initialRetryCount = 0;           // Counts retry attempts during startup phase
     node.heartbeatinterval = setInterval(heartbeat, 5*60*1000, node);
 
     // Call API for announce the instacehash and authentication, retrive server and port.

package/nodes/remote-config.html

@@ -11,8 +11,7 @@
       instancehash: {value:""},
       server: {value:""},
       region: {value:"de"},
-      customerhash: {value:""},
-      customerkey: {value:""}
+      customerhash: {value:""}
     },
     credentials: {
       instanceauth: {type:"text"}
@@ -26,10 +25,32 @@
       document.getElementById('remoteInstanceInputs').style.visibility = 'collapse';
 
       // Deactivate region if already registered
-      if (document.getElementById('node-config-input-instancehash').value != "") {
+      const alreadyRegistered = document.getElementById('node-config-input-instancehash').value != "";
+      if (alreadyRegistered) {
         document.getElementById('node-config-input-region').disabled = true;
       }
 
+      // Partner-Bereich: aufklappbar, Toggle togglet Sichtbarkeit
+      document.getElementById('node-config-input-showpartner').onchange = function() {
+        togglePartnerSection(this.checked);
+      };
+      // Bereits ein customerhash gesetzt? Dann direkt aufgeklappt anzeigen.
+      const hasCustomerhash = document.getElementById('node-config-input-customerhash').value != "";
+      if (hasCustomerhash) {
+        document.getElementById('node-config-input-showpartner').checked = true;
+      }
+      togglePartnerSection(hasCustomerhash);
+
+      // Instanz schon registriert? Partner-Zuordnung ist dann nicht mehr änderbar.
+      if (alreadyRegistered) {
+        document.getElementById('node-config-input-showpartner').disabled = true;
+        document.getElementById('node-config-input-customerhash').disabled = true;
+        document.getElementById('customerkeyRow').style.display = 'none';
+        document.getElementById('customerreferenceRow').style.display = 'none';
+        document.getElementById('partnerInfoEditable').style.display = 'none';
+        document.getElementById('partnerInfoReadonly').style.display = '';
+      }
+
       // Insert legal link urls
       setTimeout(insertLinkUrls, 250);
 
@@ -82,6 +103,18 @@
     document.getElementById('legalTermsLink').setAttribute('href', document.getElementById('terms_url_template').innerHTML);
   }
 
+  function togglePartnerSection(show) {
+    // Shows/hides the Remote-RED Partner Programm section
+    const section = document.getElementById('partnerSection');
+    if (show) {
+      section.style.removeProperty('visibility');
+      section.style.removeProperty('max-height');
+    } else {
+      section.style.visibility = 'collapse';
+      section.style.maxHeight = '0px';
+    }
+  }
+
   function updateLocalhostInfo() {
     // Gives infos about localhost, maybe hides it.
     if (document.getElementById('node-config-input-host').value.toLowerCase() == 'localhost') {
@@ -103,7 +136,18 @@
   function registerInstance() {
     // Request InstanceHash when empty
     const region = document.getElementById('node-config-input-region').value;
-    $.getJSON('contrib-remote/requestInstanceHash/' + region + '/0/0', function(data) {
+    const customerhash = document.getElementById('node-config-input-customerhash').value || '0';
+    const customerkey = document.getElementById('node-config-input-customerkeyinput').value || '0';
+    const customerreference = document.getElementById('node-config-input-customerreferenceinput').value || '';
+    let requestUrl = 'contrib-remote/requestInstanceHash/' + region + '/' + encodeURIComponent(customerhash) + '/' + encodeURIComponent(customerkey);
+    if (customerreference !== '') {
+      requestUrl += '?customerreference=' + encodeURIComponent(customerreference);
+    }
+    $.getJSON(requestUrl, function(data) {
+      // CustomerKey und CustomerReference werden nur einmalig zur Registrierung benoetigt - danach aus dem UI entfernen.
+      document.getElementById('node-config-input-customerkeyinput').value = '';
+      document.getElementById('node-config-input-customerreferenceinput').value = '';
+
       if ( data.error == undefined ) {
         // Fill UI
         document.getElementById('node-config-input-instancehash').value = data.instancehash;
@@ -267,6 +311,41 @@
   </div>
   <label><i class="fa fa-info-circle"></i> <span data-i18n="remote-config.label.region_desc"></label>
 
+  <br>
+  <br>
+  <div class="form-row">
+    <input type="checkbox" id="node-config-input-showpartner" style="display:inline-block; width:22px; vertical-align:top;">
+    <label for="node-config-input-showpartner" style="width:auto;" data-i18n="remote-config.label.partner_toggle"></label>
+  </div>
+  <div id="partnerSection" style="visibility: collapse; max-height: 0px;">
+    <div id="partnerInfo" style="max-width: 460px; border-width: 1px; border-style: dashed; border-color: #666; padding: 10px; margin-bottom: 10px;">
+      <label data-i18n="remote-config.partner.title" style="font-weight: bold;"></label>
+      <label id="partnerInfoEditable" data-i18n="remote-config.partner.info1"></label>
+      <label id="partnerInfoReadonly" data-i18n="remote-config.partner.info1_readonly" style="display: none;"></label>
+      <a id="partnerPortalLink" href="https://portal.remote-red.com" target="_blank"><i><label data-i18n="remote-config.partner.link" style="display: inline; color: #AD1626;"></label></i></a>
+    </div>
+    <div class="form-row">
+      <label for="node-config-input-customerhash"><span data-i18n="remote-config.label.customerhash"></span></label>
+      <input type="text" id="node-config-input-customerhash" placeholder="">
+    </div>
+    <div id="customerkeyRow">
+      <div class="form-row">
+        <label for="node-config-input-customerkeyinput"><span data-i18n="remote-config.label.customerkey"></span></label>
+        <input type="password" id="node-config-input-customerkeyinput" placeholder="">
+      </div>
+      <label><i class="fa fa-info-circle"></i> <span data-i18n="remote-config.label.customerkey_desc"></label>
+      <br>
+    </div>
+    <div id="customerreferenceRow">
+      <div class="form-row">
+        <label for="node-config-input-customerreferenceinput"><span data-i18n="remote-config.label.customerreference"></span></label>
+        <input type="text" id="node-config-input-customerreferenceinput" placeholder="" maxlength="100">
+      </div>
+      <label><i class="fa fa-info-circle"></i> <span data-i18n="remote-config.label.customerreference_desc"></label>
+      <br>
+    </div>
+  </div>
+
   <br>
   <button id="registerRemoteAppButton" type="button" class="red-ui-button" onclick="registerButtonClicked()">
     <span id="registerRemoteAppButtonText" data-i18n="remote-config.actions.register_app">

package/nodes/remote-config.js

@@ -5,6 +5,7 @@ module.exports = function(RED) {
   const dns = require('dns'); 
   const dnsPromises = dns.promises;
   const fs = require('fs');
+  const path = require('path');
   var QRCode = require('qrcode');
 
   function RemoteConfigNode(n) {
@@ -18,6 +19,7 @@ module.exports = function(RED) {
     this.server = n.server;
     this.instanceauth = this.credentials.instanceauth;
     this.region = n.region;
+    this.customerhash = n.customerhash;
   }
 
   RED.nodes.registerType("remote-config",RemoteConfigNode, {
@@ -53,14 +55,12 @@ module.exports = function(RED) {
             .then(res => {
               const v4 = res.some(e => e.family === 4);
               const v6 = res.some(e => e.family === 6);
-              testResults.push({type: 'DNS', test: `DNS lookup ${host}`, result: getErrorMessage(error)});
+              testResults.push({type: 'DNS', test: `DNS lookup ${host}`, result: `OK (${v4 ? 'IPv4' : ''}${v4 && v6 ? ', ' : ''}${v6 ? 'IPv6' : ''})`});
               console.log(res);
-              // testResults.push({test: `DNS lookup ${host}`, result: res.alive ? `${res.time}ms` : 'Error'});
             })
             .catch(error => {
               console.log(error);
               console.log(`dns resolve ${host}: ${getErrorMessage(error)}`);
-              // console.log(error);
               testResults.push({type: 'DNS', test: `DNS lookup ${host}`, result: getErrorMessage(error)});
             });
     });
@@ -129,12 +129,19 @@ module.exports = function(RED) {
       url = 'https://contact-' + req.params.regionorserver + '.remote-red.com/instanceHashRequest';
     }
 
-    // Call API
-    axiosInstance.post(url, {
+    // Build request body; customerreference is optional (query param, backwards compatible
+    // with older CLI/node versions that never send it, PARTNER-PORTAL-KONZEPT Kap. 8.3 pt. 7)
+    const postData = {
       'customerhash': req.params.customerhash,
       'customerkey': req.params.customerkey,
       'version': commons.getNodeVersion()
-    })
+    };
+    if (req.query.customerreference !== undefined && req.query.customerreference !== '') {
+      postData.customerreference = req.query.customerreference;
+    }
+
+    // Call API
+    axiosInstance.post(url, postData)
     .then(response => {
       res.json(response.data);
     })
@@ -207,7 +214,8 @@ module.exports = function(RED) {
 
   RED.httpAdmin.get("/contrib-remote/getResouceFile/:filename", RED.auth.needsPermission('remote-config.read'), function(req,res) {
     // Sends a file as Base64
-    const fileBase64 = fs.readFileSync(__dirname + '/resources/' + req.params.filename, {encoding: 'base64'});
+    const safeName = path.basename(req.params.filename);
+    const fileBase64 = fs.readFileSync(__dirname + '/resources/' + safeName, {encoding: 'base64'});
     res.json({ 'filedata': fileBase64 });
   });
 

package/nodes/remote-notification.js

@@ -75,7 +75,7 @@ module.exports = function(RED) {
                 });
               } else {
                 // To big...
-                node.error("xxxThe message exceeded 3600 bytes. Can´t send.");
+                node.error("The message exceeded 3600 bytes. Can´t send.");
 
                 // Output status if configured so
                 if ( config.output == 2 ) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-remote",
-  "version": "2.0.4",
+  "version": "3.0.0",
   "description": "Remote-RED is an ecosystem to bring remote access, push notification and geofencing to Node-RED. There are also additional functions like directly answer on a notification and homescreen widgets.",
   "author": "Thorsten Heilmann",
   "license": "GPL-3.0",