unetjs 2.0.10 → 3.1.0

package/README.md

@@ -63,14 +63,18 @@ The JavaScript version of the UnetSocket API allows a user to connect to a node
 
 The UnetSocket API allows a user to cache responses to parameter requests. This is useful in a scenario where the parameters aren't changing very often, and the user wants to reduce the round trip time for parameter requests.
 
+> This behaviour used to be enabled by default in unetsocket.js v2.0.0 till v2.0.10. From v3.0.0 onwards, this behaviour is **disabled** by default but a available as an option.
+
+You can use the `CachingGateway` class instead of the `Gateway` class to enable this behaviour.
+
 UnetSocket API acheives this using two mechanism, firstly, it can request ALL of the parameters from an Agent instead of just one, and then cache the responses. This is called the `greedy` mode. The greedy mode is enabled by default but can be disabled by setting the `greedy` property to `false` in the `CachingAgentID` constructor.
 
 Secondly, the UnetSocket API caches the responses to parameter requests for a limited time. If the user requests the same parameter again, the UnetSocket will return the cached response. The time to cache a response is set by the `cacheTime` property in the `CachingAgentID` constructor.
 
 ```js
-import {UnetMessages, Gateway} from 'unetjs'
-let gw = new Gateway({...});
-let nodeinfo = await gw.agentForService(Services.NODE_INFO); // returns a CachingAgentID by default.
+import {UnetMessages, CachingGateway} from 'unetjs'
+let gw = new CachingGateway({...});
+let nodeinfo = await gw.agentForService(Services.NODE_INFO); // returns a CachingAgentID
 let cLoc = nodeinfo.get('location'); // this will request all the Parameters from the Agent, and cache the responses.
 ...
 cLoc = nodeinfo.get('location', maxage=5000); // this will return the cached response if it was called within 5000ms of the original request.
@@ -79,9 +83,9 @@ cLoc = nodeinfo.get('location', maxage=0); // this will force the Gateway to req
 ```
 
 ```js
-import {UnetMessages, Gateway} from 'unetjs'
-let gw = new Gateway({...});
-let nodeinfo = await gw.agentForService(Services.NODE_INFO); // returns a CachingAgentID by default.
+import {UnetMessages, CachingGateway} from 'unetjs'
+let gw = new CachingGateway({...});
+let nodeinfo = await gw.agentForService(Services.NODE_INFO); // returns a CachingAgentID
 let nonCachingNodeInfo = await gw.agentForService(Services.NODE_INFO, false); // returns an AgentID without caching (original fjage.js functionality).
 let cLoc = nonCachingNodeInfo.get('location'); // this will request the `location` parameter from the Agent.
 ...

package/dist/cjs/unet.cjs

@@ -1,28 +1,8 @@
-/* unet.js v2.0.10 2022-07-27T05:47:35.162Z */
+/* unet.js v3.1.0 2024-01-26T11:16:07.040Z */
 
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
-function _interopNamespace(e) {
-  if (e && e.__esModule) return e;
-  var n = Object.create(null);
-  if (e) {
-    Object.keys(e).forEach(function (k) {
-      if (k !== 'default') {
-        var d = Object.getOwnPropertyDescriptor(e, k);
-        Object.defineProperty(n, k, d.get ? d : {
-          enumerable: true,
-          get: function () { return e[k]; }
-        });
-      }
-    });
-  }
-  n["default"] = e;
-  return Object.freeze(n);
-}
-
-/* fjage.js v1.10.3 */
+/* fjage.js v1.12.0 */
 
 const isBrowser =
   typeof window !== "undefined" && typeof window.document !== "undefined";
@@ -47,10 +27,13 @@ const isJsDom =
     (navigator.userAgent.includes("Node.js") ||
       navigator.userAgent.includes("jsdom")));
 
-typeof Deno !== "undefined" && typeof Deno.core !== "undefined";
+typeof Deno !== "undefined" &&
+  typeof Deno.version !== "undefined" &&
+  typeof Deno.version.deno !== "undefined";
 
 const SOCKET_OPEN = 'open';
 const SOCKET_OPENING = 'opening';
+const DEFAULT_RECONNECT_TIME$1 = 5000;       // ms, delay between retries to connect to the server.
 
 var createConnection;
 
@@ -62,17 +45,24 @@ class TCPconnector {
 
   /**
     * Create an TCPConnector to connect to a fjage master over TCP
-    * @param {Object} opts
-    * @param {String} [opts.hostname='localhost'] - ip address/hostname of the master container to connect to
-    * @param {number} opts.port - port number of the master container to connect to
+   * @param {Object} opts
+   * @param {string} [opts.hostname='localhost'] - hostname/ip address of the master container to connect to
+   * @param {number} opts.port - port number of the master container to connect to
+   * @param {string} opts.pathname - path of the master container to connect to
+   * @param {boolean} opts.keepAlive - try to reconnect if the connection is lost
+   * @param {number} [opts.reconnectTime=5000] - time before reconnection is attempted after an error
     */
   constructor(opts = {}) {
     this.url = new URL('tcp://localhost');
     let host = opts.hostname || 'localhost';
     let port = opts.port || -1;
-    this.url.hostname = opts.hostname;
-    this.url.port = opts.port;
+    this.url.hostname = host;
+    this.url.port = port;
     this._buf = '';
+    this._reconnectTime = opts.reconnectTime || DEFAULT_RECONNECT_TIME$1;
+    this._keepAlive = opts.keepAlive || true;
+    this._firstConn = true;               // if the Gateway has managed to connect to a server before
+    this._firstReConn = true;             // if the Gateway has attempted to reconnect to a server before
     this.pendingOnOpen = [];              // list of callbacks make as soon as gateway is open
     this.connListeners = [];              // external listeners wanting to listen connection events
     this._sockInit(host, port);
@@ -88,7 +78,7 @@ class TCPconnector {
   _sockInit(host, port){
     if (!createConnection){
       try {
-        Promise.resolve().then(function () { return /*#__PURE__*/_interopNamespace(require('net')); }).then(module => {
+        import('net').then(module => {
           createConnection = module.createConnection;
           this._sockSetup(host, port);
         });
@@ -97,7 +87,7 @@ class TCPconnector {
       }
     }else {
       this._sockSetup(host, port);
-    }  
+    }
   }
 
   _sockSetup(host, port){
@@ -116,18 +106,18 @@ class TCPconnector {
   }
 
   _sockReconnect(){
-    if (this._firstConn || !this.keepAlive || this.sock.readyState == SOCKET_OPENING || this.sock.readyState == SOCKET_OPEN) return;
+    if (this._firstConn || !this._keepAlive || this.sock.readyState == SOCKET_OPENING || this.sock.readyState == SOCKET_OPEN) return;
     if (this._firstReConn) this._sendConnEvent(false);
     this._firstReConn = false;
-    if(this.debug) console.log('Reconnecting to ', this.sock.remoteAddress + ':' + this.sock.remotePort);
     setTimeout(() => {
       this.pendingOnOpen = [];
-      this._sockSetup(this.sock.url);
+      this._sockSetup(this.url.hostname, this.url.port);
     }, this._reconnectTime);
   }
 
   _onSockOpen() {
     this._sendConnEvent(true);
+    this._firstConn = false;
     this.sock.on('close', this._sockReconnect.bind(this));
     this.sock.on('data', this._processSockData.bind(this));
     this.pendingOnOpen.forEach(cb => cb());
@@ -184,7 +174,7 @@ class TCPconnector {
    * @ignore
    * @param {string} s - incoming message string
    */
-  
+
   /**
    * Add listener for connection events
    * @param {function} listener - a listener callback that is called when the connection is opened/closed
@@ -215,12 +205,16 @@ class TCPconnector {
     if (this.sock.readyState == SOCKET_OPENING) {
       this.pendingOnOpen.push(() => {
         this.sock.send('{"alive": false}\n');
-        this.sock.onclose = null;
+        this.sock.removeAllListeners('connect');
+        this.sock.removeAllListeners('error');
+        this.sock.removeAllListeners('close');
         this.sock.destroy();
       });
     } else if (this.sock.readyState == SOCKET_OPEN) {
       this.sock.send('{"alive": false}\n');
-      this.sock.onclose = null;
+      this.sock.removeAllListeners('connect');
+      this.sock.removeAllListeners('error');
+      this.sock.removeAllListeners('close');
       this.sock.destroy();
     }
   }
@@ -245,11 +239,11 @@ class WSConnector {
    */
   constructor(opts = {}) {
     this.url = new URL('ws://localhost');
-    this.url.hostname = opts.hostname;      
+    this.url.hostname = opts.hostname;
     this.url.port = opts.port;
     this.url.pathname = opts.pathname;
     this._reconnectTime = opts.reconnectTime || DEFAULT_RECONNECT_TIME;
-    this._keepAlive = opts.keepAlive;
+    this._keepAlive = opts.keepAlive || true;
     this.debug = opts.debug || false;      // debug info to be logged to console?
     this._firstConn = true;               // if the Gateway has managed to connect to a server before
     this._firstReConn = true;             // if the Gateway has attempted to reconnect to a server before
@@ -335,7 +329,7 @@ class WSConnector {
    * @ignore
    * @param {string} s - incoming message string
    */
-  
+
   /**
    * Add listener for connection events
    * @param {function} listener - a listener callback that is called when the connection is opened/closed
@@ -379,6 +373,7 @@ class WSConnector {
 
 /* global global Buffer */
 
+
 const DEFAULT_QUEUE_SIZE = 128;        // max number of old unreceived messages to store
 
 /**
@@ -507,14 +502,17 @@ class AgentID {
     msg.index = Number.isInteger(index) ? index : -1;
     const rsp = await this.owner.request(msg, timeout);
     var ret = Array.isArray(params) ? new Array(params.length).fill(null) : null;
-    if (!rsp || rsp.perf != Performative.INFORM || !rsp.param) return ret;
+    if (!rsp || rsp.perf != Performative.INFORM || !rsp.param) {
+      if (this.owner._returnNullOnFailedResponse) return ret;
+      else throw new Error(`Unable to set ${this.name}.${params} to ${values}`);
+    }
     if (Array.isArray(params)) {
       if (!rsp.values) rsp.values = {};
       if (rsp.param) rsp.values[rsp.param] = rsp.value;
       const rvals = Object.keys(rsp.values);
       return params.map( p => {
         let f = rvals.find(rv => rv.endsWith(p));
-        return f ? rsp.values[f] : null;
+        return f ? rsp.values[f] : undefined;
       });
     } else {
       return rsp.value;
@@ -545,7 +543,10 @@ class AgentID {
     msg.index = Number.isInteger(index) ? index : -1;
     const rsp = await this.owner.request(msg, timeout);
     var ret = Array.isArray(params) ? new Array(params.length).fill(null) : null;
-    if (!rsp || rsp.perf != Performative.INFORM || (params && (!rsp.param))) return ret;
+    if (!rsp || rsp.perf != Performative.INFORM || !rsp.param) {
+      if (this.owner._returnNullOnFailedResponse) return ret;
+      else throw new Error(`Unable to get ${this.name}.${params}`);
+    }
     // Request for listing of all parameters.
     if (!params) {
       if (!rsp.values) rsp.values = {};
@@ -557,7 +558,7 @@ class AgentID {
       const rvals = Object.keys(rsp.values);
       return params.map(p => {
         let f = rvals.find(rv => rv.endsWith(p));
-        return f ? rsp.values[f] : null;
+        return f ? rsp.values[f] : undefined;
       });
     } else {
       return rsp.value;
@@ -641,12 +642,17 @@ class Message {
         return null;
       }
     }
-    let qclazz = obj.clazz;
-    let clazz = qclazz.replace(/^.*\./, '');
-    let rv = MessageClass[clazz] ? new MessageClass[clazz] : new Message();
-    rv.__clazz__ = qclazz;
-    rv._inflate(obj.data);
-    return rv;
+    try {
+      let qclazz = obj.clazz;
+      let clazz = qclazz.replace(/^.*\./, '');
+      let rv = MessageClass[clazz] ? new MessageClass[clazz] : new Message();
+      rv.__clazz__ = qclazz;
+      rv._inflate(obj.data);
+      return rv;
+    } catch (err) {
+      console.warn('Error trying to deserialize JSON object : ', obj, err);
+      return null;
+    }
   }
 }
 
@@ -663,6 +669,7 @@ class Message {
  * @param {string} [opts.keepAlive=true]     - try to reconnect if the connection is lost
  * @param {number} [opts.queueSize=128]      - size of the queue of received messages that haven't been consumed yet
  * @param {number} [opts.timeout=1000]       - timeout for fjage level messages in ms
+ * @param {boolean} [opts.returnNullOnFailedResponse=true] - return null instead of throwing an error when a parameter is not found
  * @param {string} [hostname="localhost"]    - <strike>Deprecated : hostname/ip address of the master container to connect to</strike>
  * @param {number} [port=]                   - <strike>Deprecated : port number of the master container to connect to</strike>
  * @param {string} [pathname=="/ws/"]        - <strike>Deprecated : path of the master container to connect to (for WebSockets)</strike>
@@ -691,6 +698,7 @@ class Gateway {
     this._timeout = opts.timeout;         // timeout for fjage level messages (agentForService etc)
     this._keepAlive = opts.keepAlive;     // reconnect if connection gets closed/errored
     this._queueSize = opts.queueSize;      // size of queue
+    this._returnNullOnFailedResponse = opts.returnNullOnFailedResponse; // null or error
     this.pending = {};                    // msgid to callback mapping for pending requests to server
     this.subscriptions = {};              // hashset for all topics that are subscribed
     this.listener = {};                   // set of callbacks that want to listen to incoming messages
@@ -706,7 +714,13 @@ class Gateway {
   _sendEvent(type, val) {
     if (Array.isArray(this.eventListeners[type])) {
       this.eventListeners[type].forEach(l => {
-        l && {}.toString.call(l) === '[object Function]' && l(val);
+        if (l && {}.toString.call(l) === '[object Function]'){
+          try {
+            l(val);
+          } catch (error) {
+            console.warn('Error in event listener : ' + error);
+          }
+        }
       });
     }
   }
@@ -735,18 +749,26 @@ class Gateway {
         var consumed = false;
         if (Array.isArray(this.eventListeners['message'])){
           for (var i = 0; i < this.eventListeners['message'].length; i++) {
-            if (this.eventListeners['message'][i](msg)) {
-              consumed = true;
-              break;
+            try {
+              if (this.eventListeners['message'][i](msg)) {
+                consumed = true;
+                break;
+              }
+            } catch (error) {
+              console.warn('Error in message listener : ' + error);
             }
           }
         }
         // iterate over internal callbacks, until one consumes the message
         for (var key in this.listener){
           // callback returns true if it has consumed the message
-          if (this.listener[key](msg)) {
-            consumed = true;
-            break;
+          try {
+            if (this.listener[key](msg)) {
+              consumed = true;
+              break;
+            }
+          } catch (error) {
+            console.warn('Error in listener : ' + error);
           }
         }
         if(!consumed) {
@@ -834,6 +856,7 @@ class Gateway {
         this.connector.write('{"alive": true}');
         this._update_watch();
       }
+      this._sendEvent('conn', state);
     });
     return conn;
   }
@@ -847,7 +870,12 @@ class Gateway {
     } else if (filter.__proto__.name == 'Message' || filter.__proto__.__proto__.name == 'Message') {
       return filter.__clazz__ == msg.__clazz__;
     } else if (typeof filter == 'function') {
-      return filter(msg);
+      try {
+        return filter(msg);
+      }catch(e){
+        console.warn('Error in filter : ' + e);
+        return false;
+      }
     } else {
       return msg instanceof filter;
     }
@@ -1021,6 +1049,30 @@ class Gateway {
     this._update_watch();
   }
 
+  /**
+   * Gets a list of all agents in the container.
+   * @returns {Promise<AgentID[]>} - a promise which returns an array of all agent ids when resolved
+   */
+  async agents() {
+    let rq = { action: 'agents' };
+    let rsp = await this._msgTxRx(rq);
+    if (!rsp || !Array.isArray(rsp.agentIDs)) throw new Error('Unable to get agents');
+    return rsp.agentIDs.map(aid => new AgentID(aid, false, this));
+  }
+
+  /**
+   * Check if an agent with a given name exists in the container.
+   *
+   * @param {AgentID|String} agentID - the agent id to check
+   * @returns {Promise<boolean>} - a promise which returns true if the agent exists when resolved
+   */
+  async containsAgent(agentID) {
+    let rq = { action: 'containsAgent', agentID: agentID instanceof AgentID ? agentID.getName() : agentID };
+    let rsp = await this._msgTxRx(rq);
+    if (!rsp) throw new Error('Unable to check if agent exists');
+    return !!rsp.answer;
+  }
+
   /**
    * Finds an agent that provides a named service. If multiple agents are registered
    * to provide a given service, any of the agents' id may be returned.
@@ -1031,7 +1083,11 @@ class Gateway {
   async agentForService(service) {
     let rq = { action: 'agentForService', service: service };
     let rsp = await this._msgTxRx(rq);
-    if (!rsp || !rsp.agentID) return;
+    if (!rsp) {
+      if (this._returnNullOnFailedResponse) return null;
+      else throw new Error('Unable to get agent for service');
+    }
+    if (!rsp.agentID) return null;
     return new AgentID(rsp.agentID, false, this);
   }
 
@@ -1045,7 +1101,11 @@ class Gateway {
     let rq = { action: 'agentsForService', service: service };
     let rsp = await this._msgTxRx(rq);
     let aids = [];
-    if (!rsp || !Array.isArray(rsp.agentIDs)) return aids;
+    if (!rsp) {
+      if (this._returnNullOnFailedResponse) return aids;
+      else throw new Error('Unable to get agents for service');
+    }
+    if (!Array.isArray(rsp.agentIDs)) return aids;
     for (var i = 0; i < rsp.agentIDs.length; i++)
       aids.push(new AgentID(rsp.agentIDs[i], false, this));
     return aids;
@@ -1117,7 +1177,7 @@ class Gateway {
       let timer;
       if (timeout > 0){
         timer = setTimeout(() => {
-          delete this.listener[lid];
+          this.listener[lid] && delete this.listener[lid];
           if (this.debug) console.log('Receive Timeout : ' + filter);
           resolve();
         }, timeout);
@@ -1125,7 +1185,7 @@ class Gateway {
       this.listener[lid] = msg => {
         if (!this._matchMessage(filter, msg)) return false;
         if(timer) clearTimeout(timer);
-        delete this.listener[lid];
+        this.listener[lid] && delete this.listener[lid];
         resolve(msg);
         return true;
       };
@@ -1264,7 +1324,8 @@ if (isBrowser || isWebWorker){
     'pathname' : '/ws/',
     'timeout': 1000,
     'keepAlive' : true,
-    'queueSize': DEFAULT_QUEUE_SIZE
+    'queueSize': DEFAULT_QUEUE_SIZE,
+    'returnNullOnFailedResponse': true
   });
   DEFAULT_URL = new URL('ws://localhost');
   // Enable caching of Gateways
@@ -1278,7 +1339,8 @@ if (isBrowser || isWebWorker){
     'pathname': '',
     'timeout': 1000,
     'keepAlive' : true,
-    'queueSize': DEFAULT_QUEUE_SIZE
+    'queueSize': DEFAULT_QUEUE_SIZE,
+    'returnNullOnFailedResponse': true
   });
   DEFAULT_URL = new URL('tcp://localhost');
   gObj.atob = a => Buffer.from(a, 'base64').toString('binary');
@@ -1724,7 +1786,7 @@ class UnetSocket {
 
   constructor(hostname, port, path='') {
     return (async () => {
-      this.gw = new CachingGateway({
+      this.gw = new Gateway({
         hostname : hostname,
         port : port,
         path : path
@@ -1984,7 +2046,8 @@ class UnetSocket {
 
 exports.AgentID = AgentID;
 exports.CachingAgentID = CachingAgentID;
-exports.Gateway = CachingGateway;
+exports.CachingGateway = CachingGateway;
+exports.Gateway = Gateway;
 exports.Message = Message;
 exports.MessageClass = MessageClass;
 exports.Performative = Performative;