webpack-dev-server 4.15.1 → 5.0.1

package/lib/getPort.js

@@ -46,7 +46,7 @@ const checkAvailablePort = (basePort, host) =>
     server.on("error", reject);
 
     server.listen(basePort, host, () => {
-      // Next line should return AdressInfo because we're calling it after listen() and before close()
+      // Next line should return AddressInfo because we're calling it after listen() and before close()
       const { port } = /** @type {import("net").AddressInfo} */ (
         server.address()
       );
@@ -75,7 +75,7 @@ const getAvailablePort = async (port, hosts) => {
       /* We throw an error only if the interface exists */
       if (
         !nonExistentInterfaceErrors.has(
-          /** @type {NodeJS.ErrnoException} */ (error).code
+          /** @type {NodeJS.ErrnoException} */ (error).code,
         )
       ) {
         throw error;
@@ -118,7 +118,7 @@ async function getPorts(basePort, host) {
       /* Try next port if port is busy; throw for any other error */
       if (
         !portUnavailableErrors.has(
-          /** @type {NodeJS.ErrnoException} */ (error).code
+          /** @type {NodeJS.ErrnoException} */ (error).code,
         )
       ) {
         throw error;

package/lib/options.json

@@ -264,195 +264,6 @@
       "type": "object",
       "additionalProperties": true
     },
-    "HTTP2": {
-      "type": "boolean",
-      "description": "Allows to serve over HTTP/2 using SPDY. Deprecated, use the `server` option.",
-      "link": "https://webpack.js.org/configuration/dev-server/#devserverhttp2",
-      "cli": {
-        "negatedDescription": "Does not serve over HTTP/2 using SPDY."
-      }
-    },
-    "HTTPS": {
-      "anyOf": [
-        {
-          "type": "boolean",
-          "cli": {
-            "negatedDescription": "Disallows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP)."
-          }
-        },
-        {
-          "type": "object",
-          "additionalProperties": true,
-          "properties": {
-            "passphrase": {
-              "type": "string",
-              "description": "Passphrase for a pfx file. Deprecated, use the `server.options.passphrase` option."
-            },
-            "requestCert": {
-              "type": "boolean",
-              "description": "Request for an SSL certificate. Deprecated, use the `server.options.requestCert` option.",
-              "cli": {
-                "negatedDescription": "Does not request for an SSL certificate."
-              }
-            },
-            "ca": {
-              "anyOf": [
-                {
-                  "type": "array",
-                  "items": {
-                    "anyOf": [
-                      {
-                        "type": "string"
-                      },
-                      {
-                        "instanceof": "Buffer"
-                      }
-                    ]
-                  }
-                },
-                {
-                  "type": "string"
-                },
-                {
-                  "instanceof": "Buffer"
-                }
-              ],
-              "description": "Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option."
-            },
-            "cacert": {
-              "anyOf": [
-                {
-                  "type": "array",
-                  "items": {
-                    "anyOf": [
-                      {
-                        "type": "string"
-                      },
-                      {
-                        "instanceof": "Buffer"
-                      }
-                    ]
-                  }
-                },
-                {
-                  "type": "string"
-                },
-                {
-                  "instanceof": "Buffer"
-                }
-              ],
-              "description": "Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option."
-            },
-            "cert": {
-              "anyOf": [
-                {
-                  "type": "array",
-                  "items": {
-                    "anyOf": [
-                      {
-                        "type": "string"
-                      },
-                      {
-                        "instanceof": "Buffer"
-                      }
-                    ]
-                  }
-                },
-                {
-                  "type": "string"
-                },
-                {
-                  "instanceof": "Buffer"
-                }
-              ],
-              "description": "Path to an SSL certificate or content of an SSL certificate. Deprecated, use the `server.options.cert` option."
-            },
-            "crl": {
-              "anyOf": [
-                {
-                  "type": "array",
-                  "items": {
-                    "anyOf": [
-                      {
-                        "type": "string"
-                      },
-                      {
-                        "instanceof": "Buffer"
-                      }
-                    ]
-                  }
-                },
-                {
-                  "type": "string"
-                },
-                {
-                  "instanceof": "Buffer"
-                }
-              ],
-              "description": "Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists). Deprecated, use the `server.options.crl` option."
-            },
-            "key": {
-              "anyOf": [
-                {
-                  "type": "array",
-                  "items": {
-                    "anyOf": [
-                      {
-                        "type": "string"
-                      },
-                      {
-                        "instanceof": "Buffer"
-                      },
-                      {
-                        "type": "object",
-                        "additionalProperties": true
-                      }
-                    ]
-                  }
-                },
-                {
-                  "type": "string"
-                },
-                {
-                  "instanceof": "Buffer"
-                }
-              ],
-              "description": "Path to an SSL key or content of an SSL key. Deprecated, use the `server.options.key` option."
-            },
-            "pfx": {
-              "anyOf": [
-                {
-                  "type": "array",
-                  "items": {
-                    "anyOf": [
-                      {
-                        "type": "string"
-                      },
-                      {
-                        "instanceof": "Buffer"
-                      },
-                      {
-                        "type": "object",
-                        "additionalProperties": true
-                      }
-                    ]
-                  }
-                },
-                {
-                  "type": "string"
-                },
-                {
-                  "instanceof": "Buffer"
-                }
-              ],
-              "description": "Path to an SSL pfx file or content of an SSL pfx file. Deprecated, use the `server.options.pfx` option."
-            }
-          }
-        }
-      ],
-      "description": "Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP). Deprecated, use the `server` option.",
-      "link": "https://webpack.js.org/configuration/dev-server/#devserverhttps"
-    },
     "HeaderObject": {
       "type": "object",
       "additionalProperties": false,
@@ -556,24 +367,6 @@
       },
       "link": "https://webpack.js.org/configuration/dev-server/#devserverlivereload"
     },
-    "MagicHTML": {
-      "type": "boolean",
-      "description": "Tells dev-server whether to enable magic HTML routes (routes corresponding to your webpack output, for example '/main' for 'main.js').",
-      "cli": {
-        "negatedDescription": "Disables magic HTML routes (routes corresponding to your webpack output, for example '/main' for 'main.js')."
-      },
-      "link": "https://webpack.js.org/configuration/dev-server/#devservermagichtml"
-    },
-    "OnAfterSetupMiddleware": {
-      "instanceof": "Function",
-      "description": "Provides the ability to execute a custom function and apply custom middleware(s) after all other middlewares. Deprecated: please use the 'setupMiddlewares' option.",
-      "link": "https://webpack.js.org/configuration/dev-server/#devserveronaftersetupmiddleware"
-    },
-    "OnBeforeSetupMiddleware": {
-      "instanceof": "Function",
-      "description": "Provides the ability to execute a custom function and apply custom middleware(s) prior to all other middlewares. Deprecated: please use the 'setupMiddlewares' option.",
-      "link": "https://webpack.js.org/configuration/dev-server/#devserveronbeforesetupmiddleware"
-    },
     "OnListening": {
       "instanceof": "Function",
       "description": "Provides the ability to execute a custom function when dev server starts listening.",
@@ -666,7 +459,7 @@
               "minLength": 1,
               "description": "Open specified browser.",
               "cli": {
-                "description": "Open specified browser. Deprecated: please use '--open-app-name'."
+                "exclude": true
               }
             }
           ],
@@ -697,24 +490,17 @@
       "link": "https://webpack.js.org/configuration/dev-server/#devserverport"
     },
     "Proxy": {
-      "anyOf": [
-        {
-          "type": "object"
-        },
-        {
-          "type": "array",
-          "items": {
-            "anyOf": [
-              {
-                "type": "object"
-              },
-              {
-                "instanceof": "Function"
-              }
-            ]
+      "type": "array",
+      "items": {
+        "anyOf": [
+          {
+            "type": "object"
+          },
+          {
+            "instanceof": "Function"
           }
-        }
-      ],
+        ]
+      },
       "description": "Allows to proxy requests, can be useful when you have a separate API backend development server and you want to send API requests on the same domain.",
       "link": "https://webpack.js.org/configuration/dev-server/#devserverproxy"
     },
@@ -807,30 +593,6 @@
           ],
           "description": "Path to an SSL CA certificate or content of an SSL CA certificate."
         },
-        "cacert": {
-          "anyOf": [
-            {
-              "type": "array",
-              "items": {
-                "anyOf": [
-                  {
-                    "type": "string"
-                  },
-                  {
-                    "instanceof": "Buffer"
-                  }
-                ]
-              }
-            },
-            {
-              "type": "string"
-            },
-            {
-              "instanceof": "Buffer"
-            }
-          ],
-          "description": "Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option."
-        },
         "cert": {
           "anyOf": [
             {
@@ -1141,12 +903,12 @@
           }
         },
         {
-          "$ref": "#/definitions/WebSocketServerType"
+          "enum": ["sockjs", "ws"],
+          "cli": {
+            "exclude": true
+          }
         }
-      ],
-      "cli": {
-        "description": "Deprecated: please use '--web-socket-server-type' option."
-      }
+      ]
     },
     "WebSocketServerFunction": {
       "instanceof": "Function"
@@ -1179,7 +941,10 @@
     },
     "WebSocketServerString": {
       "type": "string",
-      "minLength": 1
+      "minLength": 1,
+      "cli": {
+        "exclude": true
+      }
     }
   },
   "additionalProperties": false,
