From ae2acdf31176d8934e5c087dfe06a06005fa5444 Mon Sep 17 00:00:00 2001 From: David Langley Date: Wed, 29 Oct 2025 09:40:21 +0000 Subject: [PATCH] Use context provided RoomViewStore within the RoomView component hierarchy (#31077) * Update ContentMessages.ts Update ContentMessages.ts * update PlaybackQueue.ts * Update SpaceHierarchy.tsx * Update ThreadView.tsx * Update RoomCallBanner.tsx * Update useRoomCall.tsx * Update DateSeparator.tsx * Update TimelineCard.tsx * Update UserInfoBasicOptions * Update slask-commands/utils.ts * lint * Update PlaybackQueue, MVoiceMessageBody and UserInfoBasicOptionsView tests. * Update RoomHeader-test.tsx * lint * Add ts docs * Update utils-test.tsx * Update message-test.ts * coverage * lint * Improve naming --------- Co-authored-by: Michael Telatynski <7t3chguy@gmail.com> --- src/ContentMessages.ts | 13 ++- src/SlashCommands.tsx | 9 +- src/audio/PlaybackQueue.ts | 24 +++-- src/autocomplete/CommandProvider.tsx | 7 +- src/components/structures/RoomView.tsx | 2 + src/components/structures/SpaceHierarchy.tsx | 27 ++++-- src/components/structures/ThreadView.tsx | 4 +- .../UserInfoBasicOptionsViewModel.tsx | 10 +-- .../views/beacon/RoomCallBanner.tsx | 6 +- .../views/dialogs/SlashCommandHelpDialog.tsx | 10 ++- .../views/messages/DateSeparator.tsx | 8 +- .../views/messages/MVoiceMessageBody.tsx | 9 +- .../views/right_panel/TimelineCard.tsx | 11 ++- .../user_info/UserInfoBasicOptionsView.tsx | 2 +- .../views/rooms/BasicMessageComposer.tsx | 5 +- .../views/rooms/EditMessageComposer.tsx | 2 +- .../views/rooms/MessageComposerButtons.tsx | 3 +- .../views/rooms/SendMessageComposer.tsx | 3 +- .../rooms/wysiwyg_composer/hooks/utils.ts | 9 +- .../rooms/wysiwyg_composer/utils/message.ts | 2 +- src/editor/commands.tsx | 10 ++- src/hooks/room/useRoomCall.tsx | 7 +- src/slash-commands/command.ts | 29 +++++- src/slash-commands/utils.ts | 9 +- test/unit-tests/SlashCommands-test.tsx | 22 ++--- test/unit-tests/audio/PlaybackQueue-test.ts | 5 +- .../autocomplete/CommandProvider-test.ts | 87 ++++++++++++++++++ .../structures/SpaceHierarchy-test.tsx | 58 +++++++++++- .../UserInfoBasicOptionsViewModel-test.tsx | 2 +- .../views/beacon/RoomCallBanner-test.tsx | 32 ++++++- .../dialogs/SlashCommandHelpDialog-test.tsx | 90 +++++++++++++++++++ .../views/messages/DateSeparator-test.tsx | 24 +++-- .../views/messages/MVoiceMessageBody-test.tsx | 3 +- .../UserInfoBasicOptionsView-test.tsx | 2 +- .../views/rooms/BasicMessageComposer-test.tsx | 22 +++++ .../rooms/RoomHeader/RoomHeader-test.tsx | 49 +++++++--- .../wysiwyg_composer/hooks/utils-test.tsx | 5 +- .../wysiwyg_composer/utils/message-test.ts | 2 +- 38 files changed, 520 insertions(+), 104 deletions(-) create mode 100644 test/unit-tests/autocomplete/CommandProvider-test.ts create mode 100644 test/unit-tests/components/views/dialogs/SlashCommandHelpDialog-test.tsx diff --git a/src/ContentMessages.ts b/src/ContentMessages.ts index bf39d9ea1f..ebfc23d43a 100644 --- a/src/ContentMessages.ts +++ b/src/ContentMessages.ts @@ -55,7 +55,6 @@ import UploadConfirmDialog from "./components/views/dialogs/UploadConfirmDialog" import { createThumbnail } from "./utils/image-media"; import { attachMentions, attachRelation } from "./utils/messages.ts"; import { doMaybeLocalRoomAction } from "./utils/local-room"; -import { SdkContextClass } from "./contexts/SDKContext"; import { blobIsAnimated } from "./utils/Image.ts"; // scraped out of a macOS hidpi (5660ppm) screenshot png @@ -428,10 +427,21 @@ export default class ContentMessages { return this.mediaConfig?.["m.upload.size"] ?? null; } + /** + * Sends a list of files to a room. + * @param files - The files to send. + * @param roomId - The ID of the room to send the files to. + * @param relation - The relation to the event being replied to. + * @param replyToEvent - The event being replied to, if any. + * @param matrixClient - The Matrix client to use for sending the files. + * @param context - The context in which the files are being sent. + * @returns A promise that resolves when the files have been sent. + */ public async sendContentListToRoom( files: File[], roomId: string, relation: IEventRelation | undefined, + replyToEvent: MatrixEvent | undefined, matrixClient: MatrixClient, context = TimelineRenderingType.Room, ): Promise { @@ -440,7 +450,6 @@ export default class ContentMessages { return; } - const replyToEvent = SdkContextClass.instance.roomViewStore.getQuotingEvent(); if (!this.mediaConfig) { // hot-path optimization to not flash a spinner if we don't need to const modal = Modal.createDialog(Spinner, undefined, "mx_Dialog_spinner"); diff --git a/src/SlashCommands.tsx b/src/SlashCommands.tsx index f0d9085507..cf87bc79d0 100644 --- a/src/SlashCommands.tsx +++ b/src/SlashCommands.tsx @@ -732,8 +732,8 @@ export const Commands = [ new Command({ command: "help", description: _td("slash_command|help"), - runFn: function () { - Modal.createDialog(SlashCommandHelpDialog); + runFn: function (cli, roomId, threadId, args) { + Modal.createDialog(SlashCommandHelpDialog, { roomId }); return success(); }, category: CommandCategories.advanced, @@ -967,14 +967,15 @@ interface ICmd { /** * Process the given text for /commands and returns a parsed command that can be used for running the operation. + * @param {string} roomId The room ID where the command was issued. * @param {string} input The raw text input by the user. * @return {ICmd} The parsed command object. * Returns an empty object if the input didn't match a command. */ -export function getCommand(input: string): ICmd { +export function getCommand(roomId: string, input: string): ICmd { const { cmd, args } = parseCommandString(input); - if (cmd && CommandMap.has(cmd) && CommandMap.get(cmd)!.isEnabled(MatrixClientPeg.get())) { + if (cmd && CommandMap.has(cmd) && CommandMap.get(cmd)!.isEnabled(MatrixClientPeg.get(), roomId)) { return { cmd: CommandMap.get(cmd), args, diff --git a/src/audio/PlaybackQueue.ts b/src/audio/PlaybackQueue.ts index f5721df6cf..025c9d2587 100644 --- a/src/audio/PlaybackQueue.ts +++ b/src/audio/PlaybackQueue.ts @@ -15,7 +15,7 @@ import { MatrixClientPeg } from "../MatrixClientPeg"; import { arrayFastClone } from "../utils/arrays"; import { PlaybackManager } from "./PlaybackManager"; import { isVoiceMessage } from "../utils/EventUtils"; -import { SdkContextClass } from "../contexts/SDKContext"; +import { type RoomViewStore } from "../stores/RoomViewStore"; /** * Audio playback queue management for a given room. This keeps track of where the user @@ -38,10 +38,18 @@ export class PlaybackQueue { private currentPlaybackId: string | null = null; // event ID, broken out from above for ease of use private recentFullPlays = new Set(); // event IDs - public constructor(private room: Room) { + /** + * Create a PlaybackQueue for a given room. + * @param room The room + * @param roomViewStore The RoomViewStore instance + */ + public constructor( + private room: Room, + private roomViewStore: RoomViewStore, + ) { this.loadClocks(); - SdkContextClass.instance.roomViewStore.addRoomListener(this.room.roomId, (isActive) => { + this.roomViewStore.addRoomListener(this.room.roomId, (isActive) => { if (!isActive) return; // Reset the state of the playbacks before they start mounting and enqueuing updates. @@ -53,14 +61,20 @@ export class PlaybackQueue { }); } - public static forRoom(roomId: string): PlaybackQueue { + /** + * Get the PlaybackQueue for a given room, creating it if necessary. + * @param roomId The ID of the room + * @param roomViewStore The RoomViewStore instance + * @returns The PlaybackQueue for the room + */ + public static forRoom(roomId: string, roomViewStore: RoomViewStore): PlaybackQueue { const cli = MatrixClientPeg.safeGet(); const room = cli.getRoom(roomId); if (!room) throw new Error("Unknown room"); if (PlaybackQueue.queues.has(room.roomId)) { return PlaybackQueue.queues.get(room.roomId)!; } - const queue = new PlaybackQueue(room); + const queue = new PlaybackQueue(room, roomViewStore); PlaybackQueue.queues.set(room.roomId, queue); return queue; } diff --git a/src/autocomplete/CommandProvider.tsx b/src/autocomplete/CommandProvider.tsx index 76d53bb865..41781c0a68 100644 --- a/src/autocomplete/CommandProvider.tsx +++ b/src/autocomplete/CommandProvider.tsx @@ -25,7 +25,7 @@ const COMMAND_RE = /(^\/\w*)(?: .*)?/g; export default class CommandProvider extends AutocompleteProvider { public matcher: QueryMatcher; - + private room: Room; public constructor(room: Room, renderingType?: TimelineRenderingType) { super({ commandRegex: COMMAND_RE, renderingType }); this.matcher = new QueryMatcher(Commands, { @@ -33,6 +33,7 @@ export default class CommandProvider extends AutocompleteProvider { funcs: [({ aliases }) => aliases.join(" ")], // aliases context: renderingType, }); + this.room = room; } public async getCompletions( @@ -51,7 +52,7 @@ export default class CommandProvider extends AutocompleteProvider { if (command[0] !== command[1]) { // The input looks like a command with arguments, perform exact match const name = command[1].slice(1); // strip leading `/` - if (CommandMap.has(name) && CommandMap.get(name)!.isEnabled(cli)) { + if (CommandMap.has(name) && CommandMap.get(name)!.isEnabled(cli, this.room.roomId)) { // some commands, namely `me` don't suit having the usage shown whilst typing their arguments if (CommandMap.get(name)!.hideCompletionAfterSpace) return []; matches = [CommandMap.get(name)!]; @@ -70,7 +71,7 @@ export default class CommandProvider extends AutocompleteProvider { return matches .filter((cmd) => { const display = !cmd.renderingTypes || cmd.renderingTypes.includes(this.renderingType); - return cmd.isEnabled(cli) && display; + return cmd.isEnabled(cli, this.room.roomId) && display; }) .map((result) => { let completion = result.getCommand() + " "; diff --git a/src/components/structures/RoomView.tsx b/src/components/structures/RoomView.tsx index 6fbe6a0081..d73b96a30d 100644 --- a/src/components/structures/RoomView.tsx +++ b/src/components/structures/RoomView.tsx @@ -1128,6 +1128,7 @@ export class RoomView extends React.Component { [payload.file], roomId, undefined, + this.state.replyToEvent, this.context.client, ); } @@ -2047,6 +2048,7 @@ export class RoomView extends React.Component { Array.from(dataTransfer.files), roomId, undefined, + this.state.replyToEvent, this.context.client, TimelineRenderingType.Room, ); diff --git a/src/components/structures/SpaceHierarchy.tsx b/src/components/structures/SpaceHierarchy.tsx index f460784dc6..9a6fd85bdb 100644 --- a/src/components/structures/SpaceHierarchy.tsx +++ b/src/components/structures/SpaceHierarchy.tsx @@ -67,10 +67,11 @@ import { type JoinRoomReadyPayload } from "../../dispatcher/payloads/JoinRoomRea import { KeyBindingAction } from "../../accessibility/KeyboardShortcuts"; import { getKeyBindingsManager } from "../../KeyBindingsManager"; import { getTopic } from "../../hooks/room/useTopic"; -import { SdkContextClass } from "../../contexts/SDKContext"; import { getDisplayAliasForAliasSet } from "../../Rooms"; import SettingsStore from "../../settings/SettingsStore"; import { filterBoolean } from "../../utils/arrays.ts"; +import { type RoomViewStore } from "../../stores/RoomViewStore.tsx"; +import RoomContext from "../../contexts/RoomContext.ts"; interface IProps { space: Room; @@ -404,7 +405,20 @@ export const showRoom = (cli: MatrixClient, hierarchy: RoomHierarchy, roomId: st }); }; -export const joinRoom = async (cli: MatrixClient, hierarchy: RoomHierarchy, roomId: string): Promise => { +/** + * Join a room. + * @param cli The Matrix client + * @param roomViewStore The RoomViewStore instance + * @param hierarchy The RoomHierarchy instance + * @param roomId The ID of the room to join + * @returns A promise that resolves when the room has been joined + */ +export const joinRoom = async ( + cli: MatrixClient, + roomViewStore: RoomViewStore, + hierarchy: RoomHierarchy, + roomId: string, +): Promise => { // Don't let the user view a room they won't be able to either peek or join: // fail earlier so they don't have to click back to the directory. if (cli.isGuest()) { @@ -418,10 +432,10 @@ export const joinRoom = async (cli: MatrixClient, hierarchy: RoomHierarchy, room }); } catch (err: unknown) { if (err instanceof MatrixError) { - SdkContextClass.instance.roomViewStore.showJoinRoomError(err, roomId); + roomViewStore.showJoinRoomError(err, roomId); } else { logger.warn("Got a non-MatrixError while joining room", err); - SdkContextClass.instance.roomViewStore.showJoinRoomError( + roomViewStore.showJoinRoomError( new MatrixError({ error: _t("error|unknown"), }), @@ -761,6 +775,7 @@ const ManageButtons: React.FC = ({ hierarchy, selected, set const SpaceHierarchy: React.FC = ({ space, initialText = "", showRoom, additionalButtons }) => { const cli = useContext(MatrixClientContext); + const roomContext = useContext(RoomContext); const [query, setQuery] = useState(initialText); const [selected, setSelected] = useState(new Map>()); // Map> @@ -855,10 +870,10 @@ const SpaceHierarchy: React.FC = ({ space, initialText = "", showRoom, a onJoinRoomClick={async (roomId, parents) => { for (const parent of parents) { if (cli.getRoom(parent)?.getMyMembership() !== KnownMembership.Join) { - await joinRoom(cli, hierarchy, parent); + await joinRoom(cli, roomContext.roomViewStore, hierarchy, parent); } } - await joinRoom(cli, hierarchy, roomId); + await joinRoom(cli, roomContext.roomViewStore, hierarchy, roomId); }} /> diff --git a/src/components/structures/ThreadView.tsx b/src/components/structures/ThreadView.tsx index 514fd9875c..8ddbbf6367 100644 --- a/src/components/structures/ThreadView.tsx +++ b/src/components/structures/ThreadView.tsx @@ -49,7 +49,6 @@ import { type ButtonEvent } from "../views/elements/AccessibleButton"; import Spinner from "../views/elements/Spinner"; import { type ComposerInsertPayload, ComposerType } from "../../dispatcher/payloads/ComposerInsertPayload"; import Heading from "../views/typography/Heading"; -import { SdkContextClass } from "../../contexts/SDKContext"; import { type ThreadPayload } from "../../dispatcher/payloads/ThreadPayload"; import { ScopedRoomContextProvider } from "../../contexts/ScopedRoomContext.tsx"; @@ -124,7 +123,7 @@ export default class ThreadView extends React.Component { const roomId = this.props.mxEvent.getRoomId(); SettingsStore.unwatchSetting(this.layoutWatcherRef); - const hasRoomChanged = SdkContextClass.instance.roomViewStore.getRoomId() !== roomId; + const hasRoomChanged = this.context.roomViewStore.getRoomId() !== roomId; if (this.props.initialEvent && !hasRoomChanged) { dis.dispatch({ action: Action.ViewRoom, @@ -334,6 +333,7 @@ export default class ThreadView extends React.Component { Array.from(dataTransfer.files), roomId, this.threadRelation, + this.context.replyToEvent, MatrixClientPeg.safeGet(), TimelineRenderingType.Thread, ); diff --git a/src/components/viewmodels/right_panel/user_info/UserInfoBasicOptionsViewModel.tsx b/src/components/viewmodels/right_panel/user_info/UserInfoBasicOptionsViewModel.tsx index 6af49cbe6a..9d286125ae 100644 --- a/src/components/viewmodels/right_panel/user_info/UserInfoBasicOptionsViewModel.tsx +++ b/src/components/viewmodels/right_panel/user_info/UserInfoBasicOptionsViewModel.tsx @@ -17,7 +17,6 @@ import PosthogTrackers from "../../../../PosthogTrackers"; import { ShareDialog } from "../../../views/dialogs/ShareDialog"; import { type ComposerInsertPayload } from "../../../../dispatcher/payloads/ComposerInsertPayload"; import { Action } from "../../../../dispatcher/actions"; -import { SdkContextClass } from "../../../../contexts/SDKContext"; import { TimelineRenderingType } from "../../../../contexts/RoomContext"; import MultiInviter from "../../../../utils/MultiInviter"; import { type ViewRoomPayload } from "../../../../dispatcher/payloads/ViewRoomPayload"; @@ -41,7 +40,7 @@ export interface UserInfoBasicOptionsState { // Method called when a share user button is clicked, will display modal with profile to share onShareUserClick: () => void; // Method called when a invite button is clicked, will display modal to invite user - onInviteUserButton: (evt: Event) => Promise; + onInviteUserButton: (fallbackRoomId: string, evt: Event) => Promise; // Method called when the DM button is clicked, will open a DM with the selected member onOpenDmForUser: (member: Member) => Promise; } @@ -91,12 +90,9 @@ export const useUserInfoBasicOptionsViewModel = (room: Room, member: User | Room }); }; - const onInviteUserButton = async (ev: Event): Promise => { + const onInviteUserButton = async (fallbackRoomId: string, ev: Event): Promise => { try { - const roomId = - member instanceof RoomMember && member.roomId - ? member.roomId - : SdkContextClass.instance.roomViewStore.getRoomId(); + const roomId = member instanceof RoomMember && member.roomId ? member.roomId : fallbackRoomId; // We use a MultiInviter to re-use the invite logic, even though we're only inviting one user. const inviter = new MultiInviter(cli, roomId || ""); diff --git a/src/components/views/beacon/RoomCallBanner.tsx b/src/components/views/beacon/RoomCallBanner.tsx index 7c2131d4b4..25109a0a5a 100644 --- a/src/components/views/beacon/RoomCallBanner.tsx +++ b/src/components/views/beacon/RoomCallBanner.tsx @@ -20,7 +20,7 @@ import { useCall } from "../../../hooks/useCall"; import { useEventEmitterState } from "../../../hooks/useEventEmitter"; import { OwnBeaconStore, OwnBeaconStoreEvent } from "../../../stores/OwnBeaconStore"; import { SessionDuration } from "../voip/CallDuration"; -import { SdkContextClass } from "../../../contexts/SDKContext"; +import { useScopedRoomContext } from "../../../contexts/ScopedRoomContext"; interface RoomCallBannerProps { roomId: Room["roomId"]; @@ -83,7 +83,7 @@ interface Props { const RoomCallBanner: React.FC = ({ roomId }) => { const call = useCall(roomId); - + const { roomViewStore } = useScopedRoomContext("roomViewStore"); // this section is to check if we have a live location share. If so, we dont show the call banner const isMonitoringLiveLocation = useEventEmitterState( OwnBeaconStore.instance, @@ -100,7 +100,7 @@ const RoomCallBanner: React.FC = ({ roomId }) => { } // Check if the call is already showing. No banner is needed in this case. - if (SdkContextClass.instance.roomViewStore.isViewingCall()) { + if (roomViewStore.isViewingCall()) { return null; } diff --git a/src/components/views/dialogs/SlashCommandHelpDialog.tsx b/src/components/views/dialogs/SlashCommandHelpDialog.tsx index 819d28513e..0ac1a0de0d 100644 --- a/src/components/views/dialogs/SlashCommandHelpDialog.tsx +++ b/src/components/views/dialogs/SlashCommandHelpDialog.tsx @@ -13,14 +13,20 @@ import { type Command, CommandCategories, Commands } from "../../../SlashCommand import InfoDialog from "./InfoDialog"; import { MatrixClientPeg } from "../../../MatrixClientPeg"; +/** + * Props for {@link SlashCommandHelpDialog} + * @param roomId - The room ID to check whether commands are enabled + * @param onFinished - Callback called when the dialog is closed + */ interface IProps { + roomId: string; onFinished(): void; } -const SlashCommandHelpDialog: React.FC = ({ onFinished }) => { +const SlashCommandHelpDialog: React.FC = ({ roomId, onFinished }) => { const categories: Record = {}; Commands.forEach((cmd) => { - if (!cmd.isEnabled(MatrixClientPeg.get())) return; + if (!cmd.isEnabled(MatrixClientPeg.get(), roomId)) return; if (!categories[cmd.category]) { categories[cmd.category] = []; } diff --git a/src/components/views/messages/DateSeparator.tsx b/src/components/views/messages/DateSeparator.tsx index 9edb5fb94e..3b9a1bc393 100644 --- a/src/components/views/messages/DateSeparator.tsx +++ b/src/components/views/messages/DateSeparator.tsx @@ -31,8 +31,8 @@ import IconizedContextMenu, { } from "../context_menus/IconizedContextMenu"; import JumpToDatePicker from "./JumpToDatePicker"; import { type ViewRoomPayload } from "../../../dispatcher/payloads/ViewRoomPayload"; -import { SdkContextClass } from "../../../contexts/SDKContext"; import TimelineSeparator from "./TimelineSeparator"; +import RoomContext from "../../../contexts/RoomContext"; interface IProps { roomId: string; @@ -51,6 +51,8 @@ interface IState { * Has additional jump to date functionality when labs flag is enabled */ export default class DateSeparator extends React.Component { + public static contextType = RoomContext; + declare public context: React.ContextType; private settingWatcherRef?: string; public constructor(props: IProps) { @@ -143,7 +145,7 @@ export default class DateSeparator extends React.Component { // Only try to navigate to the room if the user is still viewing the same // room. We don't want to jump someone back to a room after a slow request // if they've already navigated away to another room. - const currentRoomId = SdkContextClass.instance.roomViewStore.getRoomId(); + const currentRoomId = this.context.roomViewStore.getRoomId(); if (currentRoomId === roomIdForJumpRequest) { dispatcher.dispatch({ action: Action.ViewRoom, @@ -169,7 +171,7 @@ export default class DateSeparator extends React.Component { // don't want to worry someone about an error in a room they no longer care // about after a slow request if they've already navigated away to another // room. - const currentRoomId = SdkContextClass.instance.roomViewStore.getRoomId(); + const currentRoomId = this.context.roomViewStore.getRoomId(); if (currentRoomId === roomIdForJumpRequest) { let friendlyErrorMessage = "An error occured while trying to find and jump to the given date."; let submitDebugLogsContent: JSX.Element = <>; diff --git a/src/components/views/messages/MVoiceMessageBody.tsx b/src/components/views/messages/MVoiceMessageBody.tsx index 0f07c11576..8961009165 100644 --- a/src/components/views/messages/MVoiceMessageBody.tsx +++ b/src/components/views/messages/MVoiceMessageBody.tsx @@ -17,11 +17,18 @@ import MediaProcessingError from "./shared/MediaProcessingError"; import { isVoiceMessage } from "../../../utils/EventUtils"; import { PlaybackQueue } from "../../../audio/PlaybackQueue"; import { type Playback } from "../../../audio/Playback"; +import RoomContext from "../../../contexts/RoomContext"; export default class MVoiceMessageBody extends MAudioBody { + public static contextType = RoomContext; + declare public context: React.ContextType; + protected onMount(playback: Playback): void { if (isVoiceMessage(this.props.mxEvent)) { - PlaybackQueue.forRoom(this.props.mxEvent.getRoomId()!).unsortedEnqueue(this.props.mxEvent, playback); + PlaybackQueue.forRoom(this.props.mxEvent.getRoomId()!, this.context.roomViewStore).unsortedEnqueue( + this.props.mxEvent, + playback, + ); } } diff --git a/src/components/views/right_panel/TimelineCard.tsx b/src/components/views/right_panel/TimelineCard.tsx index 52366f099e..7a56e7c15e 100644 --- a/src/components/views/right_panel/TimelineCard.tsx +++ b/src/components/views/right_panel/TimelineCard.tsx @@ -37,7 +37,6 @@ import JumpToBottomButton from "../rooms/JumpToBottomButton"; import { type ViewRoomPayload } from "../../../dispatcher/payloads/ViewRoomPayload"; import Measured from "../elements/Measured"; import { UPDATE_EVENT } from "../../../stores/AsyncStore"; -import { SdkContextClass } from "../../../contexts/SDKContext"; import { ScopedRoomContextProvider } from "../../../contexts/ScopedRoomContext.tsx"; interface IProps { @@ -88,7 +87,7 @@ export default class TimelineCard extends React.Component { } public componentDidMount(): void { - SdkContextClass.instance.roomViewStore.addListener(UPDATE_EVENT, this.onRoomViewStoreUpdate); + this.context.roomViewStore.addListener(UPDATE_EVENT, this.onRoomViewStoreUpdate); this.dispatcherRef = dis.register(this.onAction); this.readReceiptsSettingWatcher = SettingsStore.watchSetting("showReadReceipts", null, (...[, , , value]) => this.setState({ showReadReceipts: value as boolean }), @@ -99,7 +98,7 @@ export default class TimelineCard extends React.Component { } public componentWillUnmount(): void { - SdkContextClass.instance.roomViewStore.removeListener(UPDATE_EVENT, this.onRoomViewStoreUpdate); + this.context.roomViewStore.removeListener(UPDATE_EVENT, this.onRoomViewStoreUpdate); SettingsStore.unwatchSetting(this.readReceiptsSettingWatcher); SettingsStore.unwatchSetting(this.layoutWatcherRef); @@ -109,9 +108,9 @@ export default class TimelineCard extends React.Component { private onRoomViewStoreUpdate = async (_initial?: boolean): Promise => { const newState: Pick = { - initialEventId: SdkContextClass.instance.roomViewStore.getInitialEventId(), - isInitialEventHighlighted: SdkContextClass.instance.roomViewStore.isInitialEventHighlighted(), - replyToEvent: SdkContextClass.instance.roomViewStore.getQuotingEvent(), + initialEventId: this.context.roomViewStore.getInitialEventId(), + isInitialEventHighlighted: this.context.roomViewStore.isInitialEventHighlighted(), + replyToEvent: this.context.roomViewStore.getQuotingEvent(), }; this.setState(newState); diff --git a/src/components/views/right_panel/user_info/UserInfoBasicOptionsView.tsx b/src/components/views/right_panel/user_info/UserInfoBasicOptionsView.tsx index b14bd87278..cd80d77d85 100644 --- a/src/components/views/right_panel/user_info/UserInfoBasicOptionsView.tsx +++ b/src/components/views/right_panel/user_info/UserInfoBasicOptionsView.tsx @@ -88,7 +88,7 @@ export const UserInfoBasicOptionsView: React.FC<{ role="button" onSelect={async (ev) => { ev.preventDefault(); - vm.onInviteUserButton(ev); + vm.onInviteUserButton(room.roomId, ev); }} label={_t("action|invite")} Icon={InviteIcon} diff --git a/src/components/views/rooms/BasicMessageComposer.tsx b/src/components/views/rooms/BasicMessageComposer.tsx index 23111939c2..9aee26072e 100644 --- a/src/components/views/rooms/BasicMessageComposer.tsx +++ b/src/components/views/rooms/BasicMessageComposer.tsx @@ -244,7 +244,10 @@ export default class BasicMessageEditor extends React.Component if (isTyping && this.props.model.parts[0].type === "command") { const { cmd } = parseCommandString(this.props.model.parts[0].text); const command = CommandMap.get(cmd!); - if (!command?.isEnabled(MatrixClientPeg.get()) || command.category !== CommandCategories.messages) { + if ( + !command?.isEnabled(MatrixClientPeg.get(), this.props.room.roomId) || + command.category !== CommandCategories.messages + ) { isTyping = false; } } diff --git a/src/components/views/rooms/EditMessageComposer.tsx b/src/components/views/rooms/EditMessageComposer.tsx index f6677286b8..51cd5093bf 100644 --- a/src/components/views/rooms/EditMessageComposer.tsx +++ b/src/components/views/rooms/EditMessageComposer.tsx @@ -312,7 +312,7 @@ class EditMessageComposer extends React.Component = ({ roomId, relation, children }) => { const cli = useContext(MatrixClientContext); - const roomContext = useScopedRoomContext("timelineRenderingType"); + const roomContext = useScopedRoomContext("timelineRenderingType", "replyToEvent"); const uploadInput = useRef(null); const onUploadClick = (): void => { @@ -195,6 +195,7 @@ const UploadButtonContextProvider: React.FC = ({ roomId, rel Array.from(ev.target.files!), roomId, relation, + roomContext.replyToEvent, cli, roomContext.timelineRenderingType, ); diff --git a/src/components/views/rooms/SendMessageComposer.tsx b/src/components/views/rooms/SendMessageComposer.tsx index 51b14168df..122048d85a 100644 --- a/src/components/views/rooms/SendMessageComposer.tsx +++ b/src/components/views/rooms/SendMessageComposer.tsx @@ -356,7 +356,7 @@ export class SendMessageComposer extends React.Component { // use mxid to textify user pills in a command and room alias/id for room pills if (part.type === Type.UserPill || part.type === Type.RoomPill) { @@ -46,7 +52,7 @@ export function getSlashCommand(model: EditorModel): [Command | undefined, strin } return text + part.text; }, ""); - const { cmd, args } = getCommand(commandText); + const { cmd, args } = getCommand(roomId, commandText); return [cmd, args, commandText]; } diff --git a/src/hooks/room/useRoomCall.tsx b/src/hooks/room/useRoomCall.tsx index 92f68d02f8..9f72430492 100644 --- a/src/hooks/room/useRoomCall.tsx +++ b/src/hooks/room/useRoomCall.tsx @@ -26,7 +26,6 @@ import { useRoomState } from "../useRoomState"; import { _t } from "../../languageHandler"; import { isManagedHybridWidget, isManagedHybridWidgetEnabled } from "../../widgets/ManagedHybrid"; import { type IApp } from "../../stores/WidgetStore"; -import { SdkContextClass } from "../../contexts/SDKContext"; import { UPDATE_EVENT } from "../../stores/AsyncStore"; import defaultDispatcher from "../../dispatcher/dispatcher"; import { type ViewRoomPayload } from "../../dispatcher/payloads/ViewRoomPayload"; @@ -37,6 +36,7 @@ import { UIFeature } from "../../settings/UIFeature"; import { type InteractionName } from "../../PosthogTrackers"; import { ElementCallMemberEventType } from "../../call-types"; import { LocalRoom, LocalRoomState } from "../../models/LocalRoom"; +import { useScopedRoomContext } from "../../contexts/ScopedRoomContext"; export enum PlatformCallType { ElementCall, @@ -98,6 +98,7 @@ export const useRoomCall = ( showVideoCallButton: boolean; showVoiceCallButton: boolean; } => { + const roomViewStore = useScopedRoomContext("roomViewStore").roomViewStore; // settings const groupCallsEnabled = useFeatureEnabled("feature_group_calls"); const widgetsFeatureEnabled = useSettingValue(UIFeature.Widgets); @@ -124,9 +125,9 @@ export const useRoomCall = ( const hasGroupCall = groupCall !== null; const hasActiveCallSession = useParticipantCount(groupCall) > 0; const isViewingCall = useEventEmitterState( - SdkContextClass.instance.roomViewStore, + roomViewStore, UPDATE_EVENT, - () => SdkContextClass.instance.roomViewStore.isViewingCall() || isVideoRoom(room), + () => roomViewStore.isViewingCall() || isVideoRoom(room), ); // room diff --git a/src/slash-commands/command.ts b/src/slash-commands/command.ts index 029d42db45..9619c514dd 100644 --- a/src/slash-commands/command.ts +++ b/src/slash-commands/command.ts @@ -18,6 +18,14 @@ import { _t, type TranslationKey, UserFriendlyError } from "../languageHandler"; import { PosthogAnalytics } from "../PosthogAnalytics"; import { CommandCategories, type RunResult } from "./interface"; +/** + * The function signature for the run function of a {@link Command} + * @param matrixClient - The Matrix client + * @param roomId - The room ID where the command is run + * @param threadId - The thread ID where the command is run, or null for room timeline + * @param args - The arguments passed to the command + * @returns The result of running the command + */ type RunFn = ( this: Command, matrixClient: MatrixClient, @@ -26,6 +34,19 @@ type RunFn = ( args?: string, ) => RunResult; +/** + * Options for {@link Command} + * @param command - The command name, e.g. "me" for the /me command + * @param aliases - Alternative names for the command + * @param args - The arguments for the command, e.g. "" for the /me command + * @param description - A translation key describing the command + * @param analyticsName - The name to use for analytics tracking + * @param runFn - The function to execute when the command is run + * @param category - The category of the command, e.g. CommandCategories.emoji + * @param hideCompletionAfterSpace - Whether to hide autocomplete after a space is typed + * @param isEnabled - A function to determine if the command is enabled in a given context + * @param renderingTypes - The rendering types (room/thread) where this command is valid + */ interface ICommandOpts { command: string; aliases?: string[]; @@ -35,7 +56,7 @@ interface ICommandOpts { runFn?: RunFn; category: string; hideCompletionAfterSpace?: boolean; - isEnabled?(matrixClient: MatrixClient | null): boolean; + isEnabled?(matrixClient: MatrixClient | null, roomId: string | null): boolean; renderingTypes?: TimelineRenderingType[]; } @@ -49,7 +70,7 @@ export class Command { public readonly hideCompletionAfterSpace: boolean; public readonly renderingTypes?: TimelineRenderingType[]; public readonly analyticsName?: SlashCommandEvent["command"]; - private readonly _isEnabled?: (matrixClient: MatrixClient | null) => boolean; + private readonly _isEnabled?: (matrixClient: MatrixClient | null, roomId: string | null) => boolean; public constructor(opts: ICommandOpts) { this.command = opts.command; @@ -102,7 +123,7 @@ export class Command { return _t("slash_command|usage") + ": " + this.getCommandWithArgs(); } - public isEnabled(cli: MatrixClient | null): boolean { - return this._isEnabled?.(cli) ?? true; + public isEnabled(cli: MatrixClient | null, roomId: string | null): boolean { + return this._isEnabled?.(cli, roomId) ?? true; } } diff --git a/src/slash-commands/utils.ts b/src/slash-commands/utils.ts index d9cf15d16a..a96a324d5d 100644 --- a/src/slash-commands/utils.ts +++ b/src/slash-commands/utils.ts @@ -29,8 +29,13 @@ export function successSync(value: any): RunResult { return success(Promise.resolve(value)); } -export const canAffectPowerlevels = (cli: MatrixClient | null): boolean => { - const roomId = SdkContextClass.instance.roomViewStore.getRoomId(); +/** + * Check whether the user can affect power levels in the given room + * @param cli - The Matrix client + * @param roomId - The room ID + * @returns True if the user can affect power levels, false otherwise + */ +export const canAffectPowerlevels = (cli: MatrixClient | null, roomId: string | null): boolean => { if (!cli || !roomId) return false; const room = cli?.getRoom(roomId); return !!room?.currentState.maySendStateEvent(EventType.RoomPowerLevels, cli.getSafeUserId()) && !isLocalRoom(room); diff --git a/test/unit-tests/SlashCommands-test.tsx b/test/unit-tests/SlashCommands-test.tsx index bf8d30c3dd..1f583138c4 100644 --- a/test/unit-tests/SlashCommands-test.tsx +++ b/test/unit-tests/SlashCommands-test.tsx @@ -66,7 +66,7 @@ describe("SlashCommands", () => { describe("/topic", () => { it("sets topic", async () => { - const command = getCommand("/topic pizza"); + const command = getCommand(roomId, "/topic pizza"); expect(command.cmd).toBeDefined(); expect(command.args).toBeDefined(); await command.cmd!.run(client, "room-id", null, command.args); @@ -75,7 +75,7 @@ describe("SlashCommands", () => { it("should show topic modal if no args passed", async () => { const spy = jest.spyOn(Modal, "createDialog"); - const command = getCommand("/topic")!; + const command = getCommand(roomId, "/topic")!; await command.cmd!.run(client, roomId, null); expect(spy).toHaveBeenCalled(); }); @@ -109,12 +109,12 @@ describe("SlashCommands", () => { describe("isEnabled", () => { it("should return true for Room", () => { setCurrentRoom(); - expect(command.isEnabled(client)).toBe(true); + expect(command.isEnabled(client, roomId)).toBe(true); }); it("should return false for LocalRoom", () => { setCurrentLocalRoom(); - expect(command.isEnabled(client)).toBe(false); + expect(command.isEnabled(client, roomId)).toBe(false); }); }); }); @@ -126,7 +126,7 @@ describe("SlashCommands", () => { }); it("should be enabled by default", () => { - expect(command.isEnabled(client)).toBe(true); + expect(command.isEnabled(client, roomId)).toBe(true); }); }); @@ -199,11 +199,11 @@ describe("SlashCommands", () => { room2.getCanonicalAlias = jest.fn().mockReturnValue("#baz:bar"); mocked(client.getRooms).mockReturnValue([room1, room2]); - const command = getCommand("/part #foo:bar"); + const command = getCommand(room1.roomId, "/part #foo:bar"); expect(command.cmd).toBeDefined(); expect(command.args).toBeDefined(); - await command.cmd!.run(client, "room-id", null, command.args); - expect(client.leaveRoomChain).toHaveBeenCalledWith("room-id", expect.anything()); + await command.cmd!.run(client, room1.roomId, null, command.args); + expect(client.leaveRoomChain).toHaveBeenCalledWith(room1.roomId, expect.anything()); }); it("should part room matching alt alias if found", async () => { @@ -213,11 +213,11 @@ describe("SlashCommands", () => { room2.getAltAliases = jest.fn().mockReturnValue(["#baz:bar"]); mocked(client.getRooms).mockReturnValue([room1, room2]); - const command = getCommand("/part #foo:bar"); + const command = getCommand(room1.roomId, "/part #foo:bar"); expect(command.cmd).toBeDefined(); expect(command.args).toBeDefined(); - await command.cmd!.run(client, "room-id", null, command.args!); - expect(client.leaveRoomChain).toHaveBeenCalledWith("room-id", expect.anything()); + await command.cmd!.run(client, room1.roomId, null, command.args!); + expect(client.leaveRoomChain).toHaveBeenCalledWith(room1.roomId, expect.anything()); }); }); diff --git a/test/unit-tests/audio/PlaybackQueue-test.ts b/test/unit-tests/audio/PlaybackQueue-test.ts index 59e4cd9ab4..15bad79345 100644 --- a/test/unit-tests/audio/PlaybackQueue-test.ts +++ b/test/unit-tests/audio/PlaybackQueue-test.ts @@ -12,6 +12,7 @@ import { PlaybackQueue } from "../../../src/audio/PlaybackQueue"; import { type Playback, PlaybackState } from "../../../src/audio/Playback"; import { UPDATE_EVENT } from "../../../src/stores/AsyncStore"; import { MockedPlayback } from "./MockedPlayback"; +import { SdkContextClass } from "../../../src/contexts/SDKContext"; describe("PlaybackQueue", () => { let playbackQueue: PlaybackQueue; @@ -21,7 +22,7 @@ describe("PlaybackQueue", () => { mockRoom = { getMember: jest.fn(), } as unknown as Mocked; - playbackQueue = new PlaybackQueue(mockRoom); + playbackQueue = new PlaybackQueue(mockRoom, SdkContextClass.instance.roomViewStore); }); it.each([ @@ -75,7 +76,7 @@ describe("PlaybackQueue", () => { `mx_voice_message_clocks_${mockRoom.roomId}`, JSON.stringify(Array.from(clockStates.entries())), ); - playbackQueue = new PlaybackQueue(mockRoom); + playbackQueue = new PlaybackQueue(mockRoom, SdkContextClass.instance.roomViewStore); // @ts-ignore expect(playbackQueue.clockStates.has("a")).toBe(true); diff --git a/test/unit-tests/autocomplete/CommandProvider-test.ts b/test/unit-tests/autocomplete/CommandProvider-test.ts new file mode 100644 index 0000000000..f282063901 --- /dev/null +++ b/test/unit-tests/autocomplete/CommandProvider-test.ts @@ -0,0 +1,87 @@ +/* +Copyright 2025 New Vector 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 { type Room } from "matrix-js-sdk/src/matrix"; + +import CommandProvider from "../../../src/autocomplete/CommandProvider"; +import { stubClient } from "../../test-utils"; +import { Command } from "../../../src/slash-commands/command"; +import { CommandCategories } from "../../../src/slash-commands/interface"; +import { _td } from "../../../src/languageHandler"; +import * as SlashCommands from "../../../src/SlashCommands"; + +describe("CommandProvider", () => { + let room: Room; + + beforeEach(() => { + stubClient(); + room = { + roomId: "!room:server", + } as Room; + }); + + it("should filter out disabled commands when arguments are provided", async () => { + // Create a disabled command + const disabledCommand = new Command({ + command: "disabled", + args: "", + description: _td("slash_command|spoiler"), + runFn: jest.fn(), + category: CommandCategories.messages, + isEnabled: () => false, + }); + + // Create an enabled command + const enabledCommand = new Command({ + command: "enabled", + args: "", + description: _td("slash_command|shrug"), + runFn: jest.fn(), + category: CommandCategories.messages, + isEnabled: () => true, + }); + + // Mock the Commands array and CommandMap + Object.defineProperty(SlashCommands, "Commands", { + value: [disabledCommand, enabledCommand], + configurable: true, + }); + + const mockCommandMap = new Map(); + mockCommandMap.set("disabled", disabledCommand); + mockCommandMap.set("enabled", enabledCommand); + + Object.defineProperty(SlashCommands, "CommandMap", { + value: mockCommandMap, + configurable: true, + }); + + const provider = new CommandProvider(room); + + // When we search for a disabled command with arguments + const completions = await provider.getCompletions("/disabled test", { + beginning: true, + start: 0, + end: 14, + }); + + // Then we should get no completions because the command is disabled + expect(completions).toEqual([]); + + // When we search for an enabled command with arguments + const enabledCompletions = await provider.getCompletions("/enabled test", { + beginning: true, + start: 0, + end: 13, + }); + + // Then we should get the completion because the command is enabled + // The completion preserves the arguments when the command matches + expect(enabledCompletions.length).toBe(1); + expect(enabledCompletions[0].completion).toBe("/enabled test"); + }); +}); diff --git a/test/unit-tests/components/structures/SpaceHierarchy-test.tsx b/test/unit-tests/components/structures/SpaceHierarchy-test.tsx index f0d6429789..4861b720d4 100644 --- a/test/unit-tests/components/structures/SpaceHierarchy-test.tsx +++ b/test/unit-tests/components/structures/SpaceHierarchy-test.tsx @@ -9,18 +9,19 @@ Please see LICENSE files in the repository root for full details. import React from "react"; import { mocked } from "jest-mock"; import { fireEvent, render, screen, waitFor, waitForElementToBeRemoved } from "jest-matrix-react"; -import { type HierarchyRoom, JoinRule, type MatrixClient, Room } from "matrix-js-sdk/src/matrix"; +import { type HierarchyRoom, JoinRule, MatrixError, type MatrixClient, Room } from "matrix-js-sdk/src/matrix"; import { KnownMembership } from "matrix-js-sdk/src/types"; import { RoomHierarchy } from "matrix-js-sdk/src/room-hierarchy"; import { MatrixClientPeg } from "../../../../src/MatrixClientPeg"; import { mkStubRoom, stubClient } from "../../../test-utils"; import dispatcher from "../../../../src/dispatcher/dispatcher"; -import SpaceHierarchy, { showRoom, toLocalRoom } from "../../../../src/components/structures/SpaceHierarchy"; +import SpaceHierarchy, { showRoom, toLocalRoom, joinRoom } from "../../../../src/components/structures/SpaceHierarchy"; import { Action } from "../../../../src/dispatcher/actions"; import MatrixClientContext from "../../../../src/contexts/MatrixClientContext"; import DMRoomMap from "../../../../src/utils/DMRoomMap"; import SettingsStore from "../../../../src/settings/SettingsStore"; +import { type RoomViewStore } from "../../../../src/stores/RoomViewStore"; describe("SpaceHierarchy", () => { describe("showRoom", () => { @@ -66,6 +67,59 @@ describe("SpaceHierarchy", () => { }); }); + describe("joinRoom", () => { + let client: MatrixClient; + let hierarchy: RoomHierarchy; + let roomViewStore: RoomViewStore; + let room: Room; + const roomId = "!room:server"; + + beforeEach(() => { + stubClient(); + client = MatrixClientPeg.safeGet(); + room = new Room("space-id", client, "@alice:example.com"); + hierarchy = new RoomHierarchy(room); + roomViewStore = { + showJoinRoomError: jest.fn(), + } as unknown as RoomViewStore; + + jest.spyOn(client, "isGuest").mockReturnValue(false); + jest.spyOn(dispatcher, "dispatch"); + }); + + it("should handle MatrixError exceptions when joining room", async () => { + // Mock joinRoom to throw a MatrixError + const matrixError = new MatrixError({ errcode: "M_FORBIDDEN", error: "Access denied" }); + mocked(client.joinRoom).mockRejectedValue(matrixError); + + // Attempt to join the room + await expect(joinRoom(client, roomViewStore, hierarchy, roomId)).rejects.toThrow(matrixError); + + // Verify that showJoinRoomError was called with the MatrixError + expect(roomViewStore.showJoinRoomError).toHaveBeenCalledWith(matrixError, roomId); + }); + + it("should handle non-MatrixError exceptions when joining room", async () => { + // Mock joinRoom to throw a non-MatrixError + const customError = new Error("Custom error"); + mocked(client.joinRoom).mockRejectedValue(customError); + + // Attempt to join the room + await expect(joinRoom(client, roomViewStore, hierarchy, roomId)).rejects.toThrow("Custom error"); + + // Verify that showJoinRoomError was called with a MatrixError wrapper + expect(roomViewStore.showJoinRoomError).toHaveBeenCalledWith( + expect.objectContaining({ + errcode: undefined, + data: expect.objectContaining({ + error: "Unknown error", + }), + }), + roomId, + ); + }); + }); + describe("toLocalRoom", () => { stubClient(); const client = MatrixClientPeg.safeGet(); diff --git a/test/unit-tests/components/viewmodels/right_panel/user_info/UserInfoBasicOptionsViewModel-test.tsx b/test/unit-tests/components/viewmodels/right_panel/user_info/UserInfoBasicOptionsViewModel-test.tsx index fba632199e..d3f731e20c 100644 --- a/test/unit-tests/components/viewmodels/right_panel/user_info/UserInfoBasicOptionsViewModel-test.tsx +++ b/test/unit-tests/components/viewmodels/right_panel/user_info/UserInfoBasicOptionsViewModel-test.tsx @@ -204,7 +204,7 @@ describe("", () => { jest.spyOn(Modal, "createDialog"); const { result } = renderUserInfoBasicOptionsViewModelHook(); - result.current.onInviteUserButton(new Event("click")); + result.current.onInviteUserButton("roomId", new Event("click")); // check that we have called .invite expect(spy).toHaveBeenCalledWith([defaultMember.userId]); diff --git a/test/unit-tests/components/views/beacon/RoomCallBanner-test.tsx b/test/unit-tests/components/views/beacon/RoomCallBanner-test.tsx index 38cb77eb03..908f8bdf6f 100644 --- a/test/unit-tests/components/views/beacon/RoomCallBanner-test.tsx +++ b/test/unit-tests/components/views/beacon/RoomCallBanner-test.tsx @@ -30,7 +30,9 @@ import { CallStore } from "../../../../../src/stores/CallStore"; import { WidgetMessagingStore } from "../../../../../src/stores/widgets/WidgetMessagingStore"; import { MatrixClientPeg } from "../../../../../src/MatrixClientPeg"; import { ConnectionState } from "../../../../../src/models/Call"; -import { SdkContextClass } from "../../../../../src/contexts/SDKContext"; +import { ScopedRoomContextProvider } from "../../../../../src/contexts/ScopedRoomContext"; +import { type IRoomState } from "../../../../../src/components/structures/RoomView"; +import RoomContext from "../../../../../src/contexts/RoomContext"; describe("", () => { let client: Mocked; @@ -42,6 +44,15 @@ describe("", () => { roomId: "!1:example.org", }; + const mockRoomViewStore = { + isViewingCall: jest.fn().mockReturnValue(false), + on: jest.fn(), + off: jest.fn(), + emit: jest.fn(), + }; + + let roomContext: IRoomState; + beforeEach(() => { stubClient(); @@ -59,6 +70,16 @@ describe("", () => { setupAsyncStoreWithClient(CallStore.instance, client); setupAsyncStoreWithClient(WidgetMessagingStore.instance, client); + + // Reset the mock RoomViewStore + mockRoomViewStore.isViewingCall.mockReturnValue(false); + + // Create a stable room context for this test + roomContext = { + ...RoomContext, + roomId: room.roomId, + roomViewStore: mockRoomViewStore, + } as unknown as IRoomState; }); afterEach(async () => { @@ -66,7 +87,11 @@ describe("", () => { }); const renderBanner = async (props = {}): Promise => { - render(); + render( + + + , + ); await act(() => Promise.resolve()); // Let effects settle }; @@ -117,8 +142,7 @@ describe("", () => { }); it("doesn't show banner if the call is shown", async () => { - jest.spyOn(SdkContextClass.instance.roomViewStore, "isViewingCall"); - mocked(SdkContextClass.instance.roomViewStore.isViewingCall).mockReturnValue(true); + mockRoomViewStore.isViewingCall.mockReturnValue(true); await renderBanner(); const banner = await screen.queryByText("Video call"); expect(banner).toBeFalsy(); diff --git a/test/unit-tests/components/views/dialogs/SlashCommandHelpDialog-test.tsx b/test/unit-tests/components/views/dialogs/SlashCommandHelpDialog-test.tsx new file mode 100644 index 0000000000..00e4aa96db --- /dev/null +++ b/test/unit-tests/components/views/dialogs/SlashCommandHelpDialog-test.tsx @@ -0,0 +1,90 @@ +/* +Copyright 2025 New Vector 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 React from "react"; +import { render, screen } from "jest-matrix-react"; + +import SlashCommandHelpDialog from "../../../../../src/components/views/dialogs/SlashCommandHelpDialog"; +import { stubClient } from "../../../../test-utils"; +import { Command } from "../../../../../src/slash-commands/command"; +import { CommandCategories } from "../../../../../src/slash-commands/interface"; +import { _t, _td } from "../../../../../src/languageHandler"; +import * as SlashCommands from "../../../../../src/SlashCommands"; + +describe("SlashCommandHelpDialog", () => { + const roomId = "!room:server"; + + beforeEach(() => { + stubClient(); + }); + + it("should filter out disabled commands", () => { + // Create commands with some enabled and some disabled + const enabledCommand = new Command({ + command: "enabled", + args: "", + description: _td("slash_command|spoiler"), + runFn: jest.fn(), + category: CommandCategories.messages, + isEnabled: () => true, + }); + + const disabledCommand = new Command({ + command: "disabled", + args: "", + description: _td("slash_command|shrug"), + runFn: jest.fn(), + category: CommandCategories.messages, + isEnabled: () => false, + }); + + // Mock the Commands array by replacing the property + Object.defineProperty(SlashCommands, "Commands", { + value: [enabledCommand, disabledCommand], + configurable: true, + }); + + const onFinished = jest.fn(); + render(); + + // The enabled command should be visible + expect(screen.getByText("/enabled")).toBeInTheDocument(); + + // The disabled command should not be visible + expect(screen.queryByText("/disabled")).not.toBeInTheDocument(); + }); + + it("should group commands by category", () => { + const messageCommand = new Command({ + command: "msg", + args: "", + description: _td("slash_command|plain"), + runFn: jest.fn(), + category: CommandCategories.messages, + }); + + const adminCommand = new Command({ + command: "admin", + args: "", + description: _td("slash_command|upgraderoom"), + runFn: jest.fn(), + category: CommandCategories.admin, + }); + + Object.defineProperty(SlashCommands, "Commands", { + value: [messageCommand, adminCommand], + configurable: true, + }); + + const onFinished = jest.fn(); + render(); + + // Both category headers should be present + expect(screen.getByText(_t(CommandCategories.messages))).toBeInTheDocument(); + expect(screen.getByText(_t(CommandCategories.admin))).toBeInTheDocument(); + }); +}); diff --git a/test/unit-tests/components/views/messages/DateSeparator-test.tsx b/test/unit-tests/components/views/messages/DateSeparator-test.tsx index 190872feea..30e48305be 100644 --- a/test/unit-tests/components/views/messages/DateSeparator-test.tsx +++ b/test/unit-tests/components/views/messages/DateSeparator-test.tsx @@ -14,7 +14,6 @@ import { type TimestampToEventResponse, ConnectionError, HTTPError, MatrixError import dispatcher from "../../../../../src/dispatcher/dispatcher"; import { Action } from "../../../../../src/dispatcher/actions"; import { type ViewRoomPayload } from "../../../../../src/dispatcher/payloads/ViewRoomPayload"; -import { SdkContextClass } from "../../../../../src/contexts/SDKContext"; import { formatFullDateNoTime } from "../../../../../src/DateUtils"; import SettingsStore from "../../../../../src/settings/SettingsStore"; import { UIFeature } from "../../../../../src/settings/UIFeature"; @@ -26,6 +25,9 @@ import { waitEnoughCyclesForModal, } from "../../../../test-utils"; import DateSeparator from "../../../../../src/components/views/messages/DateSeparator"; +import { ScopedRoomContextProvider } from "../../../../../src/contexts/ScopedRoomContext"; +import { type IRoomState } from "../../../../../src/components/structures/RoomView"; +import RoomContext from "../../../../../src/contexts/RoomContext"; jest.mock("../../../../../src/settings/SettingsStore"); @@ -40,13 +42,25 @@ describe("DateSeparator", () => { roomId, }; + const mockRoomViewStore = { + getRoomId: jest.fn().mockReturnValue(roomId), + }; + + const defaultRoomContext = { + ...RoomContext, + roomId, + roomViewStore: mockRoomViewStore, + } as unknown as IRoomState; + const mockClient = getMockClientWithEventEmitter({ timestampToEvent: jest.fn(), }); const getComponent = (props = {}) => render( - + + + , ); @@ -74,7 +88,7 @@ describe("DateSeparator", () => { return true; } }); - jest.spyOn(SdkContextClass.instance.roomViewStore, "getRoomId").mockReturnValue(roomId); + mockRoomViewStore.getRoomId.mockReturnValue(roomId); }); afterAll(() => { @@ -200,7 +214,7 @@ describe("DateSeparator", () => { // network request is taking a while, so we got bored, switched rooms; we // shouldn't jump back to the previous room after the network request // happens to finish later. - jest.spyOn(SdkContextClass.instance.roomViewStore, "getRoomId").mockReturnValue("!some-other-room"); + mockRoomViewStore.getRoomId.mockReturnValue("!some-other-room"); // Jump to "last week" mockClient.timestampToEvent.mockResolvedValue({ @@ -230,7 +244,7 @@ describe("DateSeparator", () => { // network request is taking a while, so we got bored, switched rooms; we // shouldn't jump back to the previous room after the network request // happens to finish later. - jest.spyOn(SdkContextClass.instance.roomViewStore, "getRoomId").mockReturnValue("!some-other-room"); + mockRoomViewStore.getRoomId.mockReturnValue("!some-other-room"); // Try to jump to "last week" but we want an error to occur and ensure that // we don't show an error dialog for it since we already switched away to diff --git a/test/unit-tests/components/views/messages/MVoiceMessageBody-test.tsx b/test/unit-tests/components/views/messages/MVoiceMessageBody-test.tsx index 4a20266af4..d31c6f7390 100644 --- a/test/unit-tests/components/views/messages/MVoiceMessageBody-test.tsx +++ b/test/unit-tests/components/views/messages/MVoiceMessageBody-test.tsx @@ -16,6 +16,7 @@ import type { MediaEventHelper } from "../../../../../src/utils/MediaEventHelper import MVoiceMessageBody from "../../../../../src/components/views/messages/MVoiceMessageBody"; import { PlaybackQueue } from "../../../../../src/audio/PlaybackQueue"; import { createTestClient } from "../../../../test-utils"; +import { SdkContextClass } from "../../../../../src/contexts/SDKContext"; describe("", () => { let event: MatrixEvent; @@ -25,7 +26,7 @@ describe("", () => { const matrixClient = createTestClient(); const room = new Room("!TESTROOM", matrixClient, "@alice:example.org"); - const playbackQueue = new PlaybackQueue(room); + const playbackQueue = new PlaybackQueue(room, SdkContextClass.instance.roomViewStore); jest.spyOn(PlaybackQueue, "forRoom").mockReturnValue(playbackQueue); jest.spyOn(playbackQueue, "unsortedEnqueue").mockReturnValue(undefined); diff --git a/test/unit-tests/components/views/right_panel/user_info/UserInfoBasicOptionsView-test.tsx b/test/unit-tests/components/views/right_panel/user_info/UserInfoBasicOptionsView-test.tsx index 3047541e65..8f0f4411da 100644 --- a/test/unit-tests/components/views/right_panel/user_info/UserInfoBasicOptionsView-test.tsx +++ b/test/unit-tests/components/views/right_panel/user_info/UserInfoBasicOptionsView-test.tsx @@ -40,7 +40,7 @@ describe("", () => { onInsertPillButton: () => jest.fn(), onReadReceiptButton: () => jest.fn(), onShareUserClick: () => jest.fn(), - onInviteUserButton: (evt: Event) => Promise.resolve(), + onInviteUserButton: (fallbackRoomId: string, evt: Event) => Promise.resolve(), onOpenDmForUser: (member: Member) => Promise.resolve(), }; diff --git a/test/unit-tests/components/views/rooms/BasicMessageComposer-test.tsx b/test/unit-tests/components/views/rooms/BasicMessageComposer-test.tsx index 798f948114..569ee80fec 100644 --- a/test/unit-tests/components/views/rooms/BasicMessageComposer-test.tsx +++ b/test/unit-tests/components/views/rooms/BasicMessageComposer-test.tsx @@ -16,6 +16,9 @@ import * as TestUtils from "../../../../test-utils"; import { MatrixClientPeg } from "../../../../../src/MatrixClientPeg"; import EditorModel from "../../../../../src/editor/model"; import { createPartCreator, createRenderer } from "../../../editor/mock"; +import { CommandPartCreator } from "../../../../../src/editor/parts"; +import DocumentOffset from "../../../../../src/editor/offset"; +import { SdkContextClass } from "../../../../../src/contexts/SDKContext"; import SettingsStore from "../../../../../src/settings/SettingsStore"; describe("BasicMessageComposer", () => { @@ -103,6 +106,25 @@ describe("BasicMessageComposer", () => { const placeholder = input[0].style.getPropertyValue("--placeholder"); expect(placeholder).toMatch("'w\\\\e'"); }); + + it("should not consider typing for unknown or disabled slash commands", async () => { + // create a command part which represents a slash command the client doesn't recognise + const commandPc = new CommandPartCreator(room as unknown as Room, client as unknown as MatrixClient, null); + const commandPart = commandPc.command("/unknown do stuff"); + const model = new EditorModel([commandPart], commandPc, renderer); + + // spy on typingStore.setSelfTyping + const spy = jest.spyOn(SdkContextClass.instance.typingStore, "setSelfTyping"); + + render(); + + // simulate typing by updating the model - this will call the component's update callback + await model.update(commandPart.text, "insertText", new DocumentOffset(commandPart.text.length, true)); + + // Since the command is not in CommandMap, it should not be considered typing + expect(spy).toHaveBeenCalledWith(room.roomId, null, false); + spy.mockRestore(); + }); }); function generateMockDataTransferForString(string: string): DataTransfer { diff --git a/test/unit-tests/components/views/rooms/RoomHeader/RoomHeader-test.tsx b/test/unit-tests/components/views/rooms/RoomHeader/RoomHeader-test.tsx index b0ffb4f1fe..86c4a9f352 100644 --- a/test/unit-tests/components/views/rooms/RoomHeader/RoomHeader-test.tsx +++ b/test/unit-tests/components/views/rooms/RoomHeader/RoomHeader-test.tsx @@ -40,6 +40,9 @@ import { filterConsole, stubClient } from "../../../../../test-utils"; import RoomHeader from "../../../../../../src/components/views/rooms/RoomHeader/RoomHeader"; import DMRoomMap from "../../../../../../src/utils/DMRoomMap"; import { MatrixClientPeg } from "../../../../../../src/MatrixClientPeg"; +import { ScopedRoomContextProvider } from "../../../../../../src/contexts/ScopedRoomContext"; +import { type IRoomState } from "../../../../../../src/components/structures/RoomView"; +import RoomContext from "../../../../../../src/contexts/RoomContext"; import RightPanelStore from "../../../../../../src/stores/right-panel/RightPanelStore"; import { RightPanelPhases } from "../../../../../../src/stores/right-panel/RightPanelStorePhases"; import LegacyCallHandler from "../../../../../../src/LegacyCallHandler"; @@ -52,7 +55,6 @@ import * as ShieldUtils from "../../../../../../src/utils/ShieldUtils"; import { Container, WidgetLayoutStore } from "../../../../../../src/stores/widgets/WidgetLayoutStore"; import MatrixClientContext from "../../../../../../src/contexts/MatrixClientContext"; import { _t } from "../../../../../../src/languageHandler"; -import { SdkContextClass } from "../../../../../../src/contexts/SDKContext"; import WidgetStore, { type IApp } from "../../../../../../src/stores/WidgetStore"; import { UIFeature } from "../../../../../../src/settings/UIFeature"; import { SettingLevel } from "../../../../../../src/settings/SettingLevel"; @@ -65,14 +67,6 @@ jest.mock("../../../../../../src/hooks/right-panel/useCurrentPhase", () => ({ }, })); -function getWrapper(): RenderOptions { - return { - wrapper: ({ children }) => ( - {children} - ), - }; -} - describe("RoomHeader", () => { filterConsole( "[getType] Room !1:example.org does not have an m.room.create event", @@ -84,6 +78,25 @@ describe("RoomHeader", () => { let setCardSpy: jest.SpyInstance | undefined; + const mockRoomViewStore = { + isViewingCall: jest.fn().mockReturnValue(false), + on: jest.fn(), + off: jest.fn(), + emit: jest.fn(), + }; + + let roomContext: IRoomState; + + function getWrapper(): RenderOptions { + return { + wrapper: ({ children }) => ( + + {children} + + ), + }; + } + beforeEach(async () => { stubClient(); room = new Room(ROOM_ID, MatrixClientPeg.get()!, "@alice:example.org", { @@ -99,6 +112,16 @@ describe("RoomHeader", () => { // Mock CallStore.instance.getCall to return null by default // Individual tests can override this when they need a specific Call object jest.spyOn(CallStore.instance, "getCall").mockReturnValue(null); + + // Reset the mock RoomViewStore + mockRoomViewStore.isViewingCall.mockReturnValue(false); + + // Create a stable room context for this test + roomContext = { + ...RoomContext, + roomId: ROOM_ID, + roomViewStore: mockRoomViewStore, + } as unknown as IRoomState; }); afterEach(() => { @@ -581,7 +604,7 @@ describe("RoomHeader", () => { it("close lobby button is shown", async () => { mockRoomMembers(room, 3); - jest.spyOn(SdkContextClass.instance.roomViewStore, "isViewingCall").mockReturnValue(true); + mockRoomViewStore.isViewingCall.mockReturnValue(true); render(, getWrapper()); getByLabelText(document.body, "Close lobby"); }); @@ -590,21 +613,21 @@ describe("RoomHeader", () => { mockRoomMembers(room, 3); // Mock CallStore to return a call with 3 participants jest.spyOn(CallStore.instance, "getCall").mockReturnValue(createMockCall(ROOM_ID, 3)); - jest.spyOn(SdkContextClass.instance.roomViewStore, "isViewingCall").mockReturnValue(true); + mockRoomViewStore.isViewingCall.mockReturnValue(true); render(, getWrapper()); getByLabelText(document.body, "Close lobby"); }); it("don't show external conference button if the call is not shown", () => { - jest.spyOn(SdkContextClass.instance.roomViewStore, "isViewingCall").mockReturnValue(false); + mockRoomViewStore.isViewingCall.mockReturnValue(false); jest.spyOn(SdkConfig, "get").mockImplementation((key) => { return { guest_spa_url: "https://guest_spa_url.com", url: "https://spa_url.com" }; }); render(, getWrapper()); expect(screen.queryByLabelText(_t("voip|get_call_link"))).not.toBeInTheDocument(); - jest.spyOn(SdkContextClass.instance.roomViewStore, "isViewingCall").mockReturnValue(true); + mockRoomViewStore.isViewingCall.mockReturnValue(true); render(, getWrapper()); diff --git a/test/unit-tests/components/views/rooms/wysiwyg_composer/hooks/utils-test.tsx b/test/unit-tests/components/views/rooms/wysiwyg_composer/hooks/utils-test.tsx index f47c8075fd..8ee3302824 100644 --- a/test/unit-tests/components/views/rooms/wysiwyg_composer/hooks/utils-test.tsx +++ b/test/unit-tests/components/views/rooms/wysiwyg_composer/hooks/utils-test.tsx @@ -85,12 +85,13 @@ describe("handleClipboardEvent", () => { clipboardData: { files: ["something here"], types: [] }, }); const output = handleClipboardEvent(originalEvent, originalEvent.clipboardData, mockRoomState, mockClient); - + const mockReplyToEvent = {} as unknown as MatrixEvent; expect(sendContentListToRoomSpy).toHaveBeenCalledTimes(1); expect(sendContentListToRoomSpy).toHaveBeenCalledWith( originalEvent.clipboardData?.files, mockRoom.roomId, undefined, // this is the event relation, an optional arg + mockReplyToEvent, mockClient, mockRoomState.timelineRenderingType, ); @@ -103,6 +104,7 @@ describe("handleClipboardEvent", () => { clipboardData: { files: ["something here"], types: [] }, }); const mockEventRelation = {} as unknown as IEventRelation; + const mockReplyToEvent = {} as unknown as MatrixEvent; const output = handleClipboardEvent( originalEvent, originalEvent.clipboardData, @@ -116,6 +118,7 @@ describe("handleClipboardEvent", () => { originalEvent.clipboardData?.files, mockRoom.roomId, mockEventRelation, // this is the event relation, an optional arg + mockReplyToEvent, mockClient, mockRoomState.timelineRenderingType, ); diff --git a/test/unit-tests/components/views/rooms/wysiwyg_composer/utils/message-test.ts b/test/unit-tests/components/views/rooms/wysiwyg_composer/utils/message-test.ts index 23f46244db..c5dbea367d 100644 --- a/test/unit-tests/components/views/rooms/wysiwyg_composer/utils/message-test.ts +++ b/test/unit-tests/components/views/rooms/wysiwyg_composer/utils/message-test.ts @@ -230,7 +230,7 @@ describe("message", () => { }); // Then - expect(getCommandSpy).toHaveBeenCalledWith(validCommand); + expect(getCommandSpy).toHaveBeenCalledWith(mockRoom.roomId, validCommand); }); it("does not call getCommand for valid command with invalid prefix", async () => {