@libp2p/utils 5.4.0-a11e135c2 → 5.4.0-d9366f9aa

package/dist/src/abort-options.d.ts

@@ -0,0 +1,7 @@
+import type { AbortOptions } from '@libp2p/interface';
+import type { ClearableSignal } from 'any-signal';
+export declare function createTimeoutOptions(timeout: number): AbortOptions;
+export declare function createTimeoutOptions(timeout: number, ...existingSignals: AbortSignal[]): {
+    signal: ClearableSignal;
+};
+//# sourceMappingURL=abort-options.d.ts.map

package/dist/src/abort-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abort-options.d.ts","sourceRoot":"","sources":["../../src/abort-options.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAEjD,wBAAgB,oBAAoB,CAAE,OAAO,EAAE,MAAM,GAAG,YAAY,CAAA;AACpE,wBAAgB,oBAAoB,CAAE,OAAO,EAAE,MAAM,EAAE,GAAG,eAAe,EAAE,WAAW,EAAE,GAAG;IAAE,MAAM,EAAE,eAAe,CAAA;CAAE,CAAA"}

package/dist/src/abort-options.js

@@ -0,0 +1,14 @@
+import { setMaxListeners } from '@libp2p/interface';
+import { anySignal } from 'any-signal';
+export function createTimeoutOptions(timeout, ...existingSignals) {
+    let signal = AbortSignal.timeout(timeout);
+    setMaxListeners(Infinity, signal);
+    if (existingSignals.length > 0) {
+        signal = anySignal([signal, ...existingSignals]);
+        setMaxListeners(Infinity, signal);
+    }
+    return {
+        signal
+    };
+}
+//# sourceMappingURL=abort-options.js.map

package/dist/src/abort-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abort-options.js","sourceRoot":"","sources":["../../src/abort-options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAMtC,MAAM,UAAU,oBAAoB,CAAE,OAAe,EAAE,GAAG,eAA8B;IACtF,IAAI,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IACzC,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IAEjC,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/B,MAAM,GAAG,SAAS,CAAC,CAAC,MAAM,EAAE,GAAG,eAAe,CAAC,CAAC,CAAA;QAChD,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IACnC,CAAC;IAED,OAAO;QACL,MAAM;KACP,CAAA;AACH,CAAC"}

package/dist/src/close.d.ts

@@ -0,0 +1,21 @@
+import type { Connection, Stream, AbortOptions } from '@libp2p/interface';
+/**
+ * Close the passed stream, falling back to aborting the stream if closing
+ * cleanly fails.
+ */
+export declare function safelyCloseStream(stream?: Stream, options?: AbortOptions): Promise<void>;
+export interface SafelyCloseConnectionOptions extends AbortOptions {
+    /**
+     * Only close the stream if it either has no protocol streams open or only
+     * ones in this list.
+     *
+     * @default ['/ipfs/id/1.0.0']
+     */
+    closableProtocols?: string[];
+}
+/**
+ * Close the passed connection if it has no streams, or only closable protocol
+ * streams, falling back to aborting the connection if closing it cleanly fails.
+ */
+export declare function safelyCloseConnectionIfUnused(connection?: Connection, options?: SafelyCloseConnectionOptions): Promise<void>;
+//# sourceMappingURL=close.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"close.d.ts","sourceRoot":"","sources":["../../src/close.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAEzE;;;GAGG;AACH,wBAAsB,iBAAiB,CAAE,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAM/F;AAuBD,MAAM,WAAW,4BAA6B,SAAQ,YAAY;IAChE;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;CAC7B;AAED;;;GAGG;AACH,wBAAsB,6BAA6B,CAAE,UAAU,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,4BAA4B,GAAG,OAAO,CAAC,IAAI,CAAC,CAenI"}

package/dist/src/close.js

