utils/structures/Queue.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 DiscordClient from "../../client/Client";
import { generate as randomstring } from 'randomstring';
import { IQueuedJob } from "../../models/QueuedJob";

export interface QueueOptions {
    runAfter?: number;
    id?: string;
    runAt?: Date;
    model: IQueuedJob;
}

export default abstract class Queue {
    protected completed = false;
    public readonly runOn: number = 0;
    public readonly id: string;
    public readonly model: IQueuedJob;
    protected readonly timeout: NodeJS.Timeout;
    public readonly guild: string | undefined;

    constructor(protected client: DiscordClient, { runAfter, id, runAt, model }: QueueOptions) {
        if (runAfter !== 0 && runAfter !== 0 && !runAfter && !runAt) {
            throw new Error("One of runAfter or runAt must be specified for creating a queue");
        }

        this.runOn = runAfter ? Date.now() + runAfter : runAt!.getTime();
        this.id = id ?? randomstring(7);
        this.model = model;
        this.guild = model.guild;

        const ms = this.runOn - Date.now();

        this.timeout = setTimeout(async () => {
            await this.run();
            await this.finish();
        }, ms < 0 ? 0 : ms);

        console.log('Queue created: ', this.constructor.name, this.id);
    }

    get data() {
        return this.model.data;
    }

    async finish() {
        this.client.queueManager.removeQueue(this);
        console.log("Job complete: ", this.constructor.name);
    }

    async cancel() {
        clearTimeout(this.timeout);
        await this.model.delete();
        this.client.queueManager.removeQueue(this);
    }

    abstract execute(data?: { [key: string | number]: any }): Promise<any>;

    async run() {
        this.completed = true;
        this.model.delete();

        try {
            return await this.execute(this.model.data);
        }
        catch (e) {
            console.error(`An error occurred in queue job\nJob ID: ${this.id}`, e);
        }
    }
}
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 DiscordClient from "../../client/Client";
21	import { generate as randomstring } from 'randomstring';
22	import { IQueuedJob } from "../../models/QueuedJob";
23
24	export interface QueueOptions {
25	runAfter?: number;
26	id?: string;
27	runAt?: Date;
28	model: IQueuedJob;
29	}
30
31	export default abstract class Queue {
32	protected completed = false;
33	public readonly runOn: number = 0;
34	public readonly id: string;
35	public readonly model: IQueuedJob;
36	protected readonly timeout: NodeJS.Timeout;
37	public readonly guild: string \| undefined;
38
39	constructor(protected client: DiscordClient, { runAfter, id, runAt, model }: QueueOptions) {
40	if (runAfter !== 0 && runAfter !== 0 && !runAfter && !runAt) {
41	throw new Error("One of runAfter or runAt must be specified for creating a queue");
42	}
43
44	this.runOn = runAfter ? Date.now() + runAfter : runAt!.getTime();
45	this.id = id ?? randomstring(7);
46	this.model = model;
47	this.guild = model.guild;
48
49	const ms = this.runOn - Date.now();
50
51	this.timeout = setTimeout(async () => {
52	await this.run();
53	await this.finish();
54	}, ms < 0 ? 0 : ms);
55
56	console.log('Queue created: ', this.constructor.name, this.id);
57	}
58
59	get data() {
60	return this.model.data;
61	}
62
63	async finish() {
64	this.client.queueManager.removeQueue(this);
65	console.log("Job complete: ", this.constructor.name);
66	}
67
68	async cancel() {
69	clearTimeout(this.timeout);
70	await this.model.delete();
71	this.client.queueManager.removeQueue(this);
72	}
73
74	abstract execute(data?: { [key: string \| number]: any }): Promise<any>;
75
76	async run() {
77	this.completed = true;
78	this.model.delete();
79
80	try {
81	return await this.execute(this.model.data);
82	}
83	catch (e) {
84	console.error(`An error occurred in queue job\nJob ID: ${this.id}`, e);
85	}
86	}
87	}