From a332a0b02a6c3253ea7ac606211c41a09c409de5 Mon Sep 17 00:00:00 2001 From: Mikhail Aheichyk Date: Tue, 14 Mar 2023 10:10:41 +0300 Subject: [PATCH 1/4] Show room create button in RoomSublist if "UIComponent.roomCreation" is enabled Signed-off-by: Mikhail Aheichyk --- src/components/views/rooms/RoomSublist.tsx | 4 +- .../views/rooms/RoomSublist-test.tsx | 73 +++++++++++++++++++ 2 files changed, 76 insertions(+), 1 deletion(-) create mode 100644 test/components/views/rooms/RoomSublist-test.tsx diff --git a/src/components/views/rooms/RoomSublist.tsx b/src/components/views/rooms/RoomSublist.tsx index 6e471dde428..bdeed9934e4 100644 --- a/src/components/views/rooms/RoomSublist.tsx +++ b/src/components/views/rooms/RoomSublist.tsx @@ -55,6 +55,8 @@ import SettingsStore from "../../../settings/SettingsStore"; import { SlidingSyncManager } from "../../../SlidingSyncManager"; import NotificationBadge from "./NotificationBadge"; import RoomTile from "./RoomTile"; +import { shouldShowComponent } from "../../../customisations/helpers/UIComponents"; +import { UIComponent } from "../../../settings/UIFeature"; const SHOW_N_BUTTON_HEIGHT = 28; // As defined by CSS const RESIZE_HANDLE_HEIGHT = 4; // As defined by CSS @@ -661,7 +663,7 @@ export default class RoomSublist extends React.Component { ); let addRoomButton: JSX.Element | undefined; - if (this.props.AuxButtonComponent) { + if (this.props.AuxButtonComponent && shouldShowComponent(UIComponent.CreateRooms)) { const AuxButtonComponent = this.props.AuxButtonComponent; addRoomButton = ; } diff --git a/test/components/views/rooms/RoomSublist-test.tsx b/test/components/views/rooms/RoomSublist-test.tsx new file mode 100644 index 00000000000..60d8cffa23c --- /dev/null +++ b/test/components/views/rooms/RoomSublist-test.tsx @@ -0,0 +1,73 @@ +/* +Copyright 2023 Mikhail Aheichyk +Copyright 2023 Nordeck IT + Consulting GmbH. + +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 { render, RenderResult, screen } from "@testing-library/react"; +import { ComponentProps } from "react"; +import React from "react"; +import { EventEmitter } from "events"; +import { mocked } from "jest-mock"; + +import RoomSublist, { IAuxButtonProps } from "../../../../src/components/views/rooms/RoomSublist"; +import { DefaultTagID } from "../../../../src/stores/room-list/models"; +import ResizeNotifier from "../../../../src/utils/ResizeNotifier"; +import AccessibleButton from "../../../../src/components/views/elements/AccessibleButton"; +import { shouldShowComponent } from "../../../../src/customisations/helpers/UIComponents"; +import { UIComponent } from "../../../../src/settings/UIFeature"; + +jest.mock("../../../../src/customisations/helpers/UIComponents", () => ({ + shouldShowComponent: jest.fn(), +})); + +const AuxButton: React.FC = ({ tabIndex }) => { + return Add room; +}; + +describe("RoomSublist", () => { + function renderComponent(props: Partial> = {}): RenderResult { + return render( + , + ); + } + + it("does not render when UIComponent customisations disable room creation", () => { + mocked(shouldShowComponent).mockReturnValue(false); + + renderComponent(); + + expect(shouldShowComponent).toHaveBeenCalledWith(UIComponent.CreateRooms); + expect(screen.queryByRole("button", { name: "Add room" })).not.toBeInTheDocument(); + }); + + it("renders when UIComponent customisations enable room creation", () => { + mocked(shouldShowComponent).mockReturnValue(true); + + renderComponent(); + + expect(shouldShowComponent).toHaveBeenCalledWith(UIComponent.CreateRooms); + expect(screen.getByRole("button", { name: "Add room" })).toBeInTheDocument(); + }); +}); From ac1ea8e47ae5fe95b0e45b296dad843a51938811 Mon Sep 17 00:00:00 2001 From: Mikhail Aheichyk Date: Fri, 17 Mar 2023 18:00:58 +0300 Subject: [PATCH 2/4] Revert "Show room create button in RoomSublist if "UIComponent.roomCreation" is enabled" This reverts commit a332a0b02a6c3253ea7ac606211c41a09c409de5. --- src/components/views/rooms/RoomSublist.tsx | 4 +- .../views/rooms/RoomSublist-test.tsx | 73 ------------------- 2 files changed, 1 insertion(+), 76 deletions(-) delete mode 100644 test/components/views/rooms/RoomSublist-test.tsx diff --git a/src/components/views/rooms/RoomSublist.tsx b/src/components/views/rooms/RoomSublist.tsx index bdeed9934e4..6e471dde428 100644 --- a/src/components/views/rooms/RoomSublist.tsx +++ b/src/components/views/rooms/RoomSublist.tsx @@ -55,8 +55,6 @@ import SettingsStore from "../../../settings/SettingsStore"; import { SlidingSyncManager } from "../../../SlidingSyncManager"; import NotificationBadge from "./NotificationBadge"; import RoomTile from "./RoomTile"; -import { shouldShowComponent } from "../../../customisations/helpers/UIComponents"; -import { UIComponent } from "../../../settings/UIFeature"; const SHOW_N_BUTTON_HEIGHT = 28; // As defined by CSS const RESIZE_HANDLE_HEIGHT = 4; // As defined by CSS @@ -663,7 +661,7 @@ export default class RoomSublist extends React.Component { ); let addRoomButton: JSX.Element | undefined; - if (this.props.AuxButtonComponent && shouldShowComponent(UIComponent.CreateRooms)) { + if (this.props.AuxButtonComponent) { const AuxButtonComponent = this.props.AuxButtonComponent; addRoomButton = ; } diff --git a/test/components/views/rooms/RoomSublist-test.tsx b/test/components/views/rooms/RoomSublist-test.tsx deleted file mode 100644 index 60d8cffa23c..00000000000 --- a/test/components/views/rooms/RoomSublist-test.tsx +++ /dev/null @@ -1,73 +0,0 @@ -/* -Copyright 2023 Mikhail Aheichyk -Copyright 2023 Nordeck IT + Consulting GmbH. - -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 { render, RenderResult, screen } from "@testing-library/react"; -import { ComponentProps } from "react"; -import React from "react"; -import { EventEmitter } from "events"; -import { mocked } from "jest-mock"; - -import RoomSublist, { IAuxButtonProps } from "../../../../src/components/views/rooms/RoomSublist"; -import { DefaultTagID } from "../../../../src/stores/room-list/models"; -import ResizeNotifier from "../../../../src/utils/ResizeNotifier"; -import AccessibleButton from "../../../../src/components/views/elements/AccessibleButton"; -import { shouldShowComponent } from "../../../../src/customisations/helpers/UIComponents"; -import { UIComponent } from "../../../../src/settings/UIFeature"; - -jest.mock("../../../../src/customisations/helpers/UIComponents", () => ({ - shouldShowComponent: jest.fn(), -})); - -const AuxButton: React.FC = ({ tabIndex }) => { - return Add room; -}; - -describe("RoomSublist", () => { - function renderComponent(props: Partial> = {}): RenderResult { - return render( - , - ); - } - - it("does not render when UIComponent customisations disable room creation", () => { - mocked(shouldShowComponent).mockReturnValue(false); - - renderComponent(); - - expect(shouldShowComponent).toHaveBeenCalledWith(UIComponent.CreateRooms); - expect(screen.queryByRole("button", { name: "Add room" })).not.toBeInTheDocument(); - }); - - it("renders when UIComponent customisations enable room creation", () => { - mocked(shouldShowComponent).mockReturnValue(true); - - renderComponent(); - - expect(shouldShowComponent).toHaveBeenCalledWith(UIComponent.CreateRooms); - expect(screen.getByRole("button", { name: "Add room" })).toBeInTheDocument(); - }); -}); From 95820fd7917790e9adab9affd5ed26e4d152a801 Mon Sep 17 00:00:00 2001 From: Mikhail Aheichyk Date: Fri, 17 Mar 2023 18:47:45 +0300 Subject: [PATCH 3/4] Use UIComponent.ExploreRooms to display menu item "Explore public rooms" ("Explore rooms" in case of space room) in context menu of "Rooms" section of RoomList component. The context menu will be available if one of UIComponent.ExploreRooms or UIComponent.CreateRooms is enabled. Signed-off-by: Mikhail Aheichyk --- src/components/views/rooms/RoomList.tsx | 92 ++++---- test/components/views/rooms/RoomList-test.tsx | 210 ++++++++++++++++++ 2 files changed, 261 insertions(+), 41 deletions(-) create mode 100644 test/components/views/rooms/RoomList-test.tsx diff --git a/src/components/views/rooms/RoomList.tsx b/src/components/views/rooms/RoomList.tsx index 7e2bd9dae8c..72c91b339a8 100644 --- a/src/components/views/rooms/RoomList.tsx +++ b/src/components/views/rooms/RoomList.tsx @@ -213,6 +213,8 @@ const UntaggedAuxButton: React.FC = ({ tabIndex }) => { }); const showCreateRoom = shouldShowComponent(UIComponent.CreateRooms); + const showExploreRooms = shouldShowComponent(UIComponent.ExploreRooms); + const videoRoomsEnabled = useFeatureEnabled("feature_video_rooms"); const elementCallVideoRoomsEnabled = useFeatureEnabled("feature_element_call_video_rooms"); @@ -225,21 +227,23 @@ const UntaggedAuxButton: React.FC = ({ tabIndex }) => { contextMenuContent = ( - { - e.preventDefault(); - e.stopPropagation(); - closeMenu(); - defaultDispatcher.dispatch({ - action: Action.ViewRoom, - room_id: activeSpace.roomId, - metricsTrigger: undefined, // other - }); - PosthogTrackers.trackInteraction("WebRoomListRoomsSublistPlusMenuExploreRoomsItem", e); - }} - /> + {showExploreRooms ? ( + { + e.preventDefault(); + e.stopPropagation(); + closeMenu(); + defaultDispatcher.dispatch({ + action: Action.ViewRoom, + room_id: activeSpace.roomId, + metricsTrigger: undefined, // other + }); + PosthogTrackers.trackInteraction("WebRoomListRoomsSublistPlusMenuExploreRoomsItem", e); + }} + /> + ) : null} {showCreateRoom ? ( <> = ({ tabIndex }) => { )} )} - { - e.preventDefault(); - e.stopPropagation(); - closeMenu(); - PosthogTrackers.trackInteraction("WebRoomListRoomsSublistPlusMenuExploreRoomsItem", e); - defaultDispatcher.fire(Action.ViewRoomDirectory); - }} - /> + {showExploreRooms ? ( + { + e.preventDefault(); + e.stopPropagation(); + closeMenu(); + PosthogTrackers.trackInteraction("WebRoomListRoomsSublistPlusMenuExploreRoomsItem", e); + defaultDispatcher.fire(Action.ViewRoomDirectory); + }} + /> + ) : null} ); } @@ -361,22 +367,26 @@ const UntaggedAuxButton: React.FC = ({ tabIndex }) => { ); } - return ( - <> - + if (showCreateRoom || showExploreRooms) { + return ( + <> + - {contextMenu} - - ); + {contextMenu} + + ); + } + + return null; }; const TAG_AESTHETICS: TagAestheticsMap = { diff --git a/test/components/views/rooms/RoomList-test.tsx b/test/components/views/rooms/RoomList-test.tsx new file mode 100644 index 00000000000..1fcb6e1aee1 --- /dev/null +++ b/test/components/views/rooms/RoomList-test.tsx @@ -0,0 +1,210 @@ +/* +Copyright 2023 Mikhail Aheichyk +Copyright 2023 Nordeck IT + Consulting GmbH. + +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, { ComponentProps } from "react"; +import { render, screen, within } from "@testing-library/react"; +import userEvent from "@testing-library/user-event"; +import { mocked } from "jest-mock"; +import { Room } from "matrix-js-sdk/src/models/room"; + +import RoomList from "../../../../src/components/views/rooms/RoomList"; +import ResizeNotifier from "../../../../src/utils/ResizeNotifier"; +import { MetaSpace } from "../../../../src/stores/spaces"; +import { shouldShowComponent } from "../../../../src/customisations/helpers/UIComponents"; +import { UIComponent } from "../../../../src/settings/UIFeature"; +import dis from "../../../../src/dispatcher/dispatcher"; +import { Action } from "../../../../src/dispatcher/actions"; +import * as testUtils from "../../../test-utils"; +import { mkSpace, stubClient } from "../../../test-utils"; +import { MatrixClientPeg } from "../../../../src/MatrixClientPeg"; +import SpaceStore from "../../../../src/stores/spaces/SpaceStore"; +import DMRoomMap from "../../../../src/utils/DMRoomMap"; + +jest.mock("../../../../src/customisations/helpers/UIComponents", () => ({ + shouldShowComponent: jest.fn(), +})); + +jest.mock("../../../../src/dispatcher/dispatcher"); + +const getUserIdForRoomId = jest.fn(); +const getDMRoomsForUserId = jest.fn(); +// @ts-ignore +DMRoomMap.sharedInstance = { getUserIdForRoomId, getDMRoomsForUserId }; + +describe("RoomList", () => { + stubClient(); + const client = MatrixClientPeg.get(); + const store = SpaceStore.instance; + + function getComponent(props: Partial> = {}): JSX.Element { + return ( + + ); + } + + describe("Rooms", () => { + describe("when meta space is active", () => { + beforeEach(() => { + store.setActiveSpace(MetaSpace.Home); + }); + + it("does not render add room button when UIComponent customisation disables CreateRooms and ExploreRooms", () => { + const disabled: UIComponent[] = [UIComponent.CreateRooms, UIComponent.ExploreRooms]; + mocked(shouldShowComponent).mockImplementation((feature) => !disabled.includes(feature)); + render(getComponent()); + + const roomsList = screen.getByRole("group", { name: "Rooms" }); + expect(within(roomsList).queryByRole("button", { name: "Add room" })).not.toBeInTheDocument(); + }); + + it("renders add room button with menu when UIComponent customisation allows CreateRooms or ExploreRooms", async () => { + let disabled: UIComponent[] = []; + mocked(shouldShowComponent).mockImplementation((feature) => !disabled.includes(feature)); + const { rerender } = render(getComponent()); + + const roomsList = screen.getByRole("group", { name: "Rooms" }); + const addRoomButton = within(roomsList).getByRole("button", { name: "Add room" }); + expect(screen.queryByRole("menu")).not.toBeInTheDocument(); + + await userEvent.click(addRoomButton); + + const menu = screen.getByRole("menu"); + + expect(within(menu).getByRole("menuitem", { name: "New room" })).toBeInTheDocument(); + expect(within(menu).getByRole("menuitem", { name: "Explore public rooms" })).toBeInTheDocument(); + + disabled = [UIComponent.CreateRooms]; + rerender(getComponent()); + + expect(addRoomButton).toBeInTheDocument(); + expect(menu).toBeInTheDocument(); + expect(within(menu).queryByRole("menuitem", { name: "New room" })).not.toBeInTheDocument(); + expect(within(menu).getByRole("menuitem", { name: "Explore public rooms" })).toBeInTheDocument(); + + disabled = [UIComponent.ExploreRooms]; + rerender(getComponent()); + + expect(addRoomButton).toBeInTheDocument(); + expect(menu).toBeInTheDocument(); + expect(within(menu).getByRole("menuitem", { name: "New room" })).toBeInTheDocument(); + expect(within(menu).queryByRole("menuitem", { name: "Explore public rooms" })).not.toBeInTheDocument(); + }); + + it("renders add room button and clicks explore public rooms", async () => { + mocked(shouldShowComponent).mockReturnValue(true); + render(getComponent()); + + const roomsList = screen.getByRole("group", { name: "Rooms" }); + await userEvent.click(within(roomsList).getByRole("button", { name: "Add room" })); + + const menu = screen.getByRole("menu"); + await userEvent.click(within(menu).getByRole("menuitem", { name: "Explore public rooms" })); + + expect(dis.fire).toHaveBeenCalledWith(Action.ViewRoomDirectory); + }); + }); + + describe("when room space is active", () => { + let rooms: Room[]; + const mkSpaceForRooms = (spaceId: string, children: string[] = []) => + mkSpace(client, spaceId, rooms, children); + + const space1 = "!space1:server"; + + beforeEach(async () => { + rooms = []; + mkSpaceForRooms(space1); + mocked(client).getRoom.mockImplementation( + (roomId) => rooms.find((room) => room.roomId === roomId) || null, + ); + await testUtils.setupAsyncStoreWithClient(store, client); + + store.setActiveSpace(space1); + }); + + it("does not render add room button when UIComponent customisation disables CreateRooms and ExploreRooms", () => { + const disabled: UIComponent[] = [UIComponent.CreateRooms, UIComponent.ExploreRooms]; + mocked(shouldShowComponent).mockImplementation((feature) => !disabled.includes(feature)); + render(getComponent()); + + const roomsList = screen.getByRole("group", { name: "Rooms" }); + expect(within(roomsList).queryByRole("button", { name: "Add room" })).not.toBeInTheDocument(); + }); + + it("renders add room button with menu when UIComponent customisation allows CreateRooms or ExploreRooms", async () => { + let disabled: UIComponent[] = []; + mocked(shouldShowComponent).mockImplementation((feature) => !disabled.includes(feature)); + const { rerender } = render(getComponent()); + + const roomsList = screen.getByRole("group", { name: "Rooms" }); + const addRoomButton = within(roomsList).getByRole("button", { name: "Add room" }); + expect(screen.queryByRole("menu")).not.toBeInTheDocument(); + + await userEvent.click(addRoomButton); + + const menu = screen.getByRole("menu"); + + expect(within(menu).getByRole("menuitem", { name: "Explore rooms" })).toBeInTheDocument(); + expect(within(menu).getByRole("menuitem", { name: "New room" })).toBeInTheDocument(); + expect(within(menu).getByRole("menuitem", { name: "Add existing room" })).toBeInTheDocument(); + + disabled = [UIComponent.CreateRooms]; + rerender(getComponent()); + + expect(addRoomButton).toBeInTheDocument(); + expect(menu).toBeInTheDocument(); + expect(within(menu).getByRole("menuitem", { name: "Explore rooms" })).toBeInTheDocument(); + expect(within(menu).queryByRole("menuitem", { name: "New room" })).not.toBeInTheDocument(); + expect(within(menu).queryByRole("menuitem", { name: "Add existing room" })).not.toBeInTheDocument(); + + disabled = [UIComponent.ExploreRooms]; + rerender(getComponent()); + + expect(addRoomButton).toBeInTheDocument(); + expect(menu).toBeInTheDocument(); + expect(within(menu).queryByRole("menuitem", { name: "Explore rooms" })).not.toBeInTheDocument(); + expect(within(menu).getByRole("menuitem", { name: "New room" })).toBeInTheDocument(); + expect(within(menu).getByRole("menuitem", { name: "Add existing room" })).toBeInTheDocument(); + }); + + it("renders add room button and clicks explore rooms", async () => { + mocked(shouldShowComponent).mockReturnValue(true); + render(getComponent()); + + const roomsList = screen.getByRole("group", { name: "Rooms" }); + await userEvent.click(within(roomsList).getByRole("button", { name: "Add room" })); + + const menu = screen.getByRole("menu"); + await userEvent.click(within(menu).getByRole("menuitem", { name: "Explore rooms" })); + + expect(dis.dispatch).toHaveBeenCalledWith({ + action: Action.ViewRoom, + room_id: space1, + }); + }); + }); + }); +}); From 2a7a24c60b44a020cdcbae0286962c67b769f3ba Mon Sep 17 00:00:00 2001 From: Mikhail Aheichyk Date: Wed, 29 Mar 2023 10:36:16 +0300 Subject: [PATCH 4/4] "Explore rooms" of space room should not be controlled by UIComponent.ExploreRooms. Signed-off-by: Mikhail Aheichyk --- src/components/views/rooms/RoomList.tsx | 32 +++++++++---------- test/components/views/rooms/RoomList-test.tsx | 2 +- 2 files changed, 16 insertions(+), 18 deletions(-) diff --git a/src/components/views/rooms/RoomList.tsx b/src/components/views/rooms/RoomList.tsx index 72c91b339a8..98a3260b666 100644 --- a/src/components/views/rooms/RoomList.tsx +++ b/src/components/views/rooms/RoomList.tsx @@ -227,23 +227,21 @@ const UntaggedAuxButton: React.FC = ({ tabIndex }) => { contextMenuContent = ( - {showExploreRooms ? ( - { - e.preventDefault(); - e.stopPropagation(); - closeMenu(); - defaultDispatcher.dispatch({ - action: Action.ViewRoom, - room_id: activeSpace.roomId, - metricsTrigger: undefined, // other - }); - PosthogTrackers.trackInteraction("WebRoomListRoomsSublistPlusMenuExploreRoomsItem", e); - }} - /> - ) : null} + { + e.preventDefault(); + e.stopPropagation(); + closeMenu(); + defaultDispatcher.dispatch({ + action: Action.ViewRoom, + room_id: activeSpace.roomId, + metricsTrigger: undefined, // other + }); + PosthogTrackers.trackInteraction("WebRoomListRoomsSublistPlusMenuExploreRoomsItem", e); + }} + /> {showCreateRoom ? ( <> { expect(addRoomButton).toBeInTheDocument(); expect(menu).toBeInTheDocument(); - expect(within(menu).queryByRole("menuitem", { name: "Explore rooms" })).not.toBeInTheDocument(); + expect(within(menu).queryByRole("menuitem", { name: "Explore rooms" })).toBeInTheDocument(); expect(within(menu).getByRole("menuitem", { name: "New room" })).toBeInTheDocument(); expect(within(menu).getByRole("menuitem", { name: "Add existing room" })).toBeInTheDocument(); });