Encapsulate sockjs, introduce ws and build base for users to make own server implementation

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,6 +31,7 @@ const createDomain = require('./utils/createDomain');
 const runBonjour = require('./utils/runBonjour');
 const routes = require('./utils/routes');
 const schema = require('./options.json');
+const SockjsServer = require('./utils/server/sockjsServer');
 
 // Workaround for sockjs@~0.3.19
 // sockjs will remove Origin header, however Origin header is required for checking host.
@@ -674,20 +674,15 @@ 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);
-        }
-      },
+    const socket = new SockjsServer({
+      error: this.log.error.bind(this),
+      debug: this.log.debug.bind(this),
+      server: this.listeningApp,
+      path: this.sockPath,
     });
+    this.socketServer = socket;
 
-    socket.on('connection', (connection) => {
+    socket.onConnection((connection) => {
       if (!connection) {
         return;
       }
@@ -739,10 +734,6 @@ class Server {
 
       this._sendStats([connection], this.getStats(this._stats), true);
     });
-
-    socket.installHandlers(this.listeningApp, {
-      prefix: this.sockPath,
-    });
   }
 
   listen(port, hostname, fn) {
@@ -765,7 +756,7 @@ class Server {
 
   close(cb) {
     this.sockets.forEach((socket) => {
-      socket.close();
+      this.socketServer.close(socket);
     });
 
     this.sockets = [];
@@ -926,7 +917,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/utils/server/baseServer.js

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

lib/utils/server/sockjsServer.js

@@ -0,0 +1,43 @@
+'use strict';
+
+/* eslint-disable
+  class-methods-use-this
+*/
+const sockjs = require('sockjs');
+const BaseServer = require('./baseServer');
+
+module.exports = class SockjsServer extends BaseServer {
+  // options has: error (function), debug (function), server (http/s server), path (string)
+  constructor(options) {
+    super();
+    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') {
+          options.error(line);
+        } else {
+          options.debug(line);
+        }
+      },
+    });
+
+    this.socket.installHandlers(options.server, {
+      prefix: options.path,
+    });
+  }
+
+  send(connection, message) {
+    connection.write(message);
+  }
+
+  close(connection) {
+    connection.close();
+  }
+
+  // f should return the resulting connection
+  onConnection(f) {
+    this.socket.on('connection', f);
+  }
+};

lib/utils/server/wsServer.js

@@ -0,0 +1,11 @@
+'use strict';
+
+/* eslint-disable
+  no-unused-vars
+*/
+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 WSServer extends BaseServer {};

package.json

@@ -62,6 +62,7 @@
     "url": "^0.11.0",
     "webpack-dev-middleware": "^3.7.0",
     "webpack-log": "^2.0.0",
+    "ws": "^6.2.1",
     "yargs": "12.0.5"
   },
   "devDependencies": {
@@ -101,8 +102,7 @@
     "supertest": "^4.0.2",
     "url-loader": "^1.1.2",
     "webpack": "^4.31.0",
-    "webpack-cli": "^3.3.2",
-    "ws": "^6.2.1"
+    "webpack-cli": "^3.3.2"
   },
   "peerDependencies": {
     "webpack": "^4.0.0"