fix: schema for web socket server type (#3913)

webpack · Oct 5, 2021 · f6aa6f7 · f6aa6f7
1 parent 30956dd
commit f6aa6f7
Show file tree

Hide file tree

Showing 5 changed files with 80 additions and 10 deletions.
diff --git a/bin/cli-flags.js b/bin/cli-flags.js
@@ -297,21 +297,30 @@ module.exports = {
   "web-socket-server": {
     configs: [
       {
-        type: "enum",
-        values: [false, "sockjs", "ws"],
-        multiple: false,
         description:
           "Allows to set web socket server and options (by default 'ws').",
+        multiple: false,
         path: "webSocketServer",
+        type: "enum",
+        values: [false],
       },
       {
-        type: "string",
+        description:
+          "Allows to set web socket server and options (by default 'ws').",
         multiple: false,
+        path: "webSocketServer",
+        type: "enum",
+        values: ["sockjs", "ws"],
+      },
+      {
         description:
           "Allows to set web socket server and options (by default 'ws').",
+        multiple: false,
         path: "webSocketServer",
+        type: "string",
       },
     ],
+
     description:
       "Allows to set web socket server and options (by default 'ws').",
     simpleType: "string",

diff --git a/lib/options.json b/lib/options.json
@@ -790,8 +790,18 @@
       "description": "Allows to set web socket server and options (by default 'ws').",
       "link": "https://webpack.js.org/configuration/dev-server/#devserverwebsocketserver"
     },
+    "WebSocketServerType": {
+      "enum": ["sockjs", "ws"]
+    },
     "WebSocketServerEnum": {
-      "enum": [false, "sockjs", "ws"]
+      "anyOf": [
+        {
+          "enum": [false]
+        },
+        {
+          "$ref": "#/definitions/WebSocketServerType"
+        }
+      ]
     },
     "WebSocketServerFunction": {
       "instanceof": "Function"
@@ -805,7 +815,7 @@
         "type": {
           "anyOf": [
             {
-              "$ref": "#/definitions/WebSocketServerEnum"
+              "$ref": "#/definitions/WebSocketServerType"
             },
             {
               "$ref": "#/definitions/WebSocketServerString"

diff --git a/test/__snapshots__/validate-options.test.js.snap.webpack4 b/test/__snapshots__/validate-options.test.js.snap.webpack4
@@ -721,6 +721,22 @@ exports[`options validate should throw an error on the "webSocketServer" option
    object { type?, options? }"
 `;
 
+exports[`options validate should throw an error on the "webSocketServer" option with '{"type":false}' value 1`] = `
+"ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
+ - options.webSocketServer should be one of these:
+   false | \\"sockjs\\" | \\"ws\\" | non-empty string | function | object { type?, options? }
+   -> Allows to set web socket server and options (by default 'ws').
+   -> Read more at https://webpack.js.org/configuration/dev-server/#devserverwebsocketserver
+   Details:
+    * options.webSocketServer.type should be one of these:
+      \\"sockjs\\" | \\"ws\\" | non-empty string | function
+      Details:
+       * options.webSocketServer.type should be one of these:
+         \\"sockjs\\" | \\"ws\\"
+       * options.webSocketServer.type should be a non-empty string.
+       * options.webSocketServer.type should be an instance of function."
+`;
+
 exports[`options validate should throw an error on the "webSocketServer" option with '{"type":true}' value 1`] = `
 "ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
  - options.webSocketServer should be one of these:
@@ -729,10 +745,10 @@ exports[`options validate should throw an error on the "webSocketServer" option
    -> Read more at https://webpack.js.org/configuration/dev-server/#devserverwebsocketserver
    Details:
     * options.webSocketServer.type should be one of these:
-      false | \\"sockjs\\" | \\"ws\\" | non-empty string | function
+      \\"sockjs\\" | \\"ws\\" | non-empty string | function
       Details:
        * options.webSocketServer.type should be one of these:
-         false | \\"sockjs\\" | \\"ws\\"
+         \\"sockjs\\" | \\"ws\\"
        * options.webSocketServer.type should be a non-empty string.
        * options.webSocketServer.type should be an instance of function."
 `;
@@ -746,6 +762,10 @@ exports[`options validate should throw an error on the "webSocketServer" option
    Details:
     * options.webSocketServer should be one of these:
       false | \\"sockjs\\" | \\"ws\\"
+      Details:
+       * options.webSocketServer should be false.
+       * options.webSocketServer should be one of these:
+         \\"sockjs\\" | \\"ws\\"
     * options.webSocketServer should be a non-empty string.
     * options.webSocketServer should be an instance of function.
     * options.webSocketServer should be an object:
@@ -761,6 +781,10 @@ exports[`options validate should throw an error on the "webSocketServer" option
    Details:
     * options.webSocketServer should be one of these:
       false | \\"sockjs\\" | \\"ws\\"
+      Details:
+       * options.webSocketServer should be false.
+       * options.webSocketServer should be one of these:
+         \\"sockjs\\" | \\"ws\\"
     * options.webSocketServer should be a non-empty string.
     * options.webSocketServer should be an instance of function.
     * options.webSocketServer should be an object:

diff --git a/test/__snapshots__/validate-options.test.js.snap.webpack5 b/test/__snapshots__/validate-options.test.js.snap.webpack5
@@ -721,6 +721,22 @@ exports[`options validate should throw an error on the "webSocketServer" option
    object { type?, options? }"
 `;
 
+exports[`options validate should throw an error on the "webSocketServer" option with '{"type":false}' value 1`] = `
+"ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
+ - options.webSocketServer should be one of these:
+   false | \\"sockjs\\" | \\"ws\\" | non-empty string | function | object { type?, options? }
+   -> Allows to set web socket server and options (by default 'ws').
+   -> Read more at https://webpack.js.org/configuration/dev-server/#devserverwebsocketserver
+   Details:
+    * options.webSocketServer.type should be one of these:
+      \\"sockjs\\" | \\"ws\\" | non-empty string | function
+      Details:
+       * options.webSocketServer.type should be one of these:
+         \\"sockjs\\" | \\"ws\\"
+       * options.webSocketServer.type should be a non-empty string.
+       * options.webSocketServer.type should be an instance of function."
+`;
+
 exports[`options validate should throw an error on the "webSocketServer" option with '{"type":true}' value 1`] = `
 "ValidationError: Invalid options object. Dev Server has been initialized using an options object that does not match the API schema.
  - options.webSocketServer should be one of these:
@@ -729,10 +745,10 @@ exports[`options validate should throw an error on the "webSocketServer" option
    -> Read more at https://webpack.js.org/configuration/dev-server/#devserverwebsocketserver
    Details:
     * options.webSocketServer.type should be one of these:
-      false | \\"sockjs\\" | \\"ws\\" | non-empty string | function
+      \\"sockjs\\" | \\"ws\\" | non-empty string | function
       Details:
        * options.webSocketServer.type should be one of these:
-         false | \\"sockjs\\" | \\"ws\\"
+         \\"sockjs\\" | \\"ws\\"
        * options.webSocketServer.type should be a non-empty string.
        * options.webSocketServer.type should be an instance of function."
 `;
@@ -746,6 +762,10 @@ exports[`options validate should throw an error on the "webSocketServer" option
    Details:
     * options.webSocketServer should be one of these:
       false | \\"sockjs\\" | \\"ws\\"
+      Details:
+       * options.webSocketServer should be false.
+       * options.webSocketServer should be one of these:
+         \\"sockjs\\" | \\"ws\\"
     * options.webSocketServer should be a non-empty string.
     * options.webSocketServer should be an instance of function.
     * options.webSocketServer should be an object:
@@ -761,6 +781,10 @@ exports[`options validate should throw an error on the "webSocketServer" option
    Details:
     * options.webSocketServer should be one of these:
       false | \\"sockjs\\" | \\"ws\\"
+      Details:
+       * options.webSocketServer should be false.
+       * options.webSocketServer should be one of these:
+         \\"sockjs\\" | \\"ws\\"
     * options.webSocketServer should be a non-empty string.
     * options.webSocketServer should be an instance of function.
     * options.webSocketServer should be an object:

diff --git a/test/validate-options.test.js b/test/validate-options.test.js
@@ -448,6 +448,9 @@ const tests = {
     failure: [
       null,
       true,
+      {
+        type: false,
+      },
       {
         notAnOption: true,
       },