libp2p 0.45.5 → 0.45.6-de61ddb4

package/src/connection-manager/index.ts

@@ -10,7 +10,7 @@ import { codes } from '../errors.js'
 import { getPeerAddress } from '../get-peer.js'
 import { AutoDial } from './auto-dial.js'
 import { ConnectionPruner } from './connection-pruner.js'
-import { AUTO_DIAL_CONCURRENCY, AUTO_DIAL_PRIORITY, DIAL_TIMEOUT, INBOUND_CONNECTION_THRESHOLD, MAX_CONNECTIONS, MAX_INCOMING_PENDING_CONNECTIONS, MAX_PARALLEL_DIALS, MAX_PEER_ADDRS_TO_DIAL, MIN_CONNECTIONS } from './constants.js'
+import { AUTO_DIAL_CONCURRENCY, AUTO_DIAL_MAX_QUEUE_LENGTH, AUTO_DIAL_PRIORITY, DIAL_TIMEOUT, INBOUND_CONNECTION_THRESHOLD, MAX_CONNECTIONS, MAX_INCOMING_PENDING_CONNECTIONS, MAX_PARALLEL_DIALS, MAX_PEER_ADDRS_TO_DIAL, MIN_CONNECTIONS } from './constants.js'
 import { DialQueue } from './dial-queue.js'
 import type { Connection, MultiaddrConnection } from '@libp2p/interface-connection'
 import type { ConnectionGater } from '@libp2p/interface-connection-gater'
@@ -18,7 +18,7 @@ import type { ConnectionManager } from '@libp2p/interface-connection-manager'
 import type { PendingDial, AddressSorter, Libp2pEvents } from '@libp2p/interface-libp2p'
 import type { Metrics } from '@libp2p/interface-metrics'
 import type { PeerId } from '@libp2p/interface-peer-id'
-import type { PeerStore } from '@libp2p/interface-peer-store'
+import type { Peer, PeerStore } from '@libp2p/interface-peer-store'
 import type { TransportManager } from '@libp2p/interface-transport'
 import type { AbortOptions } from '@libp2p/interfaces'
 import type { EventEmitter } from '@libp2p/interfaces/events'
