Vencord/src/utils/Queue.ts

/*
 * Vencord, a modification for Discord's desktop app
 * Copyright (c) 2022 Vendicated and contributors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

import { Promisable } from "type-fest";

/**
 * A queue that can be used to run tasks consecutively.
 * Highly recommended for things like fetching data from Discord
 */
export class Queue {
    /**
     * @param maxSize The maximum amount of functions that can be queued at once.
     *                If the queue is full, the oldest function will be removed.
     */
    constructor(public readonly maxSize = Infinity) { }

    private queue = [] as Array<() => Promisable<unknown>>;

    private promise?: Promise<any>;

    private next() {
        const func = this.queue.shift();
        if (func)
            this.promise = Promise.resolve()
                .then(func)
                .finally(() => this.next());
        else
            this.promise = undefined;
    }

    private run() {
        if (!this.promise)
            this.next();
    }

    /**
     * Append a task at the end of the queue. This task will be executed after all other tasks
     * If the queue exceeds the specified maxSize, the first task in queue will be removed.
     * @param func Task
     */
    push<T>(func: () => Promisable<T>) {
        if (this.size >= this.maxSize)
            this.queue.shift();

        this.queue.push(func);
        this.run();
    }

    /**
     * Prepend a task at the beginning of the queue. This task will be executed next
     * If the queue exceeds the specified maxSize, the last task in queue will be removed.
     * @param func Task
     */
    unshift<T>(func: () => Promisable<T>) {
        if (this.size >= this.maxSize)
            this.queue.pop();

        this.queue.unshift(func);
        this.run();
    }

    /**
     * The amount of tasks in the queue
     */
    get size() {
        return this.queue.length;
    }
}