Prepare for repo merge
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
This commit is contained in:
parent
0f670b8dc0
commit
b084ff2313
807 changed files with 0 additions and 0 deletions
220
test/unit-tests/stores/right-panel/RightPanelStore-test.ts
Normal file
220
test/unit-tests/stores/right-panel/RightPanelStore-test.ts
Normal file
|
@ -0,0 +1,220 @@
|
|||
/*
|
||||
Copyright 2024 New Vector Ltd.
|
||||
Copyright 2022 The Matrix.org Foundation C.I.C.
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
|
||||
Please see LICENSE files in the repository root for full details.
|
||||
*/
|
||||
|
||||
import { mocked, MockedObject } from "jest-mock";
|
||||
import { MatrixClient, RoomMember } from "matrix-js-sdk/src/matrix";
|
||||
|
||||
import { stubClient } from "../../test-utils";
|
||||
import { MatrixClientPeg } from "../../../src/MatrixClientPeg";
|
||||
import DMRoomMap from "../../../src/utils/DMRoomMap";
|
||||
import { Action } from "../../../src/dispatcher/actions";
|
||||
import defaultDispatcher from "../../../src/dispatcher/dispatcher";
|
||||
import { ActiveRoomChangedPayload } from "../../../src/dispatcher/payloads/ActiveRoomChangedPayload";
|
||||
import RightPanelStore from "../../../src/stores/right-panel/RightPanelStore";
|
||||
import { RightPanelPhases } from "../../../src/stores/right-panel/RightPanelStorePhases";
|
||||
import SettingsStore from "../../../src/settings/SettingsStore";
|
||||
|
||||
describe("RightPanelStore", () => {
|
||||
// Mock out the settings store so the right panel store can't persist values between tests
|
||||
jest.spyOn(SettingsStore, "setValue").mockImplementation(async () => {});
|
||||
|
||||
const store = RightPanelStore.instance;
|
||||
let cli: MockedObject<MatrixClient>;
|
||||
beforeEach(() => {
|
||||
stubClient();
|
||||
cli = mocked(MatrixClientPeg.safeGet());
|
||||
DMRoomMap.makeShared(cli);
|
||||
|
||||
// Make sure we start with a clean store
|
||||
store.reset();
|
||||
store.useUnitTestClient(cli);
|
||||
});
|
||||
|
||||
const viewRoom = async (roomId: string) => {
|
||||
const roomChanged = new Promise<void>((resolve) => {
|
||||
const ref = defaultDispatcher.register((payload) => {
|
||||
if (payload.action === Action.ActiveRoomChanged && payload.newRoomId === roomId) {
|
||||
defaultDispatcher.unregister(ref);
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
defaultDispatcher.dispatch<ActiveRoomChangedPayload>({
|
||||
action: Action.ActiveRoomChanged,
|
||||
oldRoomId: null,
|
||||
newRoomId: roomId,
|
||||
});
|
||||
|
||||
await roomChanged;
|
||||
};
|
||||
|
||||
const setCard = (roomId: string, phase: RightPanelPhases) => store.setCard({ phase }, true, roomId);
|
||||
|
||||
describe("isOpen", () => {
|
||||
it("is false if no rooms are open", () => {
|
||||
expect(store.isOpen).toEqual(false);
|
||||
});
|
||||
it("is false if a room other than the current room is open", async () => {
|
||||
await viewRoom("!1:example.org");
|
||||
setCard("!2:example.org", RightPanelPhases.RoomSummary);
|
||||
expect(store.isOpen).toEqual(false);
|
||||
});
|
||||
it("is true if the current room is open", async () => {
|
||||
await viewRoom("!1:example.org");
|
||||
setCard("!1:example.org", RightPanelPhases.RoomSummary);
|
||||
expect(store.isOpen).toEqual(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe("currentCard", () => {
|
||||
it("has a phase of null if nothing is open", () => {
|
||||
expect(store.currentCard.phase).toEqual(null);
|
||||
});
|
||||
it("has a phase of null if the panel is open but in another room", async () => {
|
||||
await viewRoom("!1:example.org");
|
||||
setCard("!2:example.org", RightPanelPhases.RoomSummary);
|
||||
expect(store.currentCard.phase).toEqual(null);
|
||||
});
|
||||
it("reflects the phase of the current room", async () => {
|
||||
await viewRoom("!1:example.org");
|
||||
setCard("!1:example.org", RightPanelPhases.RoomSummary);
|
||||
expect(store.currentCard.phase).toEqual(RightPanelPhases.RoomSummary);
|
||||
});
|
||||
});
|
||||
|
||||
describe("setCard", () => {
|
||||
it("does nothing if given no room ID and not viewing a room", () => {
|
||||
store.setCard({ phase: RightPanelPhases.RoomSummary }, true);
|
||||
expect(store.isOpen).toEqual(false);
|
||||
expect(store.currentCard.phase).toEqual(null);
|
||||
});
|
||||
it("does nothing if given an invalid state", async () => {
|
||||
await viewRoom("!1:example.org");
|
||||
// Needs a member specified to be valid
|
||||
store.setCard({ phase: RightPanelPhases.RoomMemberInfo }, true, "!1:example.org");
|
||||
expect(store.roomPhaseHistory).toEqual([]);
|
||||
});
|
||||
it("only creates a single history entry if given the same card twice", async () => {
|
||||
await viewRoom("!1:example.org");
|
||||
store.setCard({ phase: RightPanelPhases.RoomSummary }, true, "!1:example.org");
|
||||
store.setCard({ phase: RightPanelPhases.RoomSummary }, true, "!1:example.org");
|
||||
expect(store.roomPhaseHistory).toEqual([{ phase: RightPanelPhases.RoomSummary, state: {} }]);
|
||||
});
|
||||
it("opens the panel in the given room with the correct phase", () => {
|
||||
store.setCard({ phase: RightPanelPhases.RoomSummary }, true, "!1:example.org");
|
||||
expect(store.isOpenForRoom("!1:example.org")).toEqual(true);
|
||||
expect(store.currentCardForRoom("!1:example.org").phase).toEqual(RightPanelPhases.RoomSummary);
|
||||
});
|
||||
it("overwrites history if changing the phase", async () => {
|
||||
await viewRoom("!1:example.org");
|
||||
store.setCard({ phase: RightPanelPhases.RoomSummary }, true, "!1:example.org");
|
||||
store.setCard({ phase: RightPanelPhases.RoomMemberList }, true, "!1:example.org");
|
||||
expect(store.roomPhaseHistory).toEqual([{ phase: RightPanelPhases.RoomMemberList, state: {} }]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("setCards", () => {
|
||||
it("overwrites history", async () => {
|
||||
await viewRoom("!1:example.org");
|
||||
store.setCard({ phase: RightPanelPhases.RoomMemberList }, true, "!1:example.org");
|
||||
store.setCards(
|
||||
[{ phase: RightPanelPhases.RoomSummary }, { phase: RightPanelPhases.PinnedMessages }],
|
||||
true,
|
||||
"!1:example.org",
|
||||
);
|
||||
expect(store.roomPhaseHistory).toEqual([
|
||||
{ phase: RightPanelPhases.RoomSummary, state: {} },
|
||||
{ phase: RightPanelPhases.PinnedMessages, state: {} },
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("pushCard", () => {
|
||||
it("does nothing if given no room ID and not viewing a room", () => {
|
||||
store.pushCard({ phase: RightPanelPhases.RoomSummary }, true);
|
||||
expect(store.isOpen).toEqual(false);
|
||||
expect(store.currentCard.phase).toEqual(null);
|
||||
});
|
||||
it("opens the panel in the given room with the correct phase", () => {
|
||||
store.pushCard({ phase: RightPanelPhases.RoomSummary }, true, "!1:example.org");
|
||||
expect(store.isOpenForRoom("!1:example.org")).toEqual(true);
|
||||
expect(store.currentCardForRoom("!1:example.org").phase).toEqual(RightPanelPhases.RoomSummary);
|
||||
});
|
||||
it("appends the phase to any phases that were there before", async () => {
|
||||
await viewRoom("!1:example.org");
|
||||
store.setCard({ phase: RightPanelPhases.RoomSummary }, true, "!1:example.org");
|
||||
store.pushCard({ phase: RightPanelPhases.PinnedMessages }, true, "!1:example.org");
|
||||
expect(store.roomPhaseHistory).toEqual([
|
||||
{ phase: RightPanelPhases.RoomSummary, state: {} },
|
||||
{ phase: RightPanelPhases.PinnedMessages, state: {} },
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("popCard", () => {
|
||||
it("removes the most recent card", () => {
|
||||
store.setCards(
|
||||
[{ phase: RightPanelPhases.RoomSummary }, { phase: RightPanelPhases.PinnedMessages }],
|
||||
true,
|
||||
"!1:example.org",
|
||||
);
|
||||
expect(store.currentCardForRoom("!1:example.org").phase).toEqual(RightPanelPhases.PinnedMessages);
|
||||
store.popCard("!1:example.org");
|
||||
expect(store.currentCardForRoom("!1:example.org").phase).toEqual(RightPanelPhases.RoomSummary);
|
||||
});
|
||||
});
|
||||
|
||||
describe("togglePanel", () => {
|
||||
it("does nothing if the room has no phase to open to", () => {
|
||||
expect(store.isOpenForRoom("!1:example.org")).toEqual(false);
|
||||
store.togglePanel("!1:example.org");
|
||||
expect(store.isOpenForRoom("!1:example.org")).toEqual(false);
|
||||
});
|
||||
it("works if a room is specified", () => {
|
||||
store.setCard({ phase: RightPanelPhases.RoomSummary }, true, "!1:example.org");
|
||||
expect(store.isOpenForRoom("!1:example.org")).toEqual(true);
|
||||
store.togglePanel("!1:example.org");
|
||||
expect(store.isOpenForRoom("!1:example.org")).toEqual(false);
|
||||
store.togglePanel("!1:example.org");
|
||||
expect(store.isOpenForRoom("!1:example.org")).toEqual(true);
|
||||
});
|
||||
it("operates on the current room if no room is specified", async () => {
|
||||
await viewRoom("!1:example.org");
|
||||
store.setCard({ phase: RightPanelPhases.RoomSummary }, true);
|
||||
expect(store.isOpen).toEqual(true);
|
||||
store.togglePanel(null);
|
||||
expect(store.isOpen).toEqual(false);
|
||||
store.togglePanel(null);
|
||||
expect(store.isOpen).toEqual(true);
|
||||
});
|
||||
});
|
||||
|
||||
it("doesn't restore member info cards when switching back to a room", async () => {
|
||||
await viewRoom("!1:example.org");
|
||||
store.setCards(
|
||||
[
|
||||
{
|
||||
phase: RightPanelPhases.RoomMemberList,
|
||||
},
|
||||
{
|
||||
phase: RightPanelPhases.RoomMemberInfo,
|
||||
state: { member: new RoomMember("!1:example.org", "@alice:example.org") },
|
||||
},
|
||||
],
|
||||
true,
|
||||
"!1:example.org",
|
||||
);
|
||||
expect(store.currentCardForRoom("!1:example.org").phase).toEqual(RightPanelPhases.RoomMemberInfo);
|
||||
|
||||
// Switch away and back
|
||||
await viewRoom("!2:example.org");
|
||||
await viewRoom("!1:example.org");
|
||||
expect(store.currentCardForRoom("!1:example.org").phase).toEqual(RightPanelPhases.RoomMemberList);
|
||||
});
|
||||
});
|
|
@ -0,0 +1,50 @@
|
|||
/*
|
||||
Copyright 2024 New Vector Ltd.
|
||||
Copyright 2023 The Matrix.org Foundation C.I.C.
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
|
||||
Please see LICENSE files in the repository root for full details.
|
||||
*/
|
||||
|
||||
import { MockedObject } from "jest-mock";
|
||||
import { EventType, MatrixEvent } from "matrix-js-sdk/src/matrix";
|
||||
|
||||
import { Action } from "../../../../src/dispatcher/actions";
|
||||
import { onView3pidInvite } from "../../../../src/stores/right-panel/action-handlers";
|
||||
import RightPanelStore from "../../../../src/stores/right-panel/RightPanelStore";
|
||||
import { RightPanelPhases } from "../../../../src/stores/right-panel/RightPanelStorePhases";
|
||||
|
||||
describe("onView3pidInvite()", () => {
|
||||
let rightPanelStore!: MockedObject<RightPanelStore>;
|
||||
|
||||
beforeEach(() => {
|
||||
rightPanelStore = {
|
||||
pushCard: jest.fn(),
|
||||
showOrHidePhase: jest.fn(),
|
||||
} as unknown as MockedObject<RightPanelStore>;
|
||||
});
|
||||
|
||||
it("should display room member list when payload has a falsy event", () => {
|
||||
const payload = {
|
||||
action: Action.View3pidInvite,
|
||||
};
|
||||
onView3pidInvite(payload, rightPanelStore);
|
||||
|
||||
expect(rightPanelStore.showOrHidePhase).toHaveBeenCalledWith(RightPanelPhases.RoomMemberList);
|
||||
expect(rightPanelStore.pushCard).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("should push a 3pid member card on the right panel stack when payload has an event", () => {
|
||||
const payload = {
|
||||
action: Action.View3pidInvite,
|
||||
event: new MatrixEvent({ type: EventType.RoomThirdPartyInvite }),
|
||||
};
|
||||
onView3pidInvite(payload, rightPanelStore);
|
||||
|
||||
expect(rightPanelStore.showOrHidePhase).not.toHaveBeenCalled();
|
||||
expect(rightPanelStore.pushCard).toHaveBeenCalledWith({
|
||||
phase: RightPanelPhases.Room3pidMemberInfo,
|
||||
state: { memberInfoEvent: payload.event },
|
||||
});
|
||||
});
|
||||
});
|
Loading…
Add table
Add a link
Reference in a new issue