test: move client.test.js to playwright

Author: mahdikhashan

test/e2e-playwright/client.test.js

@@ -0,0 +1,277 @@
+"use strict";
+
+const webpack = require("webpack");
+const { test } = require("@playwright/test");
+const { expect } = require("@playwright/test");
+const { describe } = require("@playwright/test");
+const { afterEach } = require("@playwright/test");
+const { beforeEach } = require("@playwright/test");
+const Server = require("../../lib/Server");
+const config = require("../fixtures/simple-config-other/webpack.config");
+const port = require("../ports-map")["client-option"];
+
+describe("client option", () => {
+  describe("default behaviour", () => {
+    let compiler;
+    let server;
+    let pageErrors;
+    let consoleMessages;
+
+    beforeEach(async () => {
+      compiler = webpack(config);
+
+      server = new Server(
+        {
+          client: {
+            webSocketTransport: "sockjs",
+          },
+          webSocketServer: "sockjs",
+          port,
+        },
+        compiler,
+      );
+
+      await server.start();
+
+      pageErrors = [];
+      consoleMessages = [];
+    });
+
+    afterEach(async () => {
+      await server.stop();
+    });
+
+    test("responds with a 200 status code for /ws path", async ({ page }) => {
+      page
+        .on("console", (message) => {
+          consoleMessages.push(message);
+        })
+        .on("pageerror", (error) => {
+          pageErrors.push(error);
+        });
+
+      const response = await page.goto(`http://127.0.0.1:${port}/ws`, {
+        waitUntil: "networkidle0",
+      });
+
+      // overlay should be true by default
+      expect(server.options.client.overlay).toBe(true);
+
+      expect(JSON.stringify(response.status())).toMatchSnapshot();
+
+      expect(
+        JSON.stringify(consoleMessages.map((message) => message.text())),
+      ).toMatchSnapshot();
+
+      expect(JSON.stringify(pageErrors)).toMatchSnapshot();
+    });
+  });
+
+  describe("should respect path option", () => {
+    let compiler;
+    let server;
+    let pageErrors;
+    let consoleMessages;
+
+    beforeEach(async () => {
+      compiler = webpack(config);
+
+      server = new Server(
+        {
+          client: {
+            webSocketTransport: "sockjs",
+          },
+          webSocketServer: {
+            type: "sockjs",
+            options: {
+              host: "localhost",
+              port,
+              path: "/foo/test/bar",
+            },
+          },
+          port,
+        },
+        compiler,
+      );
+
+      await server.start();
+
+      pageErrors = [];
+      consoleMessages = [];
+    });
+
+    afterEach(async () => {
+      await server.stop();
+    });
+
+    test("responds with a 200 status code for /foo/test/bar path", async ({
+      page,
+    }) => {
+      page
+        .on("console", (message) => {
+          consoleMessages.push(message);
+        })
+        .on("pageerror", (error) => {
+          pageErrors.push(error);
+        });
+
+      const response = await page.goto(
+        `http://127.0.0.1:${port}/foo/test/bar`,
+        {
+          waitUntil: "networkidle0",
+        },
+      );
+
+      expect(JSON.stringify(response.status())).toMatchSnapshot();
+
+      expect(
+        JSON.stringify(consoleMessages.map((message) => message.text())),
+      ).toMatchSnapshot();
+
+      expect(JSON.stringify(pageErrors)).toMatchSnapshot();
+    });
+  });
+
+  describe("configure client entry", () => {
+    let compiler;
+    let server;
+    let pageErrors;
+    let consoleMessages;
+
+    beforeEach(async () => {
+      compiler = webpack(config);
+
+      server = new Server(
+        {
+          client: false,
+          port,
+        },
+        compiler,
+      );
+
+      await server.start();
+
+      pageErrors = [];
+      consoleMessages = [];
+    });
+
+    afterEach(async () => {
+      await server.stop();
+    });
+
+    test("should disable client entry", async ({ page }) => {
+      page
+        .on("console", (message) => {
+          consoleMessages.push(message);
+        })
+        .on("pageerror", (error) => {
+          pageErrors.push(error);
+        });
+
+      const response = await page.goto(`http://127.0.0.1:${port}/main.js`, {
+        waitUntil: "networkidle0",
+      });
+
+      expect(JSON.stringify(response.status())).toMatchSnapshot();
+
+      expect(await response.text()).not.toMatch(/client\/index\.js/);
+
+      expect(
+        JSON.stringify(consoleMessages.map((message) => message.text())),
+      ).toMatchSnapshot();
+
+      expect(JSON.stringify(pageErrors)).toMatchSnapshot();
+    });
+  });
+
+  describe("webSocketTransport", () => {
+    const clientModes = [
+      {
+        title: 'as a string ("sockjs")',
+        client: {
+          webSocketTransport: "sockjs",
+        },
+        webSocketServer: "sockjs",
+        shouldThrow: false,
+      },
+      {
+        title: 'as a string ("ws")',
+        client: {
+          webSocketTransport: "ws",
+        },
+        webSocketServer: "ws",
+        shouldThrow: false,
+      },
+      {
+        title: 'as a path ("sockjs")',
+        client: {
+          webSocketTransport: require.resolve(
+            "../../client-src/clients/SockJSClient",
+          ),
+        },
+        webSocketServer: "sockjs",
+        shouldThrow: false,
+      },
+      {
+        title: 'as a path ("ws")',
+        client: {
+          webSocketTransport: require.resolve(
+            "../../client-src/clients/WebSocketClient",
+          ),
+        },
+        webSocketServer: "ws",
+        shouldThrow: false,
+      },
+      {
+        title: "as a nonexistent path (sockjs)",
+        client: {
+          webSocketTransport: "/bad/path/to/implementation",
+        },
+        webSocketServer: "sockjs",
+        shouldThrow: true,
+      },
+      {
+        title: "as a nonexistent path (ws)",
+        client: {
+          webSocketTransport: "/bad/path/to/implementation",
+        },
+        webSocketServer: "ws",
+        shouldThrow: true,
+      },
+    ];
+
+    describe("passed to server", () => {
+      clientModes.forEach((data) => {
+        test(`${data.title} ${
+          data.shouldThrow ? "should throw" : "should not throw"
+        }`, async () => {
+          const compiler = webpack(config);
+
+          const server = new Server(
+            {
+              client: data.client,
+              port,
+            },
+            compiler,
+          );
+
+          let thrownError;
+
+          try {
+            await server.start();
+          } catch (error) {
+            thrownError = error;
+          }
+
+          if (data.shouldThrow) {
+            expect(thrownError.message).toMatch(
+              /client\.webSocketTransport must be a string/,
+            );
+          }
+
+          await server.stop();
+        });
+      });
+    });
+  });
+});

