chore: remove SockJS support and related configurations from the project

Author: bjohansebas

bin/cli-flags.js

@@ -214,7 +214,7 @@ module.exports = {
     configs: [
       {
         type: "enum",
-        values: ["sockjs", "ws"],
+        values: ["ws"],
         multiple: false,
         description:
           "Allows to set custom web socket transport to communicate with dev server.",
@@ -1253,7 +1253,7 @@ module.exports = {
         multiple: false,
         path: "webSocketServer",
         type: "enum",
-        values: ["sockjs", "ws"],
+        values: ["ws"],
       },
       {
         description:
@@ -1276,7 +1276,7 @@ module.exports = {
         multiple: false,
         path: "webSocketServer.type",
         type: "enum",
-        values: ["sockjs", "ws"],
+        values: ["ws"],
       },
       {
         description:

jest.config.js

@@ -26,9 +26,5 @@ module.exports = {
     // https://jestjs.io/docs/upgrading-to-jest28#packagejson-exports
     // https://github.com/microsoft/accessibility-insights-web/pull/5421#issuecomment-1109168149
     //
-    // FIXME: this uuid moduleNameMapper workaround can be removed after sockjs > uuid@v9 release
-    // https://github.com/uuidjs/uuid/pull/616#issuecomment-1206283882
-    // eslint-disable-next-line n/no-extraneous-require
-    "^uuid$": require.resolve("uuid"),
   },
 };

lib/Server.js

@@ -121,16 +121,16 @@ const schema = require("./options.json");
 
 /**
  * @typedef {object} WebSocketServerConfiguration
- * @property {("sockjs" | "ws" | string | (() => WebSocketServerConfiguration))=} type type
+ * @property {( "ws" | string | (() => WebSocketServerConfiguration))=} type type
  * @property {Record<string, EXPECTED_ANY>=} options options
  */
 
 /**
- * @typedef {(import("ws").WebSocket | import("sockjs").Connection & { send: import("ws").WebSocket["send"], terminate: import("ws").WebSocket["terminate"], ping: import("ws").WebSocket["ping"] }) & { isAlive?: boolean }} ClientConnection
+ * @typedef {(import("ws").WebSocket & { send: import("ws").WebSocket["send"], terminate: import("ws").WebSocket["terminate"], ping: import("ws").WebSocket["ping"] }) & { isAlive?: boolean }} ClientConnection
  */
 
 /**
- * @typedef {import("ws").WebSocketServer | import("sockjs").Server & { close: import("ws").WebSocketServer["close"] }} WebSocketServer
+ * @typedef {import("ws").WebSocketServer & { close: import("ws").WebSocketServer["close"] }} WebSocketServer
  */
 
 /**
@@ -190,7 +190,7 @@ const schema = require("./options.json");
  * @property {(boolean | { warnings?: OverlayMessageOptions, errors?: OverlayMessageOptions, runtimeErrors?: OverlayMessageOptions })=} overlay overlay
  * @property {boolean=} progress progress
  * @property {(boolean | number)=} reconnect reconnect
- * @property {("ws" | "sockjs" | string)=} webSocketTransport web socket transport
+ * @property {("ws" | string)=} webSocketTransport web socket transport
  * @property {(string | WebSocketURL)=} webSocketURL web socket URL
  */
 
@@ -231,7 +231,7 @@ const schema = require("./options.json");
  * @property {(boolean | string | Static | Array<string | Static>)=} static
  * @property {(ServerType<A, S> | ServerConfiguration<A, S>)=} server
  * @property {(() => Promise<A>)=} app
- * @property {(boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration)=} webSocketServer
+ * @property {(boolean | "ws" | string | WebSocketServerConfiguration)=} webSocketServer
  * @property {ProxyConfigArray=} proxy
  * @property {(boolean | string | Open | Array<string | Open>)=} open
  * @property {boolean=} setupExitSignals
@@ -674,28 +674,17 @@ class Server {
         /** @type {string} */
         let hostname;
 
-        // SockJS is not supported server mode, so `hostname` and `port` can't specified, let's ignore them
-        const isSockJSType = webSocketServer.type === "sockjs";
         const isWebSocketServerHostDefined =
           typeof webSocketServer.options.host !== "undefined";
         const isWebSocketServerPortDefined =
           typeof webSocketServer.options.port !== "undefined";
 
-        if (
-          isSockJSType &&
-          (isWebSocketServerHostDefined || isWebSocketServerPortDefined)
-        ) {
-          this.logger.warn(
-            "SockJS only supports client mode and does not support custom hostname and port options. Please consider using 'ws' if you need to customize these options.",
-          );
-        }
-
         // We are proxying dev server and need to specify custom `hostname`
         if (typeof webSocketURL.hostname !== "undefined") {
           hostname = webSocketURL.hostname;
         }
         // Web socket server works on custom `hostname`, only for `ws` because `sock-js` is not support custom `hostname`
-        else if (isWebSocketServerHostDefined && !isSockJSType) {
+        else if (isWebSocketServerHostDefined) {
           hostname = webSocketServer.options.host;
         }
         // The `host` option is specified
@@ -717,7 +706,7 @@ class Server {
           port = webSocketURL.port;
         }
         // Web socket server works on custom `port`, only for `ws` because `sock-js` is not support custom `port`
-        else if (isWebSocketServerPortDefined && !isSockJSType) {
+        else if (isWebSocketServerPortDefined) {
           port = webSocketServer.options.port;
         }
         // The `port` option is specified
@@ -1560,9 +1549,7 @@ class Server {
         (this.options.webSocketServer).type
       ) === "string" &&
       // @ts-expect-error
-      (this.options.webSocketServer.type === "ws" ||
-        /** @type {WebSocketServerConfiguration} */
-        (this.options.webSocketServer).type === "sockjs");
+      this.options.webSocketServer.type === "ws";
 
     let clientTransport;
 
@@ -1589,12 +1576,8 @@ class Server {
 
     switch (typeof clientTransport) {
       case "string":
-        // could be 'sockjs', 'ws', or a path that should be required
-        if (clientTransport === "sockjs") {
-          clientImplementation = require.resolve(
-            "../client/clients/SockJSClient",
-          );
-        } else if (clientTransport === "ws") {
+        // could be 'ws', or a path that should be required
+        if (clientTransport === "ws") {
           clientImplementation = require.resolve(
             "../client/clients/WebSocketClient",
           );
@@ -1616,7 +1599,7 @@ class Server {
           !isKnownWebSocketServerImplementation
             ? "When you use custom web socket implementation you must explicitly specify client.webSocketTransport. "
             : ""
-        }client.webSocketTransport must be a string denoting a default implementation (e.g. 'sockjs', 'ws') or a full path to a JS file via require.resolve(...) which exports a class `,
+        }client.webSocketTransport must be a string denoting a default implementation (e.g. 'ws') or a full path to a JS file via require.resolve(...) which exports a class `,
       );
     }
 
@@ -1639,14 +1622,8 @@ class Server {
       )
     ) {
       case "string":
-        // Could be 'sockjs', in the future 'ws', or a path that should be required
+        // Could be 'ws', or a path that should be required
         if (
-          /** @type {WebSocketServerConfiguration} */ (
-            this.options.webSocketServer
-          ).type === "sockjs"
-        ) {
-          implementation = require("./servers/SockJSServer");
-        } else if (
           /** @type {WebSocketServerConfiguration} */ (
             this.options.webSocketServer
           ).type === "ws"
@@ -1674,7 +1651,7 @@ class Server {
 
     if (!implementationFound) {
       throw new Error(
-        "webSocketServer (webSocketServer.type) must be a string denoting a default implementation (e.g. 'ws', 'sockjs'), a full path to " +
+        "webSocketServer (webSocketServer.type) must be a string denoting a default implementation (e.g. 'ws'), a full path to " +
           "a JS file which exports a class extending BaseServer (webpack-dev-server/lib/servers/BaseServer.js) " +
           "via require.resolve(...), or the class itself which extends BaseServer",
       );
@@ -2677,11 +2654,7 @@ class Server {
           typeof request !== "undefined"
             ? /** @type {{ [key: string]: string | undefined }} */
               (request.headers)
-            : typeof (
-                  /** @type {import("sockjs").Connection} */ (client).headers
-                ) !== "undefined"
-              ? /** @type {import("sockjs").Connection} */ (client).headers
-              : undefined;
+            : undefined;
 
         if (!headers) {
           this.logger.warn(

lib/options.json

@@ -193,7 +193,7 @@
       "link": "https://webpack.js.org/configuration/dev-server/#websockettransport"
     },
     "ClientWebSocketTransportEnum": {
-      "enum": ["sockjs", "ws"]
+      "enum": ["ws"]
     },
     "ClientWebSocketTransportString": {
       "type": "string",
@@ -907,7 +907,7 @@
       "link": "https://webpack.js.org/configuration/dev-server/#devserverwebsocketserver"
     },
     "WebSocketServerType": {
-      "enum": ["sockjs", "ws"]
+      "enum": ["ws"]
     },
     "WebSocketServerEnum": {
       "anyOf": [
@@ -918,7 +918,7 @@
           }
         },
         {
-          "enum": ["sockjs", "ws"],
+          "enum": ["ws"],
           "cli": {
             "exclude": true
           }

lib/servers/SockJSServer.js

@@ -4,17 +4,6 @@ const { testBin } = require("../helpers/test-bin");
 const port = require("../ports-map")["cli-client"];
 
 describe('"client" CLI option', () => {
-  it('should work using "--client-web-socket-transport sockjs"', async () => {
-    const { exitCode } = await testBin([
-      "--port",
-      port,
-      "--client-web-socket-transport",
-      "sockjs",
-    ]);
-
-    expect(exitCode).toBe(0);
-  });
-
   it('should work using "--client-web-socket-transport ws"', async () => {
     const { exitCode } = await testBin([
       "--port",

test/cli/client-option.test.js

@@ -15,17 +15,6 @@ describe('"webSocketServer" CLI option', () => {
     expect(exitCode).toBe(0);
   });
 
-  it('should work using "--web-socket-server-type sockjs"', async () => {
-    const { exitCode } = await testBin([
-      "--port",
-      port,
-      "--web-socket-server-type",
-      "sockjs",
-    ]);
-
-    expect(exitCode).toBe(0);
-  });
-
   it('should work using "--no-web-socket-server"', async () => {
     const { exitCode } = await testBin([
       "--port",

test/cli/webSocketServer-option.test.js

@@ -8,7 +8,7 @@ const config = require("../fixtures/client-config/webpack.config");
 const runBrowser = require("../helpers/run-browser");
 const [port1, port2] = require("../ports-map")["allowed-hosts"];
 
-const webSocketServers = ["ws", "sockjs"];
+const webSocketServers = ["ws"];
 
 describe("allowed hosts", () => {
   for (const webSocketServer of webSocketServers) {