refactor!: remove the https and the http2 option (#4661)

Author: snitin315

lib/Server.js

@@ -988,40 +988,13 @@ class Server {
  ? options.hot
  : true;
 
- const isHTTPs = Boolean(options.https);
- const isSPDY = Boolean(options.http2);
-
- if (isHTTPs) {
- // TODO: remove in the next major release
- util.deprecate(
- () => {},
- "'https' option is deprecated. Please use the 'server' option.",
- "DEP_WEBPACK_DEV_SERVER_HTTPS"
- )();
- }
-
- if (isSPDY) {
- // TODO: remove in the next major release
- util.deprecate(
- () => {},
- "'http2' option is deprecated. Please use the 'server' option.",
- "DEP_WEBPACK_DEV_SERVER_HTTP2"
- )();
- }
-
  options.server = {
  type:
  // eslint-disable-next-line no-nested-ternary
  typeof options.server === "string"
  ? options.server
- : // eslint-disable-next-line no-nested-ternary
- typeof (options.server || {}).type === "string"
+ : typeof (options.server || {}).type === "string"
  ? /** @type {ServerConfiguration} */ (options.server).type || "http"
- : // eslint-disable-next-line no-nested-ternary
- isSPDY
- ? "spdy"
- : isHTTPs
- ? "https"
  : "http",
  options: {
  .../** @type {ServerOptions} */ (options.https),

lib/options.json

@@ -240,195 +240,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,
@@ -1187,12 +998,6 @@
  "hot": {
  "$ref": "#/definitions/Hot"
  },
- "http2": {
- "$ref": "#/definitions/HTTP2"
- },
- "https": {
- "$ref": "#/definitions/HTTPS"
- },
  "ipc": {
  "$ref": "#/definitions/IPC"
  },

test/__snapshots__/validate-options.test.js.snap.webpack5

@@ -345,105 +345,6 @@ exports[`options validate should throw an error on the "hot" option with 'foo' v
  * options.hot should be \\"only\\"."
 `;
 
-exports[`options validate should throw an error on the "http2" option with '' value 1`] = `
-"ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
- - options.http2 should be a boolean.
- -> Allows to serve over HTTP/2 using SPDY. Deprecated, use the \`server\` option.
- -> Read more at https://webpack.js.org/configuration/dev-server/#devserverhttp2"
-`;
-
-exports[`options validate should throw an error on the "https" option with '' value 1`] = `
-"ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
- - options.https should be one of these:
- boolean | object { passphrase?, requestCert?, ca?, cacert?, cert?, crl?, key?, pfx?, … }
- -> Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP). Deprecated, use the \`server\` option.
- -> Read more at https://webpack.js.org/configuration/dev-server/#devserverhttps
- Details:
- * options.https should be a boolean.
- * options.https should be an object:
- object { passphrase?, requestCert?, ca?, cacert?, cert?, crl?, key?, pfx?, … }"
-`;
-
-exports[`options validate should throw an error on the "https" option with '{"cacert":true}' value 1`] = `
-"ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
- - options.https should be one of these:
- boolean | object { passphrase?, requestCert?, ca?, cacert?, cert?, crl?, key?, pfx?, … }
- -> Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP). Deprecated, use the \`server\` option.
- -> Read more at https://webpack.js.org/configuration/dev-server/#devserverhttps
- Details:
- * options.https.cacert should be one of these:
- [string | Buffer, ...] | string | Buffer
- -> Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the \`server.options.ca\` option.
- Details:
- * options.https.cacert should be an array:
- [string | Buffer, ...]
- * options.https.cacert should be a string.
- * options.https.cacert should be an instance of Buffer."
-`;
-
-exports[`options validate should throw an error on the "https" option with '{"cert":true}' value 1`] = `
-"ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
- - options.https should be one of these:
- boolean | object { passphrase?, requestCert?, ca?, cacert?, cert?, crl?, key?, pfx?, … }
- -> Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP). Deprecated, use the \`server\` option.
- -> Read more at https://webpack.js.org/configuration/dev-server/#devserverhttps
- Details:
- * options.https.cert should be one of these:
- [string | Buffer, ...] | string | Buffer
- -> Path to an SSL certificate or content of an SSL certificate. Deprecated, use the \`server.options.cert\` option.
- Details:
- * options.https.cert should be an array:
- [string | Buffer, ...]
- * options.https.cert should be a string.
- * options.https.cert should be an instance of Buffer."
-`;
-
-exports[`options validate should throw an error on the "https" option with '{"key":10}' value 1`] = `
-"ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
- - options.https should be one of these:
- boolean | object { passphrase?, requestCert?, ca?, cacert?, cert?, crl?, key?, pfx?, … }
- -> Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP). Deprecated, use the \`server\` option.
- -> Read more at https://webpack.js.org/configuration/dev-server/#devserverhttps
- Details:
- * options.https.key should be one of these:
- [string | Buffer | object { … }, ...] | string | Buffer
- -> Path to an SSL key or content of an SSL key. Deprecated, use the \`server.options.key\` option.
- Details:
- * options.https.key should be an array:
- [string | Buffer | object { … }, ...]
- * options.https.key should be a string.
- * options.https.key should be an instance of Buffer."
-`;
-
-exports[`options validate should throw an error on the "https" option with '{"passphrase":false}' value 1`] = `
-"ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
- - options.https.passphrase should be a string.
- -> Passphrase for a pfx file. Deprecated, use the \`server.options.passphrase\` option."
-`;
-
-exports[`options validate should throw an error on the "https" option with '{"pfx":10}' value 1`] = `
-"ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
- - options.https should be one of these:
- boolean | object { passphrase?, requestCert?, ca?, cacert?, cert?, crl?, key?, pfx?, … }
- -> Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP). Deprecated, use the \`server\` option.
- -> Read more at https://webpack.js.org/configuration/dev-server/#devserverhttps
- Details:
- * options.https.pfx should be one of these:
- [string | Buffer | object { … }, ...] | string | Buffer
- -> Path to an SSL pfx file or content of an SSL pfx file. Deprecated, use the \`server.options.pfx\` option.
- Details:
- * options.https.pfx should be an array:
- [string | Buffer | object { … }, ...]
- * options.https.pfx should be a string.
- * options.https.pfx should be an instance of Buffer."
-`;
-
-exports[`options validate should throw an error on the "https" option with '{"requestCert":"test"}' value 1`] = `
-"ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
- - options.https.requestCert should be a boolean.
- -> Request for an SSL certificate. Deprecated, use the \`server.options.requestCert\` option."
-`;
-
 exports[`options validate should throw an error on the "ipc" option with '{}' value 1`] = `
 "ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
  - options.ipc should be one of these:

test/cli/__snapshots__/basic.test.js.snap.webpack5

@@ -89,25 +89,6 @@ Options:
  --host <value> Allows to specify a hostname to use.
  --hot [value] Enables Hot Module Replacement.
  --no-hot Disables Hot Module Replacement.
- --http2 Allows to serve over HTTP/2 using SPDY. Deprecated, use the \`server\` option.
- --no-http2 Does not serve over HTTP/2 using SPDY.
- --https Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP). Deprecated, use the \`server\` option.
- --no-https Disallows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP).
- --https-passphrase <value> Passphrase for a pfx file. Deprecated, use the \`server.options.passphrase\` option.
- --https-request-cert Request for an SSL certificate. Deprecated, use the \`server.options.requestCert\` option.
- --no-https-request-cert Does not request for an SSL certificate.
- --https-ca <value...> Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the \`server.options.ca\` option.
- --https-ca-reset Clear all items provided in 'https.ca' configuration. Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the \`server.options.ca\` option.
- --https-cacert <value...> Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the \`server.options.ca\` option.
- --https-cacert-reset Clear all items provided in 'https.cacert' configuration. Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the \`server.options.ca\` option.
- --https-cert <value...> Path to an SSL certificate or content of an SSL certificate. Deprecated, use the \`server.options.cert\` option.
- --https-cert-reset Clear all items provided in 'https.cert' configuration. Path to an SSL certificate or content of an SSL certificate. Deprecated, use the \`server.options.cert\` option.
- --https-crl <value...> Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists). Deprecated, use the \`server.options.crl\` option.
- --https-crl-reset Clear all items provided in 'https.crl' configuration. Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists). Deprecated, use the \`server.options.crl\` option.
- --https-key <value...> Path to an SSL key or content of an SSL key. Deprecated, use the \`server.options.key\` option.
- --https-key-reset Clear all items provided in 'https.key' configuration. Path to an SSL key or content of an SSL key. Deprecated, use the \`server.options.key\` option.
- --https-pfx <value...> Path to an SSL pfx file or content of an SSL pfx file. Deprecated, use the \`server.options.pfx\` option.
- --https-pfx-reset Clear all items provided in 'https.pfx' configuration. Path to an SSL pfx file or content of an SSL pfx file. Deprecated, use the \`server.options.pfx\` option.
  --ipc [value] Listen to a unix socket.
  --live-reload Enables reload/refresh the page(s) when file changes are detected (enabled by default).
  --no-live-reload Disables reload/refresh the page(s) when file changes are detected (enabled by default).

test/cli/__snapshots__/bonjour-option.test.js.snap.webpack5

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`"bonjour" CLI option should work using "--bonjour and --https" 1`] = `
+exports[`"bonjour" CLI option should work using "--bonjour and --server-type=https" 1`] = `
 "<i> [webpack-dev-server] Generating SSL certificate...
 <i> [webpack-dev-server] SSL certificate: <cwd>/node_modules/.cache/webpack-dev-server/server.pem
 <i> [webpack-dev-server] Project is running at: