webpack-dev-server 3.5.0 → 3.7.1

package/client/socket.js

@@ -1,24 +1,26 @@
 'use strict';
+/* global __webpack_dev_server_client__ */
 
-var SockJS = require('sockjs-client/dist/sockjs');
+/* eslint-disable
+  camelcase
+*/
 
+var Client = __webpack_dev_server_client__;
 var retries = 0;
-var sock = null;
+var client = null;
 
 var socket = function initSocket(url, handlers) {
-  sock = new SockJS(url);
-
-  sock.onopen = function onopen() {
+  client = new Client(url);
+  client.onOpen(function () {
     retries = 0;
-  };
-
-  sock.onclose = function onclose() {
+  });
+  client.onClose(function () {
     if (retries === 0) {
       handlers.close();
     } // Try to reconnect.
 
 
-    sock = null; // After 10 retries stop trying, to prevent logspam.
+    client = null; // After 10 retries stop trying, to prevent logspam.
 
     if (retries <= 10) {
       // Exponentially increase timeout to reconnect.
@@ -30,16 +32,14 @@ var socket = function initSocket(url, handlers) {
         socket(url, handlers);
       }, retryInMs);
     }
-  };
-
-  sock.onmessage = function onmessage(e) {
-    // This assumes that all data sent via the websocket is JSON.
-    var msg = JSON.parse(e.data);
+  });
+  client.onMessage(function (data) {
+    var msg = JSON.parse(data);
 
     if (handlers[msg.type]) {
       handlers[msg.type](msg.data);
     }
-  };
+  });
 };
 
 module.exports = socket;

package/client/utils/createSocketUrl.js

@@ -0,0 +1,78 @@
+'use strict';
+/* global self */
+
+var url = require('url');
+
+var querystring = require('querystring');
+
+var getCurrentScriptSource = require('./getCurrentScriptSource');
+
+function createSocketUrl(resourceQuery) {
+  var urlParts;
+
+  if (typeof resourceQuery === 'string' && resourceQuery !== '') {
+    // If this bundle is inlined, use the resource query to get the correct url.
+    urlParts = url.parse(resourceQuery.substr(1));
+  } else {
+    // Else, get the url from the <script> this file was called with.
+    var scriptHost = getCurrentScriptSource(); // eslint-disable-next-line no-useless-escape
+
+    scriptHost = scriptHost.replace(/\/[^\/]+$/, '');
+    urlParts = url.parse(scriptHost || '/', false, true);
+  }
+
+  if (!urlParts.port || urlParts.port === '0') {
+    urlParts.port = self.location.port;
+  }
+
+  var _urlParts = urlParts,
+      auth = _urlParts.auth,
+      path = _urlParts.path;
+  var _urlParts2 = urlParts,
+      hostname = _urlParts2.hostname,
+      protocol = _urlParts2.protocol; // check ipv4 and ipv6 `all hostname`
+  // why do we need this check?
+  // hostname n/a for file protocol (example, when using electron, ionic)
+  // see: https://github.com/webpack/webpack-dev-server/pull/384
+
+  if ((hostname === '0.0.0.0' || hostname === '::') && self.location.hostname && // eslint-disable-next-line no-bitwise
+  !!~self.location.protocol.indexOf('http')) {
+    hostname = self.location.hostname;
+  } // `hostname` can be empty when the script path is relative. In that case, specifying
+  // a protocol would result in an invalid URL.
+  // When https is used in the app, secure websockets are always necessary
+  // because the browser doesn't accept non-secure websockets.
+
+
+  if (hostname && (self.location.protocol === 'https:' || urlParts.hostname === '0.0.0.0')) {
+    protocol = self.location.protocol;
+  } // default values of the sock url if they are not provided
+
+
+  var sockHost = hostname;
+  var sockPath = '/sockjs-node';
+  var sockPort = urlParts.port; // eslint-disable-next-line no-undefined
+
+  if (path !== null && path !== undefined && path !== '/') {
+    var parsedQuery = querystring.parse(path); // all of these sock url params are optionally passed in through
+    // resourceQuery, so we need to fall back to the default if
+    // they are not provided
+
+    sockHost = parsedQuery.sockHost || sockHost;
+    sockPath = parsedQuery.sockPath || sockPath;
+    sockPort = parsedQuery.sockPort || sockPort;
+  }
+
+  return url.format({
+    protocol: protocol,
+    auth: auth,
+    hostname: sockHost,
+    port: sockPort,
+    // If sockPath is provided it'll be passed in via the resourceQuery as a
+    // query param so it has to be parsed out of the querystring in order for the
+    // client to open the socket to the correct location.
+    pathname: sockPath
+  });
+}
+
+module.exports = createSocketUrl;

