feat: queue list command

Author: virtual-designer

src/framework/typescript/queues/Queue.ts

@@ -22,15 +22,15 @@ export type QueueOptions<T extends StorableData> = {
 abstract class Queue<T extends StorableData = StorableData> extends HasApplication {
     public static readonly uniqueName: string = "";
     public readonly data: T;
-    protected readonly guildId: Snowflake;
-    protected readonly userId: Snowflake;
-    protected readonly channelId?: Snowflake;
-    protected readonly messageId?: Snowflake;
+    public readonly guildId: Snowflake;
+    public readonly userId: Snowflake;
+    public readonly channelId?: Snowflake;
+    public readonly messageId?: Snowflake;
+    public readonly runsAt: Date;
+    public readonly repeat?: boolean;
     protected readonly manager: QueueManager;
-    protected readonly runsAt: Date;
-    protected readonly repeat?: boolean;
-    private _isExecuting: boolean = false;
 
+    private _isExecuting: boolean = false;
     private _createdAt?: Date;
     private _updatedAt?: Date;
     private _id?: number;
@@ -116,6 +116,14 @@ abstract class Queue<T extends StorableData = StorableData> extends HasApplicati
         return id;
     }
 
+    public get createdAt() {
+        return this._createdAt;
+    }
+
+    public get updatedAt() {
+        return this._updatedAt;
+    }
+
     public async delete() {
         requireNonNull(this._id, "Queue ID must be set to delete");
 

src/framework/typescript/queues/QueueManager.ts

@@ -1,6 +1,6 @@
 import { HasApplication } from "../types/HasApplication";
-import type { QueueOptions, StorableData } from "./Queue";
 import type Queue from "./Queue";
+import type { QueueOptions, StorableData } from "./Queue";
 
 export type QueueClass<T extends StorableData = StorableData> = typeof Queue<T>;
 export type QueueConstructor<T extends StorableData = StorableData> = new (
@@ -28,6 +28,10 @@ class QueueManager extends HasApplication {
         return this.queueClasses.get(name) as QueueConstructor<StorableData> | undefined;
     }
 
+    public getJobs(): ReadonlyMap<number, Queue> {
+        return this.scheduledQueues;
+    }
+
     public create<T extends StorableData>(
         queue: string | QueueClass,
         options: QueueOptions<T>
@@ -44,7 +48,10 @@ class QueueManager extends HasApplication {
         return new QueueClass(this.application, this, options);
     }
 
-    public async bulkCancel<T extends StorableData>(type: QueueClass<T>, filter: (queue: Queue<NoInfer<T>>) => boolean) {
+    public async bulkCancel<T extends StorableData>(
+        type: QueueClass<T>,
+        filter: (queue: Queue<NoInfer<T>>) => boolean
+    ) {
         for (const queue of this.scheduledQueues.values()) {
             // noinspection SuspiciousTypeOfGuard
             if (queue instanceof type && filter(queue as Queue<NoInfer<T>>)) {

src/framework/typescript/utils/embeds.ts

@@ -1,3 +1,4 @@
+import type { Client, Snowflake } from "discord.js";
 import { MessageType, type GuildBasedChannel, type Message, type User } from "discord.js";
 
 export function userInfo(user: User) {
@@ -11,3 +12,11 @@ export function channelInfo(channel: GuildBasedChannel) {
 export function messageInfo(message: Message) {
     return `ID: ${message.id}\nType: ${MessageType[message.type]}\nURL: ${message.url}`;
 }
+
+export function shortUserInfo(client: Client, userId: Snowflake) {
+    if (userId === client.user!.id) {
+        return "System";
+    }
+
+    return `<@${userId}> [\`${userId}\`]`;
+}

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

@@ -50,7 +50,13 @@ class QueueAddCommand extends Command {
 
     public override async execute(context: Context, args: QueueAddCommandArgs): Promise<void> {
         const { command, runAfter } = args;
-        const commandName = command.slice(0, Math.max(command.indexOf(" "), command.indexOf("\n")));
+        const spaceIndex = command.indexOf(" ");
+        const newLineIndex = command.indexOf("\n");
+        const index =
+            spaceIndex === -1 || newLineIndex === -1
+                ? Math.max(spaceIndex, newLineIndex)
+                : Math.min(spaceIndex, newLineIndex);
+        const commandName = command.slice(0, index === -1 ? command.length : index);
 
         if (!this.commandManager.commands.has(commandName)) {
             return void context.error(
@@ -79,6 +85,7 @@ class QueueAddCommand extends Command {
                     fromInteraction: context.isChatInput()
                 },
                 guildId: context.guildId,
+                userId: context.userId,
                 runsAt: new Date(Date.now() + runAfter.toMilliseconds())
             })
             .schedule();

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

@@ -0,0 +1,75 @@
+import { Command } from "@framework/commands/Command";
+import type Context from "@framework/commands/Context";
+import { Inject } from "@framework/container/Inject";
+import Pagination from "@framework/pagination/Pagination";
+import Queue from "@framework/queues/Queue";
+import { shortUserInfo } from "@framework/utils/embeds";
+import { Colors } from "@main/constants/Colors";
+import QueueService from "@main/services/QueueService";
+import { PermissionFlagsBits, inlineCode, italic, time } from "discord.js";
+
+// type QueueListCommandArgs = {
+//     id: number
+// };
+
+// @TakesArgument<QueueListCommandArgs>({
+//     names: ["id"],
+//     types: [IntegerArgument],
+//     optional: false,
+//     errorMessages: [{
+//         [ErrorType.Required]: "You must provide a Queued Job ID!",
+//     }],
+// })
+class QueueListCommand extends Command {
+    public override readonly name = "queue::list";
+    public override readonly description: string = "List all queued jobs in this server.";
+    public override readonly defer = true;
+    public override readonly permissions = [PermissionFlagsBits.ManageGuild];
+
+    @Inject()
+    private readonly queueService!: QueueService;
+
+    public override async execute(context: Context): Promise<void> {
+        const jobs = this.queueService.getJobs();
+
+        if (jobs.size === 0) {
+            return void (await context.error("There are currently no queued jobs in this server."));
+        }
+
+        const pagination: Pagination<Queue> = Pagination.withData(jobs.values())
+            .setLimit(5)
+            .setMaxTimeout(Pagination.DEFAULT_TIMEOUT)
+            .setMessageOptionsBuilder(({ data, maxPages, page }) => {
+                let description = "";
+
+                for (const queue of data) {
+                    description += `### Job #${queue.id}\n`;
+                    description += `**Type:** ${inlineCode((queue.constructor as unknown as { uniqueName: string }).uniqueName)}\n`;
+                    description += `**Created By:** ${queue.userId ? (queue.userId === "0" ? "[Unknown]" : shortUserInfo(this.application.client, queue.userId)) : italic("Unknown")}\n`;
+                    description += `**Creation Time:** ${queue.createdAt ? time(queue.createdAt, "R") : "`[Not yet created]`"}\n`;
+                    description += `**Execution:** ${time(queue.runsAt, "R")}\n\n`;
+                }
+
+                return {
+                    embeds: [
+                        {
+                            author: {
+                                name: `Queues in ${context.guild.name}`,
+                                icon_url: context.guild.iconURL() ?? undefined
+                            },
+                            color: Colors.Primary,
+                            description,
+                            footer: {
+                                text: `Page ${page} of ${maxPages} • ${jobs.size} queues total`
+                            }
+                        }
+                    ]
+                };
+            });
+
+        const reply = await context.reply(await pagination.getMessageOptions());
+        pagination.setInitialMessage(reply);
+    }
+}
+
+export default QueueListCommand;

src/main/typescript/commands/moderation/InfractionListCommand.ts

@@ -58,8 +58,7 @@ class InfractionListCommand extends Command {
         }
 
         const pagination: Pagination<Infraction> = Pagination.withData(infractions)
-            .setData(infractions)
-            .setLimit(3)
+            .setLimit(5)
             .setMaxTimeout(Pagination.DEFAULT_TIMEOUT)
             .setMessageOptionsBuilder(({ data, maxPages, page }) => {
                 let description = "";

src/main/typescript/services/QueueService.ts

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