chore: remove SockJS support and related tests from the project

Author: bjohansebas

lib/Server.js

@@ -2042,56 +2042,6 @@ class Server {
       middleware: /** @type {MiddlewareHandler} */ (this.middleware),
     });
 
-    // Should be after `webpack-dev-middleware`, otherwise other middlewares might rewrite response
-    middlewares.push({
-      name: "webpack-dev-server-sockjs-bundle",
-      path: "/__webpack_dev_server__/sockjs.bundle.js",
-      /**
-       * @param {Request} req request
-       * @param {Response} res response
-       * @param {NextFunction} next next function
-       * @returns {void}
-       */
-      middleware: (req, res, next) => {
-        if (req.method !== "GET" && req.method !== "HEAD") {
-          next();
-          return;
-        }
-
-        const clientPath = path.join(
-          __dirname,
-          "..",
-          "client/modules/sockjs-client/index.js",
-        );
-
-        // Express send Etag and other headers by default, so let's keep them for compatibility reasons
-        if (typeof res.sendFile === "function") {
-          res.sendFile(clientPath);
-          return;
-        }
-
-        let stats;
-
-        try {
-          // TODO implement `inputFileSystem.createReadStream` in webpack
-          stats = fs.statSync(clientPath);
-        } catch {
-          next();
-          return;
-        }
-
-        res.setHeader("Content-Type", "application/javascript; charset=UTF-8");
-        res.setHeader("Content-Length", stats.size);
-
-        if (req.method === "HEAD") {
-          res.end();
-          return;
-        }
-
-        fs.createReadStream(clientPath).pipe(res);
-      },
-    });
-
     middlewares.push({
       name: "webpack-dev-server-invalidate",
       path: "/webpack-dev-server/invalidate",
@@ -3288,8 +3238,7 @@ class Server {
    */
   sendMessage(clients, type, data, params) {
     for (const client of clients) {
-      // `sockjs` uses `1` to indicate client is ready to accept data
-      // `ws` uses `WebSocket.OPEN`, but it is mean `1` too
+      // `ws` uses `WebSocket.OPEN`, which is `1`
       if (client.readyState === 1) {
         client.send(JSON.stringify({ type, data, params }));
       }

test/e2e/built-in-routes.test.js

@@ -33,69 +33,6 @@ describe("Built in routes", () => {
       await server.stop();
     });
 
-    it("should handles GET request to sockjs bundle", async () => {
-      page
-        .on("console", (message) => {
-          consoleMessages.push(message);
-        })
-        .on("pageerror", (error) => {
-          pageErrors.push(error);
-        });
-
-      const response = await page.goto(
-        `http://localhost:${port}/__webpack_dev_server__/sockjs.bundle.js`,
-        {
-          waitUntil: "networkidle0",
-        },
-      );
-
-      expect(response.headers()["content-type"]).toMatchSnapshot(
-        "response headers content-type",
-      );
-
-      expect(response.status()).toMatchSnapshot("response status");
-
-      expect(consoleMessages.map((message) => message.text())).toMatchSnapshot(
-        "console messages",
-      );
-
-      expect(pageErrors).toMatchSnapshot("page errors");
-    });
-
-    it("should handles HEAD request to sockjs bundle", async () => {
-      page
-        .on("console", (message) => {
-          consoleMessages.push(message);
-        })
-        .on("pageerror", (error) => {
-          pageErrors.push(error);
-        })
-        .on("request", (interceptedRequest) => {
-          if (interceptedRequest.isInterceptResolutionHandled()) return;
-
-          interceptedRequest.continue({ method: "HEAD" }, 10);
-        });
-
-      const response = await page.goto(
-        `http://localhost:${port}/__webpack_dev_server__/sockjs.bundle.js`,
-        {
-          waitUntil: "networkidle0",
-        },
-      );
-
-      expect(response.headers()["content-type"]).toMatchSnapshot(
-        "response headers content-type",
-      );
-
-      expect(response.status()).toMatchSnapshot("response status");
-
-      expect(consoleMessages.map((message) => message.text())).toMatchSnapshot(
-        "console messages",
-      );
-
-      expect(pageErrors).toMatchSnapshot("page errors");
-    });
-
     it("should handle GET request to invalidate endpoint", async () => {
       page
         .on("console", (message) => {

test/e2e/hot-and-live-reload.test.js

@@ -6,7 +6,6 @@
 
 const path = require("node:path");
 const fs = require("graceful-fs");
-const SockJS = require("sockjs-client");
 const webpack = require("webpack");
 const WebSocket = require("ws");
 const Server = require("../../lib/Server");
@@ -25,7 +24,6 @@ const cssFilePath = path.resolve(
 const INVALID_MESSAGE = "[webpack-dev-server] App updated. Recompiling...";
 
 describe("hot and live reload", () => {
-  // "sockjs" client cannot add additional headers
   const modes = [
     {
       title: "should work and refresh content using hot module replacement",
@@ -133,70 +131,6 @@ describe("hot and live reload", () => {
         hot: true,
       },
     },
-    // "sockjs" web socket serve
-    {
-      title:
-        "should work and refresh content using hot module replacement when hot enabled",
-      options: {
-        allowedHosts: "all",
-
-        webSocketServer: "sockjs",
-        hot: true,
-      },
-    },
-    {
-      title:
-        "should work and refresh content using hot module replacement when live reload enabled",
-      options: {
-        allowedHosts: "all",
-
-        webSocketServer: "sockjs",
-        liveReload: true,
-      },
-    },
-    {
-      title: "should not refresh content when hot and no live reload disabled",
-      options: {
-        allowedHosts: "all",
-
-        webSocketServer: "sockjs",
-        hot: false,
-        liveReload: false,
-      },
-    },
-    {
-      title:
-        "should work and refresh content using hot module replacement when live reload disabled and hot enabled",
-      options: {
-        allowedHosts: "all",
-
-        webSocketServer: "sockjs",
-        liveReload: false,
-        hot: true,
-      },
-    },
-    {
-      title:
-        "should work and refresh content using live reload when live reload disabled and hot enabled",
-      options: {
-        allowedHosts: "all",
-
-        webSocketServer: "sockjs",
-        liveReload: true,
-        hot: false,
-      },
-    },
-    {
-      title:
-        "should work and refresh content using hot module replacement when live reload and hot enabled",
-      options: {
-        allowedHosts: "all",
-
-        webSocketServer: "sockjs",
-        liveReload: true,
-        hot: true,
-      },
-    },
     {
       title:
         'should work and allow to disable hot module replacement using the "webpack-dev-server-hot=false"',
@@ -347,89 +281,44 @@ describe("hot and live reload", () => {
         testDevServerOptions.webSocketServer !== false;
 
       await new Promise((resolve) => {
-        const webSocketTransport =
-          typeof testDevServerOptions.webSocketServer !== "undefined" &&
-          testDevServerOptions.webSocketServer !== false
-            ? testDevServerOptions.webSocketServer
-            : "ws";
-
-        if (webSocketTransport === "ws") {
-          const ws = new WebSocket(
-            `ws://localhost:${devServerOptions.port}/ws`,
-            {
-              headers: {
-                host: `localhost:${devServerOptions.port}`,
-                origin: `http://localhost:${devServerOptions.port}`,
-              },
-            },
-          );
-
-          let opened = false;
-          let received = false;
-          let errored = false;
-
-          ws.on("error", (_error) => {
-            errored = true;
-
-            ws.close();
-          });
-
-          ws.on("open", () => {
-            opened = true;
-          });
-
-          ws.on("message", (data) => {
-            const message = JSON.parse(data);
-
-            if (message.type === "ok") {
-              received = true;
+        const ws = new WebSocket(`ws://localhost:${devServerOptions.port}/ws`, {
+          headers: {
+            host: `localhost:${devServerOptions.port}`,
+            origin: `http://localhost:${devServerOptions.port}`,
+          },
+        });
 
-              ws.close();
-            }
-          });
+        let opened = false;
+        let received = false;
+        let errored = false;
 
-          ws.on("close", () => {
-            if (opened && received && !errored) {
-              resolve();
-            } else if (!webSocketServerLaunched && errored) {
-              resolve();
-            }
-          });
-        } else {
-          const sockjs = new SockJS(
-            `http://localhost:${devServerOptions.port}/ws`,
-          );
+        ws.on("error", (_error) => {
+          errored = true;
 
-          let opened = false;
-          let received = false;
-          let errored = false;
-
-          sockjs.onerror = () => {
-            errored = true;
-          };
+          ws.close();
+        });
 
-          sockjs.onopen = () => {
-            opened = true;
-          };
+        ws.on("open", () => {
+          opened = true;
+        });
 
-          sockjs.onmessage = ({ data }) => {
-            const message = JSON.parse(data);
+        ws.on("message", (data) => {
+          const message = JSON.parse(data);
 
-            if (message.type === "ok") {
-              received = true;
+          if (message.type === "ok") {
+            received = true;
 
-              sockjs.close();
-            }
-          };
+            ws.close();
+          }
+        });
 
-          sockjs.onclose = (event) => {
-            if (opened && received && !errored) {
-              resolve();
-            } else if (event && event.reason === "Cannot connect to server") {
-              resolve();
-            }
-          };
-        }
+        ws.on("close", () => {
+          if (opened && received && !errored) {
+            resolve();
+          } else if (!webSocketServerLaunched && errored) {
+            resolve();
+          }
+        });
       });
 
       const launched = await runBrowser();

test/validate-options.test.js

@@ -68,10 +68,7 @@ const tests = {
         },
       },
       {
-        webSocketTransport: "sockjs",
-      },
-      {
-        webSocketTransport: require.resolve("../client/clients/SockJSClient"),
+        webSocketTransport: "ws",
       },
       {
         webSocketURL: "ws://localhost:8080",
@@ -502,7 +499,6 @@ const tests = {
     success: [
       false,
       "ws",
-      "sockjs",
       {
         type: "ws",
         options: {