package/client/utils/getCurrentScriptSource.js

@@ -0,0 +1,22 @@
+'use strict';
+
+function getCurrentScriptSource() {
+  // `document.currentScript` is the most accurate way to find the current script,
+  // but is not supported in all browsers.
+  if (document.currentScript) {
+    return document.currentScript.getAttribute('src');
+  } // Fall back to getting all scripts in the document.
+
+
+  var scriptElements = document.scripts || [];
+  var currentScript = scriptElements[scriptElements.length - 1];
+
+  if (currentScript) {
+    return currentScript.getAttribute('src');
+  } // Fail as there was no script to use.
+
+
+  throw new Error('[WDS] Failed to get current script source.');
+}
+
+module.exports = getCurrentScriptSource;

package/client/utils/log.js

@@ -0,0 +1,49 @@
+'use strict';
+
+var log = require('loglevel').getLogger('webpack-dev-server');
+
+var INFO = 'info';
+var WARN = 'warn';
+var ERROR = 'error';
+var DEBUG = 'debug';
+var TRACE = 'trace';
+var SILENT = 'silent'; // deprecated
+// TODO: remove these at major released
+// https://github.com/webpack/webpack-dev-server/pull/1825
+
+var WARNING = 'warning';
+var NONE = 'none'; // Set the default log level
+
+log.setDefaultLevel(INFO);
+
+function setLogLevel(level) {
+  switch (level) {
+    case INFO:
+    case WARN:
+    case ERROR:
+    case DEBUG:
+    case TRACE:
+      log.setLevel(level);
+      break;
+    // deprecated
+
+    case WARNING:
+      // loglevel's warning name is different from webpack's
+      log.setLevel('warn');
+      break;
+    // deprecated
+
+    case NONE:
+    case SILENT:
+      log.disableAll();
+      break;
+
+    default:
+      log.error("[WDS] Unknown clientLogLevel '".concat(level, "'"));
+  }
+}
+
+module.exports = {
+  log: log,
+  setLogLevel: setLogLevel
+};

package/client/utils/reloadApp.js

@@ -0,0 +1,55 @@
+'use strict';
+/* global WorkerGlobalScope self */
+
+var _require = require('./log'),
+    log = _require.log;
+
+function reloadApp(_ref, _ref2) {
+  var hotReload = _ref.hotReload,
+      hot = _ref.hot,
+      liveReload = _ref.liveReload;
+  var isUnloading = _ref2.isUnloading,
+      currentHash = _ref2.currentHash;
+
+  if (isUnloading || !hotReload) {
+    return;
+  }
+
+  if (hot) {
+    log.info('[WDS] App hot update...'); // eslint-disable-next-line global-require
+
+    var hotEmitter = require('webpack/hot/emitter');
+
+    hotEmitter.emit('webpackHotUpdate', currentHash);
+
+    if (typeof self !== 'undefined' && self.window) {
+      // broadcast update to window
+      self.postMessage("webpackHotUpdate".concat(currentHash), '*');
+    }
+  } // allow refreshing the page only if liveReload isn't disabled
+  else if (liveReload) {
+      var rootWindow = self; // use parent window for reload (in case we're in an iframe with no valid src)
+
+      var intervalId = self.setInterval(function () {
+        if (rootWindow.location.protocol !== 'about:') {
+          // reload immediately if protocol is valid
+          applyReload(rootWindow, intervalId);
+        } else {
+          rootWindow = rootWindow.parent;
+
+          if (rootWindow.parent === rootWindow) {
+            // if parent equals current window we've reached the root which would continue forever, so trigger a reload anyways
+            applyReload(rootWindow, intervalId);
+          }
+        }
+      });
+    }
+
+  function applyReload(rootWindow, intervalId) {
+    clearInterval(intervalId);
+    log.info('[WDS] App updated. Reloading...');
+    rootWindow.location.reload();
+  }
+}
+
+module.exports = reloadApp;

