bare-rpc 1.3.5 → 1.3.7

package/index.js

@@ -2,6 +2,7 @@ const safetyCatch = require('safety-catch')
 const b4a = require('b4a')
 const c = require('compact-encoding')
 const m = require('./lib/messages')
+const errors = require('./lib/errors')
 const { type: t, stream: s } = require('./lib/constants')
 const IncomingEvent = require('./lib/incoming-event')
 const IncomingRequest = require('./lib/incoming-request')
@@ -36,10 +37,15 @@ module.exports = exports = class RPC {
 
     this._onrequest = onrequest
     this._onerror = this._onerror.bind(this)
+    this._onclose = this._onclose.bind(this)
     this._ondata = this._ondata.bind(this)
     this._ondrain = this._ondrain.bind(this)
 
-    this._stream.on('error', this._onerror).on('data', this._ondata).on('drain', this._ondrain)
+    this._stream
+      .on('error', this._onerror)
+      .on('close', this._onclose)
+      .on('data', this._ondata)
+      .on('drain', this._ondrain)
   }
 
   // Whether there are no requests or responses currently in flight. Useful for
@@ -64,6 +70,14 @@ module.exports = exports = class RPC {
   }
 
   _sendMessage(message, cb) {
+    // Once the underlying stream is being torn down there is nowhere left to
+    // write, so drop the message and settle the callback immediately. This
+    // keeps stream teardown from stalling on a drain that will never arrive.
+    if (this._stream.destroying) {
+      if (cb) cb(null)
+      return
+    }
+
     const header = c.encode(m.header, message)
 
     let flushed = this._stream.write(header)
@@ -167,9 +181,53 @@ module.exports = exports = class RPC {
   }
 
   _onerror(err) {
+    this._teardown(err)
+  }
+
+  _onclose() {
+    // A clean close of the underlying stream leaves in-flight requests and
+    // responses with nowhere to complete, so tear them down as if the channel
+    // had errored.
+    this._teardown(errors.CHANNEL_CLOSED('Channel closed'))
+  }
+
+  _teardown(err) {
     this._ondrain(err)
 
-    // TODO Destroy pending requests and responses
+    // Reject any request awaiting a plain reply. Requests whose response is
+    // delivered over a stream are torn down through that stream below.
+    for (const request of this._outgoingRequests.values()) {
+      if (request.received && request._responseStream === null) request._reject(err)
+    }
+
+    // Collect the streams first, deduplicating as a single request may appear
+    // in more than one map, then destroy them once the maps have been cleared.
+    const streams = new Set()
+
+    for (const request of this._outgoingRequests.values()) {
+      if (request._requestStream !== null) streams.add(request._requestStream)
+    }
+
+    for (const request of this._incomingRequests.values()) {
+      if (request._requestStream !== null) streams.add(request._requestStream)
+    }
+
+    for (const request of this._outgoingResponses.values()) {
+      if (request._responseStream !== null) streams.add(request._responseStream)
+    }
+
+    for (const request of this._incomingResponses.values()) {
+      if (request._responseStream !== null) streams.add(request._responseStream)
+    }
+
+    this._outgoingRequests.clear()
+    this._outgoingResponses.clear()
+    this._incomingRequests.clear()
+    this._incomingResponses.clear()
+    this._pendingRequests.clear()
+    this._pendingResponses.clear()
+
+    for (const stream of streams) stream.destroy(err)
   }
 
   _ondata(data) {

package/lib/errors.d.ts

@@ -1,6 +1,8 @@
 declare class RPCError extends Error {
   static UNKNOWN_MESSAGE(msg: string): RPCError
   static ALREADY_SENT(msg: string): RPCError
+  static ALREADY_RECEIVED(msg: string): RPCError
+  static CHANNEL_CLOSED(msg: string): RPCError
 }
 
 export = RPCError

package/lib/errors.js

@@ -23,4 +23,8 @@ module.exports = class RPCError extends Error {
   static ALREADY_RECEIVED(msg) {
     return new RPCError(msg, 'ALREADY_RECEIVED', RPCError.ALREADY_RECEIVED)
   }
+
+  static CHANNEL_CLOSED(msg) {
+    return new RPCError(msg, 'CHANNEL_CLOSED', RPCError.CHANNEL_CLOSED)
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-rpc",
-  "version": "1.3.5",
+  "version": "1.3.7",
   "description": "librpc ABI compatible RPC for Bare",
   "exports": {
     ".": {