This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 827
Show room create icon if "UIComponent.roomCreation" is enabled #10364
Merged
kerryarchibald
merged 14 commits into
matrix-org:develop
from
nordeck:room_create_should_show
Apr 2, 2023
Merged
Changes from 8 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
a332a0b
Show room create button in RoomSublist if "UIComponent.roomCreation" …
ac1ea8e
Revert "Show room create button in RoomSublist if "UIComponent.roomCr…
95820fd
Use UIComponent.ExploreRooms to display menu item "Explore public roo…
61d7e6a
Merge branch 'develop' into room_create_should_show
maheichyk a175655
Merge branch 'develop' into room_create_should_show
maheichyk 66cb7ad
Merge branch 'develop' into room_create_should_show
maheichyk 2a757c0
Merge branch 'develop' into room_create_should_show
maheichyk 345106d
Merge branch 'develop' into room_create_should_show
maheichyk 2a7a24c
"Explore rooms" of space room should not be controlled by UIComponent…
5d3ab5d
Merge branch 'develop' into room_create_should_show
maheichyk 0432def
Merge branch 'develop' into room_create_should_show
maheichyk 60b964c
Merge branch 'develop' into room_create_should_show
maheichyk e8168e1
Merge branch 'develop' into room_create_should_show
maheichyk ebb340c
Merge branch 'develop' into room_create_should_show
maheichyk File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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<ComponentProps<typeof RoomList>> = {}): JSX.Element { | ||
return ( | ||
<RoomList | ||
onKeyDown={jest.fn()} | ||
onFocus={jest.fn()} | ||
onBlur={jest.fn()} | ||
onResize={jest.fn()} | ||
resizeNotifier={new ResizeNotifier()} | ||
isMinimized={false} | ||
activeSpace={MetaSpace.Home} | ||
{...props} | ||
/> | ||
); | ||
} | ||
|
||
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, | ||
}); | ||
}); | ||
}); | ||
}); | ||
}); |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a bit unclear from the name
UIComponent.ExploreRooms
but the documentation says "Components that lead to the public room directory."This menu option leads to the space directory, not to the public room directory, so I don't think it should be controlled by the
UIComponent.ExploreRooms
option.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kerryarchibald, thanks for this point,
UIComponent.ExploreRooms
no longer controls exploring space directory.