Added automatic test workflow

Author: stefanrammo

README.md

@@ -29,16 +29,16 @@ node test/testTimeSync.js
 
 ## Usage
 
-The index.js file contains a simple logger built for the CDP Studio example case.
+The value.js file contains a simple logger built for the CDP Studio example case.
 
 1. Set up and run the Logger in CDP Studio.
 (Refer to Help → Framework - Data Logging → How to Setup Logging in Automation System)
 https://cdpstudio.com/manual/cdp/cdplogger/cdplogger-configuration-example.html
 
-2. Run the index.js file from the command line:
+2. Run the value.js file from the command line:
 
 ```bash
-node examples/index.js
+node examples/value.js
 ```
 
 For usage related to events run:

client.js

@@ -40,6 +40,10 @@ class Client {
     if (!/^wss?:\/\//.test(url)) {
       url = `ws://${url}`;
     }
+    // Same for ":17000"
+    if (!/\:17000$/.test(url)) {
+      url += ':17000';
+    }
 
     this.reqId = -1;
     this.autoReconnect = autoReconnect;
@@ -85,7 +89,7 @@ class Client {
   setEnableTimeSync(enable) {
     this.enableTimeSync = enable;
     if (!enable) {
-      // Cancel any pending time sync requests so they won’t update timeDiff later.
+      // Cancel any pending time sync requests so they won't update timeDiff later.
       for (const key in this.storedPromises) {
         this.storedPromises[key].reject(new Error("Time sync disabled"));
       }
@@ -129,7 +133,7 @@ class Client {
    *     larger data sets should be downloaded in patches.
    * - 4.0 (2024-01, CDP 4.12):
    *     - Added NodeTag support to save custom tags for logged values (e.g. Unit or Description),
-   *       accessible via the client’s API.
+   *       accessible via the client's API.
    *     - Reduced network usage by having data responses only include changes instead of repeating unchanged values.
    *     - Added support for string values and events.
    *
@@ -445,8 +449,7 @@ class Client {
    * This method checks if the tags for the specified sender are already cached. If so, it returns a 
    * resolved promise with the cached tags. Otherwise, it initializes a pending promise for the sender,
    * sends a request for the sender's tags using `_sendEventSenderTagsRequest`, and returns a promise that
-   * resolves when the tags are received. If no response is received within 5000 ms, it falls back to resolving
-   * with an empty object.
+   * resolves when the tags are received.
    *
    * @param {string} sender - The identifier of the event sender.
    * @returns {Promise<Object>} A promise that resolves with an object representing the tags for the sender.
@@ -867,7 +870,7 @@ class Client {
 
   _reqDataPoints(nodeNames, startS, endS, noOfDataPoints, limit, requestId) {
     const _getDataPoints = (nodeIds) => {
-      this._sendDataPointsRequest(nodeIds, startS, endS, requestId, limit, noOfDataPoints);
+      this._sendDataPointsRequest(nodeIds, startS, endS, requestId, noOfDataPoints, limit);
     };
 
     const rejectRequest = (error) => {
@@ -909,7 +912,7 @@ class Client {
     });
   }
 
-  _sendDataPointsRequest(nodeIds, startS, endS, requestId, limit, noOfDataPoints) {
+  _sendDataPointsRequest(nodeIds, startS, endS, requestId, noOfDataPoints, limit) {
     const container = Container.create();
     container.messageType = Container.Type.eSignalDataRequest;
     container.signalDataRequest = {

examples/event.js

@@ -3,8 +3,11 @@
 
 const cdplogger = require('../client');
 
+const { EventQueryFlags, MatchType } = cdplogger.Client;
+
+
 async function main() {
-  const client = new cdplogger.Client('ws://127.0.0.1:17000', false);
+  const client = new cdplogger.Client('127.0.0.1', true);
 
   try {
     console.log("Waiting for connection to establish...");
@@ -13,20 +16,17 @@ async function main() {
 
     // Build the query with a limit and offset
     const query = {
-      senderConditions: [
-        {
-          value: "CDPLoggerDemoApp.InvalidLicense",
-          matchType: cdplogger.Client.MatchType.Exact
-        }
-      ],
+      senderConditions: [{
+        value: "CDPLoggerDemoApp.InvalidLicense",
+        matchType: MatchType.Exact
+      }],
       dataConditions: {
-        "Text": {
-          value: "*", // Wildcard condition for Text field
-        }
+        Text: ["Invalid*"], //Wildcard is the default
+        // Multiple data conditions can be specified
       },
-      flags: cdplogger.Client.EventQueryFlags.NewestFirst | cdplogger.Client.EventQueryFlags.UseLogStampForTimeRange,
-      limit: 10,   // Request a maximum of 10 events
-      offset: 0    // Starting at the beginning
+      limit: 100,
+      offset: 0,
+      flags: EventQueryFlags.NewestFirst | EventQueryFlags.UseLogStampForTimeRange
     };
 
     console.log("Counting matching events...");

examples/index.js examples/value.jsexamples/index.js renamed to examples/value.js

@@ -1,3 +1,4 @@
+// TODO Guide on how this file was generated
 /*eslint-disable block-scoped-var, id-length, no-control-regex, no-magic-numbers, no-prototype-builtins, no-redeclare, no-shadow, no-var, sort-vars*/
 "use strict";
 

generated/containerPb.js

@@ -106,12 +106,12 @@ describe('ClientTester', () => {
     setImmediate(() => {
       expect(client._sendTimeRequest).toHaveBeenCalledWith(1);
       expect(client._sendDataPointsRequest).toHaveBeenCalledWith(
-        [0, 1],
-        1530613239.0,
-        1530613270.0,
-        2,      // The second call's requestId
-        500,    // limit
-        0       // noOfDataPoints
+        [0, 1],           // nodeIds
+        1530613239.0,     // startS
+        1530613270.0,     // endS
+        2,                // requestId
+        0,                // noOfDataPoints
+        500               // limit
       );
       done();
     });
@@ -198,7 +198,7 @@ describe('ClientTester', () => {
     client.reqId = 0;
     client.isOpen = true;
     client._sendDataPointsRequest = jest.fn();
-    client.requestDataPoints(["Output", "CPULoad"], 1531313250.0, 1531461231.0, 0, 500)
+    client.requestDataPoints(["Output", "CPULoad"], 1531313250.0, 1531461231.0, 500, 0)
       .then(dataPoints => {
         expect(dataPoints[0].timestamp).toBeCloseTo(1531313250.0);
         expect(dataPoints[0].value["Output"].min).toBeCloseTo(0.638855091434);
@@ -220,7 +220,7 @@ describe('ClientTester', () => {
         delete client.idToName[id];
       }
     }
-    client.requestDataPoints(["Output", "CPULoad"], 1531313250.0, 1531461231.0, 0, 500)
+    client.requestDataPoints(["Output", "CPULoad"], 1531313250.0, 1531461231.0, 500, 0)
       .catch(error => {
         expect(error).toBeInstanceOf(Error);
         expect(error.message).toMatch(/Output/);

test/client.test.js

@@ -171,7 +171,7 @@ async function runTest() {
 
   await runThrough(
     "requestDataPoints",
-    () => client.requestDataPoints(["Output", "CPULoad"], 1531313250.0, 1531461231.0, 500),
+    () => client.requestDataPoints(["Output", "CPULoad"], 1531313250.0, 1531461231.0, 0, 500),
     (timeSyncId, apiId) => {
       const timeResponse = {
         messageType: fakeData.Container.Type.eTimeResponse,