Prefer MatrixClientContext over MatrixClientPeg (#10986)

test/components/views/settings/tabs/room/BridgeSettingsTab-test.tsx

@@ -19,7 +19,7 @@ import { render } from "@testing-library/react";
 import { MatrixEvent, Room } from "matrix-js-sdk/src/matrix";
 
 import BridgeSettingsTab from "../../../../../../src/components/views/settings/tabs/room/BridgeSettingsTab";
-import { getMockClientWithEventEmitter } from "../../../../../test-utils";
+import { getMockClientWithEventEmitter, withClientContextRenderOptions } from "../../../../../test-utils";
 
 describe("<BridgeSettingsTab />", () => {
     const userId = "@alice:server.org";
@@ -28,7 +28,8 @@ describe("<BridgeSettingsTab />", () => {
     });
     const roomId = "!room:server.org";
 
-    const getComponent = (room: Room) => render(<BridgeSettingsTab room={room} />);
+    const getComponent = (room: Room) =>
+        render(<BridgeSettingsTab room={room} />, withClientContextRenderOptions(client));
 
     it("renders when room is not bridging messages to any platform", () => {
         const room = new Room(roomId, client, userId);

test/components/views/settings/tabs/room/RolesRoomSettingsTab-test.tsx

@@ -24,7 +24,7 @@ import { mocked } from "jest-mock";
 import { RoomMember } from "matrix-js-sdk/src/matrix";
 
 import RolesRoomSettingsTab from "../../../../../../src/components/views/settings/tabs/room/RolesRoomSettingsTab";
-import { mkStubRoom, stubClient } from "../../../../../test-utils";
+import { mkStubRoom, withClientContextRenderOptions, stubClient } from "../../../../../test-utils";
 import { MatrixClientPeg } from "../../../../../../src/MatrixClientPeg";
 import { VoiceBroadcastInfoEventType } from "../../../../../../src/voice-broadcast";
 import SettingsStore from "../../../../../../src/settings/SettingsStore";
@@ -37,7 +37,7 @@ describe("RolesRoomSettingsTab", () => {
     let room: Room;
 
     const renderTab = (propRoom: Room = room): RenderResult => {
-        return render(<RolesRoomSettingsTab room={propRoom} />);
+        return render(<RolesRoomSettingsTab room={propRoom} />, withClientContextRenderOptions(cli));
     };
 
     const getVoiceBroadcastsSelect = (): HTMLElement => {

test/components/views/settings/tabs/user/AppearanceUserSettingsTab-test.tsx

@@ -16,9 +16,10 @@ limitations under the License.
 
 import { render } from "@testing-library/react";
 import React from "react";
+import { MatrixClient } from "matrix-js-sdk/src/matrix";
 
 import AppearanceUserSettingsTab from "../../../../../../src/components/views/settings/tabs/user/AppearanceUserSettingsTab";
-import { stubClient } from "../../../../../test-utils";
+import { withClientContextRenderOptions, stubClient } from "../../../../../test-utils";
 
 // Fake random strings to give a predictable snapshot
 jest.mock("matrix-js-sdk/src/randomstring", () => ({
@@ -26,12 +27,14 @@ jest.mock("matrix-js-sdk/src/randomstring", () => ({
 }));
 
 describe("AppearanceUserSettingsTab", () => {
+    let client: MatrixClient;
+
     beforeEach(() => {
-        stubClient();
+        client = stubClient();
     });
 
     it("should render", () => {
-        const { asFragment } = render(<AppearanceUserSettingsTab />);
+        const { asFragment } = render(<AppearanceUserSettingsTab />, withClientContextRenderOptions(client));
         expect(asFragment()).toMatchSnapshot();
     });
 });

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

@@ -17,7 +17,7 @@ limitations under the License.
 import React from "react";
 import { act, render, RenderResult } from "@testing-library/react";
 
-import { filterConsole, stubClient } from "../../../test-utils";
+import { filterConsole, withClientContextRenderOptions, stubClient } from "../../../test-utils";
 import { UserOnboardingPage } from "../../../../src/components/views/user-onboarding/UserOnboardingPage";
 import { MatrixClientPeg } from "../../../../src/MatrixClientPeg";
 import SdkConfig from "../../../../src/SdkConfig";
@@ -34,7 +34,7 @@ jest.mock("../../../../src/components/structures/HomePage", () => ({
 
 describe("UserOnboardingPage", () => {
     const renderComponent = async (): Promise<RenderResult> => {
-        const renderResult = render(<UserOnboardingPage />);
+        const renderResult = render(<UserOnboardingPage />, withClientContextRenderOptions(MatrixClientPeg.safeGet()));
         await act(async () => {
             jest.runAllTimers();
         });

test/test-utils/wrappers.tsx

@@ -16,6 +16,7 @@ limitations under the License.
 
 import React, { ComponentType, Ref } from "react";
 import { MatrixClient } from "matrix-js-sdk/src/matrix";
+import { RenderOptions } from "@testing-library/react";
 
 import { MatrixClientPeg as peg } from "../../src/MatrixClientPeg";
 import MatrixClientContext from "../../src/contexts/MatrixClientContext";
@@ -57,3 +58,15 @@ export function wrapInSdkContext<T>(
         }
     };
 }
+
+/**
+ * Test helper to generate React testing library render options for wrapping with a MatrixClientContext.Provider
+ * @param client the MatrixClient instance to expose via the provider
+ */
+export function withClientContextRenderOptions(client: MatrixClient): RenderOptions {
+    return {
+        wrapper: ({ children }) => (
+            <MatrixClientContext.Provider value={client}>{children}</MatrixClientContext.Provider>
+        ),
+    };
+}

test/voice-broadcast/components/VoiceBroadcastBody-test.tsx

@@ -28,7 +28,7 @@ import {
     VoiceBroadcastPlayback,
     VoiceBroadcastRecordingsStore,
 } from "../../../src/voice-broadcast";
-import { stubClient, wrapInSdkContext } from "../../test-utils";
+import { withClientContextRenderOptions, stubClient, wrapInSdkContext } from "../../test-utils";
 import { mkVoiceBroadcastInfoStateEvent } from "../utils/test-utils";
 import { MediaEventHelper } from "../../../src/utils/MediaEventHelper";
 import { RoomPermalinkCreator } from "../../../src/utils/permalinks/Permalinks";
@@ -66,6 +66,7 @@ describe("VoiceBroadcastBody", () => {
                 onMessageAllowed={() => {}}
                 permalinkCreator={new RoomPermalinkCreator(room)}
             />,
+            withClientContextRenderOptions(client),
         );
         testRecording = SdkContextClass.instance.voiceBroadcastRecordingsStore.getByInfoEvent(infoEvent, client);
     };