fix: add auto and all option in allowedHosts

anshumanv · anshumanv · commit 0b7bb6577022 · 2021-05-27T20:03:29.000+05:30
diff --git a/bin/cli-flags.js b/bin/cli-flags.js
@@ -398,17 +398,12 @@ module.exports = {
       name: 'allowed-hosts',
       type: [Boolean, String],
       configs: [
-        {
-          type: 'boolean',
-        },
         {
           type: 'string',
         },
       ],
       description: 'Set hosts that are allowed to access the dev server.',
-      negatedDescription: 'Allow any host to access dev server.',
       multiple: true,
-      negative: true,
     },
     {
       name: 'watch-files',
diff --git a/examples/cli/web-socket-url/webpack.config.js b/examples/cli/web-socket-url/webpack.config.js
@@ -12,6 +12,6 @@ module.exports = setup({
     client: {
       webSocketURL: 'ws://localhost:8080',
     },
-    allowedHosts: true,
+    allowedHosts: 'all',
   },
 });
diff --git a/lib/Server.js b/lib/Server.js
@@ -900,7 +900,7 @@ class Server {
   checkHeaders(headers, headerToCheck) {
     // allow user to opt out of this security check, at their own risk
     // by explicitly enabling allowedHosts
-    if (this.options.allowedHosts) {
+    if (this.options.allowedHosts.includes('auto')) {
       return true;
     }
 
diff --git a/lib/options.json b/lib/options.json
@@ -340,7 +340,7 @@
     "allowedHosts": {
       "anyOf": [
         {
-          "type": "boolean"
+          "enum": ["auto", "all"]
         },
         {
           "type": "string"
diff --git a/lib/utils/normalizeOptions.js b/lib/utils/normalizeOptions.js
@@ -129,9 +129,11 @@ function normalizeOptions(compiler, options, logger) {
   options.devMiddleware = options.devMiddleware || {};
 
   if (typeof options.allowedHosts === 'undefined') {
-    // allowedHosts is disabled by default
-    options.allowedHosts = false;
-  } else if (typeof options.allowedHosts === 'string') {
+    // allowedHosts allows some default hosts picked from
+    // `options.host` or `webSocketURL.host` and `localhost`
+    options.allowedHosts = 'auto';
+  }
+  if (typeof options.allowedHosts === 'string') {
     // we store allowedHosts as array when supplied as string
     options.allowedHosts = [options.allowedHosts];
   }
diff --git a/test/__snapshots__/validate-options.test.js.snap.webpack4 b/test/__snapshots__/validate-options.test.js.snap.webpack4
@@ -1,17 +1,39 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`options validate should throw an error on the "allowedHosts" option with '[]' value 1`] = `
+exports[`options validate should throw an error on the "allowedHosts" 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.allowedHosts should be an non-empty array."
+ - configuration.allowedHosts should be one of these:
+   \\"auto\\" | \\"all\\" | string | [string, ...] (should not have fewer than 1 item)
+   -> Defines routes which are enabled by default, on by default and allows localhost. https://webpack.js.org/configuration/dev-server/#devserverallowedhosts
+   Details:
+    * configuration.allowedHosts should be one of these:
+      \\"auto\\" | \\"all\\"
+    * configuration.allowedHosts should be a string.
+    * configuration.allowedHosts should be an array:
+      [string, ...] (should not have fewer than 1 item)"
 `;
 
-exports[`options validate should throw an error on the "allowedHosts" option with '123' value 1`] = `
+exports[`options validate should throw an error on the "allowedHosts" 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.allowedHosts should be one of these:
+   \\"auto\\" | \\"all\\" | string | [string, ...] (should not have fewer than 1 item)
+   -> Defines routes which are enabled by default, on by default and allows localhost. https://webpack.js.org/configuration/dev-server/#devserverallowedhosts
+   Details:
+    * configuration.allowedHosts should be one of these:
+      \\"auto\\" | \\"all\\"
+    * configuration.allowedHosts should be a string.
+    * configuration.allowedHosts should be an array:
+      [string, ...] (should not have fewer than 1 item)"
+`;
+
+exports[`options validate should throw an error on the "allowedHosts" option with 'true' value 1`] = `
 "ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
  - configuration.allowedHosts should be one of these:
-   boolean | string | [string, ...] (should not have fewer than 1 item)
+   \\"auto\\" | \\"all\\" | string | [string, ...] (should not have fewer than 1 item)
    -> Defines routes which are enabled by default, on by default and allows localhost. https://webpack.js.org/configuration/dev-server/#devserverallowedhosts
    Details:
-    * configuration.allowedHosts should be a boolean.
+    * configuration.allowedHosts should be one of these:
+      \\"auto\\" | \\"all\\"
     * configuration.allowedHosts should be a string.
     * configuration.allowedHosts should be an array:
       [string, ...] (should not have fewer than 1 item)"
diff --git a/test/__snapshots__/validate-options.test.js.snap.webpack5 b/test/__snapshots__/validate-options.test.js.snap.webpack5
@@ -1,17 +1,39 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`options validate should throw an error on the "allowedHosts" option with '[]' value 1`] = `
+exports[`options validate should throw an error on the "allowedHosts" 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.allowedHosts should be an non-empty array."
+ - configuration.allowedHosts should be one of these:
+   \\"auto\\" | \\"all\\" | string | [string, ...] (should not have fewer than 1 item)
+   -> Defines routes which are enabled by default, on by default and allows localhost. https://webpack.js.org/configuration/dev-server/#devserverallowedhosts
+   Details:
+    * configuration.allowedHosts should be one of these:
+      \\"auto\\" | \\"all\\"
+    * configuration.allowedHosts should be a string.
+    * configuration.allowedHosts should be an array:
+      [string, ...] (should not have fewer than 1 item)"
 `;
 
-exports[`options validate should throw an error on the "allowedHosts" option with '123' value 1`] = `
+exports[`options validate should throw an error on the "allowedHosts" 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.allowedHosts should be one of these:
+   \\"auto\\" | \\"all\\" | string | [string, ...] (should not have fewer than 1 item)
+   -> Defines routes which are enabled by default, on by default and allows localhost. https://webpack.js.org/configuration/dev-server/#devserverallowedhosts
+   Details:
+    * configuration.allowedHosts should be one of these:
+      \\"auto\\" | \\"all\\"
+    * configuration.allowedHosts should be a string.
+    * configuration.allowedHosts should be an array:
+      [string, ...] (should not have fewer than 1 item)"
+`;
+
+exports[`options validate should throw an error on the "allowedHosts" option with 'true' value 1`] = `
 "ValidationError: Invalid configuration object. Object has been initialized using a configuration object that does not match the API schema.
  - configuration.allowedHosts should be one of these:
-   boolean | string | [string, ...] (should not have fewer than 1 item)
+   \\"auto\\" | \\"all\\" | string | [string, ...] (should not have fewer than 1 item)
    -> Defines routes which are enabled by default, on by default and allows localhost. https://webpack.js.org/configuration/dev-server/#devserverallowedhosts
    Details:
-    * configuration.allowedHosts should be a boolean.
+    * configuration.allowedHosts should be one of these:
+      \\"auto\\" | \\"all\\"
     * configuration.allowedHosts should be a string.
     * configuration.allowedHosts should be an array:
       [string, ...] (should not have fewer than 1 item)"
diff --git a/test/cli/__snapshots__/cli.test.js.snap.webpack4 b/test/cli/__snapshots__/cli.test.js.snap.webpack4
@@ -273,7 +273,6 @@ Options:
   --no-compress                    Disable gzip compression.
   --allowed-hosts [value...]       Set hosts that are allowed to access the dev
                                    server.
-  --no-allowed-hosts               Allow any host to access dev server.
   --watch-files <value...>         Watch static files for file changes.
 
 Global options:
diff --git a/test/cli/__snapshots__/cli.test.js.snap.webpack5 b/test/cli/__snapshots__/cli.test.js.snap.webpack5
@@ -274,7 +274,6 @@ Options:
   --no-compress                    Disable gzip compression.
   --allowed-hosts [value...]       Set hosts that are allowed to access the dev
                                    server.
-  --no-allowed-hosts               Allow any host to access dev server.
   --watch-files <value...>         Watch static files for file changes.
 
 Global options:
diff --git a/test/cli/cli.test.js b/test/cli/cli.test.js
@@ -655,17 +655,17 @@ describe('CLI', () => {
   });
 
   describe('allowed-hosts', () => {
-    it('--allowed-hosts', (done) => {
-      testBin('--allowed-hosts')
+    it('--allowed-hosts auto', (done) => {
+      testBin(['--allowed-hosts', 'auto'])
         .then((output) => {
           expect(output.exitCode).toEqual(0);
           done();
         })
         .catch(done);
     });
 
-    it('--no-allowed-hosts', (done) => {
-      testBin('--no-allowed-hosts')
+    it('--allowed-hosts all', (done) => {
+      testBin(['--allowed-hosts', 'all'])
         .then((output) => {
           expect(output.exitCode).toEqual(0);
           done();
diff --git a/test/e2e/web-socket-server-and-url.test.js b/test/e2e/web-socket-server-and-url.test.js
@@ -65,7 +65,7 @@ for (const webSocketServerType of webSocketServerTypes) {
         webSocketServer: webSocketServerType,
         port: devServerPort,
         host: devServerHost,
-        allowedHosts: true,
+        allowedHosts: 'all',
         hot: true,
       };
 
@@ -132,7 +132,7 @@ for (const webSocketServerType of webSocketServerTypes) {
         webSocketServer: webSocketServerType,
         port: devServerPort,
         host: devServerHost,
-        allowedHosts: true,
+        allowedHosts: 'all',
         hot: true,
       };
 
@@ -204,7 +204,7 @@ for (const webSocketServerType of webSocketServerTypes) {
         port: devServerPort,
         host: devServerHost,
         webSocketServer: webSocketServerType,
-        allowedHosts: true,
+        allowedHosts: 'all',
         hot: true,
         static: true,
       };
diff --git a/test/server/allowedHosts-option.test.js b/test/server/allowedHosts-option.test.js
@@ -25,7 +25,7 @@ describe('allowedHosts', () => {
       client: {
         webSocketURL: 'ws://test.host:80',
       },
-      allowedHosts: true,
+      allowedHosts: 'all',
     };
 
     const headers = {
diff --git a/test/server/utils/__snapshots__/normalizeOptions.test.js.snap.webpack4 b/test/server/utils/__snapshots__/normalizeOptions.test.js.snap.webpack4
diff --git a/test/server/utils/__snapshots__/normalizeOptions.test.js.snap.webpack5 b/test/server/utils/__snapshots__/normalizeOptions.test.js.snap.webpack5
diff --git a/test/server/utils/normalizeOptions.test.js b/test/server/utils/normalizeOptions.test.js
diff --git a/test/validate-options.test.js b/test/validate-options.test.js

Original file line number	Diff line number	Diff line change
`@@ -900,7 +900,7 @@ class Server {`
`900`	`900`	`checkHeaders(headers, headerToCheck) {`
`901`	`901`	`// allow user to opt out of this security check, at their own risk`
`902`	`902`	`// by explicitly enabling allowedHosts`
`903`		`- if (this.options.allowedHosts) {`
	`903`	`+ if (this.options.allowedHosts.includes('auto')) {`
`904`	`904`	`return true;`
`905`	`905`	`}`
`906`	`906`
Original file line number	Diff line number	Diff line change
`@@ -340,7 +340,7 @@`
`340`	`340`	`"allowedHosts": {`
`341`	`341`	`"anyOf": [`
`342`	`342`	`{`
`343`		`- "type": "boolean"`
	`343`	`+ "enum": ["auto", "all"]`
`344`	`344`	`},`
`345`	`345`	`{`
`346`	`346`	`"type": "string"`