New room list: add empty state (#29512)

* refactor: extract room creation and right verification * refactor: update `RoomListHeaderViewModel` to use utils * feat(room list filter): add filter key to `PrimaryFilter` model * feat(room list filter): return active primary filter * feat(room list): add create room action and rights verification * test: update room list tests * feat(empty room list): add empty room list * test(empty room list): add empty room list tests * feat(room list): use empty room list in `RoomListView` * test(room list panel): update tests * test(e2e): add e2e tests for empty room list * test(e2e): update room list header snapshot
2026-11-04 10:32:44 +00:00 · 2025-03-18 11:02:33 +01:00
parent 55b0b1107e
commit 7de54a385e
26 changed files with 991 additions and 155 deletions
@@ -0,0 +1,69 @@
+/*
+ * Copyright 2025 New Vector 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 { mocked } from "jest-mock";
+
+import type { MatrixClient, Room, RoomState } from "matrix-js-sdk/src/matrix";
+import { createTestClient, mkStubRoom } from "../../../../test-utils";
+import { shouldShowComponent } from "../../../../../src/customisations/helpers/UIComponents";
+import { hasCreateRoomRights, createRoom } from "../../../../../src/components/viewmodels/roomlist/utils";
+import defaultDispatcher from "../../../../../src/dispatcher/dispatcher";
+import { Action } from "../../../../../src/dispatcher/actions";
+import { showCreateNewRoom } from "../../../../../src/utils/space";
+
+jest.mock("../../../../../src/customisations/helpers/UIComponents", () => ({
+    shouldShowComponent: jest.fn(),
+}));
+
+jest.mock("../../../../../src/utils/space", () => ({
+    showCreateNewRoom: jest.fn(),
+}));
+
+describe("utils", () => {
+    let matrixClient: MatrixClient;
+    let space: Room;
+
+    beforeEach(() => {
+        matrixClient = createTestClient();
+        space = mkStubRoom("spaceId", "spaceName", matrixClient);
+    });
+
+    describe("createRoom", () => {
+        it("should fire Action.CreateRoom when createRoom is called without a space", async () => {
+            const spy = jest.spyOn(defaultDispatcher, "fire");
+            await createRoom();
+
+            expect(spy).toHaveBeenCalledWith(Action.CreateRoom);
+        });
+
+        it("should call showCreateNewRoom when createRoom is called in a space", async () => {
+            await createRoom(space);
+            expect(showCreateNewRoom).toHaveBeenCalledWith(space);
+        });
+    });
+
+    describe("hasCreateRoomRights", () => {
+        it("should return false when UIComponent.CreateRooms is disabled", () => {
+            mocked(shouldShowComponent).mockReturnValue(false);
+            expect(hasCreateRoomRights(matrixClient, space)).toBe(false);
+        });
+
+        it("should return true when UIComponent.CreateRooms is enabled and no space", () => {
+            mocked(shouldShowComponent).mockReturnValue(true);
+            expect(hasCreateRoomRights(matrixClient)).toBe(true);
+        });
+
+        it("should return false in space when UIComponent.CreateRooms is enabled and the user doesn't have the rights", () => {
+            mocked(shouldShowComponent).mockReturnValue(true);
+            jest.spyOn(space.getLiveTimeline(), "getState").mockReturnValue({
+                maySendStateEvent: jest.fn().mockReturnValue(true),
+            } as unknown as RoomState);
+
+            expect(hasCreateRoomRights(matrixClient)).toBe(true);
+        });
+    });
+});