@libp2p/utils 5.1.1 → 5.2.0

package/dist/src/peer-job-queue.d.ts

@@ -1,42 +0,0 @@
-import PQueue from 'p-queue';
-import type { PeerId } from '@libp2p/interface';
-import type { AbortOptions } from 'it-pushable';
-import type { QueueAddOptions, Options, Queue } from 'p-queue';
-interface RunFunction<T> {
-    (options?: AbortOptions): Promise<T>;
-}
-export interface PeerPriorityQueueOptions extends QueueAddOptions {
-    peerId: PeerId;
-}
-/**
- * Port of https://github.com/sindresorhus/p-queue/blob/main/source/priority-queue.ts
- * that adds support for filtering jobs by peer id
- */
-declare class PeerPriorityQueue implements Queue<RunFunction<unknown>, PeerPriorityQueueOptions> {
-    #private;
-    enqueue(run: RunFunction<unknown>, options?: Partial<PeerPriorityQueueOptions>): void;
-    dequeue(): RunFunction<unknown> | undefined;
-    filter(options: Readonly<Partial<PeerPriorityQueueOptions>>): Array<RunFunction<unknown>>;
-    get size(): number;
-}
-/**
- * Extends PQueue to add support for querying queued jobs by peer id
- */
-export declare class PeerJobQueue extends PQueue<PeerPriorityQueue, PeerPriorityQueueOptions> {
-    private readonly results;
-    constructor(options?: Options<PeerPriorityQueue, PeerPriorityQueueOptions>);
-    /**
-     * Returns true if this queue has a job for the passed peer id that has not
-     * yet started to run
-     */
-    hasJob(peerId: PeerId): boolean;
-    /**
-     * Returns a promise for the result of the job in the queue for the passed
-     * peer id.
-     */
-    joinJob<Result = void>(peerId: PeerId): Promise<Result>;
-    add<T>(fn: RunFunction<T>, opts: PeerPriorityQueueOptions): Promise<T>;
-    clear(): void;
-}
-export {};
-//# sourceMappingURL=peer-job-queue.d.ts.map

package/dist/src/peer-job-queue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"peer-job-queue.d.ts","sourceRoot":"","sources":["../../src/peer-job-queue.ts"],"names":[],"mappings":"AAKA,OAAO,MAAM,MAAM,SAAS,CAAA;AAC5B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE/C,OAAO,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAuB9D,UAAU,WAAW,CAAC,CAAC;IACrB,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;CACrC;AAED,MAAM,WAAW,wBAAyB,SAAQ,eAAe;IAC/D,MAAM,EAAE,MAAM,CAAA;CACf;AAQD;;;GAGG;AACH,cAAM,iBAAkB,YAAW,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,wBAAwB,CAAC;;IAGtF,OAAO,CAAE,GAAG,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,GAAG,IAAI;IA0BtF,OAAO,IAAK,WAAW,CAAC,OAAO,CAAC,GAAG,SAAS;IAK5C,MAAM,CAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAc1F,IAAI,IAAI,IAAK,MAAM,CAElB;CACF;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,MAAM,CAAC,iBAAiB,EAAE,wBAAwB,CAAC;IACnF,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsC;gBAEjD,OAAO,GAAE,OAAO,CAAC,iBAAiB,EAAE,wBAAwB,CAAM;IAS/E;;;OAGG;IACH,MAAM,CAAE,MAAM,EAAE,MAAM,GAAG,OAAO;IAMhC;;;OAGG;IACG,OAAO,CAAE,MAAM,GAAG,IAAI,EAAG,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAgBzD,GAAG,CAAE,CAAC,EAAG,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,CAAC,CAAC;IAkC9E,KAAK,IAAK,IAAI;CAIf"}

package/dist/src/peer-job-queue.js

