feat: ipc

.github/workflows/nodejs.yml

@@ -105,7 +105,7 @@ jobs:
           npm link webpack-dev-server
 
       - name: Run tests for webpack version ${{ matrix.webpack-version }}
-        run: npm run test:coverage -- --ci
+        run: node_modules/.bin/jest test/e2e/ipc.test.js --ci
 
       - name: Submit coverage data to codecov
         uses: codecov/codecov-action@v1

README.md

@@ -130,6 +130,7 @@ Options:
   --https-key <value>                       Path to an SSL key.
   --https-pfx <value>                       Path to an SSL pfx file.
   --https-cert <value>                      Path to an SSL certificate.
+  --ipc [value]                             Listen to a unix socket. https://webpack.js.org/configuration/dev-server/#devserveripc
   --live-reload                             Enables reload/refresh the page(s) when file changes are detected (enabled by default).
                                             https://webpack.js.org/configuration/dev-server/#devserverlivereload
   --no-live-reload                          Negative 'live-reload' option.

bin/cli-flags.js

@@ -510,6 +510,29 @@ module.exports = {
     simpleType: 'string',
     multiple: false,
   },
+  ipc: {
+    configs: [
+      {
+        type: 'string',
+        multiple: false,
+        description:
+          'Listen to a unix socket. https://webpack.js.org/configuration/dev-server/#devserveripc',
+        path: 'ipc',
+      },
+      {
+        type: 'enum',
+        values: [true],
+        multiple: false,
+        description:
+          'Listen to a unix socket. https://webpack.js.org/configuration/dev-server/#devserveripc',
+        path: 'ipc',
+      },
+    ],
+    description:
+      'Listen to a unix socket. https://webpack.js.org/configuration/dev-server/#devserveripc',
+    simpleType: 'string',
+    multiple: false,
+  },
   'live-reload': {
     configs: [
       {

lib/Server.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const net = require('net');
 const path = require('path');
 const fs = require('fs');
 const url = require('url');
@@ -759,94 +760,105 @@ class Server {
     };
 
     const useColor = getColorsOption(getCompilerConfigArray(this.compiler));
-    const protocol = this.options.https ? 'https' : 'http';
-    const { address, port } = this.server.address();
-    const prettyPrintUrl = (newHostname) =>
-      url.format({ protocol, hostname: newHostname, port, pathname: '/' });
-
-    let server;
-    let localhost;
-    let loopbackIPv4;
-    let loopbackIPv6;
-    let networkUrlIPv4;
-    let networkUrlIPv6;
-
-    if (this.options.host) {
-      if (this.options.host === 'localhost') {
-        localhost = prettyPrintUrl('localhost');
-      } else {
-        let isIP;
 
-        try {
-          isIP = ipaddr.parse(this.options.host);
-        } catch (error) {
-          // Ignore
-        }
+    if (this.options.ipc) {
+      this.logger.info(`Project is running at: "${this.server.address()}"`);
+    } else {
+      const protocol = this.options.https ? 'https' : 'http';
+      const { address, port } = this.server.address();
+      const prettyPrintUrl = (newHostname) =>
+        url.format({ protocol, hostname: newHostname, port, pathname: '/' });
+
+      let server;
+      let localhost;
+      let loopbackIPv4;
+      let loopbackIPv6;
+      let networkUrlIPv4;
+      let networkUrlIPv6;
+
+      if (this.options.host) {
+        if (this.options.host === 'localhost') {
+          localhost = prettyPrintUrl('localhost');
+        } else {
+          let isIP;
 
-        if (!isIP) {
-          server = prettyPrintUrl(this.options.host);
+          try {
+            isIP = ipaddr.parse(this.options.host);
+          } catch (error) {
+            // Ignore
+          }
+
+          if (!isIP) {
+            server = prettyPrintUrl(this.options.host);
+          }
         }
       }
-    }
 
-    const parsedIP = ipaddr.parse(address);
+      const parsedIP = ipaddr.parse(address);
 
-    if (parsedIP.range() === 'unspecified') {
-      localhost = prettyPrintUrl('localhost');
+      if (parsedIP.range() === 'unspecified') {
+        localhost = prettyPrintUrl('localhost');
 
-      const networkIPv4 = internalIp.v4.sync();
+        const networkIPv4 = internalIp.v4.sync();
 
-      if (networkIPv4) {
-        networkUrlIPv4 = prettyPrintUrl(networkIPv4);
-      }
+        if (networkIPv4) {
+          networkUrlIPv4 = prettyPrintUrl(networkIPv4);
+        }
 
-      const networkIPv6 = internalIp.v6.sync();
+        const networkIPv6 = internalIp.v6.sync();
 
-      if (networkIPv6) {
-        networkUrlIPv6 = prettyPrintUrl(networkIPv6);
-      }
-    } else if (parsedIP.range() === 'loopback') {
-      if (parsedIP.kind() === 'ipv4') {
-        loopbackIPv4 = prettyPrintUrl(parsedIP.toString());
-      } else if (parsedIP.kind() === 'ipv6') {
-        loopbackIPv6 = prettyPrintUrl(parsedIP.toString());
+        if (networkIPv6) {
+          networkUrlIPv6 = prettyPrintUrl(networkIPv6);
+        }
+      } else if (parsedIP.range() === 'loopback') {
+        if (parsedIP.kind() === 'ipv4') {
+          loopbackIPv4 = prettyPrintUrl(parsedIP.toString());
+        } else if (parsedIP.kind() === 'ipv6') {
+          loopbackIPv6 = prettyPrintUrl(parsedIP.toString());
+        }
+      } else {
+        networkUrlIPv4 =
+          parsedIP.kind() === 'ipv6' && parsedIP.isIPv4MappedAddress()
+            ? prettyPrintUrl(parsedIP.toIPv4Address().toString())
+            : prettyPrintUrl(address);
+
+        if (parsedIP.kind() === 'ipv6') {
+          networkUrlIPv6 = prettyPrintUrl(address);
+        }
       }
-    } else {
-      networkUrlIPv4 =
-        parsedIP.kind() === 'ipv6' && parsedIP.isIPv4MappedAddress()
-          ? prettyPrintUrl(parsedIP.toIPv4Address().toString())
-          : prettyPrintUrl(address);
 
-      if (parsedIP.kind() === 'ipv6') {
-        networkUrlIPv6 = prettyPrintUrl(address);
+      this.logger.info('Project is running at:');
+
+      if (server) {
+        this.logger.info(`Server: ${colors.info(useColor, server)}`);
       }
-    }
 
-    this.logger.info('Project is running at:');
+      if (localhost || loopbackIPv4 || loopbackIPv6) {
+        const loopbacks = []
+          .concat(localhost ? [colors.info(useColor, localhost)] : [])
+          .concat(loopbackIPv4 ? [colors.info(useColor, loopbackIPv4)] : [])
+          .concat(loopbackIPv6 ? [colors.info(useColor, loopbackIPv6)] : []);
 
-    if (server) {
-      this.logger.info(`Server: ${colors.info(useColor, server)}`);
-    }
+        this.logger.info(`Loopback: ${loopbacks.join(', ')}`);
+      }
 
-    if (localhost || loopbackIPv4 || loopbackIPv6) {
-      const loopbacks = []
-        .concat(localhost ? [colors.info(useColor, localhost)] : [])
-        .concat(loopbackIPv4 ? [colors.info(useColor, loopbackIPv4)] : [])
-        .concat(loopbackIPv6 ? [colors.info(useColor, loopbackIPv6)] : []);
+      if (networkUrlIPv4) {
+        this.logger.info(
+          `On Your Network (IPv4): ${colors.info(useColor, networkUrlIPv4)}`
+        );
+      }
 
-      this.logger.info(`Loopback: ${loopbacks.join(', ')}`);
-    }
+      if (networkUrlIPv6) {
+        this.logger.info(
+          `On Your Network (IPv6): ${colors.info(useColor, networkUrlIPv6)}`
+        );
+      }
 
-    if (networkUrlIPv4) {
-      this.logger.info(
-        `On Your Network (IPv4): ${colors.info(useColor, networkUrlIPv4)}`
-      );
-    }
+      if (this.options.open) {
+        const openTarget = prettyPrintUrl(this.options.host || 'localhost');
 
-    if (networkUrlIPv6) {
-      this.logger.info(
-        `On Your Network (IPv6): ${colors.info(useColor, networkUrlIPv6)}`
-      );
+        this.openBrowser(openTarget);
+      }
     }
 
     if (this.options.static && this.options.static.length > 0) {
@@ -877,15 +889,13 @@ class Server {
         `Broadcasting "${bonjourProtocol}" with subtype of "webpack" via ZeroConf DNS (Bonjour)`
       );
     }
-
-    if (this.options.open) {
-      const openTarget = prettyPrintUrl(this.options.host || 'localhost');
-
-      this.openBrowser(openTarget);
-    }
   }
 
   listen(port, hostname, fn) {
+    if (typeof port === 'function') {
+      fn = port;
+    }
+
     if (
       typeof port !== 'undefined' &&
       typeof this.options.port !== 'undefined' &&
@@ -920,35 +930,85 @@ class Server {
 
     this.options.host = Server.getHostname(this.options.host);
 
-    return Server.getFreePort(this.options.port)
-      .then((foundPort) => {
+    const resolveFreePortOrIPC = () => {
+      if (this.options.ipc) {
+        return new Promise((resolve, reject) => {
+          const socket = new net.Socket();
+
+          socket.on('error', (error) => {
+            // eslint-disable-next-line no-console
+            console.log('TEST ERROR', error);
+
+            if (error.code === 'ECONNREFUSED') {
+              fs.unlinkSync(this.options.ipc);
+
+              resolve(this.options.ipc);
+
+              return;
+            } else if (error.code === 'ENOENT') {
+              resolve(this.options.ipc);
+
+              return;
+            }
+
+            reject(error);
+          });
+
+          socket.connect({ path: this.options.ipc }, () => {
+            throw new Error(`IPC "${this.options.ipc}" is already used`);
+          });
+        });
+      }
+
+      return Server.getFreePort(this.options.port).then((foundPort) => {
         this.options.port = foundPort;
+      });
+    };
 
+    return resolveFreePortOrIPC()
+      .then(() => {
         this.initialize();
 
-        return this.server.listen(
-          this.options.port,
-          this.options.host,
-          (error) => {
-            if (Boolean(this.options.hot) || this.options.liveReload) {
-              this.createWebSocketServer();
-            }
+        const listenOptions = this.options.ipc
+          ? { path: this.options.ipc }
+          : {
+              host: this.options.host,
+              port: this.options.port,
+            };
+
+        // eslint-disable-next-line no-console
+        console.log(listenOptions);
+
+        return this.server.listen(listenOptions, (error) => {
+          // eslint-disable-next-line no-console
+          console.log('LISTEN');
+          if (this.options.ipc) {
+            // chmod 666 (rw rw rw)
+            const READ_WRITE = 438;
+
+            // eslint-disable-next-line no-console
+            console.log('CHANGE CHMOD');
+            fs.chmodSync(this.options.ipc, READ_WRITE);
+          }
 
-            if (this.options.bonjour) {
-              this.runBonjour();
-            }
+          if (Boolean(this.options.hot) || this.options.liveReload) {
+            this.createWebSocketServer();
+          }
 
-            this.logStatus();
+          if (this.options.bonjour) {
+            this.runBonjour();
+          }
 
-            if (fn) {
-              fn.call(this.server, error);
-            }
+          this.logStatus();
 
-            if (typeof this.options.onListening === 'function') {
-              this.options.onListening(this);
-            }
+          if (fn) {
+            fn.call(this.server, error);
           }
-        );
+
+          if (typeof this.options.onListening === 'function') {
+            this.options.onListening(this);
+          }
+        });
       })
       .catch((error) => {
         if (fn) {

lib/options.json

@@ -308,7 +308,19 @@
       ],
       "description": "Enables Hot Module Replacement. https://webpack.js.org/configuration/dev-server/#devserverhot"
     },
-
+    "IPC": {
+      "anyOf": [
+        {
+          "type": "string",
+          "minLength": 1
+        },
+        {
+          "type": "boolean",
+          "enum": [true]
+        }
+      ],
+      "description": "Listen to a unix socket. https://webpack.js.org/configuration/dev-server/#devserveripc"
+    },
     "LiveReload": {
       "type": "boolean",
       "description": "Enables reload/refresh the page(s) when file changes are detected (enabled by default). https://webpack.js.org/configuration/dev-server/#devserverlivereload"
@@ -692,6 +704,9 @@
     "https": {
       "$ref": "#/definitions/HTTPS"
     },
+    "ipc": {
+      "$ref": "#/definitions/IPC"
+    },
     "liveReload": {
       "$ref": "#/definitions/LiveReload"
     },