@@ -61,6 +61,12 @@ export interface ConnectionManagerInit {
    */
   autoDialPriority?: number
 
+  /**
+   * Limit the maximum number of peers to dial when trying to keep the number of
+   * open connections above `minConnections`. (default: 100)
+   */
+  autoDialMaxQueueLength?: number
+
   /**
    * Sort the known addresses of a peer before trying to dial, By default public
    * addresses will be dialled before private (e.g. loopback or LAN) addresses.
@@ -136,7 +142,8 @@ const defaultOptions = {
   inboundConnectionThreshold: INBOUND_CONNECTION_THRESHOLD,
   maxIncomingPendingConnections: MAX_INCOMING_PENDING_CONNECTIONS,
   autoDialConcurrency: AUTO_DIAL_CONCURRENCY,
-  autoDialPriority: AUTO_DIAL_PRIORITY
+  autoDialPriority: AUTO_DIAL_PRIORITY,
+  autoDialMaxQueueLength: AUTO_DIAL_MAX_QUEUE_LENGTH
 }
 
 export interface DefaultConnectionManagerComponents {
@@ -217,7 +224,8 @@ export class DefaultConnectionManager implements ConnectionManager, Startable {
     }, {
       minConnections,
       autoDialConcurrency: init.autoDialConcurrency ?? defaultOptions.autoDialConcurrency,
-      autoDialPriority: init.autoDialPriority ?? defaultOptions.autoDialPriority
+      autoDialPriority: init.autoDialPriority ?? defaultOptions.autoDialPriority,
+      maxQueueLength: init.autoDialMaxQueueLength ?? defaultOptions.autoDialMaxQueueLength
     })
 
     // controls what happens when we have too many connections
@@ -344,17 +352,15 @@ export class DefaultConnectionManager implements ConnectionManager, Startable {
     // re-connect to any peers with the KEEP_ALIVE tag
     void Promise.resolve()
       .then(async () => {
-        const keepAlivePeers: PeerId[] = []
-
-        for (const peer of await this.peerStore.all()) {
-          if (peer.tags.has(KEEP_ALIVE)) {
-            keepAlivePeers.push(peer.id)
-          }
-        }
+        const keepAlivePeers: Peer[] = await this.peerStore.all({
+          filters: [(peer) => {
+            return peer.tags.has(KEEP_ALIVE)
+          }]
+        })
 
         await Promise.all(
           keepAlivePeers.map(async peer => {
-            await this.openConnection(peer)
+            await this.openConnection(peer.id)
               .catch(err => {
                 log.error(err)
               })

package/src/upnp-nat/index.ts

@@ -142,7 +142,7 @@ class UPnPNAT implements Startable {
         continue
       }
 
-      const client = await this._getClient()
+      const client = this._getClient()
       const publicIp = this.externalAddress ?? await client.externalIp()
       const isPrivate = isPrivateIp(publicIp)
 
@@ -173,12 +173,12 @@ class UPnPNAT implements Startable {
     }
   }
 
-  async _getClient (): Promise<NatAPI> {
+  _getClient (): NatAPI {
     if (this.client != null) {
       return this.client
     }
 
-    this.client = await upnpNat({
+    this.client = upnpNat({
       description: this.description,
       ttl: this.ttl,
       keepAlive: this.keepAlive,

package/src/utils/peer-job-queue.ts

@@ -0,0 +1,119 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+
+import { CodeError } from '@libp2p/interfaces/errors'
+import PQueue from 'p-queue'
+import { codes } from '../errors.js'
+import type { PeerId } from '@libp2p/interface-peer-id'
+import type { QueueAddOptions, Options, Queue } from 'p-queue'
+
+// Port of lower_bound from https://en.cppreference.com/w/cpp/algorithm/lower_bound
+// Used to compute insertion index to keep queue sorted after insertion
+function lowerBound<T> (array: readonly T[], value: T, comparator: (a: T, b: T) => number): number {
+  let first = 0
+  let count = array.length
+
+  while (count > 0) {
+    const step = Math.trunc(count / 2)
+    let it = first + step
+
+    if (comparator(array[it]!, value) <= 0) {
+      first = ++it
+      count -= step + 1
+    } else {
+      count = step
+    }
+  }
+
+  return first
+}
+
+interface RunFunction { (): Promise<unknown> }
+
+export interface PeerPriorityQueueOptions extends QueueAddOptions {
+  peerId: PeerId
+}
+
+interface PeerJob {
+  priority: number
+  peerId: PeerId
+  run: RunFunction
+}
+
+/**
+ * Port of https://github.com/sindresorhus/p-queue/blob/main/source/priority-queue.ts
+ * that adds support for filtering jobs by peer id
+ */
+class PeerPriorityQueue implements Queue<RunFunction, PeerPriorityQueueOptions> {
+  readonly #queue: PeerJob[] = []
+
+  enqueue (run: RunFunction, options?: Partial<PeerPriorityQueueOptions>): void {
+    const peerId = options?.peerId
+    const priority = options?.priority ?? 0
+
+    if (peerId == null) {
+      throw new CodeError('missing peer id', codes.ERR_INVALID_PARAMETERS)
+    }
+
+    const element: PeerJob = {
+      priority,
+      peerId,
+      run
+    }
+
+    if (this.size > 0 && this.#queue[this.size - 1]!.priority >= priority) {
+      this.#queue.push(element)
+      return
+    }
+
+    const index = lowerBound(
+      this.#queue, element,
+      (a: Readonly<PeerPriorityQueueOptions>, b: Readonly<PeerPriorityQueueOptions>) => b.priority! - a.priority!
+    )
+    this.#queue.splice(index, 0, element)
+  }
+
+  dequeue (): RunFunction | undefined {
+    const item = this.#queue.shift()
+    return item?.run
+  }
+
+  filter (options: Readonly<Partial<PeerPriorityQueueOptions>>): RunFunction[] {
+    if (options.peerId != null) {
+      const peerId = options.peerId
+
+      return this.#queue.filter(
+        (element: Readonly<PeerPriorityQueueOptions>) => peerId.equals(element.peerId)
+      ).map((element: Readonly<{ run: RunFunction }>) => element.run)
+    }
+
+    return this.#queue.filter(
+      (element: Readonly<PeerPriorityQueueOptions>) => element.priority === options.priority
+    ).map((element: Readonly<{ run: RunFunction }>) => element.run)
+  }
+
+  get size (): number {
+    return this.#queue.length
+  }
+}
+
+/**
+ * Extends PQueue to add support for querying queued jobs by peer id
+ */
+export class PeerJobQueue extends PQueue<PeerPriorityQueue, PeerPriorityQueueOptions> {
+  constructor (options: Options<PeerPriorityQueue, PeerPriorityQueueOptions> = {}) {
+    super({
+      ...options,
+      queueClass: PeerPriorityQueue
+    })
+  }
+
+  /**
+   * Returns true if this queue has a job for the passed peer id that has not yet
+   * started to run
+   */
+  hasJob (peerId: PeerId): boolean {
+    return this.sizeBy({
+      peerId
+    }) > 0
+  }
+}