@@ -1,132 +0,0 @@
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
-import { CodeError, ERR_INVALID_PARAMETERS } from '@libp2p/interface';
-import { PeerMap } from '@libp2p/peer-collections';
-import pDefer from 'p-defer';
-import PQueue 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(array, value, comparator) {
-    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;
-}
-/**
- * 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 {
-    #queue = [];
-    enqueue(run, options) {
-        const peerId = options?.peerId;
-        const priority = options?.priority ?? 0;
-        if (peerId == null) {
-            throw new CodeError('missing peer id', ERR_INVALID_PARAMETERS);
-        }
-        const element = {
-            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, b) => b.priority - a.priority);
-        this.#queue.splice(index, 0, element);
-    }
-    dequeue() {
-        const item = this.#queue.shift();
-        return item?.run;
-    }
-    filter(options) {
-        if (options.peerId != null) {
-            const peerId = options.peerId;
-            return this.#queue.filter((element) => peerId.equals(element.peerId)).map((element) => element.run);
-        }
-        return this.#queue.filter((element) => element.priority === options.priority).map((element) => element.run);
-    }
-    get size() {
-        return this.#queue.length;
-    }
-}
-/**
- * Extends PQueue to add support for querying queued jobs by peer id
- */
-export class PeerJobQueue extends PQueue {
-    results;
-    constructor(options = {}) {
-        super({
-            ...options,
-            queueClass: PeerPriorityQueue
-        });
-        this.results = new PeerMap();
-    }
-    /**
-     * Returns true if this queue has a job for the passed peer id that has not
-     * yet started to run
-     */
-    hasJob(peerId) {
-        return this.sizeBy({
-            peerId
-        }) > 0;
-    }
-    /**
-     * Returns a promise for the result of the job in the queue for the passed
-     * peer id.
-     */
-    async joinJob(peerId) {
-        let deferred = this.results.get(peerId);
-        if (deferred == null) {
-            throw new CodeError('No job found for peer id', 'ERR_NO_JOB_FOR_PEER_ID');
-        }
-        if (deferred === true) {
-            // a job has been added but so far nothing has tried to join the job
-            deferred = pDefer();
-            this.results.set(peerId, deferred);
-        }
-        return deferred.promise;
-    }
-    async add(fn, opts) {
-        const peerId = opts?.peerId;
-        if (peerId == null) {
-            throw new CodeError('missing peer id', ERR_INVALID_PARAMETERS);
-        }
-        this.results.set(opts.peerId, true);
-        return super.add(async (opts) => {
-            try {
-                const value = await fn(opts);
-                const deferred = this.results.get(peerId);
-                if (deferred != null && deferred !== true) {
-                    deferred.resolve(value);
-                }
-                return value;
-            }
-            catch (err) {
-                const deferred = this.results.get(peerId);
-                if (deferred != null && deferred !== true) {
-                    deferred.reject(err);
-                }
-                throw err;
-            }
-            finally {
-                this.results.delete(peerId);
-            }
-        }, opts);
-    }
-    clear() {
-        this.results.clear();
-        super.clear();
-    }
-}
-//# sourceMappingURL=peer-job-queue.js.map

