webpack-dev-server 3.6.0 → 3.8.0

package/lib/utils/getSocketClientPath.js

@@ -0,0 +1,37 @@
+'use strict';
+
+function getSocketClientPath(options) {
+  let ClientImplementation;
+  let clientImplFound = true;
+  switch (typeof options.transportMode.client) {
+    case 'string':
+      // could be 'sockjs', 'ws', or a path that should be required
+      if (options.transportMode.client === 'sockjs') {
+        ClientImplementation = require('../../client/clients/SockJSClient');
+      } else if (options.transportMode.client === 'ws') {
+        ClientImplementation = require('../../client/clients/WebsocketClient');
+      } else {
+        try {
+          // eslint-disable-next-line import/no-dynamic-require
+          ClientImplementation = require(options.transportMode.client);
+        } catch (e) {
+          clientImplFound = false;
+        }
+      }
+      break;
+    default:
+      clientImplFound = false;
+  }
+
+  if (!clientImplFound) {
+    throw new Error(
+      "transportMode.client must be a string denoting a default implementation (e.g. 'sockjs', 'ws') or a full path to " +
+        'a JS file which exports a class extending BaseClient (webpack-dev-server/client-src/clients/BaseClient) ' +
+        'via require.resolve(...)'
+    );
+  }
+
+  return ClientImplementation.getClientPath(options);
+}
+
+module.exports = getSocketClientPath;

package/lib/utils/getSocketServerImplementation.js

