From 796e12e789395ea429f422a4b0df3743f0c88eef Mon Sep 17 00:00:00 2001 From: Robin Date: Tue, 17 May 2022 09:22:35 -0400 Subject: [PATCH] Go to space landing page when clicking on a selected space (#6442) * Go to space landing page when clicking on a selected space Signed-off-by: Robin Townsend * Go to home landing page when clicking on selected home space Signed-off-by: Robin Townsend * Remove metaspace behavior * Add tests * Use the dispatcher action enum * Break up the onClick assignment --- .../views/spaces/SpaceTreeLevel.tsx | 15 ++-- .../views/spaces/SpaceTreeLevel-test.tsx | 85 +++++++++++++++++++ 2 files changed, 92 insertions(+), 8 deletions(-) create mode 100644 test/components/views/spaces/SpaceTreeLevel-test.tsx diff --git a/src/components/views/spaces/SpaceTreeLevel.tsx b/src/components/views/spaces/SpaceTreeLevel.tsx index 6acd9845ef..d966415061 100644 --- a/src/components/views/spaces/SpaceTreeLevel.tsx +++ b/src/components/views/spaces/SpaceTreeLevel.tsx @@ -25,6 +25,8 @@ import { SpaceKey } from "../../../stores/spaces"; import SpaceTreeLevelLayoutStore from "../../../stores/spaces/SpaceTreeLevelLayoutStore"; import NotificationBadge from "../rooms/NotificationBadge"; import { _t } from "../../../languageHandler"; +import defaultDispatcher from "../../../dispatcher/dispatcher"; +import { Action } from "../../../dispatcher/actions"; import { ContextMenuTooltipButton } from "../../../accessibility/context_menu/ContextMenuTooltipButton"; import { toRightOf, useContextMenu } from "../../structures/ContextMenu"; import MatrixClientContext from "../../../contexts/MatrixClientContext"; @@ -103,6 +105,10 @@ export const SpaceButton: React.FC = ({ />; } + const viewSpaceHome = () => defaultDispatcher.dispatch({ action: Action.ViewRoom, room_id: space.roomId }); + const activateSpace = () => SpaceStore.instance.setActiveSpace(spaceKey ?? space.roomId); + const onClick = props.onClick ?? (selected && space ? viewSpaceHome : activateSpace); + return ( = ({ mx_SpaceButton_narrow: isNarrow, })} title={label} - onClick={spaceKey ? () => SpaceStore.instance.setActiveSpace(spaceKey) : props.onClick} + onClick={onClick} onContextMenu={openMenu} forceHide={!isNarrow || menuDisplayed} inputRef={handle} @@ -261,12 +267,6 @@ export class SpaceItem extends React.PureComponent { } }; - private onClick = (ev: React.MouseEvent) => { - ev.preventDefault(); - ev.stopPropagation(); - SpaceStore.instance.setActiveSpace(this.props.space.roomId); - }; - render() { // eslint-disable-next-line @typescript-eslint/no-unused-vars const { space, activeSpaces, isNested, isPanelCollapsed, onExpand, parents, innerRef, dragHandleProps, @@ -328,7 +328,6 @@ export class SpaceItem extends React.PureComponent { notificationState={notificationState} isNarrow={isPanelCollapsed} avatarSize={isNested ? 24 : 32} - onClick={this.onClick} onKeyDown={this.onKeyDown} ContextMenuComponent={this.props.space.getMyMembership() === "join" ? SpaceContextMenu : undefined} > diff --git a/test/components/views/spaces/SpaceTreeLevel-test.tsx b/test/components/views/spaces/SpaceTreeLevel-test.tsx new file mode 100644 index 0000000000..09661c71f4 --- /dev/null +++ b/test/components/views/spaces/SpaceTreeLevel-test.tsx @@ -0,0 +1,85 @@ +/* +Copyright 2022 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 { mount } from "enzyme"; + +import { stubClient, mkRoom } from "../../../test-utils"; +import { MatrixClientPeg } from "../../../../src/MatrixClientPeg"; +import DMRoomMap from "../../../../src/utils/DMRoomMap"; +import defaultDispatcher from "../../../../src/dispatcher/dispatcher"; +import { Action } from "../../../../src/dispatcher/actions"; +import { SpaceButton } from "../../../../src/components/views/spaces/SpaceTreeLevel"; +import { MetaSpace, SpaceKey } from "../../../../src/stores/spaces"; +import SpaceStore from "../../../../src/stores/spaces/SpaceStore"; + +jest.mock("../../../../src/stores/spaces/SpaceStore", () => { + // eslint-disable-next-line @typescript-eslint/no-var-requires + const EventEmitter = require("events"); + class MockSpaceStore extends EventEmitter { + activeSpace: SpaceKey = "!space1"; + setActiveSpace = jest.fn(); + } + + return { instance: new MockSpaceStore() }; +}); + +describe("SpaceButton", () => { + stubClient(); + const space = mkRoom(MatrixClientPeg.get(), "!1:example.org"); + DMRoomMap.makeShared(); + + const dispatchSpy = jest.spyOn(defaultDispatcher, "dispatch"); + + afterEach(jest.clearAllMocks); + + describe("real space", () => { + it("activates the space on click", () => { + const button = mount(); + + expect(SpaceStore.instance.setActiveSpace).not.toHaveBeenCalled(); + button.simulate("click"); + expect(SpaceStore.instance.setActiveSpace).toHaveBeenCalledWith("!1:example.org"); + }); + + it("navigates to the space home on click if already active", () => { + const button = mount(); + + expect(dispatchSpy).not.toHaveBeenCalled(); + button.simulate("click"); + expect(dispatchSpy).toHaveBeenCalledWith({ action: Action.ViewRoom, room_id: "!1:example.org" }); + }); + }); + + describe("metaspace", () => { + it("activates the metaspace on click", () => { + const button = mount(); + + expect(SpaceStore.instance.setActiveSpace).not.toHaveBeenCalled(); + button.simulate("click"); + expect(SpaceStore.instance.setActiveSpace).toHaveBeenCalledWith(MetaSpace.People); + }); + + it("does nothing on click if already active", () => { + const button = mount(); + + button.simulate("click"); + expect(dispatchSpy).not.toHaveBeenCalled(); + // Re-activating the metaspace is a no-op + expect(SpaceStore.instance.setActiveSpace).toHaveBeenCalledWith(MetaSpace.People); + }); + }); +});