package/dist/src/peer-job-queue.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"peer-job-queue.js","sourceRoot":"","sources":["../../src/peer-job-queue.ts"],"names":[],"mappings":"AAAA,6DAA6D;AAE7D,OAAO,EAAE,SAAS,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AACrE,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAA;AAClD,OAAO,MAAM,MAAM,SAAS,CAAA;AAC5B,OAAO,MAAM,MAAM,SAAS,CAAA;AAM5B,mFAAmF;AACnF,uEAAuE;AACvE,SAAS,UAAU,CAAK,KAAmB,EAAE,KAAQ,EAAE,UAAkC;IACvF,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,CAAA;IAExB,OAAO,KAAK,GAAG,CAAC,EAAE,CAAC;QACjB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAA;QAClC,IAAI,EAAE,GAAG,KAAK,GAAG,IAAI,CAAA;QAErB,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAE,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACvC,KAAK,GAAG,EAAE,EAAE,CAAA;YACZ,KAAK,IAAI,IAAI,GAAG,CAAC,CAAA;QACnB,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,IAAI,CAAA;QACd,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC;AAgBD;;;GAGG;AACH,MAAM,iBAAiB;IACZ,MAAM,GAAc,EAAE,CAAA;IAE/B,OAAO,CAAE,GAAyB,EAAE,OAA2C;QAC7E,MAAM,MAAM,GAAG,OAAO,EAAE,MAAM,CAAA;QAC9B,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,CAAC,CAAA;QAEvC,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,SAAS,CAAC,iBAAiB,EAAE,sBAAsB,CAAC,CAAA;QAChE,CAAC;QAED,MAAM,OAAO,GAAY;YACvB,QAAQ;YACR,MAAM;YACN,GAAG;SACJ,CAAA;QAED,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAE,CAAC,QAAQ,IAAI,QAAQ,EAAE,CAAC;YACtE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YACzB,OAAM;QACR,CAAC;QAED,MAAM,KAAK,GAAG,UAAU,CACtB,IAAI,CAAC,MAAM,EAAE,OAAO,EACpB,CAAC,CAAqC,EAAE,CAAqC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAS,GAAG,CAAC,CAAC,QAAS,CAC5G,CAAA;QACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,CAAA;IACvC,CAAC;IAED,OAAO;QACL,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;QAChC,OAAO,IAAI,EAAE,GAAG,CAAA;IAClB,CAAC;IAED,MAAM,CAAE,OAAoD;QAC1D,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAA;YAE7B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CACvB,CAAC,OAA2C,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAC/E,CAAC,GAAG,CAAC,CAAC,OAAgD,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QAC1E,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CACvB,CAAC,OAA2C,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ,CACvF,CAAC,GAAG,CAAC,CAAC,OAAgD,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IAC1E,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAA;IAC3B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,MAAmD;IAClE,OAAO,CAAsC;IAE9D,YAAa,UAAgE,EAAE;QAC7E,KAAK,CAAC;YACJ,GAAG,OAAO;YACV,UAAU,EAAE,iBAAiB;SAC9B,CAAC,CAAA;QAEF,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,EAAE,CAAA;IAC9B,CAAC;IAED;;;OAGG;IACH,MAAM,CAAE,MAAc;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC;YACjB,MAAM;SACP,CAAC,GAAG,CAAC,CAAA;IACR,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAkB,MAAc;QAC3C,IAAI,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QAEvC,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrB,MAAM,IAAI,SAAS,CAAC,0BAA0B,EAAE,wBAAwB,CAAC,CAAA;QAC3E,CAAC;QAED,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACtB,oEAAoE;YACpE,QAAQ,GAAG,MAAM,EAAU,CAAA;YAC3B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;QACpC,CAAC;QAED,OAAO,QAAQ,CAAC,OAAO,CAAA;IACzB,CAAC;IAED,KAAK,CAAC,GAAG,CAAM,EAAkB,EAAE,IAA8B;QAC/D,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,CAAA;QAE3B,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,SAAS,CAAC,iBAAiB,EAAE,sBAAsB,CAAC,CAAA;QAChE,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAEnC,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,IAAmB,EAAE,EAAE;YAC7C,IAAI,CAAC;gBACH,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,CAAA;gBAE5B,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;gBAEzC,IAAI,QAAQ,IAAI,IAAI,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;oBAC1C,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;gBACzB,CAAC;gBAED,OAAO,KAAK,CAAA;YACd,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;gBAEzC,IAAI,QAAQ,IAAI,IAAI,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;oBAC1C,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;gBACtB,CAAC;gBAED,MAAM,GAAG,CAAA;YACX,CAAC;oBAAS,CAAC;gBACT,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;YAC7B,CAAC;QACH,CAAC,EAAE,IAAI,CAAe,CAAA;IACxB,CAAC;IAED,KAAK;QACH,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;QACpB,KAAK,CAAC,KAAK,EAAE,CAAA;IACf,CAAC;CACF"}