package/src/version.ts

@@ -1,2 +1,2 @@
-export const version = '0.45.5'
+export const version = '0.45.6-de61ddb4'
 export const name = 'libp2p'

package/dist/typedoc-urls.json

@@ -1,58 +0,0 @@
-{
-  "AutoNATComponents": "https://libp2p.github.io/js-libp2p/interfaces/autonat.AutoNATComponents.html",
-  "AutoNATServiceInit": "https://libp2p.github.io/js-libp2p/interfaces/autonat.AutoNATServiceInit.html",
-  "autoNATService": "https://libp2p.github.io/js-libp2p/functions/autonat.autoNATService.html",
-  "codec": "https://libp2p.github.io/js-libp2p/functions/circuit_relay._internal_.Limit.codec.html",
-  "decode": "https://libp2p.github.io/js-libp2p/functions/circuit_relay._internal_.Limit.decode.html",
-  "encode": "https://libp2p.github.io/js-libp2p/functions/circuit_relay._internal_.Limit.encode.html",
-  "AdvertServiceComponents": "https://libp2p.github.io/js-libp2p/interfaces/circuit_relay._internal_.AdvertServiceComponents.html",
-  "AdvertServiceInit": "https://libp2p.github.io/js-libp2p/interfaces/circuit_relay._internal_.AdvertServiceInit.html",
-  "CircuitRelayServerComponents": "https://libp2p.github.io/js-libp2p/interfaces/circuit_relay._internal_.CircuitRelayServerComponents.html",
-  "CircuitRelayServerInit": "https://libp2p.github.io/js-libp2p/interfaces/circuit_relay._internal_.CircuitRelayServerInit.html",
-  "CircuitRelayTransportComponents": "https://libp2p.github.io/js-libp2p/interfaces/circuit_relay._internal_.CircuitRelayTransportComponents.html",
-  "CircuitRelayTransportInit": "https://libp2p.github.io/js-libp2p/interfaces/circuit_relay._internal_.CircuitRelayTransportInit.html",
-  "Limit": "https://libp2p.github.io/js-libp2p/interfaces/circuit_relay._internal_.Limit-1.html",
-  "RelayDiscoveryComponents": "https://libp2p.github.io/js-libp2p/interfaces/circuit_relay._internal_.RelayDiscoveryComponents.html",
-  "RelayStoreInit": "https://libp2p.github.io/js-libp2p/interfaces/circuit_relay._internal_.RelayStoreInit.html",
-  "ReservationStoreInit": "https://libp2p.github.io/js-libp2p/interfaces/circuit_relay._internal_.ReservationStoreInit.html",
-  "CircuitRelayService": "https://libp2p.github.io/js-libp2p/interfaces/circuit_relay.CircuitRelayService.html",
-  "CircuitRelayServiceEvents": "https://libp2p.github.io/js-libp2p/interfaces/circuit_relay.CircuitRelayServiceEvents.html",
-  "RelayReservation": "https://libp2p.github.io/js-libp2p/interfaces/circuit_relay.RelayReservation.html",
-  "circuitRelayServer": "https://libp2p.github.io/js-libp2p/functions/circuit_relay.circuitRelayServer.html",
-  "circuitRelayTransport": "https://libp2p.github.io/js-libp2p/functions/circuit_relay.circuitRelayTransport.html",
-  "FetchService": "https://libp2p.github.io/js-libp2p/interfaces/fetch.FetchService.html",
-  "FetchServiceComponents": "https://libp2p.github.io/js-libp2p/interfaces/fetch.FetchServiceComponents.html",
-  "FetchServiceInit": "https://libp2p.github.io/js-libp2p/interfaces/fetch.FetchServiceInit.html",
-  "HandleMessageOptions": "https://libp2p.github.io/js-libp2p/interfaces/fetch.HandleMessageOptions.html",
-  "LookupFunction": "https://libp2p.github.io/js-libp2p/interfaces/fetch.LookupFunction.html",
-  "fetchService": "https://libp2p.github.io/js-libp2p/functions/fetch.fetchService-1.html",
-  "DefaultIdentifyService": "https://libp2p.github.io/js-libp2p/classes/identify._internal_.DefaultIdentifyService.html",
-  "Identify": "https://libp2p.github.io/js-libp2p/interfaces/identify._internal_.Identify-1.html",
-  "IdentifyServiceComponents": "https://libp2p.github.io/js-libp2p/interfaces/identify.IdentifyServiceComponents.html",
-  "IdentifyServiceInit": "https://libp2p.github.io/js-libp2p/interfaces/identify.IdentifyServiceInit.html",
-  "Message": "https://libp2p.github.io/js-libp2p/variables/identify.Message.html",
-  "multicodecs": "https://libp2p.github.io/js-libp2p/variables/identify.multicodecs.html",
-  "identifyService": "https://libp2p.github.io/js-libp2p/functions/identify.identifyService.html",
-  "AddressFilter": "https://libp2p.github.io/js-libp2p/interfaces/index._internal_.AddressFilter.html",
-  "AddressManagerInit": "https://libp2p.github.io/js-libp2p/interfaces/index._internal_.AddressManagerInit.html",
-  "Components": "https://libp2p.github.io/js-libp2p/interfaces/index._internal_.Components.html",
-  "ConnectionManagerInit": "https://libp2p.github.io/js-libp2p/interfaces/index._internal_.ConnectionManagerInit.html",
-  "TransportManagerInit": "https://libp2p.github.io/js-libp2p/interfaces/index._internal_.TransportManagerInit.html",
-  "Libp2pInit": "https://libp2p.github.io/js-libp2p/interfaces/index.Libp2pInit.html",
-  "Libp2pOptions": "https://libp2p.github.io/js-libp2p/types/index.Libp2pOptions.html",
-  "ServiceFactoryMap": "https://libp2p.github.io/js-libp2p/types/index.ServiceFactoryMap.html",
-  "createLibp2p": "https://libp2p.github.io/js-libp2p/functions/index.createLibp2p.html",
-  "plaintext": "https://libp2p.github.io/js-libp2p/functions/insecure.plaintext.html",
-  "PingService": "https://libp2p.github.io/js-libp2p/interfaces/ping.PingService.html",
-  "PingServiceComponents": "https://libp2p.github.io/js-libp2p/interfaces/ping.PingServiceComponents.html",
-  "PingServiceInit": "https://libp2p.github.io/js-libp2p/interfaces/ping.PingServiceInit.html",
-  "pingService": "https://libp2p.github.io/js-libp2p/functions/ping.pingService-1.html",
-  "ProtectorInit": "https://libp2p.github.io/js-libp2p/interfaces/pnet.ProtectorInit.html",
-  "generateKey": "https://libp2p.github.io/js-libp2p/functions/pnet.generateKey.html",
-  "preSharedKey": "https://libp2p.github.io/js-libp2p/functions/pnet.preSharedKey.html",
-  "UPnPNAT": "https://libp2p.github.io/js-libp2p/classes/upnp_nat._internal_.UPnPNAT.html",
-  "PMPOptions": "https://libp2p.github.io/js-libp2p/interfaces/upnp_nat.PMPOptions.html",
-  "UPnPNATComponents": "https://libp2p.github.io/js-libp2p/interfaces/upnp_nat.UPnPNATComponents.html",
-  "UPnPNATInit": "https://libp2p.github.io/js-libp2p/interfaces/upnp_nat.UPnPNATInit.html",
-  "uPnPNATService": "https://libp2p.github.io/js-libp2p/functions/upnp_nat.uPnPNATService.html"
-}