test: updates

Author: snitin315

lib/options.json

@@ -212,10 +212,6 @@
           "type": "string",
           "description": "Tells clients connected to devServer to use the provided host."
         },
-        "path": {
-          "type": "string",
-          "description": "Tells clients connected to devServer to use the provided path to connect."
-        },
         "port": {
           "anyOf": [
             {
@@ -232,7 +228,7 @@
         },
         "path": {
           "type": "string",
-          "description": "Tells clients connected to devServer to use the provided port."
+          "description": "Tells clients connected to devServer to use the provided path to connect."
         },
         "logging": {
           "enum": ["none", "error", "warn", "info", "log", "verbose"],

lib/servers/WebsocketServer.js

@@ -10,7 +10,7 @@ module.exports = class WebsocketServer extends BaseServer {
   constructor(server) {
     super(server);
 
-    this.wsServer = new ws.Server({
+    this.webSocketServer = new ws.Server({
       ...this.server.options.webSocketServer.options,
       noServer: true,
     });

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

@@ -96,17 +96,28 @@ exports[`options validate should throw an error on the "client" option with '{"p
    -> Print compilation progress in percentage in the browser."
 `;
 
+exports[`options validate should throw an error on the "client" option with '{"transport":true}' value 1`] = `
+"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
+ - configuration.client.transport should be one of these:
+   \\"sockjs\\" | \\"ws\\" | non-empty string
+   -> Allows to set custom transport to communicate with server.
+   Details:
+    * configuration.client.transport should be one of these:
+      \\"sockjs\\" | \\"ws\\"
+    * configuration.client.transport should be a non-empty string."
+`;
+
 exports[`options validate should throw an error on the "client" option with '{"unknownOption":true}' value 1`] = `
 "ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
  - configuration.client has an unknown property 'unknownOption'. These properties are valid:
-   object { host?, path?, port?, logging?, progress?, overlay?, needClientEntry?, needHotEntry? }
+   object { transport?, host?, port?, path?, logging?, progress?, overlay?, needClientEntry?, needHotEntry? }
    -> Specifies client properties. https://webpack.js.org/configuration/dev-server/#devserverclient"
 `;
 
 exports[`options validate should throw an error on the "client" option with 'whoops!' value 1`] = `
 "ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
  - configuration.client should be an object:
-   object { host?, path?, port?, logging?, progress?, overlay?, needClientEntry?, needHotEntry? }
+   object { transport?, host?, port?, path?, logging?, progress?, overlay?, needClientEntry?, needHotEntry? }
    -> Specifies client properties. https://webpack.js.org/configuration/dev-server/#devserverclient"
 `;
 
@@ -489,54 +500,6 @@ exports[`options validate should throw an error on the "static" option with 'nul
       [non-empty string | object { directory?, staticOptions?, publicPath?, serveIndex?, watch? }, ...] (should not have fewer than 1 item)"
 `;
 
-exports[`options validate should throw an error on the "transportMode" option with '{"notAnOption":true}' value 1`] = `
-"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
- - configuration.transportMode has an unknown property 'notAnOption'. These properties are valid:
-   object { client?, server? }"
-`;
-
-exports[`options validate should throw an error on the "transportMode" option with '{"server":false}' value 1`] = `
-"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
- - configuration.transportMode should be one of these:
-   object { client?, server? } | \\"sockjs\\" | \\"ws\\"
-   -> This option allows us either to choose the current devServer transport mode for client/server individually or to provide custom client/server implementation. https://webpack.js.org/configuration/dev-server/#devservertransportmode
-   Details:
-    * configuration.transportMode.server should be one of these:
-      string | function
-      Details:
-       * configuration.transportMode.server should be a string.
-       * configuration.transportMode.server should be an instance of function."
-`;
-
-exports[`options validate should throw an error on the "transportMode" option with '{}' value 1`] = `
-"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
- - configuration.transportMode.client should be a string."
-`;
-
-exports[`options validate should throw an error on the "transportMode" option with 'nonexistent-implementation' value 1`] = `
-"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
- - configuration.transportMode should be one of these:
-   object { client?, server? } | \\"sockjs\\" | \\"ws\\"
-   -> This option allows us either to choose the current devServer transport mode for client/server individually or to provide custom client/server implementation. https://webpack.js.org/configuration/dev-server/#devservertransportmode
-   Details:
-    * configuration.transportMode should be an object:
-      object { client?, server? }
-    * configuration.transportMode should be one of these:
-      \\"sockjs\\" | \\"ws\\""
-`;
-
-exports[`options validate should throw an error on the "transportMode" option with 'null' value 1`] = `
-"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
- - configuration.transportMode should be one of these:
-   object { client?, server? } | \\"sockjs\\" | \\"ws\\"
-   -> This option allows us either to choose the current devServer transport mode for client/server individually or to provide custom client/server implementation. https://webpack.js.org/configuration/dev-server/#devservertransportmode
-   Details:
-    * configuration.transportMode should be an object:
-      object { client?, server? }
-    * configuration.transportMode should be one of these:
-      \\"sockjs\\" | \\"ws\\""
-`;
-
 exports[`options validate should throw an error on the "watchFiles" option with '123' value 1`] = `
 "ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
  - configuration.watchFiles should be one of these:
@@ -562,3 +525,54 @@ exports[`options validate should throw an error on the "watchFiles" option with
     * configuration.watchFiles should be an array:
       [non-empty string | object { paths?, options? }, ...]"
 `;
+
+exports[`options validate should throw an error on the "webSocketServer" option with '{"notAnOption":true}' value 1`] = `
+"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
+ - configuration.webSocketServer has an unknown property 'notAnOption'. These properties are valid:
+   object { type?, options? }"
+`;
+
+exports[`options validate should throw an error on the "webSocketServer" option with '{"type":true}' value 1`] = `
+"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
+ - configuration.webSocketServer should be one of these:
+   \\"sockjs\\" | \\"ws\\" | non-empty string | function | object { type?, options? }
+   -> Allows to set web socket server and options.
+   Details:
+    * configuration.webSocketServer.type should be one of these:
+      \\"sockjs\\" | \\"ws\\" | non-empty string | function
+      Details:
+       * configuration.webSocketServer.type should be one of these:
+         \\"sockjs\\" | \\"ws\\"
+       * configuration.webSocketServer.type should be a non-empty string.
+       * configuration.webSocketServer.type should be an instance of function."
+`;
+
+exports[`options validate should throw an error on the "webSocketServer" option with 'false' value 1`] = `
+"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
+ - configuration.webSocketServer should be one of these:
+   \\"sockjs\\" | \\"ws\\" | non-empty string | function | object { type?, options? }
+   -> Allows to set web socket server and options.
+   Details:
+    * configuration.webSocketServer should be one of these:
+      \\"sockjs\\" | \\"ws\\"
+    * configuration.webSocketServer should be a non-empty string.
+    * configuration.webSocketServer should be an instance of function.
+    * configuration.webSocketServer should be an object:
+      object { type?, options? }"
+`;
+
+exports[`options validate should throw an error on the "webSocketServer" option with 'nonexistent-implementation' value 1`] = `"Error: client.transport must be a string denoting a default implementation (e.g. 'sockjs', 'ws') or a full path to a JS file which exports a class extending BaseClient (webpack-dev-server/client-src/clients/BaseClient.js) via require.resolve(...)"`;
+
+exports[`options validate should throw an error on the "webSocketServer" option with 'null' value 1`] = `
+"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
+ - configuration.webSocketServer should be one of these:
+   \\"sockjs\\" | \\"ws\\" | non-empty string | function | object { type?, options? }
+   -> Allows to set web socket server and options.
+   Details:
+    * configuration.webSocketServer should be one of these:
+      \\"sockjs\\" | \\"ws\\"
+    * configuration.webSocketServer should be a non-empty string.
+    * configuration.webSocketServer should be an instance of function.
+    * configuration.webSocketServer should be an object:
+      object { type?, options? }"
+`;

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

@@ -96,17 +96,28 @@ exports[`options validate should throw an error on the "client" option with '{"p
    -> Print compilation progress in percentage in the browser."
 `;
 
+exports[`options validate should throw an error on the "client" option with '{"transport":true}' value 1`] = `
+"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
+ - configuration.client.transport should be one of these:
+   \\"sockjs\\" | \\"ws\\" | non-empty string
+   -> Allows to set custom transport to communicate with server.
+   Details:
+    * configuration.client.transport should be one of these:
+      \\"sockjs\\" | \\"ws\\"
+    * configuration.client.transport should be a non-empty string."
+`;
+
 exports[`options validate should throw an error on the "client" option with '{"unknownOption":true}' value 1`] = `
 "ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
  - configuration.client has an unknown property 'unknownOption'. These properties are valid:
-   object { host?, path?, port?, logging?, progress?, overlay?, needClientEntry?, needHotEntry? }
+   object { transport?, host?, port?, path?, logging?, progress?, overlay?, needClientEntry?, needHotEntry? }
    -> Specifies client properties. https://webpack.js.org/configuration/dev-server/#devserverclient"
 `;
 
 exports[`options validate should throw an error on the "client" option with 'whoops!' value 1`] = `
 "ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
  - configuration.client should be an object:
-   object { host?, path?, port?, logging?, progress?, overlay?, needClientEntry?, needHotEntry? }
+   object { transport?, host?, port?, path?, logging?, progress?, overlay?, needClientEntry?, needHotEntry? }
    -> Specifies client properties. https://webpack.js.org/configuration/dev-server/#devserverclient"
 `;
 
@@ -489,54 +500,6 @@ exports[`options validate should throw an error on the "static" option with 'nul
       [non-empty string | object { directory?, staticOptions?, publicPath?, serveIndex?, watch? }, ...] (should not have fewer than 1 item)"
 `;
 
-exports[`options validate should throw an error on the "transportMode" option with '{"notAnOption":true}' value 1`] = `
-"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
- - configuration.transportMode has an unknown property 'notAnOption'. These properties are valid:
-   object { client?, server? }"
-`;
-
-exports[`options validate should throw an error on the "transportMode" option with '{"server":false}' value 1`] = `
-"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
- - configuration.transportMode should be one of these:
-   object { client?, server? } | \\"sockjs\\" | \\"ws\\"
-   -> This option allows us either to choose the current devServer transport mode for client/server individually or to provide custom client/server implementation. https://webpack.js.org/configuration/dev-server/#devservertransportmode
-   Details:
-    * configuration.transportMode.server should be one of these:
-      string | function
-      Details:
-       * configuration.transportMode.server should be a string.
-       * configuration.transportMode.server should be an instance of function."
-`;
-
-exports[`options validate should throw an error on the "transportMode" option with '{}' value 1`] = `
-"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
- - configuration.transportMode.client should be a string."
-`;
-
-exports[`options validate should throw an error on the "transportMode" option with 'nonexistent-implementation' value 1`] = `
-"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
- - configuration.transportMode should be one of these:
-   object { client?, server? } | \\"sockjs\\" | \\"ws\\"
-   -> This option allows us either to choose the current devServer transport mode for client/server individually or to provide custom client/server implementation. https://webpack.js.org/configuration/dev-server/#devservertransportmode
-   Details:
-    * configuration.transportMode should be an object:
-      object { client?, server? }
-    * configuration.transportMode should be one of these:
-      \\"sockjs\\" | \\"ws\\""
-`;
-
-exports[`options validate should throw an error on the "transportMode" option with 'null' value 1`] = `
-"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
- - configuration.transportMode should be one of these:
-   object { client?, server? } | \\"sockjs\\" | \\"ws\\"
-   -> This option allows us either to choose the current devServer transport mode for client/server individually or to provide custom client/server implementation. https://webpack.js.org/configuration/dev-server/#devservertransportmode
-   Details:
-    * configuration.transportMode should be an object:
-      object { client?, server? }
-    * configuration.transportMode should be one of these:
-      \\"sockjs\\" | \\"ws\\""
-`;
-
 exports[`options validate should throw an error on the "watchFiles" option with '123' value 1`] = `
 "ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
  - configuration.watchFiles should be one of these:
@@ -562,3 +525,54 @@ exports[`options validate should throw an error on the "watchFiles" option with
     * configuration.watchFiles should be an array:
       [non-empty string | object { paths?, options? }, ...]"
 `;
+
+exports[`options validate should throw an error on the "webSocketServer" option with '{"notAnOption":true}' value 1`] = `
+"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
+ - configuration.webSocketServer has an unknown property 'notAnOption'. These properties are valid:
+   object { type?, options? }"
+`;
+
+exports[`options validate should throw an error on the "webSocketServer" option with '{"type":true}' value 1`] = `
+"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
+ - configuration.webSocketServer should be one of these:
+   \\"sockjs\\" | \\"ws\\" | non-empty string | function | object { type?, options? }
+   -> Allows to set web socket server and options.
+   Details:
+    * configuration.webSocketServer.type should be one of these:
+      \\"sockjs\\" | \\"ws\\" | non-empty string | function
+      Details:
+       * configuration.webSocketServer.type should be one of these:
+         \\"sockjs\\" | \\"ws\\"
+       * configuration.webSocketServer.type should be a non-empty string.
+       * configuration.webSocketServer.type should be an instance of function."
+`;
+
+exports[`options validate should throw an error on the "webSocketServer" option with 'false' value 1`] = `
+"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
+ - configuration.webSocketServer should be one of these:
+   \\"sockjs\\" | \\"ws\\" | non-empty string | function | object { type?, options? }
+   -> Allows to set web socket server and options.
+   Details:
+    * configuration.webSocketServer should be one of these:
+      \\"sockjs\\" | \\"ws\\"
+    * configuration.webSocketServer should be a non-empty string.
+    * configuration.webSocketServer should be an instance of function.
+    * configuration.webSocketServer should be an object:
+      object { type?, options? }"
+`;
+
+exports[`options validate should throw an error on the "webSocketServer" option with 'nonexistent-implementation' value 1`] = `"Error: client.transport must be a string denoting a default implementation (e.g. 'sockjs', 'ws') or a full path to a JS file which exports a class extending BaseClient (webpack-dev-server/client-src/clients/BaseClient.js) via require.resolve(...)"`;
+
+exports[`options validate should throw an error on the "webSocketServer" option with 'null' value 1`] = `
+"ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
+ - configuration.webSocketServer should be one of these:
+   \\"sockjs\\" | \\"ws\\" | non-empty string | function | object { type?, options? }
+   -> Allows to set web socket server and options.
+   Details:
+    * configuration.webSocketServer should be one of these:
+      \\"sockjs\\" | \\"ws\\"
+    * configuration.webSocketServer should be a non-empty string.
+    * configuration.webSocketServer should be an instance of function.
+    * configuration.webSocketServer should be an object:
+      object { type?, options? }"
+`;

test/e2e/ProvidePlugin.test.js

@@ -8,7 +8,7 @@ const port = require('../ports-map').ProvidePlugin;
 const { beforeBrowserCloseDelay } = require('../helpers/puppeteer-constants');
 
 describe('ProvidePlugin', () => {
-  describe('default transportMode.client (ws)', () => {
+  describe('default client.transport (ws)', () => {
     beforeAll((done) => {
       const options = {
         port,
@@ -40,12 +40,14 @@ describe('ProvidePlugin', () => {
     });
   });
 
-  describe('with transportMode.client sockjs', () => {
+  describe('with client.transport sockjs', () => {
     beforeAll((done) => {
       const options = {
         port,
         host: '0.0.0.0',
-        transportMode: 'sockjs',
+        client: {
+          transport: 'sockjs',
+        },
       };
       testServer.startAwaitingCompilation(sockjsConfig, options, done);
     });