fix(Socket): prevent sockets from leaking (obs-websocket-community-projects#191)

Closes obs-websocket-community-projects#188

Author: The-Clockmaker

lib/Socket.js

@@ -23,8 +23,16 @@ class Socket extends EventEmitter {
     args = args || {};
     const address = args.address || 'localhost:4444';
 
-    if (this._connected) {
-      this._socket.close();
+    if (this._socket) {
+      try {
+        // Blindly try to close the socket.
+        // Don't care if its already closed.
+        // We just don't want any sockets to leak.
+        this._socket.close();
+      } catch (error) {
+        // These errors are probably safe to ignore, but debug log them just in case.
+        debug('Failed to close previous WebSocket:', error.message);
+      }
     }
 
     // eslint-disable-next-line no-async-promise-executor

test/auth.spec.js

@@ -2,6 +2,7 @@ const test = require('ava');
 const env = require('./setup/environment');
 const OBSWebSocket = require('..');
 const SHA256 = require('sha.js/sha256');
+const WebSocket = require('ws');
 
 let unauthServer;
 let authServer;
@@ -227,3 +228,23 @@ test('closes an existing connection when `connect` is called again', async t =>
 
   t.true(open);
 });
+
+test('closes in-flight sockets when `connect` is called', async t => {
+  const obs = new OBSWebSocket();
+  obs._connected = false;
+
+  // A minimal stub of a socket that is currently connecting.
+  let closeCalled = 0;
+  obs._socket = {
+    readyState: WebSocket.CONNECTING,
+    close() {
+      closeCalled++;
+    }
+  };
+
+  await t.notThrowsAsync(obs.connect({
+    address: 'localhost:4444'
+  }));
+
+  t.is(closeCalled, 1);
+});