Warn when demoting self via /op and /deop slash commands (#11214)

* Warn when demoting self via /op and /deop slash commands * Iterate and DRY * i18n * Improve coverage * Improve coverage * Improve coverage * Iterate
2023-07-11 13:53:33 +01:00 · 2023-07-11 13:53:33 +01:00 · a8f632ae19
commit a8f632ae19
parent b6c7fe4235
8 changed files with 431 additions and 267 deletions
--- a/src/slash-commands/command.ts
+++ b/src/slash-commands/command.ts
@ -0,0 +1,116 @@
+/*
+Copyright 2015, 2016 OpenMarket Ltd
+Copyright 2018 New Vector Ltd
+Copyright 2019 Michael Telatynski <7t3chguy@gmail.com>
+Copyright 2020, 2023 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 { MatrixClient } from "matrix-js-sdk/src/matrix";
+import { SlashCommand as SlashCommandEvent } from "@matrix-org/analytics-events/types/typescript/SlashCommand";
+
+import { TimelineRenderingType } from "../contexts/RoomContext";
+import { reject } from "./utils";
+import { _t, UserFriendlyError } from "../languageHandler";
+import { PosthogAnalytics } from "../PosthogAnalytics";
+import { CommandCategories, RunResult } from "./interface";
+
+type RunFn = (
+    this: Command,
+    matrixClient: MatrixClient,
+    roomId: string,
+    threadId: string | null,
+    args?: string,
+) => RunResult;
+
+interface ICommandOpts {
+    command: string;
+    aliases?: string[];
+    args?: string;
+    description: string;
+    analyticsName?: SlashCommandEvent["command"];
+    runFn?: RunFn;
+    category: string;
+    hideCompletionAfterSpace?: boolean;
+    isEnabled?(matrixClient: MatrixClient | null): boolean;
+    renderingTypes?: TimelineRenderingType[];
+}
+
+export class Command {
+    public readonly command: string;
+    public readonly aliases: string[];
+    public readonly args?: string;
+    public readonly description: string;
+    public readonly runFn?: RunFn;
+    public readonly category: string;
+    public readonly hideCompletionAfterSpace: boolean;
+    public readonly renderingTypes?: TimelineRenderingType[];
+    public readonly analyticsName?: SlashCommandEvent["command"];
+    private readonly _isEnabled?: (matrixClient: MatrixClient | null) => boolean;
+
+    public constructor(opts: ICommandOpts) {
+        this.command = opts.command;
+        this.aliases = opts.aliases || [];
+        this.args = opts.args || "";
+        this.description = opts.description;
+        this.runFn = opts.runFn?.bind(this);
+        this.category = opts.category || CommandCategories.other;
+        this.hideCompletionAfterSpace = opts.hideCompletionAfterSpace || false;
+        this._isEnabled = opts.isEnabled;
+        this.renderingTypes = opts.renderingTypes;
+        this.analyticsName = opts.analyticsName;
+    }
+
+    public getCommand(): string {
+        return `/${this.command}`;
+    }
+
+    public getCommandWithArgs(): string {
+        return this.getCommand() + " " + this.args;
+    }
+
+    public run(matrixClient: MatrixClient, roomId: string, threadId: string | null, args?: string): RunResult {
+        // if it has no runFn then its an ignored/nop command (autocomplete only) e.g `/me`
+        if (!this.runFn) {
+            return reject(new UserFriendlyError("Command error: Unable to handle slash command."));
+        }
+
+        const renderingType = threadId ? TimelineRenderingType.Thread : TimelineRenderingType.Room;
+        if (this.renderingTypes && !this.renderingTypes?.includes(renderingType)) {
+            return reject(
+                new UserFriendlyError("Command error: Unable to find rendering type (%(renderingType)s)", {
+                    renderingType,
+                    cause: undefined,
+                }),
+            );
+        }
+
+        if (this.analyticsName) {
+            PosthogAnalytics.instance.trackEvent<SlashCommandEvent>({
+                eventName: "SlashCommand",
+                command: this.analyticsName,
+            });
+        }
+
+        return this.runFn(matrixClient, roomId, threadId, args);
+    }
+
+    public getUsage(): string {
+        return _t("Usage") + ": " + this.getCommandWithArgs();
+    }
+
+    public isEnabled(cli: MatrixClient | null): boolean {
+        return this._isEnabled?.(cli) ?? true;
+    }
+}