Jika/element-web
1
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

Move the upgraderoom command into its own subdirectory of slash-commands (#31941)

Browse Source 
* Move the code for running the upgrade command into its subdir

* Replace use of deprecated currentState property in runUpgradeRoomCommand

* Move upgraderoom command options into their own file

* Move upgraderoom tests into their own file and add a couple
This commit is contained in:
Andy Balaam
2026-02-03 15:02:54 +00:00
committed by GitHub
parent a1be203683
commit 6d7def7b10
5 changed files with 231 additions and 114 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
test/unit-tests/SlashCommands-test.tsx
View File

@@ -22,10 +22,6 @@ import { warnSelfDemote } from "../../src/components/views/right_panel/UserInfo"
import dispatcher from "../../src/dispatcher/dispatcher";
import QuestionDialog from "../../src/components/views/dialogs/QuestionDialog";
import ErrorDialog from "../../src/components/views/dialogs/ErrorDialog";
import RoomUpgradeWarningDialog, {
type IFinishedOpts,
} from "../../src/components/views/dialogs/RoomUpgradeWarningDialog";
import { parseUpgradeRoomArgs } from "../../src/slash-commands/upgraderoom/parseUpgradeRoomArgs";
jest.mock("../../src/components/views/right_panel/UserInfo");
@@ -123,67 +119,6 @@ describe("SlashCommands", () => {
});
});
describe("/upgraderoom", () => {
beforeEach(() => {
command = findCommand("upgraderoom")!;
setCurrentRoom();
});
it("should be enabled by default", () => {
expect(command.isEnabled(client, roomId)).toBe(true);
});
it("should return usage if given no args", () => {
expect(command.run(client, roomId, null, undefined).error).toBe(command.getUsage());
expect(command.run(client, roomId, null, "").error).toBe(command.getUsage());
});
it("should accept arguments of a room version with no additional creators", () => {
expect(parseUpgradeRoomArgs("12")).toEqual({ targetVersion: "12" });
});
it("should accept arguments of a room version and additional creators", () => {
expect(parseUpgradeRoomArgs("13 @u:s.co")).toEqual({
targetVersion: "13",
additionalCreators: ["@u:s.co"],
});
expect(parseUpgradeRoomArgs("14 @u:s.co @v:s.co @w:z.uk")).toEqual({
targetVersion: "14",
additionalCreators: ["@u:s.co", "@v:s.co", "@w:z.uk"],
});
});
it("should upgrade the room when given valid arguments", async () => {
// Given we mock out creating dialogs and upgrading rooms
const createDialog = jest.spyOn(Modal, "createDialog");
const upgradeRoom = jest.fn().mockResolvedValue({ replacement_room: "!newroom" });
const resp: IFinishedOpts = { continue: true, invite: false };
createDialog.mockReturnValue({
finished: Promise.resolve([resp]),
close: jest.fn(),
});
client.upgradeRoom = upgradeRoom;
// When we run a room upgrade
const result = command.run(client, roomId, null, "12 @foo:bar.com @baz:qux.uk");
expect(result.promise).toBeDefined();
await result.promise;
// Then we warned the user
expect(createDialog).toHaveBeenCalledWith(
RoomUpgradeWarningDialog,
{ roomId: "!room:example.com", targetVersion: "12" },
undefined,
false,
true,
);
// And when they said yes, we called into upgradeRoom
expect(upgradeRoom).toHaveBeenCalledWith("!room:example.com", "12", ["@foo:bar.com", "@baz:qux.uk"]);
});
});
describe("/op", () => {
beforeEach(() => {
command = findCommand("op")!;

136
test/unit-tests/slash-commands/upgraderoom-test.tsx Normal file
View File

@@ -0,0 +1,136 @@
/*
* Copyright 2026 Element Creations Ltd.
*
* SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
* Please see LICENSE files in the repository root for full details.
*/
import { mocked } from "jest-mock";
import { type MatrixClient, Room } from "matrix-js-sdk/src/matrix";
import RoomUpgradeWarningDialog, {
type IFinishedOpts,
} from "../../../src/components/views/dialogs/RoomUpgradeWarningDialog";
import { type Command, Commands } from "../../../src/SlashCommands";
import { SdkContextClass } from "../../../src/contexts/SDKContext";
import { createTestClient } from "../../test-utils";
import { parseUpgradeRoomArgs } from "../../../src/slash-commands/upgraderoom/parseUpgradeRoomArgs";
import Modal from "../../../src/Modal";
describe("/upgraderoom", () => {
const roomId = "!room:example.com";
function findCommand(cmd: string): Command | undefined {
return Commands.find((command: Command) => command.command === cmd);
}
/**
* Set up an upgraderoom test.
*
* @param continueUpgrade if true, simulates the user clicking Continue in
* the "Upgrade Room" dialog. If false, simulates the
* user clicking Cancel.
*/
function setUp(continueUpgrade: boolean): {
command: Command;
client: MatrixClient;
createDialog: unknown;
upgradeRoom: unknown;
} {
jest.clearAllMocks();
const command = findCommand("upgraderoom")!;
const client = createTestClient();
jest.spyOn(SdkContextClass.instance.roomViewStore, "getRoomId");
mocked(SdkContextClass.instance.roomViewStore.getRoomId).mockReturnValue(roomId);
mocked(client.getRoom).mockImplementation((rId: string): Room | null => {
if (rId === roomId) return new Room(roomId, client, client.getSafeUserId());
return null;
});
const createDialog = jest.spyOn(Modal, "createDialog");
const upgradeRoom = jest.fn().mockResolvedValue({ replacement_room: "!newroom" });
const resp: IFinishedOpts = { continue: continueUpgrade, invite: false };
createDialog.mockReturnValue({
finished: Promise.resolve([resp]),
close: jest.fn(),
});
client.upgradeRoom = upgradeRoom;
return { command, client, createDialog, upgradeRoom };
}
it("should be enabled by default", () => {
const { command, client } = setUp(false);
expect(command.isEnabled(client, roomId)).toBe(true);
});
it("should return usage if given no args", () => {
const { command, client } = setUp(false);
expect(command.run(client, roomId, null, undefined).error).toBe(command.getUsage());
expect(command.run(client, roomId, null, "").error).toBe(command.getUsage());
expect(command.run(client, roomId, null, " ").error).toBe(command.getUsage());
});
it("should accept arguments of a room version with no additional creators", () => {
expect(parseUpgradeRoomArgs("12")).toEqual({ targetVersion: "12" });
});
it("should accept arguments of a room version and additional creators", () => {
expect(parseUpgradeRoomArgs("13 @u:s.co")).toEqual({
targetVersion: "13",
additionalCreators: ["@u:s.co"],
});
expect(parseUpgradeRoomArgs("14 @u:s.co @v:s.co @w:z.uk")).toEqual({
targetVersion: "14",
additionalCreators: ["@u:s.co", "@v:s.co", "@w:z.uk"],
});
});
it("should upgrade the room when given valid arguments", async () => {
// Given the user clicks continue in the Upgrade Room dialog
const { command, client, createDialog, upgradeRoom } = setUp(true);
// When we type /upgraderoom ...
const result = command.run(client, roomId, null, "12 @foo:bar.com @baz:qux.uk");
expect(result.promise).toBeDefined();
await result.promise;
// Then we warned the user
expect(createDialog).toHaveBeenCalledWith(
RoomUpgradeWarningDialog,
{ roomId: "!room:example.com", targetVersion: "12" },
undefined,
false,
true,
);
// And when they said yes, we called into upgradeRoom
expect(upgradeRoom).toHaveBeenCalledWith("!room:example.com", "12", ["@foo:bar.com", "@baz:qux.uk"]);
});
it("should not upgrade the room if the user changes their mind", async () => {
// Given the user cancels the upgrade dialog
const { command, client, createDialog, upgradeRoom } = setUp(false);
// When we type /upgraderoom ...
const result = command.run(client, roomId, null, "12 @foo:bar.com @baz:qux.uk");
expect(result.promise).toBeDefined();
await result.promise;
// Then we warned the user
expect(createDialog).toHaveBeenCalledWith(
RoomUpgradeWarningDialog,
{ roomId: "!room:example.com", targetVersion: "12" },
undefined,
false,
true,
);
// And when they said no, we did not call into upgradeRoom
expect(upgradeRoom).not.toHaveBeenCalledWith("!room:example.com", "12", ["@foo:bar.com", "@baz:qux.uk"]);
});
});