refactor: improve build scripts & automatic testing

- Fix reporter breaking because of ConsoleShortcuts - Fix extractAndLoadChunks issue with 2 match groups; Improve testing of lazy extractAndLoadChunks - Reporter: Properly implement reporter build of Vencord; Test more plugins; Fix running in wrong pages - Fix wrong external files and clean up build script; Remove non used stuff
Vendicated · May 30, 2024 · 05a4044 · 05a4044
1 parent 537fc5e
commit 05a4044
Show file tree

Hide file tree

Showing 22 changed files with 225 additions and 176 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -32,7 +32,7 @@ jobs:
               run: pnpm install --frozen-lockfile
 
             - name: Build web
-              run: pnpm buildWeb --standalone
+              run: pnpm buildWebStandalone
 
             - name: Build
               run: pnpm build --standalone

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -32,7 +32,7 @@ jobs:
               run: pnpm install --frozen-lockfile
 
             - name: Build web
-              run: pnpm buildWeb --standalone
+              run: pnpm buildWebStandalone
 
             - name: Publish extension
               run: |

diff --git a/.github/workflows/reportBrokenPlugins.yml b/.github/workflows/reportBrokenPlugins.yml
@@ -37,8 +37,8 @@ jobs:
               with:
                   chrome-version: stable
 
-            - name: Build web
-              run: pnpm buildWeb --standalone --dev
+            - name: Build Vencord Reporter Version
+              run: pnpm buildReporter
 
             - name: Create Report
               timeout-minutes: 10

diff --git a/package.json b/package.json
@@ -20,7 +20,10 @@
         "build": "node --require=./scripts/suppressExperimentalWarnings.js scripts/build/build.mjs",
         "buildStandalone": "pnpm build --standalone",
         "buildWeb": "node --require=./scripts/suppressExperimentalWarnings.js scripts/build/buildWeb.mjs",
+        "buildWebStandalone": "pnpm buildWeb --standalone",
+        "buildReporter": "pnpm buildWebStandalone --reporter --skip-extension",
         "watch": "pnpm build --watch",
+        "watchWeb": "pnpm buildWeb --watch",
         "generatePluginJson": "tsx scripts/generatePluginList.ts",
         "generateTypes": "tspc --emitDeclarationOnly --declaration --outDir packages/vencord-types",
         "inject": "node scripts/runInstaller.mjs",

diff --git a/scripts/build/build.mjs b/scripts/build/build.mjs
@@ -21,19 +21,21 @@ import esbuild from "esbuild";
 import { readdir } from "fs/promises";
 import { join } from "path";
 
-import { BUILD_TIMESTAMP, commonOpts, existsAsync, globPlugins, isDev, isStandalone, updaterDisabled, VERSION, watch } from "./common.mjs";
+import { BUILD_TIMESTAMP, commonOpts, exists, globPlugins, IS_DEV, IS_REPORTER, IS_STANDALONE, IS_UPDATER_DISABLED, VERSION, watch } from "./common.mjs";
 
 const defines = {
-    IS_STANDALONE: isStandalone,
-    IS_DEV: JSON.stringify(isDev),
-    IS_UPDATER_DISABLED: updaterDisabled,
+    IS_STANDALONE,
+    IS_DEV,
+    IS_REPORTER,
+    IS_UPDATER_DISABLED,
     IS_WEB: false,
     IS_EXTENSION: false,
     VERSION: JSON.stringify(VERSION),
-    BUILD_TIMESTAMP,
+    BUILD_TIMESTAMP
 };
-if (defines.IS_STANDALONE === "false")
-    // If this is a local build (not standalone), optimise
+
+if (defines.IS_STANDALONE === false)
+    // If this is a local build (not standalone), optimize
     // for the specific platform we're on
     defines["process.platform"] = JSON.stringify(process.platform);
 
@@ -46,7 +48,7 @@ const nodeCommonOpts = {
     platform: "node",
     target: ["esnext"],
     external: ["electron", "original-fs", "~pluginNatives", ...commonOpts.external],
-    define: defines,
+    define: defines
 };
 
 const sourceMapFooter = s => watch ? "" : `//# sourceMappingURL=vencord://${s}.js.map`;
