Merge remote-tracking branch 'origin/main' into feat/download-cars-fr…

…om-verified-fetch

packages/car/test/index.spec.ts

@@ -68,11 +68,7 @@ describe('import/export car file', () => {
     const otherBlockstore = new MemoryBlockstore()
     const otherUnixFS = unixfs({ blockstore: otherBlockstore })
     const otherCar = car({ blockstore: otherBlockstore, dagWalkers })
-    const cid = await otherUnixFS.addBytes(largeFile, {
-      chunker: fixedSize({
-        chunkSize: 1024
-      })
-    })
+    const cid = await otherUnixFS.addBytes(largeFile)
 
     const writer = memoryCarWriter(cid)
     await otherCar.export(cid, writer)

packages/verified-fetch/package.json

@@ -161,6 +161,7 @@
     "progress-events": "^1.0.0"
   },
   "devDependencies": {
+    "@helia/car": "^3.0.0",
     "@helia/dag-cbor": "^3.0.0",
     "@helia/dag-json": "^3.0.0",
     "@helia/json": "^3.0.0",

packages/verified-fetch/src/index.ts

@@ -324,7 +324,7 @@
  *
  * The `Accept` header can be passed to override certain response processing, or to ensure that the final `Content-Type` of the response is the one that is expected.
  *
- * If the final `Content-Type` does not match the `Accept` header, or if the content cannot be represented in the format dictated by the `Accept` header, or you have configured a custom content type parser, and that parser returns a value that isn't in the accept header, a [406: Not Acceptible](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/406) response will be returned:
+ * If the final `Content-Type` does not match the `Accept` header, or if the content cannot be represented in the format dictated by the `Accept` header, or you have configured a custom content type parser, and that parser returns a value that isn't in the accept header, a [406: Not Acceptable](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/406) response will be returned:
  *
  * ```typescript
  * import { verifiedFetch } from '@helia/verified-fetch'

packages/verified-fetch/src/utils/responses.ts

@@ -0,0 +1,22 @@
+export function okResponse (body?: BodyInit | null): Response {
+  return new Response(body, {
+    status: 200,
+    statusText: 'OK'
+  })
+}
+
+export function notSupportedResponse (body?: BodyInit | null): Response {
+  const response = new Response(body, {
+    status: 501,
+    statusText: 'Not Implemented'
+  })
+  response.headers.set('X-Content-Type-Options', 'nosniff') // see https://specs.ipfs.tech/http-gateways/path-gateway/#x-content-type-options-response-header
+  return response
+}
+
+export function notAcceptableResponse (body?: BodyInit | null): Response {
+  return new Response(body, {
+    status: 406,
+    statusText: 'Not Acceptable'
+  })
+}

packages/verified-fetch/src/utils/select-output-type.ts

@@ -6,6 +6,9 @@ import { code as rawCode } from 'multiformats/codecs/raw'
 import type { RequestFormatShorthand } from '../types.js'
 import type { CID } from 'multiformats/cid'
 
+/**
+ * This maps supported response types for each codec supported by verified-fetch
+ */
 const CID_TYPE_MAP: Record<number, string[]> = {
   [dagCborCode]: [
     'application/json',

packages/verified-fetch/src/verified-fetch.ts

@@ -15,6 +15,7 @@ import { getContentDispositionFilename } from './utils/get-content-disposition-f
 import { getETag } from './utils/get-e-tag.js'
 import { getStreamFromAsyncIterable } from './utils/get-stream-from-async-iterable.js'
 import { parseResource } from './utils/parse-resource.js'
+import { notAcceptableResponse, notSupportedResponse, okResponse } from './utils/responses.js'
 import { selectOutputType, queryFormatToAcceptHeader } from './utils/select-output-type.js'
 import { walkPath } from './utils/walk-path.js'
 import type { CIDDetail, ContentTypeParser, Resource, VerifiedFetchInit as VerifiedFetchOptions } from './index.js'
@@ -68,29 +69,6 @@ function convertOptions (options?: VerifiedFetchOptions): (Omit<VerifiedFetchOpt
   }
 }
 
-function okResponse (body?: BodyInit | null): Response {
-  return new Response(body, {
-    status: 200,
-    statusText: 'OK'
-  })
-}
-
-function notSupportedResponse (body?: BodyInit | null): Response {
-  const response = new Response(body, {
-    status: 501,
-    statusText: 'Not Implemented'
-  })
-  response.headers.set('X-Content-Type-Options', 'nosniff') // see https://specs.ipfs.tech/http-gateways/path-gateway/#x-content-type-options-response-header
-  return response
-}
-
-function notAcceptableResponse (body?: BodyInit | null): Response {
-  return new Response(body, {
-    status: 406,
-    statusText: '406 Not Acceptable'
-  })
-}
-
 /**
  * These are Accept header values that will cause content type sniffing to be
  * skipped and set to these values.
@@ -103,8 +81,8 @@ const RAW_HEADERS = [
 /**
  * if the user has specified an `Accept` header, and it's in our list of
  * allowable "raw" format headers, use that instead of detecting the content
- * type, to avoid the user signalling that they will Accepting one mime type
- * and then receiving something different.
+ * type. This avoids the user from receiving something different when they
+ * signal that they want to `Accept` a specific mime type.
  */
 function getOverridenRawContentType (headers?: HeadersInit): string | undefined {
   const acceptHeader = new Headers(headers).get('accept') ?? ''
@@ -262,7 +240,6 @@ export class VerifiedFetch {
       terminalElement = pathDetails.terminalElement
     } catch (err) {
       this.log.error('Error walking path %s', path, err)
-      // return new Response(`Error walking path: ${(err as Error).message}`, { status: 500 })
     }
 
     let resolvedCID = terminalElement?.cid ?? cid

packages/verified-fetch/test/accept-header.spec.ts

@@ -138,7 +138,7 @@ describe('accept header', () => {
     expect(output).to.deep.equal(obj)
   })
 
-  it('should return 406 Not Acceptable if the accept header cannot be honoured', async () => {
+  it('should return 406 Not Acceptable if the accept header cannot be adhered to', async () => {
     const obj = {
       hello: 'world'
     }
@@ -151,7 +151,7 @@ describe('accept header', () => {
       }
     })
     expect(resp.status).to.equal(406)
-    expect(resp.statusText).to.equal('406 Not Acceptable')
+    expect(resp.statusText).to.equal('Not Acceptable')
   })
 
   it('should support wildcards', async () => {