bare-rpc 1.3.6 → 1.3.8

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')
@@ -28,6 +29,9 @@ module.exports = exports = class RPC {
     this._frame = -1
     this._draining = []
 
+    this._closed = false
+    this._error = null
+
     if (typeof onrequest === 'function') {
       onrequest = onrequest.bind(this)
     } else {
@@ -36,10 +40,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
@@ -95,6 +104,11 @@ module.exports = exports = class RPC {
   }
 
   _sendRequest(request, data = null) {
+    // Once the channel has been torn down there is nowhere left to send the
+    // request. Skip registering it so that it never leaks into the maps; the
+    // awaiting reply is rejected through `RPCOutgoingRequest.reply()` instead.
+    if (this._closed) return
+
     this._outgoingRequests.set(request.id, request)
 
     this._sendMessage({
@@ -108,21 +122,33 @@ module.exports = exports = class RPC {
 
   _createRequestStream(request, isInitiator, opts) {
     if (isInitiator) {
-      this._outgoingRequests.set(request.id, request)
-
       request._requestStream = new OutgoingStream(this, request, t.REQUEST, opts)
 
+      // Once the channel has been torn down there is nowhere left to open the
+      // stream, so destroy it right away rather than leave it hanging.
+      if (this._closed) return request._requestStream.destroy(this._error)
+
+      this._outgoingRequests.set(request.id, request)
+
       request._requestStream.on('close', () => this._gcOutgoingRequest(request))
     } else {
-      this._incomingRequests.set(request.id, request)
-
       request._requestStream = new IncomingStream(this, request, t.REQUEST, opts)
 
+      if (this._closed) return request._requestStream.destroy(this._error)
+
+      this._incomingRequests.set(request.id, request)
+
       request._requestStream.on('close', () => this._incomingRequests.delete(request.id))
     }
   }
 
   _sendResponse(request, data) {
+    // Once the channel has been torn down there is nowhere left to send the
+    // response, so drop it rather than encode and write a message that would
+    // only be discarded. The reply is fire-and-forget, so there is nothing to
+    // settle.
+    if (this._closed) return
+
     this._sendMessage({
       type: t.RESPONSE,
       id: request.id,
@@ -134,16 +160,22 @@ module.exports = exports = class RPC {
 
   _createResponseStream(request, isInitiator, opts) {
     if (isInitiator) {
-      this._outgoingResponses.set(request.id, request)
-
       request._responseStream = new OutgoingStream(this, request, t.RESPONSE, opts)
 
+      // Once the channel has been torn down there is nowhere left to open the
+      // stream, so destroy it right away rather than leave it hanging.
+      if (this._closed) return request._responseStream.destroy(this._error)
+
+      this._outgoingResponses.set(request.id, request)
+
       request._responseStream.on('close', () => this._outgoingResponses.delete(request.id))
     } else {
-      this._incomingResponses.set(request.id, request)
-
       request._responseStream = new IncomingStream(this, request, t.RESPONSE, opts)
 
+      if (this._closed) return request._responseStream.destroy(this._error)
+
+      this._incomingResponses.set(request.id, request)
+
       request._responseStream.on('close', () => {
         this._incomingResponses.delete(request.id)
 
@@ -175,6 +207,22 @@ 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) {
+    // Mark the channel as closed so that any calls made from here on are
+    // rejected or destroyed immediately rather than left hanging.
+    this._closed = true
+    this._error = err
+
     this._ondrain(err)
 
     // Reject any request awaiting a plain reply. Requests whose response is

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/lib/outgoing-request.js

@@ -46,6 +46,12 @@ module.exports = class RPCOutgoingRequest {
 
     this.received = true
 
+    // If the channel was torn down before a response arrived there is nothing
+    // left to await, so reject with the teardown error rather than hang. This
+    // covers both requests sent after teardown and requests still awaiting a
+    // reply when teardown happens.
+    if (this.rpc._closed && !this._responded) this._reject(this.rpc._error)
+
     return encoding ? this._promise.then((data) => c.decode(encoding, data)) : this._promise
   }
 

package/package.json

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