Room list: extract getTagsForRoom from old room list store (#32716)
* refactor: extract `getTagsForRoom` from old rls `getTagsForRoom` doesn't rely on the rls state. We can extract it safely to an external function. The function is not moved into the rls v3 because the rls is for the room list and not for other ui elements. * refactor: remove dead code * test: add more tests for `getTagsForRoom` * refactor: `getTagsForRoom` in old rls * doc: add missing tsdoc for `room`
This commit is contained in:
Florian Duros
@@ -0,0 +1,149 @@
|
||||
/*
|
||||
* Copyright 2026 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 { JoinRule, type MatrixClient, type Room } from "matrix-js-sdk/src/matrix";
|
||||
import { KnownMembership } from "matrix-js-sdk/src/types";
|
||||
import { mocked } from "jest-mock";
|
||||
|
||||
import { createTestClient, mkRoom } from "../../../test-utils";
|
||||
import { DefaultTagID } from "../../../../src/stores/room-list-v3/skip-list/tag";
|
||||
import { getTagsForRoom } from "../../../../src/utils/room/getTagsForRoom";
|
||||
import DMRoomMap from "../../../../src/utils/DMRoomMap";
|
||||
|
||||
describe("getTagsForRoom", () => {
|
||||
let client: MatrixClient;
|
||||
let rooms: Room[];
|
||||
|
||||
beforeEach(() => {
|
||||
client = createTestClient();
|
||||
rooms = [];
|
||||
|
||||
const dmRoomMap = {
|
||||
getUserIdForRoomId: jest.fn().mockReturnValue(undefined),
|
||||
} as unknown as DMRoomMap;
|
||||
DMRoomMap.setShared(dmRoomMap);
|
||||
});
|
||||
|
||||
function makeRoom(roomId: string): Room {
|
||||
mkRoom(client, roomId, rooms);
|
||||
mocked(client).getRoom.mockImplementation((id) => rooms.find((r) => r.roomId === id) ?? null);
|
||||
mocked(client).getRooms.mockImplementation(() => rooms);
|
||||
return client.getRoom(roomId)!;
|
||||
}
|
||||
|
||||
it("should return [Invite] for a room where the user is invited", () => {
|
||||
const room = makeRoom("!invited:server");
|
||||
(room.getMyMembership as jest.Mock).mockReturnValue(KnownMembership.Invite);
|
||||
|
||||
const tags = getTagsForRoom(room);
|
||||
expect(tags).toEqual([DefaultTagID.Invite]);
|
||||
});
|
||||
|
||||
it.each([KnownMembership.Leave, KnownMembership.Ban])(
|
||||
"should return [Archived] for a room where the user has %s",
|
||||
(membership) => {
|
||||
const room = makeRoom(`!${membership.toLowerCase()}:server`);
|
||||
(room.getMyMembership as jest.Mock).mockReturnValue(membership);
|
||||
|
||||
const tags = getTagsForRoom(room);
|
||||
expect(tags).toEqual([DefaultTagID.Archived]);
|
||||
},
|
||||
);
|
||||
|
||||
describe("joined rooms", () => {
|
||||
describe("with no user-defined tags and not a DM", () => {
|
||||
it("should return [Untagged] when the room has no tags and is not a DM", () => {
|
||||
const room = makeRoom("!plain:server");
|
||||
(room.getMyMembership as jest.Mock).mockReturnValue(KnownMembership.Join);
|
||||
(room as any).tags = {};
|
||||
|
||||
const tags = getTagsForRoom(room);
|
||||
expect(tags).toEqual([DefaultTagID.Untagged]);
|
||||
});
|
||||
});
|
||||
|
||||
it("should return [DM] when the room is a DM", () => {
|
||||
const room = makeRoom("!dm:server");
|
||||
(room.getMyMembership as jest.Mock).mockReturnValue(KnownMembership.Join);
|
||||
(room as any).tags = {};
|
||||
|
||||
mocked(DMRoomMap.shared().getUserIdForRoomId as jest.Mock).mockReturnValue("@alice:server");
|
||||
|
||||
const tags = getTagsForRoom(room);
|
||||
expect(tags).toContain(DefaultTagID.DM);
|
||||
expect(tags).not.toContain(DefaultTagID.Untagged);
|
||||
});
|
||||
|
||||
describe("rooms with user-defined tags", () => {
|
||||
it("should return the user-defined tags", () => {
|
||||
const room = makeRoom("!tagged:server");
|
||||
(room.getMyMembership as jest.Mock).mockReturnValue(KnownMembership.Join);
|
||||
(room as any).tags = { "m.favourite": {}, "u.alice": {} };
|
||||
|
||||
const tags = getTagsForRoom(room);
|
||||
expect(tags).toContain("m.favourite");
|
||||
expect(tags).toContain("u.alice");
|
||||
expect(tags).not.toContain(DefaultTagID.Untagged);
|
||||
});
|
||||
|
||||
it("should not check DM status when user-defined tags are already present", () => {
|
||||
const room = makeRoom("!tagged-dm:server");
|
||||
(room.getMyMembership as jest.Mock).mockReturnValue(KnownMembership.Join);
|
||||
(room as any).tags = { "m.lowpriority": {} };
|
||||
|
||||
// Even if the room is a DM, user-defined tags take priority
|
||||
mocked(DMRoomMap.shared().getUserIdForRoomId as jest.Mock).mockReturnValue("@alice:server");
|
||||
|
||||
const tags = getTagsForRoom(room);
|
||||
expect(tags).toContain("m.lowpriority");
|
||||
expect(tags).not.toContain(DefaultTagID.DM);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("conference (call) rooms", () => {
|
||||
it.each([JoinRule.Public, JoinRule.Knock])(
|
||||
"should include Conference tag for a call room with %s join rule",
|
||||
(joinRule) => {
|
||||
const room = makeRoom(`!call:${joinRule}:server`);
|
||||
(room.getMyMembership as jest.Mock).mockReturnValue(KnownMembership.Join);
|
||||
(room.isCallRoom as jest.Mock).mockReturnValue(true);
|
||||
(room.getJoinRule as jest.Mock).mockReturnValue(joinRule);
|
||||
|
||||
const tags = getTagsForRoom(room);
|
||||
expect(tags).toContain(DefaultTagID.Conference);
|
||||
},
|
||||
);
|
||||
|
||||
it.each([JoinRule.Invite, JoinRule.Private])(
|
||||
"should not include Conference tag for a call room with %s join rule",
|
||||
(joinRule) => {
|
||||
const room = makeRoom(`!call:${joinRule}:server`);
|
||||
(room.getMyMembership as jest.Mock).mockReturnValue(KnownMembership.Join);
|
||||
(room.isCallRoom as jest.Mock).mockReturnValue(true);
|
||||
(room.getJoinRule as jest.Mock).mockReturnValue(joinRule);
|
||||
|
||||
const tags = getTagsForRoom(room);
|
||||
expect(tags).not.toContain(DefaultTagID.Conference);
|
||||
},
|
||||
);
|
||||
|
||||
it("should include Conference alongside Untagged for a public call room with no other tags", () => {
|
||||
const room = makeRoom("!callPublicPlain:server");
|
||||
(room.getMyMembership as jest.Mock).mockReturnValue(KnownMembership.Join);
|
||||
(room as any).tags = {};
|
||||
(room.isCallRoom as jest.Mock).mockReturnValue(true);
|
||||
(room.getJoinRule as jest.Mock).mockReturnValue(JoinRule.Public);
|
||||
|
||||
const tags = getTagsForRoom(room);
|
||||
// Conference is added to the tag list before the Untagged fallback check,
|
||||
// so tags.length is already 1 — Untagged is not appended.
|
||||
expect(tags).toContain(DefaultTagID.Conference);
|
||||
expect(tags).not.toContain(DefaultTagID.Untagged);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -11,9 +11,9 @@ import { Room } from "matrix-js-sdk/src/matrix";
|
||||
import RoomListActions from "../../../../src/actions/RoomListActions";
|
||||
import defaultDispatcher from "../../../../src/dispatcher/dispatcher";
|
||||
import { DefaultTagID, type TagID } from "../../../../src/stores/room-list-v3/skip-list/tag";
|
||||
import RoomListStore from "../../../../src/stores/room-list/RoomListStore";
|
||||
import { tagRoom } from "../../../../src/utils/room/tagRoom";
|
||||
import { getMockClientWithEventEmitter } from "../../../test-utils";
|
||||
import * as getTagsForRoomUtils from "../../../../src/utils/room/getTagsForRoom";
|
||||
|
||||
describe("tagRoom()", () => {
|
||||
const userId = "@alice:server.org";
|
||||
@@ -25,7 +25,7 @@ describe("tagRoom()", () => {
|
||||
});
|
||||
const room = new Room(roomId, client, userId);
|
||||
|
||||
jest.spyOn(RoomListStore.instance, "getTagsForRoom").mockReturnValue(tags);
|
||||
jest.spyOn(getTagsForRoomUtils, "getTagsForRoom").mockReturnValue(tags);
|
||||
|
||||
return room;
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user