Rewrite WebpackPatcher to support new features (#3157)

Author: Nuckyz

.gitignore

@@ -8,6 +8,7 @@ vencord_installer
 .DS_Store
 
 yarn.lock
+bun.lock
 package-lock.json
 
 *.log

scripts/build/common.mjs

@@ -312,7 +312,7 @@ export const commonOpts = {
     logLevel: "info",
     bundle: true,
     watch,
-    minify: !watch,
+    minify: !watch && !IS_REPORTER,
     sourcemap: watch ? "inline" : "",
     legalComments: "linked",
     banner,

scripts/generateReport.ts

@@ -215,7 +215,7 @@ page.on("console", async e => {
 
         switch (tag) {
             case "WebpackInterceptor:":
-                const patchFailMatch = message.match(/Patch by (.+?) (had no effect|errored|found no module) \(Module id is (.+?)\): (.+)/)!;
+                const patchFailMatch = message.match(/Patch by (.+?) (had no effect|errored|found no module|took [\d.]+?ms) \(Module id is (.+?)\): (.+)/)!;
                 if (!patchFailMatch) break;
 
                 console.error(await getText());
@@ -226,7 +226,7 @@ page.on("console", async e => {
                     plugin,
                     type,
                     id,
-                    match: regex.replace(/\(\?:\[A-Za-z_\$\]\[\\w\$\]\*\)/g, "\\i"),
+                    match: regex,
                     error: await maybeGetError(e.args()[3])
                 });
 
@@ -292,7 +292,7 @@ page.on("error", e => console.error("[Error]", e.message));
 page.on("pageerror", e => {
     if (e.message.includes("Sentry successfully disabled")) return;
 
-    if (!e.message.startsWith("Object") && !e.message.includes("Cannot find module")) {
+    if (!e.message.startsWith("Object") && !e.message.includes("Cannot find module") && !/^.{1,2}$/.test(e.message)) {
         console.error("[Page Error]", e.message);
         report.otherErrors.push(e.message);
     } else {

src/Vencord.ts

@@ -23,6 +23,7 @@ export * as Util from "./utils";
 export * as QuickCss from "./utils/quickCss";
 export * as Updater from "./utils/updater";
 export * as Webpack from "./webpack";
+export * as WebpackPatcher from "./webpack/patchWebpack";
 export { PlainSettings, Settings };
 
 import "./utils/quickCss";

src/api/Settings.ts

@@ -32,9 +32,10 @@ export interface Settings {
     autoUpdate: boolean;
     autoUpdateNotification: boolean,
     useQuickCss: boolean;
+    eagerPatches: boolean;
+    enabledThemes: string[];
     enableReactDevtools: boolean;
     themeLinks: string[];
-    enabledThemes: string[];
     frameless: boolean;
     transparent: boolean;
     winCtrlQ: boolean;
@@ -81,6 +82,7 @@ const DefaultSettings: Settings = {
     autoUpdateNotification: true,
     useQuickCss: true,
     themeLinks: [],
+    eagerPatches: IS_REPORTER,
     enabledThemes: [],
     enableReactDevtools: false,
     frameless: false,

src/debug/Tracer.ts

@@ -23,35 +23,61 @@ if (IS_DEV || IS_REPORTER) {
     var logger = new Logger("Tracer", "#FFD166");
 }
 
-const noop = function () { };
-
-export const beginTrace = !(IS_DEV || IS_REPORTER) ? noop :
+export const beginTrace = !(IS_DEV || IS_REPORTER) ? () => { } :
     function beginTrace(name: string, ...args: any[]) {
-        if (name in traces)
+        if (name in traces) {
             throw new Error(`Trace ${name} already exists!`);
+        }
 
         traces[name] = [performance.now(), args];
     };
 
-export const finishTrace = !(IS_DEV || IS_REPORTER) ? noop : function finishTrace(name: string) {
-    const end = performance.now();
+export const finishTrace = !(IS_DEV || IS_REPORTER) ? () => 0 :
+    function finishTrace(name: string) {
+        const end = performance.now();
+
+        const [start, args] = traces[name];
+        delete traces[name];
 
-    const [start, args] = traces[name];
-    delete traces[name];
+        const totalTime = end - start;
+        logger.debug(`${name} took ${totalTime}ms`, args);
 
-    logger.debug(`${name} took ${end - start}ms`, args);
-};
+        return totalTime;
+    };
 
 type Func = (...args: any[]) => any;
 type TraceNameMapper<F extends Func> = (...args: Parameters<F>) => string;
 
-const noopTracer =
-    <F extends Func>(name: string, f: F, mapper?: TraceNameMapper<F>) => f;
+function noopTracerWithResults<F extends Func>(name: string, f: F, mapper?: TraceNameMapper<F>) {
+    return function (this: unknown, ...args: Parameters<F>): [ReturnType<F>, number] {
+        return [f.apply(this, args), 0];
+    };
+}
+
+function noopTracer<F extends Func>(name: string, f: F, mapper?: TraceNameMapper<F>) {
+    return f;
+}
+
+export const traceFunctionWithResults = !(IS_DEV || IS_REPORTER)
+    ? noopTracerWithResults
+    : function traceFunctionWithResults<F extends Func>(name: string, f: F, mapper?: TraceNameMapper<F>): (this: unknown, ...args: Parameters<F>) => [ReturnType<F>, number] {
+        return function (this: unknown, ...args: Parameters<F>) {
+            const traceName = mapper?.(...args) ?? name;
+
+            beginTrace(traceName, ...arguments);
+            try {
+                return [f.apply(this, args), finishTrace(traceName)];
+            } catch (e) {
+                finishTrace(traceName);
+                throw e;
+            }
+        };
+    };
 
 export const traceFunction = !(IS_DEV || IS_REPORTER)
     ? noopTracer
     : function traceFunction<F extends Func>(name: string, f: F, mapper?: TraceNameMapper<F>): F {
-        return function (this: any, ...args: Parameters<F>) {
+        return function (this: unknown, ...args: Parameters<F>) {
             const traceName = mapper?.(...args) ?? name;
 
             beginTrace(traceName, ...arguments);

src/debug/loadLazyChunks.ts

@@ -8,23 +8,27 @@ import { Logger } from "@utils/Logger";
 import { canonicalizeMatch } from "@utils/patches";
 import * as Webpack from "@webpack";
 import { wreq } from "@webpack";
-
-const LazyChunkLoaderLogger = new Logger("LazyChunkLoader");
+import { AnyModuleFactory, ModuleFactory } from "webpack";
 
 export async function loadLazyChunks() {
+    const LazyChunkLoaderLogger = new Logger("LazyChunkLoader");
+
     try {
         LazyChunkLoaderLogger.log("Loading all chunks...");
 
-        const validChunks = new Set<number>();
-        const invalidChunks = new Set<number>();
-        const deferredRequires = new Set<number>();
+        const validChunks = new Set<PropertyKey>();
+        const invalidChunks = new Set<PropertyKey>();
+        const deferredRequires = new Set<PropertyKey>();
 
-        let chunksSearchingResolve: (value: void | PromiseLike<void>) => void;
+        let chunksSearchingResolve: (value: void) => void;
         const chunksSearchingDone = new Promise<void>(r => chunksSearchingResolve = r);
 
         // True if resolved, false otherwise
         const chunksSearchPromises = [] as Array<() => boolean>;
 
+        /* This regex loads all language packs which makes webpack finds testing extremely slow, so for now, lets use one which doesnt include those
+        const LazyChunkRegex = canonicalizeMatch(/(?:(?:Promise\.all\(\[)?(\i\.e\("?[^)]+?"?\)[^\]]*?)(?:\]\))?)\.then\(\i(?:\.\i)?\.bind\(\i,"?([^)]+?)"?(?:,[^)]+?)?\)\)/g);
+        */
         const LazyChunkRegex = canonicalizeMatch(/(?:(?:Promise\.all\(\[)?(\i\.e\("?[^)]+?"?\)[^\]]*?)(?:\]\))?)\.then\(\i\.bind\(\i,"?([^)]+?)"?\)\)/g);
 
         let foundCssDebuggingLoad = false;
@@ -34,12 +38,15 @@ export async function loadLazyChunks() {
             const hasCssDebuggingLoad = foundCssDebuggingLoad ? false : (foundCssDebuggingLoad = factoryCode.includes(".cssDebuggingEnabled&&"));
 
             const lazyChunks = factoryCode.matchAll(LazyChunkRegex);
-            const validChunkGroups = new Set<[chunkIds: number[], entryPoint: number]>();
+            const validChunkGroups = new Set<[chunkIds: PropertyKey[], entryPoint: PropertyKey]>();
 
             const shouldForceDefer = false;
 
             await Promise.all(Array.from(lazyChunks).map(async ([, rawChunkIds, entryPoint]) => {
-                const chunkIds = rawChunkIds ? Array.from(rawChunkIds.matchAll(Webpack.ChunkIdsRegex)).map(m => Number(m[1])) : [];
+                const chunkIds = rawChunkIds ? Array.from(rawChunkIds.matchAll(Webpack.ChunkIdsRegex)).map(m => {
+                    const numChunkId = Number(m[1]);
+                    return Number.isNaN(numChunkId) ? m[1] : numChunkId;
+                }) : [];
 
                 if (chunkIds.length === 0) {
                     return;
@@ -74,15 +81,16 @@ export async function loadLazyChunks() {
                 }
 
                 if (!invalidChunkGroup) {
-                    validChunkGroups.add([chunkIds, Number(entryPoint)]);
+                    const numEntryPoint = Number(entryPoint);
+                    validChunkGroups.add([chunkIds, Number.isNaN(numEntryPoint) ? entryPoint : numEntryPoint]);
                 }
             }));
 
             // Loads all found valid chunk groups
             await Promise.all(
                 Array.from(validChunkGroups)
                     .map(([chunkIds]) =>
-                        Promise.all(chunkIds.map(id => wreq.e(id as any).catch(() => { })))
+                        Promise.all(chunkIds.map(id => wreq.e(id)))
                     )
             );
 
@@ -94,7 +102,7 @@ export async function loadLazyChunks() {
                         continue;
                     }
 
-                    if (wreq.m[entryPoint]) wreq(entryPoint as any);
+                    if (wreq.m[entryPoint]) wreq(entryPoint);
                 } catch (err) {
                     console.error(err);
                 }
@@ -122,41 +130,44 @@ export async function loadLazyChunks() {
             }, 0);
         }
 
-        Webpack.factoryListeners.add(factory => {
+        function factoryListener(factory: AnyModuleFactory | ModuleFactory) {
             let isResolved = false;
-            searchAndLoadLazyChunks(factory.toString()).then(() => isResolved = true);
+            searchAndLoadLazyChunks(String(factory))
+                .then(() => isResolved = true)
+                .catch(() => isResolved = true);
 
             chunksSearchPromises.push(() => isResolved);
-        });
+        }
 
+        Webpack.factoryListeners.add(factoryListener);
         for (const factoryId in wreq.m) {
-            let isResolved = false;
-            searchAndLoadLazyChunks(wreq.m[factoryId].toString()).then(() => isResolved = true);
-
-            chunksSearchPromises.push(() => isResolved);
+            factoryListener(wreq.m[factoryId]);
         }
 
         await chunksSearchingDone;
+        Webpack.factoryListeners.delete(factoryListener);
 
         // Require deferred entry points
         for (const deferredRequire of deferredRequires) {
-            wreq!(deferredRequire as any);
+            wreq(deferredRequire);
         }
 
         // All chunks Discord has mapped to asset files, even if they are not used anymore
-        const allChunks = [] as number[];
+        const allChunks = [] as PropertyKey[];
 
         // Matches "id" or id:
-        for (const currentMatch of wreq!.u.toString().matchAll(/(?:"([\deE]+?)"(?![,}]))|(?:([\deE]+?):)/g)) {
+        for (const currentMatch of String(wreq.u).matchAll(/(?:"([\deE]+?)"(?![,}]))|(?:([\deE]+?):)/g)) {
             const id = currentMatch[1] ?? currentMatch[2];
             if (id == null) continue;
 
-            allChunks.push(Number(id));
+            const numId = Number(id);
+            allChunks.push(Number.isNaN(numId) ? id : numId);
         }
 
         if (allChunks.length === 0) throw new Error("Failed to get all chunks");
 
-        // Chunks that are not loaded (not used) by Discord code anymore
+        // Chunks which our regex could not catch to load
+        // It will always contain WebWorker assets, and also currently contains some language packs which are loaded differently
         const chunksLeft = allChunks.filter(id => {
             return !(validChunks.has(id) || invalidChunks.has(id));
         });
@@ -166,12 +177,9 @@ export async function loadLazyChunks() {
                 .then(r => r.text())
                 .then(t => t.includes("importScripts("));
 
-            // Loads and requires a chunk
+            // Loads the chunk. Currently this only happens with the language packs which are loaded differently
             if (!isWorkerAsset) {
-                await wreq.e(id as any);
-                // Technically, the id of the chunk does not match the entry point
-                // But, still try it because we have no way to get the actual entry point
-                if (wreq.m[id]) wreq(id as any);
+                await wreq.e(id);
             }
         }));
 

src/debug/runReporter.ts

@@ -6,20 +6,35 @@
 
 import { Logger } from "@utils/Logger";
 import * as Webpack from "@webpack";
-import { patches } from "plugins";
+import { addPatch, patches } from "plugins";
 
 import { loadLazyChunks } from "./loadLazyChunks";
 
-const ReporterLogger = new Logger("Reporter");
-
 async function runReporter() {
+    const ReporterLogger = new Logger("Reporter");
+
     try {
         ReporterLogger.log("Starting test...");
 
-        let loadLazyChunksResolve: (value: void | PromiseLike<void>) => void;
+        let loadLazyChunksResolve: (value: void) => void;
         const loadLazyChunksDone = new Promise<void>(r => loadLazyChunksResolve = r);
 
-        Webpack.beforeInitListeners.add(() => loadLazyChunks().then((loadLazyChunksResolve)));
+        // The main patch for starting the reporter chunk loading
+        addPatch({
+            find: '"Could not find app-mount"',
+            replacement: {
+                match: /(?<="use strict";)/,
+                replace: "Vencord.Webpack._initReporter();"
+            }
+        }, "Vencord Reporter");
+
+        // @ts-ignore
+        Vencord.Webpack._initReporter = function () {
+            // initReporter is called in the patched entry point of Discord
+            // setImmediate to only start searching for lazy chunks after Discord initialized the app
+            setTimeout(() => loadLazyChunks().then(loadLazyChunksResolve), 0);
+        };
+
         await loadLazyChunksDone;
 
         for (const patch of patches) {
@@ -28,6 +43,12 @@ async function runReporter() {
             }
         }
 
+        for (const [plugin, moduleId, match, totalTime] of Vencord.WebpackPatcher.patchTimings) {
+            if (totalTime > 3) {
+                new Logger("WebpackInterceptor").warn(`Patch by ${plugin} took ${Math.round(totalTime * 100) / 100}ms (Module id is ${String(moduleId)}): ${match}`);
+            }
+        }
+
         for (const [searchType, args] of Webpack.lazyWebpackSearchHistory) {
             let method = searchType;
 
@@ -88,4 +109,6 @@ async function runReporter() {
     }
 }
 
-runReporter();
+// Run after the Vencord object has been created.
+// We need to add extra properties to it, and it is only created after all of Vencord code has ran
+setTimeout(runReporter, 0);

src/globals.d.ts

@@ -64,13 +64,8 @@ declare global {
     export var Vesktop: any;
     export var VesktopNative: any;
 
-    interface Window {
-        webpackChunkdiscord_app: {
-            push(chunk: any): any;
-            pop(): any;
-        };
+    interface Window extends Record<PropertyKey, any> {
         _: LoDashStatic;
-        [k: string]: any;
     }
 }