src/utils/cache.ts

/*
 * This file is part of SudoBot.
 *
 * Copyright (C) 2021-2023 OSN Developers.
 *
 * 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/>.
 */

const data = new Map<string, CacheData>();

export type CacheOptions<T extends boolean = false> = {
    ttl?: number;
    invoke?: T;
    onHit?: () => void;
};

type CacheData<T = unknown> = {
    value: T;
    timeout?: Timer;
};

type AnyFunction = (...args: unknown[]) => unknown;
type ReturnValue<I extends boolean, F extends AnyFunction> = I extends true ? ReturnType<F> : F;

export const cache = <F extends AnyFunction, I extends boolean = false>(
    id: string | number,
    fn: F,
    options?: CacheOptions<I>
): ReturnValue<I, F> => {
    const callback = ((...args: unknown[]) => {
        const finalId = [...args, id].join("_");

        if (!data.has(finalId)) {
            const cacheData: CacheData = {
                value: fn(...args)
            };

            if (options?.ttl) {
                cacheData.timeout = setTimeout(() => {
                    data.delete(finalId);
                }, options.ttl);
            }

            data.set(finalId, cacheData);
            options?.onHit?.();
        }

        return data.get(finalId)?.value;
    }) as unknown as F;

    if (options?.invoke) {
        return callback() as ReturnValue<I, F>;
    }

    return callback as ReturnValue<I, F>;
};

export const resetCache = () => {
    data.forEach(entry => entry.timeout && clearTimeout(entry.timeout));
    data.clear();
};
1	/*
2	* This file is part of SudoBot.
3	*
4	* Copyright (C) 2021-2023 OSN Developers.
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	const data = new Map<string, CacheData>();
21
22	export type CacheOptions<T extends boolean = false> = {
23	ttl?: number;
24	invoke?: T;
25	onHit?: () => void;
26	};
27
28	type CacheData<T = unknown> = {
29	value: T;
30	timeout?: Timer;
31	};
32
33	type AnyFunction = (...args: unknown[]) => unknown;
34	type ReturnValue<I extends boolean, F extends AnyFunction> = I extends true ? ReturnType<F> : F;
35
36	export const cache = <F extends AnyFunction, I extends boolean = false>(
37	id: string \| number,
38	fn: F,
39	options?: CacheOptions<I>
40	): ReturnValue<I, F> => {
41	const callback = ((...args: unknown[]) => {
42	const finalId = [...args, id].join("_");
43
44	if (!data.has(finalId)) {
45	const cacheData: CacheData = {
46	value: fn(...args)
47	};
48
49	if (options?.ttl) {
50	cacheData.timeout = setTimeout(() => {
51	data.delete(finalId);
52	}, options.ttl);
53	}
54
55	data.set(finalId, cacheData);
56	options?.onHit?.();
57	}
58
59	return data.get(finalId)?.value;
60	}) as unknown as F;
61
62	if (options?.invoke) {
63	return callback() as ReturnValue<I, F>;
64	}
65
66	return callback as ReturnValue<I, F>;
67	};
68
69	export const resetCache = () => {
70	data.forEach(entry => entry.timeout && clearTimeout(entry.timeout));
71	data.clear();
72	};