Merge branch 'master' into update-scripts

Author: alexander-akait

README.md

@@ -124,7 +124,6 @@ Options:
   --no-history-api-fallback        Do not fallback to /index.html for Single Page Applications.
   --compress                       Enable gzip compression.
   --no-compress                    Disable gzip compression.
-  --public <value>                 The public hostname/ip address of the server.
   --firewall [value...]            Enable firewall or set hosts that are allowed to access the dev server.
   --no-firewall                    Disable firewall.
   --watch-files <value...>         Watch static files for file changes.

bin/cli-flags.js

@@ -394,16 +394,6 @@ module.exports = {
       negatedDescription: 'Disable gzip compression.',
       negative: true,
     },
-    {
-      name: 'public',
-      type: String,
-      configs: [
-        {
-          type: 'string',
-        },
-      ],
-      description: 'The public hostname/ip address of the server.',
-    },
     {
       name: 'firewall',
       type: [Boolean, String],

client-src/utils/createSocketURL.js

@@ -7,14 +7,6 @@ const url = require('url');
 function createSocketURL(parsedURL) {
   let { auth, hostname, protocol, port } = parsedURL;
 
-  const getURLSearchParam = (name) => {
-    if (parsedURL.searchParams) {
-      return parsedURL.searchParams.get(name);
-    }
-
-    return parsedURL.query && parsedURL.query[name];
-  };
-
   // Node.js module parses it as `::`
   // `new URL(urlString, [baseURLstring])` parses it as '[::]'
   const isInAddrAny =
@@ -66,22 +58,25 @@ function createSocketURL(parsedURL) {
   //
   // All of these sock url params are optionally passed in through resourceQuery,
   // so we need to fall back to the default if they are not provided
-  const socketURLHostname = (
-    getURLSearchParam('host') ||
-    hostname ||
-    'localhost'
-  ).replace(/^\[(.*)\]$/, '$1');
+  const socketURLHostname = (hostname || 'localhost').replace(
+    /^\[(.*)\]$/,
+    '$1'
+  );
 
   if (!port || port === '0') {
     port = self.location.port;
   }
 
-  const socketURLPort = getURLSearchParam('port') || port;
+  const socketURLPort = port;
 
   // If path is provided it'll be passed in via the resourceQuery as a
   // query param so it has to be parsed out of the querystring in order for the
   // client to open the socket to the correct location.
-  const socketURLPathname = getURLSearchParam('path') || '/ws';
+  let socketURLPathname = '/ws';
+
+  if (parsedURL.pathname && !parsedURL.fromCurrentScript) {
+    socketURLPathname = parsedURL.pathname;
+  }
 
   return url.format({
     protocol: socketURLProtocol,

client-src/utils/parseURL.js

@@ -8,13 +8,18 @@ function parseURL(resourceQuery) {
 
   if (typeof resourceQuery === 'string' && resourceQuery !== '') {
     // If this bundle is inlined, use the resource query to get the correct url.
-    // format is like `?http://0.0.0.0:8096&port=8097&host=localhost`
+    // for backward compatibility we supports:
+    // - ?ws://0.0.0.0:8096&3Flogging=info
+    // - ?ws%3A%2F%2F192.168.0.5%3A8080%2F%3Flogging%3Dinfo
+    // Also we support `http` and `https` for backward compatibility too
     options = url.parse(
-      resourceQuery
-        // strip leading `?` from query string to get a valid URL
-        .substr(1)
-        // replace first `&` with `?` to have a valid query string
-        .replace('&', '?'),
+      decodeURIComponent(
+        resourceQuery
+          // strip leading `?` from query string to get a valid URL
+          .substr(1)
+          // replace first `&` with `?` to have a valid query string
+          .replace('&', '?')
+      ),
       true
     );
   } else {
@@ -36,9 +41,11 @@ function parseURL(resourceQuery) {
 
       if (scriptSourceURL) {
         options = scriptSourceURL;
+        options.fromCurrentScript = true;
       }
     } else {
       options = url.parse(self.location.href, true, true);
+      options.fromCurrentScript = true;
     }
   }
 

examples/cli/public-protocol/app.js

@@ -1,14 +1,14 @@
-# CLI: Public Option
+# CLI: Web Socket URL
 
 ```console
-npx webpack serve --open-target --host 0.0.0.0 --public <insert local ip>:8080
+npx webpack serve --open-target --host 0.0.0.0 --web-socket-url <insert-host>:8080
 ```
 
 _NOTE: replace `<insert local ip>` with your local IP Address._
 
 In order to make the server publicly accessible the client needs to know with
 what host to connect to the server. If `--host 0.0.0.0` is given, the client
-would try to connect to `0.0.0.0`. With the `--public` option it is possible to
+would try to connect to `0.0.0.0`. With the `--web-socket-url` options it is possible to
 override this.
 
 ## What Should Happen
@@ -18,4 +18,4 @@ override this.
 3. Open the console in your browser's devtools.
 4. Select the 'Network' tab.
 5. Select the 'WS' or 'WebSockets' sub-tab.
-6. Verify that the WebSocket is connecting to `<insert local ip>:8080`.
+6. Verify that the WebSocket is connecting to `<insert-host>:8080`.

examples/cli/public/README.md renamed to examples/cli/web-socket-url-cli/README.md

@@ -1,12 +1,12 @@
-# CLI: Public Option Protocol
+# CLI: Web Socket URL Option Protocol
 
 ```console
 npx webpack serve
 ```
 
 _NOTE: replace `<insert local ip>` with your local IP Address._
 
-You're now able to explicitly define the protocol used with the `public` option
+You're now able to explicitly define the protocol used with the `client.webSocketURL` option
 (have a look to the config provided in `webpack.config.js`).
 
 ## What Should Happen

examples/cli/public/app.js renamed to examples/cli/web-socket-url-cli/app.js

@@ -0,0 +1,6 @@
+'use strict';
+
+const target = document.querySelector('#target');
+
+target.innerHTML =
+  'Please check the ws request in devtools, it should try to connect to the protocol + server defined in the webSocketURL setting.';