Merge pull request #38 from boschrexroth/bugfix/subscription_port

Bugfix/subscription port

Author: krauskopf

.vscode/launch.json

@@ -9,6 +9,7 @@
           "type": "node",
           "request": "launch",
           "program": "C:/Apps/node-red-1.2.6/node-red/red.js",
+          "runtimeArgs": ["--preserve-symlinks"],
           "env": {
             "DEBUG": "ctrlxcore,ctrlxcore:*",
             "DEBUG_COLORS": "true"

README.md

@@ -79,21 +79,23 @@ Any use of the source code and related documents of this repository in applicati
                       Support custom port after hostname. E.g. 'localhost:8443'.
 * 2020-10-01: 1.8.1 - fix: automatic reconnect when device was not available on start of flow.
 * 2021-02-22: 1.8.2 - Switched to ctrlX Data Layer API version v2 which is only available with AutomationCore 1.8.0 or newer.
-                      Introduced new setting to request node, which allows to set payload format to return only `value` or `value` and `type`.
+                      Introduced new setting to request node, which allows to set payload format to return only 'value' or 'value' and 'type'.
 * 2021-03-10: 1.8.3 - Internal improvements for more compliant URI encoding of http requests.
 * 2021-05-07: 1.8.4 - fix: allow to make a write without arguments (msg.payload = null). E.g. for 'diagnosis/confirm/error'.
-* 2021-05-25: 1.8.5 - fix: make `BROWSE`requests to support the payload property `value only`.
+* 2021-05-25: 1.8.5 - fix: make 'BROWSE' requests to support the payload property 'value only'.
 * 2021-05-28: 1.8.6 - feat: make path tree view selection in property window to automatically expand to current path.
-                      fix: make subscribe node to emit an initial `msg` after deploy, even if value does not change.
+                      fix: make subscribe node to emit an initial 'msg' after deploy, even if value does not change.
 * 2021-06-29: 1.8.7 - fix: writing strings with non-ASCII symbols (e.g. 'ü') resulted in DL_TYPE_MISMATCH.
 * 2021-07-04: 1.8.8 - fix: give each of the subscribe nodes his own counter to show in the status text.
                       fix: allow to make a create without arguments (msg.payload = null). E.g. for '/motion/axs/<axs_name>/cmd/reset'.
-* 2021-09-20: 1.8.9 - fix: read with argument failed with error DL_TYPE_MISMATCH.
+* 2021-09-20: 1.8.9 - fix: read with argument failed with error 'DL_TYPE_MISMATCH'.
 * 2021-10-19: 1.8.10 - fix: support 64bit integer as BigInt to prevent rounding errors on big integer values.
 * 2021-10-22: 1.8.11 - fix: prevent "Failed login attempts" after flow gets redeployed with correct credentials (Bug392030).
 * 2021-10-22: 1.8.12 - fix: make subscription to properly report error and reconnect when authorization token expires (Bug405282).
 * 2022-01-27: 1.8.13 - refactor: update dependency versions. No functional change.
 * 2022-03-02: 1.8.14 - fix: improve diagnostics for misconfigured subscriptions. E.g. when a single node of a subscription is missing (Bug449366).
+* 2022-03-14: 1.8.15 - fix: make subscribe node useable on other ports than 443 (Bug457112).
+                       fix: remove an uncaught exception which was introduced with version 1.8.14 (Bug454078).
 
 ## About
 

lib/CtrlxCore.js

@@ -807,7 +807,7 @@ class CtrlxCore {
       }
 
       // The subscription is encapsulated in a separate object.
-      let sub = new CtrlxDatalayerSubscription(this._hostname, this._servername, this._tokenType + ' ' + this._token, paths, publishIntervalMs);
+      let sub = new CtrlxDatalayerSubscription(this._hostname, this._port, this._servername, this._tokenType + ' ' + this._token, paths, publishIntervalMs);
 
       sub.open((err, subscription) => {
         if (err) {

lib/CtrlxDatalayerSubscription.js

@@ -41,7 +41,7 @@ const debugUpdate = require('debug')('ctrlxcore:datalayer:subscription:update');
  * This class works as a facade around the EventSource interface (https://www.w3.org/TR/eventsource/).
  *
  * @example <caption>Example how to subscribe and print the updates.</caption>
- * let subscription = new CtrlxDatalayerSubscription('192.168.1.1', 'Bearer ABCD1234', ['framework/metrics/system/cpu-utilisation-percent']);
+ * let subscription = new CtrlxDatalayerSubscription('192.168.1.1', 443, '', 'Bearer ABCD1234', ['framework/metrics/system/cpu-utilisation-percent']);
  *
  * subscription.open((err, sub) => {
  *   if (err) throw err;
@@ -58,19 +58,21 @@ class CtrlxDatalayerSubscription extends EventEmitter {
   /**
    * Creates an instance of CtrlxDatalayerSubscription.
    *
-   * @param {string} hostname - The hostname of the device. Can also be a ipv4-, ipv6-address or 'localhost'.
+   * @param {string} hostname - The hostname of the device. Can also be an ipv4-, ipv6-address or 'localhost'.
+   * @param {number} port - The port number of the device, where the web server is listening. Usually 443.
    * @param {string} servername - The TLS servername of the device as defined by RFC 6066. Empty string in case of an ip-address.
    * @param {string} authorization - The authorization token string for the http header.
    * @param {string[]} paths - An array of node addresses to subscribe to.
    * @param {number|undefined} publishIntervalMs - The interval in milliseconds that is requested as update interval from the server.
    *                                               If omitted, then the server will chose a default value (usually 1s).
    * @memberof CtrlxCore
    */
-  constructor(hostname, servername, authorization, paths, publishIntervalMs = undefined) {
+  constructor(hostname, port = 443, servername = '', authorization, paths, publishIntervalMs = undefined) {
     debug(`constructor(${hostname}, ...)`);
     super();
 
     this._hostname = hostname;
+    this._port = port;
     this._servername = servername;
     this._authorization = authorization;
     this._nodes = paths;
@@ -109,7 +111,7 @@ class CtrlxDatalayerSubscription extends EventEmitter {
     }
 
     // Arguments are given as query parameter.
-    let url = `https://${this._hostname}:443/automation/api/v2/events?nodes=${this._nodes}`;
+    let url = `https://${this._hostname}:${this._port}/automation/api/v2/events?nodes=${this._nodes}`;
     if (typeof this._publishIntervalMs !== 'undefined') {
       url += `&publishIntervalMs=${this._publishIntervalMs}`;
     }
@@ -197,7 +199,7 @@ class CtrlxDatalayerSubscription extends EventEmitter {
       this._es.onerror = (e) => {
         debug(`onerror(${e.type})`);
 
-        if (e.data !== 'undefined') {
+        if (typeof e.data !== 'undefined') {
 
           // The error is of type 'MessageEvent'. This means, that not the stream has an error, but
           // an 'error' message is send over the stream (in contrast to an 'update' message if everything is fine).

package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-red-contrib-ctrlx-automation",
-    "version": "1.8.14",
+    "version": "1.8.15",
     "description": "Node-RED nodes for ctrlX AUTOMATION",
     "repository": {
         "type": "git",

test/CtrlxCore.events.test.js

@@ -53,7 +53,7 @@ describe('CtrlxCoreDataLayerEvents', function() {
   let testServer;
   before(function(done) {
     testServer = new CtrlxMockup();
-    testServer.startServer('localhost', 443, () => {
+    testServer.startServer('localhost', CtrlxCore._parseHost(getHostname()).port, () => {
       done();
     });
   });
@@ -256,3 +256,88 @@ describe('CtrlxCoreDataLayerEvents', function() {
   });
 
 });
+
+
+
+/*
+ * This test group contains test cases for the subcription mechanism of the Data Layer
+ * which is mapped to server sent events, but run on a different port.
+ */
+describe('CtrlxCoreDataLayerEvents - With different port', function() {
+
+  function getHostname() {
+    return process.env.TEST_HOSTNAME || '127.0.0.1:8443';
+  }
+  function getUsername() {
+    return process.env.TEST_USERNAME || 'boschrexroth';
+  }
+  function getPassword() {
+    return process.env.TEST_PASSWORD || 'boschrexroth';
+  }
+
+  let testServer;
+  before(function(done) {
+    testServer = new CtrlxMockup();
+    testServer.startServer('localhost', 8443, () => {
+      done();
+    });
+  });
+
+  after(function(done) {
+    this.timeout(10000);
+    testServer.stopServer(() => {
+      done();
+    });
+  });
+
+
+  describe('CtrlxCoreSubscription: Subscription Interface', function() {
+
+
+    it('should subscribe to a single node', async function() {
+      this.timeout(5000);
+      let ctrlx = new CtrlxCore(getHostname(), getUsername(), getPassword());
+
+      try {
+
+        await ctrlx.logIn();
+
+        // Create the subscription
+        let subscription = await ctrlx.datalayerSubscribe(['framework/metrics/system/cpu-utilisation-percent']);
+        expect(subscription).to.exist;
+
+        // Check and count the updates
+        let numReceived = 0;
+        subscription.on('update', (data) => {
+
+          expect(data.node).to.be.a('string').eql('framework/metrics/system/cpu-utilisation-percent');
+          expect(data.timestamp).to.be.a('number');
+          expect(data.type).to.be.a('string').eql('double');
+          expect(data.value).to.be.a('number').within(0, 100);
+
+          const timestamp = CtrlxDatalayerSubscription.convertTimestamp2Date(data.timestamp);
+          const deltaTime = Math.abs(timestamp.valueOf() - Date.now());
+          expect(deltaTime).to.be.below(500);
+
+          //console.log(`update: node=${data.node} value=${data.value} timestampUTC=${timestamp.toISOString()}`);
+          numReceived++;
+        });
+
+        // Give some time to receive the updates
+        await sleep(3000);
+        subscription.close();
+
+        // Check for the expected number of updates
+        expect(numReceived).to.be.greaterThan(1);
+
+      } catch(err) {
+        console.error('Housten we are in trouble: ' + err);
+        throw err;
+      } finally {
+        await ctrlx.logOut();
+      }
+    });
+
+  });
+
+});

test/CtrlxCore.nodes.test.js

@@ -52,7 +52,7 @@ describe('CtrlxCoreDataLayerNodes', function() {
   let testServer;
   before(function(done) {
     testServer = new CtrlxMockup();
-    testServer.startServer('localhost', 443, () => {
+    testServer.startServer('localhost', CtrlxCore._parseHost(getHostname()).port, () => {
       done();
     });
   });

test/ctrlx-config.test.js

@@ -40,7 +40,7 @@ const ctrlxDatalayerRequestNode = require("../ctrlx-datalayer-request.js");
 // The the server mockup to test against
 const CtrlxMockup = require('./helper/CtrlxMockupV2')
 
-
+const CtrlxCore = require('../lib/CtrlxCore')
 const expect = require('chai').expect;
 
 
@@ -65,7 +65,7 @@ describe('ctrlx-config', function() {
   let testServer;
   before(function(done) {
     testServer = new CtrlxMockup();
-    testServer.startServer('localhost', 443, () => {
+    testServer.startServer('localhost', CtrlxCore._parseHost(getHostname()).port, () => {
       done();
     });
   });

test/ctrlx-datalayer-subscribe.test.js

@@ -42,8 +42,9 @@ const ctrlxDatalayerSubscribeNode = require("../ctrlx-datalayer-subscribe.js");
 const CtrlxMockup = require('./helper/CtrlxMockupV2')
 const CtrlxDatalayerSubscription = require('../lib/CtrlxDatalayerSubscription');
 
+// Additional helper
 const expect = require('chai').expect;
-
+const CtrlxCore = require('../lib/CtrlxCore');
 
 
 
@@ -66,7 +67,7 @@ describe('ctrlx-datalayer-subscribe', function() {
   let testServer;
   before(function(done) {
     testServer = new CtrlxMockup();
-    testServer.startServer('localhost', 443, () => {
+    testServer.startServer('localhost', CtrlxCore._parseHost(getHostname()).port, () => {
       done();
     });
   });
@@ -198,7 +199,7 @@ describe('ctrlx-datalayer-subscribe', function() {
           expect(numReceived).to.be.greaterThan(8);
           done();
           s1.subscription.close();
-        }, 1000);
+        }, 1200);
       });
     });