dht-rpc 6.3.2 → 6.4.0

package/index.js

@@ -8,6 +8,7 @@ const NatSampler = require('nat-sampler')
 const b4a = require('b4a')
 const IO = require('./lib/io')
 const Query = require('./lib/query')
+const Session = require('./lib/session')
 const peer = require('./lib/peer')
 const { UNKNOWN_COMMAND, INVALID_TOKEN } = require('./lib/errors')
 const { PING, PING_NAT, FIND_NODE, DOWN_HINT } = require('./lib/commands')
@@ -150,15 +151,19 @@ class DHT extends EventEmitter {
 
     if (opts && opts.size && opts.size > 0) value = b4a.alloc(opts.size)
 
-    const req = this.io.createRequest({ id: null, host, port }, null, true, PING, null, value)
+    const req = this.io.createRequest({ id: null, host, port }, null, true, PING, null, value, (opts && opts.session) || null)
     return this._requestToPromise(req, opts)
   }
 
   request ({ token = null, command, target = null, value = null }, { host, port }, opts) {
-    const req = this.io.createRequest({ id: null, host, port }, token, false, command, target, value)
+    const req = this.io.createRequest({ id: null, host, port }, token, false, command, target, value, (opts && opts.session) || null)
     return this._requestToPromise(req, opts)
   }
 
+  session () {
+    return new Session(this)
+  }
+
   _requestToPromise (req, opts) {
     if (req === null) return Promise.reject(new Error('Node destroyed'))
 
@@ -212,7 +217,7 @@ class DHT extends EventEmitter {
       const value = b4a.allocUnsafe(2)
       c.uint16.encode({ start: 0, end: 2, buffer: value }, self.io.serverSocket.address().port)
 
-      self._request(data.from, true, PING_NAT, null, value, () => { testNat = true }, noop)
+      self._request(data.from, true, PING_NAT, null, value, null, () => { testNat = true }, noop)
     }
   }
 
@@ -227,8 +232,8 @@ class DHT extends EventEmitter {
     return this.io.destroy()
   }
 
