Vencord/src/utils/lazy.ts

105 lines
3.3 KiB
TypeScript
Raw Normal View History

2022-10-21 23:17:06 +00:00
/*
* 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/>.
*/
2023-09-23 01:25:19 +00:00
export function makeLazy<T>(factory: () => T, attempts = 5): () => T {
let tries = 0;
2023-05-05 23:36:00 +00:00
let cache: T;
2023-09-23 01:25:19 +00:00
return () => {
if (!cache && attempts > tries++) {
cache = factory();
if (!cache && attempts === tries)
console.error("Lazy factory failed:", factory);
}
return cache;
};
2023-05-05 23:36:00 +00:00
}
2022-11-06 17:00:59 +00:00
// Proxies demand that these properties be unmodified, so proxyLazy
// will always return the function default for them.
const unconfigurable = ["arguments", "caller", "prototype"];
2022-10-14 19:34:35 +00:00
2022-11-06 17:00:59 +00:00
const handler: ProxyHandler<any> = {};
2023-07-05 22:53:43 +00:00
const kGET = Symbol.for("vencord.lazy.get");
const kCACHE = Symbol.for("vencord.lazy.cached");
2022-11-06 17:00:59 +00:00
for (const method of [
"apply",
"construct",
"defineProperty",
"deleteProperty",
"get",
"getOwnPropertyDescriptor",
"getPrototypeOf",
"has",
"isExtensible",
"ownKeys",
"preventExtensions",
"set",
"setPrototypeOf"
]) {
handler[method] =
2023-07-05 22:53:43 +00:00
(target: any, ...args: any[]) => Reflect[method](target[kGET](), ...args);
2022-11-06 17:00:59 +00:00
}
handler.ownKeys = target => {
2023-07-05 22:53:43 +00:00
const v = target[kGET]();
2022-11-06 17:00:59 +00:00
const keys = Reflect.ownKeys(v);
for (const key of unconfigurable) {
if (!keys.includes(key)) keys.push(key);
}
return keys;
};
handler.getOwnPropertyDescriptor = (target, p) => {
if (typeof p === "string" && unconfigurable.includes(p))
return Reflect.getOwnPropertyDescriptor(target, p);
2023-07-05 22:53:43 +00:00
const descriptor = Reflect.getOwnPropertyDescriptor(target[kGET](), p);
if (descriptor) Object.defineProperty(target, p, descriptor);
return descriptor;
2022-11-06 17:00:59 +00:00
};
2022-10-14 20:38:36 +00:00
2022-10-14 19:34:35 +00:00
/**
* Wraps the result of {@see makeLazy} in a Proxy you can consume as if it wasn't lazy.
* On first property access, the lazy is evaluated
* @param factory lazy factory
2023-07-05 22:53:43 +00:00
* @param attempts how many times to try to evaluate the lazy before giving up
2022-10-14 19:34:35 +00:00
* @returns Proxy
*
* Note that the example below exists already as an api, see {@link findByPropsLazy}
2022-10-14 19:40:10 +00:00
* @example const mod = proxyLazy(() => findByProps("blah")); console.log(mod.blah);
2022-10-14 19:34:35 +00:00
*/
2023-07-05 22:53:43 +00:00
export function proxyLazy<T>(factory: () => T, attempts = 5): T {
let tries = 0;
const proxyDummy = Object.assign(function () { }, {
[kCACHE]: void 0 as T | undefined,
[kGET]() {
if (!proxyDummy[kCACHE] && attempts > tries++) {
proxyDummy[kCACHE] = factory();
2023-09-23 01:25:19 +00:00
if (!proxyDummy[kCACHE] && attempts === tries)
console.error("Lazy factory failed:", factory);
2023-07-05 22:53:43 +00:00
}
return proxyDummy[kCACHE];
}
});
2022-11-06 17:00:59 +00:00
return new Proxy(proxyDummy, handler) as any;
2022-10-14 19:34:35 +00:00
}