feat: queue view and cancel commands

Author: virtual-designer

src/framework/typescript/queues/QueueManager.ts

@@ -32,6 +32,10 @@ class QueueManager extends HasApplication {
         return this.scheduledQueues;
     }
 
+    public getJob(id: number) {
+        return this.scheduledQueues.get(id);
+    }
+
     public create<T extends StorableData>(
         queue: string | QueueClass,
         options: QueueOptions<T>

src/main/typescript/commands/automation/QueueCancelCommand.ts

@@ -0,0 +1,56 @@
+import { TakesArgument } from "@framework/arguments/ArgumentTypes";
+import IntegerArgument from "@framework/arguments/IntegerArgument";
+import { ErrorType } from "@framework/arguments/InvalidArgumentError";
+import { Command } from "@framework/commands/Command";
+import type Context from "@framework/commands/Context";
+import { Inject } from "@framework/container/Inject";
+import QueueService from "@main/services/QueueService";
+import { PermissionFlagsBits } from "discord.js";
+
+type QueueCancelCommandArgs = {
+    id: number;
+};
+
+@TakesArgument<QueueCancelCommandArgs>({
+    names: ["id"],
+    types: [IntegerArgument],
+    optional: false,
+    errorMessages: [
+        {
+            [ErrorType.Required]: "You must provide a Queued Job ID!",
+            [ErrorType.InvalidType]: "The provided ID is not a valid integer!"
+        }
+    ],
+    interactionName: "id"
+})
+class QueueCancelCommand extends Command {
+    public override readonly name = "queue::cancel";
+    public override readonly description: string = "Cancels a queued job.";
+    public override readonly defer = true;
+    public override readonly permissions = [PermissionFlagsBits.ManageGuild];
+    public override readonly usage = ["<id: Int>"];
+    public override readonly aliases = ["queue::remove", "queue::delete"];
+
+    @Inject()
+    private readonly queueService!: QueueService;
+
+    public override async execute(context: Context, args: QueueCancelCommandArgs): Promise<void> {
+        const job = this.queueService.getJob(args.id);
+
+        if (!job) {
+            return void (await context.error("No queued job found with that ID."));
+        }
+
+        if (job.isExecuting) {
+            return void (await context.error(
+                "You cannot cancel a job that is currently executing."
+            ));
+        }
+
+        await job.cancel();
+
+        await context.success(`Successfully cancelled the job with ID ${job.id}.`);
+    }
+}
+
+export default QueueCancelCommand;

src/main/typescript/commands/automation/QueueCommand.ts

@@ -9,7 +9,15 @@ class QueueCommand extends Command {
     public override readonly defer = true;
     public override readonly usage = ["<subcommand: String> [...args: Any[]]"];
     public override readonly systemPermissions = [];
-    public override readonly subcommands = ["list", "cancel", "show", "add"];
+    public override readonly subcommands = [
+        "list",
+        "cancel",
+        "show",
+        "view",
+        "add",
+        "remove",
+        "delete"
+    ];
     public override readonly isolatedSubcommands = true;
     public override readonly aliases = ["queues", "q"];
     public override readonly permissions = [PermissionFlagsBits.ManageGuild];

src/main/typescript/commands/automation/QueueViewCommand.ts

@@ -0,0 +1,99 @@
+import { TakesArgument } from "@framework/arguments/ArgumentTypes";
+import IntegerArgument from "@framework/arguments/IntegerArgument";
+import { ErrorType } from "@framework/arguments/InvalidArgumentError";
+import { Command } from "@framework/commands/Command";
+import type Context from "@framework/commands/Context";
+import { Inject } from "@framework/container/Inject";
+import { shortUserInfo } from "@framework/utils/embeds";
+import { Colors } from "@main/constants/Colors";
+import CommandExecutionQueue from "@main/queues/CommandExecutionQueue";
+import QueueService from "@main/services/QueueService";
+import { PermissionFlagsBits, inlineCode, italic, time } from "discord.js";
+
+type QueueViewCommandArgs = {
+    id: number;
+};
+
+@TakesArgument<QueueViewCommandArgs>({
+    names: ["id"],
+    types: [IntegerArgument],
+    optional: false,
+    errorMessages: [
+        {
+            [ErrorType.Required]: "You must provide a Queued Job ID!",
+            [ErrorType.InvalidType]: "The provided ID is not a valid integer!"
+        }
+    ],
+    interactionName: "id"
+})
+class QueueViewCommand extends Command {
+    public override readonly name = "queue::view";
+    public override readonly description: string = "Shows information about a queued job.";
+    public override readonly defer = true;
+    public override readonly permissions = [PermissionFlagsBits.ManageGuild];
+    public override readonly usage = ["<id: Int>"];
+    public override readonly aliases = ["queue::show"];
+
+    @Inject()
+    private readonly queueService!: QueueService;
+
+    public override async execute(context: Context, args: QueueViewCommandArgs): Promise<void> {
+        const job = this.queueService.getJob(args.id);
+
+        if (!job) {
+            return void (await context.error("No queued job found with that ID."));
+        }
+
+        const fields = [
+            {
+                name: "Type",
+                value: inlineCode(
+                    (job.constructor as unknown as { uniqueName: string }).uniqueName
+                ),
+                inline: false
+            },
+            {
+                name: "Created By",
+                value: job.userId
+                    ? job.userId === "0"
+                        ? "[Unknown]"
+                        : shortUserInfo(this.application.client, job.userId)
+                    : italic("Unknown"),
+                inline: false
+            },
+            {
+                name: "Creation Time",
+                value: job.createdAt
+                    ? `${time(job.createdAt, "F")} (${time(job.createdAt, "R")})`
+                    : "`[Not yet created]`",
+                inline: true
+            },
+            {
+                name: "Execution Time",
+                value: `${time(job.runsAt, "F")} (${time(job.runsAt, "R")})`,
+                inline: true
+            }
+        ];
+
+        if (job instanceof CommandExecutionQueue) {
+            fields.push({
+                name: "Command To Execute",
+                value: inlineCode(job.data.commandString),
+                inline: false
+            });
+        }
+
+        await context.reply({
+            embeds: [
+                {
+                    title: `Job #${job.id}`,
+                    color: Colors.Primary,
+                    fields,
+                    timestamp: new Date().toISOString()
+                }
+            ]
+        });
+    }
+}
+
+export default QueueViewCommand;

src/main/typescript/services/QueueService.ts

@@ -24,6 +24,10 @@ class QueueService extends Service implements HasEventListeners {
         return this.queueManager.getJobs();
     }
 
+    public getJob(id: number) {
+        return this.queueManager.getJob(id);
+    }
+
     public async sync(): Promise<void> {
         const queues = await this.application.prisma.queue.findMany({
             where: {