/* * 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 . */ import { proxyLazy } from "@utils/lazy"; import { LazyComponent } from "@utils/lazyReact"; import { Logger } from "@utils/Logger"; import { canonicalizeMatch } from "@utils/patches"; import type { WebpackInstance } from "discord-types/other"; import { traceFunction } from "../debug/Tracer"; const logger = new Logger("Webpack"); export let _resolveReady: () => void; /** * Fired once a gateway connection to Discord has been established. * This indicates that the core webpack modules have been initialised */ export const onceReady = new Promise(r => _resolveReady = r); export let wreq: WebpackInstance; export let cache: WebpackInstance["c"]; export type FilterFn = (mod: any) => boolean; export const filters = { byProps: (...props: string[]): FilterFn => props.length === 1 ? m => m[props[0]] !== void 0 : m => props.every(p => m[p] !== void 0), byCode: (...code: string[]): FilterFn => m => { if (typeof m !== "function") return false; const s = Function.prototype.toString.call(m); for (const c of code) { if (!s.includes(c)) return false; } return true; }, byStoreName: (name: string): FilterFn => m => m.constructor?.displayName === name, componentByCode: (...code: string[]): FilterFn => { const filter = filters.byCode(...code); return m => { if (filter(m)) return true; if (!m.$$typeof) return false; if (m.type && m.type.render) return filter(m.type.render); // memo + forwardRef if (m.type) return filter(m.type); // memos if (m.render) return filter(m.render); // forwardRefs return false; }; } }; export type CallbackFn = (mod: any, id: string) => void; export const subscriptions = new Map(); export const moduleListeners = new Set(); export const factoryListeners = new Set<(factory: (module: any, exports: any, require: WebpackInstance) => void) => void>(); export const beforeInitListeners = new Set<(wreq: WebpackInstance) => void>(); export function _initWebpack(webpackRequire: WebpackInstance) { wreq = webpackRequire; cache = webpackRequire.c; } let devToolsOpen = false; if (IS_DEV && IS_DISCORD_DESKTOP) { // At this point in time, DiscordNative has not been exposed yet, so setImmediate is needed setTimeout(() => { DiscordNative/* just to make sure */?.window.setDevtoolsCallbacks(() => devToolsOpen = true, () => devToolsOpen = false); }, 0); } export function handleModuleNotFound(method: string, ...filter: unknown[]) { const err = new Error(`webpack.${method} found no module`); logger.error(err, "Filter:", filter); // Strict behaviour in DevBuilds to fail early and make sure the issue is found if (IS_DEV && !devToolsOpen) throw err; } /** * Find the first module that matches the filter */ export const find = traceFunction("find", function find(filter: FilterFn, { isIndirect = false, isWaitFor = false }: { isIndirect?: boolean; isWaitFor?: boolean; } = {}) { if (typeof filter !== "function") throw new Error("Invalid filter. Expected a function got " + typeof filter); for (const key in cache) { const mod = cache[key]; if (!mod?.exports || mod.exports === window) continue; if (filter(mod.exports)) { return isWaitFor ? [mod.exports, key] : mod.exports; } if (mod.exports.default && mod.exports.default !== window && filter(mod.exports.default)) { const found = mod.exports.default; return isWaitFor ? [found, key] : found; } } if (!isIndirect) { handleModuleNotFound("find", filter); } return isWaitFor ? [null, null] : null; }); export function findAll(filter: FilterFn) { if (typeof filter !== "function") throw new Error("Invalid filter. Expected a function got " + typeof filter); const ret = [] as any[]; for (const key in cache) { const mod = cache[key]; if (!mod?.exports) continue; if (filter(mod.exports)) ret.push(mod.exports); if (mod.exports.default && filter(mod.exports.default)) ret.push(mod.exports.default); } return ret; } /** * Same as {@link find} but in bulk * @param filterFns Array of filters. Please note that this array will be modified in place, so if you still * need it afterwards, pass a copy. * @returns Array of results in the same order as the passed filters */ export const findBulk = traceFunction("findBulk", function findBulk(...filterFns: FilterFn[]) { if (!Array.isArray(filterFns)) throw new Error("Invalid filters. Expected function[] got " + typeof filterFns); const { length } = filterFns; if (length === 0) throw new Error("Expected at least two filters."); if (length === 1) { if (IS_DEV) { throw new Error("bulk called with only one filter. Use find"); } return find(filterFns[0]); } const filters = filterFns as Array; let found = 0; const results = Array(length); outer: for (const key in cache) { const mod = cache[key]; if (!mod?.exports) continue; for (let j = 0; j < length; j++) { const filter = filters[j]; // Already done if (filter === undefined) continue; if (filter(mod.exports)) { results[j] = mod.exports; filters[j] = undefined; if (++found === length) break outer; break; } if (mod.exports.default && filter(mod.exports.default)) { results[j] = mod.exports.default; filters[j] = undefined; if (++found === length) break outer; break; } } } if (found !== length) { const err = new Error(`Got ${length} filters, but only found ${found} modules!`); if (IS_DEV) { if (!devToolsOpen) // Strict behaviour in DevBuilds to fail early and make sure the issue is found throw err; } else { logger.warn(err); } } return results; }); /** * Find the id of the first module factory that includes all the given code * @returns string or null */ export const findModuleId = traceFunction("findModuleId", function findModuleId(...code: string[]) { outer: for (const id in wreq.m) { const str = wreq.m[id].toString(); for (const c of code) { if (!str.includes(c)) continue outer; } return id; } const err = new Error("Didn't find module with code(s):\n" + code.join("\n")); if (IS_DEV) { if (!devToolsOpen) // Strict behaviour in DevBuilds to fail early and make sure the issue is found throw err; } else { logger.warn(err); } return null; }); /** * Find the first module factory that includes all the given code * @returns The module factory or null */ export function findModuleFactory(...code: string[]) { const id = findModuleId(...code); if (!id) return null; return wreq.m[id]; } export const lazyWebpackSearchHistory = [] as Array<["find" | "findByProps" | "findByCode" | "findStore" | "findComponent" | "findComponentByCode" | "findExportedComponent" | "waitFor" | "waitForComponent" | "waitForStore" | "proxyLazyWebpack" | "LazyComponentWebpack" | "extractAndLoadChunks", any[]]>; /** * This is just a wrapper around {@link proxyLazy} to make our reporter test for your webpack finds. * * Wraps the result of {@link 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 * @param attempts how many times to try to evaluate the lazy before giving up * @returns Proxy * * Note that the example below exists already as an api, see {@link findByPropsLazy} * @example const mod = proxyLazy(() => findByProps("blah")); console.log(mod.blah); */ export function proxyLazyWebpack(factory: () => any, attempts?: number) { if (IS_DEV) lazyWebpackSearchHistory.push(["proxyLazyWebpack", [factory]]); return proxyLazy(factory, attempts); } /** * This is just a wrapper around {@link LazyComponent} to make our reporter test for your webpack finds. * * A lazy component. The factory method is called on first render. * @param factory Function returning a Component * @param attempts How many times to try to get the component before giving up * @returns Result of factory function */ export function LazyComponentWebpack(factory: () => any, attempts?: number) { if (IS_DEV) lazyWebpackSearchHistory.push(["LazyComponentWebpack", [factory]]); return LazyComponent(factory, attempts); } /** * Find the first module that matches the filter, lazily */ export function findLazy(filter: FilterFn) { if (IS_DEV) lazyWebpackSearchHistory.push(["find", [filter]]); return proxyLazy(() => find(filter)); } /** * Find the first module that has the specified properties */ export function findByProps(...props: string[]) { const res = find(filters.byProps(...props), { isIndirect: true }); if (!res) handleModuleNotFound("findByProps", ...props); return res; } /** * Find the first module that has the specified properties, lazily */ export function findByPropsLazy(...props: string[]) { if (IS_DEV) lazyWebpackSearchHistory.push(["findByProps", props]); return proxyLazy(() => findByProps(...props)); } /** * Find the first function that includes all the given code */ export function findByCode(...code: string[]) { const res = find(filters.byCode(...code), { isIndirect: true }); if (!res) handleModuleNotFound("findByCode", ...code); return res; } /** * Find the first function that includes all the given code, lazily */ export function findByCodeLazy(...code: string[]) { if (IS_DEV) lazyWebpackSearchHistory.push(["findByCode", code]); return proxyLazy(() => findByCode(...code)); } /** * Find a store by its displayName */ export function findStore(name: string) { const res = find(filters.byStoreName(name), { isIndirect: true }); if (!res) handleModuleNotFound("findStore", name); return res; } /** * Find a store by its displayName, lazily */ export function findStoreLazy(name: string) { if (IS_DEV) lazyWebpackSearchHistory.push(["findStore", [name]]); return proxyLazy(() => findStore(name)); } /** * Finds the component which includes all the given code. Checks for plain components, memos and forwardRefs */ export function findComponentByCode(...code: string[]) { const res = find(filters.componentByCode(...code), { isIndirect: true }); if (!res) handleModuleNotFound("findComponentByCode", ...code); return res; } /** * Finds the first component that matches the filter, lazily. */ export function findComponentLazy(filter: FilterFn) { if (IS_DEV) lazyWebpackSearchHistory.push(["findComponent", [filter]]); return LazyComponent(() => { const res = find(filter, { isIndirect: true }); if (!res) handleModuleNotFound("findComponent", filter); return res; }); } /** * Finds the first component that includes all the given code, lazily */ export function findComponentByCodeLazy(...code: string[]) { if (IS_DEV) lazyWebpackSearchHistory.push(["findComponentByCode", code]); return LazyComponent(() => { const res = find(filters.componentByCode(...code), { isIndirect: true }); if (!res) handleModuleNotFound("findComponentByCode", ...code); return res; }); } /** * Finds the first component that is exported by the first prop name, lazily */ export function findExportedComponentLazy(...props: string[]) { if (IS_DEV) lazyWebpackSearchHistory.push(["findExportedComponent", props]); return LazyComponent(() => { const res = find(filters.byProps(...props), { isIndirect: true }); if (!res) handleModuleNotFound("findExportedComponent", ...props); return res[props[0]]; }); } const DefaultExtractAndLoadChunksRegex = /(?:Promise\.all\((\[\i\.\i\(".+?"\).+?\])\)|Promise\.resolve\(\)).then\(\i\.bind\(\i,"(.+?)"\)\)/; /** * Extract and load chunks using their entry point * @param code An array of all the code the module factory containing the lazy chunk loading must include * @param matcher A RegExp that returns the chunk ids array as the first capture group and the entry point id as the second. Defaults to a matcher that captures the lazy chunk loading found in the module factory * @returns A promise that resolves when the chunks were loaded */ export async function extractAndLoadChunks(code: string[], matcher: RegExp = DefaultExtractAndLoadChunksRegex) { const module = findModuleFactory(...code); if (!module) { const err = new Error("extractAndLoadChunks: Couldn't find module factory"); logger.warn(err, "Code:", code, "Matcher:", matcher); return; } const match = module.toString().match(canonicalizeMatch(matcher)); if (!match) { const err = new Error("extractAndLoadChunks: Couldn't find chunk loading in module factory code"); logger.warn(err, "Code:", code, "Matcher:", matcher); // Strict behaviour in DevBuilds to fail early and make sure the issue is found if (IS_DEV && !devToolsOpen) throw err; return; } const [, rawChunkIds, entryPointId] = match; if (Number.isNaN(entryPointId)) { const err = new Error("extractAndLoadChunks: Matcher didn't return a capturing group with the chunk ids array, or the entry point id returned as the second group wasn't a number"); logger.warn(err, "Code:", code, "Matcher:", matcher); // Strict behaviour in DevBuilds to fail early and make sure the issue is found if (IS_DEV && !devToolsOpen) throw err; return; } if (rawChunkIds) { const chunkIds = Array.from(rawChunkIds.matchAll(/\("(.+?)"\)/g)).map((m: any) => m[1]); await Promise.all(chunkIds.map(id => wreq.e(id))); } wreq(entryPointId); } /** * This is just a wrapper around {@link extractAndLoadChunks} to make our reporter test for your webpack finds. * * Extract and load chunks using their entry point * @param code An array of all the code the module factory containing the lazy chunk loading must include * @param matcher A RegExp that returns the chunk ids array as the first capture group and the entry point id as the second. Defaults to a matcher that captures the lazy chunk loading found in the module factory * @returns A function that returns a promise that resolves when the chunks were loaded, on first call */ export function extractAndLoadChunksLazy(code: string[], matcher = DefaultExtractAndLoadChunksRegex) { if (IS_DEV) lazyWebpackSearchHistory.push(["extractAndLoadChunks", [code, matcher]]); return () => extractAndLoadChunks(code, matcher); } /** * Wait for a module that matches the provided filter to be registered, * then call the callback with the module as the first argument */ export function waitFor(filter: string | string[] | FilterFn, callback: CallbackFn, { isIndirect = false }: { isIndirect?: boolean; } = {}) { if (IS_DEV && !isIndirect) lazyWebpackSearchHistory.push(["waitFor", Array.isArray(filter) ? filter : [filter]]); if (typeof filter === "string") filter = filters.byProps(filter); else if (Array.isArray(filter)) filter = filters.byProps(...filter); else if (typeof filter !== "function") throw new Error("filter must be a string, string[] or function, got " + typeof filter); if (cache != null) { const [existing, id] = find(filter, { isIndirect: true, isWaitFor: true }); if (existing) return void callback(existing, id); } subscriptions.set(filter, callback); } /** * Search modules by keyword. This searches the factory methods, * meaning you can search all sorts of things, displayName, methodName, strings somewhere in the code, etc * @param filters One or more strings or regexes * @returns Mapping of found modules */ export function search(...filters: Array) { const results = {} as Record; const factories = wreq.m; outer: for (const id in factories) { const factory = factories[id].original ?? factories[id]; const str: string = factory.toString(); for (const filter of filters) { if (typeof filter === "string" && !str.includes(filter)) continue outer; if (filter instanceof RegExp && !filter.test(str)) continue outer; } results[id] = factory; } return results; } /** * Extract a specific module by id into its own Source File. This has no effect on * the code, it is only useful to be able to look at a specific module without having * to view a massive file. extract then returns the extracted module so you can jump to it. * As mentioned above, note that this extracted module is not actually used, * so putting breakpoints or similar will have no effect. * @param id The id of the module to extract */ export function extract(id: string | number) { const mod = wreq.m[id] as Function; if (!mod) return null; const code = ` // [EXTRACTED] WebpackModule${id} // WARNING: This module was extracted to be more easily readable. // This module is NOT ACTUALLY USED! This means putting breakpoints will have NO EFFECT!! 0,${mod.toString()} //# sourceURL=ExtractedWebpackModule${id} `; const extracted = (0, eval)(code); return extracted as Function; }