fix: replace node buffers with uint8arrays (#134)

BREAKING CHANGE:

- `util.serialize` now returns a Uint8Array

Author: achingbrain

README.md

@@ -1,4 +1,4 @@
-# js-ipld-dag-cbor
+# js-ipld-dag-cbor <!-- omit in toc -->
 
 [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
 [![](https://img.shields.io/badge/project-IPLD-blue.svg?style=flat-square)](http://github.com/ipld/ipld)
@@ -14,11 +14,11 @@
 
 > JavaScript implementation of the [IPLD spec](https://github.com/ipfs/specs/tree/master/ipld).
 
-## Lead Maintainer
+## Lead Maintainer <!-- omit in toc -->
 
 [Volker Mische](https://github.com/vmx)
 
-## Table of Contents
+## Table of Contents <!-- omit in toc -->
 
 - [Install](#install)
   - [npm](#npm)
@@ -27,6 +27,10 @@
   - [Use in a browser Using a script tag](#use-in-a-browser-using-a-script-tag)
 - [Usage](#usage)
 - [API](#api)
+  - [`dagCBOR.util.serialize(obj)`](#dagcborutilserializeobj)
+  - [`dagCBOR.util.deserialize(serialized)`](#dagcborutildeserializeserialized)
+  - [`dagCBOR.util.configureDecoder([options])`](#dagcborutilconfiguredecoderoptions)
+  - [`dagCBOR.util.cid(obj[, options,])`](#dagcborutilcidobj-options)
 - [Contribute](#contribute)
 - [License](#license)
 
@@ -73,13 +77,13 @@ const file = {
 }
 
 const serialized = dagCBOR.util.serialize(file)
-console.log(`Encoded as a ${serialized.length} byte Buffer`)
+console.log(`Encoded as a ${serialized.length} byte Uint8Array`)
 
 const node = dagCBOR.util.deserialize(serialized)
 console.log('Decoded as:', node)
 require('assert').deepEqual(node, file) // should match
 
-// → Encoded as a 22 byte Buffer
+// → Encoded as a 22 byte Uint8Array
 // → Decoded as: { name: 'hello.txt', size: 11 }
 ```
 
@@ -97,7 +101,7 @@ Returns the serialized node.
 
  Decodes an IPLD CBOR encoded representation, restoring any CBOR tags (id `42`) to CIDs.
 
-  - `serialized` (`Buffer` or `String`): a binary blob representing an IPLD CBOR encoded object.
+  - `serialized` (`Uint8Array` or `String`): a binary blob representing an IPLD CBOR encoded object.
 
 Returns the deserialized object.
 

package.json

@@ -38,19 +38,17 @@
   "homepage": "https://github.com/ipld/js-ipld-dag-cbor",
   "dependencies": {
     "borc": "^2.1.2",
-    "buffer": "^5.6.0",
-    "cids": "~0.8.3",
+    "cids": "^1.0.0",
     "is-circular": "^1.0.2",
-    "multicodec": "^1.0.3",
-    "multihashing-async": "^1.0.0"
+    "multicodec": "^2.0.0",
+    "multihashing-async": "^2.0.0",
+    "uint8arrays": "^1.0.0"
   },
   "devDependencies": {
     "aegir": "^25.0.0",
-    "chai": "^4.2.0",
     "detect-node": "^2.0.4",
-    "dirty-chai": "^2.0.1",
     "garbage": "0.0.0",
-    "multihashes": "^1.0.1"
+    "multihashes": "^3.0.1"
   },
   "contributors": [
     "David Dias <[email protected]>",

src/resolver.js

@@ -1,7 +1,6 @@
 'use strict'
 
 const CID = require('cids')
-const { Buffer } = require('buffer')
 const util = require('./util')
 
 /**
@@ -10,7 +9,7 @@ const util = require('./util')
  * Returns the value or a link and the partial mising path. This way the
  * IPLD Resolver can fetch the link and continue to resolve.
  *
- * @param {Buffer} binaryBlob - Binary representation of a CBOR block
+ * @param {Uint8Array} binaryBlob - Binary representation of a CBOR block
  * @param {string} [path='/'] - Path that should be resolved
  * @returns {Object} result - Result of the path it it was resolved successfully
  * @returns {*} result.value - Value the path resolves to
@@ -45,7 +44,7 @@ exports.resolve = (binaryBlob, path) => {
 
 const traverse = function * (node, path) {
   // Traverse only objects and arrays
-  if (Buffer.isBuffer(node) || CID.isCID(node) || typeof node === 'string' ||
+  if (node instanceof Uint8Array || CID.isCID(node) || typeof node === 'string' ||
       node === null) {
     return
   }
@@ -60,7 +59,7 @@ const traverse = function * (node, path) {
  * Return all available paths of a block.
  *
  * @generator
- * @param {Buffer} binaryBlob - Binary representation of a CBOR block
+ * @param {Uint8Array} binaryBlob - Binary representation of a CBOR block
  * @yields {string} - A single path
  */
 exports.tree = function * (binaryBlob) {

src/util.js

@@ -1,26 +1,27 @@
 'use strict'
 
 const cbor = require('borc')
-const { Buffer } = require('buffer')
 const multicodec = require('multicodec')
 const multihashing = require('multihashing-async')
 const CID = require('cids')
 const isCircular = require('is-circular')
+const uint8ArrayConcat = require('uint8arrays/concat')
+const uint8ArrayFromString = require('uint8arrays/from-string')
 
 // https://github.com/ipfs/go-ipfs/issues/3570#issuecomment-273931692
 const CID_CBOR_TAG = 42
 
 function tagCID (cid) {
   if (typeof cid === 'string') {
-    cid = new CID(cid).buffer
+    cid = new CID(cid).bytes
   } else if (CID.isCID(cid)) {
-    cid = cid.buffer
+    cid = cid.bytes
   }
 
-  return new cbor.Tagged(CID_CBOR_TAG, Buffer.concat([
-    Buffer.from('00', 'hex'), // thanks jdag
+  return new cbor.Tagged(CID_CBOR_TAG, uint8ArrayConcat([
+    uint8ArrayFromString('00', 'base16'), // thanks jdag
     cid
-  ]))
+  ], 1 + cid.length))
 }
 
 function replaceCIDbyTAG (dagNode) {
@@ -129,7 +130,7 @@ exports.configureDecoder() // Setup default cbor.Decoder
  * Serialize internal representation into a binary CBOR block.
  *
  * @param {Object} node - Internal representation of a CBOR block
- * @returns {Buffer} - The encoded binary representation
+ * @returns {Uint8Array} - The encoded binary representation
  */
 exports.serialize = (node) => {
   const nodeTagged = replaceCIDbyTAG(node)
@@ -141,7 +142,7 @@ exports.serialize = (node) => {
 /**
  * Deserialize CBOR block into the internal representation.
  *
- * @param {Buffer} data - Binary representation of a CBOR block
+ * @param {Uint8Array} data - Binary representation of a CBOR block
  * @returns {Object} - An object that conforms to the IPLD Data Model
  */
 exports.deserialize = (data) => {

test/interop.spec.js

@@ -1,10 +1,7 @@
 /* eslint-env mocha */
 'use strict'
 
-const chai = require('chai')
-const dirtyChai = require('dirty-chai')
-const expect = chai.expect
-chai.use(dirtyChai)
+const { expect } = require('aegir/utils/chai')
 const dagCBOR = require('../src')
 const loadFixture = require('aegir/fixtures')
 const isNode = require('detect-node')

test/mod.spec.js

@@ -1,12 +1,8 @@
 /* eslint-env mocha */
 'use strict'
 
-const chai = require('chai')
-const dirtyChai = require('dirty-chai')
-const expect = chai.expect
-chai.use(dirtyChai)
+const { expect } = require('aegir/utils/chai')
 const multicodec = require('multicodec')
-
 const mod = require('../src')
 
 describe('IPLD Format', () => {

test/resolver.spec.js

@@ -2,13 +2,8 @@
 /* eslint max-nested-callbacks: ["error", 5] */
 'use strict'
 
-const chai = require('chai')
-const dirtyChai = require('dirty-chai')
-const expect = chai.expect
-chai.use(dirtyChai)
-
+const { expect } = require('aegir/utils/chai')
 const CID = require('cids')
-
 const dagCBOR = require('../src')
 const resolver = dagCBOR.resolver
 

test/util.spec.js

@@ -1,15 +1,13 @@
 /* eslint-env mocha */
 'use strict'
 
-const { Buffer } = require('buffer')
-const chai = require('chai')
-const dirtyChai = require('dirty-chai')
-const expect = chai.expect
-chai.use(dirtyChai)
+const { expect } = require('aegir/utils/chai')
 const garbage = require('garbage')
 const dagCBOR = require('../src')
 const multihash = require('multihashes')
 const CID = require('cids')
+const uint8ArrayFromString = require('uint8arrays/from-string')
+const uint8ArrayConcat = require('uint8arrays/concat')
 
 describe('util', () => {
   const obj = {
@@ -27,7 +25,7 @@ describe('util', () => {
   const serializedObj = dagCBOR.util.serialize(obj)
 
   it('.serialize and .deserialize', () => {
-    expect(Buffer.isBuffer(serializedObj)).to.equal(true)
+    expect(serializedObj).to.be.a('Uint8Array')
 
     // Check for the tag 42
     // d8 = tag, 2a = 42
@@ -45,7 +43,7 @@ describe('util', () => {
     const largeObj = { someKey: [].slice.call(new Uint8Array(dataSize)) }
 
     const serialized = dagCBOR.util.serialize(largeObj)
-    expect(Buffer.isBuffer(serialized)).to.be.true()
+    expect(serialized).to.be.a('Uint8Array')
 
     const deserialized = dagCBOR.util.deserialize(serialized)
     expect(largeObj).to.eql(deserialized)
@@ -60,7 +58,7 @@ describe('util', () => {
 
     dagCBOR.util.configureDecoder({ size: 64 * 1024, maxSize: 128 * 1024 }) // 64 Kb start, 128 Kb max
     const serialized = dagCBOR.util.serialize(largeObj)
-    expect(Buffer.isBuffer(serialized)).to.be.true()
+    expect(serialized).to.be.a('Uint8Array')
 
     expect(() => dagCBOR.util.deserialize(serialized)).to.throw(
       'Data is too large to deserialize with current decoder')
@@ -111,7 +109,7 @@ describe('util', () => {
   })
 
   it('.serialize and .deserialize object with Uint8Array field', () => {
-    const buffer = Buffer.from('some data')
+    const buffer = uint8ArrayFromString('some data')
     const bytes = Uint8Array.from(buffer)
 
     const s1 = dagCBOR.util.serialize({ data: buffer })
@@ -127,7 +125,7 @@ describe('util', () => {
     expect(() =>
       // two top-level CBOR objects, the original and a single uint=0, valid if using
       // CBOR in streaming mode, not valid here
-      dagCBOR.util.deserialize(Buffer.concat([serializedObj, Buffer.alloc(1)]))
+      dagCBOR.util.deserialize(uint8ArrayConcat([serializedObj, new Uint8Array(1)]))
     ).to.throw(Error, 'Extraneous CBOR data found beyond initial top-level object')
   })
 })