refactor for multiformats

.github/workflows/main.yml

@@ -0,0 +1,25 @@
+on: [push, pull_request]
+name: Build, test and maybe publish
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Cache node_modules
+      id: cache-modules
+      uses: actions/cache@v1
+      with:
+        path: node_modules
+        key: ${{ runner.OS }}-build-${{ hashFiles('package.json') }}
+    - name: Build
+      if: steps.cache-modules.outputs.cache-hit != 'true'
+      run: npm install
+    - name: Test
+      run: npm test
+    - name: Publish
+      if: github.ref == 'refs/heads/master' && github.repository == 'ipld/js-dag-cbor'
+      uses: mikeal/merge-release@master
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

.gitignore

@@ -1,6 +1,7 @@
 docs
 package-lock.json
 yarn.lock
+.nyc_output
 # Logs
 logs
 *.log

index.js

@@ -0,0 +1,130 @@
+const cbor = require('borc')
+const isCircular = require('is-circular')
+
+// https://github.com/ipfs/go-ipfs/issues/3570#issuecomment-273931692
+const CID_CBOR_TAG = 42
+
+module.exports = multiformats => {
+  const { CID, bytes, varint } = multiformats
+  function tagCID (cid) {
+    const buffer = Uint8Array.from([...bytes.fromHex('00'), ...cid.buffer])
+    return new cbor.Tagged(CID_CBOR_TAG, buffer)
+  }
+
+  function replaceCIDbyTAG (dagNode) {
+    if (isCircular(dagNode)) {
+      throw new Error('The object passed has circular references')
+    }
+
+    function transform (obj) {
+      if (bytes.isBinary(obj)) return bytes.coerce(obj)
+      if (!obj || typeof obj === 'string') {
+        return obj
+      }
+
+      if (Array.isArray(obj)) {
+        return obj.map(transform)
+      }
+
+      if (CID.isCID(obj)) {
+        return tagCID(obj)
+      }
+
+      const keys = Object.keys(obj)
+
+      if (keys.length > 0) {
+        // Recursive transform
+        const out = {}
+        keys.forEach((key) => {
+          if (typeof obj[key] === 'object') {
+            out[key] = transform(obj[key])
+          } else {
+            out[key] = obj[key]
+          }
+        })
+        return out
+      } else {
+        return obj
+      }
+    }
+
+    return transform(dagNode)
+  }
+
+  const defaultTags = {
+    [CID_CBOR_TAG]: (val) => {
+      // remove that 0
+      val = Uint8Array.from(val.slice(1))
+      const [version] = varint.decode(val)
+      if (version > 1) {
+        // CIDv0
+        return new CID(0, 0x70, val)
+      }
+      return new CID(val)
+    }
+  }
+  const defaultSize = 64 * 1024 // current decoder heap size, 64 Kb
+  let currentSize = defaultSize
+  const defaultMaxSize = 64 * 1024 * 1024 // max heap size when auto-growing, 64 Mb
+  let maxSize = defaultMaxSize
+  let decoder = null
+
+  /**
+   * Configure the underlying CBOR decoder.
+   *
+   * @param {Object} [options] - The options the decoder takes. The decoder will reset to the defaul values if no options are given.
+   * @param {number} [options.size=65536] - The current heap size used in CBOR parsing, this may grow automatically as larger blocks are encountered up to `maxSize`
+   * @param {number} [options.maxSize=67108864] - The maximum size the CBOR parsing heap is allowed to grow to before `dagCBOR.util.deserialize()` returns an error
+   * @param {Object} [options.tags] - An object whose keys are CBOR tag numbers and values are transform functions that accept a `value` and return a decoded representation of that `value`
+   */
+  const configureDecoder = (options) => {
+    const tags = defaultTags
+
+    if (options) {
+      if (typeof options.size === 'number') {
+        currentSize = options.size
+      }
+      if (typeof options.maxSize === 'number') {
+        maxSize = options.maxSize
+      }
+    } else {
+      // no options, reset to defaults
+      currentSize = defaultSize
+      maxSize = defaultMaxSize
+    }
+
+    const decoderOptions = {
+      tags,
+      size: currentSize
+    }
+
+    decoder = new cbor.Decoder(decoderOptions)
+    // borc edits opts.size in-place so we can capture _actual_ size
+    currentSize = decoderOptions.size
+  }
+  configureDecoder()
+  module.exports.configureDecoder = configureDecoder // for testing
+
+  const encode = (node) => {
+    const nodeTagged = replaceCIDbyTAG(node)
+    const serialized = cbor.encode(nodeTagged)
+    return serialized
+  }
+
+  const decode = (data) => {
+    if (data.length > currentSize && data.length <= maxSize) {
+      configureDecoder({ size: data.length })
+    }
+
+    if (data.length > currentSize) {
+      throw new Error('Data is too large to deserialize with current decoder')
+    }
+
+    const deserialized = decoder.decodeFirst(data)
+    return deserialized
+  }
+
+  const code = 0x71
+  const name = 'dag-cbor'
+  return { encode, decode, code, name }
+}

package.json

@@ -26,8 +26,10 @@
     "is-circular": "^1.0.2"
   },
   "devDependencies": {
+    "garbage": "0.0.0",
     "hundreds": "0.0.2",
-    "mocha": "^7.1.2",
+    "mocha": "^7.2.0",
+    "multiformats": "0.0.11",
     "polendina": "^1.0.0",
     "standard": "^14.3.4"
   },