bl 2.1.2 → 3.0.1

package/.travis.yml

@@ -1,10 +1,8 @@
 sudo: false
 language: node_js
 node_js:
-  - '4'
   - '6'
   - '8'
-  - '9'
   - '10'
 branches:
   only:

package/README.md

@@ -15,11 +15,11 @@ The original buffers are kept intact and copies are only done as necessary. Any
 const BufferList = require('bl')
 
 var bl = new BufferList()
-bl.append(new Buffer('abcd'))
-bl.append(new Buffer('efg'))
+bl.append(Buffer.from('abcd'))
+bl.append(Buffer.from('efg'))
 bl.append('hi')                     // bl will also accept & convert Strings
-bl.append(new Buffer('j'))
-bl.append(new Buffer([ 0x3, 0x4 ]))
+bl.append(Buffer.from('j'))
+bl.append(Buffer.from([ 0x3, 0x4 ]))
 
 console.log(bl.length) // 12
 
@@ -29,6 +29,9 @@ console.log(bl.slice(3, 6).toString('ascii'))  // 'def'
 console.log(bl.slice(3, 8).toString('ascii'))  // 'defgh'
 console.log(bl.slice(5, 10).toString('ascii')) // 'fghij'
 
+console.log(bl.indexOf('def')) // 3
+console.log(bl.indexOf('asdf')) // -1
+
 // or just use toString!
 console.log(bl.toString())               // 'abcdefghij\u0003\u0004'
 console.log(bl.toString('ascii', 3, 8))  // 'defgh'
@@ -72,10 +75,10 @@ const BufferList = require('bl')
     , fs         = require('fs')
 
 var bl = new BufferList()
