fix: remove node buffers (#27)

Updates to the latest interface-datastore that swaps out Buffers for
Uint8Arrays.

BREAKING CHANGE: no longer uses node Buffers, only Uint8Arrays

Author: achingbrain

package.json

@@ -38,15 +38,15 @@
   },
   "homepage": "https://github.com/ipfs/js-datastore-core#readme",
   "devDependencies": {
-    "aegir": "^22.0.0",
+    "aegir": "^25.0.0",
     "async-iterator-all": "^1.0.0",
     "chai": "^4.2.0",
     "dirty-chai": "^2.0.1"
   },
   "dependencies": {
-    "buffer": "^5.5.0",
     "debug": "^4.1.1",
-    "interface-datastore": "^1.0.2"
+    "interface-datastore": "^2.0.0",
+    "ipfs-utils": "^2.3.1"
   },
   "engines": {
     "node": ">=6.0.0",

src/shard.js

@@ -2,6 +2,7 @@
 'use strict'
 
 const Key = require('interface-datastore').Key
+const { utf8Decoder } = require('../src/utils')
 
 const readme = require('./shard-readme')
 
@@ -125,7 +126,7 @@ exports.readShardFun = async (path /* : string */, store) /* : Promise<ShardV1>
   const key = new Key(path).child(new Key(SHARDING_FN))
   const get = typeof store.getRaw === 'function' ? store.getRaw.bind(store) : store.get.bind(store)
   const res = await get(key)
-  return parseShardFun((res || '').toString().trim())
+  return parseShardFun(utf8Decoder.decode(res || '').trim())
 }
 
 exports.readme = readme

src/sharding.js

@@ -1,9 +1,9 @@
 'use strict'
 
-const { Buffer } = require('buffer')
 const { Adapter, Key } = require('interface-datastore')
 const sh = require('./shard')
 const KeytransformStore = require('./keytransform')
+const { utf8Encoder } = require('../src/utils')
 
 const shardKey = new Key(sh.SHARDING_FN)
 const shardReadmeKey = new Key(sh.README_FN)
@@ -65,8 +65,8 @@ class ShardingDatastore extends Adapter {
     const exists = await store.has(shardKey)
     if (!exists) {
       const put = typeof store.putRaw === 'function' ? store.putRaw.bind(store) : store.put.bind(store)
-      return Promise.all([put(shardKey, Buffer.from(shard.toString() + '\n')),
-        put(shardReadmeKey, Buffer.from(sh.readme))])
+      return Promise.all([put(shardKey, utf8Encoder.encode(shard.toString() + '\n')),
+        put(shardReadmeKey, utf8Encoder.encode(sh.readme))])
     }
 
     const diskShard = await sh.readShardFun('/', store)

src/utils.js

@@ -0,0 +1,7 @@
+'use strict'
+
+const TextEncoder = require('ipfs-utils/src/text-encoder')
+const TextDecoder = require('ipfs-utils/src/text-decoder')
+
+module.exports.utf8Encoder = new TextEncoder('utf8')
+module.exports.utf8Decoder = new TextDecoder('utf8')

test/keytransform.spec.js

@@ -1,7 +1,6 @@
 /* eslint-env mocha */
 'use strict'
 
-const { Buffer } = require('buffer')
 const chai = require('chai')
 chai.use(require('dirty-chai'))
 const expect = chai.expect
@@ -37,7 +36,7 @@ describe('KeyTransformDatastore', () => {
       'foo/bar/bazb',
       'foo/bar/baz/barb'
     ].map((s) => new Key(s))
-    await Promise.all(keys.map((key) => kStore.put(key, Buffer.from(key.toString()))))
+    await Promise.all(keys.map((key) => kStore.put(key, key.uint8Array())))
     const kResults = Promise.all(keys.map((key) => kStore.get(key)))
     const mResults = Promise.all(keys.map((key) => mStore.get(new Key('abc').child(key))))
     const results = await Promise.all([kResults, mResults])

test/mount.spec.js

@@ -2,12 +2,12 @@
 /* eslint max-nested-callbacks: ["error", 8] */
 'use strict'
 
-const { Buffer } = require('buffer')
 const chai = require('chai')
 chai.use(require('dirty-chai'))
 const assert = chai.assert
 const expect = chai.expect
 const all = require('async-iterator-all')
+const { utf8Encoder } = require('../src/utils')
 
 const Key = require('interface-datastore').Key
 const MemoryStore = require('interface-datastore').MemoryDatastore
@@ -18,7 +18,7 @@ describe('MountStore', () => {
   it('put - no mount', async () => {
     const m = new MountStore([])
     try {
-      await m.put(new Key('hello'), Buffer.from('foo'))
+      await m.put(new Key('hello'), utf8Encoder.encode('foo'))
       assert(false, 'Failed to throw error on no mount')
     } catch (err) {
       expect(err).to.be.an('Error')
@@ -31,7 +31,7 @@ describe('MountStore', () => {
       prefix: new Key('cool')
     }])
     try {
-      await m.put(new Key('/fail/hello'), Buffer.from('foo'))
+      await m.put(new Key('/fail/hello'), utf8Encoder.encode('foo'))
       assert(false, 'Failed to throw error on wrong mount')
     } catch (err) {
       expect(err).to.be.an('Error')
@@ -45,7 +45,7 @@ describe('MountStore', () => {
       prefix: new Key('cool')
     }])
 
-    const val = Buffer.from('hello')
+    const val = utf8Encoder.encode('hello')
     await m.put(new Key('/cool/hello'), val)
     const res = await mds.get(new Key('/hello'))
     expect(res).to.eql(val)
@@ -58,7 +58,7 @@ describe('MountStore', () => {
       prefix: new Key('cool')
     }])
 
-    const val = Buffer.from('hello')
+    const val = utf8Encoder.encode('hello')
     await mds.put(new Key('/hello'), val)
     const res = await m.get(new Key('/cool/hello'))
     expect(res).to.eql(val)
@@ -71,7 +71,7 @@ describe('MountStore', () => {
       prefix: new Key('cool')
     }])
 
-    const val = Buffer.from('hello')
+    const val = utf8Encoder.encode('hello')
     await mds.put(new Key('/hello'), val)
     const exists = await m.has(new Key('/cool/hello'))
     expect(exists).to.eql(true)
@@ -84,7 +84,7 @@ describe('MountStore', () => {
       prefix: new Key('cool')
     }])
 
-    const val = Buffer.from('hello')
+    const val = utf8Encoder.encode('hello')
     await m.put(new Key('/cool/hello'), val)
     await m.delete(new Key('/cool/hello'))
     let exists = await m.has(new Key('/cool/hello'))
@@ -100,7 +100,7 @@ describe('MountStore', () => {
       prefix: new Key('cool')
     }])
 
-    const val = Buffer.from('hello')
+    const val = utf8Encoder.encode('hello')
     await m.put(new Key('/cool/hello'), val)
     const res = await all(m.query({ prefix: '/cool' }))
     expect(res).to.eql([{ key: new Key('/cool/hello'), value: val }])

test/namespace.spec.js

@@ -1,7 +1,6 @@
 /* eslint-env mocha */
 'use strict'
 
-const { Buffer } = require('buffer')
 const chai = require('chai')
 chai.use(require('dirty-chai'))
 const expect = chai.expect
@@ -11,6 +10,7 @@ const MemoryStore = require('interface-datastore').MemoryDatastore
 
 const NamespaceStore = require('../src/').NamespaceDatastore
 const all = require('async-iterator-all')
+const { utf8Encoder } = require('../src/utils')
 
 describe('KeyTransformDatastore', () => {
   const prefixes = [
@@ -30,7 +30,7 @@ describe('KeyTransformDatastore', () => {
       'foo/bar/baz/barb'
     ].map((s) => new Key(s))
 
-    await Promise.all(keys.map(key => store.put(key, Buffer.from(key.toString()))))
+    await Promise.all(keys.map(key => store.put(key, utf8Encoder.encode(key.toString()))))
     const nResults = Promise.all(keys.map((key) => store.get(key)))
     const mResults = Promise.all(keys.map((key) => mStore.get(new Key(prefix).child(key))))
     const results = await Promise.all([nResults, mResults])

test/sharding.spec.js

@@ -1,7 +1,6 @@
 /* eslint-env mocha */
 'use strict'
 
-const { Buffer } = require('buffer')
 const chai = require('chai')
 chai.use(require('dirty-chai'))
 const expect = chai.expect
@@ -12,15 +11,16 @@ const MemoryStore = require('interface-datastore').MemoryDatastore
 
 const ShardingStore = require('../src').ShardingDatastore
 const sh = require('../src').shard
+const { utf8Encoder, utf8Decoder } = require('../src/utils')
 
 describe('ShardingStore', () => {
   it('create', async () => {
     const ms = new MemoryStore()
     const shard = new sh.NextToLast(2)
     await ShardingStore.create(ms, shard)
     const res = await Promise.all([ms.get(new Key(sh.SHARDING_FN)), ms.get(new Key(sh.README_FN))])
-    expect(res[0].toString()).to.eql(shard.toString() + '\n')
-    expect(res[1].toString()).to.eql(sh.readme)
+    expect(utf8Decoder.decode(res[0])).to.eql(shard.toString() + '\n')
+    expect(utf8Decoder.decode(res[1])).to.eql(sh.readme)
   })
 
   it('open - empty', async () => {
@@ -47,9 +47,9 @@ describe('ShardingStore', () => {
     const store = await ShardingStore.createOrOpen(ms, shard)
     expect(store).to.exist()
     await ShardingStore.createOrOpen(ms, shard)
-    await store.put(new Key('hello'), Buffer.from('test'))
+    await store.put(new Key('hello'), utf8Encoder.encode('test'))
     const res = await ms.get(new Key('ll').child(new Key('hello')))
-    expect(res).to.eql(Buffer.from('test'))
+    expect(res).to.eql(utf8Encoder.encode('test'))
   })
 
   describe('interface-datastore', () => {

test/tiered.spec.js

@@ -1,7 +1,6 @@
 /* eslint-env mocha */
 'use strict'
 
-const { Buffer } = require('buffer')
 const chai = require('chai')
 chai.use(require('dirty-chai'))
 const expect = chai.expect
@@ -10,6 +9,7 @@ const Key = require('interface-datastore').Key
 const MemoryStore = require('interface-datastore').MemoryDatastore
 
 const TieredStore = require('../src').TieredDatastore
+const { utf8Encoder } = require('../src/utils')
 
 describe('Tiered', () => {
   describe('all stores', () => {
@@ -23,7 +23,7 @@ describe('Tiered', () => {
 
     it('put', async () => {
       const k = new Key('hello')
-      const v = Buffer.from('world')
+      const v = utf8Encoder.encode('world')
       await store.put(k, v)
       const res = await Promise.all([ms[0].get(k), ms[1].get(k)])
       res.forEach((val) => {
@@ -33,7 +33,7 @@ describe('Tiered', () => {
 
     it('get and has, where available', async () => {
       const k = new Key('hello')
-      const v = Buffer.from('world')
+      const v = utf8Encoder.encode('world')
       await ms[1].put(k, v)
       const val = await store.get(k)
       expect(val).to.be.eql(v)
@@ -47,7 +47,7 @@ describe('Tiered', () => {
 
     it('has and delete', async () => {
       const k = new Key('hello')
-      const v = Buffer.from('world')
+      const v = utf8Encoder.encode('world')
       await store.put(k, v)
       let res = await Promise.all([ms[0].has(k), ms[1].has(k)])
       expect(res).to.be.eql([true, true])