@libp2p/utils 6.1.3-a5cd8cfbe → 6.1.3-c2ff2e454

package/dist/src/debounce.d.ts

@@ -0,0 +1,11 @@
+export interface CancelableFunction {
+    (): void;
+    stop(): void;
+}
+/**
+ * Returns a function wrapper that will only call the passed function once
+ *
+ * Important - the passed function should not throw or reject
+ */
+export declare function debounce(func: () => void | Promise<void>, wait: number): CancelableFunction;
+//# sourceMappingURL=debounce.d.ts.map

package/dist/src/debounce.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debounce.d.ts","sourceRoot":"","sources":["../../src/debounce.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,kBAAkB;IACjC,IAAI,IAAI,CAAA;IACR,IAAI,IAAI,IAAI,CAAA;CACb;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAE,IAAI,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,kBAAkB,CAiB5F"}

package/dist/src/debounce.js

@@ -0,0 +1,21 @@
+/**
+ * Returns a function wrapper that will only call the passed function once
+ *
+ * Important - the passed function should not throw or reject
+ */
+export function debounce(func, wait) {
+    let timeout;
+    const output = function () {
+        const later = function () {
+            timeout = undefined;
+            void func();
+        };
+        clearTimeout(timeout);
+        timeout = setTimeout(later, wait);
+    };
+    output.stop = () => {
+        clearTimeout(timeout);
+    };
+    return output;
+}
+//# sourceMappingURL=debounce.js.map

package/dist/src/debounce.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"debounce.js","sourceRoot":"","sources":["../../src/debounce.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAE,IAAgC,EAAE,IAAY;IACtE,IAAI,OAAkD,CAAA;IAEtD,MAAM,MAAM,GAAG;QACb,MAAM,KAAK,GAAG;YACZ,OAAO,GAAG,SAAS,CAAA;YACnB,KAAK,IAAI,EAAE,CAAA;QACb,CAAC,CAAA;QAED,YAAY,CAAC,OAAO,CAAC,CAAA;QACrB,OAAO,GAAG,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IACnC,CAAC,CAAA;IACD,MAAM,CAAC,IAAI,GAAG,GAAG,EAAE;QACjB,YAAY,CAAC,OAAO,CAAC,CAAA;IACvB,CAAC,CAAA;IAED,OAAO,MAAM,CAAA;AACf,CAAC"}

package/dist/src/repeating-task.d.ts

@@ -0,0 +1,18 @@
+import type { AbortOptions } from '@libp2p/interface';
+export interface RepeatingTask {
+    start(): void;
+    stop(): void;
+}
+export interface RepeatingTaskOptions {
+    /**
+     * How long the task is allowed to run before the passed AbortSignal fires an
+     * abort event
+     */
+    timeout?: number;
+    /**
+     * Whether to schedule the task to run immediately
+     */
+    runImmediately?: boolean;
+}
+export declare function repeatingTask(fn: (options?: AbortOptions) => void | Promise<void>, interval: number, options?: RepeatingTaskOptions): RepeatingTask;
+//# sourceMappingURL=repeating-task.d.ts.map

package/dist/src/repeating-task.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"repeating-task.d.ts","sourceRoot":"","sources":["../../src/repeating-task.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,MAAM,WAAW,aAAa;IAC5B,KAAK,IAAI,IAAI,CAAA;IACb,IAAI,IAAI,IAAI,CAAA;CACb;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,wBAAgB,aAAa,CAAE,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,YAAY,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,aAAa,CA2DpJ"}

package/dist/src/repeating-task.js