-bl.append(new Buffer('abcd'))
-bl.append(new Buffer('efg'))
-bl.append(new Buffer('hi'))
-bl.append(new Buffer('j'))
+bl.append(Buffer.from('abcd'))
+bl.append(Buffer.from('efg'))
+bl.append(Buffer.from('hi'))
+bl.append(Buffer.from('j'))
 
 bl.pipe(fs.createWriteStream('gibberish.txt'))
 ```
@@ -86,6 +89,7 @@ bl.pipe(fs.createWriteStream('gibberish.txt'))
   * <a href="#length"><code>bl.<b>length</b></code></a>
   * <a href="#append"><code>bl.<b>append(buffer)</b></code></a>
   * <a href="#get"><code>bl.<b>get(index)</b></code></a>
+  * <a href="#indexOf"><code>bl.<b>indexOf(value[, byteOffset][, encoding])</b></code></a>
   * <a href="#slice"><code>bl.<b>slice([ start[, end ] ])</b></code></a>
   * <a href="#shallowSlice"><code>bl.<b>shallowSlice([ start[, end ] ])</b></code></a>
   * <a href="#copy"><code>bl.<b>copy(dest, [ destStart, [ srcStart [, srcEnd ] ] ])</b></code></a>
@@ -129,6 +133,12 @@ Get the length of the list in bytes. This is the sum of the lengths of all of th
 ### bl.get(index)
 `get()` will return the byte at the specified index.
 
+--------------------------------------------------------
+<a name="indexOf"></a>
+### bl.indexOf(value[, byteOffset][, encoding])
+`get()` will return the byte at the specified index.
+`indexOf()` method returns the first index at which a given element can be found in the BufferList, or -1 if it is not present.
+
 --------------------------------------------------------
 <a name="slice"></a>
 ### bl.slice([ start, [ end ] ])

package/bl.js

@@ -1,7 +1,6 @@
 'use strict'
 var DuplexStream = require('readable-stream').Duplex
   , util         = require('util')
-  , Buffer       = require('safe-buffer').Buffer
 
 function BufferList (callback) {
   if (!(this instanceof BufferList))
@@ -186,30 +185,37 @@ BufferList.prototype.copy = function copy (dst, dstStart, srcStart, srcEnd) {
 
     if (bytes > l) {
       this._bufs[i].copy(dst, bufoff, start)
+      bufoff += l
     } else {
       this._bufs[i].copy(dst, bufoff, start, start + bytes)
+      bufoff += l
       break
     }
 
-    bufoff += l
     bytes -= l
 
     if (start)
       start = 0
   }
 
+  // safeguard so that we don't return uninitialized memory
+  if (dst.length > bufoff) return dst.slice(0, bufoff)
+
   return dst
 }
 
 BufferList.prototype.shallowSlice = function shallowSlice (start, end) {
   start = start || 0
-  end = end || this.length
+  end = typeof end !== 'number' ? this.length : end
 
   if (start < 0)
     start += this.length
   if (end < 0)
     end += this.length
 
+  if (start === end) {
+    return new BufferList()
+  }
   var startOffset = this._offset(start)
     , endOffset = this._offset(end)
     , buffers = this._bufs.slice(startOffset[0], endOffset[0] + 1)
@@ -230,6 +236,11 @@ BufferList.prototype.toString = function toString (encoding, start, end) {
 }
 
 BufferList.prototype.consume = function consume (bytes) {
+  // first, normalize the argument, in accordance with how Buffer does it
+  bytes = Math.trunc(bytes)
+  // do nothing if not a positive number
+  if (Number.isNaN(bytes) || bytes <= 0) return this
+
   while (this._bufs.length) {
     if (bytes >= this._bufs[0].length) {
       bytes -= this._bufs[0].length
@@ -256,10 +267,10 @@ BufferList.prototype.duplicate = function duplicate () {
 }
 
 
-BufferList.prototype.destroy = function destroy () {
+BufferList.prototype._destroy = function _destroy (err, cb) {
   this._bufs.length = 0
   this.length = 0
-  this.push(null)
+  cb(err)
 }
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bl",
-  "version": "2.1.2",
+  "version": "3.0.1",
   "description": "Buffer List: collect buffers and access with a standard readable Buffer interface, streamable too!",
   "main": "bl.js",
   "scripts": {
@@ -24,12 +24,11 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "readable-stream": "^2.3.5",
-    "safe-buffer": "^5.1.1"
+    "readable-stream": "^3.0.1"
   },
   "devDependencies": {
     "faucet": "0.0.1",
     "hash_file": "~0.1.1",
-    "tape": "~4.9.0"
+    "tape": "~4.9.1"
   }
 }

package/test/test.js

@@ -431,6 +431,22 @@ tape('test toString encoding', function (t) {
   t.end()
 })
 
+tape('uninitialized memory', function (t) {
+  const secret = crypto.randomBytes(256)
+  for (let i = 0; i < 1e6; i++) {
+    const clone = Buffer.from(secret)
+    const bl = new BufferList()
+    bl.append(Buffer.from('a'))
+    bl.consume(-1024)
+    const buf = bl.slice(1)
+    if (buf.indexOf(clone) !== -1) {
+      t.fail(`Match (at ${i})`)
+      break
+    }
+  }
+  t.end()
+})
+
 !process.browser && tape('test stream', function (t) {
   var random = crypto.randomBytes(65534)
     , rndhash = hash(random, 'md5')
@@ -649,6 +665,20 @@ tape('shallow slice does not make a copy', function (t) {
   t.equal(bl.toString(), 'hhhhhhhh')
 })
 
+tape('shallow slice with 0 length', function (t) {
+  t.plan(1)
+  var buffers = [Buffer.from('First'), Buffer.from('Second'), Buffer.from('Third')]
+  var bl = (new BufferList(buffers)).shallowSlice(0, 0)
+  t.equal(bl.length, 0)
+})
+
+tape('shallow slice with 0 length from middle', function (t) {
+  t.plan(1)
+  var buffers = [Buffer.from('First'), Buffer.from('Second'), Buffer.from('Third')]
+  var bl = (new BufferList(buffers)).shallowSlice(10, 10)
+  t.equal(bl.length, 0)
+})
+
 tape('duplicate', function (t) {
   t.plan(2)
 
@@ -669,6 +699,20 @@ tape('destroy no pipe', function (t) {
   t.equal(bl.length, 0)
 })
 
+tape('destroy with error', function (t) {
+  t.plan(3)
+
+  var bl = new BufferList('alsdkfja;lsdkfja;lsdk')
+  var err = new Error('kaboom')
+  bl.destroy(err)
+  bl.on('error', function (_err) {
+    t.equal(_err, err)
+  })
+
+  t.equal(bl._bufs.length, 0)
+  t.equal(bl.length, 0)
+})
+
 !process.browser && tape('destroy with pipe before read end', function (t) {
   t.plan(2)