@helia/verified-fetch 4.0.2 → 4.0.4

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

@@ -2,6 +2,7 @@ import * as ipldDagCbor from '@ipld/dag-cbor'
 import * as ipldDagJson from '@ipld/dag-json'
 import toBuffer from 'it-to-buffer'
 import { code as jsonCode } from 'multiformats/codecs/json'
+import { CODEC_CBOR } from '../constants.ts'
 import { notAcceptableResponse, okRangeResponse } from '../utils/responses.js'
 import { BasePlugin } from './plugin-base.js'
 import type { PluginContext } from './types.js'
@@ -18,8 +19,9 @@ export class JsonPlugin extends BasePlugin {
       return false
     }
 
-    if (accept?.mimeType === 'application/vnd.ipld.dag-json' && cid.code !== ipldDagCbor.code) {
-      // we can handle application/vnd.ipld.dag-json, but if the CID codec is ipldDagCbor, DagCborPlugin should handle it
+    if (accept?.mimeType === 'application/vnd.ipld.dag-json' && cid.code !== ipldDagCbor.code && cid.code !== CODEC_CBOR) {
+      // we can handle application/vnd.ipld.dag-json, but if the CID codec is
+      // cbor related, cbor related plugins will handle it
       // TODO: remove the need for deny-listing cases in plugins
       return true
     }
@@ -47,7 +49,7 @@ export class JsonPlugin extends BasePlugin {
         const obj = ipldDagJson.decode(block)
         body = ipldDagCbor.encode(obj)
       } catch (err) {
-        this.log.error('could not transform %c to application/vnd.ipld.dag-cbor', err)
+        this.log.error('could not transform %c to application/vnd.ipld.dag-cbor - %e', err)
         return notAcceptableResponse(resource)
       }
     } else {

package/src/utils/byte-range-context.ts

@@ -588,7 +588,7 @@ export class ByteRangeContext {
 
           controller.close()
         } catch (err) {
-          log.error('Error processing range(s): %o', err)
+          log.error('Error processing range(s) - %e', err)
           controller.error(err)
         }
       }

package/src/utils/dag-cbor-to-safe-json.ts

@@ -1,5 +1,27 @@
-import { decode } from 'cborg'
-import { encode } from 'cborg/json'
+import { decode, encode } from 'cborg'
+import { encode as jsonEncode } from 'cborg/json'
+import { CID } from 'multiformats/cid'
+import type { DecodeOptions } from 'cborg'
+
+// https://github.com/ipfs/go-ipfs/issues/3570#issuecomment-273931692
+const CID_CBOR_TAG = 42
+
+const options: DecodeOptions = {
+  allowIndefinite: false,
+  coerceUndefinedToNull: false,
+  allowNaN: false,
+  allowInfinity: false,
+  strict: true,
+  useMaps: false,
+  rejectDuplicateMapKeys: true,
+  tags: [],
+
+  // this is different to `DAG-CBOR` - the reason we disallow BigInts is
+  // because we are about to re-encode to `JSON` which does not support
+  // BigInts. Blocks containing large numbers should be deserialized using a
+  // cbor decoder instead
+  allowBigInt: false.valueOf
+}
 
 /**
  * Take a `DAG-CBOR` encoded `Uint8Array`, deserialize it as an object and
@@ -7,21 +29,35 @@ import { encode } from 'cborg/json'
  * `JSON.parse` without losing any data.
  */
 export function dagCborToSafeJSON (buf: Uint8Array): string {
-  const obj = decode(buf, {
-    allowIndefinite: false,
-    coerceUndefinedToNull: false,
-    allowNaN: false,
-    allowInfinity: false,
-    strict: true,
-    useMaps: false,
-    rejectDuplicateMapKeys: true,
-
-    // this is different to `DAG-CBOR` - the reason we disallow BigInts is
-    // because we are about to re-encode to `JSON` which does not support
-    // BigInts. Blocks containing large numbers should be deserialized using a
-    // cbor decoder instead
-    allowBigInt: false
-  })
-
-  return new TextDecoder().decode(encode(obj))
+  const opts: DecodeOptions = {
+    ...options,
+    tags: []
+  }
+  opts.tags[CID_CBOR_TAG] = (bytes: Uint8Array): any => {
+    if (bytes[0] !== 0) {
+      throw new Error('Invalid CID for CBOR tag 42; expected leading 0x00')
+    }
+
+    return {
+      '/': CID.decode(bytes.subarray(1)).toString() // ignore leading 0x00
+    }
+  }
+
+  const obj = decode(buf, opts)
+
+  return new TextDecoder().decode(jsonEncode(obj))
+}
+
+/**
+ * Decode CBOR to object without CID tag support
+ */
+export function cborToObject (buf: Uint8Array): any {
+  return decode(buf, options)
+}
+
+/**
+ * Decode CBOR to object without CID tag support
+ */
+export function objectToCbor (obj: any): Uint8Array {
+  return encode(obj, options)
 }