@@ -0,0 +1,55 @@
+import { setMaxListeners } from '@libp2p/interface';
+import { anySignal } from 'any-signal';
+export function repeatingTask(fn, interval, options) {
+    let timeout;
+    let shutdownController;
+    function runTask() {
+        const opts = {
+            signal: shutdownController.signal
+        };
+        if (options?.timeout != null) {
+            const signal = anySignal([shutdownController.signal, AbortSignal.timeout(options.timeout)]);
+            setMaxListeners(Infinity, signal);
+            opts.signal = signal;
+        }
+        Promise.resolve().then(async () => {
+            await fn(opts);
+        })
+            .catch(() => { })
+            .finally(() => {
+            if (shutdownController.signal.aborted) {
+                // task has been cancelled, bail
+                return;
+            }
+            // reschedule
+            timeout = setTimeout(runTask, interval);
+        });
+    }
+    let started = false;
+    return {
+        start: () => {
+            if (started) {
+                return;
+            }
+            started = true;
+            shutdownController = new AbortController();
+            setMaxListeners(Infinity, shutdownController.signal);
+            // run now
+            if (options?.runImmediately === true) {
+                queueMicrotask(() => {
+                    runTask();
+                });
+            }
+            else {
+                // run later
+                timeout = setTimeout(runTask, interval);
+            }
+        },
+        stop: () => {
+            clearTimeout(timeout);
+            shutdownController?.abort();
+            started = false;
+        }
+    };
+}
+//# sourceMappingURL=repeating-task.js.map

package/dist/src/repeating-task.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"repeating-task.js","sourceRoot":"","sources":["../../src/repeating-task.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAqBtC,MAAM,UAAU,aAAa,CAAE,EAAoD,EAAE,QAAgB,EAAE,OAA8B;IACnI,IAAI,OAAsC,CAAA;IAC1C,IAAI,kBAAmC,CAAA;IAEvC,SAAS,OAAO;QACd,MAAM,IAAI,GAAiB;YACzB,MAAM,EAAE,kBAAkB,CAAC,MAAM;SAClC,CAAA;QAED,IAAI,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;YAC3F,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;YAEjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACtB,CAAC;QAED,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE;YAChC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAA;QAChB,CAAC,CAAC;aACC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC;aACf,OAAO,CAAC,GAAG,EAAE;YACZ,IAAI,kBAAkB,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACtC,gCAAgC;gBAChC,OAAM;YACR,CAAC;YAED,aAAa;YACb,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;QACzC,CAAC,CAAC,CAAA;IACN,CAAC;IAED,IAAI,OAAO,GAAG,KAAK,CAAA;IAEnB,OAAO;QACL,KAAK,EAAE,GAAG,EAAE;YACV,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAM;YACR,CAAC;YAED,OAAO,GAAG,IAAI,CAAA;YACd,kBAAkB,GAAG,IAAI,eAAe,EAAE,CAAA;YAC1C,eAAe,CAAC,QAAQ,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAA;YAEpD,UAAU;YACV,IAAI,OAAO,EAAE,cAAc,KAAK,IAAI,EAAE,CAAC;gBACrC,cAAc,CAAC,GAAG,EAAE;oBAClB,OAAO,EAAE,CAAA;gBACX,CAAC,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,YAAY;gBACZ,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;YACzC,CAAC;QACH,CAAC;QACD,IAAI,EAAE,GAAG,EAAE;YACT,YAAY,CAAC,OAAO,CAAC,CAAA;YACrB,kBAAkB,EAAE,KAAK,EAAE,CAAA;YAC3B,OAAO,GAAG,KAAK,CAAA;QACjB,CAAC;KACF,CAAA;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/utils",
-  "version": "6.1.3-a5cd8cfbe",
+  "version": "6.1.3-c2ff2e454",
   "description": "Package to aggregate shared logic and dependencies for the libp2p ecosystem",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/utils#readme",
@@ -68,6 +68,10 @@
       "types": "./dist/src/close-source.d.ts",
       "import": "./dist/src/close-source.js"
     },
+    "./debounce": {
+      "types": "./dist/src/debounce.d.ts",
+      "import": "./dist/src/debounce.js"
+    },
     "./filters": {
       "types": "./dist/src/filters/index.d.ts",
       "import": "./dist/src/filters/index.js"
@@ -112,6 +116,10 @@
       "types": "./dist/src/rate-limiter.d.ts",
       "import": "./dist/src/rate-limiter.js"
     },
