Bump version to 0.1.7

.gitignore

@@ -1 +1,2 @@
 node_modules
+package-lock.json

.npmignore

@@ -1,7 +0,0 @@
-.git
-.gitignore
-.npmignore
-.travis.yml
-examples
-node_modules
-spec

.travis.yml

@@ -5,8 +5,15 @@ node_js:
   - "0.8"
   - "0.10"
   - "0.12"
-  - "iojs-1"
-  - "iojs-2"
-  - "iojs-3"
   - "4"
   - "5"
+  - "6"
+  - "7"
+  - "8"
+  - "9"
+  - "10"
+  - "11"
+  - "12"
+
+before_install:
+  - '[ "${TRAVIS_NODE_VERSION}" = "0.8" ] && npm install -g npm@~1.4.0 || true'

CHANGELOG.md

@@ -1,28 +1,38 @@
+### 0.1.7 / 2019-06-10
+
+- Use the `Buffer.alloc()` and `Buffer.from()` functions instead of the unsafe
+  `Buffer()` constructor
+
+### 0.1.6 / 2017-09-10
+
+- Use `9` instead of `8` as the `windowBits` parameter to zlib, to deal with
+  restrictions introduced in zlib v1.2.9
+
 ### 0.1.5 / 2016-02-24
 
-* Catch errors thrown by `close()` on zlib streams
+- Catch errors thrown by `close()` on zlib streams
 
 ### 0.1.4 / 2015-11-06
 
-* The server does not send `server_max_window_bits` if the client does not ask
+- The server does not send `server_max_window_bits` if the client does not ask
   for it; this works around an issue in Firefox.
 
 ### 0.1.3 / 2015-04-10
 
-* Fix a race condition causing some fragments of deflate output to be dropped
-* Make sure to emit minimal output on all Node versions
+- Fix a race condition causing some fragments of deflate output to be dropped
+- Make sure to emit minimal output on all Node versions
 
 ### 0.1.2 / 2014-12-18
 
-* Don't allow configure() to be called with unrecognized options
+- Don't allow configure() to be called with unrecognized options
 
 ### 0.1.1 / 2014-12-15
 
-* Fix race condition when using context takeover, where adjacent messages have
+- Fix race condition when using context takeover, where adjacent messages have
   data listeners bound at the same time and end up duplicating output
-* Use `DeflateRaw.flush()` correctly on v0.10 so that optimal compression is
+- Use `DeflateRaw.flush()` correctly on v0.10 so that optimal compression is
   achieved
 
 ### 0.1.0 / 2014-12-13
 
-* Initial release
+- Initial release

LICENSE.md

@@ -0,0 +1,12 @@
+Copyright 2014-2019 James Coglan
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License. You may obtain a copy of the
+License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

README.md

