imterah/element-portable
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Refactor stores and their relationship to the MatrixClientPeg (#124)

Browse source 
* Refactor stores and their relationship to the MatrixClientPeg

to avoid import cycles and webpack weirdness

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

* Iterate

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>

---------

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
This commit is contained in:
Michael Telatynski 2024-10-08 10:12:21 +01:00 • committed by GitHub
parent 31bd10e887
commit 197168b3ba
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
28 changed files with 71 additions and 66 deletions
Download patch file Download diff file Expand all files Collapse all files

2
test/stores/AutoRageshakeStore-test.ts
View file

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

6
test/stores/OwnProfileStore-test.ts
View file

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

4
test/stores/SpaceStore-test.ts
View file

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

2
test/stores/VoiceRecordingStore-test.ts
View file

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

8
test/stores/WidgetLayoutStore-test.ts
View file

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

2
test/stores/room-list/MessagePreviewStore-test.ts
View file

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

15
test/stores/room-list/RoomListStore-test.ts
View file

@ -29,6 +29,9 @@ import DMRoomMap from "../../../src/utils/DMRoomMap";
import { flushPromises, stubClient, upsertRoomStateEvents, mkRoom } from "../../test-utils";
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", () => {
const client = stubClient();
const newRoomId = "!roomid:example.com";
@ -91,6 +94,10 @@ describe("RoomListStore", () => {
await (RoomListStore.instance as RoomListStoreClass).makeReady(client);
});
beforeEach(() => {
DMRoomMap.makeShared(client);
});
it.each(OrderedDefaultTagIDs)("defaults to importance ordering for %s=", (tagId) => {
expect(RoomListStore.instance.getTagSorting(tagId)).toBe(SortAlgorithm.Recent);
});
@ -102,11 +109,11 @@ describe("RoomListStore", () => {
function createStore(): { store: RoomListStoreClass; handleRoomUpdate: jest.Mock<any, any> } {
const fakeDispatcher = { register: jest.fn() } as unknown as MatrixDispatcher;
const store = new RoomListStoreClass(fakeDispatcher);
// @ts-ignore accessing private member to set client
store.readyStore.matrixClient = client;
const handleRoomUpdate = jest.fn();
// @ts-ignore accessing private member to mock it
store.algorithm.handleRoomUpdate = handleRoomUpdate;
// @ts-ignore accessing private member to set client
store.readyStore.useUnitTestClient(client);
return { store, handleRoomUpdate };
}
@ -157,7 +164,6 @@ describe("RoomListStore", () => {
room1.updateMyMembership(KnownMembership.Join);
room2.updateMyMembership(KnownMembership.Join);
room3.updateMyMembership(KnownMembership.Join);
DMRoomMap.makeShared(client);
const { store } = createStore();
client.getVisibleRooms = jest.fn().mockReturnValue([room1, room2, room3]);
@ -269,7 +275,6 @@ describe("RoomListStore", () => {
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
DMRoomMap.makeShared(client);
const { store } = createStore();
client.getVisibleRooms = jest.fn().mockReturnValue([]);
@ -285,7 +290,7 @@ describe("RoomListStore", () => {
describe("room updates", () => {
const makeStore = async () => {
const store = new RoomListStoreClass(defaultDispatcher);
await store.start();
await store.useUnitTestClient(client);
return store;
};

16
test/stores/room-list/SlidingRoomListStore-test.ts
View file

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