@helia/verified-fetch 2.6.17 → 2.6.19

package/dist/typedoc-urls.json

@@ -1,4 +1,6 @@
 {
+  "start": "https://ipfs.github.io/helia-verified-fetch/functions/index.verifiedFetch.start.html",
+  "stop": "https://ipfs.github.io/helia-verified-fetch/functions/index.verifiedFetch.stop.html",
   "BasePlugin": "https://ipfs.github.io/helia-verified-fetch/classes/index.BasePlugin.html",
   "DirIndexHtmlPlugin": "https://ipfs.github.io/helia-verified-fetch/classes/index.DirIndexHtmlPlugin.html",
   "PluginError": "https://ipfs.github.io/helia-verified-fetch/classes/index.PluginError.html",
@@ -27,8 +29,8 @@
   ".:Resource": "https://ipfs.github.io/helia-verified-fetch/types/index.Resource.html",
   "VerifiedFetchProgressEvents": "https://ipfs.github.io/helia-verified-fetch/types/index.VerifiedFetchProgressEvents.html",
   ".:VerifiedFetchProgressEvents": "https://ipfs.github.io/helia-verified-fetch/types/index.VerifiedFetchProgressEvents.html",
+  "dirIndexHtmlPluginFactory": "https://ipfs.github.io/helia-verified-fetch/variables/index.dirIndexHtmlPluginFactory.html",
+  "verifiedFetch": "https://ipfs.github.io/helia-verified-fetch/variables/index.verifiedFetch.html",
   "createVerifiedFetch": "https://ipfs.github.io/helia-verified-fetch/functions/index.createVerifiedFetch.html",
-  ".:createVerifiedFetch": "https://ipfs.github.io/helia-verified-fetch/functions/index.createVerifiedFetch.html",
-  "dirIndexHtmlPluginFactory": "https://ipfs.github.io/helia-verified-fetch/functions/index.dirIndexHtmlPluginFactory.html",
-  "verifiedFetch": "https://ipfs.github.io/helia-verified-fetch/functions/index.verifiedFetch-1.html"
+  ".:createVerifiedFetch": "https://ipfs.github.io/helia-verified-fetch/functions/index.createVerifiedFetch.html"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helia/verified-fetch",
-  "version": "2.6.17",
+  "version": "2.6.19",
   "description": "A fetch-like API for obtaining verified & trustless IPFS content on the web",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/ipfs/helia-verified-fetch/tree/main/packages/verified-fetch#readme",
@@ -54,13 +54,6 @@
       "import": "./dist/src/plugins/plugins.js"
     }
   },