@@ -0,0 +1,49 @@
+/**
+ * Close the passed stream, falling back to aborting the stream if closing
+ * cleanly fails.
+ */
+export async function safelyCloseStream(stream, options) {
+    try {
+        await stream?.close(options);
+    }
+    catch (err) {
+        stream?.abort(err);
+    }
+}
+/**
+ * These are speculative protocols that are run automatically on connection open
+ * so are usually not the reason the connection was opened.
+ *
+ * Consequently when requested it should be safe to close connections that only
+ * have these protocol streams open.
+ */
+const DEFAULT_CLOSABLE_PROTOCOLS = [
+    // identify
+    '/ipfs/id/1.0.0',
+    // identify-push
+    '/ipfs/id/push/1.0.0',
+    // autonat
+    '/libp2p/autonat/1.0.0',
+    // dcutr
+    '/libp2p/dcutr'
+];
+/**
+ * Close the passed connection if it has no streams, or only closable protocol
+ * streams, falling back to aborting the connection if closing it cleanly fails.
+ */
+export async function safelyCloseConnectionIfUnused(connection, options) {
+    const streamProtocols = connection?.streams?.map(stream => stream.protocol) ?? [];
+    const closableProtocols = options?.closableProtocols ?? DEFAULT_CLOSABLE_PROTOCOLS;
+    // if the connection has protocols not in the closable protocols list, do not
+    // close the connection
+    if (streamProtocols.filter(proto => proto != null && !closableProtocols.includes(proto)).length > 0) {
+        return;
+    }
+    try {
+        await connection?.close(options);
+    }
+    catch (err) {
+        connection?.abort(err);
+    }
+}
+//# sourceMappingURL=close.js.map

package/dist/src/close.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"close.js","sourceRoot":"","sources":["../../src/close.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAE,MAAe,EAAE,OAAsB;IAC9E,IAAI,CAAC;QACH,MAAM,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;IAC9B,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;IACpB,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,0BAA0B,GAAG;IACjC,WAAW;IACX,gBAAgB;IAEhB,gBAAgB;IAChB,qBAAqB;IAErB,UAAU;IACV,uBAAuB;IAEvB,QAAQ;IACR,eAAe;CAChB,CAAA;AAYD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CAAE,UAAuB,EAAE,OAAsC;IAClH,MAAM,eAAe,GAAG,UAAU,EAAE,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAA;IACjF,MAAM,iBAAiB,GAAG,OAAO,EAAE,iBAAiB,IAAI,0BAA0B,CAAA;IAElF,6EAA6E;IAC7E,uBAAuB;IACvB,IAAI,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpG,OAAM;IACR,CAAC;IAED,IAAI,CAAC;QACH,MAAM,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;IAClC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,UAAU,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;IACxB,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/utils",
-  "version": "5.4.0-a11e135c2",
+  "version": "5.4.0-d9366f9aa",
   "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",
@@ -44,6 +44,10 @@
       "types": "./src/index.d.ts",
       "import": "./dist/src/index.js"
     },
+    "./abort-options": {
+      "types": "./dist/src/abort-options.d.ts",
+      "import": "./dist/src/abort-options.js"
+    },
     "./abstract-stream": {
       "types": "./dist/src/abstract-stream.d.ts",
       "import": "./dist/src/abstract-stream.js"
@@ -60,6 +64,10 @@
       "types": "./dist/src/close-source.d.ts",
       "import": "./dist/src/close-source.js"
     },
