vrpc 3.0.4 → 3.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vrpc",
-  "version": "3.0.4",
+  "version": "3.1.0",
   "description": "Variadic Remote Procedure Calls",
   "main": "index.js",
   "directories": {

package/vrpc/VrpcAdapter.js

@@ -499,7 +499,7 @@ class VrpcAdapter {
   }
 
   static sanitizeEventListenerReturnValues (ret) {
-    return typeof ret === 'object' &&
+    return ret && typeof ret === 'object' &&
       ret._events !== undefined &&
       ret._eventsCount !== undefined
       ? true
@@ -606,7 +606,10 @@ class VrpcAdapter {
         if (clients.has(clientId)) {
           clients.delete(clientId)
           if (clients.size === 0) {
-            VrpcAdapter.getInstance(ik).removeListener(event, listener)
+            const instance = VrpcAdapter.getInstance(ik)
+            if (instance && instance.removeListener) {
+              instance.removeListener(event, listener)
+            }
             delete VrpcAdapter._listeners[ik][ek]
           }
         }

package/vrpc/VrpcAgent.js

@@ -101,6 +101,7 @@ class VrpcAgent extends EventEmitter {
    * @param {Object} [obj.log=console] Log object (must support debug, info, warn, and error level)
    * @param {String} [obj.bestEffort=false] If true, message will be sent with best effort, i.e. no caching if offline
    * @param {String} [obj.version=''] The (user-defined) version of this agent
+   * @param {String} [obj.mqttClientId='<generated()>'] Explicitly set the mqtt client id.
    *
    * @example
    * const agent = new Agent({
@@ -117,7 +118,8 @@ class VrpcAgent extends EventEmitter {
     broker = 'mqtts://vrpc.io:8883',
     log = 'console',
     bestEffort = false,
-    version = ''
+    version = '',
+    mqttClientId = null
   } = {}) {
     super()
     this._validateDomain(domain)
@@ -130,6 +132,13 @@ class VrpcAgent extends EventEmitter {
     this._broker = broker
     this._qos = bestEffort ? 0 : 1
     this._version = version
+    this._mqttClientId =
+      mqttClientId ||
+      `va3${crypto
+        .createHash('md5')
+        .update(this._domain + this._agent)
+        .digest('hex')
+        .substring(0, 20)}`
     if (log === 'console') {
       this._log = console
       this._log.debug = () => {}
@@ -164,18 +173,13 @@ class VrpcAgent extends EventEmitter {
    * rejects
    */
   async serve () {
-    const md5 = crypto
-      .createHash('md5')
-      .update(this._domain + this._agent)
-      .digest('hex')
-      .substring(0, 20)
     let username = this._username
     let password = this._password
     if (this._token) {
-      username = `${this._domain}:${this._agent}`
+      username = `${this._domain}/${this._agent}`
       password = this._token
     } else if (!this._password) {
-      username = `${this._domain}:${this._agent}`
+      username = `${this._domain}/${this._agent}`
       password = this._generateToken()
     }
     this._options = {
@@ -183,7 +187,7 @@ class VrpcAgent extends EventEmitter {
       password,
       keepalive: 30,
       connectTimeout: 10 * 1000,
-      clientId: `va3${md5}`,
+      clientId: this._mqttClientId,
       rejectUnauthorized: false,
       will: {
         topic: `${this._baseTopic}/__agentInfo__`,
@@ -320,9 +324,38 @@ class VrpcAgent extends EventEmitter {
       (err, granted) => {
         if (err) {
           this._log.warn(
-            `Could not subscribe to topic '${topic}', because: ${err.message}`
+            `Could not subscribe to topic(s) '${topic}', because: ${err.message}`
           )
         } else {
+          const topicArray = Array.isArray(topic) ? topic : [topic]
+          const erroneousGranted = granted
+            .filter(x => x.qos === 128)
+            .map(x => x.topic)
+          if (erroneousGranted.length > 0) {
+            err = new Error(
+              `Could not subscribe all ${topicArray.length} topic(s) but got error qos=128 on following ${erroneousGranted.length} topic(s): ${erroneousGranted}`
+            )
+            err.code = 'SUBSCRIBE_FAILED'
+            err.subscribeOptions = options
+            this._log.error(err)
+            this.emit('error', err)
+          }
+          const reducedQos = granted.filter(x => x.qos < this._qos)
+          if (reducedQos.length > 0) {
+            err = new Error(
+              `Could not subscribe all ${
+                topicArray.length
+              } topic(s) at desired qos=${
+                this._qos
+              } but got reduced qos on following ${
+                reducedQos.length
+              } topic(s): ${JSON.stringify(reducedQos)}`
+            )
+            err.code = 'SUBSCRIBE_REDUCED_QOS'
+            err.subscribeOptions = options
+            this._log.warn(err)
+            this.emit('error', err)
+          }
           if (granted.length === 0) {
             this._log.debug(`Already subscribed to topic '${topic}'`)
           }

package/vrpc/VrpcClient.js

@@ -68,6 +68,8 @@ class VrpcClient extends EventEmitter {
    * @param {Number} [options.timeout=6000] Maximum time in ms to wait for a RPC answer
    * @param {Object} [options.log=console] Log object (must support debug, info, warn, and error level)
    * @param {Boolean} [options.bestEffort=false] If true, message will be sent with best effort, i.e. no caching if offline
+   * @param {String} [options.mqttClientId='<generated()>'] Explicitly sets the mqtt client id
+   * @param {String} [options.identity] Explicitly sets a vrpc client identity
    * @example
    * const client = new VrpcClient({
    *   domain: 'vrpc',
@@ -83,7 +85,9 @@ class VrpcClient extends EventEmitter {
     broker = 'mqtts://vrpc.io:8883',
     timeout = 6 * 1000,
     log = 'console',
-    bestEffort = false
+    bestEffort = false,
+    mqttClientId = null,
+    identity = null
   } = {}) {
     super()
     // domain sanity check
@@ -99,6 +103,12 @@ class VrpcClient extends EventEmitter {
         'The agent must NOT contain any of those characters: "+", "/", "#"'
       )
     }
+    // identity sanity check
+    if (identity && identity.match(/[+/#$]/)) {
+      throw new Error(
+        'The identity must NOT contain any of those characters: "+", "/", "#", "$"'
+      )
+    }
     this._token = token
     this._username = username
     this._password = password
@@ -106,10 +116,11 @@ class VrpcClient extends EventEmitter {
     this._domain = domain
     this._broker = broker
     this._timeout = timeout
+    this._identity = identity
     this._qos = this._qos = bestEffort ? 0 : 1
 
     this._instance = nanoid(8)
-    this._mqttClientId = this._createMqttClientId()
+    this._mqttClientId = mqttClientId || this._createMqttClientId()
     this._vrpcClientId = this._createVrpcClientId()
     this._agents = {}
     this._eventEmitter = new EventEmitter()
@@ -324,7 +335,7 @@ class VrpcClient extends EventEmitter {
       f: isIsolated ? '__createIsolated__' : '__createShared__',
       a: [instance, ...args],
       i: `${this._instance}-${this._invokeId++ % Number.MAX_SAFE_INTEGER}`,
-      s: `${this._domain}/${os.hostname()}/${this._instance}`,
+      s: this._vrpcClientId,
       v: VRPC_PROTOCOL_VERSION
     }
     const proxy = await this._getProxy(agent, className, json)
@@ -371,7 +382,7 @@ class VrpcClient extends EventEmitter {
       f: '__delete__',
       a: [instance],
       i: `${this._instance}-${this._invokeId++ % Number.MAX_SAFE_INTEGER}`,
-      s: `${this._domain}/${os.hostname()}/${this._instance}`,
+      s: this._vrpcClientId,
       v: VRPC_PROTOCOL_VERSION
     }
     const topic = `${this._domain}/${agent}/${className}/__static__/__delete__`
@@ -684,7 +695,8 @@ class VrpcClient extends EventEmitter {
   }
 
   _createVrpcClientId () {
-    return `${this._domain}/${os.hostname()}/${this._instance}`
+    const identity = this._identity || this._instance
+    return `${this._domain}/${os.hostname()}/${identity}`
   }
 
   _mqttPublish (topic, message, options) {
@@ -715,7 +727,7 @@ class VrpcClient extends EventEmitter {
       (err, granted) => {
         if (err) {
           this._log.warn(
-            `Could not subscribe to topic: ${topic} because: ${err.message}`
+            `Could not subscribe to topic(s): '${topic}', because: ${err.message}`
           )
           if (err.message === 'client disconnecting') {
             // Workaround for an already reported bug in MQTT.js (#1284)
@@ -724,6 +736,35 @@ class VrpcClient extends EventEmitter {
             this._client.end(true, {}, () => this._client.reconnect())
           }
         } else {
+          const topicArray = Array.isArray(topic) ? topic : [topic]
+          const erroneousGranted = granted
+            .filter(x => x.qos === 128)
+            .map(x => x.topic)
+          if (erroneousGranted.length > 0) {
+            err = new Error(
+              `Could not subscribe all ${topicArray.length} topic(s) but got error qos=128 on following ${erroneousGranted.length} topic(s): ${erroneousGranted}`
+            )
+            err.code = 'SUBSCRIBE_FAILED'
+            err.subscribeOptions = options
+            this._log.error(err)
+            this.emit('error', err)
+          }
+          const reducedQos = granted.filter(x => x.qos < this._qos)
+          if (reducedQos.length > 0) {
+            err = new Error(
+              `Could not subscribe all ${
+                topicArray.length
+              } topic(s) at desired qos=${
+                this._qos
+              } but got reduced qos on following ${
+                reducedQos.length
+              } topic(s): ${JSON.stringify(reducedQos)}`
+            )
+            err.code = 'SUBSCRIBE_REDUCED_QOS'
+            err.subscribeOptions = options
+            this._log.warn(err)
+            this.emit('error', err)
+          }
           if (granted.length === 0) {
             this._log.debug(`Already subscribed to: ${topic}`)
           }

package/vrpc/VrpcNative.js

@@ -106,12 +106,28 @@ class VrpcNative {
           if (functionName.startsWith('vrpcOn')) {
             const id = `__f__${context}-${functionName}`
             wrapped.push(id)
-            eventEmitter.on(id, a => x.apply(null, a))
+            eventEmitter.on(id, a => {
+              try {
+                x.apply(null, a)
+              } catch (err) {
+                console.error(
+                  `[VrpcNative ${context}-${functionName}]: Failed to execute callback, because: ${err.message}`
+                )
+              }
+            })
           } else {
             const id = `__f__${context}-${functionName}-${i}-${invokeId++ %
               Number.MAX_SAFE_INTEGER}`
             wrapped.push(id)
-            eventEmitter.once(id, a => x.apply(null, a))
+            eventEmitter.once(id, a => {
+              try {
+                x.apply(null, a)
+              } catch (err) {
+                console.error(
+                  `[VrpcNative ${context}-${functionName}]: Failed to execute callback, because: ${err.message}`
+                )
+              }
+            })
           }
         } else if (VrpcNative._isEmitter(x)) {
           const { emitter, event } = x
@@ -273,12 +289,28 @@ class VrpcNative {
         if (functionName.startsWith('vrpcOn')) {
           const id = `__f__${className}-${functionName}:${args[0]}`
           wrapped.push(id)
-          this._eventEmitter.on(id, a => x.apply(null, a))
+          this._eventEmitter.on(id, a => {
+            try {
+              x.apply(null, a)
+            } catch (err) {
+              console.error(
+                `[VrpcNative ${className}-${functionName}]: Failed to execute callback, because: ${err.message}`
+              )
+            }
+          })
         } else {
           const id = `__f__${className}-${functionName}-${i}-${invokeId++ %
             Number.MAX_SAFE_INTEGER}`
           wrapped.push(id)
-          this._eventEmitter.once(id, a => x.apply(null, a))
+          this._eventEmitter.once(id, a => {
+            try {
+              x.apply(null, a)
+            } catch (err) {
+              console.error(
+                `[VrpcNative ${className}-${functionName}]: Failed to execute callback, because: ${err.message}`
+              )
+            }
+          })
         }
       } else if (VrpcNative._isEmitter(x)) {
         const { emitter, event } = x