vrpc 3.16.0 → 3.16.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vrpc",
-  "version": "3.16.0",
+  "version": "3.16.1",
   "description": "Remote objects over MQTT: call classes in other programs as if they were local - Node.js, browser, C++, Python, Arduino",
   "main": "index.js",
   "directories": {

package/vrpc/VrpcAdapter.js

@@ -661,8 +661,15 @@ class VrpcAdapter {
       const [instanceId, ...args] = json.a
       VrpcAdapter._assertInstanceName(instanceId)
       const existing = VrpcAdapter._instances.get(instanceId)
-      if (existing && existing.isIsolated) {
-        throw new Error(`Instance '${instanceId}' exists as an isolated instance`)
+      if (existing) {
+        // an id is never re-homed: an isolated instance stays isolated
+        if (existing.isIsolated) {
+          throw new Error(`Instance '${instanceId}' exists as an isolated instance`)
+        }
+        // a create of a name that exists returns it unchanged: its class
+        // and arguments stay, and nothing announces it (no 'create' event)
+        json.r = instanceId
+        return existing.instance
       }
       instance = VrpcAdapter._create(className, instanceId, ...args)
       VrpcAdapter._instances.set(instanceId, {
@@ -1313,7 +1320,8 @@ class VrpcAdapter {
 /**
  * Event 'create'
  *
- * Emitted on creation of shared instance
+ * Emitted once an instance was created. A create of a name that exists
+ * returns that instance and emits nothing.
  *
  * @event VrpcAdapter#create
  * @type {Object}

package/vrpc/VrpcAgent.js

@@ -646,6 +646,9 @@ class VrpcAgent extends EventEmitter {
     ] of VrpcAdapter._instances.entries()) {
       batches.push(this._methodsTopic(className, instanceId))
     }
+    // what the broker retains of this agent's classes: an earlier run's
+    // class that is no longer offered is cleared (_sweepClassInfo)
+    batches.push(`${this._baseTopic}/+/__classInfoConcise__`)
     let pending = batches.length
     const announce = () => {
       // a connection that ended meanwhile announces nothing: the next
@@ -659,10 +662,6 @@ class VrpcAgent extends EventEmitter {
       this._serving = true
       this.emit('connect')
     }
-    if (pending === 0) {
-      announce()
-      return
-    }
     for (const topic of batches) {
       this._mqttSubscribe(topic, undefined, () => {
         pending -= 1
@@ -743,7 +742,38 @@ class VrpcAgent extends EventEmitter {
     return topics
   }
 
-  _handleMessage (topic, data) {
+  /**
+   * A class info under this agent's own name. What the broker retained of
+   * a class this agent does not offer is a ghost of an earlier run - a
+   * class info only `end({ unregister: true })` would have cleared - and
+   * clients would list the class forever: it is cleared, in full and
+   * concise. Everything else on the topic - the agent's own announcements
+   * and clears, routed back live - passes without a word.
+   *
+   * @returns {Boolean} whether the message was a class info
+   * @private
+   */
+  _sweepClassInfo (topic, data, packet) {
+    const prefix = `${this._baseTopic}/`
+    if (!topic.startsWith(prefix)) return false
+    const tokens = topic.slice(prefix.length).split('/')
+    if (tokens.length !== 2) return false
+    const [className, info] = tokens
+    if (info !== '__classInfoConcise__' && info !== '__classInfo__') {
+      return false
+    }
+    const retained = !!packet && packet.retain
+    if (!retained || data.length === 0) return true
+    if (this._getClasses().includes(className)) return true
+    this._log.info(`Clearing the class info of ${className}, no longer offered`)
+    for (const name of ['__classInfo__', '__classInfoConcise__']) {
+      this._mqttPublish(`${prefix}${className}/${name}`, null, { retain: true })
+    }
+    return true
+  }
+
+  _handleMessage (topic, data, packet) {
+    if (this._sweepClassInfo(topic, data, packet)) return
     let json
     try {
       json = JSON.parse(data.toString())

package/vrpc/VrpcBrowserAdapter.js

@@ -469,8 +469,15 @@ class VrpcAdapter {
       const [instanceId, ...args] = json.a
       VrpcAdapter._assertInstanceName(instanceId)
       const existing = VrpcAdapter._instances.get(instanceId)
-      if (existing && existing.isIsolated) {
-        throw new Error(`Instance '${instanceId}' exists as an isolated instance`)
+      if (existing) {
+        // an id is never re-homed: an isolated instance stays isolated
+        if (existing.isIsolated) {
+          throw new Error(`Instance '${instanceId}' exists as an isolated instance`)
+        }
+        // a create of a name that exists returns it unchanged: its class
+        // and arguments stay, and nothing announces it (no 'create' event)
+        json.r = instanceId
+        return existing.instance
       }
       instance = VrpcAdapter._create(className, instanceId, ...args)
       VrpcAdapter._instances.set(instanceId, {
@@ -1132,7 +1139,8 @@ class VrpcAdapter {
 /**
  * Event 'create'
  *
- * Emitted on creation of shared instance
+ * Emitted once an instance was created. A create of a name that exists
+ * returns that instance and emits nothing.
  *
  * @event VrpcAdapter#create
  * @type {Object}

package/vrpc/VrpcBrowserAgent.js

@@ -478,6 +478,9 @@ class VrpcAgent extends EventEmitter {
     ] of VrpcAdapter._instances.entries()) {
       batches.push(this._methodsTopic(className, instanceId))
     }
+    // what the broker retains of this agent's classes: an earlier run's
+    // class that is no longer offered is cleared (_sweepClassInfo)
+    batches.push(`${this._baseTopic}/+/__classInfoConcise__`)
     let pending = batches.length
     const announce = () => {
       // a connection that ended meanwhile announces nothing: the next
@@ -490,10 +493,6 @@ class VrpcAgent extends EventEmitter {
       this._serving = true
       this.emit('connect')
     }
-    if (pending === 0) {
-      announce()
-      return
-    }
     for (const topic of batches) {
       this._mqttSubscribe(topic, undefined, () => {
         pending -= 1
@@ -566,7 +565,38 @@ class VrpcAgent extends EventEmitter {
     return topics
   }
 
-  _handleMessage (topic, data) {
+  /**
+   * A class info under this agent's own name. What the broker retained of
+   * a class this agent does not offer is a ghost of an earlier run - a
+   * class info only `end({ unregister: true })` would have cleared - and
+   * clients would list the class forever: it is cleared, in full and
+   * concise. Everything else on the topic - the agent's own announcements
+   * and clears, routed back live - passes without a word.
+   *
+   * @returns {Boolean} whether the message was a class info
+   * @private
+   */
+  _sweepClassInfo (topic, data, packet) {
+    const prefix = `${this._baseTopic}/`
+    if (!topic.startsWith(prefix)) return false
+    const tokens = topic.slice(prefix.length).split('/')
+    if (tokens.length !== 2) return false
+    const [className, info] = tokens
+    if (info !== '__classInfoConcise__' && info !== '__classInfo__') {
+      return false
+    }
+    const retained = !!packet && packet.retain
+    if (!retained || data.length === 0) return true
+    if (this._getClasses().includes(className)) return true
+    this._log.info(`Clearing the class info of ${className}, no longer offered`)
+    for (const name of ['__classInfo__', '__classInfoConcise__']) {
+      this._mqttPublish(`${prefix}${className}/${name}`, null, { retain: true })
+    }
+    return true
+  }
+
+  _handleMessage (topic, data, packet) {
+    if (this._sweepClassInfo(topic, data, packet)) return
     let json
     try {
       json = JSON.parse(data.toString())