[major] Rename the 'headers' event to 'upgrade'

Refs: #1082 (comment)

Author: lpinca

doc/ws.md

@@ -237,15 +237,6 @@ human-readable string explaining why the connection has been closed.
 Emitted when an error occurs. Errors from the underlying `net.Socket` are
 forwarded here.
 
-### Event: 'headers'
-
-- `headers` {Object}
-- `response` {http.IncomingMessage}
-
-Emitted when response headers are received from the server as part of the
-handshake.  This allows you to read headers from the server, for example
-'set-cookie' headers.
-
 ### Event: 'message'
 
 - `data` {String|Buffer|ArrayBuffer|Buffer[]}
@@ -278,6 +269,14 @@ response. This event gives the ability to read the response in order to extract
 useful information. If the server sends an invalid response and there isn't a
 listener for this event, an error is emitted.
 
+### Event: 'upgrade'
+
+- `response` {http.IncomingMessage}
+
+Emitted when response headers are received from the server as part of the
+handshake.  This allows you to read headers from the server, for example
+'set-cookie' headers.
+
 ### websocket.addEventListener(type, listener)
 
 - `type` {String} A string representing the event type to listen for.

lib/websocket.js

@@ -679,10 +679,10 @@ function initAsClient (address, protocols, options) {
   });
 
   this._req.on('upgrade', (res, socket, head) => {
-    this.emit('headers', res.headers, res);
+    this.emit('upgrade', res);
 
     //
-    // The user may have closed the connection from a listener of the `headers`
+    // The user may have closed the connection from a listener of the `upgrade`
     // event.
     //
     if (this.readyState !== WebSocket.CONNECTING) return;

test/websocket-server.test.js

@@ -713,9 +713,9 @@ describe('WebSocketServer', function () {
         const port = wss._server.address().port;
         const ws = new WebSocket(`ws://localhost:${port}`);
 
-        ws.on('headers', (headers) => {
+        ws.on('upgrade', (res) => {
           assert.strictEqual(
-            headers['sec-websocket-extensions'],
+            res.headers['sec-websocket-extensions'],
             'permessage-deflate; client_max_window_bits=8'
           );
 

test/websocket.test.js

@@ -402,12 +402,12 @@ describe('WebSocket', function () {
       });
     });
 
-    it("emits a 'headers' event", function (done) {
+    it("emits an 'upgrade' event", function (done) {
       const wss = new WebSocket.Server({ port: 0 }, () => {
         const port = wss._server.address().port;
         const ws = new WebSocket(`ws://localhost:${port}`);
-        ws.on('headers', (headers, res) => {
-          assert.strictEqual(headers, res.headers);
+        ws.on('upgrade', (res) => {
+          assert.ok(res instanceof http.IncomingMessage);
           wss.close(done);
         });
       });
@@ -1206,7 +1206,7 @@ describe('WebSocket', function () {
       });
     });
 
-    it('can be called from a listener of the headers event', function (done) {
+    it("can be called from a listener of the 'upgrade' event", function (done) {
       const wss = new WebSocket.Server({ port: 0 }, () => {
         const port = wss._server.address().port;
         const ws = new WebSocket(`ws://localhost:${port}`);
@@ -1220,7 +1220,7 @@ describe('WebSocket', function () {
           );
           ws.on('close', () => wss.close(done));
         });
-        ws.on('headers', () => ws.close());
+        ws.on('upgrade', () => ws.close());
       });
     });
 
@@ -1479,7 +1479,7 @@ describe('WebSocket', function () {
       });
     });
 
-    it('can be called from a listener of the headers event', function (done) {
+    it("can be called from a listener of the 'upgrade' event", function (done) {
       const wss = new WebSocket.Server({ port: 0 }, () => {
         const port = wss._server.address().port;
         const ws = new WebSocket(`ws://localhost:${port}`);
@@ -1493,7 +1493,7 @@ describe('WebSocket', function () {
           );
           ws.on('close', () => wss.close(done));
         });
-        ws.on('headers', () => ws.terminate());
+        ws.on('upgrade', () => ws.terminate());
       });
     });