OpenCloud
/
element-web
mirror of https://github.com/vector-im/element-web
1
0
Fork 0
Code Issues Releases Wiki Activity

Add developer tools option to room list context menu (#10635) 

* Make developer tools more accessible

* Extend tests

* Use settings hook

* Trigger CI
pull/28788/head^2
Michael Weimann 2023-04-19 13:34:27 +02:00 committed by GitHub
parent 957945b356
commit 83e6a6057d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 126 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
res/css/views/context_menus/_IconizedContextMenu.pcss
View File

@ -1,5 +1,5 @@
/*
Copyright 2020 The Matrix.org Foundation C.I.C.
Copyright 2020 - 2023 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -180,6 +180,10 @@ limitations under the License.
margin-right: -5px;
}
.mx_IconizedContextMenu_developerTools::before {
mask-image: url("$(res)/img/element-icons/settings/flask.svg");
}
.mx_IconizedContextMenu_checked::before {
mask-image: url("$(res)/img/element-icons/roomlist/checkmark.svg");
}

6
res/css/views/rooms/_RoomTile.pcss
View File

@ -1,5 +1,5 @@
/*
Copyright 2020 The Matrix.org Foundation C.I.C.
Copyright 2020 - 2023 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -235,10 +235,6 @@ limitations under the License.
mask-image: url("$(res)/img/element-icons/export.svg");
}
.mx_RoomTile_iconDeveloperTools::before {
mask-image: url("$(res)/img/element-icons/settings/flask.svg");
}
.mx_RoomTile_iconCopyLink::before {
mask-image: url("$(res)/img/element-icons/link.svg");
}

47
src/components/views/context_menus/DeveloperToolsOption.tsx Normal file
View File

@ -0,0 +1,47 @@
/*
Copyright 2023 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import React from "react";
import Modal from "../../../Modal";
import DevtoolsDialog from "../dialogs/DevtoolsDialog";
import { IconizedContextMenuOption } from "./IconizedContextMenu";
import { _t } from "../../../languageHandler";
interface Props {
onFinished: () => void;
roomId: string;
}
export const DeveloperToolsOption: React.FC<Props> = ({ onFinished, roomId }) => {
return (
<IconizedContextMenuOption
onClick={() => {
Modal.createDialog(
DevtoolsDialog,
{
onFinished: () => {},
roomId: roomId,
},
"mx_DevtoolsDialog_wrapper",
);
onFinished();
}}
label={_t("Developer tools")}
iconClassName="mx_IconizedContextMenu_developerTools"
/>
);
};

25
src/components/views/context_menus/RoomContextMenu.tsx
View File

@ -1,5 +1,5 @@
/*
Copyright 2021 The Matrix.org Foundation C.I.C.
Copyright 2021 - 2023 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -48,15 +48,18 @@ import { ViewRoomPayload } from "../../../dispatcher/payloads/ViewRoomPayload";
import { getKeyBindingsManager } from "../../../KeyBindingsManager";
import { KeyBindingAction } from "../../../accessibility/KeyboardShortcuts";
import SettingsStore from "../../../settings/SettingsStore";
import DevtoolsDialog from "../dialogs/DevtoolsDialog";
import { SdkContextClass } from "../../../contexts/SDKContext";
import { shouldShowComponent } from "../../../customisations/helpers/UIComponents";
import { UIComponent } from "../../../settings/UIFeature";
import { DeveloperToolsOption } from "./DeveloperToolsOption";
interface IProps extends IContextMenuProps {
room: Room;
}
/**
* Room context menu accessible via the room header.
*/
const RoomContextMenu: React.FC<IProps> = ({ room, onFinished, ...props }) => {
const cli = useContext(MatrixClientContext);
const roomTags = useEventEmitterState(RoomListStore.instance, LISTS_UPDATE_EVENT, () =>
@ -393,23 +396,7 @@ const RoomContextMenu: React.FC<IProps> = ({ room, onFinished, ...props }) => {
{exportChatOption}
{SettingsStore.getValue("developerMode") && (
<IconizedContextMenuOption
onClick={(ev: ButtonEvent) => {
ev.preventDefault();
ev.stopPropagation();
Modal.createDialog(
DevtoolsDialog,
{
roomId: room.roomId,
},
"mx_DevtoolsDialog_wrapper",
);
onFinished();
}}
label={_t("Developer tools")}
iconClassName="mx_RoomTile_iconDeveloperTools"
/>
<DeveloperToolsOption onFinished={onFinished} roomId={room.roomId} />
)}
{leaveOption}

13
src/components/views/context_menus/RoomGeneralContextMenu.tsx
View File

@ -1,5 +1,5 @@
/*
Copyright 2021 The Matrix.org Foundation C.I.C.
Copyright 2021 - 2023 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -40,6 +40,8 @@ import IconizedContextMenu, {
import { ButtonEvent } from "../elements/AccessibleButton";
import { shouldShowComponent } from "../../../customisations/helpers/UIComponents";
import { UIComponent } from "../../../settings/UIFeature";
import { DeveloperToolsOption } from "./DeveloperToolsOption";
import { useSettingValue } from "../../../hooks/useSettings";
export interface RoomGeneralContextMenuProps extends IContextMenuProps {
room: Room;
@ -52,6 +54,9 @@ export interface RoomGeneralContextMenuProps extends IContextMenuProps {
onPostLeaveClick?: (event: ButtonEvent) => void;
}
/**
* Room context menu accessible via the room list.
*/
export const RoomGeneralContextMenu: React.FC<RoomGeneralContextMenuProps> = ({
room,
onFinished,
@ -221,6 +226,11 @@ export const RoomGeneralContextMenu: React.FC<RoomGeneralContextMenuProps> = ({
/>
) : null;
const developerModeEnabled = useSettingValue<boolean>("developerMode");
const developerToolsOption = developerModeEnabled ? (
<DeveloperToolsOption onFinished={onFinished} roomId={room.roomId} />
) : null;
return (
<IconizedContextMenu {...props} onFinished={onFinished} className="mx_RoomGeneralContextMenu" compact>
<IconizedContextMenuOptionList>
@ -234,6 +244,7 @@ export const RoomGeneralContextMenu: React.FC<RoomGeneralContextMenuProps> = ({
{settingsOption}
</>
)}
{developerToolsOption}
</IconizedContextMenuOptionList>
<IconizedContextMenuOptionList red>{leaveOption}</IconizedContextMenuOptionList>
</IconizedContextMenu>

2
src/components/views/settings/tabs/user/HelpUserSettingsTab.tsx
View File

@ -1,5 +1,5 @@
/*
Copyright 2019 - 2022 The Matrix.org Foundation C.I.C.
Copyright 2019 - 2023 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.

26
test/components/views/context_menus/RoomContextMenu-test.tsx
View File

@ -1,6 +1,7 @@
/*
Copyright 2023 Mikhail Aheichyk
Copyright 2023 Nordeck IT + Consulting GmbH.
Copyright 2023 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -27,6 +28,7 @@ import { shouldShowComponent } from "../../../../src/customisations/helpers/UICo
import { stubClient } from "../../../test-utils";
import { MatrixClientPeg } from "../../../../src/MatrixClientPeg";
import DMRoomMap from "../../../../src/utils/DMRoomMap";
import SettingsStore from "../../../../src/settings/SettingsStore";
jest.mock("../../../../src/customisations/helpers/UIComponents", () => ({
shouldShowComponent: jest.fn(),
@ -58,8 +60,8 @@ describe("RoomContextMenu", () => {
onFinished = jest.fn();
});
function getComponent(props: Partial<ComponentProps<typeof RoomContextMenu>> = {}) {
return render(
function renderComponent(props: Partial<ComponentProps<typeof RoomContextMenu>> = {}) {
render(
<MatrixClientContext.Provider value={mockClient}>
<RoomContextMenu room={room} onFinished={onFinished} {...props} />
</MatrixClientContext.Provider>,
@ -70,7 +72,7 @@ describe("RoomContextMenu", () => {
jest.spyOn(room, "canInvite").mockReturnValue(true);
mocked(shouldShowComponent).mockReturnValue(false);
getComponent();
renderComponent();
expect(screen.queryByRole("menuitem", { name: "Invite" })).not.toBeInTheDocument();
});
@ -79,8 +81,24 @@ describe("RoomContextMenu", () => {
jest.spyOn(room, "canInvite").mockReturnValue(true);
mocked(shouldShowComponent).mockReturnValue(true);
getComponent();
renderComponent();
expect(screen.getByRole("menuitem", { name: "Invite" })).toBeInTheDocument();
});
it("when developer mode is disabled, it should not render the developer tools option", () => {
renderComponent();
expect(screen.queryByText("Developer tools")).not.toBeInTheDocument();
});
describe("when developer mode is enabled", () => {
beforeEach(() => {
jest.spyOn(SettingsStore, "getValue").mockImplementation((setting) => setting === "developerMode");
});
it("should render the developer tools option", () => {
renderComponent();
expect(screen.getByText("Developer tools")).toBeInTheDocument();
});
});
});

33
test/components/views/context_menus/RoomGeneralContextMenu-test.tsx
View File

@ -1,5 +1,5 @@
/*
Copyright 2022 The Matrix.org Foundation C.I.C.
Copyright 2022 - 2023 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -20,6 +20,7 @@ import { ReceiptType } from "matrix-js-sdk/src/@types/read_receipts";
import { MatrixClient, PendingEventOrdering } from "matrix-js-sdk/src/client";
import { Room } from "matrix-js-sdk/src/models/room";
import React from "react";
import userEvent from "@testing-library/user-event";
import { ChevronFace } from "../../../../src/components/structures/ContextMenu";
import {
@ -34,6 +35,8 @@ import DMRoomMap from "../../../../src/utils/DMRoomMap";
import { mkMessage, stubClient } from "../../../test-utils/test-utils";
import { shouldShowComponent } from "../../../../src/customisations/helpers/UIComponents";
import { UIComponent } from "../../../../src/settings/UIFeature";
import SettingsStore from "../../../../src/settings/SettingsStore";
import Modal from "../../../../src/Modal";
jest.mock("../../../../src/customisations/helpers/UIComponents", () => ({
shouldShowComponent: jest.fn(),
@ -87,6 +90,10 @@ describe("RoomGeneralContextMenu", () => {
onFinished = jest.fn();
});
afterEach(() => {
Modal.closeCurrentModal("force");
});
it("renders an empty context menu for archived rooms", async () => {
jest.spyOn(RoomListStore.instance, "getTagsForRoom").mockReturnValueOnce([DefaultTagID.Archived]);
@ -138,4 +145,28 @@ describe("RoomGeneralContextMenu", () => {
expect(mockClient.sendReadReceipt).toHaveBeenCalledWith(event, ReceiptType.Read, true);
expect(onFinished).toHaveBeenCalled();
});
it("when developer mode is disabled, it should not render the developer tools option", () => {
getComponent();
expect(screen.queryByText("Developer tools")).not.toBeInTheDocument();
});
describe("when developer mode is enabled", () => {
beforeEach(() => {
jest.spyOn(SettingsStore, "getValue").mockImplementation((setting) => setting === "developerMode");
getComponent();
});
it("should render the developer tools option", async () => {
const developerToolsItem = screen.getByRole("menuitem", { name: "Developer tools" });
expect(developerToolsItem).toBeInTheDocument();
// click open developer tools dialog
await userEvent.click(developerToolsItem);
// assert that the dialog is displayed by searching some if its contents
expect(await screen.findByText("Toolbox")).toBeInTheDocument();
expect(await screen.findByText(`Room ID: ${ROOM_ID}`)).toBeInTheDocument();
});
});
});