vrpc 3.12.0 → 3.13.0

package/vrpc/VrpcBrowserAdapter.js

@@ -39,6 +39,16 @@ const Ajv = require('ajv')
 const EventEmitter = require('events')
 const { nanoid } = require('nanoid')
 
+// A runtime without dispose symbols (older browsers, Node before 18.18 /
+// 20.4) gets Node's own stand-ins from the symbol registry, so a class file
+// and the adapter meet on one symbol whichever of them installs it first.
+if (typeof Symbol.dispose !== 'symbol') {
+  Symbol.dispose = Symbol.for('nodejs.dispose')
+}
+if (typeof Symbol.asyncDispose !== 'symbol') {
+  Symbol.asyncDispose = Symbol.for('nodejs.asyncDispose')
+}
+
 const VRPC_GLOBAL = '__global__'
 const VRPC_WINDOW_NS = 'vrpc'
 
@@ -188,7 +198,10 @@ class VrpcAdapter {
   }
 
   /**
-   * Deletes an instance
+   * Deletes an instance: its name is free at once, the adapter takes back
+   * every listener it attached, and the object releases what it runs
+   * through its `[Symbol.asyncDispose]` or `[Symbol.dispose]` method, which
+   * runs in the background here (a remote delete answers once it settled).
    *
    * @param {String|Object} instance Instance (name or object itself) to be deleted
    * @returns {Boolean} True in case of success, false otherwise
@@ -199,10 +212,7 @@ class VrpcAdapter {
     }
     if (typeof instance === 'object') {
       for (const [k, v] of VrpcAdapter._instances) {
-        if (v.instance === instance) {
-          VrpcAdapter._instances.delete(k)
-          return true
-        }
+        if (v.instance === instance) return VrpcAdapter._delete(k)
       }
       return false
     }
@@ -457,11 +467,17 @@ class VrpcAdapter {
         instance,
         className: json.c
       })
-      json.r = VrpcAdapter._delete(instance)
+      const { ended, disposed } = VrpcAdapter._end(instance)
       VrpcAdapter._emitter.emit('delete', {
         instance,
         className: json.c
       })
+      // a delete answers once the object released what it runs, so that a
+      // constructor right after it never meets a resource the old object
+      // still holds; the agent's own housekeeping awaits no answer
+      if (disposed && json.s !== VrpcAdapter.LOCAL_SENDER) {
+        VrpcAdapter._handlePromise(json, disposed.then(() => ended))
+      } else json.r = ended
     } catch (err) {
       json.e = err.message
     }
@@ -482,6 +498,15 @@ class VrpcAdapter {
       json.r = true
       return
     }
+    // an unknown context fails before its arguments are unwrapped: a
+    // listener registered for a name that does not exist would outlive the
+    // failed call and pass for attached once the name is created
+    if (
+      !VrpcAdapter._functionRegistry.has(json.c) &&
+      !VrpcAdapter._instances.has(json.c)
+    ) {
+      throw new Error(`Could not find context: ${json.c}`)
+    }
     const unwrapped = VrpcAdapter._unwrapArguments(json)
     if (!unwrapped) {
       // this call must be skipped (event emitter stuff)
@@ -557,33 +582,112 @@ class VrpcAdapter {
   }
 
   static _delete (instanceId) {
+    return VrpcAdapter._end(instanceId).ended
+  }
+
+  /**
+   * Ends an instance - the one teardown behind every door (a remote delete,
+   * the auto-delete of an isolated instance whose client went, an
+   * in-process delete): its name is free at once, the adapter takes back
+   * every listener it attached (silent from now on anyway, see
+   * _generateListener), and the object releases what it runs through the
+   * ECMAScript dispose protocol, `[Symbol.asyncDispose]` or else
+   * `[Symbol.dispose]`.
+   *
+   * @returns {Object} `{ ended, disposed }`: whether the name was known, and
+   * a promise when an asynchronous dispose is under way (it never rejects)
+   */
+  static _end (instanceId) {
     const entry = VrpcAdapter._instances.get(instanceId)
-    if (entry) {
-      // in case the instance was an EventEmitter, free all registered listeners
-      if (VrpcAdapter._isFunction(entry.removeAllListeners)) {
-        entry.removeAllListeners()
+    if (!entry) return { ended: false, disposed: null }
+    VrpcAdapter._instances.delete(instanceId)
+    VrpcAdapter._detachListeners(instanceId, entry.instance)
+    return { ended: true, disposed: VrpcAdapter._dispose(instanceId, entry) }
+  }
+
+  static _detachListeners (instanceId, instance) {
+    const registrations = VrpcAdapter._listeners[instanceId]
+    delete VrpcAdapter._listeners[instanceId]
+    if (!registrations || !VrpcAdapter._isFunction(instance.removeListener)) {
+      return
+    }
+    for (const { event, listener, clients } of Object.values(registrations)) {
+      try {
+        VrpcAdapter._removeTimes(instance, event, listener, clients.length)
+      } catch (err) {
+        // a class whose removeListener fails keeps a silent listener
       }
-      delete VrpcAdapter._listeners[instanceId]
-      VrpcAdapter._instances.delete(instanceId)
-      return true
     }
-    return false
+  }
+
+  // a subscription repeated n times may hold n attachments of one listener
+  // (EventEmitter semantics): each removeListener takes one of them
+  static _removeTimes (instance, event, listener, times) {
+    for (let n = 0; n < Math.max(1, times); n++) {
+      instance.removeListener(event, listener)
+    }
+  }
+
+  /**
+   * Runs the object's dispose method. A dispose that fails or outlasts
+   * VrpcAdapter.DISPOSE_TIMEOUT is reported (event 'disposeFailed') and
+   * never thrown: the instance is gone either way.
+   *
+   * @returns {Promise|null} Settles when an asynchronous dispose is done
+   */
+  static _dispose (instanceId, { instance, className }) {
+    const fail = error =>
+      VrpcAdapter._emitter.emit('disposeFailed', {
+        instance: instanceId,
+        className,
+        error
+      })
+    let result
+    try {
+      if (VrpcAdapter._isFunction(instance[Symbol.asyncDispose])) {
+        result = instance[Symbol.asyncDispose]()
+      } else if (VrpcAdapter._isFunction(instance[Symbol.dispose])) {
+        result = instance[Symbol.dispose]()
+      }
+    } catch (err) {
+      fail(err)
+      return null
+    }
+    if (!VrpcAdapter._isPromise(result)) return null
+    let timer
+    const bound = new Promise(resolve => {
+      timer = setTimeout(() => {
+        fail(
+          new Error(
+            `dispose did not settle within ${VrpcAdapter.DISPOSE_TIMEOUT} ms`
+          )
+        )
+        resolve()
+      }, VrpcAdapter.DISPOSE_TIMEOUT)
+    })
+    const settled = result.then(
+      () => {},
+      err => fail(err)
+    )
+    return Promise.race([settled, bound]).then(() => clearTimeout(timer))
   }
 
   static _unregisterClient (clientId) {
     Object.entries(VrpcAdapter._listeners).forEach(([ik, iv]) => {
       Object.entries(iv).forEach(([ek, ev]) => {
-        const { clients, listener, event } = ev
-        const index = clients.indexOf(clientId)
-        if (index !== -1) {
-          clients.splice(index, 1)
-          if (clients.length === 0) {
-            const instance = VrpcAdapter.getInstance(ik)
-            if (instance && instance.removeListener) {
-              instance.removeListener(event, listener)
-            }
-            delete VrpcAdapter._listeners[ik][ek]
+        const { listener, event } = ev
+        // a client is listed once per subscription: its going ends them all
+        const remaining = ev.clients.filter(x => x !== clientId)
+        const gone = ev.clients.length - remaining.length
+        if (gone === 0) return
+        ev.clients = remaining
+        if (remaining.length === 0) {
+          const entry = VrpcAdapter._instances.get(ik)
+          const instance = entry && entry.instance
+          if (instance && instance.removeListener) {
+            VrpcAdapter._removeTimes(instance, event, listener, gone)
           }
+          delete VrpcAdapter._listeners[ik][ek]
         }
       })
     })
@@ -622,6 +726,7 @@ class VrpcAdapter {
           // event registration
           if (func === 'on' || func === 'addListener') {
             VrpcAdapter._mustTrackClient = true
+            const held = VrpcAdapter._holdsListener(context, arg)
             const listener = VrpcAdapter._registerListener({
               clientId,
               isCallAll,
@@ -629,9 +734,8 @@ class VrpcAdapter {
               eventId: arg,
               event: args[0]
             })
-            if (!listener) {
-              return null // skip call as listener is already registered
-            }
+            // attached already: skip the call, one listener hears once
+            if (held) return null
             unwrapped.push(listener)
             // event un-registration
           } else if (func === 'off' || func === 'removeListener') {
@@ -666,8 +770,32 @@ class VrpcAdapter {
     return unwrapped
   }
 
+  /**
+   * Whether the object under `instanceId` is still the one the adapter saw
+   * when it built a listener or a callback for it: a deleted instance never
+   * speaks on the bus again, even when its class kept the listener or its
+   * clock kept running. A static context (a class name) has no object and
+   * always speaks.
+   */
+  static _speaksFor (instanceId) {
+    const entry = VrpcAdapter._instances.get(instanceId)
+    if (!entry) return () => true
+    const { instance } = entry
+    return () => {
+      const live = VrpcAdapter._instances.get(instanceId)
+      return live !== undefined && live.instance === instance
+    }
+  }
+
+  static _holdsListener (instanceId, eventId) {
+    const registrations = VrpcAdapter._listeners[instanceId]
+    return Boolean(registrations && registrations[eventId])
+  }
+
   static _generateCallback ({ eventId, clientId, instanceId, isCallAll }) {
+    const speaks = VrpcAdapter._speaksFor(instanceId)
     return (...innerArgs) => {
+      if (!speaks()) return
       // "callAll" event notifications expect the instanceId as first argument
       const a = isCallAll ? [instanceId, ...innerArgs] : [...innerArgs]
       VrpcAdapter._callback({ a, s: clientId, i: eventId })
@@ -708,11 +836,13 @@ class VrpcAdapter {
       return VrpcAdapter._listeners[instanceId][eventId].listener
     }
     VrpcAdapter._listeners[instanceId][eventId].clients.push(clientId)
-    return null
+    return VrpcAdapter._listeners[instanceId][eventId].listener
   }
 
   static _generateListener ({ eventId, instanceId, isCallAll }) {
+    const speaks = VrpcAdapter._speaksFor(instanceId)
     return (...innerArgs) => {
+      if (!speaks()) return
       const a = isCallAll ? [instanceId, ...innerArgs] : [...innerArgs]
       VrpcAdapter._callback({ a, i: eventId })
     }
@@ -892,12 +1022,28 @@ class VrpcAdapter {
  * @property {String} instance The instance name
  */
 
+/**
+ * Event 'disposeFailed'
+ *
+ * Emitted when the dispose method of a deleted instance throws, rejects or
+ * does not settle within VrpcAdapter.DISPOSE_TIMEOUT. The instance is gone
+ * regardless.
+ *
+ * @event VrpcAdapter#disposeFailed
+ * @type {Object}
+ * @property {String} className The class name of the deleted instance
+ * @property {String} instance The instance name
+ * @property {Error} error What went wrong
+ */
+
 // Initialize static members
 VrpcAdapter._functionRegistry = new Map()
 VrpcAdapter._instances = new Map()
 VrpcAdapter._emitter = new EventEmitter()
 VrpcAdapter._correlationId = 0
 VrpcAdapter._listeners = {}
+// the longest a delete waits for the dispose method of its instance
+VrpcAdapter.DISPOSE_TIMEOUT = 10000
 VrpcAdapter._blackList = new Set([
   'caller',
   'callee',

package/vrpc/VrpcBrowserAgent.js

@@ -68,9 +68,21 @@ class VrpcAgent extends EventEmitter {
     }
     this._baseTopic = `${this._domain}/${this._agent}`
     VrpcAdapter.onCallback(this._handleVrpcCallback.bind(this))
+    // a deleted instance whose dispose failed is gone anyway: say why
+    this._handleDisposeFailed = ({ instance, className, error }) =>
+      this._log.warn(
+        error,
+        `Dispose of deleted instance ${className}::${instance} failed: ${error.message}`
+      )
+    VrpcAdapter.on('disposeFailed', this._handleDisposeFailed)
     // maps clientId to instanceId
     this._isolatedInstances = new Map()
     this._sharedInstances = new Map()
+    // counts the connections: an announcement belongs to the connection
+    // that prepared it (see _handleConnect)
+    this._connectGeneration = 0
+    // connected, request topics subscribed and info announced
+    this._serving = false
 
     // Handle the internal error event in case the user forgot to implement it
     this.on('error', err => {
@@ -90,8 +102,9 @@ class VrpcAgent extends EventEmitter {
    * If the connection could not be established because of authorization
    * failure, the 'error' event will be emitted.
    *
-   * @return {Promise} Resolves once connected or explicitly ended, never
-   * rejects
+   * @return {Promise} Resolves once the agent serves - connected, its
+   * request topics subscribed and its info announced - or once it was
+   * explicitly ended before that, never rejects
    */
   async serve () {
     let username = this._username
@@ -140,6 +153,7 @@ class VrpcAgent extends EventEmitter {
    * @returns {Promise} Resolves when disconnected and ended
    */
   async end ({ unregister = false } = {}) {
+    VrpcAdapter.off('disposeFailed', this._handleDisposeFailed)
     try {
       if (!this._client || !this._client.connected) {
         this.emit('end')
@@ -226,7 +240,11 @@ class VrpcAgent extends EventEmitter {
     )
   }
 
-  _mqttSubscribe (topic, options) {
+  /**
+   * Subscribes topic(s); `onSettled` is called once the broker has
+   * answered (granted, refused or failed alike).
+   */
+  _mqttSubscribe (topic, options, onSettled) {
     this._client.subscribe(
       topic,
       { qos: this._qos, ...options },
@@ -269,6 +287,7 @@ class VrpcAgent extends EventEmitter {
             this._log.debug(`Already subscribed to topic '${topic}'`)
           }
         }
+        if (onSettled) onSettled()
       }
     )
   }
@@ -303,12 +322,16 @@ class VrpcAgent extends EventEmitter {
     return VrpcAdapter._getMetaData(className)
   }
 
+  /**
+   * Resolves once the agent serves (its own 'connect' event: connected,
+   * request topics subscribed, info announced), or once it was ended.
+   */
   async _ensureConnected () {
     return new Promise(resolve => {
-      if (this._client.connected) {
+      if (this._serving) {
         resolve()
       } else {
-        this._client.once('connect', resolve)
+        this.once('connect', resolve)
         // Will be triggered if the user called 'agent.end()'
         this.once('end', resolve)
       }
@@ -347,33 +370,56 @@ class VrpcAgent extends EventEmitter {
     return str
   }
 
+  /**
+   * Serve first, announce second - the twin of VrpcAgent._handleConnect:
+   * every request topic (statics, the methods of every existing instance)
+   * is subscribed before the agent and class info go out, and they go out
+   * once the broker has answered every subscription. A client acts on the
+   * announcement at once; a request published before the broker routes
+   * the topic is lost (QoS 0) and only times out on the caller's side.
+   */
   _handleConnect () {
     this._log.info('[OK]')
+    const generation = ++this._connectGeneration
+    const batches = []
     try {
-      const topics = this._generateTopics()
-      if (topics.length > 0) this._mqttSubscribe(topics)
+      const statics = this._generateTopics()
+      if (statics.length > 0) batches.push(statics)
     } catch (err) {
       this._log.error(
         err,
         `Problem during initial topic subscription: ${err.message}`
       )
     }
-    // Publish agent online
-    this._publishAgentInfoMessage()
-
-    // Publish class information
-    const classes = this._getClasses()
-    classes.forEach(className => {
-      this._publishClassInfoMessage(className)
-    })
-    // Register all pre-existing instances
+    // all pre-existing instances
     for (const [
       instanceId,
       { className }
     ] of VrpcAdapter._instances.entries()) {
-      this._subscribeToMethodsOfNewInstance(className, instanceId)
+      batches.push(this._methodsTopic(className, instanceId))
+    }
+    let pending = batches.length
+    const announce = () => {
+      // a connection that ended meanwhile announces nothing: the next
+      // one prepares and announces itself
+      if (generation !== this._connectGeneration) return
+      this._publishAgentInfoMessage()
+      for (const className of this._getClasses()) {
+        this._publishClassInfoMessage(className)
+      }
+      this._serving = true
+      this.emit('connect')
+    }
+    if (pending === 0) {
+      announce()
+      return
+    }
+    for (const topic of batches) {
+      this._mqttSubscribe(topic, undefined, () => {
+        pending -= 1
+        if (pending === 0) announce()
+      })
     }
-    this.emit('connect')
   }
 
   _publishAgentInfoMessage () {
@@ -504,7 +550,9 @@ class VrpcAgent extends EventEmitter {
       const entry = this._isolatedInstances.get(connectionId)
       if (entry) {
         entry.forEach(instanceId => {
+          const known = VrpcAdapter._instances.get(instanceId)
           const json = {
+            c: known && known.className,
             f: '__delete__',
             a: [instanceId],
             r: null,
@@ -512,6 +560,8 @@ class VrpcAgent extends EventEmitter {
           }
           VrpcAdapter._call(json)
           if (json.r) {
+            // gone like a remote delete: no request topic outlives it
+            this._unsubscribeMethodsOfDeletedInstance(known.className, instanceId)
             this._log.debug(`Auto-deleted isolated instance: ${instanceId}`)
           }
         })
@@ -592,14 +642,19 @@ class VrpcAgent extends EventEmitter {
     return true
   }
 
+  /** The request topics of one instance: every method of it. */
+  _methodsTopic (className, instance) {
+    return `${this._baseTopic}/${className}/${instance}/+`
+  }
+
   _subscribeToMethodsOfNewInstance (className, instance) {
-    const topic = `${this._baseTopic}/${className}/${instance}/+`
+    const topic = this._methodsTopic(className, instance)
     this._mqttSubscribe(topic)
     this._log.debug(`Subscribed to new topic after instantiation: ${topic}`)
   }
 
   _unsubscribeMethodsOfDeletedInstance (className, instance) {
-    const topic = `${this._baseTopic}/${className}/${instance}/+`
+    const topic = this._methodsTopic(className, instance)
     this._mqttUnsubscribe(topic)
     this._log.debug(`Unsubscribed from topic after deletion: ${topic}`)
   }
@@ -614,6 +669,8 @@ class VrpcAgent extends EventEmitter {
   }
 
   _handleClose () {
+    // the next connection prepares and announces itself afresh
+    this._serving = false
     this.emit('close')
   }
 

package/vrpc/VrpcClient.js

@@ -546,7 +546,27 @@ class VrpcClient extends EventEmitter {
     const topic = `${this._domain}/${agent}/${className}/__static__/__delete__`
     this._mqttPublish(topic, JSON.stringify(json))
     delete this._proxies[`${agent}/${className}/${instance}`]
-    return this._handleAgentAnswer(json, agent)
+    const deleted = await this._handleAgentAnswer(json, agent)
+    // the answer and the class info that no longer lists the instance
+    // travel on different topics, and a broker need not keep their order:
+    // what this client deleted is gone for it at once
+    if (deleted === true) this._forgetInstance({ agent, className, instance })
+    return deleted
+  }
+
+  /**
+   * Takes an instance off this client's view of its agent, the way a class
+   * info without it does: listing, instanceGone, cached subscriptions. A
+   * class info that arrives later finds nothing left to remove.
+   */
+  _forgetInstance ({ agent, className, instance }) {
+    const info = this._agents[agent] && this._agents[agent].classes[className]
+    if (!info || !Array.isArray(info.instances)) return
+    if (!info.instances.includes(instance)) return
+    info.instances = info.instances.filter(x => x !== instance)
+    const domain = this._domain
+    this.emit('instanceGone', [instance], { domain, agent, className })
+    this._clearCachedSubscriptions({ lostInstance: instance, agent, className })
   }
 
   /**

package/vrpc/VrpcPersistor.js

@@ -98,6 +98,8 @@ class VrpcPersistor {
         .replace(/[^a-zA-Z0-9]/g, '-')}`
 
     this._storage = null
+    // the 'update' listener on each persisted instance, dropped on delete
+    this._updateListeners = new Map()
     this._isInitialized = this._init(Storage)
 
     this._log.info(
@@ -282,7 +284,11 @@ class VrpcPersistor {
           const obj = VrpcAdapter.getInstance(instance)
           // Ensure the object is an event emitter
           if (obj && typeof obj.on === 'function') {
-            obj.on('update', data => {
+            const listener = data => {
+              // a deleted object never rewrites the record of its name
+              // (#1705): an in-process delete announces nothing
+              const live = VrpcAdapter._instances.get(instance)
+              if (!live || live.instance !== obj) return
               this._log.info(
                 `[VrpcPersistor] Persisting update for: ${instance} (${className})`
               )
@@ -293,7 +299,9 @@ class VrpcPersistor {
                   `[VrpcPersistor] Failed persisting update of ${instance} (${className}): ${err.message}`
                 )
               )
-            })
+            }
+            obj.on('update', listener)
+            this._updateListeners.set(instance, { obj, listener })
           }
         } catch (err) {
           this._log.warn(
@@ -304,6 +312,11 @@ class VrpcPersistor {
 
       // Persist instance deletion
       VrpcAdapter.on('delete', ({ instance, className }) => {
+        const update = this._updateListeners.get(instance)
+        if (update) {
+          this._updateListeners.delete(instance)
+          update.obj.removeListener('update', update.listener)
+        }
         this._log.info(
           `[VrpcPersistor] Deleting persisted instance: ${instance} (${className})`
         )

package/vrpc/comment-parser/parser.js

@@ -230,6 +230,17 @@ function mkextract (opts) {
       indent = startPos + MARKER_START.length
     }
 
+    // a member with a computed key ([Symbol.asyncDispose]) names no remote
+    // function: the block documents it and nothing else - without this it
+    // landed on the first call in the member's body
+    if (
+      findMethod &&
+      /^\s*(static\s+)?(async\s+)?\*?\s*((get|set)\s+)?\[[^\]]+\]\s*\(/.test(line)
+    ) {
+      result = parse_block(chunk, opts)
+      findMethod = false
+    }
+
     if (findMethod) {
       const ret = line.match(/\s*function\s+(\w+)\s*\(/) ||
         line.match(/\s*(\w+)\s*=?\s*\(/)