test: mock console.error for proxy option tests and verify error logging

Author: bjohansebas

test/server/__snapshots__/proxy-option.test.js.snap.webpack5

@@ -0,0 +1,10 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`proxy option should work and respect \`logger\` option target respects a proxy option when a request path is matched 1`] = `"[HPM] Error occurred while proxying request %s to %s [%s] (%s)"`;
+
+exports[`proxy option should work and respect the \`infrastructureLogging.level\` option target respects a proxy option when a request path is matched 1`] = `
+"<e> [webpack-dev-server] [HPM] Error occurred while proxying request 127.0.0.1:<port>/my-path to http://unknown:1234/ [<DNS_ERROR>] (https://nodejs.org/api/errors.html#errors_common_system_errors)
+"
+`;
+
+exports[`proxy option should work and respect the \`infrastructureLogging.level\` option with \`none\` value target respects a proxy option when a request path is matched 1`] = `""`;

test/server/proxy-option.test.js

@@ -140,6 +140,23 @@ describe("proxy option", () => {
   let proxyServer1;
   let proxyServer2;
 
+  function getStderrOutput(stderrSpy) {
+    return stderrSpy.mock.calls
+      .map((call) => call[0])
+      .filter((output) => !output.includes("DeprecationWarning"))
+      .join("")
+      .replaceAll(/127\.0\.0\.1:\d+/g, "127.0.0.1:<port>")
+      .replaceAll(/\[ENOTFOUND\]|\[EAI_AGAIN\]/g, "[<DNS_ERROR>]");
+  }
+
+  function getConsoleErrorOutput(consoleSpy) {
+    return consoleSpy.mock.calls
+      .map((call) => call[0])
+      .join("\n")
+      .replaceAll(/127\.0\.0\.1:\d+/g, "127.0.0.1:<port>")
+      .replaceAll(/\[ENOTFOUND\]|\[EAI_AGAIN\]/g, "[<DNS_ERROR>]");
+  }
+
   async function listenProxyServers() {
     const proxyApp1 = express();
     const proxyApp2 = express();
@@ -834,16 +851,10 @@ describe("proxy option", () => {
   describe("should work and respect `logger` option", () => {
     let server;
     let req;
-    let customLogProvider;
+    let consoleSpy;
 
     beforeAll(async () => {
-      customLogProvider = {
-        log: jest.fn(),
-        debug: jest.fn(),
-        info: jest.fn(),
-        warn: jest.fn(),
-        error: jest.fn(),
-      };
+      consoleSpy = jest.spyOn(console, "error").mockImplementation(() => {});
 
       const compiler = webpack([config, config]);
 
@@ -853,7 +864,7 @@ describe("proxy option", () => {
             {
               context: "/my-path",
               target: "http://unknown:1234",
-              logger: customLogProvider,
+              logger: console,
             },
           ],
           port: port3,
@@ -869,6 +880,7 @@ describe("proxy option", () => {
     });
 
     afterAll(async () => {
+      consoleSpy.mockRestore();
       await server.stop();
       await closeProxyServers();
     });
@@ -877,28 +889,24 @@ describe("proxy option", () => {
       it("respects a proxy option when a request path is matched", async () => {
         await req.get("/my-path");
 
-        expect(customLogProvider.error).toHaveBeenCalledTimes(1);
+        expect(getConsoleErrorOutput(consoleSpy)).toMatchSnapshot();
       });
     });
   });
 
   describe("should work and respect the `infrastructureLogging.level` option", () => {
     let server;
     let req;
-    let customLogProvider;
+    let stderrSpy;
 
     beforeAll(async () => {
-      customLogProvider = {
-        log: jest.fn(),
-        debug: jest.fn(),
-        info: jest.fn(),
-        warn: jest.fn(),
-        error: jest.fn(),
-      };
+      stderrSpy = jest
+        .spyOn(process.stderr, "write")
+        .mockImplementation(() => true);
 
       const compiler = webpack({
         ...config,
-        infrastructureLogging: { level: "error" },
+        infrastructureLogging: { colors: false, level: "error" },
       });
 
       server = new Server(
@@ -907,7 +915,6 @@ describe("proxy option", () => {
             {
               context: "/my-path",
               target: "http://unknown:1234",
-              logger: customLogProvider,
             },
           ],
           port: port3,
@@ -923,6 +930,7 @@ describe("proxy option", () => {
     });
 
     afterAll(async () => {
+      stderrSpy.mockRestore();
       await server.stop();
       await closeProxyServers();
     });
@@ -931,24 +939,20 @@ describe("proxy option", () => {
       it("respects a proxy option when a request path is matched", async () => {
         await req.get("/my-path");
 
-        expect(customLogProvider.error).toHaveBeenCalledTimes(1);
+        expect(getStderrOutput(stderrSpy)).toMatchSnapshot();
       });
     });
   });
 
   describe("should work and respect the `infrastructureLogging.level` option with `none` value", () => {
     let server;
     let req;
-    let customLogProvider;
+    let stderrSpy;
 
     beforeAll(async () => {
-      customLogProvider = {
-        log: jest.fn(),
-        debug: jest.fn(),
-        info: jest.fn(),
-        warn: jest.fn(),
-        error: jest.fn(),
-      };
+      stderrSpy = jest
+        .spyOn(process.stderr, "write")
+        .mockImplementation(() => true);
 
       const compiler = webpack({
         ...config,
@@ -961,7 +965,6 @@ describe("proxy option", () => {
             {
               context: "/my-path",
               target: "http://unknown:1234",
-              logger: customLogProvider,
             },
           ],
           port: port3,
@@ -975,14 +978,15 @@ describe("proxy option", () => {
     });
 
     afterAll(async () => {
+      stderrSpy.mockRestore();
       await server.stop();
     });
 
     describe("target", () => {
       it("respects a proxy option when a request path is matched", async () => {
         await req.get("/my-path");
 
-        expect(customLogProvider.error).toHaveBeenCalledTimes(0);
+        expect(getStderrOutput(stderrSpy)).toMatchSnapshot();
       });
     });
   });