dht-rpc 6.22.0 → 6.23.0

package/index.js

@@ -6,6 +6,7 @@ const sodium = require('sodium-universal')
 const c = require('compact-encoding')
 const NatSampler = require('nat-sampler')
 const b4a = require('b4a')
+const NetworkHealth = require('./lib/health')
 const IO = require('./lib/io')
 const Query = require('./lib/query')
 const Session = require('./lib/session')
@@ -24,7 +25,8 @@ const OLD_NODE = 360 // if an node has been around more than 30 min we consider
 
 const DEFAULTS = {
   concurrency: 10,
-  maxWindow: IO.DEFAULT_MAX_WINDOW
+  maxWindow: IO.DEFAULT_MAX_WINDOW,
+  maxHealthWindow: NetworkHealth.DEFAULT_MAX_HEALTH_WINDOW
 }
 
 class DHT extends EventEmitter {
@@ -41,6 +43,7 @@ class DHT extends EventEmitter {
       onresponse: this._onresponse.bind(this),
       ontimeout: this._ontimeout.bind(this)
     })
+    this.health = new NetworkHealth(this, opts)
 
     this.concurrency = opts.concurrency || DEFAULTS.concurrency
     this.bootstrapped = false
@@ -50,6 +53,7 @@ class DHT extends EventEmitter {
     this.destroyed = false
     this.suspended = false
     this.online = true
+    this.degraded = false
     this.stats = {
       queries: { active: 0, total: 0 },
       requests: this.io.stats.requests,
@@ -158,6 +162,7 @@ class DHT extends EventEmitter {
     this._onwakeup()
     log('Resuming io')
     await this.io.resume()
+    this.health.reset()
     log('Done, dht resumed')
     this.io.networkInterfaces.on('change', (interfaces) => this._onnetworkchange(interfaces))
     this.refresh()
@@ -683,6 +688,8 @@ class DHT extends EventEmitter {
     ) {
       this.refresh()
     }
+
+    this.health.update()
   }
 
   async _updateNetworkState(onlyFirewall = false) {
@@ -866,17 +873,27 @@ class DHT extends EventEmitter {
     return q
   }
 
-  // called by the query
+  // called by health
   _online() {
-    if (this.online) return
+    if (this.online && !this.degraded) return
+    this.online = true
+    this.degraded = false
+    this.emit('network-update')
+  }
+
+  // called by health
+  _degraded() {
+    if (this.degraded) return
     this.online = true
+    this.degraded = true
     this.emit('network-update')
   }
 
-  // called by the query
+  // called by health
   _offline() {
     if (!this.online) return
     this.online = false
+    this.degraded = false
     this.emit('network-update')
   }
 }

package/lib/health.js

@@ -0,0 +1,67 @@
+const MAX_HEALTH_WINDOW = 4
+const RESPONSES_SANITY = 4
+const TIMEOUTS_SANITY = 4
+const TIMEOUTS_THRESHOLD = 0.1
+
+module.exports = class NetworkHealth {
+  static DEFAULT_MAX_HEALTH_WINDOW = MAX_HEALTH_WINDOW
+
+  constructor(dht, { maxHealthWindow = MAX_HEALTH_WINDOW } = {}) {
+    this._dht = dht
+    this._maxHealthWindow = maxHealthWindow
+    this._window = []
+    this._head = -1
+    this.online = true
+    this.degraded = false
+  }
+
+  get _tail() {
+    return (this._head + 1) % this._maxHealthWindow
+  }
+
+  get cold() {
+    return this._window.length < this._maxHealthWindow
+  }
+
+  reset() {
+    this._window = []
+    this._head = -1
+    this.online = true
+    this.degraded = false
+    this._dht._online()
+  }
+
+  update() {
+    this._head = this._tail
+    this._window[this._head] = {
+      responses: this._dht.stats.requests.responses,
+      timeouts: this._dht.stats.requests.timeouts
+    }
+
+    if (this.cold) return
+
+    const oldest = this._window[this._tail]
+    const newest = this._window[this._head]
+
+    const responses = newest.responses - oldest.responses
+    const timeouts = newest.timeouts - oldest.timeouts
+    const timeoutsRate = timeouts / (responses + timeouts)
+
+    if (responses > 0) {
+      this.online = true
+    }
+
+    if (responses > RESPONSES_SANITY * this._window.length) {
+      this.degraded = timeoutsRate > TIMEOUTS_THRESHOLD
+    }
+
+    if (responses === 0 && timeouts > TIMEOUTS_SANITY * this._window.length) {
+      this.online = false
+      this.degraded = false
+    }
+
+    if (this.online && !this.degraded) this._dht._online()
+    else if (this.degraded) this._dht._degraded()
+    else this._dht._offline()
+  }
+}

package/lib/query.js

@@ -30,7 +30,6 @@ module.exports = class Query extends Readable {
     this.closestReplies = []
 
     this._slow = 0
-    this._online = false
     this._slowdown = false
     this._seen = new Map()
     this._pending = []
@@ -262,9 +261,6 @@ module.exports = class Query extends Readable {
   _onvisit(m, req) {
     this._dec(req)
 
-    this._online = true
-    if (!this.dht.online) this.dht._online()
-
     const addr = req.to.host + ':' + req.to.port
     this._seen.set(addr, DONE)
 
@@ -380,7 +376,6 @@ module.exports = class Query extends Readable {
 
   _destroy(cb) {
     this.dht.stats.queries.active--
-    if (!this._online && this.dht.online) this.dht._offline()
     if (this._autoDestroySession) this._session.destroy()
     cb(null)
   }

package/package.json

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