17.2.0 - Bump ws dependency

Author: jondubois

package.json

@@ -18,12 +18,12 @@
     "sc-formatter": "^3.0.3",
     "stream-demux": "^8.0.0",
     "writable-consumable-stream": "^2.0.0",
-    "ws": "^7.4.6"
+    "ws": "^8.9.0"
   },
   "devDependencies": {
     "localStorage": "^1.0.3",
     "mocha": "^9.0.0",
-    "socketcluster-client": "^17.0.0"
+    "socketcluster-client": "^17.1.0"
   },
   "scripts": {
     "test": "mocha --reporter spec --timeout 3000 --slow 3000"

server.js

@@ -239,7 +239,7 @@ AGServer.prototype._handleSocketConnection = function (wsSocket, upgradeReq) {
   this.emit('handshake', {socket: agSocket});
 };
 
-AGServer.prototype.close = function () {
+AGServer.prototype.close = function (keepSocketsOpen) {
   this.isReady = false;
   return new Promise((resolve, reject) => {
     this.wsServer.close((err) => {
@@ -249,6 +249,11 @@ AGServer.prototype.close = function () {
       }
       resolve();
     });
+    if (!keepSocketsOpen) {
+      for (let socket of Object.values(this.clients)) {
+        socket.terminate();
+      }
+    }
   });
 };
 

serversocket.js

@@ -88,7 +88,8 @@ function AGServerSocket(id, server, socket, protocolVersion) {
     this.emitError(err);
   });
 
-  this.socket.on('close', (code, reason) => {
+  this.socket.on('close', (code, reasonBuffer) => {
+    let reason = reasonBuffer.toString();
     this._destroy(code, reason);
   });
 
@@ -127,7 +128,8 @@ function AGServerSocket(id, server, socket, protocolVersion) {
   this._handleOutboundPacketStream();
 
   // Receive incoming raw messages
-  this.socket.on('message', async (message, flags) => {
+  this.socket.on('message', async (messageBuffer, isBinary) => {
+    let message = isBinary ? messageBuffer : messageBuffer.toString();
     this.inboundReceivedMessageCount++;
 
     let isPong = message === pongMessage;

test/integration.js

@@ -2568,7 +2568,7 @@ describe('Integration tests', function () {
   });
 
   describe('Socket Ping/pong', function () {
-    describe('When when pingTimeoutDisabled is not set', function () {
+    describe('When pingTimeoutDisabled is not set', function () {
       beforeEach('Launch server with ping options before start', async function () {
         // Intentionally make pingInterval higher than pingTimeout, that
         // way the client will never receive a ping or send back a pong.
@@ -2628,7 +2628,7 @@ describe('Integration tests', function () {
       });
     });
 
-    describe('When when pingTimeoutDisabled is true', function () {
+    describe('When pingTimeoutDisabled is true', function () {
       beforeEach('Launch server with ping options before start', async function () {
         // Intentionally make pingInterval higher than pingTimeout, that
         // way the client will never receive a ping or send back a pong.
@@ -2687,12 +2687,67 @@ describe('Integration tests', function () {
         assert.equal(serverDisconnectionCode, null);
       });
     });
+
+    describe('When pingTimeout is greater than pingInterval', function () {
+      beforeEach('Launch server with ping options before start', async function () {
+        // Intentionally make pingInterval higher than pingTimeout, that
+        // way the client will never receive a ping or send back a pong.
+        server = socketClusterServer.listen(PORT_NUMBER, {
+          authKey: serverOptions.authKey,
+          wsEngine: WS_ENGINE,
+          pingInterval: 400,
+          pingTimeout: 1000
+        });
+        bindFailureHandlers(server);
+
+        await server.listener('ready').once();
+      });
+
+      it('Should not disconnect socket if server receives a pong from client before timeout', async function () {
+        client = socketClusterClient.create({
+          hostname: clientOptions.hostname,
+          port: PORT_NUMBER
+        });
+
+        let serverWarning = null;
+        (async () => {
+          for await (let {warning} of server.listener('warning')) {
+            serverWarning = warning;
+          }
+        })();
+
+        let serverDisconnectionCode = null;
+        (async () => {
+          for await (let event of server.listener('disconnection')) {
+            serverDisconnectionCode = event.code;
+          }
+        })();
+
+        let clientError = null;
+        (async () => {
+          for await (let {error} of client.listener('error')) {
+            clientError = error;
+          }
+        })();
+
+        let clientDisconnectCode = null;
+        (async () => {
+          for await (let event of client.listener('disconnect')) {
+            clientDisconnectCode = event.code;
+          }
+        })();
+
+        await wait(2000);
+        assert.equal(clientError, null);
+        assert.equal(clientDisconnectCode, null);
+
+        assert.equal(serverWarning, null);
+        assert.equal(serverDisconnectionCode, null);
+      });
+    });
   });
 
   describe('Middleware', function () {
-    let server;
-    let client;
-
     beforeEach('Launch server without middleware before start', async function () {
       server = socketClusterServer.listen(PORT_NUMBER, {
         authKey: serverOptions.authKey,
@@ -2709,18 +2764,6 @@ describe('Integration tests', function () {
       await server.listener('ready').once();
     });
 
-    afterEach('Close server after each middleware test', async function () {
-      if (client) {
-        client.closeAllListeners();
-        client.disconnect();
-      }
-      if (server) {
-        server.closeAllListeners();
-        server.httpServer.close();
-        await server.close();
-      }
-    });
-
     describe('MIDDLEWARE_HANDSHAKE', function () {
       describe('HANDSHAKE_WS action', function () {
         it('Delaying handshake for one client should not affect other clients', async function () {