@@ -1211,27 +976,12 @@
     "hot": {
       "$ref": "#/definitions/Hot"
     },
-    "http2": {
-      "$ref": "#/definitions/HTTP2"
-    },
-    "https": {
-      "$ref": "#/definitions/HTTPS"
-    },
     "ipc": {
       "$ref": "#/definitions/IPC"
     },
     "liveReload": {
       "$ref": "#/definitions/LiveReload"
     },
-    "magicHtml": {
-      "$ref": "#/definitions/MagicHTML"
-    },
-    "onAfterSetupMiddleware": {
-      "$ref": "#/definitions/OnAfterSetupMiddleware"
-    },
-    "onBeforeSetupMiddleware": {
-      "$ref": "#/definitions/OnBeforeSetupMiddleware"
-    },
     "onListening": {
       "$ref": "#/definitions/OnListening"
     },

package/lib/servers/SockJSServer.js

@@ -98,7 +98,7 @@ module.exports = class SockJSServer extends BaseServer {
 
     this.implementation.installHandlers(
       /** @type {import("http").Server} */ (this.server.server),
-      options
+      options,
     );
 
     this.implementation.on("connection", (client) => {
@@ -113,7 +113,7 @@ module.exports = class SockJSServer extends BaseServer {
       client.on("close", () => {
         this.clients.splice(
           this.clients.indexOf(/** @type {ClientConnection} */ (client)),
-          1
+          1,
         );
       });
     });

package/lib/servers/WebsocketServer.js

@@ -47,7 +47,7 @@ module.exports = class WebsocketServer extends BaseServer {
         this.implementation.handleUpgrade(req, sock, head, (connection) => {
           this.implementation.emit("connection", connection, req);
         });
-      }
+      },
     );
 
     this.implementation.on(
@@ -57,7 +57,7 @@ module.exports = class WebsocketServer extends BaseServer {
        */
       (err) => {
         this.server.logger.error(err.message);
-      }
+      },
     );
 
     const interval = setInterval(() => {
@@ -74,7 +74,7 @@ module.exports = class WebsocketServer extends BaseServer {
 
           client.isAlive = false;
           client.ping(() => {});
-        }
+        },
       );
     }, WebsocketServer.heartbeatInterval);
 