package/src/utils/get-content-type.ts

@@ -41,9 +41,9 @@ export async function getContentType ({ bytes, path, contentTypeParser, log, def
       } else if (parsed != null) {
         contentType = parsed
       }
-      log.trace('contentTypeParser returned %s', contentType)
+      log.trace('contentTypeParser returned %s for file with name %s', contentType, fileName)
     } catch (err) {
-      log.error('error parsing content type', err)
+      log.error('error parsing content type - %e', err)
     }
   }
 

package/src/utils/select-output-type.ts

@@ -3,6 +3,7 @@ import { code as dagJsonCode } from '@ipld/dag-json'
 import { code as dagPbCode } from '@ipld/dag-pb'
 import { code as jsonCode } from 'multiformats/codecs/json'
 import { code as rawCode } from 'multiformats/codecs/raw'
+import { CODEC_CBOR } from '../constants.ts'
 import type { RequestFormatShorthand } from '../index.js'
 import type { CID } from 'multiformats/cid'
 
@@ -59,6 +60,17 @@ const CID_TYPE_MAP: Record<number, string[]> = {
     'application/vnd.ipld.dag-json',
     'application/vnd.ipld.car',
     'application/x-tar'
+  ],
+  [CODEC_CBOR]: [
+    'application/json',
+    'application/vnd.ipld.dag-cbor',
+    'application/cbor',
+    'application/vnd.ipld.dag-json',
+    'application/octet-stream',
+    'application/vnd.ipld.raw',
+    'application/vnd.ipfs.ipns-record',
+    'application/vnd.ipld.car',
+    'text/html'
   ]
 }
 
@@ -71,7 +83,7 @@ export interface AcceptHeader {
  * Selects an output mime-type based on the CID and a passed `Accept` header
  */
 export function selectOutputType (cid: CID, accept?: string): AcceptHeader | undefined {
-  const cidMimeTypes = CID_TYPE_MAP[cid.code]
+  const cidMimeTypes = CID_TYPE_MAP[cid.code] ?? []
 
   if (accept != null) {
     return chooseMimeType(accept, cidMimeTypes)

package/src/verified-fetch.ts

@@ -5,6 +5,7 @@ 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 { CborPlugin } from './plugins/plugin-handle-cbor.js'
 import { DagCborPlugin } from './plugins/plugin-handle-dag-cbor.js'
 import { DagPbPlugin } from './plugins/plugin-handle-dag-pb.js'
 import { DagWalkPlugin } from './plugins/plugin-handle-dag-walk.js'
@@ -99,7 +100,8 @@ export class VerifiedFetch {
       new TarPlugin(pluginOptions),
       new JsonPlugin(pluginOptions),
       new DagCborPlugin(pluginOptions),
-      new DagPbPlugin(pluginOptions)
+      new DagPbPlugin(pluginOptions),
+      new CborPlugin(pluginOptions)
     ]
 
     const customPlugins = init.plugins?.map((pluginFactory) => pluginFactory(pluginOptions)) ?? []
@@ -245,7 +247,7 @@ export class VerifiedFetch {
       this.log(`starting pipeline pass #${passCount + 1}`)
       passCount++
 
-      this.log.trace('checking which plugins can handle %c%s with accept %o', context.cid, context.path != null ? `/${context.path}` : '', context.accept)
+      this.log.trace('checking which plugins can handle %c%s with accept %o', context.cid, context.path.length > 0 ? `/${context.path.join('/')}` : '', context.accept)
 
       // gather plugins that say they can handle the *current* context, but haven't been used yet
       const readyPlugins = this.plugins.filter(p => !pluginsUsed.has(p.id)).filter(p => p.canHandle(context))