vrpc 3.0.0-alpha.3 → 3.0.3

package/vrpc/VrpcAgent.js

@@ -48,7 +48,7 @@ class VrpcAgent extends EventEmitter {
     })
     parser.add_argument('-d', '--domain', {
       help: 'Domain name',
-      default: domain || 'public.vrpc'
+      default: domain || 'vrpc'
     })
     parser.add_argument('-t', '--token', {
       help: 'access token',
@@ -92,10 +92,10 @@ class VrpcAgent extends EventEmitter {
    *
    * @constructor
    * @param {Object} obj
-   * @param {String} [obj.username] MQTT username (if no token is used)
+   * @param {String} [obj.username='<user>-<pathId>@<hostname>-<platform>-js'] MQTT username
    * @param {String} [obj.password] MQTT password (if no token is provided)
-   * @param {String} [obj.token] Access token as generated by: https://app.vrpc.io (only optional when using default domain and broker)
-   * @param {String} [obj.domain='public.vrpc'] The domain under which the agent-provided code is reachable
+   * @param {String} [obj.token] Access token
+   * @param {String} [obj.domain='vrpc'] The domain under which the agent-provided code is reachable
    * @param {String} [obj.agent='<user>-<pathId>@<hostname>-<platform>-js'] This agent's name
    * @param {String} [obj.broker='mqtts://vrpc.io:8883'] Broker url in form: `<scheme>://<host>:<port>`
    * @param {Object} [obj.log=console] Log object (must support debug, info, warn, and error level)
@@ -104,15 +104,15 @@ class VrpcAgent extends EventEmitter {
    *
    * @example
    * const agent = new Agent({
-   *   domain: 'public.vrpc'
+   *   domain: 'vrpc'
    *   agent: 'myAgent'
    * })
    */
   constructor ({
-    username,
-    password,
     token,
-    domain = 'public.vrpc',
+    password,
+    username = VrpcAgent._generateAgentName(),
+    domain = 'vrpc',
     agent = VrpcAgent._generateAgentName(),
     broker = 'mqtts://vrpc.io:8883',
     log = 'console',
@@ -173,7 +173,7 @@ class VrpcAgent extends EventEmitter {
     let username = this._username
     let password = this._password
     if (this._token) {
-      username = '__token__'
+      username = username || this._agent
       password = this._token
     }
     this._options = {
@@ -244,13 +244,17 @@ class VrpcAgent extends EventEmitter {
     }
   }
 
+  static _generateUserName () {
+    return `${os.userInfo().username}@${os.hostname()}-${os.platform()}-js`
+  }
+
   static _generateAgentName () {
     const { username } = os.userInfo()
     const pathId = crypto
       .createHash('md5')
       .update(path.resolve())
       .digest('hex')
-      .substr(0, 4)
+      .substring(0, 4)
     return `${username}-${pathId}@${os.hostname()}-${os.platform()}-js`
   }
 
@@ -346,23 +350,23 @@ class VrpcAgent extends EventEmitter {
   }
 
   _getClasses () {
-    return VrpcAdapter.getAvailableClasses()
+    return VrpcAdapter._getClassesArray()
   }
 
   _getInstances (className) {
-    return VrpcAdapter.getAvailableInstances(className)
+    return VrpcAdapter._getInstancesArray(className)
   }
 
   _getMemberFunctions (className) {
-    return VrpcAdapter.getAvailableMemberFunctions(className)
+    return VrpcAdapter._getMemberFunctionsArray(className)
   }
 
   _getStaticFunctions (className) {
-    return VrpcAdapter.getAvailableStaticFunctions(className)
+    return VrpcAdapter._getStaticFunctionsArray(className)
   }
 
   _getMetaData (className) {
-    return VrpcAdapter.getAvailableMetaData(className)
+    return VrpcAdapter._getMetaData(className)
   }
 
   async _ensureConnected () {
@@ -376,14 +380,18 @@ class VrpcAgent extends EventEmitter {
   }
 
   _handleVrpcCallback (json) {
-    const { s } = json
+    const { s, i, r, e, a } = json
+    const topic = i.startsWith('__e__') ? i.slice(5) : s
     try {
-      this._log.debug(`Forwarding callback to: ${s} with payload:`, json)
-      this._mqttPublish(s, VrpcAgent._stringifySafely(json))
+      this._log.debug(`Forwarding callback to: ${topic} with payload:`, json)
+      this._mqttPublish(
+        topic,
+        VrpcAgent._stringifySafely({ a, r, e, i, v: VRPC_PROTOCOL_VERSION })
+      )
     } catch (err) {
       this._log.warn(
         err,
-        `Problem publishing vrpc callback to ${sender} because of: ${err.message}`
+        `Problem publishing vrpc callback to ${topic} because of: ${err.message}`
       )
     }
   }
@@ -549,7 +557,9 @@ class VrpcAgent extends EventEmitter {
           break
         }
       }
-      this._mqttPublish(json.s, VrpcAgent._stringifySafely(json))
+      const { a, r, e, i, v } = json
+      const res = e ? { a, r, e, i, v } : { a, r, i, v }
+      this._mqttPublish(json.s, VrpcAgent._stringifySafely(res))
     } catch (err) {
       this._log.error(
         err,
@@ -562,19 +572,17 @@ class VrpcAgent extends EventEmitter {
     // Client went offline
     const clientId = topic.slice(0, -15) // /__clientInfo__ = 15
     if (json.status === 'offline') {
+      VrpcAdapter._unregisterClient(clientId)
       const entry = this._isolatedInstances.get(clientId)
       if (entry) {
-        // anonymous
         entry.forEach(instanceId => {
           const json = { f: '__delete__', a: [instanceId], r: null }
-          // TODO Do not mutate!
           VrpcAdapter._call(json)
           if (json.r) {
             this._log.debug(`Auto-deleted isolated instance: ${instanceId}`)
           }
         })
       }
-      VrpcAdapter._unregisterEventListeners(clientId)
       this._mqttUnsubscribe(`${clientId}/__clientInfo__`)
       this.emit('clientGone', clientId)
     }
@@ -620,7 +628,6 @@ class VrpcAgent extends EventEmitter {
   _unregisterInstance (instanceId, clientId) {
     const entryIsolated = this._isolatedInstances.get(clientId)
     if (entryIsolated && entryIsolated.has(instanceId)) {
-      VrpcAdapter._unregisterEventListenersOfInstance(instanceId)
       entryIsolated.delete(instanceId)
       if (entryIsolated.length === 0) {
         this._isolatedInstances.delete(clientId)
@@ -633,7 +640,6 @@ class VrpcAgent extends EventEmitter {
     this._sharedInstances.forEach(async v => {
       if (v.has(instanceId)) {
         found = true
-        VrpcAdapter._unregisterEventListenersOfInstance(instanceId)
         v.delete(instanceId)
         if (v.length === 0) {
           this._sharedInstances.delete(clientId)
@@ -748,8 +754,7 @@ class VrpcAgent extends EventEmitter {
 /**
  * Event 'clientGone'
  *
- * Emitted when a VRPC client exited that before produced state (e.g. created
- * an anonymous or named instance).
+ * Emitted when a tracked VRPC client exited.
  *
  * @event VrpcAgent#clientGone
  * @type {String} clientId