@libp2p/kad-dht 9.3.4 → 9.3.6-3dfc236e

package/package.json

@@ -1,23 +1,19 @@
 {
   "name": "@libp2p/kad-dht",
-  "version": "9.3.4",
+  "version": "9.3.6-3dfc236e",
   "description": "JavaScript implementation of the Kad-DHT for libp2p",
   "license": "Apache-2.0 OR MIT",
-  "homepage": "https://github.com/libp2p/js-libp2p-kad-dht#readme",
+  "homepage": "https://github.com/libp2p/js-libp2p/tree/master/packages/kad-dht#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/libp2p/js-libp2p-kad-dht.git"
+    "url": "git+https://github.com/libp2p/js-libp2p.git"
   },
   "bugs": {
-    "url": "https://github.com/libp2p/js-libp2p-kad-dht/issues"
+    "url": "https://github.com/libp2p/js-libp2p/issues"
   },
   "keywords": [
     "IPFS"
   ],
-  "engines": {
-    "node": ">=16.0.0",
-    "npm": ">=7.0.0"
-  },
   "type": "module",
   "types": "./dist/src/index.d.ts",
   "files": [
@@ -41,91 +37,6 @@
       "src/message/dht.d.ts"
     ]
   },
-  "release": {
-    "branches": [
-      "master"
-    ],
-    "plugins": [
-      [
-        "@semantic-release/commit-analyzer",
-        {
-          "preset": "conventionalcommits",
-          "releaseRules": [
-            {
-              "breaking": true,
-              "release": "major"
-            },
-            {
-              "revert": true,
-              "release": "patch"
-            },
-            {
-              "type": "feat",
-              "release": "minor"
-            },
-            {
-              "type": "fix",
-              "release": "patch"
-            },
-            {
-              "type": "docs",
-              "release": "patch"
-            },
-            {
-              "type": "test",
-              "release": "patch"
-            },
-            {
-              "type": "deps",
-              "release": "patch"
-            },
-            {
-              "scope": "no-release",
-              "release": false
-            }
-          ]
-        }
-      ],
-      [
-        "@semantic-release/release-notes-generator",
-        {
-          "preset": "conventionalcommits",
-          "presetConfig": {
-            "types": [
-              {
-                "type": "feat",
-                "section": "Features"
-              },
-              {
-                "type": "fix",
-                "section": "Bug Fixes"
-              },
-              {
-                "type": "chore",
-                "section": "Trivial Changes"
-              },
-              {
-                "type": "docs",
-                "section": "Documentation"
-              },
-              {
-                "type": "deps",
-                "section": "Dependencies"
-              },
-              {
-                "type": "test",
-                "section": "Tests"
-              }
-            ]
-          }
-        }
-      ],
-      "@semantic-release/changelog",
-      "@semantic-release/npm",
-      "@semantic-release/github",
-      "@semantic-release/git"
-    ]
-  },
   "scripts": {
     "clean": "aegir clean",
     "lint": "aegir lint",
@@ -137,70 +48,69 @@
     "test:chrome-webworker": "aegir test -t webworker",
     "test:firefox": "aegir test -t browser -- --browser firefox",
     "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
-    "dep-check": "aegir dep-check -i protons -i events",
-    "release": "aegir release",
-    "docs": "aegir docs"
+    "dep-check": "aegir dep-check -i protons -i events"
   },
   "dependencies": {
-    "@libp2p/crypto": "^1.0.4",
-    "@libp2p/interface-address-manager": "^3.0.0",
-    "@libp2p/interface-connection": "^5.0.1",
-    "@libp2p/interface-connection-manager": "^3.0.0",
-    "@libp2p/interface-content-routing": "^2.1.0",
-    "@libp2p/interface-metrics": "^4.0.0",
-    "@libp2p/interface-peer-discovery": "^2.0.0",
-    "@libp2p/interface-peer-id": "^2.0.0",
-    "@libp2p/interface-peer-info": "^1.0.3",
-    "@libp2p/interface-peer-routing": "^1.1.0",
-    "@libp2p/interface-peer-store": "^2.0.0",
-    "@libp2p/interface-registrar": "^2.0.11",
-    "@libp2p/interfaces": "^3.2.0",
-    "@libp2p/logger": "^2.0.1",
-    "@libp2p/peer-collections": "^3.0.0",
-    "@libp2p/peer-id": "^2.0.0",
-    "@libp2p/record": "^3.0.0",
-    "@libp2p/topology": "^4.0.0",
-    "@multiformats/multiaddr": "^12.0.0",
-    "@types/sinon": "^10.0.14",
+    "@libp2p/crypto": "1.0.17-3dfc236e",
+    "@libp2p/interface-address-manager": "3.0.1-3dfc236e",
+    "@libp2p/interface-connection": "5.1.1-3dfc236e",
+    "@libp2p/interface-connection-manager": "3.0.1-3dfc236e",
+    "@libp2p/interface-content-routing": "2.1.1-3dfc236e",
+    "@libp2p/interface-metrics": "4.0.8-3dfc236e",
+    "@libp2p/interface-peer-discovery": "2.0.0-3dfc236e",
+    "@libp2p/interface-peer-id": "2.0.2-3dfc236e",
+    "@libp2p/interface-peer-info": "1.0.10-3dfc236e",
+    "@libp2p/interface-peer-routing": "1.1.1-3dfc236e",
+    "@libp2p/interface-peer-store": "2.0.4-3dfc236e",
+    "@libp2p/interface-registrar": "2.0.12-3dfc236e",
+    "@libp2p/interfaces": "3.3.2-3dfc236e",
+    "@libp2p/logger": "2.1.1-3dfc236e",
+    "@libp2p/peer-collections": "3.0.2-3dfc236e",
+    "@libp2p/peer-id": "2.0.3-3dfc236e",
+    "@libp2p/record": "3.0.4-3dfc236e",
+    "@libp2p/topology": "4.0.3-3dfc236e",
+    "@multiformats/multiaddr": "^12.1.3",
+    "@types/sinon": "^10.0.15",
     "abortable-iterator": "^5.0.1",
     "any-signal": "^4.1.1",
     "datastore-core": "^9.0.1",
     "events": "^3.3.0",
     "hashlru": "^2.3.0",
-    "interface-datastore": "^8.0.0",
-    "it-all": "^3.0.1",
+    "interface-datastore": "^8.2.0",
+    "it-all": "^3.0.2",
     "it-drain": "^3.0.1",
     "it-first": "^3.0.1",
     "it-length": "^3.0.1",
-    "it-length-prefixed": "^9.0.0",
-    "it-map": "^3.0.1",
+    "it-length-prefixed": "^9.0.1",
+    "it-map": "^3.0.2",
     "it-merge": "^3.0.0",
     "it-parallel": "^3.0.0",
-    "it-pipe": "^3.0.0",
+    "it-pipe": "^3.0.1",
     "it-stream-types": "^2.0.1",
     "it-take": "^3.0.1",
-    "multiformats": "^11.0.0",
+    "multiformats": "^11.0.2",
     "p-defer": "^4.0.0",
+    "p-event": "^6.0.0",
     "p-queue": "^7.3.4",
     "private-ip": "^3.0.0",
     "progress-events": "^1.0.0",
     "protons-runtime": "^5.0.0",
-    "uint8arraylist": "^2.0.0",
-    "uint8arrays": "^4.0.2",
+    "uint8arraylist": "^2.4.3",
+    "uint8arrays": "^4.0.3",
     "varint": "^6.0.0"
   },
   "devDependencies": {
-    "@libp2p/interface-libp2p": "^3.0.0",
-    "@libp2p/interface-mocks": "^12.0.0",
-    "@libp2p/peer-id-factory": "^2.0.0",
-    "@libp2p/peer-store": "^8.0.0",
+    "@libp2p/interface-libp2p": "3.2.0-3dfc236e",
+    "@libp2p/interface-mocks": "12.0.1-3dfc236e",
+    "@libp2p/peer-id-factory": "2.0.3-3dfc236e",
+    "@libp2p/peer-store": "8.2.1-3dfc236e",
     "@types/lodash.random": "^3.2.6",
     "@types/lodash.range": "^3.2.6",
     "@types/varint": "^6.0.0",
     "@types/which": "^3.0.0",
-    "aegir": "^39.0.5",
+    "aegir": "^39.0.10",
     "datastore-level": "^10.0.0",
-    "delay": "^5.0.0",
+    "delay": "^6.0.0",
     "execa": "^7.0.0",
     "it-filter": "^3.0.1",
     "it-last": "^3.0.1",
@@ -209,16 +119,14 @@
     "p-retry": "^5.0.0",
     "p-wait-for": "^5.0.0",
     "protons": "^7.0.2",
-    "sinon": "^15.0.0",
+    "sinon": "^15.1.0",
     "ts-sinon": "^2.0.2",
     "which": "^3.0.0"
   },
   "browser": {
     "./dist/src/routing-table/generated-prefix-list.js": "./dist/src/routing-table/generated-prefix-list-browser.js"
   },
