vrpc 3.0.2 → 3.1.0

package/vrpc/VrpcClient.js

@@ -59,15 +59,17 @@ class VrpcClient extends EventEmitter {
    *
    * @constructor
    * @param {Object} options
-   * @param {String} options.token Access token as generated by: https://app.vrpc.io
-   * @param {String} options.username MQTT username (if no token is used)
-   * @param {String} options.password MQTT password (if no token is provided)
+   * @param {String} [options.username] MQTT username
+   * @param {String} [options.password] MQTT password (if no token is provided)
+   * @param {String} [options.token] Access token
    * @param {String} options.domain Sets the domain
    * @param {String} [options.agent="*"] Sets default agent
    * @param {String} [options.broker="mqtts://vrpc.io:8883"] Broker url in form: `<scheme>://<host>:<port>`
    * @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',
@@ -76,14 +78,16 @@ class VrpcClient extends EventEmitter {
    */
   constructor ({
     token,
-    username,
     password,
+    username,
     domain,
     agent = '*',
     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()
@@ -152,6 +163,7 @@ class VrpcClient extends EventEmitter {
     let username = this._username
     let password = this._password
     if (this._token) {
+      username = username || this._generateUserName()
       password = this._token
     }
     const options = {
@@ -323,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)
@@ -370,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__`
@@ -659,10 +671,13 @@ class VrpcClient extends EventEmitter {
     return new Promise(resolve => this._client.end(false, {}, resolve))
   }
 
+  _generateUserName () {
+    return `${this._domain}:client@${os.hostname()}-${os.platform()}-js`
+  }
+
   _createMqttClientId () {
     const clientInfo =
       os.arch() +
-      JSON.stringify(os.cpus()) +
       os.homedir() +
       os.hostname() +
       JSON.stringify(os.networkInterfaces()) +
@@ -680,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) {
@@ -693,6 +709,12 @@ class VrpcClient extends EventEmitter {
           this._log.warn(
             `Could not publish MQTT message because: ${err.message}`
           )
+          if (err.message === 'client disconnecting') {
+            // Workaround for an already reported bug in MQTT.js (#1284)
+            this._log.info('Forcing reconnect now...')
+            this._client.disconnecting = false
+            this._client.end(true, {}, () => this._client.reconnect())
+          }
         }
       }
     )
@@ -705,9 +727,44 @@ 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)
+            this._log.info('Forcing reconnect now...')
+            this._client.disconnecting = false
+            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}`)
           }
@@ -932,7 +989,8 @@ class VrpcClient extends EventEmitter {
           if (typeof ret === 'string' && ret.substring(0, 5) === '__p__') {
             this._eventEmitter.once(ret, promiseData => {
               // TODO improve error message here, like above
-              if (promiseData.e) reject(new Error(`[vrpc ${agent}-${c}-${f}]: ${promiseData.e}`))
+              if (promiseData.e)
+                reject(new Error(`[vrpc ${agent}-${c}-${f}]: ${promiseData.e}`))
               else resolve(promiseData.r)
             })
           } else {
@@ -1067,7 +1125,9 @@ class VrpcClient extends EventEmitter {
       : `${this._domain}/${agent}/${className}/${event}`
     const id = `__e__${topic}`
     if (this._cachedSubscriptions[topic]) {
-      const index = this._cachedSubscriptions[topic].findIndex(x => x.callback === callback)
+      const index = this._cachedSubscriptions[topic].findIndex(
+        x => x.callback === callback
+      )
       if (index === -1) {
         this._log.warn(`Failed removing event listener ${id}`)
         return null

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