Files
element-web/test/unit-tests/components/views/rooms/memberlist/MemberTileView-test.tsx
Florian Duros 299d7baf8b Avoid excessive re-render of room list and member list (#31131)
* fix(list view): avoid re-create `onFocus` function at each render of the child items

* fix(room list): update `onFocus` signature

* fix(member list): update `onFocus` signature

* fix(room list): avoid re-render at the beginning and end of the scroll

* test(room list): remove scrolling test and props

* test(member list): update member tile view tests

* test(room list): update `ListView` focus test

* test(member list): add `onFocus` test for member list tile
2025-10-30 14:55:15 +00:00

179 lines
7.8 KiB
TypeScript

/*
* Copyright 2024 New Vector Ltd.
* Copyright 2023 The Matrix.org Foundation C.I.C.
*
* 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, screen, waitFor } from "jest-matrix-react";
import { type MatrixClient, RoomMember as SdkRoomMember, type Device, Room } from "matrix-js-sdk/src/matrix";
import { type UserVerificationStatus, type DeviceVerificationStatus } from "matrix-js-sdk/src/crypto-api";
import { mocked } from "jest-mock";
import userEvent from "@testing-library/user-event";
import * as TestUtils from "../../../../../test-utils";
import { type RoomMember } from "../../../../../../src/models/rooms/RoomMember";
import {
getPending3PidInvites,
type MemberWithSeparator,
sdkRoomMemberToRoomMember,
} from "../../../../../../src/components/viewmodels/memberlist/MemberListViewModel";
import { RoomMemberTileView } from "../../../../../../src/components/views/rooms/MemberList/tiles/RoomMemberTileView";
import { ThreePidInviteTileView } from "../../../../../../src/components/views/rooms/MemberList/tiles/ThreePidInviteTileView";
import { type ThreePIDInvite } from "../../../../../../src/models/rooms/ThreePIDInvite";
describe("MemberTileView", () => {
describe("RoomMemberTileView", () => {
const item = {} as { member: RoomMember };
let matrixClient: MatrixClient;
let member: RoomMember;
beforeEach(() => {
matrixClient = TestUtils.stubClient();
mocked(matrixClient.isRoomEncrypted).mockReturnValue(true);
const sdkMember = new SdkRoomMember("roomId", matrixClient.getUserId()!);
member = sdkRoomMemberToRoomMember(sdkMember)!.member!;
item.member = member;
});
it("should not display an E2EIcon when the e2E status = normal", () => {
const { container } = render(
<RoomMemberTileView item={item} member={member} index={0} memberCount={1} onFocus={jest.fn()} />,
);
const e2eIcon = container.querySelector(".mx_E2EIconView");
expect(e2eIcon).toBeNull();
expect(container).toMatchSnapshot();
});
it("should display an warning E2EIcon when the e2E status = Warning", async () => {
mocked(matrixClient.getCrypto()!.getUserVerificationStatus).mockResolvedValue({
isCrossSigningVerified: jest.fn().mockReturnValue(false),
wasCrossSigningVerified: jest.fn().mockReturnValue(true),
} as unknown as UserVerificationStatus);
const { container } = render(
<RoomMemberTileView item={item} member={member} index={0} memberCount={1} onFocus={jest.fn()} />,
);
await waitFor(async () => {
await userEvent.hover(container.querySelector(".mx_E2EIcon")!);
expect(screen.getByText("This user has not verified all of their sessions.")).toBeInTheDocument();
});
expect(container).toMatchSnapshot();
});
it("should display an verified E2EIcon when the e2E status = Verified", async () => {
// Mock all the required crypto methods
const deviceMap = new Map<string, Map<string, Device>>();
deviceMap.set(member.userId, new Map([["deviceId", {} as Device]]));
// Return a DeviceMap = Map<string, Map<string, Device>>
mocked(matrixClient.getCrypto()!.getUserDeviceInfo).mockResolvedValue(deviceMap);
mocked(matrixClient.getCrypto()!.getUserVerificationStatus).mockResolvedValue({
isCrossSigningVerified: jest.fn().mockReturnValue(true),
} as unknown as UserVerificationStatus);
mocked(matrixClient.getCrypto()!.getDeviceVerificationStatus).mockResolvedValue({
crossSigningVerified: true,
} as DeviceVerificationStatus);
const { container } = render(
<RoomMemberTileView item={item} member={member} index={0} memberCount={1} onFocus={jest.fn()} />,
);
await waitFor(async () => {
await userEvent.hover(container.querySelector(".mx_E2EIcon")!);
expect(
screen.getByText("You have verified this user. This user has verified all of their sessions."),
).toBeInTheDocument();
});
expect(container).toMatchSnapshot();
});
it("renders user labels correctly", async () => {
member.powerLevel = 50;
const { container: container1 } = render(
<RoomMemberTileView item={item} member={member} index={0} memberCount={1} onFocus={jest.fn()} />,
);
expect(container1).toHaveTextContent("Moderator");
member.powerLevel = 100;
const { container: container2 } = render(
<RoomMemberTileView item={item} member={member} index={0} memberCount={1} onFocus={jest.fn()} />,
);
expect(container2).toHaveTextContent("Admin");
member.powerLevel = Infinity;
const { container: container3 } = render(
<RoomMemberTileView item={item} member={member} index={0} memberCount={1} onFocus={jest.fn()} />,
);
expect(container3).toHaveTextContent("Owner");
member.isInvite = true;
const { container: container4 } = render(
<RoomMemberTileView item={item} member={member} index={0} memberCount={1} onFocus={jest.fn()} />,
);
expect(container4).toHaveTextContent("Invited");
});
it("should call onFocus handler when focused", async () => {
const user = userEvent.setup();
const onFocus = jest.fn();
render(<RoomMemberTileView item={item} member={member} index={0} memberCount={1} onFocus={onFocus} />);
const button = screen.getByRole("option", { name: member.userId });
await user.click(button);
expect(onFocus).toHaveBeenCalledWith(item, expect.anything());
});
});
describe("ThreePidInviteTileView", () => {
const member = {} as MemberWithSeparator;
let cli: MatrixClient;
let room: Room;
let threePidInvite: ThreePIDInvite;
beforeEach(() => {
cli = TestUtils.stubClient();
room = new Room("!mytestroom:foo.org", cli, cli.getSafeUserId());
room.getLiveTimeline().addEvent(
TestUtils.mkThirdPartyInviteEvent(cli.getSafeUserId(), "Foobar", room.roomId),
{ toStartOfTimeline: false, addToState: true },
);
threePidInvite = getPending3PidInvites(room)[0].threePidInvite!;
});
it("renders ThreePidInvite correctly", async () => {
const { container } = render(
<ThreePidInviteTileView
item={member}
threePidInvite={threePidInvite}
memberIndex={0}
memberCount={1}
onFocus={jest.fn()}
/>,
);
expect(container).toMatchSnapshot();
});
it("should call onFocus handler when focused", async () => {
const user = userEvent.setup();
const onFocus = jest.fn();
render(
<ThreePidInviteTileView
item={member}
threePidInvite={threePidInvite}
memberIndex={0}
memberCount={1}
onFocus={onFocus}
/>,
);
const button = screen.getByRole("option", { name: threePidInvite.event.getContent().display_name });
await user.click(button);
expect(onFocus).toHaveBeenCalledWith(member, expect.anything());
});
});
});