src/services/QueueManager.ts

/**
* This file is part of SudoBot.
* 
* Copyright (C) 2021-2022 OSN Inc.
*
* SudoBot is free software; you can redistribute it and/or modify it
* under the terms of the GNU Affero General Public License as published by 
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* 
* SudoBot is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of 
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License 
* along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
*/

import { Collection } from "discord.js";
import DiscordClient from "../client/Client";
import QueuedJob from "../models/QueuedJob";
import Queue, { QueueOptions } from "../utils/structures/Queue";
import Service from "../utils/structures/Service";
import path from "path";
import { generate as randomstring } from 'randomstring';

export type QueueCreateOptions = {
    data?: { [key: string | number]: any };
    runAt?: Date;
    runAfter?: number;
    guild?: string;
};

export default class QueueManager extends Service {
    public readonly queues: Collection<string, Queue> = new Collection();

    async loadQueues() {
        const models = await QueuedJob.find();

        for await (const model of models) {
            const { default: Queue }: { default: new (client: DiscordClient, queueOptions: QueueOptions) => Queue } = await import(path.resolve(__dirname, '../queues/', model.className));
            console.log(Queue);
            this.queues.set(model.uuid, new Queue(this.client, { model, id: model.uuid, runAt: model.runOn }));
            console.log("Found queue: ", model.className);
        }
    }

    setQueue(queue: Queue) {
        this.queues.set(queue.id, queue);
    }

    cancelQueue(id: string) {
        return this.queues.get(id)?.cancel();
    }

    async addQueue(queueClass: new (client: DiscordClient, queueOptions: QueueOptions) => Queue, { data, runAt, runAfter, guild }: QueueCreateOptions) {
        if (runAfter !== 0 && runAfter !== 0 && !runAfter && !runAt) {
            throw new Error("One of runAfter or runAt must be specified for creating a queue");
        }

        const id = randomstring(7);
        const model = await QueuedJob.create({ uuid: id, data, runOn: runAfter ? new Date(Date.now() + runAfter) : runAt!, createdAt: new Date(), className: queueClass.name, guild });
        const queue = new queueClass(this.client, { model, id, runAt, runAfter });
        this.setQueue(queue);
        return queue;
    }

    runQueue(id: string) {
        return this.queues.get(id)?.run();
    }

    removeQueue(queue: Queue) {
        const { id } = queue;
        this.queues.delete(id);
    }
}   
1	/**
2	* This file is part of SudoBot.
3	*
4	* Copyright (C) 2021-2022 OSN Inc.
5	*
6	* SudoBot is free software; you can redistribute it and/or modify it
7	* under the terms of the GNU Affero General Public License as published by
8	* the Free Software Foundation, either version 3 of the License, or
9	* (at your option) any later version.
10	*
11	* SudoBot is distributed in the hope that it will be useful, but
12	* WITHOUT ANY WARRANTY; without even the implied warranty of
13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14	* GNU Affero General Public License for more details.
15	*
16	* You should have received a copy of the GNU Affero General Public License
17	* along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
18	*/
19
20	import { Collection } from "discord.js";
21	import DiscordClient from "../client/Client";
22	import QueuedJob from "../models/QueuedJob";
23	import Queue, { QueueOptions } from "../utils/structures/Queue";
24	import Service from "../utils/structures/Service";
25	import path from "path";
26	import { generate as randomstring } from 'randomstring';
27
28	export type QueueCreateOptions = {
29	data?: { [key: string \| number]: any };
30	runAt?: Date;
31	runAfter?: number;
32	guild?: string;
33	};
34
35	export default class QueueManager extends Service {
36	public readonly queues: Collection<string, Queue> = new Collection();
37
38	async loadQueues() {
39	const models = await QueuedJob.find();
40
41	for await (const model of models) {
42	const { default: Queue }: { default: new (client: DiscordClient, queueOptions: QueueOptions) => Queue } = await import(path.resolve(__dirname, '../queues/', model.className));
43	console.log(Queue);
44	this.queues.set(model.uuid, new Queue(this.client, { model, id: model.uuid, runAt: model.runOn }));
45	console.log("Found queue: ", model.className);
46	}
47	}
48
49	setQueue(queue: Queue) {
50	this.queues.set(queue.id, queue);
51	}
52
53	cancelQueue(id: string) {
54	return this.queues.get(id)?.cancel();
55	}
56
57	async addQueue(queueClass: new (client: DiscordClient, queueOptions: QueueOptions) => Queue, { data, runAt, runAfter, guild }: QueueCreateOptions) {
58	if (runAfter !== 0 && runAfter !== 0 && !runAfter && !runAt) {
59	throw new Error("One of runAfter or runAt must be specified for creating a queue");
60	}
61
62	const id = randomstring(7);
63	const model = await QueuedJob.create({ uuid: id, data, runOn: runAfter ? new Date(Date.now() + runAfter) : runAt!, createdAt: new Date(), className: queueClass.name, guild });
64	const queue = new queueClass(this.client, { model, id, runAt, runAfter });
65	this.setQueue(queue);
66	return queue;
67	}
68
69	runQueue(id: string) {
70	return this.queues.get(id)?.run();
71	}
72
73	removeQueue(queue: Queue) {
74	const { id } = queue;
75	this.queues.delete(id);
76	}
77	}