@helia/verified-fetch 7.0.2 → 7.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helia/verified-fetch",
-  "version": "7.0.2",
+  "version": "7.0.4",
   "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",

package/src/index.ts

@@ -872,7 +872,7 @@ export interface PluginOptions {
  * - Shared Data: Allows plugins to communicate partial results, discovered data, or interim errors.
  * - Ephemeral: Typically discarded once fetch(...) completes.
  */
-export interface PluginContext extends ResolveURLResult {
+export interface PluginContext extends ResolveURLResult, Omit<VerifiedFetchInit, 'signal'>, AbortOptions {
   /**
    * The resource that was requested by the user
    */
@@ -905,11 +905,6 @@ export interface PluginContext extends ResolveURLResult {
    */
   onProgress?(evt: ProgressEvent): void
 
-  /**
-   * Onward options to pass to async operations
-   */
-  options?: Omit<VerifiedFetchInit, 'signal'> & AbortOptions
-
   /**
    * Any async operations should be invoked using server timings to allow
    * introspection by the user
@@ -1234,7 +1229,7 @@ export interface VerifiedFetchInit extends RequestInit, ProgressOptions<Verified
 
 export type URLProtocols = 'ipfs' | 'ipns' | 'dnslink'
 
-export interface ResolveURLOptions extends AbortOptions, ProviderOptions {
+export interface ResolveURLOptions extends AbortOptions, ProviderOptions, ProgressOptions {
   /**
    * If true, only peers that are found to have the root block of a DAG will be
    * queried for subsequent blocks. If no peers in the session have a subsequent
@@ -1255,6 +1250,11 @@ export interface ResolveURLOptions extends AbortOptions, ProviderOptions {
    * Allows control of how redirects are processed
    */
   redirect?: RequestInit['redirect']
+
+  /**
+   * Record timing information in a response header
+   */
+  serverTiming?: ServerTiming
 }
 
 export interface ResolveURLResult {

package/src/plugins/plugin-handle-car.ts

@@ -54,7 +54,7 @@ export class CarPlugin extends BasePlugin {
   }
 
   async handle (context: PluginContext): Promise<Response> {
-    const { options, url, accept, resource, blockstore, range, ipfsRoots, terminalElement, requestedMimeTypes } = context
+    const { url, accept, resource, blockstore, range, ipfsRoots, terminalElement, requestedMimeTypes } = context
 
     if (range != null) {
       return badRequestResponse(resource, new Error('Range requests are not supported for CAR files'))
@@ -87,7 +87,7 @@ export class CarPlugin extends BasePlugin {
     })
 
     const carExportOptions: ExportCarOptions = {
-      ...options,
+      ...context,
       includeTraversalBlocks: true
     }
 
@@ -112,7 +112,7 @@ export class CarPlugin extends BasePlugin {
           listingOnly: true
         }
 
-        const entry = await exporter(terminalElement.cid, blockstore, context.options)
+        const entry = await exporter(terminalElement.cid, blockstore, context)
 
         if (entry.type === 'file') {
           const slice = entityBytesToOffsetAndLength(entry.size, url.searchParams.get('entity-bytes'))

package/src/plugins/plugin-handle-ipld.ts

@@ -41,10 +41,10 @@ export class IpldPlugin extends BasePlugin {
   }
 
   async handle (context: PluginContext): Promise<Response> {
-    const { url, resource, accept, ipfsRoots, terminalElement, blockstore, options, requestedMimeTypes } = context
+    const { url, resource, accept, ipfsRoots, terminalElement, blockstore, requestedMimeTypes } = context
 
     this.log.trace('fetching %c%s', terminalElement.cid, url.pathname)
-    let block = await toBuffer(blockstore.get(terminalElement.cid, options))
+    let block = await toBuffer(blockstore.get(terminalElement.cid, context))
     let contentType: ContentType
 
     try {

package/src/plugins/plugin-handle-ipns-record.ts

@@ -19,8 +19,8 @@ export class IpnsRecordPlugin extends BasePlugin {
     return accept.some(header => header.contentType.mediaType === MEDIA_TYPE_IPNS_RECORD)
   }
 
-  async handle (context: Pick<PluginContext, 'resource' | 'url' | 'options' | 'range' | 'redirected'>): Promise<Response> {
-    const { resource, url, options, range } = context
+  async handle (context: Pick<PluginContext, 'resource' | 'url' | 'range' | 'redirected' | 'signal' | 'onProgress'>): Promise<Response> {
+    const { resource, url, range } = context
     const { ipnsResolver } = this.pluginOptions
 
     if ((url.pathname !== '' && url.pathname !== '/') || url.protocol !== 'ipns:') {
@@ -43,7 +43,7 @@ export class IpnsRecordPlugin extends BasePlugin {
       return badRequestResponse(resource, err)
     }
 
-    const result = await ipnsResolver.resolve(peerId, options)
+    const result = await ipnsResolver.resolve(peerId, context)
     const block = marshalIPNSRecord(result.record)
 
     return okResponse(resource, block, {

package/src/plugins/plugin-handle-raw.ts

@@ -21,10 +21,10 @@ export class RawPlugin extends BasePlugin {
   }
 
   async handle (context: PluginContext): Promise<Response> {
-    const { url, resource, accept, ipfsRoots, terminalElement, blockstore, options } = context
+    const { url, resource, accept, ipfsRoots, terminalElement, blockstore } = context
 
     this.log.trace('fetching %c%s', terminalElement.cid, url.pathname)
-    const block = await toBuffer(blockstore.get(terminalElement.cid, options))
+    const block = await toBuffer(blockstore.get(terminalElement.cid, context))
 
     const headers = {
       'content-length': `${block.byteLength}`,

package/src/plugins/plugin-handle-tar.ts

@@ -22,7 +22,7 @@ export class TarPlugin extends BasePlugin {
   }
 
   async handle (context: PluginContext): Promise<Response> {
-    const { terminalElement, url, resource, options, blockstore, range } = context
+    const { terminalElement, url, resource, blockstore, range } = context
 
     if (terminalElement.cid.code !== dagPbCode && terminalElement.cid.code !== rawCode) {
       return badRequestResponse(resource, new NotUnixFSError('Only UnixFS data can be returned in a TAR file'))
@@ -32,7 +32,7 @@ export class TarPlugin extends BasePlugin {
       return badRequestResponse(resource, new Error('Range requests are not supported for TAR files'))
     }
 
-    const stream = toBrowserReadableStream<Uint8Array>(tarStream(`/ipfs/${terminalElement.cid}${url.pathname}`, blockstore, options))
+    const stream = toBrowserReadableStream<Uint8Array>(tarStream(`/ipfs/${terminalElement.cid}${url.pathname}`, blockstore, context))
 
     return okResponse(resource, stream, {
       redirected: context.redirected,

package/src/plugins/plugin-handle-unixfs.ts

@@ -62,10 +62,10 @@ export class UnixFSPlugin extends BasePlugin {
     let entry: UnixFSEntry
 
     try {
-      entry = await exporter(terminalElement.cid, blockstore, context.options)
+      entry = await exporter(terminalElement.cid, blockstore, context)
     } catch (err: any) {
       // throw abort error if signal was aborted
-      context?.options?.signal?.throwIfAborted()
+      context?.signal?.throwIfAborted()
 
       if (err.name === 'BlockNotFoundWhileOfflineError') {
         throw err
@@ -81,10 +81,10 @@ export class UnixFSPlugin extends BasePlugin {
       if (redirectUrl != null) {
         this.log.trace('directory url normalization spec requires redirect')
 
-        if (context.options?.redirect === 'error') {
+        if (context?.redirect === 'error') {
           this.log('could not redirect to %s as redirect option was set to "error"', redirectUrl)
           throw new TypeError('Failed to fetch')
-        } else if (context.options?.redirect === 'manual') {
+        } else if (context?.redirect === 'manual') {
           this.log('returning 301 permanent redirect to %s', redirectUrl)
           return movedPermanentlyResponse(context.resource, redirectUrl)
         }
@@ -99,19 +99,19 @@ export class UnixFSPlugin extends BasePlugin {
       const dirCid = terminalElement.cid
 
       // if not disabled, search the directory for an index.html file
-      if (context.options?.supportDirectoryIndexes !== false) {
+      if (context?.supportDirectoryIndexes !== false) {
         const rootFilePath = 'index.html'
 
         try {
           this.log.trace('found directory at %c%s, looking for index.html', dirCid, url.pathname)
 
-          const indexFile = await context.serverTiming.time('exporter-dir', '', last(walkPath(`/ipfs/${dirCid}/${rootFilePath}`, context.blockstore, context.options)))
+          const indexFile = await context.serverTiming.time('exporter-dir', '', last(walkPath(`/ipfs/${dirCid}/${rootFilePath}`, context.blockstore, context)))
 
           if (indexFile == null) {
             return badGatewayResponse(resource, 'Unable to stream content')
           }
 
-          const indexFileEntry = await context.serverTiming.time('exporter-dir', '', exporter(indexFile.cid, context.blockstore, context.options))
+          const indexFileEntry = await context.serverTiming.time('exporter-dir', '', exporter(indexFile.cid, context.blockstore, context))
 
           if (indexFileEntry.type !== 'file' && indexFileEntry.type !== 'raw' && indexFileEntry.type !== 'identity') {
             return badGatewayResponse(resource, 'Unable to stream content')
@@ -122,7 +122,7 @@ export class UnixFSPlugin extends BasePlugin {
 
           this.log.trace('found directory index at %c%s with cid %c', dirCid, rootFilePath, entry.cid)
 
-          return await this.streamFile(resource, indexFileEntry, filename, ipfsRoots, redirected, context.range, context.options)
+          return await this.streamFile(resource, indexFileEntry, filename, ipfsRoots, redirected, context.range, context)
         } catch (err: any) {
           if (err.name !== 'NotFoundError') {
             this.log.error('error loading path %c/%s - %e', dirCid, rootFilePath, err)
@@ -132,7 +132,7 @@ export class UnixFSPlugin extends BasePlugin {
       }
 
       // no index file found, return the directory listing
-      const block = await toBuffer(context.blockstore.get(dirCid, context.options))
+      const block = await toBuffer(context.blockstore.get(dirCid, context))
 
       return okResponse(resource, block, {
         headers: {
@@ -148,7 +148,7 @@ export class UnixFSPlugin extends BasePlugin {
       })
     } else if (entry.type === 'file' || entry.type === 'raw' || entry.type === 'identity') {
       this.log('streaming file')
-      return this.streamFile(resource, entry, filename, ipfsRoots, redirected, context.range, context.options)
+      return this.streamFile(resource, entry, filename, ipfsRoots, redirected, context.range, context)
     } else {
       this.log.error('cannot stream terminal element type %s', entry.type)
       return badGatewayResponse(resource, 'Unable to stream content')

package/src/url-resolver.ts

@@ -15,11 +15,12 @@ import type { AbortOptions, Logger } from '@libp2p/interface'
 import type { Helia, ProviderOptions, SessionBlockstore } from 'helia'
 import type { Blockstore } from 'interface-blockstore'
 import type { PathEntry, UnixFSEntry } from 'ipfs-unixfs-exporter'
+import type { ProgressOptions } from 'progress-events'
 
 // 1 year in seconds for ipfs content
 const IPFS_CONTENT_TTL = 29030400
 
-interface GetBlockstoreOptions extends AbortOptions, ProviderOptions {
+interface GetBlockstoreOptions extends AbortOptions, ProviderOptions, ProgressOptions {
   session?: boolean
 }
 
@@ -144,7 +145,7 @@ export class URLResolver implements URLResolverInterface {
     } else {
       // @ts-expect-error @helia/dnslink follows recursive DNSLink records so
       // result namespace should only be ipns or ipfs
-      throw new TypeError(`Invalid resource. Unexpected DNSLink namespace ${result.namespace} from domain: ${domain}`)
+      throw new TypeError(`Invalid resource. Unexpected DNSLink namespace ${result.namespace} from domain: ${url.hostname}`)
     }
 
     if (resolveResult instanceof Response) {

package/src/utils/server-timing.ts

@@ -1,8 +1,10 @@
 export class ServerTiming {
   private headers: string[]
+  private precision: number
 
   constructor () {
     this.headers = []
+    this.precision = 3
   }
 
   getHeader (): string {
@@ -16,9 +18,13 @@ export class ServerTiming {
       return await promise // Execute the function
     } finally {
       const endTime = performance.now()
-      const duration = (endTime - startTime).toFixed(1) // Duration in milliseconds
+      const duration = (endTime - startTime).toFixed(this.precision) // Duration in milliseconds
 
-      this.headers.push(`${name};dur=${duration};desc="${description}"`)
+      this.add(name, description, duration)
     }
   }
+
+  add (name: string, description: string, duration: number | string): void {
+    this.headers.push(`${name};dur=${Number(duration).toFixed(this.precision)};desc="${description}"`)
+  }
 }

package/src/verified-fetch.ts

@@ -183,10 +183,10 @@ export class VerifiedFetch {
         }
 
         return this.handleFinalResponse(await ipnsRecordPlugin.handle({
+          ...options,
           range,
           url,
           resource,
-          options,
           redirected: false
         }))
       }
@@ -212,12 +212,11 @@ export class VerifiedFetch {
       }
 
       const context: PluginContext = {
+        ...options,
         ...resolveResult,
         resource,
         accept,
         range,
-        options,
-        onProgress: options?.onProgress,
         serverTiming,
         headers,
         requestedMimeTypes
@@ -367,7 +366,7 @@ export class VerifiedFetch {
       }
     }
 
-    if (context?.options?.method === 'HEAD') {
+    if (context?.method === 'HEAD') {
       // don't send the body for HEAD requests
       return new Response(null, {
         status: 200,