package/src/peer-job-queue.ts

@@ -1,187 +0,0 @@
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
-
-import { CodeError, ERR_INVALID_PARAMETERS } from '@libp2p/interface'
-import { PeerMap } from '@libp2p/peer-collections'
-import pDefer from 'p-defer'
-import PQueue from 'p-queue'
-import type { PeerId } from '@libp2p/interface'
-import type { AbortOptions } from 'it-pushable'
-import type { DeferredPromise } from 'p-defer'
-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<T> {
-  (options?: AbortOptions): Promise<T>
-}
-
-export interface PeerPriorityQueueOptions extends QueueAddOptions {
-  peerId: PeerId
-}
-
-interface PeerJob {
-  priority: number
-  peerId: PeerId
-  run: RunFunction<any>
-}
-
-/**
- * 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<unknown>, PeerPriorityQueueOptions> {
-  readonly #queue: PeerJob[] = []
-
-  enqueue (run: RunFunction<unknown>, options?: Partial<PeerPriorityQueueOptions>): void {
-    const peerId = options?.peerId
-    const priority = options?.priority ?? 0
-
-    if (peerId == null) {
-      throw new CodeError('missing peer id', 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<unknown> | undefined {
-    const item = this.#queue.shift()
-    return item?.run
-  }
-
-  filter (options: Readonly<Partial<PeerPriorityQueueOptions>>): Array<RunFunction<unknown>> {
-    if (options.peerId != null) {
-      const peerId = options.peerId
-
-      return this.#queue.filter(
-        (element: Readonly<PeerPriorityQueueOptions>) => peerId.equals(element.peerId)
-      ).map((element: Readonly<{ run: RunFunction<unknown> }>) => element.run)
-    }
-
-    return this.#queue.filter(
-      (element: Readonly<PeerPriorityQueueOptions>) => element.priority === options.priority
-    ).map((element: Readonly<{ run: RunFunction<unknown> }>) => 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> {
-  private readonly results: PeerMap<DeferredPromise<any> | true>
-
-  constructor (options: Options<PeerPriorityQueue, PeerPriorityQueueOptions> = {}) {
-    super({
-      ...options,
-      queueClass: PeerPriorityQueue
-    })
-
-    this.results = new PeerMap()
-  }
-
-  /**
-   * 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
-  }
-
-  /**
-   * Returns a promise for the result of the job in the queue for the passed
-   * peer id.
-   */
-  async joinJob <Result = void> (peerId: PeerId): Promise<Result> {
-    let deferred = this.results.get(peerId)
-
-    if (deferred == null) {
-      throw new CodeError('No job found for peer id', 'ERR_NO_JOB_FOR_PEER_ID')
-    }
-
-    if (deferred === true) {
-      // a job has been added but so far nothing has tried to join the job
-      deferred = pDefer<Result>()
-      this.results.set(peerId, deferred)
-    }
-
-    return deferred.promise
-  }
-
-  async add <T> (fn: RunFunction<T>, opts: PeerPriorityQueueOptions): Promise<T> {
-    const peerId = opts?.peerId
-
-    if (peerId == null) {
-      throw new CodeError('missing peer id', ERR_INVALID_PARAMETERS)
-    }
-
-    this.results.set(opts.peerId, true)
-
-    return super.add(async (opts?: AbortOptions) => {
-      try {
-        const value = await fn(opts)
-
-        const deferred = this.results.get(peerId)
-
-        if (deferred != null && deferred !== true) {
-          deferred.resolve(value)
-        }
-
-        return value
-      } catch (err) {
-        const deferred = this.results.get(peerId)
-
-        if (deferred != null && deferred !== true) {
-          deferred.reject(err)
-        }
-
-        throw err
-      } finally {
-        this.results.delete(peerId)
-      }
-    }, opts) as Promise<T>
-  }
-
-  clear (): void {
-    this.results.clear()
-    super.clear()
-  }
-}