refactor(server): encapsulate socket server implementation (#1904)

lib/Server.js

@@ -12,7 +12,6 @@ const url = require('url');
 const http = require('http');
 const https = require('https');
 const ip = require('ip');
-const sockjs = require('sockjs');
 const semver = require('semver');
 const killable = require('killable');
 const chokidar = require('chokidar');
@@ -32,26 +31,7 @@ const createDomain = require('./utils/createDomain');
 const runBonjour = require('./utils/runBonjour');
 const routes = require('./utils/routes');
 const schema = require('./options.json');
-
-// Workaround for sockjs@~0.3.19
-// sockjs will remove Origin header, however Origin header is required for checking host.
-// See https://github.com/webpack/webpack-dev-server/issues/1604 for more information
-{
-  // eslint-disable-next-line global-require
-  const SockjsSession = require('sockjs/lib/transport').Session;
-  const decorateConnection = SockjsSession.prototype.decorateConnection;
-  SockjsSession.prototype.decorateConnection = function(req) {
-    decorateConnection.call(this, req);
-    const connection = this.connection;
-    if (
-      connection.headers &&
-      !('origin' in connection.headers) &&
-      'origin' in req.headers
-    ) {
-      connection.headers.origin = req.headers.origin;
-    }
-  };
-}
+const SockJSServer = require('./servers/SockJSServer');
 
 // Workaround for node ^8.6.0, ^9.0.0
 // DEFAULT_ECDH_CURVE is default to prime256v1 in these version
@@ -671,20 +651,9 @@ class Server {
   }
 
   createSocketServer() {
-    const socket = sockjs.createServer({
-      // Use provided up-to-date sockjs-client
-      sockjs_url: '/__webpack_dev_server__/sockjs.bundle.js',
-      // Limit useless logs
-      log: (severity, line) => {
-        if (severity === 'error') {
-          this.log.error(line);
-        } else {
-          this.log.debug(line);
-        }
-      },
-    });
+    this.socketServer = new SockJSServer(this);
 
-    socket.on('connection', (connection) => {
+    this.socketServer.onConnection((connection) => {
       if (!connection) {
         return;
       }
@@ -736,10 +705,6 @@ class Server {
 
       this._sendStats([connection], this.getStats(this._stats), true);
     });
-
-    socket.installHandlers(this.listeningApp, {
-      prefix: this.sockPath,
-    });
   }
 
   listen(port, hostname, fn) {
@@ -762,7 +727,7 @@ class Server {
 
   close(cb) {
     this.sockets.forEach((socket) => {
-      socket.close();
+      this.socketServer.close(socket);
     });
 
     this.sockets = [];
@@ -923,7 +888,7 @@ class Server {
   // eslint-disable-next-line
   sockWrite(sockets, type, data) {
     sockets.forEach((socket) => {
-      socket.write(JSON.stringify({ type, data }));
+      this.socketServer.send(socket, JSON.stringify({ type, data }));
     });
   }
 

lib/servers/BaseServer.js

@@ -0,0 +1,9 @@
+'use strict';
+
+// base class that users should extend if they are making their own
+// server implementation
+module.exports = class BaseServer {
+  constructor(server) {
+    this.server = server;
+  }
+};

lib/servers/SockJSServer.js

@@ -0,0 +1,64 @@
+'use strict';
+
+/* eslint-disable
+  class-methods-use-this,
+  func-names
+*/
+const sockjs = require('sockjs');
+const BaseServer = require('./BaseServer');
+
+// Workaround for sockjs@~0.3.19
+// sockjs will remove Origin header, however Origin header is required for checking host.
+// See https://github.com/webpack/webpack-dev-server/issues/1604 for more information
+{
+  // eslint-disable-next-line global-require
+  const SockjsSession = require('sockjs/lib/transport').Session;
+  const decorateConnection = SockjsSession.prototype.decorateConnection;
+  SockjsSession.prototype.decorateConnection = function(req) {
+    decorateConnection.call(this, req);
+    const connection = this.connection;
+    if (
+      connection.headers &&
+      !('origin' in connection.headers) &&
+      'origin' in req.headers
+    ) {
+      connection.headers.origin = req.headers.origin;
+    }
+  };
+}
+
+module.exports = class SockJSServer extends BaseServer {
+  // options has: error (function), debug (function), server (http/s server), path (string)
+  constructor(server) {
+    super(server);
+    this.socket = sockjs.createServer({
+      // Use provided up-to-date sockjs-client
+      sockjs_url: '/__webpack_dev_server__/sockjs.bundle.js',
+      // Limit useless logs
+      log: (severity, line) => {
+        if (severity === 'error') {
+          this.server.log.error(line);
+        } else {
+          this.server.log.debug(line);
+        }
+      },
+    });
+
+    this.socket.installHandlers(this.server.listeningApp, {
+      prefix: this.server.sockPath,
+    });
+  }
+
+  send(connection, message) {
+    connection.write(message);
+  }
+
+  close(connection) {
+    connection.close();
+  }
+
+  // f should return the resulting connection
+  onConnection(f) {
+    this.socket.on('connection', f);
+  }
+};

lib/servers/WebsocketServer.js

@@ -0,0 +1,8 @@
+'use strict';
+
+// const ws = require('ws');
+const BaseServer = require('./BaseServer');
+
+// ws server implementation under construction
+// will need changes in the client as well to function
+module.exports = class WebsocketServer extends BaseServer {};

lib/servers/baseServer.js

@@ -0,0 +1,9 @@
+'use strict';
+
+// base class that users should extend if they are making their own
+// server implementation
+module.exports = class BaseServer {
+  constructor(server) {
+    this.server = server;
+  }
+};

lib/servers/sockjsServer.js

@@ -0,0 +1,64 @@
+'use strict';
+
+/* eslint-disable
+  class-methods-use-this,
+  func-names
+*/
+const sockjs = require('sockjs');
+const BaseServer = require('./BaseServer');
+
+// Workaround for sockjs@~0.3.19
+// sockjs will remove Origin header, however Origin header is required for checking host.
+// See https://github.com/webpack/webpack-dev-server/issues/1604 for more information
+{
+  // eslint-disable-next-line global-require
+  const SockjsSession = require('sockjs/lib/transport').Session;
+  const decorateConnection = SockjsSession.prototype.decorateConnection;
+  SockjsSession.prototype.decorateConnection = function(req) {
+    decorateConnection.call(this, req);
+    const connection = this.connection;
+    if (
+      connection.headers &&
+      !('origin' in connection.headers) &&
+      'origin' in req.headers
+    ) {
+      connection.headers.origin = req.headers.origin;
+    }
+  };
+}
+
+module.exports = class SockJSServer extends BaseServer {
+  // options has: error (function), debug (function), server (http/s server), path (string)
+  constructor(server) {
+    super(server);
+    this.socket = sockjs.createServer({
+      // Use provided up-to-date sockjs-client
+      sockjs_url: '/__webpack_dev_server__/sockjs.bundle.js',
+      // Limit useless logs
+      log: (severity, line) => {
+        if (severity === 'error') {
+          this.server.log.error(line);
+        } else {
+          this.server.log.debug(line);
+        }
+      },
+    });
+
+    this.socket.installHandlers(this.server.listeningApp, {
+      prefix: this.server.sockPath,
+    });
+  }
+
+  send(connection, message) {
+    connection.write(message);
+  }
+
+  close(connection) {
+    connection.close();
+  }
+
+  // f should return the resulting connection
+  onConnection(f) {
+    this.socket.on('connection', f);
+  }
+};