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

Update room summary card header (#11823)

Browse source 
* Update room summary card header

* test coverage for public room label

* test coverage for public room label (#11841)

* fix encrypted badge selector in cypress/crypto.spec

---------

Co-authored-by: Kerry <kerrya@element.io>
This commit is contained in:
Germain 2023-11-11 07:24:48 +00:00 • committed by GitHub
parent 5c9e7baa78
commit 722c5ad493
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 201 additions and 140 deletions
Download patch file Download diff file Expand all files Collapse all files

2
cypress/e2e/crypto/crypto.spec.ts
View file

@ -269,7 +269,7 @@ describe("Cryptography", function () {
// Assert that verified icon is rendered // Assert that verified icon is rendered
cy.findByRole("button", { name: "Room members" }).click(); cy.findByRole("button", { name: "Room members" }).click();
cy.findByRole("button", { name: "Room information" }).click(); cy.findByRole("button", { name: "Room information" }).click();
cy.get(".mx_RoomSummaryCard_e2ee_verified").should("exist"); cy.get('.mx_RoomSummaryCard_badges [data-kind="success"]').should("contain.text", "Encrypted");
// Take a snapshot of RoomSummaryCard with a verified E2EE icon // Take a snapshot of RoomSummaryCard with a verified E2EE icon
cy.get(".mx_RightPanel").percySnapshotElement("RoomSummaryCard - with a verified E2EE icon", { cy.get(".mx_RightPanel").percySnapshotElement("RoomSummaryCard - with a verified E2EE icon", {

60
res/css/views/right_panel/_RoomSummaryCard.pcss
View file

@ -31,68 +31,12 @@ limitations under the License.
.mx_RoomSummaryCard_roomName { .mx_RoomSummaryCard_roomName {
margin: $spacing-12 0 $spacing-4; margin: $spacing-12 0 $spacing-4;
font-weight: var(--cpd-font-weight-semibold);
font-size: $font-17px;
} }
.mx_RoomSummaryCard_alias { .mx_RoomSummaryCard_alias {
font: var(--cpd-font-body-md-regular);
color: $secondary-content;
text-overflow: ellipsis; text-overflow: ellipsis;
} }
.mx_RoomSummaryCard_avatar {
display: flex;
justify-content: center;
align-items: center;
.mx_RoomSummaryCard_e2ee {
display: inline-block;
position: relative;
width: 54px;
height: 54px;
border-radius: 50%;
background-color: #737d8c;
margin-left: -10px; /* overlap */
border: 3px solid $dark-panel-bg-color;
&::before {
content: "";
position: absolute;
top: 13px;
left: 13px;
height: 28px;
width: 28px;
mask-size: cover;
mask-repeat: no-repeat;
mask-position: center;
mask-image: url("$(res)/img/e2e/disabled.svg");
background-color: #ffffff;
}
}
.mx_RoomSummaryCard_e2ee_normal {
background-color: #424446;
&::before {
mask-image: url("$(res)/img/e2e/normal.svg");
}
}
.mx_RoomSummaryCard_e2ee_verified {
background-color: $e2e-verified-color;
&::before {
mask-image: url("$(res)/img/e2e/verified.svg");
}
}
.mx_RoomSummaryCard_e2ee_warning {
background-color: $e2e-warning-color;
&::before {
mask-image: url("$(res)/img/e2e/warning.svg");
}
}
}
.mx_RoomSummaryCard_aboutGroup { .mx_RoomSummaryCard_aboutGroup {
.mx_RoomSummaryCard_Button { .mx_RoomSummaryCard_Button {
padding-left: 44px; padding-left: 44px;
@ -244,6 +188,10 @@ limitations under the License.
} }
} }
.mx_RoomSummaryCard_badges {
margin: var(--cpd-space-4x) 0;
}
.mx_RoomSummaryCard_header { .mx_RoomSummaryCard_header {
padding: 15px 12px; padding: 15px 12px;

86
src/components/views/right_panel/RoomSummaryCard.tsx
View file

@ -16,9 +16,13 @@ limitations under the License.
import React, { useCallback, useContext, useEffect, useMemo, useState } from "react"; import React, { useCallback, useContext, useEffect, useMemo, useState } from "react";
import classNames from "classnames"; import classNames from "classnames";
import { Room } from "matrix-js-sdk/src/matrix"; import { EventType, JoinRule, Room } from "matrix-js-sdk/src/matrix";
import { Tooltip } from "@vector-im/compound-web"; import { Badge, Heading, Text, Tooltip } from "@vector-im/compound-web";
import { Icon as SearchIcon } from "@vector-im/compound-design-tokens/icons/search.svg"; import { Icon as SearchIcon } from "@vector-im/compound-design-tokens/icons/search.svg";
import { Icon as LockIcon } from "@vector-im/compound-design-tokens/icons/lock.svg";
import { Icon as LockOffIcon } from "@vector-im/compound-design-tokens/icons/lock-off.svg";
import { Icon as PublicIcon } from "@vector-im/compound-design-tokens/icons/public.svg";
import { Icon as ErrorIcon } from "@vector-im/compound-design-tokens/icons/error.svg";
import MatrixClientContext from "../../../contexts/MatrixClientContext"; import MatrixClientContext from "../../../contexts/MatrixClientContext";
import { useIsEncrypted } from "../../../hooks/useIsEncrypted"; import { useIsEncrypted } from "../../../hooks/useIsEncrypted";
@ -34,7 +38,6 @@ import { useEventEmitter } from "../../../hooks/useEventEmitter";
import WidgetUtils from "../../../utils/WidgetUtils"; import WidgetUtils from "../../../utils/WidgetUtils";
import { IntegrationManagers } from "../../../integrations/IntegrationManagers"; import { IntegrationManagers } from "../../../integrations/IntegrationManagers";
import SettingsStore from "../../../settings/SettingsStore"; import SettingsStore from "../../../settings/SettingsStore";
import TextWithTooltip from "../elements/TextWithTooltip";
import WidgetAvatar from "../avatars/WidgetAvatar"; import WidgetAvatar from "../avatars/WidgetAvatar";
import AccessibleTooltipButton from "../elements/AccessibleTooltipButton"; import AccessibleTooltipButton from "../elements/AccessibleTooltipButton";
import WidgetStore, { IApp } from "../../../stores/WidgetStore"; import WidgetStore, { IApp } from "../../../stores/WidgetStore";
@ -56,6 +59,8 @@ import PosthogTrackers from "../../../PosthogTrackers";
import { shouldShowComponent } from "../../../customisations/helpers/UIComponents"; import { shouldShowComponent } from "../../../customisations/helpers/UIComponents";
import { PollHistoryDialog } from "../dialogs/PollHistoryDialog"; import { PollHistoryDialog } from "../dialogs/PollHistoryDialog";
import { Flex } from "../../utils/Flex"; import { Flex } from "../../utils/Flex";
import { useAccountData } from "../../../hooks/useAccountData";
import { useRoomState } from "../../../hooks/useRoomState";
interface IProps { interface IProps {
room: Room; room: Room;
@ -307,31 +312,74 @@ const RoomSummaryCard: React.FC<IProps> = ({ room, permalinkCreator, onClose, on
const isVideoRoom = const isVideoRoom =
videoRoomsEnabled && (room.isElementVideoRoom() || (elementCallVideoRoomsEnabled && room.isCallRoom())); videoRoomsEnabled && (room.isElementVideoRoom() || (elementCallVideoRoomsEnabled && room.isCallRoom()));
const roomState = useRoomState(room);
const directRoomsList = useAccountData<Record<string, string[]>>(room.client, EventType.Direct);
const [isDirectMessage, setDirectMessage] = useState(false);
useEffect(() => {
for (const [, dmRoomList] of Object.entries(directRoomsList)) {
if (dmRoomList.includes(room?.roomId ?? "")) {
setDirectMessage(true);
break;
}
}
}, [room, directRoomsList]);
const alias = room.getCanonicalAlias() || room.getAltAliases()[0] || ""; const alias = room.getCanonicalAlias() || room.getAltAliases()[0] || "";
const header = ( const header = (
<header className="mx_RoomSummaryCard_container"> <header className="mx_RoomSummaryCard_container">
<div className="mx_RoomSummaryCard_avatar" role="presentation"> <RoomAvatar room={room} size="80px" viewAvatarOnClick />
<RoomAvatar room={room} size="54px" viewAvatarOnClick />
<TextWithTooltip
tooltip={isRoomEncrypted ? _t("common|encrypted") : _t("common|unencrypted")}
class={classNames("mx_RoomSummaryCard_e2ee", {
mx_RoomSummaryCard_e2ee_normal: isRoomEncrypted,
mx_RoomSummaryCard_e2ee_warning: isRoomEncrypted && e2eStatus === E2EStatus.Warning,
mx_RoomSummaryCard_e2ee_verified: isRoomEncrypted && e2eStatus === E2EStatus.Verified,
})}
/>
</div>
<RoomName room={room}> <RoomName room={room}>
{(name) => ( {(name) => (
<h1 className="mx_RoomSummaryCard_roomName" title={name}> <Heading
as="h1"
size="md"
weight="semibold"
className="mx_RoomSummaryCard_roomName text-primary"
title={name}
>
{name} {name}
</h1> </Heading>
)} )}
</RoomName> </RoomName>
<div className="mx_RoomSummaryCard_alias" title={alias}> <Text
as="div"
size="sm"
weight="semibold"
className="mx_RoomSummaryCard_alias text-secondary"
title={alias}
>
{alias} {alias}
</div> </Text>
<Flex as="section" justify="center" gap="var(--cpd-space-2x)" className="mx_RoomSummaryCard_badges">
{!isDirectMessage && roomState.getJoinRule() === JoinRule.Public && (
<Badge kind="default">
<PublicIcon width="1em" />
{_t("common|public_room")}
</Badge>
)}
{isRoomEncrypted && e2eStatus !== E2EStatus.Warning && (
<Badge kind="success">
<LockIcon width="1em" />
{_t("common|encrypted")}
</Badge>
)}
{!e2eStatus && (
<Badge kind="default">
<LockOffIcon width="1em" />
{_t("common|unencrypted")}
</Badge>
)}
{e2eStatus === E2EStatus.Warning && (
<Badge kind="critical">
<ErrorIcon width="1em" />
{_t("common|not_trusted")}
</Badge>
)}
</Flex>
</header> </header>
); );

149
test/components/views/right_panel/RoomSummaryCard-test.tsx
View file

@ -15,8 +15,9 @@ limitations under the License.
*/ */
import React from "react"; import React from "react";
import { render, fireEvent } from "@testing-library/react"; import { render, fireEvent, screen } from "@testing-library/react";
import { MatrixEvent, Room } from "matrix-js-sdk/src/matrix"; import { EventType, MatrixEvent, Room, MatrixClient, JoinRule } from "matrix-js-sdk/src/matrix";
import { mocked, MockedObject } from "jest-mock";
import DMRoomMap from "../../../../src/utils/DMRoomMap"; import DMRoomMap from "../../../../src/utils/DMRoomMap";
import RoomSummaryCard from "../../../../src/components/views/right_panel/RoomSummaryCard"; import RoomSummaryCard from "../../../../src/components/views/right_panel/RoomSummaryCard";
@ -28,56 +29,67 @@ import * as settingsHooks from "../../../../src/hooks/useSettings";
import Modal from "../../../../src/Modal"; import Modal from "../../../../src/Modal";
import RightPanelStore from "../../../../src/stores/right-panel/RightPanelStore"; import RightPanelStore from "../../../../src/stores/right-panel/RightPanelStore";
import { RightPanelPhases } from "../../../../src/stores/right-panel/RightPanelStorePhases"; import { RightPanelPhases } from "../../../../src/stores/right-panel/RightPanelStorePhases";
import { getMockClientWithEventEmitter, mockClientMethodsUser } from "../../../test-utils"; import { flushPromises, getMockClientWithEventEmitter, mockClientMethodsUser } from "../../../test-utils";
import { PollHistoryDialog } from "../../../../src/components/views/dialogs/PollHistoryDialog"; import { PollHistoryDialog } from "../../../../src/components/views/dialogs/PollHistoryDialog";
import { RoomPermalinkCreator } from "../../../../src/utils/permalinks/Permalinks"; import { RoomPermalinkCreator } from "../../../../src/utils/permalinks/Permalinks";
import { _t } from "../../../../src/languageHandler"; import { _t } from "../../../../src/languageHandler";
describe("<RoomSummaryCard />", () => { describe("<RoomSummaryCard />", () => {
const userId = "@alice:domain.org"; const userId = "@alice:domain.org";
const mockClient = getMockClientWithEventEmitter({
...mockClientMethodsUser(userId),
isRoomEncrypted: jest.fn(),
getRoom: jest.fn(),
});
const roomId = "!room:domain.org"; const roomId = "!room:domain.org";
const room = new Room(roomId, mockClient, userId); let mockClient!: MockedObject<MatrixClient>;
const roomCreateEvent = new MatrixEvent({ let room!: Room;
type: "m.room.create",
room_id: roomId, const getComponent = (props = {}) => {
sender: userId, const defaultProps = {
content: { room,
creator: userId, onClose: jest.fn(),
room_version: "5", permalinkCreator: new RoomPermalinkCreator(room),
}, };
state_key: "",
}); return render(<RoomSummaryCard {...defaultProps} {...props} />, {
room.currentState.setStateEvents([roomCreateEvent]);
const defaultProps = {
room,
onClose: jest.fn(),
permalinkCreator: new RoomPermalinkCreator(room),
};
const getComponent = (props = {}) =>
render(<RoomSummaryCard {...defaultProps} {...props} />, {
wrapper: ({ children }) => ( wrapper: ({ children }) => (
<MatrixClientContext.Provider value={mockClient}>{children}</MatrixClientContext.Provider> <MatrixClientContext.Provider value={mockClient}>{children}</MatrixClientContext.Provider>
), ),
}); });
};
const modalSpy = jest.spyOn(Modal, "createDialog");
const dispatchSpy = jest.spyOn(defaultDispatcher, "dispatch");
const rightPanelCardSpy = jest.spyOn(RightPanelStore.instance, "pushCard");
const featureEnabledSpy = jest.spyOn(settingsHooks, "useFeatureEnabled");
beforeEach(() => { beforeEach(() => {
mockClient = getMockClientWithEventEmitter({
...mockClientMethodsUser(userId),
getAccountData: jest.fn(),
isRoomEncrypted: jest.fn(),
getOrCreateFilter: jest.fn().mockResolvedValue({ filterId: 1 }),
getRoom: jest.fn(),
});
room = new Room(roomId, mockClient, userId);
const roomCreateEvent = new MatrixEvent({
type: "m.room.create",
room_id: roomId,
sender: userId,
content: {
creator: userId,
room_version: "5",
},
state_key: "",
});
room.currentState.setStateEvents([roomCreateEvent]);
jest.spyOn(Modal, "createDialog");
jest.spyOn(RightPanelStore.instance, "pushCard");
jest.spyOn(settingsHooks, "useFeatureEnabled").mockReturnValue(false);
jest.spyOn(defaultDispatcher, "dispatch");
jest.clearAllMocks(); jest.clearAllMocks();
DMRoomMap.makeShared(mockClient); DMRoomMap.makeShared(mockClient);
mockClient.getRoom.mockReturnValue(room); mockClient.getRoom.mockReturnValue(room);
jest.spyOn(room, "isElementVideoRoom").mockRestore(); jest.spyOn(room, "isElementVideoRoom").mockRestore();
jest.spyOn(room, "isCallRoom").mockRestore(); jest.spyOn(room, "isCallRoom").mockRestore();
featureEnabledSpy.mockReset().mockReturnValue(false); });
afterEach(() => {
jest.restoreAllMocks();
}); });
it("renders the room summary", () => { it("renders the room summary", () => {
@ -101,7 +113,10 @@ describe("<RoomSummaryCard />", () => {
fireEvent.click(getByText("People")); fireEvent.click(getByText("People"));
expect(rightPanelCardSpy).toHaveBeenCalledWith({ phase: RightPanelPhases.RoomMemberList }, true); expect(RightPanelStore.instance.pushCard).toHaveBeenCalledWith(
{ phase: RightPanelPhases.RoomMemberList },
true,
);
}); });
it("opens room file panel on button click", () => { it("opens room file panel on button click", () => {
@ -109,7 +124,7 @@ describe("<RoomSummaryCard />", () => {
fireEvent.click(getByText("Files")); fireEvent.click(getByText("Files"));
expect(rightPanelCardSpy).toHaveBeenCalledWith({ phase: RightPanelPhases.FilePanel }, true); expect(RightPanelStore.instance.pushCard).toHaveBeenCalledWith({ phase: RightPanelPhases.FilePanel }, true);
}); });
it("opens room export dialog on button click", () => { it("opens room export dialog on button click", () => {
@ -117,7 +132,7 @@ describe("<RoomSummaryCard />", () => {
fireEvent.click(getByText("Export chat")); fireEvent.click(getByText("Export chat"));
expect(modalSpy).toHaveBeenCalledWith(ExportDialog, { room }); expect(Modal.createDialog).toHaveBeenCalledWith(ExportDialog, { room });
}); });
it("opens share room dialog on button click", () => { it("opens share room dialog on button click", () => {
@ -125,7 +140,7 @@ describe("<RoomSummaryCard />", () => {
fireEvent.click(getByText("Share room")); fireEvent.click(getByText("Share room"));
expect(modalSpy).toHaveBeenCalledWith(ShareDialog, { target: room }); expect(Modal.createDialog).toHaveBeenCalledWith(ShareDialog, { target: room });
}); });
it("opens room settings on button click", () => { it("opens room settings on button click", () => {
@ -133,12 +148,12 @@ describe("<RoomSummaryCard />", () => {
fireEvent.click(getByText("Room settings")); fireEvent.click(getByText("Room settings"));
expect(dispatchSpy).toHaveBeenCalledWith({ action: "open_room_settings" }); expect(defaultDispatcher.dispatch).toHaveBeenCalledWith({ action: "open_room_settings" });
}); });
describe("pinning", () => { describe("pinning", () => {
it("renders pins options when pinning feature is enabled", () => { it("renders pins options when pinning feature is enabled", () => {
featureEnabledSpy.mockImplementation((feature) => feature === "feature_pinning"); mocked(settingsHooks.useFeatureEnabled).mockImplementation((feature) => feature === "feature_pinning");
const { getByText } = getComponent(); const { getByText } = getComponent();
expect(getByText("Pinned")).toBeInTheDocument(); expect(getByText("Pinned")).toBeInTheDocument();
@ -153,14 +168,15 @@ describe("<RoomSummaryCard />", () => {
}); });
it("opens poll history dialog on button click", () => { it("opens poll history dialog on button click", () => {
const { getByText } = getComponent(); const permalinkCreator = new RoomPermalinkCreator(room);
const { getByText } = getComponent({ permalinkCreator });
fireEvent.click(getByText("Poll history")); fireEvent.click(getByText("Poll history"));
expect(modalSpy).toHaveBeenCalledWith(PollHistoryDialog, { expect(Modal.createDialog).toHaveBeenCalledWith(PollHistoryDialog, {
room, room,
matrixClient: mockClient, matrixClient: mockClient,
permalinkCreator: defaultProps.permalinkCreator, permalinkCreator: permalinkCreator,
}); });
}); });
}); });
@ -168,7 +184,7 @@ describe("<RoomSummaryCard />", () => {
describe("video rooms", () => { describe("video rooms", () => {
it("does not render irrelevant options for element video room", () => { it("does not render irrelevant options for element video room", () => {
jest.spyOn(room, "isElementVideoRoom").mockReturnValue(true); jest.spyOn(room, "isElementVideoRoom").mockReturnValue(true);
featureEnabledSpy.mockImplementation( mocked(settingsHooks.useFeatureEnabled).mockImplementation(
(feature) => feature === "feature_video_rooms" || feature === "feature_pinning", (feature) => feature === "feature_video_rooms" || feature === "feature_pinning",
); );
const { queryByText } = getComponent(); const { queryByText } = getComponent();
@ -181,7 +197,7 @@ describe("<RoomSummaryCard />", () => {
it("does not render irrelevant options for element call room", () => { it("does not render irrelevant options for element call room", () => {
jest.spyOn(room, "isCallRoom").mockReturnValue(true); jest.spyOn(room, "isCallRoom").mockReturnValue(true);
featureEnabledSpy.mockImplementation( mocked(settingsHooks.useFeatureEnabled).mockImplementation(
(feature) => (feature) =>
feature === "feature_element_call_video_rooms" || feature === "feature_element_call_video_rooms" ||
feature === "feature_video_rooms" || feature === "feature_video_rooms" ||
@ -195,4 +211,49 @@ describe("<RoomSummaryCard />", () => {
expect(queryByText("Export chat")).not.toBeInTheDocument(); expect(queryByText("Export chat")).not.toBeInTheDocument();
}); });
}); });
describe("public room label", () => {
beforeEach(() => {
jest.spyOn(room.currentState, "getJoinRule").mockReturnValue(JoinRule.Public);
});
it("does not show public room label for a DM", async () => {
mockClient.getAccountData.mockImplementation(
(eventType) =>
({
[EventType.Direct]: new MatrixEvent({
type: EventType.Direct,
content: {
"@bob:sesame.st": ["some-room-id"],
// this room is a DM with ernie
"@ernie:sesame.st": ["some-other-room-id", room.roomId],
},
}),
}[eventType]),
);
getComponent();
await flushPromises();
expect(screen.queryByText("Public room")).not.toBeInTheDocument();
});
it("does not show public room label for non public room", async () => {
jest.spyOn(room.currentState, "getJoinRule").mockReturnValue(JoinRule.Invite);
getComponent();
await flushPromises();
expect(screen.queryByText("Public room")).not.toBeInTheDocument();
});
it("shows a public room label for a public room", async () => {
jest.spyOn(room.currentState, "getJoinRule").mockReturnValue(JoinRule.Public);
getComponent();
await flushPromises();
expect(screen.queryByText("Public room")).toBeInTheDocument();
});
});
}); });

44
test/components/views/right_panel/__snapshots__/RoomSummaryCard-test.tsx.snap
View file

@ -35,36 +35,40 @@ exports[`<RoomSummaryCard /> renders the room summary 1`] = `
<header <header
class="mx_RoomSummaryCard_container" class="mx_RoomSummaryCard_container"
> >
<div <span
class="mx_RoomSummaryCard_avatar" class="_avatar_1o69u_17 mx_BaseAvatar _avatar-imageless_1o69u_60"
data-color="7"
data-testid="avatar-img"
data-type="round"
role="presentation" role="presentation"
style="--cpd-avatar-size: 80px;"
> >
<span !
class="_avatar_1o69u_17 mx_BaseAvatar _avatar-imageless_1o69u_60" </span>
data-color="7"
data-testid="avatar-img"
data-type="round"
role="presentation"
style="--cpd-avatar-size: 54px;"
>
!
</span>
<div
aria-describedby="mx_TooltipTarget_vY7Q4uEh"
class="mx_TextWithTooltip_target mx_RoomSummaryCard_e2ee"
tabindex="0"
/>
</div>
<h1 <h1
class="mx_RoomSummaryCard_roomName" class="_font-heading-md-semibold_1jx6b_121 mx_RoomSummaryCard_roomName text-primary"
title="!room:domain.org" title="!room:domain.org"
> >
!room:domain.org !room:domain.org
</h1> </h1>
<div <div
class="mx_RoomSummaryCard_alias" class="_font-body-sm-semibold_1jx6b_45 mx_RoomSummaryCard_alias text-secondary"
title="" title=""
/> />
<section
class="mx_Flex mx_RoomSummaryCard_badges"
style="--mx-flex-display: flex; --mx-flex-direction: row; --mx-flex-align: start; --mx-flex-justify: center; --mx-flex-gap: var(--cpd-space-2x);"
>
<span
class="_font-body-sm-medium_1jx6b_50 _badge_qipht_17"
data-kind="default"
>
<div
width="1em"
/>
Not encrypted
</span>
</section>
</header> </header>
<div <div
class="mx_BaseCard_Group mx_RoomSummaryCard_aboutGroup" class="mx_BaseCard_Group mx_RoomSummaryCard_aboutGroup"