fix(server): Remove Socket.IO listeners

Not removing Socket.IO listeners can cause memory issues in long running processes that spawn many Karma instance. Fixes karma-runner#2980
briandipalma · Apr 23, 2018 · 10993bd · 10993bd
1 parent dae189d
commit 10993bd
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/lib/server.js b/lib/server.js
@@ -425,6 +425,10 @@ Server.prototype._start = function (config, launcher, preprocess, fileList,
     }
 
     self.emitAsync('exit').then(function () {
+      // Remove Socket.IO listeners. `connection` callback closes over `Server`
+      // instance so it leaks Plugin state e.g. Webpack compilations.
+      socketServer.sockets.removeAllListeners()
+      socketServer.close()
       // don't wait forever on webServer.close() because
       // pending client connections prevent it from closing.
       var closeTimeout = setTimeout(removeAllListeners, webServerCloseTimeout)

diff --git a/test/unit/server.spec.js b/test/unit/server.spec.js
@@ -65,13 +65,15 @@ describe('server', () => {
     }
 
     mockSocketServer = {
+      close: () => {},
       flashPolicyServer: {
         close: () => {}
       },
       sockets: {
         sockets: {},
         on: () => {},
-        emit: () => {}
+        emit: () => {},
+        removeAllListeners: () => {}
       }
     }