webpack-dev-server 4.9.2 → 4.10.1

package/README.md

@@ -209,7 +209,9 @@ CLI documentation: https://webpack.js.org/api/cli/.
 Made with ♥ by the webpack team.
 ```
 
-_**Note**: For more information on above options explore this [link](https://webpack.js.org/configuration/dev-server/)._
+> **Note**
+>
+> _Detailed documentation for above options is available on this [link](https://webpack.js.org/configuration/dev-server/)._
 
 ### With NPM Scripts
 

package/client/index.js

@@ -1,3 +1,9 @@
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
 /* global __resourceQuery, __webpack_hash__ */
 /// <reference types="webpack/module" />
 import webpackHotLog from "webpack/hot/log.js";
@@ -5,7 +11,7 @@ import stripAnsi from "./utils/stripAnsi.js";
 import parseURL from "./utils/parseURL.js";
 import socket from "./socket.js";
 import { formatProblem, show, hide } from "./overlay.js";
-import { log, setLogLevel } from "./utils/log.js";
+import { log, logEnabledFeatures, setLogLevel } from "./utils/log.js";
 import sendMessage from "./utils/sendMessage.js";
 import reloadApp from "./utils/reloadApp.js";
 import createSocketURL from "./utils/createSocketURL.js";
@@ -45,15 +51,44 @@ var options = {
   overlay: false
 };
 var parsedResourceQuery = parseURL(__resourceQuery);
+var enabledFeatures = {
+  "Hot Module Replacement": false,
+  "Live Reloading": false,
+  Progress: false,
+  Overlay: false
+};
 
 if (parsedResourceQuery.hot === "true") {
   options.hot = true;
-  log.info("Hot Module Replacement enabled.");
+  enabledFeatures["Hot Module Replacement"] = true;
 }
 
 if (parsedResourceQuery["live-reload"] === "true") {
   options.liveReload = true;
-  log.info("Live Reloading enabled.");
+  enabledFeatures["Live Reloading"] = true;
+}
+
+if (parsedResourceQuery.progress === "true") {
+  options.progress = true;
+  enabledFeatures.Progress = true;
+}
+
+if (parsedResourceQuery.overlay) {
+  try {
+    options.overlay = JSON.parse(parsedResourceQuery.overlay);
+  } catch (e) {
+    log.error("Error parsing overlay options from resource query:", e);
+  } // Fill in default "true" params for partially-specified objects.
+
+
+  if (typeof options.overlay === "object") {
+    options.overlay = _objectSpread({
+      errors: true,
+      warnings: true
+    }, options.overlay);
+  }
+
+  enabledFeatures.Overlay = true;
 }
 
 if (parsedResourceQuery.logging) {
@@ -63,11 +98,12 @@ if (parsedResourceQuery.logging) {
 if (typeof parsedResourceQuery.reconnect !== "undefined") {
   options.reconnect = Number(parsedResourceQuery.reconnect);
 }
+
+logEnabledFeatures(enabledFeatures);
 /**
  * @param {string} level
  */
 
-
 function setAllLogLevel(level) {
   // This is needed because the HMR logger operate separately from dev server logger
   webpackHotLog.setLogLevel(level === "verbose" || level === "log" ? "info" : level);
@@ -88,7 +124,6 @@ var onSocketMessage = {
     }
 
     options.hot = true;
-    log.info("Hot Module Replacement enabled.");
   },
   liveReload: function liveReload() {
     if (parsedResourceQuery["live-reload"] === "false") {
@@ -96,7 +131,6 @@ var onSocketMessage = {
     }
 
     options.liveReload = true;
-    log.info("Live Reloading enabled.");
   },
   invalid: function invalid() {
     log.info("App updated. Recompiling..."); // Fixes #1042. overlay doesn't clear if errors are fixed but warnings remain.

package/client/utils/log.js

@@ -17,4 +17,24 @@ function setLogLevel(level) {
 
 setLogLevel(defaultLevel);
 var log = logger.getLogger(name);
-export { log, setLogLevel };
+
+var logEnabledFeatures = function logEnabledFeatures(features) {
+  var enabledFeatures = Object.keys(features);
+
+  if (!features || enabledFeatures.length === 0) {
+    return;
+  }
+
+  var logString = "Server started:"; // Server started: Hot Module Replacement enabled, Live Reloading enabled, Overlay disabled.
+
+  for (var i = 0; i < enabledFeatures.length; i++) {
+    var key = enabledFeatures[i];
+    logString += " ".concat(key, " ").concat(features[key] ? "enabled" : "disabled", ",");
+  } // replace last comma with a period
+
+
+  logString = logString.slice(0, -1).concat(".");
+  log.info(logString);
+};
+
+export { log, logEnabledFeatures, setLogLevel };

package/lib/Server.js

@@ -597,6 +597,19 @@ class Server {
           searchParams.set("logging", client.logging);
         }
 
+        if (typeof client.progress !== "undefined") {
+          searchParams.set("progress", String(client.progress));
+        }
+
+        if (typeof client.overlay !== "undefined") {
+          searchParams.set(
+            "overlay",
+            typeof client.overlay === "boolean"
+              ? String(client.overlay)
+              : JSON.stringify(client.overlay)
+          );
+        }
+
         if (typeof client.reconnect !== "undefined") {
           searchParams.set(
             "reconnect",
@@ -606,6 +619,14 @@ class Server {
           );
         }
 
+        if (typeof this.options.hot !== "undefined") {
+          searchParams.set("hot", String(this.options.hot));
+        }
+
+        if (typeof this.options.liveReload !== "undefined") {
+          searchParams.set("live-reload", String(this.options.liveReload));
+        }
+
         webSocketURLStr = searchParams.toString();
       }
 
@@ -1964,12 +1985,9 @@ class Server {
       (req, res) => {
         res.setHeader("Content-Type", "application/javascript");
 
-        const { createReadStream } = fs;
         const clientPath = path.join(__dirname, "..", "client");
 
-        createReadStream(
-          path.join(clientPath, "modules/sockjs-client/index.js")
-        ).pipe(res);
+        res.sendFile(path.join(clientPath, "modules/sockjs-client/index.js"));
       }
     );
 
@@ -2113,6 +2131,32 @@ class Server {
       });
     }
 
+    {
+      /**
+       *
+       * @param {Request} req
+       * @param {Response} res
+       * @param {NextFunction} next
+       * @returns {void}
+       *
+       */
+      const optionsRequestResponseMiddleware = (req, res, next) => {
+        if (req.method === "OPTIONS") {
+          res.statusCode = 204;
+          res.setHeader("Content-Length", "0");
+          res.end();
+          return;
+        }
+        next();
+      };
+
+      middlewares.push({
+        name: "options-middleware",
+        path: "*",
+        middleware: optionsRequestResponseMiddleware,
+      });
+    }
+
     middlewares.push({
       name: "webpack-dev-middleware",
       middleware:

package/package.json

@@ -1,10 +1,19 @@
 {
   "name": "webpack-dev-server",
-  "version": "4.9.2",
+  "version": "4.10.1",
   "description": "Serves a webpack app. Updates the browser on changes.",
   "bin": "bin/webpack-dev-server.js",
   "main": "lib/Server.js",
   "types": "types/lib/Server.d.ts",
+  "author": "Tobias Koppers @sokra",
+  "bugs": "https://github.com/webpack/webpack-dev-server/issues",
+  "homepage": "https://github.com/webpack/webpack-dev-server#readme",
+  "repository": "https://github.com/webpack/webpack-dev-server",
+  "license": "MIT",
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/webpack"
+  },
   "files": [
     "bin",
     "lib",
@@ -47,7 +56,7 @@
     "chokidar": "^3.5.3",
     "colorette": "^2.0.10",
     "compression": "^1.7.4",
-    "connect-history-api-fallback": "^1.6.0",
+    "connect-history-api-fallback": "^2.0.0",
     "default-gateway": "^6.0.3",
     "express": "^4.17.3",
     "graceful-fs": "^4.2.6",
@@ -81,7 +90,7 @@
     "@types/sockjs-client": "^1.5.1",
     "@types/trusted-types": "^2.0.2",
     "acorn": "^8.2.4",
-    "babel-jest": "^27.5.1",
+    "babel-jest": "^28.1.3",
     "babel-loader": "^8.2.4",
     "body-parser": "^1.19.2",
     "core-js": "^3.21.1",
@@ -95,7 +104,8 @@
     "html-webpack-plugin": "^4.5.2",
     "http-proxy": "^1.18.1",
     "husky": "^7.0.0",
-    "jest": "^27.5.1",
+    "jest": "^28.1.3",
+    "jest-environment-jsdom": "^28.1.3",
     "klona": "^2.0.4",
     "less": "^4.1.1",
     "less-loader": "^7.3.0",
@@ -126,10 +136,5 @@
     "webpack-cli": {
       "optional": true
     }
-  },
-  "author": "Tobias Koppers @sokra",
-  "bugs": "https://github.com/webpack/webpack-dev-server/issues",
-  "homepage": "https://github.com/webpack/webpack-dev-server#readme",
-  "repository": "https://github.com/webpack/webpack-dev-server.git",
-  "license": "MIT"
+  }
 }

package/types/lib/Server.d.ts

@@ -863,8 +863,14 @@ declare class Server {
           type: string;
           multiple: boolean;
           description: string;
-          /** @type {Object<string,string>} */ negatedDescription: string;
+          negatedDescription: string;
           path: string;
+          /**
+           * prependEntry Method for webpack 4
+           * @param {any} originalEntry
+           * @param {any} newAdditionalEntries
+           * @returns {any}
+           */
         }[];
         description: string;
         simpleType: string;
@@ -875,13 +881,12 @@ declare class Server {
           | {
               type: string;
               multiple: boolean;
-              /** @type {any} */
               description: string;
               path: string;
             }
           | {
               type: string;
-              /** @type {any} */ values: boolean[];
+              values: boolean[];
               multiple: boolean;
               description: string;
               path: string;
@@ -920,7 +925,7 @@ declare class Server {
           | {
               type: string;
               multiple: boolean;
-              description: string;
+              /** @type {MultiCompiler} */ description: string;
               path: string;
             }
           | {
@@ -931,7 +936,7 @@ declare class Server {
               path: string;
             }
         )[];
-        /** @type {Compiler} */ description: string;
+        description: string;
         simpleType: string;
         multiple: boolean;
       };
@@ -956,6 +961,10 @@ declare class Server {
         description: string;
         simpleType: string;
         multiple: boolean;
+        /**
+         * @param {WatchOptions & { aggregateTimeout?: number, ignored?: WatchOptions["ignored"], poll?: number | boolean }} watchOptions
+         * @returns {WatchOptions}
+         */
       };
       "open-app-name-reset": {
         configs: {
@@ -987,7 +996,7 @@ declare class Server {
           path: string;
         }[];
         description: string;
-        /** @type {NormalizedStatic} */ simpleType: string;
+        simpleType: string;
         multiple: boolean;
       };
       "open-target-reset": {
@@ -1162,9 +1171,8 @@ declare class Server {
         }[];
         description: string;
         multiple: boolean;
-        simpleType: string /** @type {ServerOptions} */;
+        simpleType: string;
       };
-      /** @type {ServerOptions} */
       "server-options-request-cert": {
         configs: {
           description: string;
@@ -1187,7 +1195,7 @@ declare class Server {
         }[];
         description: string;
         multiple: boolean;
-        simpleType: string;
+        simpleType: string /** @type {ServerOptions} */;
       };
       static: {
         configs: (
@@ -1200,11 +1208,7 @@ declare class Server {
           | {
               type: string;
               multiple: boolean;
-              /**
-               * @param {string | Buffer | undefined} item
-               * @returns {string | Buffer | undefined}
-               */
-              description: string;
+              /** @type {ServerOptions} */ description: string;
               negatedDescription: string;
               path: string;
             }
@@ -1216,11 +1220,15 @@ declare class Server {
       "static-directory": {
         configs: {
           type: string;
-          multiple: boolean;
+          /** @type {any} */ multiple: boolean;
           description: string;
           path: string;
         }[];
-        /** @type {any} */ description: string;
+        /**
+         * @param {string | Buffer | undefined} item
+         * @returns {string | Buffer | undefined}
+         */
+        description: string;
         simpleType: string;
         multiple: boolean;
       };
@@ -1232,7 +1240,7 @@ declare class Server {
           path: string;
         }[];
         description: string;
-        simpleType: string;
+        /** @type {any} */ simpleType: string;
         multiple: boolean;
       };
       "static-public-path-reset": {
@@ -1327,9 +1335,7 @@ declare class Server {
               type: string;
             }
         )[];
-        /** @type {ServerOptions & { cacert?: ServerOptions["ca"] }} */
         description: string;
-        /** @type {ServerOptions} */
         simpleType: string;
         multiple: boolean;
       };
@@ -1346,12 +1352,12 @@ declare class Server {
               description: string;
               multiple: boolean;
               path: string;
-              type: string;
+              type: string /** @type {ServerOptions & { cacert?: ServerOptions["ca"] }} */;
             }
         )[];
         description: string;
         simpleType: string;
-        multiple: boolean;
+        multiple: boolean /** @type {ServerOptions} */;
       };
     };
     readonly processArguments: (
@@ -2374,12 +2380,6 @@ declare class Server {
                       anyOf: (
                         | {
                             type: string;
-                            /**
-                             * prependEntry Method for webpack 4
-                             * @param {any} originalEntry
-                             * @param {any} newAdditionalEntries
-                             * @returns {any}
-                             */
                             items: {
                               type: string;
                               minLength: number;
@@ -2421,7 +2421,6 @@ declare class Server {
           };
         };
       };
-      /** @type {any} */
       OpenString: {
         type: string;
         minLength: number;
@@ -2480,7 +2479,7 @@ declare class Server {
       };
       Server: {
         anyOf: {
-          $ref: string /** @type {MultiCompiler} */;
+          $ref: string;
         }[];
         link: string;
         description: string;
@@ -2631,7 +2630,6 @@ declare class Server {
                     anyOf: (
                       | {
                           type: string;
-                          /** @type {NormalizedStatic} */
                           instanceof?: undefined;
                         }
                       | {
@@ -2924,10 +2922,10 @@ declare class Server {
         anyOf: (
           | {
               enum: boolean[];
-              cli: {
+              /** @type {ServerOptions} */ cli: {
                 negatedDescription: string;
               };
-              $ref?: undefined;
+              /** @type {ServerOptions} */ $ref?: undefined;
             }
           | {
               $ref: string;
@@ -2936,7 +2934,7 @@ declare class Server {
             }
         )[];
         cli: {
-          description: string /** @type {any} */;
+          description: string;
         };
       };
       WebSocketServerFunction: {