+    "./close": {
+      "types": "./dist/src/close.d.ts",
+      "import": "./dist/src/close.js"
+    },
     "./filters": {
       "types": "./dist/src/filters/index.d.ts",
       "import": "./dist/src/filters/index.js"
@@ -132,13 +140,14 @@
   },
   "dependencies": {
     "@chainsafe/is-ip": "^2.0.2",
-    "@libp2p/crypto": "4.1.1-a11e135c2",
-    "@libp2p/interface": "1.3.1-a11e135c2",
-    "@libp2p/logger": "4.0.12-a11e135c2",
+    "@libp2p/crypto": "4.1.1-d9366f9aa",
+    "@libp2p/interface": "1.3.1-d9366f9aa",
+    "@libp2p/logger": "4.0.12-d9366f9aa",
     "@multiformats/multiaddr": "^12.2.1",
     "@multiformats/multiaddr-matcher": "^1.2.0",
     "@sindresorhus/fnv1a": "^3.1.0",
     "@types/murmurhash3js-revisited": "^3.0.3",
+    "any-signal": "^4.1.1",
     "delay": "^6.0.0",
     "get-iterator": "^2.0.1",
     "is-loopback-addr": "^2.0.2",
@@ -153,7 +162,7 @@
     "uint8arrays": "^5.0.3"
   },
   "devDependencies": {
-    "@libp2p/peer-id-factory": "4.1.1-a11e135c2",
+    "@libp2p/peer-id-factory": "4.1.1-d9366f9aa",
     "@types/netmask": "^2.0.5",
     "aegir": "^42.2.5",
     "delay": "^6.0.0",

package/src/abort-options.ts

@@ -0,0 +1,20 @@
+import { setMaxListeners } from '@libp2p/interface'
+import { anySignal } from 'any-signal'
+import type { AbortOptions } from '@libp2p/interface'
+import type { ClearableSignal } from 'any-signal'
+
+export function createTimeoutOptions (timeout: number): AbortOptions
+export function createTimeoutOptions (timeout: number, ...existingSignals: AbortSignal[]): { signal: ClearableSignal }
+export function createTimeoutOptions (timeout: number, ...existingSignals: AbortSignal[]): AbortOptions {
+  let signal = AbortSignal.timeout(timeout)
+  setMaxListeners(Infinity, signal)
+
+  if (existingSignals.length > 0) {
+    signal = anySignal([signal, ...existingSignals])
+    setMaxListeners(Infinity, signal)
+  }
+
+  return {
+    signal
+  }
+}

package/src/close.ts

@@ -0,0 +1,65 @@
+import type { Connection, Stream, AbortOptions } from '@libp2p/interface'
+
+/**
+ * Close the passed stream, falling back to aborting the stream if closing
+ * cleanly fails.
+ */
+export async function safelyCloseStream (stream?: Stream, options?: AbortOptions): Promise<void> {
+  try {
+    await stream?.close(options)
+  } catch (err: any) {
+    stream?.abort(err)
+  }
+}
+
+/**
+ * These are speculative protocols that are run automatically on connection open
+ * so are usually not the reason the connection was opened.
+ *
+ * Consequently when requested it should be safe to close connections that only
+ * have these protocol streams open.
+ */
+const DEFAULT_CLOSABLE_PROTOCOLS = [
+  // identify
+  '/ipfs/id/1.0.0',
+
+  // identify-push
+  '/ipfs/id/push/1.0.0',
+
+  // autonat
+  '/libp2p/autonat/1.0.0',
+
+  // dcutr
+  '/libp2p/dcutr'
+]
+
+export interface SafelyCloseConnectionOptions extends AbortOptions {
+  /**
+   * Only close the stream if it either has no protocol streams open or only
+   * ones in this list.
+   *
+   * @default ['/ipfs/id/1.0.0']
+   */
+  closableProtocols?: string[]
+}
+
+/**
+ * Close the passed connection if it has no streams, or only closable protocol
+ * streams, falling back to aborting the connection if closing it cleanly fails.
+ */
+export async function safelyCloseConnectionIfUnused (connection?: Connection, options?: SafelyCloseConnectionOptions): Promise<void> {
+  const streamProtocols = connection?.streams?.map(stream => stream.protocol) ?? []
+  const closableProtocols = options?.closableProtocols ?? DEFAULT_CLOSABLE_PROTOCOLS
+
+  // if the connection has protocols not in the closable protocols list, do not
+  // close the connection
+  if (streamProtocols.filter(proto => proto != null && !closableProtocols.includes(proto)).length > 0) {
+    return
+  }
+
+  try {
+    await connection?.close(options)
+  } catch (err: any) {
+    connection?.abort(err)
+  }
+}