@@ -11,7 +11,7 @@ WebSocket protocol extension as a plugin for
 $ npm install permessage-deflate
 ```
 
-## Usage
+## Usage
 
 Add the plugin to your extensions:
 
@@ -45,48 +45,25 @@ the peer, and those that are negotiated as part of the protocol. The settings
 only affecting the compressor are described fully in the [zlib
 documentation](http://nodejs.org/api/zlib.html#zlib_options):
 
-* `level`: sets the compression level, can be an integer from `0` to `9`, or one
+- `level`: sets the compression level, can be an integer from `0` to `9`, or one
   of the constants `zlib.Z_NO_COMPRESSION`, `zlib.Z_BEST_SPEED`,
   `zlib.Z_BEST_COMPRESSION`, or `zlib.Z_DEFAULT_COMPRESSION`
-* `memLevel`: sets how much memory the compressor allocates, can be an integer
+- `memLevel`: sets how much memory the compressor allocates, can be an integer
   from `1` to `9`, or one of the constants `zlib.Z_MIN_MEMLEVEL`,
   `zlib.Z_MAX_MEMLEVEL`, or `zlib.Z_DEFAULT_MEMLEVEL`
-* `strategy`: can be one of the constants `zlib.Z_FILTERED`,
+- `strategy`: can be one of the constants `zlib.Z_FILTERED`,
   `zlib.Z_HUFFMAN_ONLY`, `zlib.Z_RLE`, `zlib.Z_FIXED`, or
   `zlib.Z_DEFAULT_STRATEGY`
 
 The other options relate to settings that are negotiated via the protocol and
 can be used to set the local session's behaviour and control that of the peer:
 
-* `noContextTakeover`: if `true`, stops the session reusing a deflate context
+- `noContextTakeover`: if `true`, stops the session reusing a deflate context
   between messages
-* `requestNoContextTakeover`: if `true`, makes the session tell the other peer
+- `requestNoContextTakeover`: if `true`, makes the session tell the other peer
   not to reuse a deflate context between messages
-* `maxWindowBits`: an integer from `8` to `15` inclusive that sets the maximum
+- `maxWindowBits`: an integer from `8` to `15` inclusive that sets the maximum
   size of the session's sliding window; a lower window size will be used if
   requested by the peer
-* `requestMaxWindowBits`: an integer from `8` to `15` inclusive to ask the other
+- `requestMaxWindowBits`: an integer from `8` to `15` inclusive to ask the other
   peer to use to set its maximum sliding window size, if supported
-
-## License
-
-(The MIT License)
-
-Copyright (c) 2014-2016 James Coglan
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the 'Software'), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

lib/client_session.js

@@ -39,7 +39,7 @@ ClientSession.prototype.generateOffer = function() {
 
   if (this._requestMaxWindowBits !== undefined) {
     if (common.VALID_WINDOW_BITS.indexOf(this._requestMaxWindowBits) < 0) {
-      throw new Error('Invalid valud for requestMaxWindowBits');
+      throw new Error('Invalid value for requestMaxWindowBits');
     }
     offer.server_max_window_bits = this._requestMaxWindowBits;
   }

lib/common.js

@@ -1,5 +1,7 @@
 'use strict';
 
+var Buffer = require('safe-buffer').Buffer;
+
 var common = {
   VALID_PARAMS: [
     'server_no_context_takeover',
@@ -8,20 +10,10 @@ var common = {
     'client_max_window_bits'
   ],
 
+  MIN_WINDOW_BITS:   9,
   MAX_WINDOW_BITS:   15,
   VALID_WINDOW_BITS: [8, 9, 10, 11, 12, 13, 14, 15],
 
-  concat: function(buffers, length) {
-    var buffer = new Buffer(length),
-        offset = 0;
-
-    for (var i = 0, n = buffers.length; i < n; i++) {
-      buffers[i].copy(buffer, offset);
-      offset += buffers[i].length;
-    }
-    return buffer;
-  },
-
   fetch: function(options, key, _default) {
     if (options.hasOwnProperty(key))
       return options[key];

lib/permessage_deflate.js

@@ -11,7 +11,8 @@ var VALID_OPTIONS = [
   'noContextTakeover',
   'maxWindowBits',
   'requestNoContextTakeover',
-  'requestMaxWindowBits'
+  'requestMaxWindowBits',
+  'zlib'
 ];
 
 var PermessageDeflate = {

lib/server_session.js

@@ -23,21 +23,21 @@ ServerSession.validParams = function(params) {
 ServerSession.prototype.generateResponse = function() {
   var response = {};
 
-  // https://tools.ietf.org/html/draft-ietf-hybi-permessage-compression#section-8.1.1.1
+  // https://tools.ietf.org/html/rfc7692#section-7.1.1.1
 
   this._ownContextTakeover = !this._acceptNoContextTakeover &&
                              !this._params.server_no_context_takeover;
 
   if (!this._ownContextTakeover) response.server_no_context_takeover = true;
 
-  // https://tools.ietf.org/html/draft-ietf-hybi-permessage-compression#section-8.1.1.2
+  // https://tools.ietf.org/html/rfc7692#section-7.1.1.2
 
   this._peerContextTakeover = !this._requestNoContextTakeover &&
                               !this._params.client_no_context_takeover;
 
   if (!this._peerContextTakeover) response.client_no_context_takeover = true;
 
-  // https://tools.ietf.org/html/draft-ietf-hybi-permessage-compression#section-8.1.2.1
+  // https://tools.ietf.org/html/rfc7692#section-7.1.2.1
 
   this._ownWindowBits = Math.min(this._acceptMaxWindowBits || common.MAX_WINDOW_BITS,
                                  this._params.server_max_window_bits || common.MAX_WINDOW_BITS);
@@ -47,7 +47,7 @@ ServerSession.prototype.generateResponse = function() {
   if (this._ownWindowBits < common.MAX_WINDOW_BITS && this._params.server_max_window_bits)
     response.server_max_window_bits = this._ownWindowBits;
 
-  // https://tools.ietf.org/html/draft-ietf-hybi-permessage-compression#section-8.1.2.2
+  // https://tools.ietf.org/html/rfc7692#section-7.1.2.2
 
   var clientMax = this._params.client_max_window_bits, requestMax;
   if (clientMax) {

lib/session.js

@@ -1,10 +1,11 @@
 'use strict';
 
-var zlib   = require('zlib'),
+var Buffer = require('safe-buffer').Buffer,
+    zlib   = require('zlib'),
     common = require('./common');
 
 var Session = function(options) {
-  this._level    = common.fetch(options, 'level',    zlib.Z_DEFAULT_LEVEL);
+  this._level    = common.fetch(options, 'level',    zlib.Z_DEFAULT_COMPRESSION);
   this._memLevel = common.fetch(options, 'memLevel', zlib.Z_DEFAULT_MEMLEVEL);
   this._strategy = common.fetch(options, 'strategy', zlib.Z_DEFAULT_STRATEGY);
 
@@ -15,6 +16,8 @@ var Session = function(options) {
 
   this._queueIn  = [];
   this._queueOut = [];
+
+  this._zlib = common.fetch(options, 'zlib', zlib);
 };
 
 Session.prototype.processIncomingMessage = function(message, callback) {
@@ -55,10 +58,10 @@ Session.prototype.processIncomingMessage = function(message, callback) {
   inflate.on('error', onError);
 
   inflate.write(message.data);
-  inflate.write(new Buffer([0x00, 0x00, 0xff, 0xff]));
+  inflate.write(Buffer.from([0x00, 0x00, 0xff, 0xff]));
 
   inflate.flush(function() {
-    message.data = common.concat(chunks, length);
+    message.data = Buffer.concat(chunks, length);
     return_(null, message);
   });
 };
@@ -101,7 +104,7 @@ Session.prototype.processOutgoingMessage = function(message, callback) {
   deflate.write(message.data);
 
   var onFlush = function() {
-    var data = common.concat(chunks, length);
+    var data = Buffer.concat(chunks, length);
     message.data = data.slice(0, data.length - 4);
     message.rsv1 = true;
     return_(null, message);
@@ -123,7 +126,10 @@ Session.prototype.close = function() {
 
 Session.prototype._getInflate = function() {
   if (this._inflate) return this._inflate;
-  var inflate = zlib.createInflateRaw({windowBits: this._peerWindowBits});
+
+  var windowBits = Math.max(this._peerWindowBits, common.MIN_WINDOW_BITS),
+      inflate    = this._zlib.createInflateRaw({windowBits: windowBits});
+
   if (this._peerContextTakeover) this._inflate = inflate;
   return inflate;
 };
@@ -131,8 +137,10 @@ Session.prototype._getInflate = function() {
 Session.prototype._getDeflate = function() {
   if (this._deflate) return this._deflate;
 
-  var deflate = zlib.createDeflateRaw({
-    windowBits: this._ownWindowBits,
+  var windowBits = Math.max(this._ownWindowBits, common.MIN_WINDOW_BITS);
+
+  var deflate = this._zlib.createDeflateRaw({
+    windowBits: windowBits,
     level:      this._level,
     memLevel:   this._memLevel,
     strategy:   this._strategy
@@ -151,7 +159,7 @@ Session.prototype._getDeflate = function() {
         flush.call(this, callback);
       } else {
         this._flushFlag = zlib.Z_SYNC_FLUSH;
-        this.write(new Buffer(0), '', callback);
+        this.write(Buffer.alloc(0), '', callback);
       }
     };
 

package.json

@@ -1,20 +1,34 @@
-{ "name"            : "permessage-deflate"
-, "description"     : "Per-message DEFLATE compression extension for WebSocket connections"
-, "homepage"        : "https://github.com/faye/permessage-deflate-node"
-, "author"          : "James Coglan <jcoglan@gmail.com> (http://jcoglan.com/)"
-, "keywords"        : ["websocket", "compression", "deflate"]
-, "license"         : "MIT"
-
-, "version"         : "0.1.5"
-, "engines"         : {"node": ">=0.8.0"}
-, "main"            : "./lib/permessage_deflate"
-, "devDependencies" : {"jstest": ""}
-
-, "scripts"         : {"test": "jstest spec/runner.js"}
-
-, "repository"      : { "type"  : "git"
-                      , "url"   : "git://github.com/faye/permessage-deflate-node.git"
-                      }
-
-, "bugs"            : "https://github.com/faye/permessage-deflate-node/issues"
+{
+          "name": "permessage-deflate",
+          "description": "Per-message DEFLATE compression extension for WebSocket connections",
+          "homepage": "https://github.com/faye/permessage-deflate-node",
+          "author": "James Coglan <jcoglan@gmail.com> (http://jcoglan.com/)",
+          "keywords": [
+                    "websocket",
+                    "compression",
+                    "deflate"
+          ],
+          "license": "Apache-2.0",
+          "version": "0.1.7",
+          "engines": {
+                    "node": ">=0.8.0"
+          },
+          "files": [
+                    "lib"
+          ],
+          "main": "./lib/permessage_deflate",
+          "dependencies": {
+                    "safe-buffer": "*"
+          },
+          "devDependencies": {
+                    "jstest": "*"
+          },
+          "scripts": {
+                    "test": "jstest spec/runner.js"
+          },
+          "repository": {
+                    "type": "git",
+                    "url": "git://github.com/faye/permessage-deflate-node.git"
+          },
+          "bugs": "https://github.com/faye/permessage-deflate-node/issues"
 }

spec/client_session_spec.js

@@ -1,17 +1,18 @@
 var PermessageDeflate = require('../lib/permessage_deflate'),
-    zlib = require('zlib'),
+    _zlib = require('zlib'),
     test = require('jstest').Test
 
 test.describe("ClientSession", function() { with(this) {
   before(function() { with(this) {
-    this.ext      = PermessageDeflate.configure(options)
-    this.session  = ext.createClientSession()
-
     this.deflate  = zlibMock()
     this.inflate  = zlibMock()
-    this.level    = zlib.Z_DEFAULT_LEVEL
-    this.memLevel = zlib.Z_DEFAULT_MEMLEVEL
-    this.strategy = zlib.Z_DEFAULT_STRATEGY
+    this.level    = _zlib.Z_DEFAULT_LEVEL
+    this.memLevel = _zlib.Z_DEFAULT_MEMLEVEL
+    this.strategy = _zlib.Z_DEFAULT_STRATEGY
+
+    this.ext      = PermessageDeflate.configure(options)
+    this.zlib     = {}
+    this.session  = ext.configure({zlib: zlib}).createClientSession()
 
     this.message  = {data: "hello", rsv1: true}
   }})
@@ -127,9 +128,9 @@ test.describe("ClientSession", function() { with(this) {
         assertEqual( true, activate() )
       }})
 
-      it("uses context takeover and 8 window bits for inflating incoming messages", function() { with(this) {
+      it("uses context takeover and 9 window bits for inflating incoming messages", function() { with(this) {
         activate()
-        expect(zlib, "createInflateRaw").given({windowBits: 8}).exactly(1).returning(inflate)
+        expect(zlib, "createInflateRaw").given({windowBits: 9}).exactly(1).returning(inflate)
         processIncomingMessage()
         processIncomingMessage()
       }})
@@ -150,9 +151,9 @@ test.describe("ClientSession", function() { with(this) {
         assertEqual( true, activate() )
       }})
 
-      it("uses context takeover and 8 window bits for deflating outgoing messages", function() { with(this) {
+      it("uses context takeover and 9 window bits for deflating outgoing messages", function() { with(this) {
         activate()
-        expect(zlib, "createDeflateRaw").given({windowBits: 8, level: level, memLevel: memLevel, strategy: strategy}).exactly(1).returning(deflate)
+        expect(zlib, "createDeflateRaw").given({windowBits: 9, level: level, memLevel: memLevel, strategy: strategy}).exactly(1).returning(deflate)
         processOutgoingMessage()
         processOutgoingMessage()
       }})
@@ -224,9 +225,9 @@ test.describe("ClientSession", function() { with(this) {
         assertEqual( true, activate() )
       }})
 
-      it("uses context takeover and 8 window bits for deflating outgoing messages", function() { with(this) {
+      it("uses context takeover and 9 window bits for deflating outgoing messages", function() { with(this) {
         activate()
-        expect(zlib, "createDeflateRaw").given({windowBits: 8, level: level, memLevel: memLevel, strategy: strategy}).exactly(1).returning(deflate)
+        expect(zlib, "createDeflateRaw").given({windowBits: 9, level: level, memLevel: memLevel, strategy: strategy}).exactly(1).returning(deflate)
         processOutgoingMessage()
         processOutgoingMessage()
       }})
@@ -317,11 +318,11 @@ test.describe("ClientSession", function() { with(this) {
   }})
 
   describe("with level", function() { with(this) {
-    define("options", {level: zlib.Z_BEST_SPEED})
+    define("options", {level: _zlib.Z_BEST_SPEED})
 
     it("sets the level of the deflate stream", function() { with(this) {
       activate()
-      expect(zlib, "createDeflateRaw").given({windowBits: 15, level: zlib.Z_BEST_SPEED, memLevel: memLevel, strategy: strategy}).returns(deflate)
+      expect(zlib, "createDeflateRaw").given({windowBits: 15, level: _zlib.Z_BEST_SPEED, memLevel: memLevel, strategy: strategy}).returns(deflate)
       processOutgoingMessage()
     }})
   }})
@@ -331,17 +332,17 @@ test.describe("ClientSession", function() { with(this) {
 
     it("sets the memLevel of the deflate stream", function() { with(this) {
       activate()
-      expect(zlib, "createDeflateRaw").given({windowBits: 15, level: zlib.Z_DEFAULT_LEVEL, memLevel: 5, strategy: strategy}).returns(deflate)
+      expect(zlib, "createDeflateRaw").given({windowBits: 15, level: _zlib.Z_DEFAULT_LEVEL, memLevel: 5, strategy: strategy}).returns(deflate)
       processOutgoingMessage()
     }})
   }})
 
   describe("with strategy", function() { with(this) {
-    define("options", {strategy: zlib.Z_FILTERED})
+    define("options", {strategy: _zlib.Z_FILTERED})
 
     it("sets the strategy of the deflate stream", function() { with(this) {
       activate()
-      expect(zlib, "createDeflateRaw").given({windowBits: 15, level: zlib.Z_DEFAULT_LEVEL, memLevel: memLevel, strategy: zlib.Z_FILTERED}).returns(deflate)
+      expect(zlib, "createDeflateRaw").given({windowBits: 15, level: _zlib.Z_DEFAULT_LEVEL, memLevel: memLevel, strategy: _zlib.Z_FILTERED}).returns(deflate)
       processOutgoingMessage()
     }})
   }})

spec/server_session_spec.js

@@ -1,17 +1,18 @@
 var PermessageDeflate = require('../lib/permessage_deflate'),
-    zlib = require('zlib'),
+    _zlib = require('zlib'),
     test = require('jstest').Test
 
 test.describe("ServerSession", function() { with(this) {
   before(function() { with(this) {
-    this.ext      = PermessageDeflate.configure(options)
-    this.session  = ext.createServerSession([offer])
-
     this.deflate  = zlibMock()
     this.inflate  = zlibMock()
-    this.level    = zlib.Z_DEFAULT_LEVEL
-    this.memLevel = zlib.Z_DEFAULT_MEMLEVEL
-    this.strategy = zlib.Z_DEFAULT_STRATEGY
+    this.level    = _zlib.Z_DEFAULT_LEVEL
+    this.memLevel = _zlib.Z_DEFAULT_MEMLEVEL
+    this.strategy = _zlib.Z_DEFAULT_STRATEGY
+
+    this.ext      = PermessageDeflate.configure(options)
+    this.zlib     = {}
+    this.session  = ext.configure({zlib: zlib}).createServerSession([offer])
 
     this.message  = {data: "hello", rsv1: true}
   }})
@@ -319,11 +320,11 @@ test.describe("ServerSession", function() { with(this) {
   }})
 
   describe("with level", function() { with(this) {
-    define("options", {level: zlib.Z_BEST_SPEED})
+    define("options", {level: _zlib.Z_BEST_SPEED})
 
     it("sets the level of the deflate stream", function() { with(this) {
       response()
-      expect(zlib, "createDeflateRaw").given({windowBits: 15, level: zlib.Z_BEST_SPEED, memLevel: memLevel, strategy: strategy}).returns(deflate)
+      expect(zlib, "createDeflateRaw").given({windowBits: 15, level: _zlib.Z_BEST_SPEED, memLevel: memLevel, strategy: strategy}).returns(deflate)
       processOutgoingMessage()
     }})
   }})
@@ -333,17 +334,17 @@ test.describe("ServerSession", function() { with(this) {
 
     it("sets the memLevel of the deflate stream", function() { with(this) {
       response()
-      expect(zlib, "createDeflateRaw").given({windowBits: 15, level: zlib.Z_DEFAULT_LEVEL, memLevel: 5, strategy: strategy}).returns(deflate)
+      expect(zlib, "createDeflateRaw").given({windowBits: 15, level: _zlib.Z_DEFAULT_LEVEL, memLevel: 5, strategy: strategy}).returns(deflate)
       processOutgoingMessage()
     }})
   }})
 
   describe("with strategy", function() { with(this) {
-    define("options", {strategy: zlib.Z_FILTERED})
+    define("options", {strategy: _zlib.Z_FILTERED})
 
     it("sets the strategy of the deflate stream", function() { with(this) {
       response()
-      expect(zlib, "createDeflateRaw").given({windowBits: 15, level: zlib.Z_DEFAULT_LEVEL, memLevel: memLevel, strategy: zlib.Z_FILTERED}).returns(deflate)
+      expect(zlib, "createDeflateRaw").given({windowBits: 15, level: _zlib.Z_DEFAULT_LEVEL, memLevel: memLevel, strategy: _zlib.Z_FILTERED}).returns(deflate)
       processOutgoingMessage()
     }})
   }})