-  _request (to, internal, command, target, value, onresponse, onerror) {
-    const req = this.io.createRequest(to, null, internal, command, target, value)
+  _request (to, internal, command, target, value, session, onresponse, onerror) {
+    const req = this.io.createRequest(to, null, internal, command, target, value, session)
     if (req === null) return null
 
     req.onresponse = onresponse
@@ -358,7 +363,7 @@ class DHT extends EventEmitter {
     oldNode.pinged = this._tick
 
     this._repinging++
-    this._request({ id: null, host: oldNode.host, port: oldNode.port }, true, PING, null, null, onsuccess, onswap)
+    this._request({ id: null, host: oldNode.host, port: oldNode.port }, true, PING, null, null, null, onsuccess, onswap)
 
     function onsuccess (m) {
       if (oldNode.seen <= lastSeen) return onswap()
@@ -475,7 +480,7 @@ class DHT extends EventEmitter {
     }
 
     this._checks++
-    this._request({ id: null, host: node.host, port: node.port }, true, PING, null, null, onresponse, onerror)
+    this._request({ id: null, host: node.host, port: node.port }, true, PING, null, null, null, onresponse, onerror)
   }
 
   _ontick () {
@@ -699,7 +704,7 @@ function requestAll (dht, internal, command, value, nodes) {
 
   return new Promise((resolve) => {
     for (const node of nodes) {
-      const req = dht._request(node, internal, command, null, value, onsuccess, onerror)
+      const req = dht._request(node, internal, command, null, value, null, onsuccess, onerror)
       if (!req) return resolve(replies)
     }
 

package/lib/io.js

@@ -69,6 +69,8 @@ module.exports = class IO {
         if (i === this.inflight.length - 1) this.inflight.pop()
         else this.inflight[i] = this.inflight.pop()
 
+        if (req.session) req.session._detach(req)
+
         // TODO: Auto retry here if errors.INVALID_TOKEN is returned?
 
         if (req._timeout) {
@@ -118,6 +120,8 @@ module.exports = class IO {
       req._timeout = null
       req.destroyed = true
 
+      if (req.session) req.session._detach(req)
+
       req.onerror(errors.createDestroyedError(), req)
     }
 
@@ -199,7 +203,7 @@ module.exports = class IO {
     }
   }
 
-  createRequest (to, token, internal, command, target, value) {
+  createRequest (to, token, internal, command, target, value, session) {
     if (this._destroying !== null) return null
 
     if (this._tid === 65536) this._tid = 0
@@ -207,14 +211,15 @@ module.exports = class IO {
     const tid = this._tid++
     const socket = this.firewalled ? this.clientSocket : this.serverSocket
 
-    const req = new Request(this, socket, tid, null, to, token, internal, command, target, value)
+    const req = new Request(this, socket, tid, null, to, token, internal, command, target, value, session)
     this.inflight.push(req)
+    if (session) session._attach(req)
     return req
   }
 }
 
 class Request {
-  constructor (io, socket, tid, from, to, token, internal, command, target, value) {
+  constructor (io, socket, tid, from, to, token, internal, command, target, value, session) {
     this.socket = socket
     this.tid = tid
     this.from = from
@@ -224,6 +229,8 @@ class Request {
     this.target = target
     this.value = value
     this.internal = internal
+    this.session = session
+    this.index = -1
     this.sent = 0
     this.retries = 3
     this.destroyed = false
@@ -251,7 +258,7 @@ class Request {
 
       if (id !== null) from.id = validateId(id, from)
 
-      return new Request(io, socket, tid, from, to, token, internal, command, target, value)
+      return new Request(io, socket, tid, from, to, token, internal, command, target, value, null)
     } catch {
       return null
     }
@@ -317,6 +324,8 @@ class Request {
     if (i === this._io.inflight.length - 1) this._io.inflight.pop()
     else this._io.inflight[i] = this._io.inflight.pop()
 
+    if (this.session) this.session._detach(this)
+
     this.onerror(err || errors.createDestroyedError(), this)
   }
 

package/lib/query.js

@@ -31,6 +31,8 @@ module.exports = class Query extends Readable {
     this._fromTable = false
     this._commit = opts.commit === true ? autoCommit : (opts.commit || null)
     this._commiting = false
+    this._session = opts.session || dht.session()
+    this._autoDestroySession = !opts.session
 
     this._onvisitbound = this._onvisit.bind(this)
     this._onerrorbound = this._onerror.bind(this)
@@ -284,7 +286,7 @@ module.exports = class Query extends Readable {
   _downHint (node, down) {
     const state = { start: 0, end: 6, buffer: b4a.allocUnsafe(6) }
     peer.ipv4.encode(state, down)
-    this.dht._request(node, true, DOWN_HINT, null, state.buffer, noop, noop)
+    this.dht._request(node, true, DOWN_HINT, null, state.buffer, this._session, noop, noop)
   }
 
   _pushClosest (m) {
@@ -318,13 +320,18 @@ module.exports = class Query extends Readable {
   _visit (to) {
     this.inflight++
 
-    const req = this.dht._request(to, this.internal, this.command, this.target, this.value, this._onvisitbound, this._onerrorbound)
+    const req = this.dht._request(to, this.internal, this.command, this.target, this.value, this._session, this._onvisitbound, this._onerrorbound)
     if (req === null) {
       this.destroy(new Error('Node was destroyed'))
       return
     }
     req.oncycle = this._oncyclebound
   }
+
+  _destroy (cb) {
+    if (this._autoDestroySession) this._session.destroy()
+    cb(null)
+  }
 }
 
 function autoCommit (reply, dht, query) {

package/lib/session.js

@@ -0,0 +1,41 @@
+module.exports = class Session {
+  constructor (dht) {
+    this.dht = dht
+    this.inflight = []
+  }
+
+  _attach (req) {
+    req.index = this.inflight.push(req) - 1
+  }
+
+  _detach (req) {
+    const i = req.index
+    if (i === -1) return
+    req.index = -1
+
+    if (i === this.inflight.length - 1) this.inflight.pop()
+    else {
+      const req = this.inflight[i] = this.inflight.pop()
+      req.index = i
+    }
+  }
+
+  query ({ target, command, value }, opts = {}) {
+    return this.dht.query({ target, command, value }, { ...opts, session: this })
+  }
+
+  request ({ token, command, target, value }, { host, port }, opts = {}) {
+    return this.dht.request({ token, command, target, value }, { host, port }, { ...opts, session: this })
+  }
+
+  ping ({ host, port }, opts = {}) {
+    return this.dht.ping({ host, port }, { ...opts, session: this })
+  }
+
+  destroy (err) {
+    while (this.inflight.length) {
+      const req = this.inflight[0]
+      req.destroy(err)
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dht-rpc",
-  "version": "6.3.2",
+  "version": "6.4.0",
   "description": "Make RPC calls over a Kademlia based DHT",
   "main": "index.js",
   "dependencies": {

package/test.js

@@ -396,6 +396,27 @@ test('filter nodes from routing table', async function (t) {
   t.absent(node.table.has(b.id), 'should not have b')
 })
 
+test('request session, destroy all', async function (t) {
+  const [, a, b] = await makeSwarm(3, t)
+
+  a.on('request', () => t.fail())
+
+  const s = b.session()
+  const p = [
+    s.request({ command: 42 }, a),
+    s.request({ command: 42 }, a)
+  ]
+
+  const err = new Error('destroyed')
+
+  s.destroy(err)
+
+  for (const { status, reason } of await Promise.allSettled(p)) {
+    t.is(status, 'rejected')
+    t.is(reason, err)
+  }
+})
+
 async function freePort () {
   const udx = new UDX()
   const sock = udx.createSocket()