Experimental Module API Additions (#30863)
* Module API experiments * Move ResizerNotifier into SDKContext so we don't have to pass it into RoomView * Add the MultiRoomViewStore * Make RoomViewStore able to take a roomId prop * Different interface to add space panel items A bit less flexible but probably simpler and will help keep things actually consistent rather than just allowing modules to stick any JSX into the space panel (which means they also have to worry about styling if they *do* want it to be consistent). * Allow space panel items to be updated and manage which one is selected, allowing module "spaces" to be considered spaces * Remove fetchRoomFn from SpaceNotificationStore which didn't really seem to have any point as it was only called from one place * Switch to using module api via .instance * Fairly awful workaround to actually break the dependency nightmare * Add test for multiroomviewstore * add test * Make room names deterministic So the tests don't fail if you add other tests or run them individually * Add test for builtinsapi * Update module api * RVS is not needed as prop anymore Since it's passed through context * Add roomId to prop * Remove RoomViewStore from state This is now accessed through class field * Fix test * No need to pass RVS from LoggedInView * Add RoomContextType * Implement new builtins api * Add tests * Fix import * Fix circular dependency issue * Fix import * Add more tests * Improve comment * room-id is optional * Update license * Add implementation for AccountDataApi * Add implementation for Room * Add implementation for ClientApi * Create ClientApi in Api.ts * Write tests * Use nullish coalescing assignment * Implement openRoom in NavigationApi * Write tests * Add implementation for StoresApi * Write tests * Fix circular dependency * Add comments in lieu of type and fix else block * Change to class field --------- Co-authored-by: R Midhun Suresh <hi@midhun.dev>
This commit is contained in:
David Baker
GitHub
72
test/unit-tests/modules/AccountDataApi-test.ts
Normal file
72
test/unit-tests/modules/AccountDataApi-test.ts
Normal file
@@ -0,0 +1,72 @@
|
||||
/*
|
||||
Copyright 2025 Element Creations Ltd.
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
||||
Please see LICENSE files in the repository root for full details.
|
||||
*/
|
||||
|
||||
import { ClientEvent } from "matrix-js-sdk/src/matrix";
|
||||
|
||||
import { AccountDataApi } from "../../../src/modules/AccountDataApi";
|
||||
import { mkEvent, stubClient } from "../../test-utils/test-utils";
|
||||
|
||||
describe("AccountDataApi", () => {
|
||||
describe("AccountDataWatchable", () => {
|
||||
it("should return content of account data event on get()", () => {
|
||||
const cli = stubClient();
|
||||
const api = new AccountDataApi();
|
||||
// Mock cli to return a event
|
||||
const content = { foo: "bar" };
|
||||
const event = mkEvent({ content, type: "m.test", user: "@foobar:matrix.org", event: true });
|
||||
cli.getAccountData = () => event;
|
||||
expect(api.get("m.test").value).toStrictEqual(content);
|
||||
});
|
||||
|
||||
it("should update value on event", () => {
|
||||
const cli = stubClient();
|
||||
const api = new AccountDataApi();
|
||||
// Mock cli to return a event
|
||||
const content = { foo: "bar" };
|
||||
const event = mkEvent({ content, type: "m.test", user: "@foobar:matrix.org", event: true });
|
||||
cli.getAccountData = () => event;
|
||||
|
||||
const watchable = api.get("m.test");
|
||||
expect(watchable.value).toStrictEqual(content);
|
||||
|
||||
const fn = jest.fn();
|
||||
watchable.watch(fn);
|
||||
|
||||
// Let's say that the account data event changed
|
||||
const event2 = mkEvent({
|
||||
content: { foo: "abc" },
|
||||
type: "m.test",
|
||||
user: "@foobar:matrix.org",
|
||||
event: true,
|
||||
});
|
||||
cli.emit(ClientEvent.AccountData, event2);
|
||||
// Watchable value should have been updated
|
||||
expect(watchable.value).toStrictEqual({ foo: "abc" });
|
||||
// Watched callbacks should be called
|
||||
expect(fn).toHaveBeenCalledTimes(1);
|
||||
|
||||
// Make sure unwatch removed the event listener
|
||||
cli.off = jest.fn();
|
||||
watchable.unwatch(fn);
|
||||
expect(cli.off).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
});
|
||||
|
||||
it("should set account data via js-sdk on set()", async () => {
|
||||
const cli = stubClient();
|
||||
const api = new AccountDataApi();
|
||||
await api.set("m.test", { foo: "bar" });
|
||||
expect(cli.setAccountData).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("should delete account data via js-sdk on set()", async () => {
|
||||
const cli = stubClient();
|
||||
const api = new AccountDataApi();
|
||||
await api.delete("m.test");
|
||||
expect(cli.deleteAccountData).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
});
|
||||
53
test/unit-tests/modules/BuiltinsApi-test.tsx
Normal file
53
test/unit-tests/modules/BuiltinsApi-test.tsx
Normal file
@@ -0,0 +1,53 @@
|
||||
/*
|
||||
Copyright 2025 Element Creations Ltd.
|
||||
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
||||
Please see LICENSE files in the repository root for full details.
|
||||
*/
|
||||
|
||||
import React from "react";
|
||||
import { render } from "jest-matrix-react";
|
||||
|
||||
import { ElementWebBuiltinsApi } from "../../../src/modules/BuiltinsApi.tsx";
|
||||
import { stubClient } from "../../test-utils/test-utils";
|
||||
|
||||
const Avatar: React.FC<{ room: { roomId: string }; size: string }> = ({ room, size }) => {
|
||||
return (
|
||||
<div>
|
||||
Avatar, {room.roomId}, {size}
|
||||
</div>
|
||||
);
|
||||
};
|
||||
|
||||
describe("ElementWebBuiltinsApi", () => {
|
||||
it("returns the RoomView component thats been set", () => {
|
||||
const builtinsApi = new ElementWebBuiltinsApi();
|
||||
const sentinel = {};
|
||||
builtinsApi.setComponents({ roomView: sentinel, roomAvatar: Avatar } as any);
|
||||
expect(builtinsApi.getRoomViewComponent()).toBe(sentinel);
|
||||
});
|
||||
|
||||
it("returns rendered RoomView component", () => {
|
||||
const builtinsApi = new ElementWebBuiltinsApi();
|
||||
const RoomView = () => <div>hello world</div>;
|
||||
builtinsApi.setComponents({ roomView: RoomView, roomAvatar: Avatar } as any);
|
||||
const { container } = render(<> {builtinsApi.renderRoomView("!foo:m.org")}</>);
|
||||
expect(container).toHaveTextContent("hello world");
|
||||
});
|
||||
|
||||
it("returns rendered RoomAvatar component", () => {
|
||||
stubClient();
|
||||
const builtinsApi = new ElementWebBuiltinsApi();
|
||||
builtinsApi.setComponents({ roomView: {}, roomAvatar: Avatar } as any);
|
||||
const { container } = render(<> {builtinsApi.renderRoomAvatar("!foo:m.org", "50")}</>);
|
||||
expect(container).toHaveTextContent("Avatar");
|
||||
expect(container).toHaveTextContent("!foo:m.org");
|
||||
expect(container).toHaveTextContent("50");
|
||||
});
|
||||
|
||||
it("should throw error if called before components are set", () => {
|
||||
stubClient();
|
||||
const builtinsApi = new ElementWebBuiltinsApi();
|
||||
expect(() => builtinsApi.renderRoomAvatar("!foo:m.org")).toThrow("No RoomAvatar component has been set");
|
||||
expect(() => builtinsApi.renderRoomView("!foo:m.org")).toThrow("No RoomView component has been set");
|
||||
});
|
||||
});
|
||||
20
test/unit-tests/modules/ClientApi-test.ts
Normal file
20
test/unit-tests/modules/ClientApi-test.ts
Normal file
@@ -0,0 +1,20 @@
|
||||
/*
|
||||
Copyright 2025 Element Creations Ltd.
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
||||
Please see LICENSE files in the repository root for full details.
|
||||
*/
|
||||
|
||||
import { ClientApi } from "../../../src/modules/ClientApi";
|
||||
import { Room } from "../../../src/modules/models/Room";
|
||||
import { stubClient } from "../../test-utils/test-utils";
|
||||
|
||||
describe("ClientApi", () => {
|
||||
it("should return module room from getRoom()", () => {
|
||||
stubClient();
|
||||
const client = new ClientApi();
|
||||
const moduleRoom = client.getRoom("!foo:matrix.org");
|
||||
expect(moduleRoom).toBeInstanceOf(Room);
|
||||
expect(moduleRoom?.id).toStrictEqual("!foo:matrix.org");
|
||||
});
|
||||
});
|
||||
@@ -37,5 +37,25 @@ describe("NavigationApi", () => {
|
||||
}),
|
||||
);
|
||||
});
|
||||
|
||||
it("should dispatch correct action on openRoom", () => {
|
||||
const spy = jest.spyOn(defaultDispatcher, "dispatch");
|
||||
// Non alias
|
||||
api.openRoom("!foo:m.org");
|
||||
expect(spy).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
action: "view_room",
|
||||
room_id: "!foo:m.org",
|
||||
}),
|
||||
);
|
||||
// Alias
|
||||
api.openRoom("#bar:m.org");
|
||||
expect(spy).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
action: "view_room",
|
||||
room_alias: "#bar:m.org",
|
||||
}),
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
84
test/unit-tests/modules/StoresApi-test.ts
Normal file
84
test/unit-tests/modules/StoresApi-test.ts
Normal file
@@ -0,0 +1,84 @@
|
||||
/*
|
||||
Copyright 2025 Element Creations Ltd.
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
||||
Please see LICENSE files in the repository root for full details.
|
||||
*/
|
||||
|
||||
import { waitFor } from "jest-matrix-react";
|
||||
|
||||
import { type RoomListStoreApi, StoresApi } from "../../../src/modules/StoresApi";
|
||||
import RoomListStoreV3, {
|
||||
LISTS_LOADED_EVENT,
|
||||
LISTS_UPDATE_EVENT,
|
||||
} from "../../../src/stores/room-list-v3/RoomListStoreV3";
|
||||
import { mkRoom, stubClient } from "../../test-utils/test-utils";
|
||||
import { Room } from "../../../src/modules/models/Room";
|
||||
import {} from "../../../src/stores/room-list/algorithms/Algorithm";
|
||||
|
||||
describe("StoresApi", () => {
|
||||
describe("RoomListStoreApi", () => {
|
||||
it("should return promise that resolves when RLS is ready", async () => {
|
||||
jest.spyOn(RoomListStoreV3.instance, "isLoadingRooms", "get").mockReturnValue(true);
|
||||
const store = new StoresApi();
|
||||
let hasResolved = false;
|
||||
// The following async function will set hasResolved to false
|
||||
// only when waitForReady resolves.
|
||||
(async () => {
|
||||
await store.roomListStore.waitForReady();
|
||||
hasResolved = true;
|
||||
})();
|
||||
// Shouldn't have resolved yet.
|
||||
expect(hasResolved).toStrictEqual(false);
|
||||
|
||||
// Wait for the module to load so that we can test the listener.
|
||||
await (store.roomListStore as RoomListStoreApi).moduleLoadPromise;
|
||||
// Emit the loaded event.
|
||||
RoomListStoreV3.instance.emit(LISTS_LOADED_EVENT);
|
||||
// Should resolve now.
|
||||
await waitFor(() => {
|
||||
expect(hasResolved).toStrictEqual(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe("getRooms()", () => {
|
||||
it("should return rooms from RLS", async () => {
|
||||
const cli = stubClient();
|
||||
const room1 = mkRoom(cli, "!foo1:m.org");
|
||||
const room2 = mkRoom(cli, "!foo2:m.org");
|
||||
const room3 = mkRoom(cli, "!foo3:m.org");
|
||||
jest.spyOn(RoomListStoreV3.instance, "getSortedRooms").mockReturnValue([room1, room2, room3]);
|
||||
jest.spyOn(RoomListStoreV3.instance, "isLoadingRooms", "get").mockReturnValue(false);
|
||||
|
||||
const store = new StoresApi();
|
||||
await store.roomListStore.waitForReady();
|
||||
const watchable = store.roomListStore.getRooms();
|
||||
expect(watchable.value).toHaveLength(3);
|
||||
expect(watchable.value[0]).toBeInstanceOf(Room);
|
||||
});
|
||||
|
||||
it("should update from RLS", async () => {
|
||||
const cli = stubClient();
|
||||
const room1 = mkRoom(cli, "!foo1:m.org");
|
||||
const room2 = mkRoom(cli, "!foo2:m.org");
|
||||
const rooms = [room1, room2];
|
||||
|
||||
jest.spyOn(RoomListStoreV3.instance, "getSortedRooms").mockReturnValue(rooms);
|
||||
jest.spyOn(RoomListStoreV3.instance, "isLoadingRooms", "get").mockReturnValue(false);
|
||||
|
||||
const store = new StoresApi();
|
||||
await store.roomListStore.waitForReady();
|
||||
const watchable = store.roomListStore.getRooms();
|
||||
const fn = jest.fn();
|
||||
watchable.watch(fn);
|
||||
expect(watchable.value).toHaveLength(2);
|
||||
|
||||
const room3 = mkRoom(cli, "!foo3:m.org");
|
||||
rooms.push(room3);
|
||||
RoomListStoreV3.instance.emit(LISTS_UPDATE_EVENT);
|
||||
expect(fn).toHaveBeenCalledTimes(1);
|
||||
expect(watchable.value).toHaveLength(3);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
50
test/unit-tests/modules/models/Room-test.ts
Normal file
50
test/unit-tests/modules/models/Room-test.ts
Normal file
@@ -0,0 +1,50 @@
|
||||
/*
|
||||
Copyright 2025 Element Creations Ltd.
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
|
||||
Please see LICENSE files in the repository root for full details.
|
||||
*/
|
||||
|
||||
import { Room } from "../../../../src/modules/models/Room";
|
||||
import { mkRoom, stubClient } from "../../../test-utils";
|
||||
|
||||
describe("Room", () => {
|
||||
it("should return id from sdk room", () => {
|
||||
const cli = stubClient();
|
||||
const sdkRoom = mkRoom(cli, "!foo:m.org");
|
||||
const room = new Room(sdkRoom);
|
||||
expect(room.id).toStrictEqual("!foo:m.org");
|
||||
});
|
||||
|
||||
it("should return last timestamp from sdk room", () => {
|
||||
const cli = stubClient();
|
||||
const sdkRoom = mkRoom(cli, "!foo:m.org");
|
||||
const room = new Room(sdkRoom);
|
||||
expect(room.getLastActiveTimestamp()).toStrictEqual(sdkRoom.getLastActiveTimestamp());
|
||||
});
|
||||
|
||||
describe("watchableName", () => {
|
||||
it("should return name from sdkRoom", () => {
|
||||
const cli = stubClient();
|
||||
const sdkRoom = mkRoom(cli, "!foo:m.org");
|
||||
sdkRoom.name = "Foo Name";
|
||||
const room = new Room(sdkRoom);
|
||||
expect(room.name.value).toStrictEqual("Foo Name");
|
||||
});
|
||||
|
||||
it("should add/remove event listener on sdk room", () => {
|
||||
const cli = stubClient();
|
||||
const sdkRoom = mkRoom(cli, "!foo:m.org");
|
||||
sdkRoom.name = "Foo Name";
|
||||
|
||||
const room = new Room(sdkRoom);
|
||||
const fn = jest.fn();
|
||||
|
||||
room.name.watch(fn);
|
||||
expect(sdkRoom.on).toHaveBeenCalledTimes(1);
|
||||
|
||||
room.name.unwatch(fn);
|
||||
expect(sdkRoom.off).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user