dht-rpc 6.20.2 → 6.22.0

package/README.md

@@ -123,7 +123,9 @@ Options include:
   // Optionally pass a UDX instance on which sockets will be created.
   udx,
   // dht-rpc will automatically detect if you are firewalled. If you know that you are not set this to false
-  firewalled: true
+  firewalled: true,
+  // dht-rpc will hint when a node is down if a request times out. Setting to false disables sending hints
+  sendDownHints: true
 }
 ```
 

package/index.js

@@ -22,6 +22,11 @@ const REFRESH_TICKS = 60 // refresh every ~5min when idle
 const RECENT_NODE = 12 // we've heard from a node less than 1min ago
 const OLD_NODE = 360 // if an node has been around more than 30 min we consider it old
 
+const DEFAULTS = {
+  concurrency: 10,
+  maxWindow: IO.DEFAULT_MAX_WINDOW
+}
+
 class DHT extends EventEmitter {
   constructor(opts = {}) {
     super()
@@ -37,7 +42,7 @@ class DHT extends EventEmitter {
       ontimeout: this._ontimeout.bind(this)
     })
 
-    this.concurrency = opts.concurrency || 10
+    this.concurrency = opts.concurrency || DEFAULTS.concurrency
     this.bootstrapped = false
     this.ephemeral = true
     this.firewalled = this.io.firewalled
@@ -72,6 +77,7 @@ class DHT extends EventEmitter {
     this._nonePersistentSamples = []
     this._bootstrapping = this._bootstrap()
     this._bootstrapping.catch(noop)
+    this._sendDownHints = opts.sendDownHints !== false
 
     this.table.on('row', this._onrow)
 
@@ -84,6 +90,8 @@ class DHT extends EventEmitter {
     }
   }
 
+  static DEFAULTS = DEFAULTS
+
   static bootstrapper(port, host, opts) {
     if (!port) throw new Error('Port is required')
     if (!host) throw new Error('Host is required')
@@ -348,6 +356,7 @@ class DHT extends EventEmitter {
   }
 
   _request(to, force, internal, command, target, value, session, onresponse, onerror) {
+    if (!this._sendDownHints && command === DOWN_HINT) return null
     const req = this.io.createRequest(to, null, internal, command, target, value, session)
     if (req === null) return null
 

package/lib/io.js

@@ -9,13 +9,14 @@ const VERSION = 0b11
 const RESPONSE_ID = (0b0001 << 4) | VERSION
 const REQUEST_ID = (0b0000 << 4) | VERSION
 const EMPTY_ARRAY = []
+const MAX_WINDOW = 80
 
 module.exports = class IO {
   constructor(
     table,
     udx,
     {
-      maxWindow = 80,
+      maxWindow = MAX_WINDOW,
       port = 0,
       host = '0.0.0.0',
       anyPort = true,
@@ -37,7 +38,13 @@ module.exports = class IO {
     this.suspended = false
 
     this.stats = {
-      requests: { active: 0, total: 0 },
+      requests: {
+        active: 0,
+        total: 0,
+        responses: 0,
+        timeouts: 0,
+        retries: 0
+      },
       commands: [
         { tx: 0, rx: 0 }, // tx = transmitted, rx = received
         { tx: 0, rx: 0 },
@@ -67,6 +74,8 @@ module.exports = class IO {
     this._boundClientPort = 0
   }
 
+  static DEFAULT_MAX_WINDOW = MAX_WINDOW
+
   onmessage(socket, buffer, { host, port }) {
     if (buffer.byteLength < 2 || !(port > 0 && port < 65536) || this.suspended === true) return
 
@@ -119,6 +128,7 @@ module.exports = class IO {
         }
 
         this.stats.requests.active--
+        this.stats.requests.responses++
 
         this.onresponse(res, external)
         req.onresponse(res, req)
@@ -575,9 +585,11 @@ function oncycle(req) {
   req._timeout = null
   req.oncycle(req)
   if (req.sent >= req.retries) {
+    req._io.stats.requests.timeouts++
     req.destroy(REQUEST_TIMEOUT())
     req._io.ontimeout(req)
   } else {
+    req._io.stats.requests.retries++
     req.send()
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dht-rpc",
-  "version": "6.20.2",
+  "version": "6.22.0",
   "description": "Make RPC calls over a Kademlia based DHT",
   "main": "index.js",
   "files": [