@@ -3,16 +3,17 @@
 function getSocketServerImplementation(options) {
   let ServerImplementation;
   let serverImplFound = true;
-  switch (typeof options.serverMode) {
+  switch (typeof options.transportMode.server) {
     case 'string':
       // could be 'sockjs', in the future 'ws', or a path that should be required
-      if (options.serverMode === 'sockjs') {
-        // eslint-disable-next-line global-require
+      if (options.transportMode.server === 'sockjs') {
         ServerImplementation = require('../servers/SockJSServer');
+      } else if (options.transportMode.server === 'ws') {
+        ServerImplementation = require('../servers/WebsocketServer');
       } else {
         try {
-          // eslint-disable-next-line global-require, import/no-dynamic-require
-          ServerImplementation = require(options.serverMode);
+          // eslint-disable-next-line import/no-dynamic-require
+          ServerImplementation = require(options.transportMode.server);
         } catch (e) {
           serverImplFound = false;
         }
@@ -21,7 +22,7 @@ function getSocketServerImplementation(options) {
     case 'function':
       // potentially do more checks here to confirm that the user implemented this properlly
       // since errors could be difficult to understand
-      ServerImplementation = options.serverMode;
+      ServerImplementation = options.transportMode.server;
       break;
     default:
       serverImplFound = false;
@@ -29,7 +30,7 @@ function getSocketServerImplementation(options) {
 
   if (!serverImplFound) {
     throw new Error(
-      "serverMode must be a string denoting a default implementation (e.g. 'sockjs'), a full path to " +
+      "transportMode.server must be a string denoting a default implementation (e.g. 'sockjs', 'ws'), a full path to " +
         'a JS file which exports a class extending BaseServer (webpack-dev-server/lib/servers/BaseServer) ' +
         'via require.resolve(...), or the class itself which extends BaseServer'
     );

package/lib/utils/getVersions.js

@@ -1,7 +1,5 @@
 'use strict';
 
-/* eslint-disable global-require */
-
 function getVersions() {
   return (
     `webpack-dev-server ${require('../../package.json').version}\n` +

package/lib/utils/normalizeOptions.js

@@ -0,0 +1,38 @@
+'use strict';
+
+/* eslint-disable
+  no-undefined
+*/
+
+function normalizeOptions(compiler, options) {
+  // Setup default value
+  options.contentBase =
+    options.contentBase !== undefined ? options.contentBase : process.cwd();
+
+  // normalize transportMode option
+  if (options.transportMode === undefined) {
+    options.transportMode = {
+      server: 'sockjs',
+      client: 'sockjs',
+    };
+  } else {
+    switch (typeof options.transportMode) {
+      case 'string':
+        options.transportMode = {
+          server: options.transportMode,
+          client: options.transportMode,
+        };
+        break;
+      // if not a string, it is an object
+      default:
+        options.transportMode.server = options.transportMode.server || 'sockjs';
+        options.transportMode.client = options.transportMode.client || 'sockjs';
+    }
+  }
+
+  if (!options.watchOptions) {
+    options.watchOptions = {};
+  }
+}
+
+module.exports = normalizeOptions;

package/lib/utils/processOptions.js

@@ -2,6 +2,7 @@
 
 const createConfig = require('./createConfig');
 const defaultPort = require('./defaultPort');
+const findPort = require('./findPort');
 
 function processOptions(config, argv, callback) {
   // processOptions {Promise}
@@ -23,7 +24,21 @@ function processOptions(config, argv, callback) {
   // we should use portfinder.
   const options = createConfig(config, argv, { port: defaultPort });
 
-  callback(config, options);
+  if (options.socket) {
+    callback(config, options);
+  } else {
+    findPort(options.port)
+      .then((port) => {
+        options.port = port;
+        callback(config, options);
+      })
+      .catch((err) => {
+        // eslint-disable-next-line no-console
+        console.error(err.stack || err);
+        // eslint-disable-next-line no-process-exit
+        process.exit(1);
+      });
+  }
 }
 
 module.exports = processOptions;

package/lib/utils/routes.js

@@ -3,37 +3,31 @@
 const { createReadStream } = require('fs');
 const { join } = require('path');
 
+const clientBasePath = join(__dirname, '..', '..', 'client');
+
 function routes(app, middleware, options) {
   app.get('/__webpack_dev_server__/live.bundle.js', (req, res) => {
     res.setHeader('Content-Type', 'application/javascript');
 
-    createReadStream(
-      join(__dirname, '..', '..', 'client', 'live.bundle.js')
-    ).pipe(res);
+    createReadStream(join(clientBasePath, 'live.bundle.js')).pipe(res);
   });
 
   app.get('/__webpack_dev_server__/sockjs.bundle.js', (req, res) => {
     res.setHeader('Content-Type', 'application/javascript');
 
-    createReadStream(
-      join(__dirname, '..', '..', 'client', 'sockjs.bundle.js')
-    ).pipe(res);
+    createReadStream(join(clientBasePath, 'sockjs.bundle.js')).pipe(res);
   });
 
   app.get('/webpack-dev-server.js', (req, res) => {
     res.setHeader('Content-Type', 'application/javascript');
 
-    createReadStream(
-      join(__dirname, '..', '..', 'client', 'index.bundle.js')
-    ).pipe(res);
+    createReadStream(join(clientBasePath, 'index.bundle.js')).pipe(res);
   });
 
   app.get('/webpack-dev-server/*', (req, res) => {
     res.setHeader('Content-Type', 'text/html');
 
-    createReadStream(join(__dirname, '..', '..', 'client', 'live.html')).pipe(
-      res
-    );
+    createReadStream(join(clientBasePath, 'live.html')).pipe(res);
   });
 
   app.get('/webpack-dev-server', (req, res) => {
@@ -59,35 +53,27 @@ function routes(app, middleware, options) {
         const p = `${basePath}/${item}`;
 
         if (filesystem.statSync(p).isFile()) {
-          res.write('<li><a href="');
-          res.write(baseUrl + item);
-          res.write('">');
-          res.write(item);
-          res.write('</a></li>');
+          res.write(`<li><a href="${baseUrl + item}">${item}</a></li>`);
 
           if (/\.js$/.test(item)) {
             const html = item.substr(0, item.length - 3);
+            const containerHref = baseUrl + html;
 
-            res.write('<li><a href="');
-            res.write(baseUrl + html);
-            res.write('">');
-            res.write(html);
-            res.write('</a> (magic html for ');
-            res.write(item);
-            res.write(') (<a href="');
-            res.write(
+            const magicHtmlHref =
               baseUrl.replace(
                 // eslint-disable-next-line
                 /(^(https?:\/\/[^\/]+)?\/)/,
                 '$1webpack-dev-server/'
-              ) + html
+              ) + html;
+
+            res.write(
+              `<li><a href="${containerHref}">${html}</a>` +
+                ` (magic html for ${item}) (<a href="${magicHtmlHref}">webpack-dev-server</a>)` +
+                `</li>`
             );
-            res.write('">webpack-dev-server</a>)</li>');
           }
         } else {
-          res.write('<li>');
-          res.write(item);
-          res.write('<br>');
+          res.write(`<li>${item}<br>`);
 
           writeDirectory(`${baseUrl + item}/`, p);
 

package/lib/utils/runBonjour.js

@@ -1,12 +1,11 @@
 'use strict';
 
-function runBonjour(options) {
-  // eslint-disable-next-line global-require
+function runBonjour({ port }) {
   const bonjour = require('bonjour')();
 
   bonjour.publish({
     name: 'Webpack Dev Server',
-    port: options.port,
+    port,
     type: 'http',
     subtypes: ['webpack'],
   });

package/lib/utils/runOpen.js

@@ -1,17 +1,24 @@
 'use strict';
 
 const open = require('opn');
+const isAbsoluteUrl = require('is-absolute-url');
 
 function runOpen(uri, options, log) {
-  let openOptions = {};
+  // https://github.com/webpack/webpack-dev-server/issues/1990
+  let openOptions = { wait: false };
   let openMessage = 'Unable to open browser';
 
   if (typeof options.open === 'string') {
-    openOptions = { app: options.open };
+    openOptions = Object.assign({}, openOptions, { app: options.open });
     openMessage += `: ${options.open}`;
   }
 
-  open(`${uri}${options.openPage || ''}`, openOptions).catch(() => {
+  const pageUrl =
+    options.openPage && isAbsoluteUrl(options.openPage)
+      ? options.openPage
+      : `${uri}${options.openPage || ''}`;
+
+  return open(pageUrl, openOptions).catch(() => {
     log.warn(
       `${openMessage}. If you are running in a headless environment, please do not use the --open flag`
     );

package/lib/utils/setupExitSignals.js

@@ -2,11 +2,11 @@
 
 const signals = ['SIGINT', 'SIGTERM'];
 
-function setupExitSignals(server) {
+function setupExitSignals(serverData) {
   signals.forEach((signal) => {
     process.on(signal, () => {
-      if (server) {
-        server.close(() => {
+      if (serverData.server) {
+        serverData.server.close(() => {
           // eslint-disable-next-line no-process-exit
           process.exit();
         });

package/lib/utils/tryParseInt.js

@@ -2,9 +2,11 @@
 
 function tryParseInt(input) {
   const output = parseInt(input, 10);
+
   if (Number.isNaN(output)) {
     return null;
   }
+
   return output;
 }
 

package/lib/utils/updateCompiler.js

@@ -6,7 +6,7 @@
 */
 const webpack = require('webpack');
 const addEntries = require('./addEntries');
-const SockJSClient = require('./../clients/SockJSClient');
+const getSocketClientPath = require('./getSocketClientPath');
 
 function updateCompiler(compiler, options) {
   if (options.inline !== false) {
@@ -51,7 +51,7 @@ function updateCompiler(compiler, options) {
       compiler.hooks.entryOption.call(config.context, config.entry);
 
       const providePlugin = new webpack.ProvidePlugin({
-        __webpack_dev_server_client__: SockJSClient.getClientPath(options),
+        __webpack_dev_server_client__: getSocketClientPath(options),
       });
       providePlugin.apply(compiler);
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webpack-dev-server",
-  "version": "3.6.0",
+  "version": "3.8.0",
   "description": "Serves a webpack app. Updates the browser on changes.",
   "bin": "bin/webpack-dev-server.js",
   "main": "lib/Server.js",
@@ -17,19 +17,22 @@
     "lint:prettier": "prettier \"{**/*,*}.{js,json,md,yml,css}\" --list-different",
     "lint:js": "eslint . --cache",
     "lint": "npm-run-all -l -p \"lint:**\"",
+    "lint:type": "tsc --noEmit",
     "commitlint": "commitlint --from=master",
     "security": "npm audit",
-    "test:only": "jest --runInBand",
+    "test:only": "jest --forceExit",
     "test:coverage": "npm run test:only -- --coverage",
     "test:watch": "npm run test:coverage --watch",
     "test": "npm run test:coverage",
     "pretest": "npm run lint",
-    "prepare": "rimraf ./ssl/*.pem && npm run -s transpile:index && npm run -s build:live && npm run -s build:index && npm run -s build:sockjs",
-    "transpile:index": "babel client-src/default --out-dir client --ignore \"./client-src/default/*.config.js\"",
-    "build:index": "webpack ./client-src/default/index.js -o client/index.bundle.js --color --config client-src/default/webpack.config.js",
-    "build:live": "webpack ./client-src/live/index.js -o client/live.bundle.js --color --config client-src/live/webpack.config.js",
-    "build:sockjs": "webpack ./client-src/sockjs/index.js -o client/sockjs.bundle.js --color --config client-src/sockjs/webpack.config.js",
-    "webpack-dev-server": "cd $INIT_CWD && node ../../../bin/webpack-dev-server.js",
+    "prepare": "rimraf ./ssl/*.pem && npm run build:client",
+    "build:client:default": "babel client-src/default --out-dir client --ignore \"./client-src/default/*.config.js\"",
+    "build:client:clients": "babel client-src/clients --out-dir client/clients",
+    "build:client:index": "webpack ./client-src/default/index.js -o client/index.bundle.js --color --config client-src/default/webpack.config.js",
+    "build:client:live": "webpack ./client-src/live/index.js -o client/live.bundle.js --color --config client-src/live/webpack.config.js",
+    "build:client:sockjs": "webpack ./client-src/sockjs/index.js -o client/sockjs.bundle.js --color --config client-src/sockjs/webpack.config.js",
+    "build:client": "rimraf ./client/* && npm-run-all -s -l -p \"build:client:**\"",
+    "webpack-dev-server": "node examples/run-example.js",
     "release": "standard-version"
   },
   "dependencies": {
@@ -46,63 +49,69 @@
     "import-local": "^2.0.0",
     "internal-ip": "^4.3.0",
     "ip": "^1.1.5",
+    "is-absolute-url": "^3.0.0",
     "killable": "^1.0.1",
-    "loglevel": "^1.6.2",
+    "loglevel": "^1.6.3",
     "opn": "^5.5.0",
-    "portfinder": "^1.0.20",
+    "p-retry": "^3.0.1",
+    "portfinder": "^1.0.21",
     "schema-utils": "^1.0.0",
     "selfsigned": "^1.10.4",
-    "semver": "^6.1.1",
+    "semver": "^6.3.0",
     "serve-index": "^1.9.1",
     "sockjs": "0.3.19",
     "sockjs-client": "1.3.0",
-    "spdy": "^4.0.0",
+    "spdy": "^4.0.1",
     "strip-ansi": "^3.0.1",
     "supports-color": "^6.1.0",
     "url": "^0.11.0",
     "webpack-dev-middleware": "^3.7.0",
     "webpack-log": "^2.0.0",
+    "ws": "^6.2.1",
     "yargs": "12.0.5"
   },
   "devDependencies": {
-    "@babel/cli": "^7.4.4",
-    "@babel/core": "^7.4.5",
-    "@babel/preset-env": "^7.4.5",
-    "@commitlint/cli": "^7.6.1",
-    "@commitlint/config-conventional": "^7.6.0",
+    "@babel/cli": "^7.5.5",
+    "@babel/core": "^7.5.5",
+    "@babel/plugin-transform-runtime": "^7.5.5",
+    "@babel/preset-env": "^7.5.5",
+    "@babel/runtime": "^7.5.5",
+    "@commitlint/cli": "^8.1.0",
+    "@commitlint/config-conventional": "^8.1.0",
     "babel-loader": "^8.0.6",
     "body-parser": "^1.19.0",
     "commitlint-azure-pipelines-cli": "^1.0.2",
-    "copy-webpack-plugin": "^5.0.3",
+    "copy-webpack-plugin": "^5.0.4",
     "css-loader": "^2.1.1",
-    "eslint": "^5.16.0",
-    "eslint-config-prettier": "^4.3.0",
+    "eslint": "^6.1.0",
+    "eslint-config-prettier": "^6.0.0",
     "eslint-config-webpack": "^1.2.5",
-    "eslint-plugin-import": "^2.17.3",
+    "eslint-plugin-import": "^2.18.2",
     "execa": "^1.0.0",
     "file-loader": "^3.0.1",
     "html-loader": "^0.5.5",
     "html-webpack-plugin": "^3.2.0",
-    "husky": "^2.3.0",
+    "husky": "^3.0.3",
     "jest": "^24.8.0",
-    "jest-junit": "^6.4.0",
+    "jest-junit": "^7.0.0",
     "jquery": "^3.4.1",
     "less": "^3.9.0",
     "less-loader": "^5.0.0",
-    "lint-staged": "^8.1.7",
-    "marked": "^0.6.2",
-    "memfs": "^2.15.4",
+    "lint-staged": "^9.2.1",
+    "marked": "^0.7.0",
+    "memfs": "^2.15.5",
     "npm-run-all": "^4.1.5",
-    "prettier": "^1.17.1",
-    "puppeteer": "^1.17.0",
+    "prettier": "^1.18.2",
+    "puppeteer": "^1.19.0",
     "rimraf": "^2.6.3",
-    "standard-version": "^6.0.1",
-    "style-loader": "^0.23.1",
+    "standard-version": "^7.0.0",
+    "style-loader": "^1.0.0",
     "supertest": "^4.0.2",
+    "tcp-port-used": "^1.0.1",
+    "typescript": "^3.5.3",
     "url-loader": "^1.1.2",
-    "webpack": "^4.33.0",
-    "webpack-cli": "^3.3.2",
-    "ws": "^6.2.1"
+    "webpack": "^4.39.1",
+    "webpack-cli": "^3.3.6"
   },
   "peerDependencies": {
     "webpack": "^4.0.0"

package/lib/clients/BaseClient.js

@@ -1,10 +0,0 @@
-'use strict';
-
-/* eslint-disable
-  no-unused-vars
-*/
-module.exports = class BaseClient {
-  static getClientPath(options) {
-    throw new Error('Client needs implementation');
-  }
-};

package/lib/clients/SockJSClient.js

@@ -1,33 +0,0 @@
-'use strict';
-
-/* eslint-disable
-  no-unused-vars
-*/
-const SockJS = require('sockjs-client/dist/sockjs');
-const BaseClient = require('./BaseClient');
-
-module.exports = class SockJSClient extends BaseClient {
-  constructor(url) {
-    super();
-    this.sock = new SockJS(url);
-  }
-
-  static getClientPath(options) {
-    return require.resolve('./SockJSClient');
-  }
-
-  onOpen(f) {
-    this.sock.onopen = f;
-  }
-
-  onClose(f) {
-    this.sock.onclose = f;
-  }
-
-  // call f with the message string as the first argument
-  onMessage(f) {
-    this.sock.onmessage = (e) => {
-      f(e.data);
-    };
-  }
-};

package/lib/clients/WebsocketClient.js

@@ -1,5 +0,0 @@
-'use strict';
-
-const BaseClient = require('./BaseClient');
-
-module.exports = class WebsocketClient extends BaseClient {};