+    "./repeating-task": {
+      "types": "./dist/src/repeating-task.d.ts",
+      "import": "./dist/src/repeating-task.js"
+    },
     "./stream-to-ma-conn": {
       "types": "./dist/src/stream-to-ma-conn.d.ts",
       "import": "./dist/src/stream-to-ma-conn.js"
@@ -148,9 +156,9 @@
   },
   "dependencies": {
     "@chainsafe/is-ip": "^2.0.2",
-    "@libp2p/crypto": "5.0.6-a5cd8cfbe",
-    "@libp2p/interface": "2.2.0-a5cd8cfbe",
-    "@libp2p/logger": "5.1.3-a5cd8cfbe",
+    "@libp2p/crypto": "5.0.6-c2ff2e454",
+    "@libp2p/interface": "2.2.0-c2ff2e454",
+    "@libp2p/logger": "5.1.3-c2ff2e454",
     "@multiformats/multiaddr": "^12.2.3",
     "@sindresorhus/fnv1a": "^3.1.0",
     "@types/murmurhash3js-revisited": "^3.0.3",
@@ -171,7 +179,7 @@
     "uint8arrays": "^5.1.0"
   },
   "devDependencies": {
-    "@libp2p/peer-id": "5.0.7-a5cd8cfbe",
+    "@libp2p/peer-id": "5.0.7-c2ff2e454",
     "@types/netmask": "^2.0.5",
     "aegir": "^44.0.1",
     "benchmark": "^2.1.4",

package/src/debounce.ts

@@ -0,0 +1,28 @@
+export interface CancelableFunction {
+  (): void
+  stop(): void
+}
+
+/**
+ * Returns a function wrapper that will only call the passed function once
+ *
+ * Important - the passed function should not throw or reject
+ */
+export function debounce (func: () => void | Promise<void>, wait: number): CancelableFunction {
+  let timeout: ReturnType<typeof setTimeout> | undefined
+
+  const output = function (): void {
+    const later = function (): void {
+      timeout = undefined
+      void func()
+    }
+
+    clearTimeout(timeout)
+    timeout = setTimeout(later, wait)
+  }
+  output.stop = () => {
+    clearTimeout(timeout)
+  }
+
+  return output
+}

package/src/repeating-task.ts

@@ -0,0 +1,82 @@
+import { setMaxListeners } from '@libp2p/interface'
+import { anySignal } from 'any-signal'
+import type { AbortOptions } from '@libp2p/interface'
+
+export interface RepeatingTask {
+  start(): void
+  stop(): void
+}
+
+export interface RepeatingTaskOptions {
+  /**
+   * How long the task is allowed to run before the passed AbortSignal fires an
+   * abort event
+   */
+  timeout?: number
+
+  /**
+   * Whether to schedule the task to run immediately
+   */
+  runImmediately?: boolean
+}
+
+export function repeatingTask (fn: (options?: AbortOptions) => void | Promise<void>, interval: number, options?: RepeatingTaskOptions): RepeatingTask {
+  let timeout: ReturnType<typeof setTimeout>
+  let shutdownController: AbortController
+
+  function runTask (): void {
+    const opts: AbortOptions = {
+      signal: shutdownController.signal
+    }
+
+    if (options?.timeout != null) {
+      const signal = anySignal([shutdownController.signal, AbortSignal.timeout(options.timeout)])
+      setMaxListeners(Infinity, signal)
+
+      opts.signal = signal
+    }
+
+    Promise.resolve().then(async () => {
+      await fn(opts)
+    })
+      .catch(() => {})
+      .finally(() => {
+        if (shutdownController.signal.aborted) {
+          // task has been cancelled, bail
+          return
+        }
+
+        // reschedule
+        timeout = setTimeout(runTask, interval)
+      })
+  }
+
+  let started = false
+
+  return {
+    start: () => {
+      if (started) {
+        return
+      }
+
+      started = true
+      shutdownController = new AbortController()
+      setMaxListeners(Infinity, shutdownController.signal)
+
+      // run now
+      if (options?.runImmediately === true) {
+        queueMicrotask(() => {
+          runTask()
+        })
+      } else {
+        // run later
+        timeout = setTimeout(runTask, interval)
+      }
+    },
+    stop: () => {
+      clearTimeout(timeout)
+      shutdownController?.abort()
+      started = false
+    }
+  }
+}