This seems to be causing a lot of weirdness, presumably because there's
another missing thing like in #135, but I don't know what it might be and
it feels like it might take a while to find. Backing these changes out
to fix develop while we sort it out.

Fixes https://github.com/element-hq/element-web/issues/28179
This commit is contained in:
David Baker 2024-10-10 15:08:43 +01:00 committed by GitHub
parent 4e5cf1b720
commit 3a59556749
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
30 changed files with 78 additions and 88 deletions

View file

@ -43,7 +43,6 @@ import { formatList } from "./utils/FormattingUtils";
import SdkConfig from "./SdkConfig"; import SdkConfig from "./SdkConfig";
import { Features } from "./settings/Settings"; import { Features } from "./settings/Settings";
import { setDeviceIsolationMode } from "./settings/controllers/DeviceIsolationModeController.ts"; import { setDeviceIsolationMode } from "./settings/controllers/DeviceIsolationModeController.ts";
import { ReadyWatchingStore } from "./stores/ReadyWatchingStore.ts";
export interface IMatrixClientCreds { export interface IMatrixClientCreds {
homeserverUrl: string; homeserverUrl: string;
@ -310,7 +309,6 @@ class MatrixClientPegClass implements IMatrixClientPeg {
MatrixActionCreators.start(this.matrixClient); MatrixActionCreators.start(this.matrixClient);
MatrixClientBackedSettingsHandler.matrixClient = this.matrixClient; MatrixClientBackedSettingsHandler.matrixClient = this.matrixClient;
MatrixClientBackedController.matrixClient = this.matrixClient; MatrixClientBackedController.matrixClient = this.matrixClient;
ReadyWatchingStore.matrixClient = this.matrixClient;
return opts; return opts;
} }

View file

@ -36,13 +36,8 @@ export abstract class AsyncStoreWithClient<T extends Object> extends AsyncStore<
})(dispatcher); })(dispatcher);
} }
protected async start(matrixClient: MatrixClient | null): Promise<void> { public async start(): Promise<void> {
await this.readyStore.start(matrixClient); await this.readyStore.start();
}
// XXX: This method is intended only for use in tests.
public async useUnitTestClient(cli: MatrixClient): Promise<void> {
await this.readyStore.useUnitTestClient(cli);
} }
public get matrixClient(): MatrixClient | null { public get matrixClient(): MatrixClient | null {

View file

@ -46,7 +46,9 @@ interface IState {
*/ */
export default class AutoRageshakeStore extends AsyncStoreWithClient<IState> { export default class AutoRageshakeStore extends AsyncStoreWithClient<IState> {
private static readonly internalInstance = (() => { private static readonly internalInstance = (() => {
return new AutoRageshakeStore(); const instance = new AutoRageshakeStore();
instance.start();
return instance;
})(); })();
private constructor() { private constructor() {

View file

@ -30,7 +30,9 @@ interface IState {
export class BreadcrumbsStore extends AsyncStoreWithClient<IState> { export class BreadcrumbsStore extends AsyncStoreWithClient<IState> {
private static readonly internalInstance = (() => { private static readonly internalInstance = (() => {
return new BreadcrumbsStore(); const instance = new BreadcrumbsStore();
instance.start();
return instance;
})(); })();
private waitingRooms: { roomId: string; addedTs: number }[] = []; private waitingRooms: { roomId: string; addedTs: number }[] = [];

View file

@ -31,6 +31,7 @@ export class CallStore extends AsyncStoreWithClient<{}> {
public static get instance(): CallStore { public static get instance(): CallStore {
if (!this._instance) { if (!this._instance) {
this._instance = new CallStore(); this._instance = new CallStore();
this._instance.start();
} }
return this._instance; return this._instance;
} }

View file

@ -24,6 +24,7 @@ interface IState {
export class ModalWidgetStore extends AsyncStoreWithClient<IState> { export class ModalWidgetStore extends AsyncStoreWithClient<IState> {
private static readonly internalInstance = (() => { private static readonly internalInstance = (() => {
const instance = new ModalWidgetStore(); const instance = new ModalWidgetStore();
instance.start();
return instance; return instance;
})(); })();
private modalInstance: IHandle<typeof ModalWidgetDialog> | null = null; private modalInstance: IHandle<typeof ModalWidgetDialog> | null = null;

View file

@ -87,6 +87,7 @@ const getLocallyCreatedBeaconEventIds = (): string[] => {
export class OwnBeaconStore extends AsyncStoreWithClient<OwnBeaconStoreState> { export class OwnBeaconStore extends AsyncStoreWithClient<OwnBeaconStoreState> {
private static readonly internalInstance = (() => { private static readonly internalInstance = (() => {
const instance = new OwnBeaconStore(); const instance = new OwnBeaconStore();
instance.start();
return instance; return instance;
})(); })();
// users beacons, keyed by event type // users beacons, keyed by event type

View file

@ -28,6 +28,7 @@ const KEY_AVATAR_URL = "mx_profile_avatar_url";
export class OwnProfileStore extends AsyncStoreWithClient<IState> { export class OwnProfileStore extends AsyncStoreWithClient<IState> {
private static readonly internalInstance = (() => { private static readonly internalInstance = (() => {
const instance = new OwnProfileStore(); const instance = new OwnProfileStore();
instance.start();
return instance; return instance;
})(); })();

View file

@ -9,42 +9,27 @@
import { MatrixClient, SyncState } from "matrix-js-sdk/src/matrix"; import { MatrixClient, SyncState } from "matrix-js-sdk/src/matrix";
import { EventEmitter } from "events"; import { EventEmitter } from "events";
import { MatrixClientPeg } from "../MatrixClientPeg";
import { ActionPayload } from "../dispatcher/payloads"; import { ActionPayload } from "../dispatcher/payloads";
import { IDestroyable } from "../utils/IDestroyable"; import { IDestroyable } from "../utils/IDestroyable";
import { Action } from "../dispatcher/actions"; import { Action } from "../dispatcher/actions";
import { MatrixDispatcher } from "../dispatcher/dispatcher"; import { MatrixDispatcher } from "../dispatcher/dispatcher";
export abstract class ReadyWatchingStore extends EventEmitter implements IDestroyable { export abstract class ReadyWatchingStore extends EventEmitter implements IDestroyable {
private static instances: ReadyWatchingStore[] = []; protected matrixClient: MatrixClient | null = null;
protected _matrixClient: MatrixClient | null = null;
private dispatcherRef: string | null = null; private dispatcherRef: string | null = null;
public static set matrixClient(client: MatrixClient) {
for (const instance of ReadyWatchingStore.instances) {
instance.start(client);
}
}
public constructor(protected readonly dispatcher: MatrixDispatcher) { public constructor(protected readonly dispatcher: MatrixDispatcher) {
super(); super();
}
public async start(): Promise<void> {
this.dispatcherRef = this.dispatcher.register(this.onAction); this.dispatcherRef = this.dispatcher.register(this.onAction);
ReadyWatchingStore.instances.push(this); // MatrixClientPeg can be undefined in tests because of circular dependencies with other stores
} const matrixClient = MatrixClientPeg?.get();
public get matrixClient(): MatrixClient | null {
return this._matrixClient;
}
public async start(matrixClient: MatrixClient | null): Promise<void> {
const oldClient = this._matrixClient;
this._matrixClient = matrixClient;
if (oldClient !== matrixClient) {
await this.onNotReady();
}
if (matrixClient) { if (matrixClient) {
this.matrixClient = matrixClient;
await this.onReady(); await this.onReady();
} }
} }
@ -53,10 +38,8 @@ export abstract class ReadyWatchingStore extends EventEmitter implements IDestro
return this.matrixClient; // for external readonly access return this.matrixClient; // for external readonly access
} }
// XXX: This method is intended only for use in tests. public useUnitTestClient(cli: MatrixClient): void {
public async useUnitTestClient(cli: MatrixClient): Promise<void> { this.matrixClient = cli;
this._matrixClient = cli;
await this.onReady();
} }
public destroy(): void { public destroy(): void {
@ -91,13 +74,13 @@ export abstract class ReadyWatchingStore extends EventEmitter implements IDestro
if (this.matrixClient) { if (this.matrixClient) {
await this.onNotReady(); await this.onNotReady();
} }
this._matrixClient = payload.matrixClient; this.matrixClient = payload.matrixClient;
await this.onReady(); await this.onReady();
} }
} else if (payload.action === "on_client_not_viable" || payload.action === Action.OnLoggedOut) { } else if (payload.action === "on_client_not_viable" || payload.action === Action.OnLoggedOut) {
if (this.matrixClient) { if (this.matrixClient) {
await this.onNotReady(); await this.onNotReady();
this._matrixClient = null; this.matrixClient = null;
} }
} }
}; };

View file

@ -30,6 +30,7 @@ export class VoiceRecordingStore extends AsyncStoreWithClient<IState> {
public static get instance(): VoiceRecordingStore { public static get instance(): VoiceRecordingStore {
if (!this.internalInstance) { if (!this.internalInstance) {
this.internalInstance = new VoiceRecordingStore(); this.internalInstance = new VoiceRecordingStore();
this.internalInstance.start();
} }
return this.internalInstance; return this.internalInstance;
} }

View file

@ -45,6 +45,7 @@ interface IRoomWidgets {
export default class WidgetStore extends AsyncStoreWithClient<IState> { export default class WidgetStore extends AsyncStoreWithClient<IState> {
private static readonly internalInstance = (() => { private static readonly internalInstance = (() => {
const instance = new WidgetStore(); const instance = new WidgetStore();
instance.start();
return instance; return instance;
})(); })();

View file

@ -38,6 +38,7 @@ export class EchoStore extends AsyncStoreWithClient<IState> {
public static get instance(): EchoStore { public static get instance(): EchoStore {
if (!this._instance) { if (!this._instance) {
this._instance = new EchoStore(); this._instance = new EchoStore();
this._instance.start();
} }
return this._instance; return this._instance;
} }

View file

@ -26,6 +26,7 @@ export const UPDATE_STATUS_INDICATOR = Symbol("update-status-indicator");
export class RoomNotificationStateStore extends AsyncStoreWithClient<IState> { export class RoomNotificationStateStore extends AsyncStoreWithClient<IState> {
private static readonly internalInstance = (() => { private static readonly internalInstance = (() => {
const instance = new RoomNotificationStateStore(); const instance = new RoomNotificationStateStore();
instance.start();
return instance; return instance;
})(); })();
private roomMap = new Map<Room, RoomNotificationState>(); private roomMap = new Map<Room, RoomNotificationState>();

View file

@ -403,6 +403,7 @@ export default class RightPanelStore extends ReadyWatchingStore {
public static get instance(): RightPanelStore { public static get instance(): RightPanelStore {
if (!this.internalInstance) { if (!this.internalInstance) {
this.internalInstance = new RightPanelStore(); this.internalInstance = new RightPanelStore();
this.internalInstance.start();
} }
return this.internalInstance; return this.internalInstance;
} }

View file

@ -124,7 +124,11 @@ const mkMessagePreview = (text: string, event: MatrixEvent): MessagePreview => {
}; };
export class MessagePreviewStore extends AsyncStoreWithClient<IState> { export class MessagePreviewStore extends AsyncStoreWithClient<IState> {
private static readonly internalInstance = (() => new MessagePreviewStore())(); private static readonly internalInstance = (() => {
const instance = new MessagePreviewStore();
instance.start();
return instance;
})();
/** /**
* @internal Public for test only * @internal Public for test only

View file

@ -28,6 +28,7 @@ export default class RoomListLayoutStore extends AsyncStoreWithClient<IState> {
public static get instance(): RoomListLayoutStore { public static get instance(): RoomListLayoutStore {
if (!this.internalInstance) { if (!this.internalInstance) {
this.internalInstance = new RoomListLayoutStore(); this.internalInstance = new RoomListLayoutStore();
this.internalInstance.start();
} }
return RoomListLayoutStore.internalInstance; return RoomListLayoutStore.internalInstance;
} }

View file

@ -643,9 +643,11 @@ export default class RoomListStore {
if (SettingsStore.getValue("feature_sliding_sync")) { if (SettingsStore.getValue("feature_sliding_sync")) {
logger.info("using SlidingRoomListStoreClass"); logger.info("using SlidingRoomListStoreClass");
const instance = new SlidingRoomListStoreClass(defaultDispatcher, SdkContextClass.instance); const instance = new SlidingRoomListStoreClass(defaultDispatcher, SdkContextClass.instance);
instance.start();
RoomListStore.internalInstance = instance; RoomListStore.internalInstance = instance;
} else { } else {
const instance = new RoomListStoreClass(defaultDispatcher); const instance = new RoomListStoreClass(defaultDispatcher);
instance.start();
RoomListStore.internalInstance = instance; RoomListStore.internalInstance = instance;
} }
} }

View file

@ -17,7 +17,6 @@ import {
MatrixEvent, MatrixEvent,
ClientEvent, ClientEvent,
ISendEventResponse, ISendEventResponse,
MatrixClient,
} from "matrix-js-sdk/src/matrix"; } from "matrix-js-sdk/src/matrix";
import { KnownMembership } from "matrix-js-sdk/src/types"; import { KnownMembership } from "matrix-js-sdk/src/types";
import { logger } from "matrix-js-sdk/src/logger"; import { logger } from "matrix-js-sdk/src/logger";
@ -1398,6 +1397,7 @@ export class SpaceStoreClass extends AsyncStoreWithClient<IState> {
export default class SpaceStore { export default class SpaceStore {
private static readonly internalInstance = (() => { private static readonly internalInstance = (() => {
const instance = new SpaceStoreClass(); const instance = new SpaceStoreClass();
instance.start();
return instance; return instance;
})(); })();
@ -1408,9 +1408,9 @@ export default class SpaceStore {
/** /**
* @internal for test only * @internal for test only
*/ */
public static testInstance(client: MatrixClient): SpaceStoreClass { public static testInstance(): SpaceStoreClass {
const store = new SpaceStoreClass(); const store = new SpaceStoreClass();
store.useUnitTestClient(client); store.start();
return store; return store;
} }
} }

View file

@ -60,6 +60,7 @@ export class WidgetLayoutStore extends ReadyWatchingStore {
public static get instance(): WidgetLayoutStore { public static get instance(): WidgetLayoutStore {
if (!this.internalInstance) { if (!this.internalInstance) {
this.internalInstance = new WidgetLayoutStore(); this.internalInstance = new WidgetLayoutStore();
this.internalInstance.start();
} }
return this.internalInstance; return this.internalInstance;
} }

View file

@ -27,6 +27,7 @@ export enum WidgetMessagingStoreEvent {
export class WidgetMessagingStore extends AsyncStoreWithClient<{}> { export class WidgetMessagingStore extends AsyncStoreWithClient<{}> {
private static readonly internalInstance = (() => { private static readonly internalInstance = (() => {
const instance = new WidgetMessagingStore(); const instance = new WidgetMessagingStore();
instance.start();
return instance; return instance;
})(); })();

View file

@ -6,8 +6,8 @@ SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
Please see LICENSE files in the repository root for full details. Please see LICENSE files in the repository root for full details.
*/ */
import * as MatrixJs from "matrix-js-sdk/src/matrix";
import { logger } from "matrix-js-sdk/src/logger"; import { logger } from "matrix-js-sdk/src/logger";
import fetchMockJest from "fetch-mock-jest";
import { advanceDateAndTime, stubClient } from "./test-utils"; import { advanceDateAndTime, stubClient } from "./test-utils";
import { IMatrixClientPeg, MatrixClientPeg as peg } from "../src/MatrixClientPeg"; import { IMatrixClientPeg, MatrixClientPeg as peg } from "../src/MatrixClientPeg";
@ -19,14 +19,9 @@ jest.useFakeTimers();
const PegClass = Object.getPrototypeOf(peg).constructor; const PegClass = Object.getPrototypeOf(peg).constructor;
describe("MatrixClientPeg", () => { describe("MatrixClientPeg", () => {
let mockClient: MatrixJs.MatrixClient;
beforeEach(() => { beforeEach(() => {
// stub out Logger.log which gets called a lot and clutters up the test output // stub out Logger.log which gets called a lot and clutters up the test output
jest.spyOn(logger, "log").mockImplementation(() => {}); jest.spyOn(logger, "log").mockImplementation(() => {});
mockClient = stubClient();
jest.spyOn(MatrixJs, "createClient").mockReturnValue(mockClient);
}); });
afterEach(() => { afterEach(() => {
@ -38,6 +33,7 @@ describe("MatrixClientPeg", () => {
}); });
it("setJustRegisteredUserId", () => { it("setJustRegisteredUserId", () => {
stubClient();
(peg as any).matrixClient = peg.get(); (peg as any).matrixClient = peg.get();
peg.setJustRegisteredUserId("@userId:matrix.org"); peg.setJustRegisteredUserId("@userId:matrix.org");
expect(peg.safeGet().credentials.userId).toBe("@userId:matrix.org"); expect(peg.safeGet().credentials.userId).toBe("@userId:matrix.org");
@ -56,6 +52,7 @@ describe("MatrixClientPeg", () => {
}); });
it("setJustRegisteredUserId(null)", () => { it("setJustRegisteredUserId(null)", () => {
stubClient();
(peg as any).matrixClient = peg.get(); (peg as any).matrixClient = peg.get();
peg.setJustRegisteredUserId(null); peg.setJustRegisteredUserId(null);
expect(peg.currentUserIsJustRegistered()).toBe(false); expect(peg.currentUserIsJustRegistered()).toBe(false);
@ -74,6 +71,7 @@ describe("MatrixClientPeg", () => {
beforeEach(() => { beforeEach(() => {
// instantiate a MatrixClientPegClass instance, with a new MatrixClient // instantiate a MatrixClientPegClass instance, with a new MatrixClient
testPeg = new PegClass(); testPeg = new PegClass();
fetchMockJest.get("http://example.com/_matrix/client/versions", {});
testPeg.replaceUsingCreds({ testPeg.replaceUsingCreds({
accessToken: "SEKRET", accessToken: "SEKRET",
homeserverUrl: "http://example.com", homeserverUrl: "http://example.com",
@ -85,10 +83,13 @@ describe("MatrixClientPeg", () => {
it("should initialise the rust crypto library by default", async () => { it("should initialise the rust crypto library by default", async () => {
const mockSetValue = jest.spyOn(SettingsStore, "setValue").mockResolvedValue(undefined); const mockSetValue = jest.spyOn(SettingsStore, "setValue").mockResolvedValue(undefined);
const mockInitCrypto = jest.spyOn(testPeg.safeGet(), "initCrypto").mockResolvedValue(undefined);
const mockInitRustCrypto = jest.spyOn(testPeg.safeGet(), "initRustCrypto").mockResolvedValue(undefined);
const cryptoStoreKey = new Uint8Array([1, 2, 3, 4]); const cryptoStoreKey = new Uint8Array([1, 2, 3, 4]);
await testPeg.start({ rustCryptoStoreKey: cryptoStoreKey }); await testPeg.start({ rustCryptoStoreKey: cryptoStoreKey });
expect(mockClient.initCrypto).not.toHaveBeenCalled(); expect(mockInitCrypto).not.toHaveBeenCalled();
expect(mockClient.initRustCrypto).toHaveBeenCalledWith({ storageKey: cryptoStoreKey }); expect(mockInitRustCrypto).toHaveBeenCalledWith({ storageKey: cryptoStoreKey });
// we should have stashed the setting in the settings store // we should have stashed the setting in the settings store
expect(mockSetValue).toHaveBeenCalledWith("feature_rust_crypto", null, SettingLevel.DEVICE, true); expect(mockSetValue).toHaveBeenCalledWith("feature_rust_crypto", null, SettingLevel.DEVICE, true);
@ -96,9 +97,10 @@ describe("MatrixClientPeg", () => {
it("Should migrate existing login", async () => { it("Should migrate existing login", async () => {
const mockSetValue = jest.spyOn(SettingsStore, "setValue").mockResolvedValue(undefined); const mockSetValue = jest.spyOn(SettingsStore, "setValue").mockResolvedValue(undefined);
const mockInitRustCrypto = jest.spyOn(testPeg.safeGet(), "initRustCrypto").mockResolvedValue(undefined);
await testPeg.start(); await testPeg.start();
expect(mockClient.initRustCrypto).toHaveBeenCalledTimes(1); expect(mockInitRustCrypto).toHaveBeenCalledTimes(1);
// we should have stashed the setting in the settings store // we should have stashed the setting in the settings store
expect(mockSetValue).toHaveBeenCalledWith("feature_rust_crypto", null, SettingLevel.DEVICE, true); expect(mockSetValue).toHaveBeenCalledWith("feature_rust_crypto", null, SettingLevel.DEVICE, true);

View file

@ -47,7 +47,7 @@ describe("AutoRageshakeStore", () => {
// @ts-ignore bypass private ctor for tests // @ts-ignore bypass private ctor for tests
autoRageshakeStore = new AutoRageshakeStore(); autoRageshakeStore = new AutoRageshakeStore();
autoRageshakeStore.useUnitTestClient(client); autoRageshakeStore.start();
utdEvent = mkEvent({ utdEvent = mkEvent({
event: true, event: true,

View file

@ -40,7 +40,7 @@ describe("OwnProfileStore", () => {
displayname: "Display Name", displayname: "Display Name",
avatar_url: "mxc://example.com/abc123", avatar_url: "mxc://example.com/abc123",
}); });
await ownProfileStore.useUnitTestClient(client); await ownProfileStore.start();
expect(onUpdate).toHaveBeenCalled(); expect(onUpdate).toHaveBeenCalled();
expect(ownProfileStore.displayName).toBe("Display Name"); expect(ownProfileStore.displayName).toBe("Display Name");
@ -54,7 +54,7 @@ describe("OwnProfileStore", () => {
errcode: "M_NOT_FOUND", errcode: "M_NOT_FOUND",
}), }),
); );
await ownProfileStore.useUnitTestClient(client); await ownProfileStore.start();
expect(onUpdate).toHaveBeenCalled(); expect(onUpdate).toHaveBeenCalled();
expect(ownProfileStore.displayName).toBe(client.getSafeUserId()); expect(ownProfileStore.displayName).toBe(client.getSafeUserId());
@ -69,7 +69,7 @@ describe("OwnProfileStore", () => {
}), }),
); );
try { try {
await ownProfileStore.useUnitTestClient(client); await ownProfileStore.start();
} catch (ignore) {} } catch (ignore) {}
expect(onUpdate).not.toHaveBeenCalled(); expect(onUpdate).not.toHaveBeenCalled();

View file

@ -1428,7 +1428,7 @@ describe("SpaceStore", () => {
it("passes that value in calls to getVisibleRooms during getSpaceFilteredRoomIds", () => { it("passes that value in calls to getVisibleRooms during getSpaceFilteredRoomIds", () => {
// Given a store // Given a store
const store = SpaceStore.testInstance(client); const store = SpaceStore.testInstance();
// When we ask for filtered room ids // When we ask for filtered room ids
store.getSpaceFilteredRoomIds(MetaSpace.Home); store.getSpaceFilteredRoomIds(MetaSpace.Home);
@ -1478,7 +1478,7 @@ describe("SpaceStore", () => {
it("passes that value in calls to getVisibleRooms during getSpaceFilteredRoomIds", () => { it("passes that value in calls to getVisibleRooms during getSpaceFilteredRoomIds", () => {
// Given a store // Given a store
const store = SpaceStore.testInstance(client); const store = SpaceStore.testInstance();
// When we ask for filtered room ids // When we ask for filtered room ids
store.getSpaceFilteredRoomIds(MetaSpace.Home); store.getSpaceFilteredRoomIds(MetaSpace.Home);

View file

@ -31,7 +31,7 @@ describe("VoiceRecordingStore", () => {
const mkStore = (): VoiceRecordingStore => { const mkStore = (): VoiceRecordingStore => {
const store = new VoiceRecordingStore(); const store = new VoiceRecordingStore();
store.useUnitTestClient(stubClient); store.start();
return store; return store;
}; };

View file

@ -167,7 +167,7 @@ describe("WidgetLayoutStore", () => {
it("should recalculate all rooms when the client is ready", async () => { it("should recalculate all rooms when the client is ready", async () => {
mocked(client.getVisibleRooms).mockReturnValue([mockRoom]); mocked(client.getVisibleRooms).mockReturnValue([mockRoom]);
await store.start(client); await store.start();
expect(roomUpdateListener).toHaveBeenCalled(); expect(roomUpdateListener).toHaveBeenCalled();
expect(store.getContainerWidgets(mockRoom, Container.Top)).toEqual([]); expect(store.getContainerWidgets(mockRoom, Container.Top)).toEqual([]);
@ -243,7 +243,7 @@ describe("WidgetLayoutStore", () => {
}); });
it("should copy the layout to the room", async () => { it("should copy the layout to the room", async () => {
await store.start(client); await store.start();
store.recalculateRoom(mockRoom); store.recalculateRoom(mockRoom);
store.moveToContainer(mockRoom, mockApps[0], Container.Top); store.moveToContainer(mockRoom, mockApps[0], Container.Top);
store.copyLayoutToRoom(mockRoom); store.copyLayoutToRoom(mockRoom);
@ -297,7 +297,7 @@ describe("WidgetLayoutStore", () => {
mocked(client.getVisibleRooms).mockReturnValue([]); mocked(client.getVisibleRooms).mockReturnValue([]);
// @ts-ignore bypass private ctor for tests // @ts-ignore bypass private ctor for tests
const store = new WidgetLayoutStore(); const store = new WidgetLayoutStore();
await store.start(client); await store.start();
expect(client.getVisibleRooms).toHaveBeenCalledWith(false); expect(client.getVisibleRooms).toHaveBeenCalledWith(false);
}); });
}); });
@ -314,7 +314,7 @@ describe("WidgetLayoutStore", () => {
mocked(client.getVisibleRooms).mockReturnValue([]); mocked(client.getVisibleRooms).mockReturnValue([]);
// @ts-ignore bypass private ctor for tests // @ts-ignore bypass private ctor for tests
const store = new WidgetLayoutStore(); const store = new WidgetLayoutStore();
await store.start(client); await store.start();
expect(client.getVisibleRooms).toHaveBeenCalledWith(true); expect(client.getVisibleRooms).toHaveBeenCalledWith(true);
}); });
}); });

View file

@ -80,7 +80,7 @@ describe("MessagePreviewStore", () => {
mocked(client.getRoom).mockReturnValue(room); mocked(client.getRoom).mockReturnValue(room);
store = MessagePreviewStore.testInstance(); store = MessagePreviewStore.testInstance();
await store.useUnitTestClient(client); await store.start();
await setupAsyncStoreWithClient(store, client); await setupAsyncStoreWithClient(store, client);
}); });

View file

@ -29,9 +29,6 @@ import DMRoomMap from "../../../src/utils/DMRoomMap";
import { flushPromises, stubClient, upsertRoomStateEvents, mkRoom } from "../../test-utils"; import { flushPromises, stubClient, upsertRoomStateEvents, mkRoom } from "../../test-utils";
import { DEFAULT_PUSH_RULES, makePushRule } from "../../test-utils/pushRules"; import { DEFAULT_PUSH_RULES, makePushRule } from "../../test-utils/pushRules";
// Mock out the SpaceWatcher as it messes with the prefilterConditions
jest.mock("../../../src/stores/room-list/SpaceWatcher.ts");
describe("RoomListStore", () => { describe("RoomListStore", () => {
const client = stubClient(); const client = stubClient();
const newRoomId = "!roomid:example.com"; const newRoomId = "!roomid:example.com";
@ -94,10 +91,6 @@ describe("RoomListStore", () => {
await (RoomListStore.instance as RoomListStoreClass).makeReady(client); await (RoomListStore.instance as RoomListStoreClass).makeReady(client);
}); });
beforeEach(() => {
DMRoomMap.makeShared(client);
});
it.each(OrderedDefaultTagIDs)("defaults to importance ordering for %s=", (tagId) => { it.each(OrderedDefaultTagIDs)("defaults to importance ordering for %s=", (tagId) => {
expect(RoomListStore.instance.getTagSorting(tagId)).toBe(SortAlgorithm.Recent); expect(RoomListStore.instance.getTagSorting(tagId)).toBe(SortAlgorithm.Recent);
}); });
@ -109,11 +102,11 @@ describe("RoomListStore", () => {
function createStore(): { store: RoomListStoreClass; handleRoomUpdate: jest.Mock<any, any> } { function createStore(): { store: RoomListStoreClass; handleRoomUpdate: jest.Mock<any, any> } {
const fakeDispatcher = { register: jest.fn() } as unknown as MatrixDispatcher; const fakeDispatcher = { register: jest.fn() } as unknown as MatrixDispatcher;
const store = new RoomListStoreClass(fakeDispatcher); const store = new RoomListStoreClass(fakeDispatcher);
// @ts-ignore accessing private member to set client
store.readyStore.matrixClient = client;
const handleRoomUpdate = jest.fn(); const handleRoomUpdate = jest.fn();
// @ts-ignore accessing private member to mock it // @ts-ignore accessing private member to mock it
store.algorithm.handleRoomUpdate = handleRoomUpdate; store.algorithm.handleRoomUpdate = handleRoomUpdate;
// @ts-ignore accessing private member to set client
store.readyStore.useUnitTestClient(client);
return { store, handleRoomUpdate }; return { store, handleRoomUpdate };
} }
@ -164,6 +157,7 @@ describe("RoomListStore", () => {
room1.updateMyMembership(KnownMembership.Join); room1.updateMyMembership(KnownMembership.Join);
room2.updateMyMembership(KnownMembership.Join); room2.updateMyMembership(KnownMembership.Join);
room3.updateMyMembership(KnownMembership.Join); room3.updateMyMembership(KnownMembership.Join);
DMRoomMap.makeShared(client);
const { store } = createStore(); const { store } = createStore();
client.getVisibleRooms = jest.fn().mockReturnValue([room1, room2, room3]); client.getVisibleRooms = jest.fn().mockReturnValue([room1, room2, room3]);
@ -275,6 +269,7 @@ describe("RoomListStore", () => {
it("Passes the feature flag on to the client when asking for visible rooms", () => { it("Passes the feature flag on to the client when asking for visible rooms", () => {
// Given a store that we can ask for a room list // Given a store that we can ask for a room list
DMRoomMap.makeShared(client);
const { store } = createStore(); const { store } = createStore();
client.getVisibleRooms = jest.fn().mockReturnValue([]); client.getVisibleRooms = jest.fn().mockReturnValue([]);
@ -290,7 +285,7 @@ describe("RoomListStore", () => {
describe("room updates", () => { describe("room updates", () => {
const makeStore = async () => { const makeStore = async () => {
const store = new RoomListStoreClass(defaultDispatcher); const store = new RoomListStoreClass(defaultDispatcher);
await store.useUnitTestClient(client); await store.start();
return store; return store;
}; };

View file

@ -65,7 +65,7 @@ describe("SlidingRoomListStore", () => {
describe("spaces", () => { describe("spaces", () => {
it("alters 'filters.spaces' on the DefaultTagID.Untagged list when the selected space changes", async () => { it("alters 'filters.spaces' on the DefaultTagID.Untagged list when the selected space changes", async () => {
await store.useUnitTestClient(context.client!); // call onReady await store.start(); // call onReady
const spaceRoomId = "!foo:bar"; const spaceRoomId = "!foo:bar";
const p = untilEmission(store, LISTS_LOADING_EVENT, (listName, isLoading) => { const p = untilEmission(store, LISTS_LOADING_EVENT, (listName, isLoading) => {
@ -92,7 +92,7 @@ describe("SlidingRoomListStore", () => {
}, },
); );
activeSpace = MetaSpace.Home; activeSpace = MetaSpace.Home;
await store.useUnitTestClient(context.client!); // call onReady await store.start(); // call onReady
expect(context._SlidingSyncManager!.ensureListRegistered).toHaveBeenCalledWith(DefaultTagID.Untagged, { expect(context._SlidingSyncManager!.ensureListRegistered).toHaveBeenCalledWith(DefaultTagID.Untagged, {
filters: expect.objectContaining({ filters: expect.objectContaining({
@ -108,7 +108,7 @@ describe("SlidingRoomListStore", () => {
const p = untilEmission(store, LISTS_LOADING_EVENT, (listName, isLoading) => { const p = untilEmission(store, LISTS_LOADING_EVENT, (listName, isLoading) => {
return listName === DefaultTagID.Untagged && !isLoading; return listName === DefaultTagID.Untagged && !isLoading;
}); });
await store.useUnitTestClient(context.client!); // call onReady await store.start(); // call onReady
await p; await p;
expect(context._SlidingSyncManager!.ensureListRegistered).toHaveBeenCalledWith( expect(context._SlidingSyncManager!.ensureListRegistered).toHaveBeenCalledWith(
DefaultTagID.Untagged, DefaultTagID.Untagged,
@ -121,7 +121,7 @@ describe("SlidingRoomListStore", () => {
}); });
it("includes subspaces in 'filters.spaces' when the selected space has subspaces", async () => { it("includes subspaces in 'filters.spaces' when the selected space has subspaces", async () => {
await store.useUnitTestClient(context.client!); // call onReady await store.start(); // call onReady
const spaceRoomId = "!foo:bar"; const spaceRoomId = "!foo:bar";
const subSpace1 = "!ss1:bar"; const subSpace1 = "!ss1:bar";
const subSpace2 = "!ss2:bar"; const subSpace2 = "!ss2:bar";
@ -168,7 +168,7 @@ describe("SlidingRoomListStore", () => {
}); });
it("getTagsForRoom gets the tags for the room", async () => { it("getTagsForRoom gets the tags for the room", async () => {
await store.useUnitTestClient(context.client!); await store.start();
const roomA = "!a:localhost"; const roomA = "!a:localhost";
const roomB = "!b:localhost"; const roomB = "!b:localhost";
const keyToListData: Record<string, { joinedCount: number; roomIndexToRoomId: Record<number, string> }> = { const keyToListData: Record<string, { joinedCount: number; roomIndexToRoomId: Record<number, string> }> = {
@ -200,7 +200,7 @@ describe("SlidingRoomListStore", () => {
}); });
it("emits LISTS_UPDATE_EVENT when slidingSync lists update", async () => { it("emits LISTS_UPDATE_EVENT when slidingSync lists update", async () => {
await store.useUnitTestClient(context.client!); await store.start();
const roomA = "!a:localhost"; const roomA = "!a:localhost";
const roomB = "!b:localhost"; const roomB = "!b:localhost";
const roomC = "!c:localhost"; const roomC = "!c:localhost";
@ -236,7 +236,7 @@ describe("SlidingRoomListStore", () => {
}); });
it("sets the sticky room on the basis of the viewed room in RoomViewStore", async () => { it("sets the sticky room on the basis of the viewed room in RoomViewStore", async () => {
await store.useUnitTestClient(context.client!); await store.start();
// seed the store with 3 rooms // seed the store with 3 rooms
const roomIdA = "!a:localhost"; const roomIdA = "!a:localhost";
const roomIdB = "!b:localhost"; const roomIdB = "!b:localhost";
@ -301,7 +301,7 @@ describe("SlidingRoomListStore", () => {
}); });
it("gracefully handles unknown room IDs", async () => { it("gracefully handles unknown room IDs", async () => {
await store.useUnitTestClient(context.client!); await store.start();
const roomIdA = "!a:localhost"; const roomIdA = "!a:localhost";
const roomIdB = "!b:localhost"; // does not exist const roomIdB = "!b:localhost"; // does not exist
const roomIdC = "!c:localhost"; const roomIdC = "!c:localhost";

View file

@ -86,14 +86,13 @@ export function createTestClient(): MatrixClient {
let txnId = 1; let txnId = 1;
const client = { const client = {
startClient: jest.fn(),
getHomeserverUrl: jest.fn(), getHomeserverUrl: jest.fn(),
getIdentityServerUrl: jest.fn(), getIdentityServerUrl: jest.fn(),
getDomain: jest.fn().mockReturnValue("matrix.org"), getDomain: jest.fn().mockReturnValue("matrix.org"),
getUserId: jest.fn().mockReturnValue("@userId:matrix.org"), getUserId: jest.fn().mockReturnValue("@userId:matrix.org"),
getSafeUserId: jest.fn().mockReturnValue("@userId:matrix.org"), getSafeUserId: jest.fn().mockReturnValue("@userId:matrix.org"),
getUserIdLocalpart: jest.fn().mockResolvedValue("userId"), getUserIdLocalpart: jest.fn().mockResolvedValue("userId"),
getUser: jest.fn().mockReturnValue({ on: jest.fn(), off: jest.fn(), removeListener: jest.fn() }), getUser: jest.fn().mockReturnValue({ on: jest.fn(), off: jest.fn() }),
getDevice: jest.fn(), getDevice: jest.fn(),
getDeviceId: jest.fn().mockReturnValue("ABCDEFGHI"), getDeviceId: jest.fn().mockReturnValue("ABCDEFGHI"),
getStoredCrossSigningForUser: jest.fn(), getStoredCrossSigningForUser: jest.fn(),
@ -134,8 +133,6 @@ export function createTestClient(): MatrixClient {
getVerificationRequestsToDeviceInProgress: jest.fn().mockReturnValue([]), getVerificationRequestsToDeviceInProgress: jest.fn().mockReturnValue([]),
setDeviceIsolationMode: jest.fn(), setDeviceIsolationMode: jest.fn(),
}), }),
initCrypto: jest.fn(),
initRustCrypto: jest.fn(),
getPushActionsForEvent: jest.fn(), getPushActionsForEvent: jest.fn(),
getRoom: jest.fn().mockImplementation((roomId) => mkStubRoom(roomId, "My room", client)), getRoom: jest.fn().mockImplementation((roomId) => mkStubRoom(roomId, "My room", client)),
@ -183,7 +180,6 @@ export function createTestClient(): MatrixClient {
getSyncState: jest.fn().mockReturnValue("SYNCING"), getSyncState: jest.fn().mockReturnValue("SYNCING"),
generateClientSecret: () => "t35tcl1Ent5ECr3T", generateClientSecret: () => "t35tcl1Ent5ECr3T",
isGuest: jest.fn().mockReturnValue(false), isGuest: jest.fn().mockReturnValue(false),
setGuest: jest.fn(),
getRoomHierarchy: jest.fn().mockReturnValue({ getRoomHierarchy: jest.fn().mockReturnValue({
rooms: [], rooms: [],
}), }),
@ -281,7 +277,6 @@ export function createTestClient(): MatrixClient {
isFallbackICEServerAllowed: jest.fn().mockReturnValue(false), isFallbackICEServerAllowed: jest.fn().mockReturnValue(false),
getAuthIssuer: jest.fn(), getAuthIssuer: jest.fn(),
getOrCreateFilter: jest.fn(), getOrCreateFilter: jest.fn(),
setNotifTimelineSet: jest.fn(),
} as unknown as MatrixClient; } as unknown as MatrixClient;
client.reEmitter = new ReEmitter(client); client.reEmitter = new ReEmitter(client);