-  "eslintConfig": {
-    "extends": "ipfs",
-    "parserOptions": {
-      "project": true,
-      "sourceType": "module"
-    }
-  },
   "release": {
     "branches": [
       "main"
@@ -180,17 +173,16 @@
     "@helia/unixfs": "^5.0.2",
     "@ipld/dag-cbor": "^9.2.3",
     "@ipld/dag-json": "^10.2.4",
-    "@ipld/dag-pb": "^4.1.4",
-    "@libp2p/interface": "^2.9.0",
-    "@libp2p/kad-dht": "^15.0.2",
-    "@libp2p/logger": "^5.1.15",
-    "@libp2p/peer-id": "^5.1.2",
-    "@libp2p/webrtc": "^5.2.12",
-    "@libp2p/websockets": "^9.2.10",
+    "@ipld/dag-pb": "^4.1.5",
+    "@libp2p/interface": "^2.10.1",
+    "@libp2p/kad-dht": "^15.1.1",
+    "@libp2p/logger": "^5.1.17",
+    "@libp2p/peer-id": "^5.1.4",
+    "@libp2p/webrtc": "^5.2.14",
+    "@libp2p/websockets": "^9.2.12",
     "@multiformats/dns": "^1.0.6",
-    "cborg": "^4.2.10",
+    "cborg": "^4.2.11",
     "file-type": "^20.5.0",
-    "hashlru": "^2.3.0",
     "helia": "^5.4.1",
     "interface-blockstore": "^5.3.1",
     "interface-datastore": "^8.3.1",
@@ -200,10 +192,10 @@
     "it-pipe": "^3.0.1",
     "it-tar": "^6.0.5",
     "it-to-browser-readablestream": "^2.0.11",
-    "libp2p": "^2.8.5",
-    "lru-cache": "^11.1.0",
-    "multiformats": "^13.3.3",
+    "libp2p": "^2.8.7",
+    "multiformats": "^13.3.6",
     "progress-events": "^1.0.1",
+    "quick-lru": "^7.0.1",
     "uint8arrays": "^5.1.0"
   },
   "devDependencies": {
@@ -212,9 +204,9 @@
     "@helia/http": "^2.1.1",
     "@helia/json": "^4.0.5",
     "@ipld/car": "^5.4.1",
-    "@libp2p/crypto": "^5.1.1",
+    "@libp2p/crypto": "^5.1.3",
     "@types/sinon": "^17.0.4",
-    "aegir": "^46.0.1",
+    "aegir": "^47.0.11",
     "blockstore-core": "^5.0.2",
     "browser-readablestream-to-it": "^2.0.9",
     "datastore-core": "^10.0.2",

package/src/index.ts

@@ -591,8 +591,8 @@
  *
  * #### Unsupported response types
  *
- * * Returning IPLD nodes or DAGs as JS objects is not supported, as there is no currently well-defined structure for representing this data in an [HTTP Response](https://developer.mozilla.org/en-US/docs/Web/API/Response). Instead, users should request `aplication/vnd.ipld.car` or use the [`helia`](https://github.com/ipfs/helia) library directly for this use case.
- * * Others? Open an issue or PR!
+ * - Returning IPLD nodes or DAGs as JS objects is not supported, as there is no currently well-defined structure for representing this data in an [HTTP Response](https://developer.mozilla.org/en-US/docs/Web/API/Response). Instead, users should request `aplication/vnd.ipld.car` or use the [`helia`](https://github.com/ipfs/helia) library directly for this use case.
+ * - Others? Open an issue or PR!
  *
  * ### Response headers
  *
@@ -600,9 +600,9 @@
  *
  * Some known header specifications:
  *
- * * https://specs.ipfs.tech/http-gateways/path-gateway/#response-headers
- * * https://specs.ipfs.tech/http-gateways/trustless-gateway/#response-headers
- * * https://specs.ipfs.tech/http-gateways/subdomain-gateway/#response-headers
+ * - https://specs.ipfs.tech/http-gateways/path-gateway/#response-headers
+ * - https://specs.ipfs.tech/http-gateways/trustless-gateway/#response-headers
+ * - https://specs.ipfs.tech/http-gateways/subdomain-gateway/#response-headers
  *
  * #### Server Timing headers
  *

package/src/plugins/plugin-handle-dag-pb.ts

@@ -1,5 +1,6 @@
 import { unixfs } from '@helia/unixfs'
 import { code as dagPbCode } from '@ipld/dag-pb'
+import { AbortError } from '@libp2p/interface'
 import { exporter } from 'ipfs-unixfs-exporter'
 import { CustomProgressEvent } from 'progress-events'
 import { getStreamFromAsyncIterable } from '../utils/get-stream-from-async-iterable.js'
@@ -98,8 +99,10 @@ export class DagPbPlugin extends BasePlugin {
         path = rootFilePath
         resolvedCID = entry.cid
       } catch (err: any) {
+        if (options?.signal?.aborted) {
+          throw new AbortError(options?.signal?.reason)
+        }
         this.log.error('error loading path %c/%s', dirCid, rootFilePath, err)
-        options?.signal?.throwIfAborted()
         context.isDirectory = true
         context.directoryEntries = []
         context.modified++
@@ -161,7 +164,9 @@ export class DagPbPlugin extends BasePlugin {
 
       return response
     } catch (err: any) {
-      options?.signal?.throwIfAborted()
+      if (options?.signal?.aborted) {
+        throw new AbortError(options?.signal?.reason)
+      }
       log.error('error streaming %c/%s', cid, path, err)
       if (byteRangeContext.isRangeRequest && err.code === 'ERR_INVALID_PARAMS') {
         return badRangeResponse(resource)

package/src/plugins/plugin-handle-dag-walk.ts

@@ -29,10 +29,10 @@ export class DagWalkPlugin extends BasePlugin {
     const { cid, resource, options, withServerTiming = false } = context
     const { getBlockstore, handleServerTiming } = this.pluginOptions
     const blockstore = getBlockstore(cid, resource, options?.session ?? true, options)
+
     // TODO: migrate handlePathWalking into this plugin
     const pathDetails = await handleServerTiming('path-walking', '', async () => handlePathWalking({ ...context, blockstore, log: this.log }), withServerTiming)
 
-    context.modified++
     if (pathDetails instanceof Response) {
       this.log.trace('path walking failed')
 
@@ -42,10 +42,11 @@ export class DagWalkPlugin extends BasePlugin {
         return pathDetails
       }
 
-      // some error walking the path
+      // some other error walking the path (codec doesn't support pathing, etc..), let the next plugin try to handle it
       return null
     }
 
+    context.modified++
     context.pathDetails = pathDetails
 
     return null

package/src/types.ts

@@ -1,6 +1,6 @@
 export type RequestFormatShorthand = 'raw' | 'car' | 'tar' | 'ipns-record' | 'dag-json' | 'dag-cbor' | 'json' | 'cbor'
 
-export type SupportedBodyTypes = string | ArrayBuffer | Blob | ReadableStream<Uint8Array> | null
+export type SupportedBodyTypes = string | Uint8Array | ArrayBuffer | Blob | ReadableStream<Uint8Array> | null
 
 /**
  * A ContentTypeParser attempts to return the mime type of a given file. It

package/src/utils/dir-index-html.ts

@@ -4,8 +4,8 @@ import type { UnixFSEntry } from 'ipfs-unixfs-exporter'
 /**
  * Types taken from:
  *
- * * https://github.com/ipfs/boxo/blob/09b0013e1c3e09468009b02dfc9b2b9041199d5d/gateway/assets/assets.go#L92C1-L96C2
- * * https://github.com/ipfs/boxo/blob/09b0013e1c3e09468009b02dfc9b2b9041199d5d/gateway/assets/assets.go#L114C1-L135C2
+ * - https://github.com/ipfs/boxo/blob/09b0013e1c3e09468009b02dfc9b2b9041199d5d/gateway/assets/assets.go#L92C1-L96C2
+ * - https://github.com/ipfs/boxo/blob/09b0013e1c3e09468009b02dfc9b2b9041199d5d/gateway/assets/assets.go#L114C1-L135C2
  */
 
 interface GlobalData {

package/src/utils/get-stream-from-async-iterable.ts

@@ -25,7 +25,7 @@ export async function getStreamFromAsyncIterable (iterator: AsyncIterable<Uint8A
     },
     async pull (controller) {
       const { value, done } = await reader.next()
-      if (options?.signal?.aborted === true) {
+      if (options?.signal?.aborted) {
         controller.error(new AbortError(options.signal.reason ?? 'signal aborted by user'))
         controller.close()
         return

package/src/utils/libp2p-defaults.browser.ts

@@ -1,7 +1,7 @@
 import { webRTCDirect } from '@libp2p/webrtc'
 import { webSockets } from '@libp2p/websockets'
 import { libp2pDefaults } from 'helia'
-import type { ServiceFactoryMap } from './libp2p-types'
+import type { ServiceFactoryMap } from './libp2p-types.js'
 import type { DefaultLibp2pServices } from 'helia'
 import type { Libp2pOptions } from 'libp2p'
 

package/src/utils/libp2p-defaults.ts

@@ -2,7 +2,7 @@ import { kadDHT } from '@libp2p/kad-dht'
 import { libp2pDefaults } from 'helia'
 import { ipnsSelector } from 'ipns/selector'
 import { ipnsValidator } from 'ipns/validator'
-import type { ServiceFactoryMap } from './libp2p-types'
+import type { ServiceFactoryMap } from './libp2p-types.js'
 import type { DefaultLibp2pServices } from 'helia'
 import type { Libp2pOptions } from 'libp2p'
 

package/src/utils/parse-url-string.ts

@@ -1,3 +1,4 @@
+import { AbortError } from '@libp2p/interface'
 import { CID } from 'multiformats/cid'
 import { getPeerIdFromString } from './get-peer-id-from-string.js'
 import { serverTiming } from './server-timing.js'
@@ -65,9 +66,9 @@ interface MatchUrlGroups {
 
 function matchUrlGroupsGuard (groups?: null | { [key in string]: string; } | MatchUrlGroups): groups is MatchUrlGroups {
   const protocol = groups?.protocol
-  if (protocol == null) return false
+  if (protocol == null) { return false }
   const cidOrPeerIdOrDnsLink = groups?.cidOrPeerIdOrDnsLink
-  if (cidOrPeerIdOrDnsLink == null) return false
+  if (cidOrPeerIdOrDnsLink == null) { return false }
   const path = groups?.path
   const queryString = groups?.queryString
 
@@ -132,8 +133,8 @@ function isInlinedDnsLink (label: string): boolean {
 
 /**
  * DNSLink label decoding
- * * Every standalone - is replaced with .
- * * Every remaining -- is replaced with -
+ * - Every standalone - is replaced with .
+ * - Every remaining -- is replaced with -
  *
  * @example en-wikipedia--on--ipfs-org.ipns.example.net -> example.net/ipns/en.wikipedia-on-ipfs.org
  */
@@ -145,8 +146,8 @@ function dnsLinkLabelDecoder (linkLabel: string): string {
  * A function that parses ipfs:// and ipns:// URLs, returning an object with easily recognizable properties.
  *
  * After determining the protocol successfully, we process the cidOrPeerIdOrDnsLink:
- * * If it's ipfs, it parses the CID or throws Error[]
- * * If it's ipns, it attempts to resolve the PeerId and then the DNSLink. If both fail, Error[] is thrown.
+ * - If it's ipfs, it parses the CID or throws Error[]
+ * - If it's ipns, it attempts to resolve the PeerId and then the DNSLink. If both fail, Error[] is thrown.
  *
  * @todo we need to break out each step of this function (cid parsing, ipns resolving, dnslink resolving) into separate functions and then remove the eslint-disable comment
  *
@@ -212,7 +213,9 @@ export async function parseUrlString ({ urlString, ipns, logger, withServerTimin
         resolvedPath = resolveResult?.path
         log.trace('resolved %s to %c', cidOrPeerIdOrDnsLink, cid)
       } catch (err) {
-        options?.signal?.throwIfAborted()
+        if (options?.signal?.aborted) {
+          throw new AbortError(options?.signal?.reason)
+        }
         if (peerId == null) {
           log.error('could not parse PeerId string "%s"', cidOrPeerIdOrDnsLink, err)
           errors.push(new TypeError(`Could not parse PeerId in ipns url "${cidOrPeerIdOrDnsLink}", ${(err as Error).message}`))
@@ -249,7 +252,10 @@ export async function parseUrlString ({ urlString, ipns, logger, withServerTimin
           resolvedPath = resolveResult?.path
           log.trace('resolved %s to %c', decodedDnsLinkLabel, cid)
         } catch (err: any) {
-          options?.signal?.throwIfAborted()
+          // eslint-disable-next-line max-depth
+          if (options?.signal?.aborted) {
+            throw new AbortError(options?.signal?.reason)
+          }
           log.error('could not resolve DnsLink for "%s"', cidOrPeerIdOrDnsLink, err)
           errors.push(err)
         }
@@ -264,7 +270,7 @@ export async function parseUrlString ({ urlString, ipns, logger, withServerTimin
 
     errors.push(new Error(`Invalid resource. Cannot determine CID from URL "${urlString}".`))
 
-    // eslint-disable-next-line @typescript-eslint/no-throw-literal
+    // eslint-disable-next-line @typescript-eslint/only-throw-error
     throw errors
   }
 

package/src/utils/responses.ts

@@ -1,4 +1,4 @@
-import type { ByteRangeContext } from './byte-range-context'
+import type { ByteRangeContext } from './byte-range-context.js'
 import type { SupportedBodyTypes } from '../types.js'
 import type { Logger } from '@libp2p/interface'
 
@@ -193,9 +193,9 @@ export function okRangeResponse (url: string, body: SupportedBodyTypes, { byteRa
 
 /**
  * We likely need to catch errors handled by upstream helia libraries if range-request throws an error. Some examples:
- * * The range is out of bounds
- * * The range is invalid
- * * The range is not supported for the given type
+ * - The range is out of bounds
+ * - The range is invalid
+ * - The range is not supported for the given type
  */
 export function badRangeResponse (url: string, body?: SupportedBodyTypes, init?: ResponseInit): Response {
   const response = new Response(body, {

package/src/utils/tlru.ts

@@ -1,4 +1,4 @@
-import hashlru from 'hashlru'
+import QuickLRU from 'quick-lru'
 
 /**
  * Time Aware Least Recent Used Cache
@@ -6,30 +6,20 @@ import hashlru from 'hashlru'
  * @see https://arxiv.org/pdf/1801.00390
  */
 export class TLRU<T> {
-  private readonly lru: ReturnType<typeof hashlru>
+  private readonly lru: QuickLRU<string, T>
 
   constructor (maxSize: number) {
-    this.lru = hashlru(maxSize)
+    this.lru = new QuickLRU({ maxSize })
   }
 
   get (key: string): T | undefined {
-    const value = this.lru.get(key)
-
-    if (value != null) {
-      if (value.expire != null && value.expire < Date.now()) {
-        this.lru.remove(key)
-
-        return undefined
-      }
-
-      return value.value
-    }
-
-    return undefined
+    return this.lru.get(key)
   }
 
   set (key: string, value: T, ttlMs: number): void {
-    this.lru.set(key, { value, expire: Date.now() + ttlMs })
+    this.lru.set(key, value, {
+      maxAge: Date.now() + ttlMs
+    })
   }
 
   has (key: string): boolean {
@@ -43,7 +33,7 @@ export class TLRU<T> {
   }
 
   remove (key: string): void {
-    this.lru.remove(key)
+    this.lru.delete(key)
   }
 
   clear (): void {

package/src/utils/walk-path.ts

@@ -1,4 +1,5 @@
 import { DoesNotExistError } from '@helia/unixfs/errors'
+import { AbortError } from '@libp2p/interface'
 import { walkPath as exporterWalk } from 'ipfs-unixfs-exporter'
 import { badGatewayResponse, notFoundResponse } from './responses.js'
 import type { PluginContext } from '../plugins/types.js'
@@ -53,7 +54,10 @@ export async function handlePathWalking ({ cid, path, resource, options, blockst
   try {
     return await walkPath(blockstore, `${cid.toString()}/${path}`, options)
   } catch (err: any) {
-    options?.signal?.throwIfAborted()
+    if (options?.signal?.aborted) {
+      throw new AbortError(options?.signal?.reason)
+    }
+
     if (['ERR_NO_PROP', 'ERR_NO_TERMINAL_ELEMENT', 'ERR_NOT_FOUND'].includes(err.code)) {
       return notFoundResponse(resource)
     }

package/src/verified-fetch.ts

@@ -1,7 +1,8 @@
 import { ipns as heliaIpns } from '@helia/ipns'
+import { AbortError } from '@libp2p/interface'
 import { prefixLogger } from '@libp2p/logger'
-import { LRUCache } from 'lru-cache'
 import { CustomProgressEvent } from 'progress-events'
+import QuickLRU from 'quick-lru'
 import { ByteRangeContextPlugin } from './plugins/plugin-handle-byte-range-context.js'
 import { CarPlugin } from './plugins/plugin-handle-car.js'
 import { DagCborPlugin } from './plugins/plugin-handle-dag-cbor.js'
@@ -62,7 +63,7 @@ export class VerifiedFetch {
   private readonly ipns: IPNS
   private readonly log: Logger
   private readonly contentTypeParser: ContentTypeParser | undefined
-  private readonly blockstoreSessions: LRUCache<string, SessionBlockstore>
+  private readonly blockstoreSessions: QuickLRU<string, SessionBlockstore>
   private serverTimingHeaders: string[] = []
   private readonly withServerTiming: boolean
   private readonly plugins: VerifiedFetchPlugin[] = []
@@ -72,10 +73,10 @@ export class VerifiedFetch {
     this.log = helia.logger.forComponent('helia:verified-fetch')
     this.ipns = ipns ?? heliaIpns(helia)
     this.contentTypeParser = init?.contentTypeParser ?? contentTypeParser
-    this.blockstoreSessions = new LRUCache({
-      max: init?.sessionCacheSize ?? SESSION_CACHE_MAX_SIZE,
-      ttl: init?.sessionTTLms ?? SESSION_CACHE_TTL_MS,
-      dispose: (store) => {
+    this.blockstoreSessions = new QuickLRU({
+      maxSize: init?.sessionCacheSize ?? SESSION_CACHE_MAX_SIZE,
+      maxAge: init?.sessionTTLms ?? SESSION_CACHE_TTL_MS,
+      onEviction: (key, store) => {
         store.close()
       }
     })
@@ -282,7 +283,9 @@ export class VerifiedFetch {
             break
           }
         } catch (err: any) {
-          context.options?.signal?.throwIfAborted()
+          if (context.options?.signal?.aborted) {
+            throw new AbortError(context.options?.signal?.reason)
+          }
           this.log.error('Error in plugin:', plugin.constructor.name, err)
           // if fatal, short-circuit the pipeline
           if (err.name === 'PluginFatalError') {
@@ -341,7 +344,9 @@ export class VerifiedFetch {
       parsedResult = await this.handleServerTiming('parse-resource', '', async () => parseResource(resource, { ipns: this.ipns, logger: this.helia.logger }, { withServerTiming, ...options }), withServerTiming)
       this.serverTimingHeaders.push(...parsedResult.serverTimings.map(({ header }) => header))
     } catch (err: any) {
-      options?.signal?.throwIfAborted()
+      if (options?.signal?.aborted) {
+        throw new AbortError(options?.signal?.reason)
+      }
       this.log.error('error parsing resource %s', resource, err)
 
       return this.handleFinalResponse(badRequestResponse(resource.toString(), err))