chore(client): rename clientOptions to client (#2655)

webpack · Jun 24, 2020 · eb9c58d · eb9c58d
1 parent e4761bf
commit eb9c58d
Show file tree

Hide file tree

Showing 20 changed files with 89 additions and 103 deletions.
diff --git a/lib/Server.js b/lib/Server.js
@@ -634,12 +634,8 @@ class Server {
         }
       });
 
-      if (this.options.clientOptions.logging) {
-        this.sockWrite(
-          [connection],
-          'logging',
-          this.options.clientOptions.logging
-        );
+      if (this.options.client.logging) {
+        this.sockWrite([connection], 'logging', this.options.client.logging);
       }
 
       if (this.options.hot === true || this.options.hot === 'only') {

diff --git a/lib/options.json b/lib/options.json
@@ -10,7 +10,7 @@
     "bonjour": {
       "type": "boolean"
     },
-    "clientOptions": {
+    "client": {
       "type": "object",
       "properties": {
         "host": {
@@ -390,7 +390,7 @@
     "properties": {
       "allowedHosts": "should be {Array} (https://webpack.js.org/configuration/dev-server/#devserverallowedhosts)",
       "bonjour": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverbonjour)",
-      "clientOptions": "should be {Object} (https://webpack.js.org/configuration/dev-server/#devserverclientoptions)",
+      "client": "should be {Object} (https://webpack.js.org/configuration/dev-server/#devserverclient)",
       "compress": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devservercompress)",
       "contentBase": "should be {Number|String|Array} (https://webpack.js.org/configuration/dev-server/#devservercontentbase)",
       "disableHostCheck": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverdisablehostcheck)",

diff --git a/lib/servers/SockJSServer.js b/lib/servers/SockJSServer.js
@@ -47,7 +47,7 @@ module.exports = class SockJSServer extends BaseServer {
     });
 
     this.socket.installHandlers(this.server.listeningApp, {
-      prefix: this.server.options.clientOptions.path,
+      prefix: this.server.options.client.path,
     });
   }
 

diff --git a/lib/servers/WebsocketServer.js b/lib/servers/WebsocketServer.js
@@ -12,7 +12,7 @@ module.exports = class WebsocketServer extends BaseServer {
 
     this.wsServer = new ws.Server({
       noServer: true,
-      path: this.server.options.clientOptions.path,
+      path: this.server.options.client.path,
     });
 
     this.server.listeningApp.on('upgrade', (req, sock, head) => {

diff --git a/lib/utils/addEntries.js b/lib/utils/addEntries.js
@@ -30,24 +30,16 @@ function addEntries(config, options, server) {
   const domain = createDomain(options, app);
   /** @type {string} */
   const host =
-    options.clientOptions && options.clientOptions.host
-      ? `&host=${options.clientOptions.host}`
-      : '';
+    options.client && options.client.host ? `&host=${options.client.host}` : '';
   /** @type {string} */
   let path = '';
   // only add the path if it is not default
-  if (
-    options.clientOptions &&
-    options.clientOptions.path &&
-    options.clientOptions.path !== '/ws'
-  ) {
-    path = `&path=${options.clientOptions.path}`;
+  if (options.client && options.client.path && options.client.path !== '/ws') {
+    path = `&path=${options.client.path}`;
   }
   /** @type {string} */
   const port =
-    options.clientOptions && options.clientOptions.port
-      ? `&port=${options.clientOptions.port}`
-      : '';
+    options.client && options.client.port ? `&port=${options.client.port}` : '';
   /** @type {string} */
   const clientEntry = `${require.resolve(
     '../../client/default/'

diff --git a/lib/utils/createConfig.js b/lib/utils/createConfig.js
@@ -81,10 +81,10 @@ function createConfig(config, argv, { port }) {
   }
 
   if (argv.clientLogging) {
-    if (options.clientOptions) {
-      options.clientOptions.logging = argv.clientLogging;
+    if (options.client) {
+      options.client.logging = argv.clientLogging;
     } else {
-      options.clientOptions = {
+      options.client = {
         logging: argv.clientLogging,
       };
     }

diff --git a/lib/utils/normalizeOptions.js b/lib/utils/normalizeOptions.js
@@ -42,14 +42,12 @@ function normalizeOptions(compiler, options) {
     }
   }
 
-  if (!options.clientOptions) {
-    options.clientOptions = {};
+  if (!options.client) {
+    options.client = {};
   }
 
-  options.clientOptions.path = `/${
-    options.clientOptions.path
-      ? options.clientOptions.path.replace(/^\/|\/$/g, '')
-      : 'ws'
+  options.client.path = `/${
+    options.client.path ? options.client.path.replace(/^\/|\/$/g, '') : 'ws'
   }`;
 }
 

diff --git a/test/__snapshots__/Validation.test.js.snap b/test/__snapshots__/Validation.test.js.snap
@@ -31,5 +31,5 @@ exports[`Validation validation should fail validation for invalid \`writeToDisk\
 exports[`Validation validation should fail validation for no additional properties 1`] = `
 "Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
  - configuration has an unknown property 'additional'. These properties are valid:
-   object { allowedHosts?, bonjour?, clientOptions?, compress?, contentBasePublicPath?, contentBase?, disableHostCheck?, fs?, headers?, historyApiFallback?, host?, hot?, http2?, https?, index?, injectClient?, injectHot?, liveReload?, mimeTypes?, onAfterSetupMiddleware?, onBeforeSetupMiddleware?, onListening?, open?, openPage?, overlay?, port?, profile?, progress?, proxy?, public?, publicPath?, requestCert?, serveIndex?, serverSideRender?, socket?, staticOptions?, stats?, transportMode?, useLocalIp?, watchContentBase?, watchOptions?, writeToDisk? }"
+   object { allowedHosts?, bonjour?, client?, compress?, contentBasePublicPath?, contentBase?, disableHostCheck?, fs?, headers?, historyApiFallback?, host?, hot?, http2?, https?, index?, injectClient?, injectHot?, liveReload?, mimeTypes?, onAfterSetupMiddleware?, onBeforeSetupMiddleware?, onListening?, open?, openPage?, overlay?, port?, profile?, progress?, proxy?, public?, publicPath?, requestCert?, serveIndex?, serverSideRender?, socket?, staticOptions?, stats?, transportMode?, useLocalIp?, watchContentBase?, watchOptions?, writeToDisk? }"
 `;
diff --git a/test/e2e/ClientOptions.test.js b/test/e2e/ClientOptions.test.js
@@ -162,7 +162,7 @@ describe('sockjs public and client path', () => {
         poll: true,
       },
       public: 'myhost.test',
-      clientOptions: {
+      client: {
         path: '/foo/test/bar/',
       },
     };
@@ -203,7 +203,7 @@ describe('sockjs client path and port', () => {
       watchOptions: {
         poll: true,
       },
-      clientOptions: {
+      client: {
         path: '/foo/test/bar/',
         port: port3,
       },
@@ -249,7 +249,7 @@ describe('sockjs client port, no path', () => {
       watchOptions: {
         poll: true,
       },
-      clientOptions: {
+      client: {
         port: port3,
       },
     };
@@ -288,7 +288,7 @@ describe('sockjs client host', () => {
       watchOptions: {
         poll: true,
       },
-      clientOptions: {
+      client: {
         host: 'myhost.test',
       },
     };
@@ -327,7 +327,7 @@ describe('ws client host, port, and path', () => {
       watchOptions: {
         poll: true,
       },
-      clientOptions: {
+      client: {
         host: 'myhost',
         port: port3,
         path: '/foo/test/bar/',
@@ -407,7 +407,7 @@ describe('Client console.log', () => {
     {
       title: 'client logging is none',
       options: {
-        clientOptions: {
+        client: {
           logging: 'none',
         },
       },

diff --git a/test/options.test.js b/test/options.test.js
@@ -130,73 +130,73 @@ describe('options', () => {
         success: [false],
         failure: [''],
       },
-      clientOptions: {
+      client: {
         success: [
           {
-            clientOptions: {},
+            client: {},
           },
           {
-            clientOptions: {
+            client: {
               host: '',
             },
           },
           {
-            clientOptions: {
+            client: {
               path: '',
             },
           },
           {
-            clientOptions: {
+            client: {
               port: '',
             },
           },
           {
-            clientOptions: {
+            client: {
               logging: 'none',
             },
           },
           {
-            clientOptions: {
+            client: {
               logging: 'error',
             },
           },
           {
-            clientOptions: {
+            client: {
               logging: 'warn',
             },
           },
           {
-            clientOptions: {
+            client: {
               logging: 'info',
             },
           },
           {
-            clientOptions: {
+            client: {
               logging: 'log',
             },
           },
           {
-            clientOptions: {
+            client: {
               logging: 'verbose',
             },
           },
           {
-            clientOptions: {
+            client: {
               host: '',
               path: '',
               port: 8080,
               logging: 'none',
             },
           },
           {
-            clientOptions: {
+            client: {
               host: '',
               path: '',
               port: '',
             },
           },
           {
-            clientOptions: {
+            client: {
               host: '',
               path: '',
               port: null,
@@ -206,24 +206,24 @@ describe('options', () => {
         failure: [
           'whoops!',
           {
-            clientOptions: {
+            client: {
               unknownOption: true,
             },
           },
           {
-            clientOptions: {
+            client: {
               host: true,
               path: '',
               port: 8080,
             },
           },
           {
-            clientOptions: {
+            client: {
               logging: 'whoops!',
             },
           },
           {
-            clientOptions: {
+            client: {
               logging: 'silent',
             },
           },

diff --git a/test/ports-map.js b/test/ports-map.js
@@ -30,7 +30,7 @@ const portsList = {
   'port-option': 1,
   'proxy-option': 4,
   'transportMode-option': 1,
-  'clientOptions-option': 1,
+  'client-option': 1,
   'stats-option': 1,
   ProvidePlugin: 1,
   WebsocketClient: 1,

diff --git a/test/server/clientOptions-option.test.js b/test/server/clientOptions-option.test.js
@@ -3,9 +3,9 @@
 const request = require('supertest');
 const config = require('../fixtures/simple-config/webpack.config');
 const testServer = require('../helpers/test-server');
-const port = require('../ports-map')['clientOptions-option'];
+const port = require('../ports-map')['client-option'];
 
-describe('clientOptions option', () => {
+describe('client option', () => {
   let server;
   let req;
 
@@ -30,7 +30,7 @@ describe('clientOptions option', () => {
 
     it('defaults to a path', () => {
       expect(
-        server.options.clientOptions.path.match(/\/[a-z0-9\-/]+[^/]$/)
+        server.options.client.path.match(/\/[a-z0-9\-/]+[^/]$/)
       ).toBeTruthy();
     });
 
@@ -47,7 +47,7 @@ describe('clientOptions option', () => {
         config,
         {
           transportMode: 'sockjs',
-          clientOptions: {
+          client: {
             path: '/foo/test/bar/',
           },
           port,
@@ -58,7 +58,7 @@ describe('clientOptions option', () => {
     });
 
     it('sets the sock path correctly and strips leading and trailing /s', () => {
-      expect(server.options.clientOptions.path).toEqual(path);
+      expect(server.options.client.path).toEqual(path);
     });
 
     it('responds with a 200 second', (done) => {

diff --git a/test/server/servers/SockJSServer.test.js b/test/server/servers/SockJSServer.test.js
@@ -23,7 +23,7 @@ describe('SockJSServer', () => {
           debug: () => {},
         },
         options: {
-          clientOptions: {
+          client: {
             path: '/ws',
           },
         },

diff --git a/test/server/servers/WebsocketServer.test.js b/test/server/servers/WebsocketServer.test.js
@@ -19,7 +19,7 @@ describe('WebsocketServer', () => {
     listeningApp.listen(port, 'localhost', () => {
       server = {
         options: {
-          clientOptions: {
+          client: {
             path: '/ws-server',
           },
         },

diff --git a/test/server/transportMode-option.test.js b/test/server/transportMode-option.test.js
@@ -282,7 +282,7 @@ describe('transportMode', () => {
                     });
 
                     this.socket.installHandlers(this.server.listeningApp, {
-                      prefix: this.server.options.clientOptions.path,
+                      prefix: this.server.options.client.path,
                     });
                   }
 
@@ -378,7 +378,7 @@ describe('transportMode', () => {
                     });
 
                     this.socket.installHandlers(this.server.listeningApp, {
-                      prefix: this.server.options.clientOptions.path,
+                      prefix: this.server.options.client.path,
                     });
                   }
 

diff --git a/test/server/utils/__snapshots__/createConfig.test.js.snap b/test/server/utils/__snapshots__/createConfig.test.js.snap
@@ -75,7 +75,7 @@ Object {
 
 exports[`createConfig clientLogging option 1`] = `
 Object {
-  "clientOptions": Object {
+  "client": Object {
     "logging": "none",
   },
   "hot": true,
@@ -90,7 +90,7 @@ Object {
 
 exports[`createConfig clientLogging option overrides devServer config 1`] = `
 Object {
-  "clientOptions": Object {
+  "client": Object {
     "logging": "none",
   },
   "hot": true,
-Original file line number
+Diff line change
@@ Expand Up / @@ -47,7 +47,7 @@ module.exports = class SockJSServer extends BaseServer { @@
         });
         this.socket.installHandlers(this.server.listeningApp, {
-          prefix: this.server.options.clientOptions.path,
+          prefix: this.server.options.client.path,
         });
       }
@@ Expand Down @@