@helia/verified-fetch 8.0.3 → 8.1.0

package/src/verified-fetch.ts

@@ -3,8 +3,7 @@ import { ipnsResolver } from '@helia/ipns'
 import { isPeerId, isPublicKey } from '@libp2p/interface'
 import { CID } from 'multiformats/cid'
 import { CustomProgressEvent } from 'progress-events'
-import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
-import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
+import { MAX_HEADER_VALUE_LENGTH } from './constants.ts'
 import { CarPlugin } from './plugins/plugin-handle-car.ts'
 import { IpldPlugin } from './plugins/plugin-handle-ipld.ts'
 import { IpnsRecordPlugin } from './plugins/plugin-handle-ipns-record.ts'
@@ -19,10 +18,12 @@ import { errorToObject } from './utils/error-to-object.ts'
 import { errorToResponse } from './utils/error-to-response.ts'
 import { getETag, ifNoneMatches } from './utils/get-e-tag.ts'
 import { getRangeHeader } from './utils/get-range-header.ts'
+import { toIpfsUri } from './utils/ipfs-uri.ts'
 import { stringToIpfsUrl } from './utils/parse-resource.ts'
 import { setCacheControlHeader } from './utils/response-headers.ts'
 import { notAcceptableResponse, notImplementedResponse, notModifiedResponse } from './utils/responses.ts'
 import { ServerTiming } from './utils/server-timing.ts'
+import { toXIpfsPath } from './utils/x-ipfs-path.ts'
 import type { AcceptHeader, CIDDetail, ContentTypeParser, CreateVerifiedFetchOptions, Resource, ResourceDetail, VerifiedFetchInit as VerifiedFetchOptions, VerifiedFetchPlugin, PluginContext, PluginOptions } from './index.ts'
 import type { DNSLink } from '@helia/dnslink'
 import type { Helia } from '@helia/interface'
@@ -163,7 +164,15 @@ export class VerifiedFetch {
         })
       }
 
-      const url = this.parseResource(resource)
+      let url: URL
+
+      try {
+        url = this.parseResource(resource)
+      } catch (err: any) {
+        return this.handleFinalResponse(errorToResponse(resource, err, opts), withServerTiming, {
+          serverTiming
+        })
+      }
 
       if (url.protocol === 'ipfs:' && url.pathname === '') {
         // if we don't need to resolve an IPNS names or traverse a DAG, we can
@@ -429,15 +438,31 @@ export class VerifiedFetch {
     }
 
     if (context?.terminalElement?.cid != null && context?.url != null) {
-      // headers can ony contain extended ASCII but IPFS paths can be unicode
-      const decodedPath = context.url.pathname.split('/')
-        .map(component => decodeURIComponent(component))
-        .join('/')
-        .trim()
-
-      const path = uint8ArrayToString(uint8ArrayFromString(decodedPath, 'ascii'), 'ascii')
+      const ipfsUri = toIpfsUri(context.url)
+
+      // the value is ASCII-only so string length equals byte length; a value
+      // of exactly MAX_HEADER_VALUE_LENGTH bytes is still sent
+      if (ipfsUri != null && ipfsUri.length <= MAX_HEADER_VALUE_LENGTH) {
+        try {
+          response.headers.set('ipfs-uri', ipfsUri)
+        } catch (err) {
+          this.log.error('could not set ipfs-uri to "%s"', ipfsUri)
+        }
+      }
 
-      response.headers.set('x-ipfs-path', `/${context.url.protocol === 'ipfs:' ? 'ipfs' : 'ipns'}/${context?.url.hostname}${path === '/' ? '' : path}`)
+      // x-ipfs-path is deprecated by IPIP-0548 in favour of ipfs-uri, and is
+      // kept for clients that still read it. It is omitted for content paths
+      // that an HTTP field value cannot carry, e.g. a file name with
+      // non-ASCII bytes
+      const ipfsPath = toXIpfsPath(context.url)
+
+      if (ipfsPath != null && ipfsPath.length <= MAX_HEADER_VALUE_LENGTH) {
+        try {
+          response.headers.set('x-ipfs-path', ipfsPath)
+        } catch (err) {
+          this.log.error('could not set x-ipfs-path to "%s"', ipfsPath)
+        }
+      }
     }
 
     // set CORS headers. If hosting your own gateway with verified-fetch behind
@@ -449,7 +474,7 @@ export class VerifiedFetch {
     response.headers.set('access-control-allow-origin', '*')
     response.headers.set('access-control-allow-methods', 'GET, HEAD, OPTIONS')
     response.headers.set('access-control-allow-headers', 'Content-Type, Range, User-Agent, X-Requested-With')
-    response.headers.set('access-control-expose-headers', 'Content-Range, Content-Length, X-Ipfs-Path, X-Ipfs-Roots, X-Chunked-Output, X-Stream-Output')
+    response.headers.set('access-control-expose-headers', 'Content-Range, Content-Length, Ipfs-Uri, X-Ipfs-Path, X-Ipfs-Roots, X-Chunked-Output, X-Stream-Output')
 
     if (context?.terminalElement?.cid != null && response.headers.get('etag') == null) {
       const etag = getETag({

package/dist/src/utils/ipfs-path-to-string.d.ts

@@ -1,6 +0,0 @@
-/**
- * Joins an array of strings as an IPFS path and URI encodes individual
- * components
- */
-export declare function uriEncodeIPFSPath(str: string): string;
-//# sourceMappingURL=ipfs-path-to-string.d.ts.map

package/dist/src/utils/ipfs-path-to-string.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ipfs-path-to-string.d.ts","sourceRoot":"","sources":["../../../src/utils/ipfs-path-to-string.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,iBAAiB,CAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAItD"}

package/dist/src/utils/ipfs-path-to-string.js

@@ -1,10 +0,0 @@
-/**
- * Joins an array of strings as an IPFS path and URI encodes individual
- * components
- */
-export function uriEncodeIPFSPath(str) {
-    return str.split('/')
-        .map(p => encodeURIComponent(p))
-        .join('/');
-}
-//# sourceMappingURL=ipfs-path-to-string.js.map

package/dist/src/utils/ipfs-path-to-string.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ipfs-path-to-string.js","sourceRoot":"","sources":["../../../src/utils/ipfs-path-to-string.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAE,GAAW;IAC5C,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC;SAClB,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;SAC/B,IAAI,CAAC,GAAG,CAAC,CAAA;AACd,CAAC"}

package/src/utils/ipfs-path-to-string.ts

@@ -1,9 +0,0 @@
-/**
- * Joins an array of strings as an IPFS path and URI encodes individual
- * components
- */
-export function uriEncodeIPFSPath (str: string): string {
-  return str.split('/')
-    .map(p => encodeURIComponent(p))
-    .join('/')
-}