@@ -73,13 +75,13 @@ const globNativesPlugin = {
             let i = 0;
             for (const dir of pluginDirs) {
                 const dirPath = join("src", dir);
-                if (!await existsAsync(dirPath)) continue;
+                if (!await exists(dirPath)) continue;
                 const plugins = await readdir(dirPath);
                 for (const p of plugins) {
                     const nativePath = join(dirPath, p, "native.ts");
                     const indexNativePath = join(dirPath, p, "native/index.ts");
 
-                    if (!(await existsAsync(nativePath)) && !(await existsAsync(indexNativePath)))
+                    if (!(await exists(nativePath)) && !(await exists(indexNativePath)))
                         continue;
 
                     const nameParts = p.split(".");

diff --git a/scripts/build/buildWeb.mjs b/scripts/build/buildWeb.mjs
@@ -23,7 +23,7 @@ import { appendFile, mkdir, readdir, readFile, rm, writeFile } from "fs/promises
 import { join } from "path";
 import Zip from "zip-local";
 
-import { BUILD_TIMESTAMP, commonOpts, globPlugins, isDev, VERSION } from "./common.mjs";
+import { BUILD_TIMESTAMP, commonOpts, globPlugins, IS_DEV, IS_REPORTER, VERSION } from "./common.mjs";
 
 /**
  * @type {esbuild.BuildOptions}
@@ -33,22 +33,23 @@ const commonOptions = {
     entryPoints: ["browser/Vencord.ts"],
     globalName: "Vencord",
     format: "iife",
-    external: ["plugins", "git-hash", "/assets/*"],
+    external: ["~plugins", "~git-hash", "/assets/*"],
     plugins: [
         globPlugins("web"),
         ...commonOpts.plugins,
     ],
     target: ["esnext"],
     define: {
-        IS_WEB: "true",
-        IS_EXTENSION: "false",
-        IS_STANDALONE: "true",
-        IS_DEV: JSON.stringify(isDev),
-        IS_DISCORD_DESKTOP: "false",
-        IS_VESKTOP: "false",
-        IS_UPDATER_DISABLED: "true",
+        IS_WEB: true,
+        IS_EXTENSION: false,
+        IS_STANDALONE: true,
+        IS_DEV,
+        IS_REPORTER,
+        IS_DISCORD_DESKTOP: false,
+        IS_VESKTOP: false,
+        IS_UPDATER_DISABLED: true,
         VERSION: JSON.stringify(VERSION),
-        BUILD_TIMESTAMP,
+        BUILD_TIMESTAMP
     }
 };
 
@@ -87,16 +88,16 @@ await Promise.all(
         esbuild.build({
             ...commonOptions,
             outfile: "dist/browser.js",
-            footer: { js: "//# sourceURL=VencordWeb" },
+            footer: { js: "//# sourceURL=VencordWeb" }
         }),
         esbuild.build({
             ...commonOptions,
             outfile: "dist/extension.js",
             define: {
                 ...commonOptions?.define,
-                IS_EXTENSION: "true",
+                IS_EXTENSION: true,
             },
-            footer: { js: "//# sourceURL=VencordWeb" },
+            footer: { js: "//# sourceURL=VencordWeb" }
         }),
         esbuild.build({
             ...commonOptions,
@@ -112,7 +113,7 @@ await Promise.all(
             footer: {
                 // UserScripts get wrapped in an iife, so define Vencord prop on window that returns our local
                 js: "Object.defineProperty(unsafeWindow,'Vencord',{get:()=>Vencord});"
-            },
+            }
         })
     ]
 );
@@ -165,7 +166,7 @@ async function buildExtension(target, files) {
                 f.startsWith("manifest") ? "manifest.json" : f,
                 content
             ];
-        }))),
+        })))
     };
 
     await rm(target, { recursive: true, force: true });
@@ -192,14 +193,19 @@ const appendCssRuntime = readFile("dist/Vencord.user.css", "utf-8").then(content
     return appendFile("dist/Vencord.user.js", cssRuntime);
 });
 
-await Promise.all([
-    appendCssRuntime,
-    buildExtension("chromium-unpacked", ["modifyResponseHeaders.json", "content.js", "manifest.json", "icon.png"]),
-    buildExtension("firefox-unpacked", ["background.js", "content.js", "manifestv2.json", "icon.png"]),
-]);
+if (!process.argv.includes("--skip-extension")) {
+    await Promise.all([
+        appendCssRuntime,
+        buildExtension("chromium-unpacked", ["modifyResponseHeaders.json", "content.js", "manifest.json", "icon.png"]),
+        buildExtension("firefox-unpacked", ["background.js", "content.js", "manifestv2.json", "icon.png"]),
+    ]);
 
-Zip.sync.zip("dist/chromium-unpacked").compress().save("dist/extension-chrome.zip");
-console.info("Packed Chromium Extension written to dist/extension-chrome.zip");
+    Zip.sync.zip("dist/chromium-unpacked").compress().save("dist/extension-chrome.zip");
+    console.info("Packed Chromium Extension written to dist/extension-chrome.zip");
 
-Zip.sync.zip("dist/firefox-unpacked").compress().save("dist/extension-firefox.zip");
-console.info("Packed Firefox Extension written to dist/extension-firefox.zip");
+    Zip.sync.zip("dist/firefox-unpacked").compress().save("dist/extension-firefox.zip");
+    console.info("Packed Firefox Extension written to dist/extension-firefox.zip");
+
+} else {
+    await appendCssRuntime;
+}
diff --git a/scripts/build/common.mjs b/scripts/build/common.mjs
@@ -35,24 +35,26 @@ const PackageJSON = JSON.parse(readFileSync("package.json"));
 export const VERSION = PackageJSON.version;
 // https://reproducible-builds.org/docs/source-date-epoch/
 export const BUILD_TIMESTAMP = Number(process.env.SOURCE_DATE_EPOCH) || Date.now();
+
 export const watch = process.argv.includes("--watch");
-export const isDev = watch || process.argv.includes("--dev");
-export const isStandalone = JSON.stringify(process.argv.includes("--standalone"));
-export const updaterDisabled = JSON.stringify(process.argv.includes("--disable-updater"));
+export const IS_DEV = watch || process.argv.includes("--dev");
+export const IS_REPORTER = process.argv.includes("--reporter");
+export const IS_STANDALONE = process.argv.includes("--standalone");
+
+export const IS_UPDATER_DISABLED = process.argv.includes("--disable-updater");
 export const gitHash = process.env.VENCORD_HASH || execSync("git rev-parse --short HEAD", { encoding: "utf-8" }).trim();
+
 export const banner = {
     js: `
 // Vencord ${gitHash}
-// Standalone: ${isStandalone}
-// Platform: ${isStandalone === "false" ? process.platform : "Universal"}
-// Updater disabled: ${updaterDisabled}
+// Standalone: ${IS_STANDALONE}
+// Platform: ${IS_STANDALONE === false ? process.platform : "Universal"}
+// Updater Disabled: ${IS_UPDATER_DISABLED}
 `.trim()
 };
 
-const isWeb = process.argv.slice(0, 2).some(f => f.endsWith("buildWeb.mjs"));
-
-export function existsAsync(path) {
-    return access(path, FsConstants.F_OK)
+export async function exists(path) {
+    return await access(path, FsConstants.F_OK)
         .then(() => true)
         .catch(() => false);
 }
@@ -66,7 +68,7 @@ export const makeAllPackagesExternalPlugin = {
     setup(build) {
         const filter = /^[^./]|^\.[^./]|^\.\.[^/]/; // Must not start with "/" or "./" or "../"
         build.onResolve({ filter }, args => ({ path: args.path, external: true }));
-    },
+    }
 };
 
 /**
@@ -89,14 +91,14 @@ export const globPlugins = kind => ({
             let plugins = "\n";
             let i = 0;
             for (const dir of pluginDirs) {
-                if (!await existsAsync(`./src/${dir}`)) continue;
+                if (!await exists(`./src/${dir}`)) continue;
                 const files = await readdir(`./src/${dir}`);
                 for (const file of files) {
                     if (file.startsWith("_") || file.startsWith(".")) continue;
                     if (file === "index.ts") continue;
 
                     const target = getPluginTarget(file);
-                    if (target) {
+                    if (target && !IS_REPORTER) {
                         if (target === "dev" && !watch) continue;
                         if (target === "web" && kind === "discordDesktop") continue;
                         if (target === "desktop" && kind === "web") continue;
@@ -178,7 +180,7 @@ export const fileUrlPlugin = {
         build.onLoad({ filter, namespace: "file-uri" }, async ({ pluginData: { path, uri } }) => {
             const { searchParams } = new URL(uri);
             const base64 = searchParams.has("base64");
-            const minify = isStandalone === "true" && searchParams.has("minify");
+            const minify = IS_STANDALONE === true && searchParams.has("minify");
             const noTrim = searchParams.get("trim") === "false";
 
             const encoding = base64 ? "base64" : "utf-8";

diff --git a/scripts/generateReport.ts b/scripts/generateReport.ts
@@ -205,7 +205,12 @@ page.on("console", async e => {
     }
 
     if (isVencord) {
-        const args = await Promise.all(e.args().map(a => a.jsonValue()));
+        let args: unknown[] = [];
+        try {
+            args = await Promise.all(e.args().map(a => a.jsonValue()));
+        } catch {
+            return;
+        }
 
         const [, tag, message] = args as Array<string>;
         const cause = await maybeGetError(e.args()[3]);
@@ -277,51 +282,15 @@ page.on("pageerror", e => console.error("[Page Error]", e));
 
 await page.setBypassCSP(true);
 
-async function runtime(token: string) {
+async function reporterRuntime(token: string) {
     console.log("[PUP_DEBUG]", "Starting test...");
 
     try {
         // Spoof languages to not be suspicious
         Object.defineProperty(navigator, "languages", {
             get: function () {
                 return ["en-US", "en"];
-            },
-        });
-
-        // Monkey patch Logger to not log with custom css
-        // @ts-ignore
-        const originalLog = Vencord.Util.Logger.prototype._log;
-        // @ts-ignore
-        Vencord.Util.Logger.prototype._log = function (level, levelColor, args) {
-            if (level === "warn" || level === "error")
-                return console[level]("[Vencord]", this.name + ":", ...args);
-
-            return originalLog.call(this, level, levelColor, args);
-        };
-
-        // Force enable all plugins and patches
-        Vencord.Plugins.patches.length = 0;
-        Object.values(Vencord.Plugins.plugins).forEach(p => {
-            // Needs native server to run
-            if (p.name === "WebRichPresence (arRPC)") return;
-
-            Vencord.Settings.plugins[p.name].enabled = true;
-            p.patches?.forEach(patch => {
-                patch.plugin = p.name;
-                delete patch.predicate;
-                delete patch.group;
-
-                Vencord.Util.canonicalizeFind(patch);
-                if (!Array.isArray(patch.replacement)) {
-                    patch.replacement = [patch.replacement];
-                }
-
-                patch.replacement.forEach(r => {
-                    delete r.predicate;
-                });
-
-                Vencord.Plugins.patches.push(patch);
-            });
+            }
         });
 
         let wreq: typeof Vencord.Webpack.wreq;
@@ -338,7 +307,7 @@ async function runtime(token: string) {
         // True if resolved, false otherwise
         const chunksSearchPromises = [] as Array<() => boolean>;
 
-        const LazyChunkRegex = canonicalizeMatch(/(?:Promise\.all\(\[(\i\.\i\("[^)]+?"\)[^\]]+?)\]\)|(\i\.\i\("[^)]+?"\)))\.then\(\i\.bind\(\i,"([^)]+?)"\)\)/g);
+        const LazyChunkRegex = canonicalizeMatch(/(?:(?:Promise\.all\(\[)?(\i\.e\("[^)]+?"\)[^\]]*?)(?:\]\))?)\.then\(\i\.bind\(\i,"([^)]+?)"\)\)/g);
 
         async function searchAndLoadLazyChunks(factoryCode: string) {
             const lazyChunks = factoryCode.matchAll(LazyChunkRegex);
@@ -348,8 +317,7 @@ async function runtime(token: string) {
             // the chunk containing the component
             const shouldForceDefer = factoryCode.includes(".Messages.GUILD_FEED_UNFEATURE_BUTTON_TEXT");
 
-            await Promise.all(Array.from(lazyChunks).map(async ([, rawChunkIdsArray, rawChunkIdsSingle, entryPoint]) => {
-                const rawChunkIds = rawChunkIdsArray ?? rawChunkIdsSingle;
+            await Promise.all(Array.from(lazyChunks).map(async ([, rawChunkIds, entryPoint]) => {
                 const chunkIds = rawChunkIds ? Array.from(rawChunkIds.matchAll(Vencord.Webpack.ChunkIdsRegex)).map(m => m[1]) : [];
 
                 if (chunkIds.length === 0) {
@@ -520,14 +488,14 @@ async function runtime(token: string) {
                 } else if (method === "extractAndLoadChunks") {
                     const [code, matcher] = args;
 
-                    const module = Vencord.Webpack.findModuleFactory(...code);
-                    if (module) result = module.toString().match(canonicalizeMatch(matcher));
+                    result = await Vencord.Webpack.extractAndLoadChunks(code, matcher);
+                    if (result === false) result = null;
                 } else {
                     // @ts-ignore
                     result = Vencord.Webpack[method](...args);
                 }
 
-                if (result == null || ("$$vencordInternal" in result && result.$$vencordInternal() == null)) throw "a rock at ben shapiro";
+                if (result == null || (result.$$vencordInternal != null && result.$$vencordInternal() == null)) throw "a rock at ben shapiro";
             } catch (e) {
                 let logMessage = searchType;
                 if (method === "find" || method === "proxyLazyWebpack" || method === "LazyComponentWebpack") logMessage += `(${args[0].toString().slice(0, 147)}...)`;
@@ -545,9 +513,10 @@ async function runtime(token: string) {
 }
 
 await page.evaluateOnNewDocument(`
-    ${readFileSync("./dist/browser.js", "utf-8")}
-
-    ;(${runtime.toString()})(${JSON.stringify(process.env.DISCORD_TOKEN)});
+    if (location.host.endsWith("discord.com")) {
+        ${readFileSync("./dist/browser.js", "utf-8")};
+        (${reporterRuntime.toString()})(${JSON.stringify(process.env.DISCORD_TOKEN)});
+    }
 `);
 
 await page.goto(CANARY ? "https://canary.discord.com/login" : "https://discord.com/login");