test/e2e-playwright/client.test.js-snapshots/client-option-configure-client-entry-should-disable-client-entry-1-chromium-darwin.txt

@@ -0,0 +1 @@
+200

test/e2e-playwright/client.test.js-snapshots/client-option-configure-client-entry-should-disable-client-entry-2-chromium-darwin.txt

@@ -0,0 +1 @@
+[]

test/e2e-playwright/client.test.js-snapshots/client-option-configure-client-entry-should-disable-client-entry-3-chromium-darwin.txt

@@ -0,0 +1 @@
+[]

test/e2e-playwright/client.test.js-snapshots/client-option-default-behaviour-responds-with-a-200-status-code-for-ws-path-1-chromium-darwin.txt

@@ -0,0 +1 @@
+200

test/e2e-playwright/client.test.js-snapshots/client-option-default-behaviour-responds-with-a-200-status-code-for-ws-path-2-chromium-darwin.txt

@@ -0,0 +1 @@
+[]

test/e2e-playwright/client.test.js-snapshots/client-option-default-behaviour-responds-with-a-200-status-code-for-ws-path-3-chromium-darwin.txt

@@ -0,0 +1 @@
+[]

test/e2e-playwright/client.test.js-snapshots/client-option-should-respect-path-option-responds-with-a-200-status-code-for-foo-test-bar-path-1-chromium-darwin.txt

@@ -0,0 +1 @@
+200

test/e2e-playwright/client.test.js-snapshots/client-option-should-respect-path-option-responds-with-a-200-status-code-for-foo-test-bar-path-2-chromium-darwin.txt

@@ -0,0 +1 @@
+[]

test/e2e-playwright/client.test.js-snapshots/client-option-should-respect-path-option-responds-with-a-200-status-code-for-foo-test-bar-path-3-chromium-darwin.txt

@@ -0,0 +1 @@
+[]