@@ -95,7 +95,18 @@ module.exports = class WebsocketServer extends BaseServer {
         client.on("close", () => {
           this.clients.splice(this.clients.indexOf(client), 1);
         });
-      }
+
+        // TODO: add a test case for this - https://github.com/webpack/webpack-dev-server/issues/5018
+        client.on(
+          "error",
+          /**
+           * @param {Error} err
+           */
+          (err) => {
+            this.server.logger.error(err.message);
+          },
+        );
+      },
     );
 
     this.implementation.on("close", () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webpack-dev-server",
-  "version": "4.15.1",
+  "version": "5.0.1",
   "description": "Serves a webpack app. Updates the browser on changes.",
   "bin": "bin/webpack-dev-server.js",
   "main": "lib/Server.js",
@@ -21,120 +21,120 @@
     "types"
   ],
   "engines": {
-    "node": ">= 12.13.0"
+    "node": ">= 18.12.0"
   },
   "scripts": {
     "fmt:check": "prettier \"{**/*,*}.{js,json,md,yml,css,ts}\" --list-different",
-    "lint:js": "eslint . --cache",
+    "lint:prettier": "prettier --cache --list-different .",
+    "lint:js": "eslint --cache .",
     "lint:types": "tsc --pretty --noEmit",
-    "lint": "npm-run-all -p \"fmt:**\" \"lint:**\"",
-    "fmt": "npm run fmt:check -- --write",
+    "lint:spelling": "cspell --cache --no-must-find-files --quiet \"**/*.*\"",
+    "lint": "npm-run-all -l -p \"lint:**\"",
     "fix:js": "npm run lint:js -- --fix",
-    "fix": "npm-run-all fix:js fmt",
+    "fix:prettier": "npm run lint:prettier -- --write",
+    "fix": "npm-run-all -l fix:js fix:prettier",
     "commitlint": "commitlint --from=master",
-    "build:client": "rimraf ./client/* && babel client-src/ --out-dir client/ --ignore \"client-src/webpack.config.js\" --ignore \"client-src/modules\" && webpack --config client-src/webpack.config.js",
-    "build:types": "rimraf ./types/* && tsc --declaration --emitDeclarationOnly --outDir types && node ./scripts/extend-webpack-types.js && prettier \"types/**/*.ts\" --write && prettier \"types/**/*.ts\" --write",
+    "build:client": "rimraf -g ./client/* && babel client-src/ --out-dir client/ --ignore \"client-src/webpack.config.js\" --ignore \"client-src/modules\" && webpack --config client-src/webpack.config.js",
+    "build:types": "rimraf -g ./types/* && tsc --declaration --emitDeclarationOnly --outDir types && node ./scripts/extend-webpack-types.js && prettier \"types/**/*.ts\" --write && prettier \"types/**/*.ts\" --write",
     "build": "npm-run-all -p \"build:**\"",
-    "test:only": "jest",
+    "test:only": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
     "test:coverage": "npm run test:only -- --coverage",
     "test:watch": "npm run test:coverage --watch",
     "test": "npm run test:coverage",
     "pretest": "npm run lint",
-    "prepare": "husky install && npm run build",
+    "prepare": "husky && npm run build",
     "release": "standard-version"
   },
   "dependencies": {
-    "@types/bonjour": "^3.5.9",
-    "@types/connect-history-api-fallback": "^1.3.5",
-    "@types/express": "^4.17.13",
-    "@types/serve-index": "^1.9.1",
-    "@types/serve-static": "^1.13.10",
-    "@types/sockjs": "^0.3.33",
-    "@types/ws": "^8.5.5",
+    "@types/bonjour": "^3.5.13",
+    "@types/connect-history-api-fallback": "^1.5.4",
+    "@types/express": "^4.17.21",
+    "@types/serve-index": "^1.9.4",
+    "@types/serve-static": "^1.15.5",
+    "@types/sockjs": "^0.3.36",
+    "@types/ws": "^8.5.10",
     "ansi-html-community": "^0.0.8",
-    "bonjour-service": "^1.0.11",
-    "chokidar": "^3.5.3",
+    "bonjour-service": "^1.2.1",
+    "chokidar": "^3.6.0",
     "colorette": "^2.0.10",
     "compression": "^1.7.4",
     "connect-history-api-fallback": "^2.0.0",
     "default-gateway": "^6.0.3",
     "express": "^4.17.3",
     "graceful-fs": "^4.2.6",
-    "html-entities": "^2.3.2",
+    "html-entities": "^2.4.0",
     "http-proxy-middleware": "^2.0.3",
-    "ipaddr.js": "^2.0.1",
-    "launch-editor": "^2.6.0",
-    "open": "^8.0.9",
-    "p-retry": "^4.5.0",
-    "rimraf": "^3.0.2",
-    "schema-utils": "^4.0.0",
-    "selfsigned": "^2.1.1",
+    "ipaddr.js": "^2.1.0",
+    "launch-editor": "^2.6.1",
+    "open": "^10.0.3",
+    "p-retry": "^6.2.0",
+    "rimraf": "^5.0.5",
+    "schema-utils": "^4.2.0",
+    "selfsigned": "^2.4.1",
     "serve-index": "^1.9.1",
     "sockjs": "^0.3.24",
     "spdy": "^4.0.2",
-    "webpack-dev-middleware": "^5.3.1",
-    "ws": "^8.13.0"
+    "webpack-dev-middleware": "^7.0.0",
+    "ws": "^8.16.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.17.3",
-    "@babel/core": "^7.20.2",
-    "@babel/eslint-parser": "^7.17.0",
-    "@babel/plugin-transform-object-assign": "^7.14.5",
-    "@babel/plugin-transform-runtime": "^7.17.0",
-    "@babel/preset-env": "^7.20.2",
-    "@babel/runtime": "^7.20.1",
-    "@commitlint/cli": "^16.2.3",
-    "@commitlint/config-conventional": "^16.2.1",
+    "@babel/cli": "^7.22.5",
+    "@babel/core": "^7.22.5",
+    "@babel/eslint-parser": "^7.22.5",
+    "@babel/plugin-transform-object-assign": "^7.22.5",
+    "@babel/plugin-transform-runtime": "^7.22.5",
+    "@babel/preset-env": "^7.22.5",
+    "@babel/runtime": "^7.22.5",
+    "@commitlint/cli": "^18.5.0",
+    "@commitlint/config-conventional": "^18.5.0",
     "@types/compression": "^1.7.2",
     "@types/default-gateway": "^3.0.1",
-    "@types/node": "^18.11.9",
+    "@types/node": "^20.11.16",
     "@types/node-forge": "^1.3.1",
-    "@types/rimraf": "^3.0.2",
     "@types/sockjs-client": "^1.5.1",
     "@types/trusted-types": "^2.0.2",
-    "acorn": "^8.2.4",
-    "babel-jest": "^28.1.3",
-    "babel-loader": "^8.2.4",
+    "acorn": "^8.9.0",
+    "babel-jest": "^29.5.0",
+    "babel-loader": "^9.1.0",
     "body-parser": "^1.19.2",
-    "core-js": "^3.21.1",
-    "css-loader": "^5.2.4",
-    "eslint": "^8.28.0",
-    "eslint-config-prettier": "^8.4.0",
+    "core-js": "^3.31.0",
+    "cspell": "^8.3.2",
+    "css-loader": "^6.8.1",
+    "eslint": "^8.43.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-config-webpack": "^1.2.5",
     "eslint-plugin-import": "^2.23.2",
     "execa": "^5.1.1",
-    "file-loader": "^6.2.0",
-    "html-webpack-plugin": "^4.5.2",
+    "html-webpack-plugin": "^5.5.3",
     "http-proxy": "^1.18.1",
-    "husky": "^7.0.0",
-    "jest": "^28.1.3",
-    "jest-environment-jsdom": "^28.1.3",
+    "husky": "^9.0.10",
+    "jest": "^29.5.0",
+    "jest-environment-jsdom": "^29.5.0",
     "klona": "^2.0.4",
     "less": "^4.1.1",
-    "less-loader": "^7.3.0",
-    "lint-staged": "^12.3.4",
-    "marked": "^4.2.3",
-    "memfs": "^3.4.12",
+    "less-loader": "^12.1.0",
+    "lint-staged": "^15.2.0",
+    "marked": "^12.0.0",
+    "memfs": "^4.6.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.8.0",
-    "puppeteer": "^13.4.1",
+    "prettier": "^3.2.4",
+    "puppeteer": "^22.0.0",
+    "readable-stream": "^4.5.2",
     "require-from-string": "^2.0.2",
-    "rimraf": "^3.0.2",
     "sockjs-client": "^1.6.1",
     "standard-version": "^9.3.0",
     "strip-ansi-v6": "npm:strip-ansi@^6.0.0",
-    "style-loader": "^2.0.0",
+    "style-loader": "^3.3.1",
     "supertest": "^6.1.3",
     "tcp-port-used": "^1.0.2",
-    "typescript": "^4.9.3",
-    "url-loader": "^4.1.1",
+    "typescript": "^5.3.3",
     "wait-for-expect": "^3.0.2",
-    "webpack": "^5.81.0",
-    "webpack-cli": "^4.7.2",
-    "webpack-merge": "^5.8.0"
+    "webpack": "^5.89.0",
+    "webpack-cli": "^5.0.1",
+    "webpack-merge": "^5.9.0"
   },
   "peerDependencies": {
-    "webpack": "^4.37.0 || ^5.0.0"
+    "webpack": "^5.0.0"
   },
   "peerDependenciesMeta": {
     "webpack-cli": {