feat: support Uint8Array input in place of Buffer (#13)

With this change all the `Buffer` inputs were replaced by `Uint8Array` which is backwards compatible since `Buffer` is a subclass.

This does make an assumption that "bytes" encoder used to take `Buffer|string` here:

https://github.com/ipfs/protons/blob/3b5276f052f2e17c2d806d27cd9a88e156588977/src/compile/encodings.js#L30-L43


Fixes #12

.travis.yml

@@ -6,7 +6,9 @@ stages:
   - cov
 
 node_js:
+  - '10'
   - '12'
+  - '14'
 
 os:
   - linux

package.json

@@ -14,6 +14,7 @@
     "varint": "^5.0.0"
   },
   "devDependencies": {
+    "ipfs-utils": "^2.3.0",
     "aegir": "^21.4.0",
     "benchmark": "^2.1.4",
     "protocol-buffers": "^4.1.0",

src/compile/encodings.js

@@ -17,7 +17,7 @@ var encoder = function (type, encode, decode, encodingLength) {
 
 exports.make = encoder
 
-exports.bytes = (function (tag) {
+exports.bytes = (function () {
   var bufferLength = function (val) {
     return Buffer.isBuffer(val) ? val.length : Buffer.byteLength(val)
   }
@@ -34,7 +34,7 @@ exports.bytes = (function (tag) {
     varint.encode(len, buffer, offset)
     offset += varint.encode.bytes
 
-    if (Buffer.isBuffer(val)) val.copy(buffer, offset)
+    if (val instanceof Uint8Array) buffer.set(val, offset)
     else buffer.write(val, offset, len)
     offset += len
 
@@ -198,7 +198,7 @@ exports.sfixed64 = (function () {
   }
 
   var encode = function (val, buffer, offset) {
-    val.copy(buffer, offset)
+    buffer.set(val, offset)
     encode.bytes = 8
     return buffer
   }

test/bytes.js

@@ -6,7 +6,7 @@ var Bytes = protobuf(require('./test.proto')).Bytes
 
 tape('bytes encode + decode', function (t) {
   var b1 = Bytes.encode({
-    req: Buffer.from([0, 1, 2, 3])
+    req: Uint8Array.from([0, 1, 2, 3])
   })
 
   var o1 = Bytes.decode(b1)

test/corrupted.js

@@ -27,7 +27,7 @@ var messages = protobuf(protoStr)
 tape('invalid message decode', function (t) {
   var didFail = false
   try {
-    messages.ABC.decode(Buffer.from([8, 182, 168, 235, 144, 178, 41]))
+    messages.ABC.decode(Uint8Array.from([8, 182, 168, 235, 144, 178, 41]))
   } catch (e) {
     didFail = true
   }

test/custom-types.js

@@ -8,7 +8,7 @@ tape('custom types encode + decode', function (t) {
   var b1 = CustomType.encode({
     req: {
       num: 5,
-      payload: Buffer.from([])
+      payload: Uint8Array.from([])
     }
   })
 

test/nested.js

@@ -2,25 +2,27 @@
 
 var tape = require('tape')
 var protobuf = require('../')
+const TextEncoder = require('ipfs-utils/src/text-encoder')
+
 var Nested = protobuf(require('./test.proto')).Nested
 
 tape('nested encode', function (t) {
   var b1 = Nested.encode({
     num: 1,
-    payload: Buffer.from('lol'),
+    payload: new TextEncoder().encode('lol'),
     meh: {
       num: 2,
-      payload: Buffer.from('bar')
+      payload: new TextEncoder().encode('bar')
     }
   })
 
   var b2 = Nested.encode({
     num: 1,
-    payload: Buffer.from('lol'),
+    payload: new TextEncoder().encode('lol'),
     meeeh: 42,
     meh: {
       num: 2,
-      payload: Buffer.from('bar')
+      payload: new TextEncoder().encode('bar')
     }
   })
 
@@ -31,10 +33,10 @@ tape('nested encode', function (t) {
 tape('nested encode + decode', function (t) {
   var b1 = Nested.encode({
     num: 1,
-    payload: Buffer.from('lol'),
+    payload: new TextEncoder().encode('lol'),
     meh: {
       num: 2,
-      payload: Buffer.from('bar')
+      payload: new TextEncoder().encode('bar')
     }
   })
 
@@ -48,11 +50,11 @@ tape('nested encode + decode', function (t) {
 
   var b2 = Nested.encode({
     num: 1,
-    payload: Buffer.from('lol'),
+    payload: new TextEncoder().encode('lol'),
     meeeh: 42,
     meh: {
       num: 2,
-      payload: Buffer.from('bar')
+      payload: new TextEncoder().encode('bar')
     }
   })
 

test/repeated.js

@@ -3,25 +3,26 @@
 var tape = require('tape')
 var protobuf = require('../')
 var Repeated = protobuf(require('./test.proto')).Repeated
+const TextEncoder = require('ipfs-utils/src/text-encoder')
 
 tape('repeated encode', function (t) {
   var b1 = Repeated.encode({
     list: [{
       num: 1,
-      payload: Buffer.from('lol')
+      payload: new TextEncoder().encode('lol')
     }, {
       num: 2,
-      payload: Buffer.from('lol1')
+      payload: new TextEncoder().encode('lol1')
     }]
   })
 
   var b2 = Repeated.encode({
     list: [{
       num: 1,
-      payload: Buffer.from('lol')
+      payload: new TextEncoder().encode('lol')
     }, {
       num: 2,
-      payload: Buffer.from('lol1'),
+      payload: new TextEncoder().encode('lol1'),
       meeeeh: 100
     }],
     meeh: 42
@@ -35,10 +36,10 @@ tape('repeated encode + decode', function (t) {
   var b1 = Repeated.encode({
     list: [{
       num: 1,
-      payload: Buffer.from('lol')
+      payload: new TextEncoder().encode('lol')
     }, {
       num: 2,
-      payload: Buffer.from('lol1')
+      payload: new TextEncoder().encode('lol1')
     }]
   })
 
@@ -53,10 +54,10 @@ tape('repeated encode + decode', function (t) {
   var b2 = Repeated.encode({
     list: [{
       num: 1,
-      payload: Buffer.from('lol')
+      payload: new TextEncoder().encode('lol')
     }, {
       num: 2,
-      payload: Buffer.from('lol1'),
+      payload: new TextEncoder().encode('lol1'),
       meeeeh: 100
     }],
     meeh: 42