webpack-dev-server 3.3.1 → 3.5.1

package/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 {};

package/lib/utils/addEntries.js

@@ -16,28 +16,34 @@ function addEntries(config, options, server) {
     };
 
     const domain = createDomain(options, app);
+    const sockHost = options.sockHost ? `&sockHost=${options.sockHost}` : '';
     const sockPath = options.sockPath ? `&sockPath=${options.sockPath}` : '';
-    const entries = [
-      `${require.resolve('../../client/')}?${domain}${sockPath}`,
-    ];
+    const sockPort = options.sockPort ? `&sockPort=${options.sockPort}` : '';
+    const clientEntry = `${require.resolve(
+      '../../client/'
+    )}?${domain}${sockHost}${sockPath}${sockPort}`;
+    let hotEntry;
 
     if (options.hotOnly) {
-      entries.push(require.resolve('webpack/hot/only-dev-server'));
+      hotEntry = require.resolve('webpack/hot/only-dev-server');
     } else if (options.hot) {
-      entries.push(require.resolve('webpack/hot/dev-server'));
+      hotEntry = require.resolve('webpack/hot/dev-server');
     }
 
-    const prependEntry = (entry) => {
-      if (typeof entry === 'function') {
-        return () => Promise.resolve(entry()).then(prependEntry);
+    const prependEntry = (originalEntry, additionalEntries) => {
+      if (typeof originalEntry === 'function') {
+        return () =>
+          Promise.resolve(originalEntry()).then((entry) =>
+            prependEntry(entry, additionalEntries)
+          );
       }
 
-      if (typeof entry === 'object' && !Array.isArray(entry)) {
+      if (typeof originalEntry === 'object' && !Array.isArray(originalEntry)) {
         const clone = {};
 
-        Object.keys(entry).forEach((key) => {
+        Object.keys(originalEntry).forEach((key) => {
           // entry[key] should be a string here
-          clone[key] = prependEntry(entry[key]);
+          clone[key] = prependEntry(originalEntry[key], additionalEntries);
         });
 
         return clone;
@@ -45,8 +51,8 @@ function addEntries(config, options, server) {
 
       // in this case, entry is a string or an array.
       // make sure that we do not add duplicates.
-      const entriesClone = entries.slice(0);
-      [].concat(entry).forEach((newEntry) => {
+      const entriesClone = additionalEntries.slice(0);
+      [].concat(originalEntry).forEach((newEntry) => {
         if (!entriesClone.includes(newEntry)) {
           entriesClone.push(newEntry);
         }
@@ -54,9 +60,34 @@ function addEntries(config, options, server) {
       return entriesClone;
     };
 
+    // eslint-disable-next-line no-shadow
+    const checkInject = (option, config, defaultValue) => {
+      if (typeof option === 'boolean') return option;
+      if (typeof option === 'function') return option(config);
+      return defaultValue;
+    };
+
     // eslint-disable-next-line no-shadow
     [].concat(config).forEach((config) => {
-      config.entry = prependEntry(config.entry || './src');
+      const webTarget =
+        config.target === 'web' ||
+        config.target === 'webworker' ||
+        config.target === 'electron-renderer' ||
+        config.target === 'node-webkit' ||
+        config.target == null;
+      const additionalEntries = checkInject(
+        options.injectClient,
+        config,
+        webTarget
+      )
+        ? [clientEntry]
+        : [];
+
+      if (hotEntry && checkInject(options.injectHot, config, true)) {
+        additionalEntries.push(hotEntry);
+      }
+
+      config.entry = prependEntry(config.entry || './src', additionalEntries);
 
       if (options.hot || options.hotOnly) {
         config.plugins = config.plugins || [];

package/lib/utils/createCertificate.js

@@ -2,8 +2,8 @@
 
 const selfsigned = require('selfsigned');
 
-function createCertificate(attrs) {
-  return selfsigned.generate(attrs, {
+function createCertificate(attributes) {
+  return selfsigned.generate(attributes, {
     algorithm: 'sha256',
     days: 30,
     keySize: 2048,

package/lib/utils/createConfig.js

@@ -30,6 +30,22 @@ function createConfig(config, argv, { port }) {
     options.socket = argv.socket;
   }
 
+  if (argv.sockHost) {
+    options.sockHost = argv.sockHost;
+  }
+
+  if (argv.sockPath) {
+    options.sockPath = argv.sockPath;
+  }
+
+  if (argv.sockPort) {
+    options.sockPort = argv.sockPort;
+  }
+
+  if (argv.liveReload === false) {
+    options.liveReload = false;
+  }
+
   if (argv.progress) {
     options.progress = argv.progress;
   }

package/lib/utils/defaultPort.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = 8080;

package/lib/utils/findPort.js

@@ -1,35 +1,28 @@
 'use strict';
 
-const portfinder = require('portfinder');
-
-function runPortFinder(defaultPort, cb) {
-  portfinder.basePort = defaultPort;
-  portfinder.getPort((err, port) => {
-    cb(err, port);
-  });
-}
-
-function findPort(server, defaultPort, defaultPortRetry, fn) {
-  let tryCount = 0;
-  const portFinderRunCb = (err, port) => {
-    tryCount += 1;
-    fn(err, port);
-  };
-
-  server.listeningApp.on('error', (err) => {
-    if (err && err.code !== 'EADDRINUSE') {
-      throw err;
-    }
-
-    if (tryCount >= defaultPortRetry) {
-      fn(err);
-      return;
-    }
-
-    runPortFinder(defaultPort, portFinderRunCb);
+const { getPortPromise } = require('portfinder');
+const defaultPort = require('./defaultPort');
+const defaultTo = require('./defaultTo');
+const tryParseInt = require('./tryParseInt');
+
+function findPort(port) {
+  if (typeof port !== 'undefined') {
+    return Promise.resolve(port);
+  }
+
+  // Try to find unused port and listen on it for 3 times,
+  // if port is not specified in options.
+  // Because NaN == null is false, defaultTo fails if parseInt returns NaN
+  // so the tryParseInt function is introduced to handle NaN
+  const defaultPortRetry = defaultTo(
+    tryParseInt(process.env.DEFAULT_PORT_RETRY),
+    3
+  );
+
+  return getPortPromise({
+    port: defaultPort,
+    stopPort: defaultPort + defaultPortRetry,
   });
-
-  runPortFinder(defaultPort, portFinderRunCb);
 }
 
 module.exports = findPort;

package/lib/utils/getCertificate.js

@@ -0,0 +1,45 @@
+'use strict';
+
+const path = require('path');
+const fs = require('fs');
+const del = require('del');
+const createCertificate = require('./createCertificate');
+
+function getCertificate(logger) {
+  // Use a self-signed certificate if no certificate was configured.
+  // Cycle certs every 24 hours
+  const certificatePath = path.join(__dirname, '../../ssl/server.pem');
+
+  let certificateExists = fs.existsSync(certificatePath);
+
+  if (certificateExists) {
+    const certificateTtl = 1000 * 60 * 60 * 24;
+    const certificateStat = fs.statSync(certificatePath);
+
+    const now = new Date();
+
+    // cert is more than 30 days old, kill it with fire
+    if ((now - certificateStat.ctime) / certificateTtl > 30) {
+      logger.info('SSL Certificate is more than 30 days old. Removing.');
+
+      del.sync([certificatePath], { force: true });
+
+      certificateExists = false;
+    }
+  }
+
+  if (!certificateExists) {
+    logger.info('Generating SSL Certificate');
+
+    const attributes = [{ name: 'commonName', value: 'localhost' }];
+    const pems = createCertificate(attributes);
+
+    fs.writeFileSync(certificatePath, pems.private + pems.cert, {
+      encoding: 'utf8',
+    });
+  }
+
+  return fs.readFileSync(certificatePath);
+}
+
+module.exports = getCertificate;

package/lib/utils/processOptions.js

@@ -0,0 +1,29 @@
+'use strict';
+
+const createConfig = require('./createConfig');
+const defaultPort = require('./defaultPort');
+
+function processOptions(config, argv, callback) {
+  // processOptions {Promise}
+  if (typeof config.then === 'function') {
+    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;
+  }
+
+  // Taken out of yargs because we must know if
+  // it wasn't given by the user, in which case
+  // we should use portfinder.
+  const options = createConfig(config, argv, { port: defaultPort });
+
+  callback(config, options);
+}
+
+module.exports = processOptions;

package/lib/utils/routes.js

@@ -0,0 +1,103 @@
+'use strict';
+
+const { createReadStream } = require('fs');
+const { join } = require('path');
+
+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);
+  });
+
+  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);
+  });
+
+  app.get('/webpack-dev-server.js', (req, res) => {
+    res.setHeader('Content-Type', 'application/javascript');
+
+    createReadStream(
+      join(__dirname, '..', '..', 'client', '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
+    );
+  });
+
+  app.get('/webpack-dev-server', (req, res) => {
+    res.setHeader('Content-Type', 'text/html');
+
+    res.write(
+      '<!DOCTYPE html><html><head><meta charset="utf-8"/></head><body>'
+    );
+
+    const outputPath = middleware.getFilenameFromUrl(options.publicPath || '/');
+    const filesystem = middleware.fileSystem;
+
+    writeDirectory(options.publicPath || '/', outputPath);
+
+    res.end('</body></html>');
+
+    function writeDirectory(baseUrl, basePath) {
+      const content = filesystem.readdirSync(basePath);
+
+      res.write('<ul>');
+
+      content.forEach((item) => {
+        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>');
+
+          if (/\.js$/.test(item)) {
+            const html = item.substr(0, item.length - 3);
+
+            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(
+              baseUrl.replace(
+                // eslint-disable-next-line
+                /(^(https?:\/\/[^\/]+)?\/)/,
+                '$1webpack-dev-server/'
+              ) + html
+            );
+            res.write('">webpack-dev-server</a>)</li>');
+          }
+        } else {
+          res.write('<li>');
+          res.write(item);
+          res.write('<br>');
+
+          writeDirectory(`${baseUrl + item}/`, p);
+
+          res.write('</li>');
+        }
+      });
+
+      res.write('</ul>');
+    }
+  });
+}
+
+module.exports = routes;

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}`;
+  }
+
+  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/setupExitSignals.js

@@ -0,0 +1,21 @@
+'use strict';
+
+const signals = ['SIGINT', 'SIGTERM'];
+
+function setupExitSignals(server) {
+  signals.forEach((signal) => {
+    process.on(signal, () => {
+      if (server) {
+        server.close(() => {
+          // eslint-disable-next-line no-process-exit
+          process.exit();
+        });
+      } else {
+        // eslint-disable-next-line no-process-exit
+        process.exit();
+      }
+    });
+  });
+}
+
+module.exports = setupExitSignals;

package/lib/utils/status.js

@@ -1,8 +1,9 @@
 '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) {
   const contentBase = Array.isArray(options.contentBase)
     ? options.contentBase.join(', ')
@@ -43,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webpack-dev-server",
-  "version": "3.3.1",
+  "version": "3.5.1",
   "description": "Serves a webpack app. Updates the browser on changes.",
   "bin": "bin/webpack-dev-server.js",
   "main": "lib/Server.js",
@@ -14,11 +14,18 @@
     "node": ">= 6.11.5"
   },
   "scripts": {
-    "lint": "eslint bin lib test examples client-src",
-    "pretty": "prettier --loglevel warn --write \"**/*.{js,css,md,json,yml}\"",
-    "test": "jest --runInBand",
+    "lint:prettier": "prettier \"{**/*,*}.{js,json,md,yml,css}\" --list-different",
+    "lint:js": "eslint . --cache",
+    "lint": "npm-run-all -l -p \"lint:**\"",
+    "commitlint": "commitlint --from=master",
+    "security": "npm audit",
+    "test:only": "jest --runInBand",
+    "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 *.config.js",
+    "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",
@@ -28,24 +35,24 @@
   "dependencies": {
     "ansi-html": "0.0.7",
     "bonjour": "^3.5.0",
-    "chokidar": "^2.1.5",
+    "chokidar": "^2.1.6",
     "compression": "^1.7.4",
     "connect-history-api-fallback": "^1.6.0",
     "debug": "^4.1.1",
-    "del": "^4.1.0",
-    "express": "^4.16.4",
+    "del": "^4.1.1",
+    "express": "^4.17.1",
     "html-entities": "^1.2.1",
     "http-proxy-middleware": "^0.19.1",
     "import-local": "^2.0.0",
-    "internal-ip": "^4.2.0",
+    "internal-ip": "^4.3.0",
     "ip": "^1.1.5",
     "killable": "^1.0.1",
-    "loglevel": "^1.6.1",
+    "loglevel": "^1.6.2",
     "opn": "^5.5.0",
     "portfinder": "^1.0.20",
     "schema-utils": "^1.0.0",
     "selfsigned": "^1.10.4",
-    "semver": "^6.0.0",
+    "semver": "^6.1.1",
     "serve-index": "^1.9.1",
     "sockjs": "0.3.19",
     "sockjs-client": "1.3.0",
@@ -53,64 +60,54 @@
     "strip-ansi": "^3.0.1",
     "supports-color": "^6.1.0",
     "url": "^0.11.0",
-    "webpack-dev-middleware": "^3.6.2",
+    "webpack-dev-middleware": "^3.7.0",
     "webpack-log": "^2.0.0",
     "yargs": "12.0.5"
   },
   "devDependencies": {
-    "@babel/cli": "7.4.3",
-    "@babel/core": "7.4.3",
-    "@babel/preset-env": "7.4.3",
-    "babel-loader": "8.0.5",
-    "copy-webpack-plugin": "5.0.2",
-    "css-loader": "2.1.1",
-    "eslint": "5.16.0",
-    "eslint-config-prettier": "4.1.0",
-    "eslint-config-webpack": "1.2.5",
-    "eslint-plugin-import": "2.16.0",
-    "eslint-plugin-prettier": "3.0.1",
-    "execa": "1.0.0",
-    "file-loader": "3.0.1",
-    "html-loader": "0.5.5",
-    "html-webpack-plugin": "3.2.0",
-    "husky": "1.3.1",
-    "jest": "24.7.1",
-    "jquery": "3.3.1",
-    "less": "3.9.0",
-    "less-loader": "4.1.0",
-    "lint-staged": "8.1.5",
-    "marked": "0.6.2",
-    "nyc": "13.3.0",
-    "prettier": "1.16.4",
-    "puppeteer": "1.14.0",
-    "rimraf": "2.6.3",
-    "standard-version": "5.0.2",
-    "style-loader": "0.23.1",
-    "supertest": "4.0.2",
-    "url-loader": "1.1.2",
-    "webpack": "4.29.6",
-    "webpack-cli": "3.3.0",
-    "ws": "6.2.1"
+    "@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-loader": "^8.0.6",
+    "body-parser": "^1.19.0",
+    "commitlint-azure-pipelines-cli": "^1.0.1",
+    "copy-webpack-plugin": "^5.0.3",
+    "css-loader": "^2.1.1",
+    "eslint": "^5.16.0",
+    "eslint-config-prettier": "^4.3.0",
+    "eslint-config-webpack": "^1.2.5",
+    "eslint-plugin-import": "^2.17.3",
+    "execa": "^1.0.0",
+    "file-loader": "^3.0.1",
+    "html-loader": "^0.5.5",
+    "html-webpack-plugin": "^3.2.0",
+    "husky": "^2.3.0",
+    "jest": "^24.8.0",
+    "jest-junit": "^6.4.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",
+    "npm-run-all": "^4.1.5",
+    "nyc": "^14.1.1",
+    "prettier": "^1.17.1",
+    "puppeteer": "^1.17.0",
+    "rimraf": "^2.6.3",
+    "standard-version": "^6.0.1",
+    "style-loader": "^0.23.1",
+    "supertest": "^4.0.2",
+    "url-loader": "^1.1.2",
+    "webpack": "^4.32.2",
+    "webpack-cli": "^3.3.2",
+    "ws": "^6.2.1"
   },
   "peerDependencies": {
     "webpack": "^4.0.0"
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
-  "lint-staged": {
-    "*.js": [
-      "eslint --fix",
-      "prettier --write",
-      "git add"
-    ],
-    "*.{css,md,json,yml}": [
-      "prettier --write",
-      "git add"
-    ]
-  },
   "author": "Tobias Koppers @sokra",
   "bugs": "https://github.com/webpack/webpack-dev-server/issues",
   "homepage": "https://github.com/webpack/webpack-dev-server#readme",

package/client/webpack.config.js

@@ -1,14 +0,0 @@
-'use strict';
-
-module.exports = {
-  mode: 'production',
-  module: {
-    rules: [{
-      test: /\.js$/,
-      exclude: /node_modules|web_modules/,
-      use: [{
-        loader: 'babel-loader'
-      }]
-    }]
-  }
-};