dht-rpc 6.26.2 → 6.26.4

package/index.js

@@ -26,7 +26,6 @@ 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,
-  maxHealthWindow: NetworkHealth.DEFAULT_MAX_HEALTH_WINDOW,
   maxPingDelay: 10_000
 }
 
@@ -44,7 +43,7 @@ class DHT extends EventEmitter {
       onresponse: this._onresponse.bind(this),
       ontimeout: this._ontimeout.bind(this)
     })
-    this.health = new NetworkHealth(this, opts)
+    this.health = new NetworkHealth(this)
 
     this.concurrency = opts.concurrency || DEFAULTS.concurrency
     this.maxPingDelay = opts.maxPingDelay || DEFAULTS.maxPingDelay

package/lib/health.js

@@ -1,15 +1,16 @@
 const MAX_HEALTH_WINDOW = 4
-const TIMEOUTS_THRESHOLD = 0.5
+const OFFLINE_THRESHOLD = 2
 const IDLE_THRESHOLD = 4
+const DEGRADED_TIMEOUT_RATE_THRESHOLD = 0.5
 
 module.exports = class NetworkHealth {
-  static DEFAULT_MAX_HEALTH_WINDOW = MAX_HEALTH_WINDOW
-
-  constructor(dht, { maxHealthWindow = MAX_HEALTH_WINDOW } = {}) {
+  constructor(dht) {
     this._dht = dht
-    this._maxHealthWindow = maxHealthWindow
     this._window = []
     this._head = -1
+    this._offlineTicks = 0
+    this._degradedTicks = 0
+    this._healthyTicks = 0
     this.online = true
     this.degraded = false
   }
@@ -19,44 +20,34 @@ module.exports = class NetworkHealth {
   }
 
   get previous() {
-    return this._window[(this._head - 1 + this._maxHealthWindow) % this._maxHealthWindow]
+    return this._window[(this._head - 1 + MAX_HEALTH_WINDOW) % MAX_HEALTH_WINDOW]
   }
 
   get newest() {
     return this._window[this._head]
   }
 
-  get recentResponses() {
+  get responses() {
     if (!this.newest || !this.previous) return 0
     return this.newest.responses - this.previous.responses
   }
 
-  get recentTimeouts() {
+  get timeouts() {
     if (!this.newest || !this.previous) return 0
     return this.newest.timeouts - this.previous.timeouts
   }
 
-  get responses() {
-    if (!this.newest || !this.oldest) return 0
-    return this.newest.responses - this.oldest.responses
-  }
-
-  get timeouts() {
-    if (!this.newest || !this.oldest) return 0
-    return this.newest.timeouts - this.oldest.timeouts
-  }
-
   get timeoutsRate() {
     if (this.timeouts === 0) return 0
     return this.timeouts / (this.responses + this.timeouts)
   }
 
   get cold() {
-    return this._window.length < this._maxHealthWindow
+    return this._window.length < MAX_HEALTH_WINDOW
   }
 
   get idle() {
-    return this.recentResponses + this.recentTimeouts < IDLE_THRESHOLD
+    return this.responses + this.timeouts < IDLE_THRESHOLD
   }
 
   get stats() {
@@ -67,33 +58,62 @@ module.exports = class NetworkHealth {
       idle: this.idle,
       responses: this.responses,
       timeouts: this.timeouts,
-      timeoutsRate: this.timeoutsRate,
-      recentResponses: this.recentResponses,
-      recentTimeouts: this.recentTimeouts
+      timeoutsRate: this.timeoutsRate
     }
   }
 
   get _tail() {
-    return (this._head + 1) % this._maxHealthWindow
+    return (this._head + 1) % MAX_HEALTH_WINDOW
   }
 
   reset() {
     this._window = []
     this._head = -1
+    this._offlineTicks = 0
+    this._degradedTicks = 0
+    this._healthyTicks = 0
+    this.online = true
+    this.degraded = false
+    this._dht._online()
   }
 
   update() {
+    // update counters before dropping oldest
+    if (this.oldest?.degraded) this._degradedTicks--
+    else if (this.oldest?.degraded === false) this._healthyTicks--
+
+    // move window
     this._head = this._tail
     this._window[this._head] = {
       responses: this._dht.stats.requests.responses,
       timeouts: this._dht.stats.requests.timeouts
     }
 
+    // skip state changes
     if (this.cold || this.idle) return
 
-    this.online = this.recentResponses > 0
-    this.degraded = this.online && this.timeoutsRate > TIMEOUTS_THRESHOLD
+    // update newest
+    this.newest.offline = this.responses === 0
+    this.newest.degraded =
+      !this.newest.offline && this.timeoutsRate > DEGRADED_TIMEOUT_RATE_THRESHOLD
+
+    // update counters
+    if (this.newest.offline) this._offlineTicks++
+    else {
+      this._offlineTicks = 0
+      if (this.newest.degraded) this._degradedTicks++
+      else this._healthyTicks++
+    }
+
+    // check online/offline
+    if (!this.newest.offline) this.online = true
+    else if (this._offlineTicks >= OFFLINE_THRESHOLD) this.online = false
+
+    // check degraded
+    if (!this.online || this._healthyTicks === MAX_HEALTH_WINDOW) this.degraded = false
+    else if (this._degradedTicks === MAX_HEALTH_WINDOW) this.degraded = true
 
+    // fire events
     if (this.online && !this.degraded) this._dht._online()
     else if (this.degraded) this._dht._degraded()
     else this._dht._offline()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dht-rpc",
-  "version": "6.26.2",
+  "version": "6.26.4",
   "description": "Make RPC calls over a Kademlia based DHT",
   "main": "index.js",
   "files": [
@@ -43,12 +43,12 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/mafintosh/dht-rpc.git"
+    "url": "https://github.com/holepunchto/dht-rpc.git"
   },
   "author": "Mathias Buus (@mafintosh)",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/mafintosh/dht-rpc/issues"
+    "url": "https://github.com/holepunchto/dht-rpc/issues"
   },
-  "homepage": "https://github.com/mafintosh/dht-rpc"
+  "homepage": "https://github.com/holepunchto/dht-rpc#"
 }