-  "typedocs": {
-    "KadDHTComponents": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/KadDHTComponents.html",
-    "KadDHTInit": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/KadDHTInit.html",
-    "kadDHT": "https://libp2p.github.io/js-libp2p-kad-dht/functions/kadDHT.html"
+  "typedoc": {
+    "entryPoint": "./src/index.ts"
   }
 }

package/src/kad-dht.ts

@@ -285,10 +285,11 @@ export class DefaultKadDHT extends EventEmitter<PeerDiscoveryEvents> implements
       this.queryManager.start(),
       this.network.start(),
       this.routingTable.start(),
-      this.topologyListener.start(),
-      this.querySelf.start()
+      this.topologyListener.start()
     ])
 
+    this.querySelf.start()
+
     await this.routingTableRefresh.start()
   }
 
@@ -299,14 +300,15 @@ export class DefaultKadDHT extends EventEmitter<PeerDiscoveryEvents> implements
   async stop (): Promise<void> {
     this.running = false
 
+    this.querySelf.stop()
+
     await Promise.all([
       this.providers.stop(),
       this.queryManager.stop(),
       this.network.stop(),
       this.routingTable.stop(),
       this.routingTableRefresh.stop(),
-      this.topologyListener.stop(),
-      this.querySelf.stop()
+      this.topologyListener.stop()
     ])
   }
 