package/client/utils/sendMessage.js

@@ -0,0 +1,14 @@
+'use strict';
+/* global __resourceQuery WorkerGlobalScope self */
+// Send messages to the outside, so plugins can consume it.
+
+function sendMsg(type, data) {
+  if (typeof self !== 'undefined' && (typeof WorkerGlobalScope === 'undefined' || !(self instanceof WorkerGlobalScope))) {
+    self.postMessage({
+      type: "webpack".concat(type),
+      data: data
+    }, '*');
+  }
+}
+
+module.exports = sendMsg;

package/lib/Server.js

@@ -30,8 +30,8 @@ const status = require('./utils/status');
 const createDomain = require('./utils/createDomain');
 const runBonjour = require('./utils/runBonjour');
 const routes = require('./utils/routes');
+const getSocketServerImplementation = require('./utils/getSocketServerImplementation');
 const schema = require('./options.json');
-const SockJSServer = require('./servers/SockJSServer');
 
 // Workaround for node ^8.6.0, ^9.0.0
 // DEFAULT_ECDH_CURVE is default to prime256v1 in these version
@@ -67,6 +67,19 @@ class Server {
 
     this.log = _log || createLogger(options);
 
+    if (this.options.serverMode === undefined) {
+      this.options.serverMode = 'sockjs';
+    } else {
+      this.log.warn(
+        'serverMode is an experimental option, meaning its usage could potentially change without warning'
+      );
+    }
+
+    // this.SocketServerImplementation is a class, so it must be instantiated before use
+    this.socketServerImplementation = getSocketServerImplementation(
+      this.options
+    );
+
     this.originalStats =
       this.options.stats && Object.keys(this.options.stats).length
         ? this.options.stats
@@ -92,11 +105,8 @@ class Server {
     if (!this.options.watchOptions) {
       this.options.watchOptions = {};
     }
-    // Ignoring node_modules folder by default
-    this.options.watchOptions.ignored = this.options.watchOptions.ignored || [
-      /node_modules/,
-    ];
-    this.watchOptions = this.options.watchOptions;
+
+    this.watchOptions = options.watchOptions || {};
 
     // Replace leading and trailing slashes to normalize path
     this.sockPath = `/${
@@ -655,7 +665,8 @@ class Server {
   }
 
   createSocketServer() {
-    this.socketServer = new SockJSServer(this);
+    const SocketServerImplementation = this.socketServerImplementation;
+    this.socketServer = new SocketServerImplementation(this);
 
     this.socketServer.onConnection((connection) => {
       if (!connection) {
@@ -683,10 +694,15 @@ class Server {
         }
       });
 
+      if (this.clientLogLevel) {
+        this.sockWrite([connection], 'log-level', this.clientLogLevel);
+      }
+
       if (this.hot) {
         this.sockWrite([connection], 'hot');
       }
 
+      // TODO: change condition at major version
       if (this.options.liveReload !== false) {
         this.sockWrite([connection], 'liveReload', this.options.liveReload);
       }
@@ -699,10 +715,6 @@ class Server {
         this.sockWrite([connection], 'overlay', this.clientOverlay);
       }
 
-      if (this.clientLogLevel) {
-        this.sockWrite([connection], 'log-level', this.clientLogLevel);
-      }
-
       if (!this._stats) {
         return;
       }
@@ -711,6 +723,21 @@ class Server {
     });
   }
 
+  showStatus() {
+    const suffix =
+      this.options.inline !== false || this.options.lazy === true
+        ? '/'
+        : '/webpack-dev-server/';
+    const uri = `${createDomain(this.options, this.listeningApp)}${suffix}`;
+
+    status(
+      uri,
+      this.options,
+      this.log,
+      this.options.stats && this.options.stats.colors
+    );
+  }
+
   listen(port, hostname, fn) {
     this.hostname = hostname;
 
@@ -878,21 +905,6 @@ class Server {
     return false;
   }
 
-  showStatus() {
-    const suffix =
-      this.options.inline !== false || this.options.lazy === true
-        ? '/'
-        : '/webpack-dev-server/';
-    const uri = `${createDomain(this.options, this.listeningApp)}${suffix}`;
-
-    status(
-      uri,
-      this.options,
-      this.log,
-      this.options.stats && this.options.stats.colors
-    );
-  }
-
   // eslint-disable-next-line
   sockWrite(sockets, type, data) {
     sockets.forEach((socket) => {

package/lib/options.json

@@ -297,6 +297,16 @@
     "serveIndex": {
       "type": "boolean"
     },
+    "serverMode": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "instanceof": "Function"
+        }
+      ]
+    },
     "serverSideRender": {
       "type": "boolean"
     },
@@ -394,8 +404,8 @@
       "http2": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverhttp2)",
       "https": "should be {Object|Boolean} (https://webpack.js.org/configuration/dev-server/#devserverhttps)",
       "index": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserverindex)",
-      "injectClient": "should be {Boolean|Function}",
-      "injectHot": "should be {Boolean|Function}",
+      "injectClient": "should be {Boolean|Function} (https://webpack.js.org/configuration/dev-server/#devserverinjectclient)",
+      "injectHot": "should be {Boolean|Function} (https://webpack.js.org/configuration/dev-server/#devserverinjecthot)",
       "inline": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverinline)",
       "key": "should be {String|Buffer}",
       "lazy": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverlazy-)",
@@ -420,6 +430,7 @@
       "reporter": "should be {Function} (https://github.com/webpack/webpack-dev-middleware#reporter)",
       "requestCert": "should be {Boolean}",
       "serveIndex": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverserveindex)",
+      "serverMode": "should be {String|Function} (https://webpack.js.org/configuration/dev-server/#devserverservermode-)",
       "serverSideRender": "should be {Boolean} (https://github.com/webpack/webpack-dev-middleware#serversiderender)",
       "setup": "should be {Function} (https://webpack.js.org/configuration/dev-server/#devserversetup)",
       "sockHost": "should be {String|Null} (https://webpack.js.org/configuration/dev-server/#devserversockhost)",

package/lib/utils/createConfig.js

@@ -50,6 +50,10 @@ function createConfig(config, argv, { port }) {
     options.progress = argv.progress;
   }
 
+  if (argv.overlay) {
+    options.overlay = argv.overlay;
+  }
+
   if (!options.publicPath) {
     // eslint-disable-next-line
     options.publicPath =

package/lib/utils/createLogger.js

@@ -2,7 +2,7 @@
 
 const log = require('webpack-log');
 
-function createLogger(options) {
+function createLogger(options = {}) {
   let level = options.logLevel || 'info';
 
   if (options.noInfo === true) {

package/lib/utils/findPort.js

@@ -1,12 +1,26 @@
 'use strict';
 
-const { getPortPromise } = require('portfinder');
+const pRetry = require('p-retry');
+const portfinder = require('portfinder');
 const defaultPort = require('./defaultPort');
 const defaultTo = require('./defaultTo');
 const tryParseInt = require('./tryParseInt');
 
+function runPortFinder() {
+  return new Promise((resolve, reject) => {
+    portfinder.basePort = defaultPort;
+    portfinder.getPort((error, port) => {
+      if (error) {
+        return reject(error);
+      }
+
+      return resolve(port);
+    });
+  });
+}
+
 function findPort(port) {
-  if (typeof port !== 'undefined') {
+  if (port) {
     return Promise.resolve(port);
   }
 
@@ -19,10 +33,7 @@ function findPort(port) {
     3
   );
 
-  return getPortPromise({
-    port: defaultPort,
-    stopPort: defaultPort + defaultPortRetry,
-  });
+  return pRetry(runPortFinder, { retries: defaultPortRetry });
 }
 
 module.exports = findPort;

package/lib/utils/getSocketServerImplementation.js

@@ -0,0 +1,41 @@
+'use strict';
+
+function getSocketServerImplementation(options) {
+  let ServerImplementation;
+  let serverImplFound = true;
+  switch (typeof options.serverMode) {
+    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
+        ServerImplementation = require('../servers/SockJSServer');
+      } else {
+        try {
+          // eslint-disable-next-line global-require, import/no-dynamic-require
+          ServerImplementation = require(options.serverMode);
+        } catch (e) {
+          serverImplFound = false;
+        }
+      }
+      break;
+    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;
+      break;
+    default:
+      serverImplFound = false;
+  }
+
+  if (!serverImplFound) {
+    throw new Error(
+      "serverMode must be a string denoting a default implementation (e.g. 'sockjs'), 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'
+    );
+  }
+
+  return ServerImplementation;
+}
+
+module.exports = getSocketServerImplementation;

package/lib/utils/processOptions.js

@@ -6,12 +6,14 @@ const defaultPort = require('./defaultPort');
 function processOptions(config, argv, callback) {
   // processOptions {Promise}
   if (typeof config.then === 'function') {
-    config.then(processOptions).catch((err) => {
-      // eslint-disable-next-line no-console
-      console.error(err.stack || err);
-      // eslint-disable-next-line no-process-exit
-      process.exit();
-    });
+    config
+      .then((conf) => processOptions(conf, argv, callback))
+      .catch((err) => {
+        // eslint-disable-next-line no-console
+        console.error(err.stack || err);
+        // eslint-disable-next-line no-process-exit
+        process.exit(1);
+      });
 
     return;
   }

package/lib/utils/runOpen.js

@@ -0,0 +1,21 @@
+'use strict';
+
+const open = require('opn');
+
+function runOpen(uri, options, log) {
+  let openOptions = {};
+  let openMessage = 'Unable to open browser';
+
+  if (typeof options.open === 'string') {
+    openOptions = { app: options.open };
+    openMessage += `: ${options.open}`;
+  }
+
+  return open(`${uri}${options.openPage || ''}`, openOptions).catch(() => {
+    log.warn(
+      `${openMessage}. If you are running in a headless environment, please do not use the --open flag`
+    );
+  });
+}
+
+module.exports = runOpen;

package/lib/utils/status.js

@@ -1,7 +1,7 @@
 'use strict';
 
-const open = require('opn');
 const colors = require('./colors');
+const runOpen = require('./runOpen');
 
 // TODO: don't emit logs when webpack-dev-server is used via Node.js API
 function status(uri, options, log, useColor) {
@@ -44,19 +44,7 @@ function status(uri, options, log, useColor) {
   }
 
   if (options.open) {
-    let openOptions = {};
-    let openMessage = 'Unable to open browser';
-
-    if (typeof options.open === 'string') {
-      openOptions = { app: options.open };
-      openMessage += `: ${options.open}`;
-    }
-
-    open(`${uri}${options.openPage || ''}`, openOptions).catch(() => {
-      log.warn(
-        `${openMessage}. If you are running in a headless environment, please do not use the --open flag`
-      );
-    });
+    runOpen(uri, options, log);
   }
 }
 

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

@@ -48,6 +48,14 @@ function updateCompiler(compiler, options) {
     compilers.forEach((compiler) => {
       const config = compiler.options;
       compiler.hooks.entryOption.call(config.context, config.entry);
+
+      const providePlugin = new webpack.ProvidePlugin({
+        // SockJSClient.getClientPath(options)
+        __webpack_dev_server_client__: require.resolve(
+          '../../client/clients/SockJSClient.js'
+        ),
+      });
+      providePlugin.apply(compiler);
     });
 
     // do not apply the plugin unless it didn't exist before.