Tweak filterConsole

Author: weeman1337

test/components/structures/auth/ForgotPassword-test.tsx

@@ -40,7 +40,6 @@ describe("<ForgotPassword>", () => {
     let onComplete: () => void;
     let onLoginClick: () => void;
     let renderResult: RenderResult;
-    let restoreConsole: () => void;
 
     const typeIntoField = async (label: string, value: string): Promise<void> => {
         await act(async () => {
@@ -63,14 +62,14 @@ describe("<ForgotPassword>", () => {
         });
     };
 
-    beforeEach(() => {
-        restoreConsole = filterConsole(
-            // not implemented by js-dom https://github.com/jsdom/jsdom/issues/1937
-            "Not implemented: HTMLFormElement.prototype.requestSubmit",
-            // not of interested for this test
-            "Starting load of AsyncWrapper for modal",
-        );
+    filterConsole(
+        // not implemented by js-dom https://github.com/jsdom/jsdom/issues/1937
+        "Not implemented: HTMLFormElement.prototype.requestSubmit",
+        // not of interested for this test
+        "Starting load of AsyncWrapper for modal",
+    );
 
+    beforeEach(() => {
         client = stubClient();
         mocked(createClient).mockReturnValue(client);
 
@@ -87,7 +86,6 @@ describe("<ForgotPassword>", () => {
     afterEach(() => {
         // clean up modals
         Modal.closeCurrentModal("force");
-        restoreConsole?.();
     });
 
     beforeAll(() => {

test/components/views/avatars/RoomAvatar-test.tsx

@@ -20,7 +20,7 @@ import { MatrixClient, Room } from "matrix-js-sdk/src/matrix";
 import { mocked } from "jest-mock";
 
 import RoomAvatar from "../../../../src/components/views/avatars/RoomAvatar";
-import { stubClient } from "../../../test-utils";
+import { filterConsole, stubClient } from "../../../test-utils";
 import DMRoomMap from "../../../../src/utils/DMRoomMap";
 import { LocalRoom } from "../../../../src/models/LocalRoom";
 import * as AvatarModule from "../../../../src/Avatar";
@@ -29,6 +29,11 @@ import { DirectoryMember } from "../../../../src/utils/direct-messages";
 describe("RoomAvatar", () => {
     let client: MatrixClient;
 
+    filterConsole(
+        // unrelated for this test
+        "Room !room:example.com does not have an m.room.create event",
+    );
+
     beforeAll(() => {
         client = stubClient();
         const dmRoomMap = new DMRoomMap(client);

test/components/views/rooms/RoomTile-test.tsx

@@ -75,20 +75,19 @@ describe("RoomTile", () => {
     };
 
     let client: Mocked<MatrixClient>;
-    let restoreConsole: () => void;
     let voiceBroadcastInfoEvent: MatrixEvent;
     let room: Room;
     let renderResult: RenderResult;
     let sdkContext: TestSdkContext;
 
+    filterConsole(
+        // irrelevant for this test
+        "Room !1:example.org does not have an m.room.create event",
+    );
+
     beforeEach(() => {
         sdkContext = new TestSdkContext();
 
-        restoreConsole = filterConsole(
-            // irrelevant for this test
-            "Room !1:example.org does not have an m.room.create event",
-        );
-
         client = mocked(stubClient());
         sdkContext.client = client;
         DMRoomMap.makeShared();
@@ -105,7 +104,6 @@ describe("RoomTile", () => {
     });
 
     afterEach(() => {
-        restoreConsole();
         jest.clearAllMocks();
     });
 

test/components/views/user-onboarding/UserOnboardingPage-test.tsx

@@ -33,8 +33,6 @@ jest.mock("../../../../src/components/structures/HomePage", () => ({
 }));
 
 describe("UserOnboardingPage", () => {
-    let restoreConsole: () => void;
-
     const renderComponent = async (): Promise<RenderResult> => {
         const renderResult = render(<UserOnboardingPage />);
         await act(async () => {
@@ -43,12 +41,10 @@ describe("UserOnboardingPage", () => {
         return renderResult;
     };
 
-    beforeAll(() => {
-        restoreConsole = filterConsole(
-            // unrelated for this test
-            "could not update user onboarding context",
-        );
-    });
+    filterConsole(
+        // unrelated for this test
+        "could not update user onboarding context",
+    );
 
     beforeEach(() => {
         stubClient();
@@ -60,10 +56,6 @@ describe("UserOnboardingPage", () => {
         jest.restoreAllMocks();
     });
 
-    afterAll(() => {
-        restoreConsole();
-    });
-
     describe("when the user registered before the cutoff date", () => {
         beforeEach(() => {
             jest.spyOn(MatrixClientPeg, "userRegisteredAfter").mockReturnValue(false);

test/test-utils/console.ts

@@ -26,11 +26,11 @@ const originalFunctions: FilteredConsole = {
 
 /**
  * Allows to filter out specific messages in console.*.
+ * Automagically restores the original function by implementing an afterAll hook.
  *
  * @param ignoreList Messages to be filtered
- * @returns function to restore the console
  */
-export const filterConsole = (...ignoreList: string[]): (() => void) => {
+export const filterConsole = (...ignoreList: string[]): void => {
     for (const [key, originalFunction] of Object.entries(originalFunctions)) {
         window.console[key as keyof FilteredConsole] = (...data: any[]) => {
             const message = data?.[0]?.message || data?.[0];
@@ -43,9 +43,9 @@ export const filterConsole = (...ignoreList: string[]): (() => void) => {
         };
     }
 
-    return () => {
+    afterAll(() => {
         for (const [key, originalFunction] of Object.entries(originalFunctions)) {
             window.console[key as keyof FilteredConsole] = originalFunction;
         }
-    };
+    });
 };

test/voice-broadcast/components/molecules/VoiceBroadcastRecordingPip-test.tsx

@@ -62,7 +62,6 @@ describe("VoiceBroadcastRecordingPip", () => {
     let infoEvent: MatrixEvent;
     let recording: VoiceBroadcastRecording;
     let renderResult: RenderResult;
-    let restoreConsole: () => void;
 
     const renderPip = async (state: VoiceBroadcastInfoState) => {
         infoEvent = mkVoiceBroadcastInfoStateEvent(roomId, state, client.getUserId() || "", client.getDeviceId() || "");
@@ -85,6 +84,8 @@ describe("VoiceBroadcastRecordingPip", () => {
         });
     };
 
+    filterConsole("Starting load of AsyncWrapper for modal");
+
     beforeAll(() => {
         client = stubClient();
         mocked(requestMediaPermissions).mockResolvedValue({
@@ -105,11 +106,6 @@ describe("VoiceBroadcastRecordingPip", () => {
             [MediaDeviceKindEnum.VideoInput]: [],
         });
         jest.spyOn(MediaDeviceHandler.instance, "setDevice").mockImplementation();
-        restoreConsole = filterConsole("Starting load of AsyncWrapper for modal");
-    });
-
-    afterAll(() => {
-        restoreConsole();
     });
 
     describe("when rendering a started recording", () => {