package/src/query-self.ts

@@ -4,10 +4,12 @@ import { anySignal } from 'any-signal'
 import length from 'it-length'
 import { pipe } from 'it-pipe'
 import take from 'it-take'
+import pDefer from 'p-defer'
+import { pEvent } from 'p-event'
 import { QUERY_SELF_INTERVAL, QUERY_SELF_TIMEOUT, K, QUERY_SELF_INITIAL_INTERVAL } from './constants.js'
-import type { KadDHTComponents } from './index.js'
 import type { PeerRouting } from './peer-routing/index.js'
 import type { RoutingTable } from './routing-table/index.js'
+import type { PeerId } from '@libp2p/interface-peer-id'
 import type { Startable } from '@libp2p/interfaces/startable'
 import type { DeferredPromise } from 'p-defer'
 
@@ -22,18 +24,8 @@ export interface QuerySelfInit {
   initialQuerySelfHasRun: DeferredPromise<void>
 }
 
-function debounce (func: () => void, wait: number): () => void {
-  let timeout: ReturnType<typeof setTimeout> | undefined
-
-  return function () {
-    const later = function (): void {
-      timeout = undefined
-      func()
-    }
-
-    clearTimeout(timeout)
-    timeout = setTimeout(later, wait)
-  }
+export interface QuerySelfComponents {
+  peerId: PeerId
 }
 
 /**
@@ -41,7 +33,7 @@ function debounce (func: () => void, wait: number): () => void {
  */
 export class QuerySelf implements Startable {
   private readonly log: Logger
-  private readonly components: KadDHTComponents
+  private readonly components: QuerySelfComponents
   private readonly peerRouting: PeerRouting
   private readonly routingTable: RoutingTable
   private readonly count: number
@@ -49,17 +41,16 @@ export class QuerySelf implements Startable {
   private readonly initialInterval: number
   private readonly queryTimeout: number
   private started: boolean
-  private running: boolean
   private timeoutId?: NodeJS.Timer
   private controller?: AbortController
   private initialQuerySelfHasRun?: DeferredPromise<void>
+  private querySelfPromise?: DeferredPromise<void>
 
-  constructor (components: KadDHTComponents, init: QuerySelfInit) {
+  constructor (components: QuerySelfComponents, init: QuerySelfInit) {
     const { peerRouting, lan, count, interval, queryTimeout, routingTable } = init
 
     this.components = components
     this.log = logger(`libp2p:kad-dht:${lan ? 'lan' : 'wan'}:query-self`)
-    this.running = false
     this.started = false
     this.peerRouting = peerRouting
     this.routingTable = routingTable
@@ -68,25 +59,28 @@ export class QuerySelf implements Startable {
     this.initialInterval = init.initialInterval ?? QUERY_SELF_INITIAL_INTERVAL
     this.queryTimeout = queryTimeout ?? QUERY_SELF_TIMEOUT
     this.initialQuerySelfHasRun = init.initialQuerySelfHasRun
-
-    this.querySelf = debounce(this.querySelf.bind(this), 100)
   }
 
   isStarted (): boolean {
     return this.started
   }
 
-  async start (): Promise<void> {
+  start (): void {
     if (this.started) {
       return
     }
 
     this.started = true
     clearTimeout(this.timeoutId)
-    this.timeoutId = setTimeout(this.querySelf.bind(this), this.initialInterval)
+    this.timeoutId = setTimeout(() => {
+      this.querySelf()
+        .catch(err => {
+          this.log.error('error running self-query', err)
+        })
+    }, this.initialInterval)
   }
 
-  async stop (): Promise<void> {
+  stop (): void {
     this.started = false
 
     if (this.timeoutId != null) {
@@ -98,84 +92,72 @@ export class QuerySelf implements Startable {
     }
   }
 
-  querySelf (): void {
+  async querySelf (): Promise<void> {
     if (!this.started) {
       this.log('skip self-query because we are not started')
       return
     }
 
-    if (this.running) {
-      this.log('skip self-query because we are already running, will run again in %dms', this.interval)
-      return
+    if (this.querySelfPromise != null) {
+      this.log('joining existing self query')
+      return this.querySelfPromise.promise
     }
 
-    if (this.routingTable.size === 0) {
-      let nextInterval = this.interval
-
-      if (this.initialQuerySelfHasRun != null) {
-        // if we've not yet run the first self query, shorten the interval until we try again
-        nextInterval = this.initialInterval
-      }
+    this.querySelfPromise = pDefer()
 
-      this.log('skip self-query because routing table is empty, will run again in %dms', nextInterval)
-      clearTimeout(this.timeoutId)
-      this.timeoutId = setTimeout(this.querySelf.bind(this), nextInterval)
-      return
+    if (this.routingTable.size === 0) {
+      // wait to discover at least one DHT peer
+      await pEvent(this.routingTable, 'peer:add')
     }
 
-    this.running = true
+    if (this.started) {
+      this.controller = new AbortController()
+      const signal = anySignal([this.controller.signal, AbortSignal.timeout(this.queryTimeout)])
 
-    Promise.resolve()
-      .then(async () => {
-        if (!this.started) {
-          this.log('not running self-query - node stopped before query started')
-          return
+      // this controller will get used for lots of dial attempts so make sure we don't cause warnings to be logged
+      try {
+        if (setMaxListeners != null) {
+          setMaxListeners(Infinity, signal)
         }
+      } catch {} // fails on node < 15.4
 
-        this.controller = new AbortController()
-        const signal = anySignal([this.controller.signal, AbortSignal.timeout(this.queryTimeout)])
-
-        // this controller will get used for lots of dial attempts so make sure we don't cause warnings to be logged
-        try {
-          if (setMaxListeners != null) {
-            setMaxListeners(Infinity, signal)
-          }
-        } catch {} // fails on node < 15.4
-
-        try {
-          this.log('run self-query, look for %d peers timing out after %dms', this.count, this.queryTimeout)
-
-          const found = await pipe(
-            this.peerRouting.getClosestPeers(this.components.peerId.toBytes(), {
-              signal,
-              isSelfQuery: true
-            }),
-            (source) => take(source, this.count),
-            async (source) => length(source)
-          )
-
-          this.log('self-query ran successfully - found %d peers', found)
-
-          if (this.initialQuerySelfHasRun != null) {
-            this.initialQuerySelfHasRun.resolve()
-            this.initialQuerySelfHasRun = undefined
-          }
-        } catch (err: any) {
-          this.log.error('self-query error', err)
-        } finally {
-          signal.clear()
-        }
-      }).catch(err => {
-        this.log('self-query error', err)
-      }).finally(() => {
-        this.running = false
+      try {
+        this.log('run self-query, look for %d peers timing out after %dms', this.count, this.queryTimeout)
+
+        const found = await pipe(
+          this.peerRouting.getClosestPeers(this.components.peerId.toBytes(), {
+            signal,
+            isSelfQuery: true
+          }),
+          (source) => take(source, this.count),
+          async (source) => length(source)
+        )
 
-        clearTimeout(this.timeoutId)
+        this.log('self-query ran successfully - found %d peers', found)
 
-        if (this.started) {
-          this.log('running self-query again in %dms', this.interval)
-          this.timeoutId = setTimeout(this.querySelf.bind(this), this.interval)
+        if (this.initialQuerySelfHasRun != null) {
+          this.initialQuerySelfHasRun.resolve()
+          this.initialQuerySelfHasRun = undefined
         }
-      })
+      } catch (err: any) {
+        this.log.error('self-query error', err)
+      } finally {
+        signal.clear()
+      }
+    }
+
+    this.querySelfPromise.resolve()
+    this.querySelfPromise = undefined
+
+    if (!this.started) {
+      return
+    }
+
+    this.timeoutId = setTimeout(() => {
+      this.querySelf()
+        .catch(err => {
+          this.log.error('error running self-query', err)
+        })
+    }, this.interval)
   }
 }

package/src/routing-table/index.ts

@@ -1,3 +1,4 @@
+import { EventEmitter } from '@libp2p/interfaces/events'
 import { logger } from '@libp2p/logger'
 import { PeerSet } from '@libp2p/peer-collections'
 import Queue from 'p-queue'
@@ -33,11 +34,16 @@ export interface RoutingTableComponents {
   metrics?: Metrics
 }
 
+export interface RoutingTableEvents {
+  'peer:add': CustomEvent<PeerId>
+  'peer:remove': CustomEvent<PeerId>
+}
+
 /**
  * A wrapper around `k-bucket`, to provide easy store and
  * retrieval for peers.
  */
-export class RoutingTable implements Startable {
+export class RoutingTable extends EventEmitter<RoutingTableEvents> implements Startable {
   public kBucketSize: number
   public kb?: KBucket
   public pingQueue: Queue
@@ -58,6 +64,8 @@ export class RoutingTable implements Startable {
   }
 
   constructor (components: RoutingTableComponents, init: RoutingTableInit) {
+    super()
+
     const { kBucketSize, pingTimeout, lan, pingConcurrency, protocol, tagName, tagValue } = init
 
     this.components = components
@@ -160,11 +168,15 @@ export class RoutingTable implements Startable {
       kClosest = newClosest
     })
 
-    kBuck.addEventListener('added', () => {
+    kBuck.addEventListener('added', (evt) => {
       updatePeerTags()
+
+      this.safeDispatchEvent('peer:add', { detail: evt.detail.peer })
     })
-    kBuck.addEventListener('removed', () => {
+    kBuck.addEventListener('removed', (evt) => {
       updatePeerTags()
+
+      this.safeDispatchEvent('peer:remove', { detail: evt.detail.peer })
     })
   }
 

package/dist/typedoc-urls.json

@@ -1,29 +0,0 @@
-{
-  "ProvidersInit": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/_internal_.ProvidersInit.html",
-  "EventTypes": "https://libp2p.github.io/js-libp2p-kad-dht/enums/EventTypes.html",
-  "MessageType": "https://libp2p.github.io/js-libp2p-kad-dht/enums/MessageType.html",
-  "AddPeerEvent": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/AddPeerEvent.html",
-  "DHTRecord": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/DHTRecord.html",
-  "DialPeerEvent": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/DialPeerEvent.html",
-  "DualKadDHT": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/DualKadDHT.html",
-  "FinalPeerEvent": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/FinalPeerEvent.html",
-  "KadDHT": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/KadDHT.html",
-  "KadDHTComponents": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/KadDHTComponents.html",
-  "KadDHTInit": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/KadDHTInit.html",
-  "PeerResponseEvent": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/PeerResponseEvent.html",
-  "ProviderEvent": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/ProviderEvent.html",
-  "QueryErrorEvent": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/QueryErrorEvent.html",
-  "QueryOptions": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/QueryOptions.html",
-  "RoutingTable": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/RoutingTable.html",
-  "SelectFn": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/SelectFn.html",
-  "SendQueryEvent": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/SendQueryEvent.html",
-  "SingleKadDHT": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/SingleKadDHT.html",
-  "ValidateFn": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/ValidateFn.html",
-  "ValueEvent": "https://libp2p.github.io/js-libp2p-kad-dht/interfaces/ValueEvent.html",
-  "DHTProgressEvents": "https://libp2p.github.io/js-libp2p-kad-dht/types/DHTProgressEvents.html",
-  "MessageName": "https://libp2p.github.io/js-libp2p-kad-dht/types/MessageName.html",
-  "QueryEvent": "https://libp2p.github.io/js-libp2p-kad-dht/types/QueryEvent.html",
-  "Selectors": "https://libp2p.github.io/js-libp2p-kad-dht/types/Selectors.html",
-  "Validators": "https://libp2p.github.io/js-libp2p-kad-dht/types/Validators.html",
-  "kadDHT": "https://libp2p.github.io/js-libp2p-kad-dht/functions/kadDHT-1.html"
-}