Separate out SDKContext (#34053)

* Separate out SDKContext

...from SDKContextClass, as the comments hopefully explain.

Also make the captitalisation consistent.

* Adding the new file usually helps too

* Fix import

* More comment

* Update the various imports of SDKContextClass

* Also fix case of TestSDKContext

* Update the mock
This commit is contained in:
David Baker
2026-07-01 12:49:18 +00:00
committed by GitHub
parent 1c1bda9cab
commit 54d27fd59c
89 changed files with 493 additions and 458 deletions
+3 -3
View File
@@ -38,7 +38,7 @@ import {
mockPlatformPeg,
} from "../test-utils";
import { getIncomingCallToastKey, IncomingCallToast } from "../../src/toasts/IncomingCallToast";
import { SdkContextClass } from "../../src/contexts/SDKContext";
import { SDKContextClass } from "../../src/contexts/SDKContextClass";
import UserActivity from "../../src/UserActivity";
import Modal from "../../src/Modal";
import { mkThread } from "../test-utils/threads";
@@ -665,7 +665,7 @@ describe("Notifier", () => {
describe("evaluateEvent", () => {
beforeEach(() => {
jest.spyOn(SdkContextClass.instance.roomViewStore, "getRoomId").mockReturnValue(testRoom.roomId);
jest.spyOn(SDKContextClass.instance.roomViewStore, "getRoomId").mockReturnValue(testRoom.roomId);
jest.spyOn(UserActivity.sharedInstance(), "userActiveRecently").mockReturnValue(true);
@@ -720,7 +720,7 @@ describe("Notifier", () => {
thread_id: rootEvent.getId()!,
});
await waitFor(() => expect(SdkContextClass.instance.roomViewStore.getThreadId()).toBe(rootEvent.getId()));
await waitFor(() => expect(SDKContextClass.instance.roomViewStore.getThreadId()).toBe(rootEvent.getId()));
Notifier.evaluateEvent(events[1]);
expect(Notifier.displayPopupNotification).toHaveBeenCalledTimes(1);
@@ -6,7 +6,7 @@ SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Com
Please see LICENSE files in the repository root for full details.
*/
import { SdkContextClass } from "../../src/contexts/SDKContext";
import { SDKContextClass } from "../../src/contexts/SDKContextClass";
import { type PosthogAnalytics } from "../../src/PosthogAnalytics";
import { type SlidingSyncManager } from "../../src/SlidingSyncManager";
import { type RoomNotificationStateStore } from "../../src/stores/notifications/RoomNotificationStateStore";
@@ -18,10 +18,10 @@ import { type WidgetPermissionStore } from "../../src/stores/widgets/WidgetPermi
import type WidgetStore from "../../src/stores/WidgetStore";
/**
* A class which provides the same API as SdkContextClass but adds additional unsafe setters which can
* A class which provides the same API as SDKContextClass but adds additional unsafe setters which can
* replace individual stores. This is useful for tests which need to mock out stores.
*/
export class TestSdkContext extends SdkContextClass {
export class TestSDKContext extends SDKContextClass {
declare public _RightPanelStore?: RightPanelStore;
declare public _RoomNotificationStateStore?: RoomNotificationStateStore;
declare public _RoomViewStore?: RoomViewStore;
@@ -12,7 +12,7 @@ import { PlaybackQueue } from "../../../src/audio/PlaybackQueue";
import { type Playback, PlaybackState } from "../../../src/audio/Playback";
import { UPDATE_EVENT } from "../../../src/stores/AsyncStore";
import { MockedPlayback } from "./MockedPlayback";
import { SdkContextClass } from "../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../src/contexts/SDKContextClass";
describe("PlaybackQueue", () => {
let playbackQueue: PlaybackQueue;
@@ -22,7 +22,7 @@ describe("PlaybackQueue", () => {
mockRoom = {
getMember: jest.fn(),
} as unknown as Mocked<Room>;
playbackQueue = new PlaybackQueue(mockRoom, SdkContextClass.instance.roomViewStore);
playbackQueue = new PlaybackQueue(mockRoom, SDKContextClass.instance.roomViewStore);
});
it.each([
@@ -76,7 +76,7 @@ describe("PlaybackQueue", () => {
`mx_voice_message_clocks_${mockRoom.roomId}`,
JSON.stringify(Array.from(clockStates.entries())),
);
playbackQueue = new PlaybackQueue(mockRoom, SdkContextClass.instance.roomViewStore);
playbackQueue = new PlaybackQueue(mockRoom, SDKContextClass.instance.roomViewStore);
// @ts-ignore
expect(playbackQueue.clockStates.has("a")).toBe(true);
@@ -31,7 +31,7 @@ import { SDKContext } from "../../../../src/contexts/SDKContext";
import { StandardActions } from "../../../../src/notifications/StandardActions";
import ResizeNotifier from "../../../../src/utils/ResizeNotifier";
import { flushPromises, getMockClientWithEventEmitter, mockClientMethodsUser } from "../../../test-utils";
import { TestSdkContext } from "../../TestSdkContext";
import { TestSDKContext } from "../../TestSDKContext";
import defaultDispatcher from "../../../../src/dispatcher/dispatcher";
import SettingsStore from "../../../../src/settings/SettingsStore";
import { SettingLevel } from "../../../../src/settings/SettingLevel";
@@ -80,7 +80,7 @@ describe("<LoggedInView />", () => {
doesServerSupportExtendedProfiles: jest.fn().mockResolvedValue(true),
});
const mediaHandler = new MediaHandler(mockClient);
const mockSdkContext = new TestSdkContext();
const mockSdkContext = new TestSDKContext();
const defaultProps = {
matrixClient: mockClient,
@@ -11,7 +11,8 @@ import { render, fireEvent } from "jest-matrix-react";
import MainSplit from "../../../../src/components/structures/MainSplit";
import { PosthogAnalytics } from "../../../../src/PosthogAnalytics.ts";
import { SDKContext, SdkContextClass } from "../../../../src/contexts/SDKContext.ts";
import { SDKContext } from "../../../../src/contexts/SDKContext.ts";
import { SDKContextClass } from "../../../../src/contexts/SDKContextClass";
describe("<MainSplit/>", () => {
const children = (
@@ -20,11 +21,11 @@ describe("<MainSplit/>", () => {
</div>
);
const panel = <div>Right panel</div>;
let sdkContext: SdkContextClass;
let sdkContext: SDKContextClass;
beforeEach(() => {
localStorage.clear();
sdkContext = new SdkContextClass();
sdkContext = new SDKContextClass();
});
it("renders", () => {
@@ -70,7 +70,7 @@ import { ShareFormat } from "../../../../src/dispatcher/payloads/SharePayload.ts
import { clearStorage } from "../../../../src/Lifecycle";
import RoomListStore from "../../../../src/stores/room-list/RoomListStore.ts";
import UserSettingsDialog from "../../../../src/components/views/dialogs/UserSettingsDialog.tsx";
import { SdkContextClass } from "../../../../src/contexts/SDKContext.ts";
import { SDKContextClass } from "../../../../src/contexts/SDKContextClass";
import { makeDelegatedAuthConfig } from "../../../test-utils/oidc.ts";
import { type QrLoginCredentials } from "../../../../src/components/views/auth/LoginWithQR.tsx";
@@ -322,24 +322,24 @@ describe("<MatrixChat />", () => {
it("should notify resizenotifier when left panel hidden", async () => {
getComponent();
jest.spyOn(SdkContextClass.instance.resizeNotifier, "notifyLeftHandleResized");
jest.spyOn(SDKContextClass.instance.resizeNotifier, "notifyLeftHandleResized");
defaultDispatcher.dispatch({ action: "hide_left_panel" });
await waitFor(() =>
expect(mocked(SdkContextClass.instance.resizeNotifier.notifyLeftHandleResized)).toHaveBeenCalled(),
expect(mocked(SDKContextClass.instance.resizeNotifier.notifyLeftHandleResized)).toHaveBeenCalled(),
);
});
it("should notify resizenotifier when left panel shown", async () => {
getComponent();
jest.spyOn(SdkContextClass.instance.resizeNotifier, "notifyLeftHandleResized");
jest.spyOn(SDKContextClass.instance.resizeNotifier, "notifyLeftHandleResized");
defaultDispatcher.dispatch({ action: "show_left_panel" });
await waitFor(() =>
expect(mocked(SdkContextClass.instance.resizeNotifier.notifyLeftHandleResized)).toHaveBeenCalled(),
expect(mocked(SDKContextClass.instance.resizeNotifier.notifyLeftHandleResized)).toHaveBeenCalled(),
);
});
@@ -823,7 +823,7 @@ describe("<MatrixChat />", () => {
await waitFor(() =>
expect(createDialog).toHaveBeenCalledWith(
UserSettingsDialog,
{ initialTabId: UserTab.SessionManager, sdkContext: expect.any(SdkContextClass) },
{ initialTabId: UserTab.SessionManager, sdkContext: expect.any(SDKContextClass) },
/*className=*/ undefined,
/*isPriority=*/ false,
/*isStatic=*/ true,
@@ -31,7 +31,7 @@ import {
import type ResizeNotifier from "../../../../src/utils/ResizeNotifier";
import { MatrixClientPeg } from "../../../../src/MatrixClientPeg";
import { ScopedRoomContextProvider } from "../../../../src/contexts/ScopedRoomContext.tsx";
import { SdkContextClass } from "../../../../src/contexts/SDKContext.ts";
import { SDKContextClass } from "../../../../src/contexts/SDKContextClass";
jest.mock("../../../../src/utils/beacon", () => ({
useBeacon: jest.fn(),
@@ -54,7 +54,7 @@ describe("MessagePanel", function () {
getClientWellKnown: jest.fn().mockReturnValue({}),
supportsThreads: jest.fn().mockReturnValue(true),
});
let sdkContext: SdkContextClass;
let sdkContext: SDKContextClass;
jest.spyOn(MatrixClientPeg, "get").mockReturnValue(client);
const room = new Room(roomId, client, userId);
@@ -106,7 +106,7 @@ describe("MessagePanel", function () {
return arg === "showDisplaynameChanges";
});
sdkContext = new SdkContextClass();
sdkContext = new SDKContextClass();
DMRoomMap.makeShared(client);
});
@@ -41,12 +41,12 @@ import DMRoomMap from "../../../../src/utils/DMRoomMap";
import defaultDispatcher from "../../../../src/dispatcher/dispatcher";
import { Action } from "../../../../src/dispatcher/actions";
import { type ViewRoomPayload } from "../../../../src/dispatcher/payloads/ViewRoomPayload";
import { TestSdkContext } from "../../TestSdkContext";
import { TestSDKContext } from "../../TestSDKContext";
import { RoomViewStore } from "../../../../src/stores/RoomViewStore";
import { WidgetLayoutStore } from "../../../../src/stores/widgets/WidgetLayoutStore";
import WidgetStore from "../../../../src/stores/WidgetStore";
import { WidgetType } from "../../../../src/widgets/WidgetType";
import { SdkContextClass } from "../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../src/contexts/SDKContextClass";
import { type WidgetMessaging } from "../../../../src/stores/widgets/WidgetMessaging";
jest.mock("../../../../src/stores/OwnProfileStore", () => ({
@@ -65,7 +65,7 @@ describe("PipContainer", () => {
jest.spyOn(HTMLMediaElement.prototype, "play").mockImplementation(async () => {});
let user: UserEvent;
let sdkContext: TestSdkContext;
let sdkContext: TestSDKContext;
let client: Mocked<MatrixClient>;
let room: Room;
let room2: Room;
@@ -109,9 +109,9 @@ describe("PipContainer", () => {
),
);
sdkContext = new TestSdkContext();
sdkContext = new TestSDKContext();
// @ts-ignore PipContainer uses SDKContext in the constructor
SdkContextClass.instance = sdkContext;
SDKContextClass.instance = sdkContext;
sdkContext.client = client;
});
@@ -23,7 +23,7 @@ import { RightPanelPhases } from "../../../../src/stores/right-panel/RightPanelS
import RightPanelStore from "../../../../src/stores/right-panel/RightPanelStore";
import { UPDATE_EVENT } from "../../../../src/stores/AsyncStore";
import { WidgetLayoutStore } from "../../../../src/stores/widgets/WidgetLayoutStore";
import { SdkContextClass } from "../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../src/contexts/SDKContextClass";
import { RoomPermalinkCreator } from "../../../../src/utils/permalinks/Permalinks";
const RightPanelBase = wrapInMatrixClientContext(_RightPanel);
@@ -32,13 +32,13 @@ describe("RightPanel", () => {
const resizeNotifier = new ResizeNotifier();
let cli: MockedObject<MatrixClient>;
let context: SdkContextClass;
let context: SDKContextClass;
let RightPanel: React.ComponentType<React.ComponentProps<typeof RightPanelBase>>;
beforeEach(() => {
stubClient();
cli = mocked(MatrixClientPeg.safeGet());
DMRoomMap.makeShared(cli);
context = new SdkContextClass();
context = new SDKContextClass();
context.client = cli;
RightPanel = wrapInSdkContext(RightPanelBase, context);
});
@@ -24,7 +24,7 @@ import { clientAndSDKContextRenderOptions, stubClient } from "../../../test-util
import MatrixClientContext from "../../../../src/contexts/MatrixClientContext";
import { MatrixClientPeg } from "../../../../src/MatrixClientPeg";
import { searchPagination, SearchScope } from "../../../../src/Searching";
import { SdkContextClass } from "../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../src/contexts/SDKContextClass";
import SettingsStore from "../../../../src/settings/SettingsStore.ts";
import { SettingLevel } from "../../../../src/settings/SettingLevel.ts";
@@ -36,13 +36,13 @@ jest.mock("../../../../src/Searching", () => ({
describe("<RoomSearchView/>", () => {
const eventMapper = (obj: Partial<IEvent>) => new MatrixEvent(obj);
let client: MatrixClient;
let sdkContext: SdkContextClass;
let sdkContext: SDKContextClass;
let room: Room;
beforeEach(async () => {
stubClient();
client = MatrixClientPeg.safeGet();
sdkContext = new SdkContextClass();
sdkContext = new SDKContextClass();
client.supportsThreads = jest.fn().mockReturnValue(true);
room = new Room("!room:server", client, client.getSafeUserId());
mocked(client.getRoom).mockReturnValue(room);
@@ -55,7 +55,8 @@ import { type LocalRoom, LocalRoomState } from "../../../../src/models/LocalRoom
import { DirectoryMember } from "../../../../src/utils/direct-messages";
import { createDmLocalRoom } from "../../../../src/utils/dm/createDmLocalRoom";
import { UPDATE_EVENT } from "../../../../src/stores/AsyncStore";
import { SDKContext, SdkContextClass } from "../../../../src/contexts/SDKContext";
import { SDKContext } from "../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../src/contexts/SDKContextClass";
import WidgetUtils from "../../../../src/utils/WidgetUtils";
import { WidgetType } from "../../../../src/widgets/WidgetType";
import WidgetStore from "../../../../src/stores/WidgetStore";
@@ -85,7 +86,7 @@ describe("RoomView", () => {
let cli: MockedObject<MatrixClient>;
let room: Room;
let rooms: Map<string, Room>;
let stores: SdkContextClass;
let stores: SDKContextClass;
let crypto: CryptoApi;
// mute some noise
@@ -110,7 +111,7 @@ describe("RoomView", () => {
room.on(RoomEvent.TimelineReset, (...args) => cli.emit(RoomEvent.TimelineReset, ...args));
DMRoomMap.makeShared(cli);
stores = new SdkContextClass();
stores = new SDKContextClass();
stores.client = cli;
stores.rightPanelStore.useUnitTestClient(cli);
@@ -23,7 +23,7 @@ import React, { useState } from "react";
import ThreadView from "../../../../src/components/structures/ThreadView";
import MatrixClientContext from "../../../../src/contexts/MatrixClientContext";
import { SdkContextClass } from "../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../src/contexts/SDKContextClass";
import { Action } from "../../../../src/dispatcher/actions";
import dispatcher from "../../../../src/dispatcher/dispatcher";
import { MatrixClientPeg } from "../../../../src/MatrixClientPeg";
@@ -190,18 +190,18 @@ describe("ThreadView", () => {
});
it("sets the correct thread in the room view store", async () => {
// expect(SdkContextClass.instance.roomViewStore.getThreadId()).toBeNull();
// expect(SDKContextClass.instance.roomViewStore.getThreadId()).toBeNull();
const { unmount } = await getComponent();
waitFor(() => {
expect(SdkContextClass.instance.roomViewStore.getThreadId()).toBe(rootEvent.getId());
expect(SDKContextClass.instance.roomViewStore.getThreadId()).toBe(rootEvent.getId());
});
unmount();
await waitFor(() => expect(SdkContextClass.instance.roomViewStore.getThreadId()).toBeNull());
await waitFor(() => expect(SDKContextClass.instance.roomViewStore.getThreadId()).toBeNull());
});
it("clears highlight message in the room view store", async () => {
jest.spyOn(SdkContextClass.instance.roomViewStore, "getRoomId").mockReturnValue(room.roomId);
jest.spyOn(SDKContextClass.instance.roomViewStore, "getRoomId").mockReturnValue(room.roomId);
const mock = jest.spyOn(dispatcher, "dispatch");
const { unmount } = await getComponent(rootEvent);
mock.mockClear();
@@ -52,7 +52,7 @@ import defaultDispatcher from "../../../../src/dispatcher/dispatcher";
import { Action } from "../../../../src/dispatcher/actions";
import { SettingLevel } from "../../../../src/settings/SettingLevel";
import MatrixClientBackedController from "../../../../src/settings/controllers/MatrixClientBackedController";
import { SdkContextClass } from "../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../src/contexts/SDKContextClass";
import type Timer from "../../../../src/utils/Timer";
// ScrollPanel calls this, but jsdom doesn't mock it for us
@@ -162,7 +162,7 @@ const setupPagination = (
describe("TimelinePanel", () => {
let client: Mocked<MatrixClient>;
let sdkContext: SdkContextClass;
let sdkContext: SDKContextClass;
let userId: string;
filterConsole("checkForPreJoinUISI: showing all messages, skipping check");
@@ -170,7 +170,7 @@ describe("TimelinePanel", () => {
beforeEach(() => {
client = mocked(stubClient());
userId = client.getSafeUserId();
sdkContext = new SdkContextClass();
sdkContext = new SDKContextClass();
});
describe("read receipts and markers", () => {
@@ -30,7 +30,7 @@ import DMRoomMap from "../../../../../src/utils/DMRoomMap";
import SdkConfig from "../../../../../src/SdkConfig";
import { type ValidatedServerConfig } from "../../../../../src/utils/ValidatedServerConfig";
import { type IConfigOptions } from "../../../../../src/IConfigOptions";
import { SdkContextClass } from "../../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../../src/contexts/SDKContextClass";
import { type IProfileInfo } from "../../../../../src/hooks/useProfileInfo";
import { DirectoryMember, startDmOnFirstMessage } from "../../../../../src/utils/direct-messages";
@@ -178,13 +178,13 @@ describe("InviteDialog", () => {
mockClient.getRooms.mockReturnValue([room]);
mockClient.getRoom.mockReturnValue(room);
SdkContextClass.instance.client = mockClient;
SDKContextClass.instance.client = mockClient;
});
afterEach(async () => {
await clearAllModals();
SdkContextClass.instance.onLoggedOut();
SdkContextClass.instance.client = undefined;
SDKContextClass.instance.onLoggedOut();
SDKContextClass.instance.client = undefined;
});
afterAll(() => {
@@ -13,12 +13,13 @@ import { EventType, MatrixEvent } from "matrix-js-sdk/src/matrix";
import type { MatrixClient } from "matrix-js-sdk/src/matrix";
import { flushPromises, mkMessage, stubClient } from "../../../../test-utils";
import MessageEditHistoryDialog from "../../../../../src/components/views/dialogs/MessageEditHistoryDialog";
import { SDKContext, SdkContextClass } from "../../../../../src/contexts/SDKContext";
import { SDKContext } from "../../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../../src/contexts/SDKContextClass";
describe("<MessageEditHistory />", () => {
const roomId = "!aroom:example.com";
let client: jest.Mocked<MatrixClient>;
let sdkContext: SdkContextClass;
let sdkContext: SDKContextClass;
let event: MatrixEvent;
beforeEach(() => {
@@ -29,7 +30,7 @@ describe("<MessageEditHistory />", () => {
room: "!room:example.com",
msg: "My Great Message",
});
sdkContext = new SdkContextClass();
sdkContext = new SDKContextClass();
});
async function renderComponent(): Promise<RenderResult> {
@@ -24,7 +24,7 @@ import MatrixClientContext from "../../../../../src/contexts/MatrixClientContext
import SettingsStore from "../../../../../src/settings/SettingsStore";
import { UIFeature } from "../../../../../src/settings/UIFeature";
import DMRoomMap from "../../../../../src/utils/DMRoomMap";
import { SdkContextClass } from "../../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../../src/contexts/SDKContextClass";
describe("<RoomSettingsDialog />", () => {
const userId = "@alice:server.org";
@@ -44,7 +44,7 @@ describe("<RoomSettingsDialog />", () => {
const room2 = new Room("!room2:server.org", mockClient, userId);
room2.name = "Another Room";
let sdkContext: SdkContextClass;
let sdkContext: SDKContextClass;
jest.spyOn(SettingsStore, "getValue");
@@ -57,7 +57,7 @@ describe("<RoomSettingsDialog />", () => {
return null;
});
sdkContext = new SdkContextClass();
sdkContext = new SDKContextClass();
sdkContext.client = mockClient;
jest.spyOn(SettingsStore, "getValue").mockReset().mockReturnValue(false);
@@ -26,7 +26,7 @@ import {
} from "../../../../test-utils";
import { UIFeature } from "../../../../../src/settings/UIFeature";
import { SettingLevel } from "../../../../../src/settings/SettingLevel";
import { SdkContextClass } from "../../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../../src/contexts/SDKContextClass";
import { type FeatureSettingKey } from "../../../../../src/settings/Settings.tsx";
import { mockOpenIdConfiguration } from "../../../../test-utils/oidc.ts";
@@ -57,7 +57,7 @@ describe("<UserSettingsDialog />", () => {
const mockSettingsStore = mocked(SettingsStore);
let mockClient!: MockedObject<MatrixClient>;
let sdkContext: SdkContextClass;
let sdkContext: SDKContextClass;
const defaultProps = { onFinished: jest.fn() };
const getComponent = (
props: Partial<typeof defaultProps & { initialTabId?: UserTab; props: Record<string, any> }> = {},
@@ -76,7 +76,7 @@ describe("<UserSettingsDialog />", () => {
getMediaConfig: jest.fn(),
getAuthMetadata: jest.fn().mockResolvedValue(mockOpenIdConfiguration()),
});
sdkContext = new SdkContextClass();
sdkContext = new SDKContextClass();
sdkContext.client = mockClient;
mockSettingsStore.getValue.mockReturnValue(false);
mockSettingsStore.getValueAt.mockReturnValue(false);
@@ -39,7 +39,7 @@ import { WidgetMessagingStore } from "../../../../../src/stores/widgets/WidgetMe
import { ModuleRunner } from "../../../../../src/modules/ModuleRunner";
import { ModuleApi } from "../../../../../src/modules/Api";
import { RoomPermalinkCreator } from "../../../../../src/utils/permalinks/Permalinks";
import { SdkContextClass } from "../../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../../src/contexts/SDKContextClass";
jest.mock("../../../../../src/stores/OwnProfileStore", () => ({
OwnProfileStore: {
@@ -56,7 +56,7 @@ const realGetValue = SettingsStore.getValue;
describe("AppTile", () => {
let cli: MatrixClient;
let sdkContext: SdkContextClass;
let sdkContext: SDKContextClass;
let r1: Room;
let r2: Room;
const resizeNotifier = new ResizeNotifier();
@@ -118,7 +118,7 @@ describe("AppTile", () => {
beforeEach(async () => {
// Do not carry across settings from previous tests
SettingsStore.reset();
sdkContext = new SdkContextClass();
sdkContext = new SDKContextClass();
// @ts-ignore
await WidgetMessagingStore.instance.onReady();
@@ -27,9 +27,10 @@ import {
import DMRoomMap from "../../../../../src/utils/DMRoomMap";
import { Action } from "../../../../../src/dispatcher/actions";
import { type ButtonEvent } from "../../../../../src/components/views/elements/AccessibleButton";
import { SDKContext, SdkContextClass } from "../../../../../src/contexts/SDKContext";
import { SDKContext } from "../../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../../src/contexts/SDKContextClass";
import { MatrixClientPeg } from "../../../../../src/MatrixClientPeg.ts";
import { TestSdkContext } from "../../../TestSdkContext.ts";
import { TestSDKContext } from "../../../TestSDKContext.ts";
describe("<Pill>", () => {
let client: Mocked<MatrixClient>;
@@ -50,7 +51,7 @@ describe("<Pill>", () => {
const renderPill = (props: PillProps): void => {
const cli = MatrixClientPeg.safeGet();
const mockSdkContext = new TestSdkContext();
const mockSdkContext = new TestSDKContext();
mockSdkContext.client = cli;
const withDefault = {
@@ -78,7 +79,7 @@ describe("<Pill>", () => {
beforeEach(() => {
client = mocked(stubClient());
SdkContextClass.instance.client = client;
SDKContextClass.instance.client = client;
DMRoomMap.makeShared(client);
room1 = new Room(room1Id, client, user1Id);
room1.name = "Room 1";
@@ -16,7 +16,7 @@ import type { MediaEventHelper } from "../../../../../src/utils/MediaEventHelper
import MVoiceMessageBody from "../../../../../src/components/views/messages/MVoiceMessageBody";
import { PlaybackQueue } from "../../../../../src/audio/PlaybackQueue";
import { createTestClient } from "../../../../test-utils";
import { SdkContextClass } from "../../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../../src/contexts/SDKContextClass";
describe("<MVvoiceMessageBody />", () => {
let event: MatrixEvent;
@@ -26,7 +26,7 @@ describe("<MVvoiceMessageBody />", () => {
const matrixClient = createTestClient();
const room = new Room("!TESTROOM", matrixClient, "@alice:example.org");
const playbackQueue = new PlaybackQueue(room, SdkContextClass.instance.roomViewStore);
const playbackQueue = new PlaybackQueue(room, SDKContextClass.instance.roomViewStore);
jest.spyOn(PlaybackQueue, "forRoom").mockReturnValue(playbackQueue);
jest.spyOn(playbackQueue, "unsortedEnqueue").mockReturnValue(undefined);
@@ -15,21 +15,22 @@ import AppsDrawer from "../../../../../src/components/views/rooms/AppsDrawer";
import SdkConfig from "../../../../../src/SdkConfig";
import { WidgetLayoutStore } from "../../../../../src/stores/widgets/WidgetLayoutStore";
import MatrixClientContext from "../../../../../src/contexts/MatrixClientContext";
import { SDKContext, SdkContextClass } from "../../../../../src/contexts/SDKContext";
import { SDKContext } from "../../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../../src/contexts/SDKContextClass";
const ROOM_ID = "!room:id";
describe("AppsDrawer", () => {
let client: MatrixClient;
let room: Room;
let sdkContext: SdkContextClass;
let sdkContext: SDKContextClass;
beforeEach(async () => {
client = stubClient();
room = new Room(ROOM_ID, client, client.getUserId()!, {
pendingEventOrdering: PendingEventOrdering.Detached,
});
sdkContext = new SdkContextClass();
sdkContext = new SDKContextClass();
});
afterEach(() => {
@@ -18,7 +18,7 @@ import EditorModel from "../../../../../src/editor/model";
import { createPartCreator, createRenderer } from "../../../editor/mock";
import { CommandPartCreator } from "../../../../../src/editor/parts";
import DocumentOffset from "../../../../../src/editor/offset";
import { SdkContextClass } from "../../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../../src/contexts/SDKContextClass";
import SettingsStore from "../../../../../src/settings/SettingsStore";
describe("BasicMessageComposer", () => {
@@ -114,7 +114,7 @@ describe("BasicMessageComposer", () => {
const model = new EditorModel([commandPart], commandPc, renderer);
// spy on typingStore.setSelfTyping
const spy = jest.spyOn(SdkContextClass.instance.typingStore, "setSelfTyping");
const spy = jest.spyOn(SDKContextClass.instance.typingStore, "setSelfTyping");
render(<BasicMessageComposer model={model} room={room} />);
@@ -20,7 +20,7 @@ import RightPanelStore from "../../../../../src/stores/right-panel/RightPanelSto
import { RightPanelPhases } from "../../../../../src/stores/right-panel/RightPanelStorePhases";
import { UPDATE_EVENT } from "../../../../../src/stores/AsyncStore";
import { Action } from "../../../../../src/dispatcher/actions";
import { SdkContextClass } from "../../../../../src/contexts/SDKContext.ts";
import { SDKContextClass } from "../../../../../src/contexts/SDKContextClass";
describe("<PinnedMessageBanner />", () => {
const userId = "@alice:server.org";
@@ -29,12 +29,12 @@ describe("<PinnedMessageBanner />", () => {
let mockClient: MatrixClient;
let room: Room;
let permalinkCreator: RoomPermalinkCreator;
let sdkContext: SdkContextClass;
let sdkContext: SDKContextClass;
beforeEach(() => {
mockClient = stubClient();
room = new Room(roomId, mockClient, userId);
permalinkCreator = new RoomPermalinkCreator(room);
sdkContext = new SdkContextClass();
sdkContext = new SDKContextClass();
jest.spyOn(dis, "dispatch").mockReturnValue(undefined);
});
@@ -11,7 +11,8 @@ import { fireEvent, getByLabelText, getByText, render, screen, waitFor } from "j
import { type EventTimeline, JoinRule, Room } from "matrix-js-sdk/src/matrix";
import { KnownMembership } from "matrix-js-sdk/src/types";
import { SDKContext, SdkContextClass } from "../../../../../../src/contexts/SDKContext";
import { SDKContext } from "../../../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../../../src/contexts/SDKContextClass";
import { getMockClientWithEventEmitter, mockClientMethodsUser } from "../../../../../test-utils";
import {
CallGuestLinkButton,
@@ -25,7 +26,7 @@ import SettingsStore from "../../../../../../src/settings/SettingsStore";
describe("<CallGuestLinkButton />", () => {
const roomId = "!room:server.org";
let sdkContext!: SdkContextClass;
let sdkContext!: SDKContextClass;
let modalSpy: jest.SpyInstance;
let modalResolve: (value: unknown[] | PromiseLike<unknown[]>) => void;
let room: Room;
@@ -77,7 +78,7 @@ describe("<CallGuestLinkButton />", () => {
...mockClientMethodsUser(),
sendStateEvent: jest.fn(),
});
sdkContext = new SdkContextClass();
sdkContext = new SDKContextClass();
sdkContext.client = client;
const modalPromise = new Promise<unknown[]>((resolve) => {
modalResolve = resolve;
@@ -93,7 +94,7 @@ describe("<CallGuestLinkButton />", () => {
return oldGet(key);
});
jest.spyOn(room, "hasEncryptionStateEvent").mockReturnValue(true);
jest.spyOn(SdkContextClass.instance.roomViewStore, "isViewingCall").mockReturnValue(true);
jest.spyOn(SDKContextClass.instance.roomViewStore, "isViewingCall").mockReturnValue(true);
});
afterEach(() => {
jest.restoreAllMocks();
@@ -151,7 +152,7 @@ describe("<CallGuestLinkButton />", () => {
it("don't show external conference button if now guest spa link is configured", () => {
jest.spyOn(room, "getJoinRule").mockReturnValue(JoinRule.Public);
jest.spyOn(SdkContextClass.instance.roomViewStore, "isViewingCall").mockReturnValue(true);
jest.spyOn(SDKContextClass.instance.roomViewStore, "isViewingCall").mockReturnValue(true);
jest.spyOn(SdkConfig, "get").mockImplementation((key) => {
if (key === "element_call") {
@@ -178,7 +179,7 @@ describe("<CallGuestLinkButton />", () => {
it("opens the share dialog with the correct share link in an encrypted room", () => {
jest.spyOn(room, "getJoinRule").mockReturnValue(JoinRule.Public);
jest.spyOn(SdkContextClass.instance.roomViewStore, "isViewingCall").mockReturnValue(true);
jest.spyOn(SDKContextClass.instance.roomViewStore, "isViewingCall").mockReturnValue(true);
getComponent(room);
const modalSpy = jest.spyOn(Modal, "createDialog");
@@ -200,7 +201,7 @@ describe("<CallGuestLinkButton />", () => {
it("share dialog has correct link in an unencrypted room", () => {
jest.spyOn(room, "getJoinRule").mockReturnValue(JoinRule.Public);
jest.spyOn(room, "hasEncryptionStateEvent").mockReturnValue(false);
jest.spyOn(SdkContextClass.instance.roomViewStore, "isViewingCall").mockReturnValue(true);
jest.spyOn(SDKContextClass.instance.roomViewStore, "isViewingCall").mockReturnValue(true);
getComponent(room);
const modalSpy = jest.spyOn(Modal, "createDialog");
@@ -12,7 +12,8 @@ import { Room } from "matrix-js-sdk/src/matrix";
import { fireEvent, render, screen, waitFor } from "jest-matrix-react";
import { VideoRoomChatButton } from "../../../../../../src/components/views/rooms/RoomHeader/VideoRoomChatButton";
import { SDKContext, SdkContextClass } from "../../../../../../src/contexts/SDKContext";
import { SDKContext } from "../../../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../../../src/contexts/SDKContextClass";
import type RightPanelStore from "../../../../../../src/stores/right-panel/RightPanelStore";
import { getMockClientWithEventEmitter, mockClientMethodsUser } from "../../../../../test-utils";
import { RoomNotificationState } from "../../../../../../src/stores/notifications/RoomNotificationState";
@@ -22,7 +23,7 @@ import { RightPanelPhases } from "../../../../../../src/stores/right-panel/Right
describe("<VideoRoomChatButton />", () => {
const roomId = "!room:server.org";
let sdkContext!: SdkContextClass;
let sdkContext!: SDKContextClass;
let rightPanelStore!: MockedObject<RightPanelStore>;
/**
@@ -58,7 +59,7 @@ describe("<VideoRoomChatButton />", () => {
rightPanelStore = {
showOrHidePhase: jest.fn(),
} as unknown as MockedObject<RightPanelStore>;
sdkContext = new SdkContextClass();
sdkContext = new SDKContextClass();
sdkContext.client = client;
jest.spyOn(sdkContext, "rightPanelStore", "get").mockReturnValue(rightPanelStore);
});
@@ -38,7 +38,7 @@ import DMRoomMap from "../../../../../src/utils/DMRoomMap";
import PlatformPeg from "../../../../../src/PlatformPeg";
import type BasePlatform from "../../../../../src/BasePlatform";
import { WidgetMessagingStore } from "../../../../../src/stores/widgets/WidgetMessagingStore";
import { TestSdkContext } from "../../../TestSdkContext";
import { TestSDKContext } from "../../../TestSDKContext";
import { SDKContext } from "../../../../../src/contexts/SDKContext";
import { shouldShowComponent } from "../../../../../src/customisations/helpers/UIComponents";
import { UIComponent } from "../../../../../src/settings/UIFeature";
@@ -73,7 +73,7 @@ describe("RoomTile", () => {
let client: Mocked<MatrixClient>;
let room: Room;
let sdkContext: TestSdkContext;
let sdkContext: TestSDKContext;
let showMessagePreview = false;
filterConsole(
@@ -114,7 +114,7 @@ describe("RoomTile", () => {
beforeEach(() => {
useMockMediaDevices();
sdkContext = new TestSdkContext();
sdkContext = new TestSDKContext();
client = mocked(stubClient());
sdkContext.client = client;
@@ -30,7 +30,7 @@ import { mockPlatformPeg } from "../../../../test-utils/platform";
import { doMaybeLocalRoomAction } from "../../../../../src/utils/local-room";
import { addTextToComposer } from "../../../../test-utils/composer";
import { ScopedRoomContextProvider } from "../../../../../src/contexts/ScopedRoomContext.tsx";
import { SdkContextClass } from "../../../../../src/contexts/SDKContext.ts";
import { SDKContextClass } from "../../../../../src/contexts/SDKContextClass";
import { RoomUploadContextProvider } from "../../../../../src/viewmodels/room/RoomUploadViewModel.tsx";
jest.mock("../../../../../src/utils/local-room", () => ({
@@ -39,7 +39,7 @@ jest.mock("../../../../../src/utils/local-room", () => ({
describe("<SendMessageComposer/>", () => {
const defaultRoomContext: RoomContextType = {
roomViewStore: SdkContextClass.instance.roomViewStore,
roomViewStore: SDKContextClass.instance.roomViewStore,
roomLoading: true,
peekLoading: false,
shouldPeek: true,
@@ -26,7 +26,7 @@ import { KnownMembership } from "matrix-js-sdk/src/types";
import { MatrixClientPeg } from "../../../../../../src/MatrixClientPeg";
import * as TestUtils from "../../../../../test-utils";
import { SDKContext } from "../../../../../../src/contexts/SDKContext";
import { TestSdkContext } from "../../../../TestSdkContext";
import { TestSDKContext } from "../../../../TestSDKContext";
import MemberListView from "../../../../../../src/components/views/rooms/MemberList/MemberListView";
import MatrixClientContext from "../../../../../../src/contexts/MatrixClientContext";
@@ -121,7 +121,7 @@ export async function renderMemberList(
memberListRoom.currentState.members[member.userId] = member;
}
const context = new TestSdkContext();
const context = new TestSDKContext();
context.client = client;
context.memberListStore.isPresenceEnabled = jest.fn().mockReturnValue(enablePresence);
const root = render(
@@ -15,7 +15,8 @@ import { type MockedObject } from "jest-mock-vitest-adapter";
import { ToastContext, ToastRack } from "@element-hq/web-shared-components";
import AccountUserSettingsTab from "../../../../../../../src/components/views/settings/tabs/user/AccountUserSettingsTab";
import { SdkContextClass, SDKContext } from "../../../../../../../src/contexts/SDKContext";
import { SDKContext } from "../../../../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../../../../src/contexts/SDKContextClass";
import SettingsStore from "../../../../../../../src/settings/SettingsStore";
import {
getMockClientWithEventEmitter,
@@ -50,7 +51,7 @@ describe("<AccountUserSettingsTab />", () => {
const userId = "@alice:server.org";
let mockClient: MockedObject<MatrixClient>;
let stores: SdkContextClass;
let stores: SDKContextClass;
const getComponent = () => (
<MatrixClientContext.Provider value={mockClient}>
@@ -86,7 +87,7 @@ describe("<AccountUserSettingsTab />", () => {
id_server_unbind_result: "success",
});
stores = new SdkContextClass();
stores = new SDKContextClass();
stores.client = mockClient;
// stub out this store completely to avoid mocking initialisation
const mockOidcClientStore = {} as unknown as OidcClientStore;
@@ -19,7 +19,8 @@ import {
mockClientMethodsDevice,
mockPlatformPeg,
} from "../../../../../../test-utils";
import { SDKContext, SdkContextClass } from "../../../../../../../src/contexts/SDKContext";
import { SDKContext } from "../../../../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../../../../src/contexts/SDKContextClass";
import defaultDispatcher from "../../../../../../../src/dispatcher/dispatcher";
import { UIFeature } from "../../../../../../../src/settings/UIFeature";
import SettingsStore from "../../../../../../../src/settings/SettingsStore";
@@ -41,7 +42,7 @@ describe("<SecurityUserSettingsTab />", () => {
setIgnoredUsers,
});
const sdkContext = new SdkContextClass();
const sdkContext = new SDKContextClass();
sdkContext.client = mockClient;
const getComponent = () => (
@@ -56,7 +56,8 @@ import {
import { INACTIVE_DEVICE_AGE_MS } from "../../../../../../../src/components/views/settings/devices/filter";
import SettingsStore from "../../../../../../../src/settings/SettingsStore";
import { getClientInformationEventType } from "../../../../../../../src/utils/device/clientInformation";
import { SDKContext, SdkContextClass } from "../../../../../../../src/contexts/SDKContext";
import { SDKContext } from "../../../../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../../../../src/contexts/SDKContextClass";
import { type OidcClientStore } from "../../../../../../../src/stores/oidc/OidcClientStore";
import { makeDelegatedAuthConfig } from "../../../../../../test-utils/oidc";
import MatrixClientContext from "../../../../../../../src/contexts/MatrixClientContext";
@@ -133,7 +134,7 @@ describe("<SessionManagerTab />", () => {
} as unknown as CryptoApi);
let mockClient!: MockedObject<MatrixClient>;
let sdkContext: SdkContextClass;
let sdkContext: SDKContextClass;
const defaultProps = {};
const getComponent = (props = {}): React.ReactElement => (
@@ -249,7 +250,7 @@ describe("<SessionManagerTab />", () => {
}
});
sdkContext = new SdkContextClass();
sdkContext = new SDKContextClass();
sdkContext.client = mockClient;
// @ts-ignore allow delete of non-optional prop
@@ -13,7 +13,7 @@ import { mocked } from "jest-mock";
import QuickSettingsButton from "../../../../../src/components/views/spaces/QuickSettingsButton";
import SettingsStore from "../../../../../src/settings/SettingsStore";
import { SdkContextClass } from "../../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../../src/contexts/SDKContextClass";
describe("QuickSettingsButton", () => {
const roomId = "!room:example.com";
@@ -72,11 +72,11 @@ describe("QuickSettingsButton", () => {
describe("and a room is viewed", () => {
beforeEach(() => {
jest.spyOn(SdkContextClass.instance.roomViewStore, "getRoomId").mockReturnValue(roomId);
jest.spyOn(SDKContextClass.instance.roomViewStore, "getRoomId").mockReturnValue(roomId);
});
afterEach(() => {
mocked(SdkContextClass.instance.roomViewStore.getRoomId).mockRestore();
mocked(SDKContextClass.instance.roomViewStore.getRoomId).mockRestore();
});
describe("and the quick settings are open", () => {
@@ -17,7 +17,7 @@ import { MetaSpace, type SpaceKey } from "../../../../../src/stores/spaces";
import { shouldShowComponent } from "../../../../../src/customisations/helpers/UIComponents";
import { UIComponent } from "../../../../../src/settings/UIFeature";
import { mkStubRoom, wrapInMatrixClientContext, wrapInSdkContext } from "../../../../test-utils";
import { SdkContextClass } from "../../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../../src/contexts/SDKContextClass";
import SpaceStore from "../../../../../src/stores/spaces/SpaceStore";
import DMRoomMap from "../../../../../src/utils/DMRoomMap";
import { type SpaceNotificationState } from "../../../../../src/stores/notifications/SpaceNotificationState";
@@ -124,12 +124,12 @@ describe("<SpacePanel />", () => {
isVersionSupported: jest.fn().mockResolvedValue(true),
doesServerSupportUnstableFeature: jest.fn().mockResolvedValue(false),
} as unknown as MatrixClient;
const SpacePanel = wrapInSdkContext(wrapInMatrixClientContext(UnwrappedSpacePanel), SdkContextClass.instance);
const SpacePanel = wrapInSdkContext(wrapInMatrixClientContext(UnwrappedSpacePanel), SDKContextClass.instance);
beforeAll(() => {
jest.spyOn(MatrixClientPeg, "get").mockReturnValue(mockClient);
jest.spyOn(MatrixClientPeg, "safeGet").mockReturnValue(mockClient);
SdkContextClass.instance.client = mockClient;
SDKContextClass.instance.client = mockClient;
});
beforeEach(() => {
@@ -16,17 +16,18 @@ import { mkStubRoom, stubClient } from "../../../../test-utils";
import DMRoomMap from "../../../../../src/utils/DMRoomMap";
import { MatrixClientPeg } from "../../../../../src/MatrixClientPeg";
import LegacyCallHandler from "../../../../../src/LegacyCallHandler";
import { SDKContext, SdkContextClass } from "../../../../../src/contexts/SDKContext";
import { SDKContext } from "../../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../../src/contexts/SDKContextClass";
jest.mock("../../../../../src/components/views/voip/LegacyCallView", () => jest.fn(() => "LegacyCallView"));
describe("LegacyCallViewForRoom", () => {
const LegacyCallViewMock = LegacyCallView as unknown as jest.Mock;
let sdkContext: SdkContextClass;
let sdkContext: SDKContextClass;
beforeEach(() => {
stubClient();
sdkContext = new SdkContextClass();
sdkContext = new SDKContextClass();
LegacyCallViewMock.mockClear();
});
@@ -8,13 +8,13 @@ Please see LICENSE files in the repository root for full details.
import { type MatrixClient } from "matrix-js-sdk/src/matrix";
import { SdkContextClass } from "../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../src/contexts/SDKContextClass";
import { OidcClientStore } from "../../../src/stores/oidc/OidcClientStore";
import { UserProfilesStore } from "../../../src/stores/UserProfilesStore";
import { createTestClient } from "../../test-utils";
describe("SdkContextClass", () => {
let sdkContext = SdkContextClass.instance;
describe("SDKContextClass", () => {
let sdkContext = SDKContextClass.instance;
let client: MatrixClient;
beforeAll(() => {
@@ -22,12 +22,12 @@ describe("SdkContextClass", () => {
});
beforeEach(() => {
sdkContext = new SdkContextClass();
sdkContext = new SDKContextClass();
});
it("instance should always return the same instance", () => {
const globalInstance = SdkContextClass.instance;
expect(SdkContextClass.instance).toBe(globalInstance);
const globalInstance = SDKContextClass.instance;
expect(SDKContextClass.instance).toBe(globalInstance);
});
it("userProfilesStore should raise an error without a client", () => {
@@ -22,7 +22,7 @@ import { ScopedRoomContextProvider } from "../../../src/contexts/ScopedRoomConte
import RoomContext, { type RoomContextType } from "../../../src/contexts/RoomContext";
import { MatrixClientContextProvider } from "../../../src/components/structures/MatrixClientContextProvider";
import type LegacyCallHandler from "../../../src/LegacyCallHandler";
import { SdkContextClass } from "../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../src/contexts/SDKContextClass";
import SettingsStore from "../../../src/settings/SettingsStore";
import { CallStore } from "../../../src/stores/CallStore";
@@ -59,7 +59,7 @@ describe("useRoomCall", () => {
on: jest.fn(),
off: jest.fn(),
};
jest.spyOn(SdkContextClass.instance, "legacyCallHandler", "get").mockReturnValue(
jest.spyOn(SDKContextClass.instance, "legacyCallHandler", "get").mockReturnValue(
callHandler as unknown as LegacyCallHandler,
);
const origGetValue = SettingsStore.getValue;
@@ -12,7 +12,8 @@ import { EventEmitter } from "events";
import { stubClient } from "../../test-utils";
import DMRoomMap from "../../../src/utils/DMRoomMap";
import { SDKContext, SdkContextClass } from "../../../src/contexts/SDKContext";
import { SDKContext } from "../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../src/contexts/SDKContextClass";
import { ScopedRoomContextProvider } from "../../../src/contexts/ScopedRoomContext";
import RoomContext, { type RoomContextType } from "../../../src/contexts/RoomContext";
import MatrixClientContext from "../../../src/contexts/MatrixClientContext";
@@ -21,7 +22,7 @@ import { ModuleApi } from "../../../src/modules/Api";
describe("ExtrasApi", () => {
let client: MatrixClient;
let sdkContext: SdkContextClass;
let sdkContext: SDKContextClass;
let room: Room;
let roomContext: RoomContextType;
@@ -30,7 +31,7 @@ describe("ExtrasApi", () => {
room = new Room("!test:room", client, "@alice:example.org", {
pendingEventOrdering: PendingEventOrdering.Detached,
});
sdkContext = new SdkContextClass();
sdkContext = new SDKContextClass();
sdkContext.client = client;
jest.spyOn(sdkContext.roomViewStore, "getRoomId").mockReturnValue(room.roomId);
@@ -11,7 +11,7 @@ import { mocked } from "jest-mock";
import { type Command } from "../../../src/slash-commands/command";
import { getCommand } from "../../../src/slash-commands/SlashCommands";
import { stubClient } from "../../test-utils";
import { SdkContextClass } from "../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../src/contexts/SDKContextClass";
import { LocalRoom } from "../../../src/models/LocalRoom";
export function setUpCommandTest(
@@ -40,7 +40,7 @@ export function setUpCommandTest(
room = new Room(roomId, client, client.getSafeUserId());
}
jest.spyOn(SdkContextClass.instance.roomViewStore, "getRoomId").mockReturnValue(roomId);
jest.spyOn(SDKContextClass.instance.roomViewStore, "getRoomId").mockReturnValue(roomId);
mocked(client.getRoom).mockImplementation((rId: string): Room | null => {
if (rId === roomId) {
@@ -14,7 +14,7 @@ import SdkConfig from "../../../src/SdkConfig";
import SettingsStore from "../../../src/settings/SettingsStore";
import { MemberListStore } from "../../../src/stores/MemberListStore";
import { stubClient } from "../../test-utils";
import { TestSdkContext } from "../TestSdkContext";
import { TestSDKContext } from "../TestSDKContext";
describe("MemberListStore", () => {
const alice = "@alice:bar";
@@ -26,7 +26,7 @@ describe("MemberListStore", () => {
let room: Room;
beforeEach(() => {
const context = new TestSdkContext();
const context = new TestSDKContext();
client = stubClient();
client.baseUrl = "https://invalid.base.url.here";
context.client = client;
@@ -9,14 +9,14 @@ import { MultiRoomViewStore } from "../../../src/stores/MultiRoomViewStore";
import { RoomViewStore } from "../../../src/stores/RoomViewStore";
import { Action } from "../../../src/dispatcher/actions";
import type { MatrixDispatcher } from "../../../src/dispatcher/dispatcher";
import { TestSdkContext } from "../TestSdkContext";
import { TestSDKContext } from "../TestSDKContext";
jest.mock("../../../src/stores/RoomViewStore");
describe("MultiRoomViewStore", () => {
let multiRoomViewStore: MultiRoomViewStore;
let mockDispatcher: MatrixDispatcher;
let mockSdkContext: TestSdkContext;
let mockSdkContext: TestSDKContext;
let mockRoomViewStore: jest.Mocked<RoomViewStore>;
beforeEach(() => {
@@ -30,7 +30,7 @@ describe("MultiRoomViewStore", () => {
} as unknown as MatrixDispatcher;
// Create mock SDK context
mockSdkContext = new TestSdkContext();
mockSdkContext = new TestSDKContext();
// Create mock RoomViewStore instance
mockRoomViewStore = {
@@ -35,7 +35,7 @@ import { MatrixDispatcher } from "../../../src/dispatcher/dispatcher";
import { UPDATE_EVENT } from "../../../src/stores/AsyncStore";
import { type ActiveRoomChangedPayload } from "../../../src/dispatcher/payloads/ActiveRoomChangedPayload";
import { SpaceStoreClass } from "../../../src/stores/spaces/SpaceStore";
import { TestSdkContext } from "../TestSdkContext";
import { TestSDKContext } from "../TestSDKContext";
import { type ViewRoomPayload } from "../../../src/dispatcher/payloads/ViewRoomPayload";
import Modal from "../../../src/Modal";
import ErrorDialog from "../../../src/components/views/dialogs/ErrorDialog";
@@ -175,7 +175,7 @@ describe("RoomViewStore", function () {
let roomViewStore: RoomViewStore;
let slidingSyncManager: SlidingSyncManager;
let dis: MatrixDispatcher;
let stores: TestSdkContext;
let stores: TestSDKContext;
beforeEach(function () {
jest.clearAllMocks();
@@ -192,7 +192,7 @@ describe("RoomViewStore", function () {
// Make the RVS to test
dis = new MatrixDispatcher();
slidingSyncManager = new MockSlidingSyncManager();
stores = new TestSdkContext();
stores = new TestSDKContext();
stores.client = mockClient;
stores._SlidingSyncManager = slidingSyncManager;
stores._PosthogAnalytics = new MockPosthogAnalytics();
@@ -11,7 +11,7 @@ import { type MatrixClient } from "matrix-js-sdk/src/matrix";
import TypingStore from "../../../src/stores/TypingStore";
import { LOCAL_ROOM_ID_PREFIX } from "../../../src/models/LocalRoom";
import SettingsStore from "../../../src/settings/SettingsStore";
import { TestSdkContext } from "../TestSdkContext";
import { TestSDKContext } from "../TestSDKContext";
jest.mock("../../../src/settings/SettingsStore", () => ({
getValue: jest.fn(),
@@ -29,7 +29,7 @@ describe("TypingStore", () => {
mockClient = {
sendTyping: jest.fn(),
} as unknown as MatrixClient;
const context = new TestSdkContext();
const context = new TestSDKContext();
context.client = mockClient;
typingStore = new TypingStore(context);
jest.spyOn(SettingsStore, "getValue").mockImplementation((name: string) => {
@@ -34,7 +34,7 @@ import {
WidgetLifecycle,
} from "@matrix-org/react-sdk-module-api/lib/lifecycles/WidgetLifecycle";
import { SdkContextClass } from "../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../src/contexts/SDKContextClass";
import { MatrixClientPeg } from "../../../../src/MatrixClientPeg";
import { ElementWidgetDriver } from "../../../../src/stores/widgets/ElementWidgetDriver";
import { mkEvent, stubClient } from "../../../test-utils";
@@ -428,7 +428,7 @@ describe("ElementWidgetDriver", () => {
});
it("reads related events from the current room", async () => {
jest.spyOn(SdkContextClass.instance.roomViewStore, "getRoomId").mockReturnValue("!this-room-id");
jest.spyOn(SDKContextClass.instance.roomViewStore, "getRoomId").mockReturnValue("!this-room-id");
client.relations.mockResolvedValue({
originalEvent: new MatrixEvent(),
@@ -38,7 +38,7 @@ import ActiveWidgetStore from "../../../../src/stores/ActiveWidgetStore";
import SettingsStore from "../../../../src/settings/SettingsStore";
import defaultDispatcher from "../../../../src/dispatcher/dispatcher";
import { Action } from "../../../../src/dispatcher/actions";
import { SdkContextClass } from "../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../src/contexts/SDKContextClass";
import { UPDATE_EVENT } from "../../../../src/stores/AsyncStore";
import { type IApp } from "../../../../src/utils/WidgetUtils-types";
import { ModalWidgetStore } from "../../../../src/stores/ModalWidgetStore";
@@ -397,7 +397,7 @@ describe("WidgetMessaging as an account widget", () => {
beforeEach(() => {
stubClient();
// I give up, getting the return type of spyOn right is hopeless
getRoomId = jest.spyOn(SdkContextClass.instance.roomViewStore, "getRoomId") as unknown as MockedFunction<
getRoomId = jest.spyOn(SDKContextClass.instance.roomViewStore, "getRoomId") as unknown as MockedFunction<
() => string | null
>;
getRoomId.mockReturnValue("!1:example.org");
@@ -430,7 +430,7 @@ describe("WidgetMessaging as an account widget", () => {
expect(messaging.setViewedRoomId).toHaveBeenCalledTimes(1);
expect(messaging.setViewedRoomId).toHaveBeenLastCalledWith("!1:example.org");
getRoomId.mockReturnValue("!2:example.org");
SdkContextClass.instance.roomViewStore.emit(UPDATE_EVENT);
SDKContextClass.instance.roomViewStore.emit(UPDATE_EVENT);
expect(messaging.setViewedRoomId).toHaveBeenCalledTimes(2);
expect(messaging.setViewedRoomId).toHaveBeenLastCalledWith("!2:example.org");
});
@@ -630,7 +630,7 @@ describe("WidgetMessaging action handling for stickerpicker", () => {
const client = mocked(stubClient());
room = mkRoom(client, "!1:example.org");
client.getRoom.mockImplementation((roomId) => (roomId === room.roomId ? room : null));
const getRoomId = jest.spyOn(SdkContextClass.instance.roomViewStore, "getRoomId") as unknown as MockedFunction<
const getRoomId = jest.spyOn(SDKContextClass.instance.roomViewStore, "getRoomId") as unknown as MockedFunction<
() => string | null
>;
getRoomId.mockReturnValue(room.roomId);
@@ -12,9 +12,9 @@ import { Widget, WidgetKind } from "matrix-widget-api";
import { OIDCState, WidgetPermissionStore } from "../../../../src/stores/widgets/WidgetPermissionStore";
import SettingsStore from "../../../../src/settings/SettingsStore";
import { TestSdkContext } from "../../TestSdkContext";
import { TestSDKContext } from "../../TestSDKContext";
import { type SettingLevel } from "../../../../src/settings/SettingLevel";
import { SdkContextClass } from "../../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../../src/contexts/SDKContextClass";
import { stubClient } from "../../../test-utils";
import { ElementWidgetDriver } from "../../../../src/stores/widgets/ElementWidgetDriver";
import { WidgetType } from "../../../../src/widgets/WidgetType.ts";
@@ -53,7 +53,7 @@ describe("WidgetPermissionStore", () => {
},
);
mockClient = stubClient();
const context = new TestSdkContext();
const context = new TestSDKContext();
context.client = mockClient;
widgetPermissionStore = new WidgetPermissionStore(context);
});
@@ -85,8 +85,8 @@ describe("WidgetPermissionStore", () => {
// check this is not the case for the entire account
expect(widgetPermissionStore.getOIDCState(w, WidgetKind.Account, roomId)).toEqual(OIDCState.Unknown);
});
it("is created once in SdkContextClass", () => {
const context = new SdkContextClass();
it("is created once in SDKContextClass", () => {
const context = new SDKContextClass();
const store = context.widgetPermissionStore;
expect(store).toBeDefined();
const store2 = context.widgetPermissionStore;
@@ -32,7 +32,7 @@ import HTMLExporter from "../../../../src/utils/exportUtils/HtmlExport";
import DMRoomMap from "../../../../src/utils/DMRoomMap";
import { mediaFromMxc } from "../../../../src/customisations/Media";
import SettingsStore from "../../../../src/settings/SettingsStore";
import { SdkContextClass } from "../../../../src/contexts/SDKContext.ts";
import { SDKContextClass } from "../../../../src/contexts/SDKContextClass";
jest.mock("jszip");
jest.mock("../../../../src/settings/SettingsStore");
@@ -111,7 +111,7 @@ describe("HTMLExport", () => {
jest.setSystemTime(REPEATABLE_DATE);
client = stubClient() as jest.Mocked<MatrixClient>;
SdkContextClass.instance.client = client;
SDKContextClass.instance.client = client;
DMRoomMap.makeShared(client);
room = new Room("!myroom:example.org", client, "@me:example.org");
@@ -16,7 +16,7 @@ import defaultDispatcher from "../../../src/dispatcher/dispatcher";
import { type ViewRoomPayload } from "../../../src/dispatcher/payloads/ViewRoomPayload";
import { Action } from "../../../src/dispatcher/actions";
import { leaveRoomBehaviour } from "../../../src/utils/leave-behaviour";
import { SdkContextClass } from "../../../src/contexts/SDKContext";
import { SDKContextClass } from "../../../src/contexts/SDKContextClass";
import DMRoomMap from "../../../src/utils/DMRoomMap";
import SpaceStore from "../../../src/stores/spaces/SpaceStore";
import { MetaSpace } from "../../../src/stores/spaces";
@@ -27,7 +27,7 @@ import { type Call } from "../../../src/models/Call";
import LegacyCallHandler from "../../../src/LegacyCallHandler";
describe("leaveRoomBehaviour", () => {
SdkContextClass.instance.constructEagerStores(); // Initialize RoomViewStore
SDKContextClass.instance.constructEagerStores(); // Initialize RoomViewStore
let client: Mocked<MatrixClient>;
let room: Mocked<Room>;