vrpc 3.12.0 → 3.13.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vrpc",
-  "version": "3.12.0",
+  "version": "3.13.0",
   "description": "Variadic Remote Procedure Calls",
   "main": "index.js",
   "directories": {
@@ -12,7 +12,7 @@
     "build:addon": "ln -sf binding.gyp.no-auto binding.gyp && node-gyp rebuild && rm binding.gyp",
     "build:browser": "./node_modules/.bin/webpack --stats-error-details",
     "build:doc": "./node_modules/.bin/jsdoc2md -f vrpc/VrpcAdapter.js vrpc/VrpcAgent.js vrpc/VrpcClient.js vrpc/VrpcNative.js --param-list-format=list --separators > docs/api.md",
-    "test": "npm run test:adapter && npm run test:agent && npm run test:client && npm run test:persistor && npm run test:lifecycle && npm run test:production",
+    "test": "npm run test:adapter && npm run test:agent && npm run test:client && npm run test:persistor && npm run test:lifecycle && npm run test:legacy-runtime && npm run test:production",
     "test:adapter": "./node_modules/.bin/mocha tests/adapter/*.js --exit",
     "test:native": "./node_modules/.bin/mocha tests/native/*.js --exit",
     "test:agent": "tests/agent/test.sh",
@@ -20,6 +20,7 @@
     "test:performance": "tests/performance/test.sh",
     "test:persistor": "./node_modules/.bin/mocha tests/persistor/*.js --timeout 30000 --exit",
     "test:lifecycle": "./node_modules/.bin/mocha tests/lifecycle/*.js --timeout 30000 --exit",
+    "test:legacy-runtime": "tests/legacy-runtime/test.sh",
     "test:production": "./node_modules/.bin/mocha tests/production/lifeCycleTest.js --timeout 30000 --exit && tests/production/test.sh"
   },
   "bin": {

package/vrpc/VrpcAdapter.js

@@ -43,6 +43,17 @@ const commentParser = require('./comment-parser')
 const EventEmitter = require('events')
 const { nanoid } = require('nanoid')
 
+// Node before 18.18 / 20.4 has no dispose symbols, and a class's
+// [Symbol.asyncDispose]() would become a method named 'undefined'. Node's
+// own stand-ins live in 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')
+}
+
 /**
  * Generates an adapter layer for existing code and enables further VRPC-based
  * communication.
@@ -197,7 +208,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
@@ -208,10 +222,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
     }
@@ -577,11 +588,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 port or a session 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) {
       const { message, cause } = err
       json.e = { message, cause }
@@ -603,6 +620,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)
     // special case: removing a listener the adapter does not hold (the
     // client's subscription outlived a restart of this agent, or it sent
@@ -671,33 +697,115 @@ 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). Node has no destructor, so an object that runs a
+   * clock or holds a connection lives on as long as anything reaches it;
+   * ending it takes three steps:
+   * 1. its name is free at once: no call reaches the object any more;
+   * 2. the adapter takes back every listener it attached (its listeners are
+   *    silent from now on anyway, see _generateListener);
+   * 3. 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]
         }
       })
     })
@@ -774,8 +882,27 @@ 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 (#1705), 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 _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 })
@@ -820,7 +947,9 @@ class VrpcAdapter {
   }
 
   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 })
     }
@@ -1003,12 +1132,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/VrpcAgent.js

@@ -145,6 +145,13 @@ 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()
@@ -153,6 +160,11 @@ class VrpcAgent extends EventEmitter {
       subscribe: (topics, options) => this._mqttSubscribe(topics, options),
       log: this._log
     })
+    // 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 => {
@@ -172,8 +184,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
@@ -226,6 +239,7 @@ class VrpcAgent extends EventEmitter {
    * @returns {Promise} Resolves when disconnected and ended
    */
   async end ({ unregister = false } = {}) {
+    VrpcAdapter.off('disposeFailed', this._handleDisposeFailed)
     this._subscribeRetrier.cancel()
     try {
       if (!this._client || !this._client.connected) {
@@ -377,7 +391,13 @@ class VrpcAgent extends EventEmitter {
     )
   }
 
-  _mqttSubscribe (topic, options) {
+  /**
+   * Subscribes topic(s); `onSettled` is called once the broker has
+   * answered (granted, refused or failed alike).
+   *
+   * @private
+   */
+  _mqttSubscribe (topic, options, onSettled) {
     this._client.subscribe(
       topic,
       { qos: this._qos, ...options },
@@ -424,6 +444,7 @@ class VrpcAgent extends EventEmitter {
             this._log.debug(`Already subscribed to topic '${topic}'`)
           }
         }
+        if (onSettled) onSettled()
       }
     )
   }
@@ -458,12 +479,18 @@ 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.
+   *
+   * @private
+   */
   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)
       }
@@ -502,36 +529,64 @@ class VrpcAgent extends EventEmitter {
     return str
   }
 
+  /**
+   * Serve first, announce second. The request topics - the statics and
+   * the methods of every instance that exists already - are subscribed
+   * before the agent publishes its agent and class info, and the
+   * announcement waits until the broker has answered every subscription.
+   * A client acts on the announcement at once; a request it publishes
+   * before the broker routes the topic is lost (QoS 0) and only times out
+   * on the caller's side. That was the fate of the first call into an
+   * agent that came online after the client waiting for it. A refused
+   * subscription is the retrier's business and delays nothing.
+   *
+   * @private
+   */
   _handleConnect () {
     this._log.info('[OK]')
     // everything is subscribed afresh: pending retries are moot
     this._subscribeRetrier.cancel()
+    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)
-      this._publishClassInfoConciseMessage(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._publishClassInfoConciseMessage(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 () {
@@ -697,7 +752,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,
@@ -705,6 +762,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}`)
           }
         })
@@ -785,14 +844,23 @@ class VrpcAgent extends EventEmitter {
     return true
   }
 
+  /**
+   * The request topics of one instance: every method of it.
+   *
+   * @private
+   */
+  _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}`)
   }
@@ -807,6 +875,8 @@ class VrpcAgent extends EventEmitter {
   }
 
   _handleClose () {
+    // the next connection prepares and announces itself afresh
+    this._serving = false
     this.emit('close')
   }