refactor: allow to set client: false

Author: alexander-akait

lib/Server.js

@@ -45,7 +45,7 @@ class Server {
   initialize() {
     this.applyDevServerPlugin();
 
-    if (this.options.client.progress) {
+    if (this.options.client && this.options.client.progress) {
       this.setupProgressPlugin();
     }
 
@@ -715,15 +715,15 @@ class Server {
         this.sendMessage([connection], 'liveReload');
       }
 
-      if (this.options.client.progress) {
+      if (this.options.client && this.options.client.progress) {
         this.sendMessage(
           [connection],
           'progress',
           this.options.client.progress
         );
       }
 
-      if (this.options.client.overlay) {
+      if (this.options.client && this.options.client.overlay) {
         this.sendMessage([connection], 'overlay', this.options.client.overlay);
       }
 
@@ -1224,7 +1224,10 @@ class Server {
     }
 
     // Also allow if `client.webSocketURL.hostname` provided
-    if (typeof this.options.client.webSocketURL !== 'undefined') {
+    if (
+      this.options.client &&
+      typeof this.options.client.webSocketURL !== 'undefined'
+    ) {
       return this.options.client.webSocketURL.hostname === hostname;
     }
 

lib/utils/DevServerPlugin.js

@@ -24,10 +24,14 @@ class DevServerPlugin {
 
     let clientTransport;
 
-    if (typeof this.options.client.transport !== 'undefined') {
-      clientTransport = this.options.client.transport;
-    } else if (isKnownWebSocketServerImplementation) {
-      clientTransport = this.options.webSocketServer.type;
+    if (this.options.client) {
+      if (typeof this.options.client.transport !== 'undefined') {
+        clientTransport = this.options.client.transport;
+      } else if (isKnownWebSocketServerImplementation) {
+        clientTransport = this.options.webSocketServer.type;
+      }
+    } else {
+      clientTransport = 'ws';
     }
 
     switch (typeof clientTransport) {
@@ -191,7 +195,7 @@ class DevServerPlugin {
   getHotEntry() {
     const { options } = this;
 
-    /** @type {(string[] | string | undefined)} */
+    /** @type {(string[] | string)} */
     let hotEntry;
 
     if (options.hot === 'only') {
@@ -239,18 +243,19 @@ class DevServerPlugin {
 
     const additionalEntries = [];
 
-    const clientEntry = this.getClientEntry();
-
     if (
+      this.options.client &&
       this.isWebTarget(compiler.options) &&
       (Boolean(this.options.hot) || this.options.liveReload)
     ) {
+      const clientEntry = this.getClientEntry();
+
       additionalEntries.push(clientEntry);
     }
 
-    const hotEntry = this.getHotEntry();
+    if (this.options.hot) {
+      const hotEntry = this.getHotEntry();
 
-    if (hotEntry && Boolean(this.options.hot)) {
       additionalEntries.push(hotEntry);
     }
 
@@ -329,7 +334,7 @@ class DevServerPlugin {
     compiler.options.plugins = compiler.options.plugins || [];
 
     if (
-      hotEntry &&
+      this.options.hot &&
       !compiler.options.plugins.find(
         (p) => p.constructor === webpack.HotModuleReplacementPlugin
       )

lib/utils/normalizeOptions.js

@@ -39,36 +39,43 @@ function normalizeOptions(compiler, options, logger, cacheDir) {
     options.allowedHosts = [options.allowedHosts];
   }
 
-  if (!options.client) {
-    options.client = {};
-  }
+  if (
+    typeof options.client === 'undefined' ||
+    (typeof options.client === 'object' && options.client !== null)
+  ) {
+    if (!options.client) {
+      options.client = {};
+    }
 
-  if (typeof options.client.webSocketURL === 'undefined') {
-    options.client.webSocketURL = {};
-  } else if (typeof options.client.webSocketURL === 'string') {
-    const parsedURL = new URL(options.client.webSocketURL);
-
-    options.client.webSocketURL = {
-      protocol: parsedURL.protocol,
-      hostname: parsedURL.hostname,
-      port: parsedURL.port.length > 0 ? Number(parsedURL.port) : '',
-      pathname: parsedURL.pathname,
-      username: parsedURL.username,
-      password: parsedURL.password,
-    };
-  } else if (typeof options.client.webSocketURL.port === 'string') {
-    options.client.webSocketURL.port = Number(options.client.webSocketURL.port);
-  }
+    if (typeof options.client.webSocketURL === 'undefined') {
+      options.client.webSocketURL = {};
+    } else if (typeof options.client.webSocketURL === 'string') {
+      const parsedURL = new URL(options.client.webSocketURL);
+
+      options.client.webSocketURL = {
+        protocol: parsedURL.protocol,
+        hostname: parsedURL.hostname,
+        port: parsedURL.port.length > 0 ? Number(parsedURL.port) : '',
+        pathname: parsedURL.pathname,
+        username: parsedURL.username,
+        password: parsedURL.password,
+      };
+    } else if (typeof options.client.webSocketURL.port === 'string') {
+      options.client.webSocketURL.port = Number(
+        options.client.webSocketURL.port
+      );
+    }
 
-  // Enable client overlay by default
-  if (typeof options.client.overlay === 'undefined') {
-    options.client.overlay = true;
-  } else if (typeof options.client.overlay !== 'boolean') {
-    options.client.overlay = {
-      errors: true,
-      warnings: true,
-      ...options.client.overlay,
-    };
+    // Enable client overlay by default
+    if (typeof options.client.overlay === 'undefined') {
+      options.client.overlay = true;
+    } else if (typeof options.client.overlay !== 'boolean') {
+      options.client.overlay = {
+        errors: true,
+        warnings: true,
+        ...options.client.overlay,
+      };
+    }
   }
 
   if (typeof options.compress === 'undefined') {