bare-rpc 0.2.7 → 0.2.9

package/README.md

@@ -65,7 +65,7 @@ A boolean for whether the request has been sent.
 
 A boolean for whether the request has received a reply.
 
-#### `req.send(data[, encoding])`
+#### `req.send([data[, encoding]])`
 
 Send the request with the provided `data`. `data` can be a buffer or a string which will be encoded using `encoding`.
 
@@ -101,7 +101,7 @@ A boolean for whether a reply has been sent.
 
 A boolean for whether the request has been received as a stream. See [`req.createRequestStream()`](#const-stream--reqcreaterequeststream) for receiving requests as a stream.
 
-#### `req.reply(data, [encoding])`
+#### `req.reply([data, [encoding]])`
 
 Reply to the request with the provided `data`. `data` can be a buffer or a string which will be encoded using `encoding`.
 
@@ -141,12 +141,12 @@ Define a command and the handler for it. The callback for a command receives bot
 
 Options include:
 
-```
-{
+```js
+options = {
   // Encoding for incoming request
   requestEncoding: c.raw,
   // Encoding for outgoing response
-  responseEncoding: c.raw,
+  responseEncoding: c.raw
 }
 ```
 

package/index.d.ts

@@ -27,11 +27,11 @@ interface RPCIncomingRequest {
   readonly rpc: RPC
   readonly id: number
   readonly command: number
-  readonly data: Buffer
+  readonly data: Buffer | null
   readonly sent: boolean
   readonly received: boolean
 
-  reply(data: Buffer | string, encoding?: BufferEncoding): void
+  reply(data?: Buffer | string | null, encoding?: BufferEncoding): void
 
   createResponseStream(opts?: WritableOptions): RPCOutgoingStream
   createRequestStream(opts?: ReadableOptions): RPCIncomingStream
@@ -48,9 +48,9 @@ interface RPCOutgoingRequest {
   readonly sent: boolean
   readonly received: boolean
 
-  send(data: Buffer | string, encoding?: BufferEncoding): void
+  send(data?: Buffer | string | null, encoding?: BufferEncoding): void
 
-  reply(encoding?: BufferEncoding): Promise<Buffer | string>
+  reply(encoding?: BufferEncoding): Promise<Buffer | string | null>
 
   createRequestStream(opts?: WritableOptions): RPCOutgoingStream
   createResponseStream(opts?: ReadableOptions): RPCIncomingStream

package/index.js

@@ -24,6 +24,7 @@ module.exports = exports = class RPC {
     this._buffer = []
     this._buffered = 0
     this._frame = -1
+    this._draining = []
 
     if (typeof onrequest === 'function') {
       onrequest = onrequest.bind(this)
@@ -33,20 +34,29 @@ module.exports = exports = class RPC {
 
     this._onrequest = onrequest
     this._ondata = this._ondata.bind(this)
+    this._ondrain = this._ondrain.bind(this)
 
-    this._stream.on('data', this._ondata)
+    this._stream
+      .on('error', this._onerror)
+      .on('data', this._ondata)
+      .on('drain', this._ondrain)
   }
 
   request(command) {
     return new OutgoingRequest(this, ++this._id, command)
   }
 
-  _sendMessage(message) {
+  _sendMessage(message, cb) {
     const header = c.encode(m.header, message)
 
-    this._stream.write(header)
+    let flushed = this._stream.write(header)
 
-    if (message.data) this._stream.write(message.data)
+    if (message.data) flushed = this._stream.write(message.data)
+
+    if (cb) {
+      if (flushed) cb(null)
+      else this._draining.push(cb)
+    }
   }
 
   _sendRequest(request, data = null) {
@@ -133,6 +143,12 @@ module.exports = exports = class RPC {
     })
   }
 
+  _onerror(err) {
+    this._ondrain(err)
+
+    // TODO Destroy pending requests and responses
+  }
+
   _ondata(data) {
     this._buffer.push(data)
     this._buffered += data.byteLength
@@ -404,6 +420,14 @@ module.exports = exports = class RPC {
 
     stream.destroy(message.error)
   }
+
+  _ondrain(err = null) {
+    const draining = this._draining
+
+    this._draining = []
+
+    for (const cb of draining) cb(err)
+  }
 }
 
 exports.CommandRouter = CommandRouter

package/lib/incoming-stream.js

@@ -12,15 +12,16 @@ module.exports = class RPCIncomingStream extends Readable {
   }
 
   _open(cb) {
-    this._rpc._sendMessage({
-      type: t.STREAM,
-      id: this._request.id,
-      stream: this._mask | s.OPEN,
-      error: null,
-      data: null
-    })
-
-    cb(null)
+    this._rpc._sendMessage(
+      {
+        type: t.STREAM,
+        id: this._request.id,
+        stream: this._mask | s.OPEN,
+        error: null,
+        data: null
+      },
+      cb
+    )
   }
 
   _read() {
@@ -35,23 +36,27 @@ module.exports = class RPCIncomingStream extends Readable {
 
   _destroy(err, cb) {
     if (err) {
-      this._rpc._sendMessage({
-        type: t.STREAM,
-        id: this._request.id,
-        stream: this._mask | s.DESTROY | s.ERROR,
-        error: err,
-        data: null
-      })
+      this._rpc._sendMessage(
+        {
+          type: t.STREAM,
+          id: this._request.id,
+          stream: this._mask | s.DESTROY | s.ERROR,
+          error: err,
+          data: null
+        },
+        cb
+      )
     } else {
-      this._rpc._sendMessage({
-        type: t.STREAM,
-        id: this._request.id,
-        stream: this._mask | s.DESTROY,
-        error: null,
-        data: null
-      })
+      this._rpc._sendMessage(
+        {
+          type: t.STREAM,
+          id: this._request.id,
+          stream: this._mask | s.DESTROY,
+          error: null,
+          data: null
+        },
+        cb
+      )
     }
-
-    cb(null)
   }
 }

package/lib/messages.js

@@ -52,7 +52,7 @@ exports.header = {
         break
     }
 
-    if (hasData) c.uint.preencode(state, m.data.byteLength)
+    if (hasData) c.uint.preencode(state, m.data ? m.data.byteLength : 0)
   },
   encode(state, m) {
     const frame = state.start
@@ -89,13 +89,16 @@ exports.header = {
         break
     }
 
-    if (hasData) c.uint.encode(state, m.data.byteLength)
+    if (hasData) c.uint.encode(state, m.data ? m.data.byteLength : 0)
 
     const end = state.start
 
     state.start = frame
 
-    c.uint32.encode(state, end - start + (hasData ? m.data.byteLength : 0))
+    c.uint32.encode(
+      state,
+      end - start + (hasData && m.data ? m.data.byteLength : 0)
+    )
 
     state.start = end
   }

package/lib/outgoing-stream.js

@@ -16,39 +16,47 @@ module.exports = class RPCOutgoingStream extends Writable {
   _open(cb) {
     let pending
 
+    const onflushed = () => {
+      if (pending.has(this._request.id)) {
+        pending.delete(this._request.id)
+
+        cb(null)
+      } else {
+        this._pendingOpen = cb
+      }
+    }
+
     switch (this._type) {
       case t.REQUEST:
         pending = this._rpc._pendingRequests
 
-        this._rpc._sendMessage({
-          type: t.REQUEST,
-          id: this._request.id,
-          command: this._request.command,
-          stream: s.OPEN,
-          data: null
-        })
+        this._rpc._sendMessage(
+          {
+            type: t.REQUEST,
+            id: this._request.id,
+            command: this._request.command,
+            stream: s.OPEN,
+            data: null
+          },
+          onflushed
+        )
         break
 
       case t.RESPONSE:
         pending = this._rpc._pendingResponses
 
-        this._rpc._sendMessage({
-          type: t.RESPONSE,
-          id: this._request.id,
-          error: false,
-          stream: s.OPEN,
-          data: null
-        })
+        this._rpc._sendMessage(
+          {
+            type: t.RESPONSE,
+            id: this._request.id,
+            error: false,
+            stream: s.OPEN,
+            data: null
+          },
+          onflushed
+        )
         break
     }
-
-    if (pending.has(this._request.id)) {
-      pending.delete(this._request.id)
-
-      cb(null)
-    } else {
-      this._pendingOpen = cb
-    }
   }
 
   _continueOpen() {
@@ -59,48 +67,54 @@ module.exports = class RPCOutgoingStream extends Writable {
   }
 
   _write(data, encoding, cb) {
-    this._rpc._sendMessage({
-      type: t.STREAM,
-      id: this._request.id,
-      stream: this._mask | s.DATA,
-      error: null,
-      data
-    })
-
-    cb(null)
+    this._rpc._sendMessage(
+      {
+        type: t.STREAM,
+        id: this._request.id,
+        stream: this._mask | s.DATA,
+        error: null,
+        data
+      },
+      cb
+    )
   }
 
   _final(cb) {
-    this._rpc._sendMessage({
-      type: t.STREAM,
-      id: this._request.id,
-      stream: this._mask | s.END,
-      error: null,
-      data: null
-    })
-
-    cb(null)
+    this._rpc._sendMessage(
+      {
+        type: t.STREAM,
+        id: this._request.id,
+        stream: this._mask | s.END,
+        error: null,
+        data: null
+      },
+      cb
+    )
   }
 
   _destroy(err, cb) {
     if (err) {
-      this._rpc._sendMessage({
-        type: t.STREAM,
-        id: this._request.id,
-        stream: this._mask | s.CLOSE | s.ERROR,
-        error: err,
-        data: null
-      })
+      this._rpc._sendMessage(
+        {
+          type: t.STREAM,
+          id: this._request.id,
+          stream: this._mask | s.CLOSE | s.ERROR,
+          error: err,
+          data: null
+        },
+        cb
+      )
     } else {
-      this._rpc._sendMessage({
-        type: t.STREAM,
-        id: this._request.id,
-        stream: this._mask | s.CLOSE,
-        error: null,
-        data: null
-      })
+      this._rpc._sendMessage(
+        {
+          type: t.STREAM,
+          id: this._request.id,
+          stream: this._mask | s.CLOSE,
+          error: null,
+          data: null
+        },
+        cb
+      )
     }
-
-    cb(null)
   }
 }

package/package.json

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