[fix] Rename the 'close' event to 'conclude'

Avoid collisions with the `stream.Writable` `'close'` event.
websockets · Mar 6, 2018 · 7fb82a3 · 7fb82a3
1 parent fb05059
commit 7fb82a3
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 22 deletions.
diff --git a/lib/receiver.js b/lib/receiver.js
@@ -23,11 +23,11 @@ class Receiver extends stream.Writable {
   /**
    * Creates a Receiver instance.
    *
+   * @param {String} binaryType The type for binary data
    * @param {Object} extensions An object containing the negotiated extensions
    * @param {Number} maxPayload The maximum allowed message length
-   * @param {String} binaryType The type for binary data
    */
-  constructor (extensions, maxPayload, binaryType) {
+  constructor (binaryType, extensions, maxPayload) {
     super();
 
     this._binaryType = binaryType || constants.BINARY_TYPES[0];
@@ -430,7 +430,7 @@ class Receiver extends stream.Writable {
       this._loop = false;
 
       if (data.length === 0) {
-        this.emit('close', 1005, '');
+        this.emit('conclude', 1005, '');
         this.end();
       } else if (data.length === 1) {
         return error(RangeError, 'invalid payload length 1', true, 1002);
@@ -447,7 +447,7 @@ class Receiver extends stream.Writable {
           return error(Error, 'invalid UTF-8 sequence', true, 1007);
         }
 
-        this.emit('close', code, buf.toString());
+        this.emit('conclude', code, buf.toString());
         this.end();
       }
 

diff --git a/lib/websocket.js b/lib/websocket.js
@@ -118,9 +118,9 @@ class WebSocket extends EventEmitter {
    */
   setSocket (socket, head, maxPayload) {
     const receiver = new Receiver(
+      this._binaryType,
       this._extensions,
-      maxPayload,
-      this._binaryType
+      maxPayload
     );
 
     this._sender = new Sender(socket, this._extensions);
@@ -130,7 +130,7 @@ class WebSocket extends EventEmitter {
     receiver[kWebSocket] = this;
     socket[kWebSocket] = this;
 
-    receiver.on('close', receiverOnClose);
+    receiver.on('conclude', receiverOnConclude);
     receiver.on('drain', receiverOnDrain);
     receiver.on('error', receiverOnError);
     receiver.on('message', receiverOnMessage);
@@ -678,13 +678,13 @@ function abortHandshake (websocket, stream, message) {
 }
 
 /**
- * The listener of the `Receiver` `'close'` event.
+ * The listener of the `Receiver` `'conclude'` event.
  *
  * @param {Number} code The status code
  * @param {String} reason The reason for closing
  * @private
  */
-function receiverOnClose (code, reason) {
+function receiverOnConclude (code, reason) {
   const websocket = this[kWebSocket];
 
   websocket._socket.removeListener('data', socketOnData);

diff --git a/test/receiver.test.js b/test/receiver.test.js
@@ -25,7 +25,7 @@ describe('Receiver', function () {
   it('parses a close message', function (done) {
     const receiver = new Receiver();
 
-    receiver.on('close', (code, data) => {
+    receiver.on('conclude', (code, data) => {
       assert.strictEqual(code, 1005);
       assert.strictEqual(data, '');
       done();
@@ -334,7 +334,9 @@ describe('Receiver', function () {
     const perMessageDeflate = new PerMessageDeflate();
     perMessageDeflate.accept([{}]);
 
-    const receiver = new Receiver({ 'permessage-deflate': perMessageDeflate });
+    const receiver = new Receiver(undefined, {
+      'permessage-deflate': perMessageDeflate
+    });
     const buf = Buffer.from('Hello');
 
     receiver.on('message', (data) => {
@@ -354,7 +356,9 @@ describe('Receiver', function () {
     const perMessageDeflate = new PerMessageDeflate();
     perMessageDeflate.accept([{}]);
 
-    const receiver = new Receiver({ 'permessage-deflate': perMessageDeflate });
+    const receiver = new Receiver(undefined, {
+      'permessage-deflate': perMessageDeflate
+    });
     const buf1 = Buffer.from('foo');
     const buf2 = Buffer.from('bar');
 
@@ -398,7 +402,7 @@ describe('Receiver', function () {
   });
 
   it('resets `totalPayloadLength` only on final frame (unfragmented)', function (done) {
-    const receiver = new Receiver({}, 10);
+    const receiver = new Receiver(undefined, {}, 10);
 
     receiver.on('message', (data) => {
       assert.strictEqual(receiver._totalPayloadLength, 0);
@@ -411,7 +415,7 @@ describe('Receiver', function () {
   });
 
   it('resets `totalPayloadLength` only on final frame (fragmented)', function (done) {
-    const receiver = new Receiver({}, 10);
+    const receiver = new Receiver(undefined, {}, 10);
 
     receiver.on('message', (data) => {
       assert.strictEqual(receiver._totalPayloadLength, 0);
@@ -426,7 +430,7 @@ describe('Receiver', function () {
   });
 
   it('resets `totalPayloadLength` only on final frame (fragmented + ping)', function (done) {
-    const receiver = new Receiver({}, 10);
+    const receiver = new Receiver(undefined, {}, 10);
     let data;
 
     receiver.on('ping', (buf) => {
@@ -450,11 +454,13 @@ describe('Receiver', function () {
     const perMessageDeflate = new PerMessageDeflate();
     perMessageDeflate.accept([{}]);
 
-    const receiver = new Receiver({ 'permessage-deflate': perMessageDeflate });
+    const receiver = new Receiver(undefined, {
+      'permessage-deflate': perMessageDeflate
+    });
     const results = [];
     const push = results.push.bind(results);
 
-    receiver.on('close', push).on('message', push);
+    receiver.on('conclude', push).on('message', push);
     receiver.on('finish', () => {
       assert.deepStrictEqual(results, ['', 1005, '']);
       done();
@@ -485,7 +491,9 @@ describe('Receiver', function () {
     const perMessageDeflate = new PerMessageDeflate();
     perMessageDeflate.accept([{}]);
 
-    const receiver = new Receiver({ 'permessage-deflate': perMessageDeflate });
+    const receiver = new Receiver(undefined, {
+      'permessage-deflate': perMessageDeflate
+    });
 
     receiver.on('error', (err) => {
       assert.ok(err instanceof RangeError);
@@ -602,7 +610,9 @@ describe('Receiver', function () {
     const perMessageDeflate = new PerMessageDeflate();
     perMessageDeflate.accept([{}]);
 
-    const receiver = new Receiver({ 'permessage-deflate': perMessageDeflate });
+    const receiver = new Receiver(undefined, {
+      'permessage-deflate': perMessageDeflate
+    });
 
     receiver.on('error', (err) => {
       assert.ok(err instanceof RangeError);
@@ -736,7 +746,7 @@ describe('Receiver', function () {
   });
 
   it('emits an error if a frame payload length is bigger than `maxPayload`', function (done) {
-    const receiver = new Receiver({}, 20 * 1024);
+    const receiver = new Receiver(undefined, {}, 20 * 1024);
     const msg = crypto.randomBytes(200 * 1024);
 
     const list = Sender.frame(msg, {
@@ -763,7 +773,7 @@ describe('Receiver', function () {
     const perMessageDeflate = new PerMessageDeflate({}, false, 25);
     perMessageDeflate.accept([{}]);
 
-    const receiver = new Receiver({
+    const receiver = new Receiver(undefined, {
       'permessage-deflate': perMessageDeflate
     }, 25);
     const buf = Buffer.from('A'.repeat(50));
@@ -787,7 +797,7 @@ describe('Receiver', function () {
     const perMessageDeflate = new PerMessageDeflate({}, false, 25);
     perMessageDeflate.accept([{}]);
 
-    const receiver = new Receiver({
+    const receiver = new Receiver(undefined, {
       'permessage-deflate': perMessageDeflate
     }, 25);
     const buf = Buffer.from('A'.repeat(15));