refactor: use rolldown to bundle test files

Author: northword

src/core/tester/test-bundler-template/index.ts

@@ -27,7 +27,7 @@ export function generateHtml(
   setupCode: string,
   testFiles: string[],
 ): string {
-  const tests = testFiles.map(f => `<script src="${f}"></script>`).join("\n    ");
+  const tests = testFiles.map(f => `<script src="units/${f}"></script>`).join("\n    ");
 
   return htmlRaw.replace("__TEST_FILES__", tests).replace("___SETUP_CODE___", setupCode);
 }

src/core/tester/test-bundler.test.ts

@@ -1,52 +1,43 @@
-import type { Metafile } from "esbuild";
+import type { MetaData } from "./test-bundler.js";
 import { describe, expect, it } from "vitest";
 import { findImpactedTests } from "./test-bundler.js";
 
 describe("findImpactedTests", () => {
-  const mockMetafileOutputs = {
-    outputs: {
-      ".scaffold/test/resource/content/units/test1.spec.js": {
-        entryPoint: "test/test1.spec.ts",
-        inputs: {
-          "test/test1.spec.ts": {},
-          "src/moduleA.ts": {},
-          "src/moduleB.ts": {},
-        },
-      },
-      ".scaffold/test/resource/content/units/test2.spec.js": {
-        entryPoint: "test/test2.spec.ts",
-        inputs: {
-          "test/test2.spec.ts": {},
-          "src/moduleC.ts": {},
-        },
-      },
-      ".scaffold/test/resource/content/units/test3.spec.js": {
-        entryPoint: "test/test3.spec.ts",
-        inputs: {
-          "test/test3.spec.ts": {},
-          "src/moduleC.ts": {},
-        },
-      },
+  const mockBuildMetadata: MetaData = [
+    {
+      fileName: "test1.spec.js",
+      name: "",
+      moduleIds: ["src/moduleA.ts", "src/moduleB.ts", "test/test1.spec.ts"],
     },
-  } as unknown as Metafile;
+    {
+      fileName: "test2.spec.js",
+      name: "",
+      moduleIds: ["test/test2.spec.ts", "src/moduleC.ts"],
+    },
+    {
+      fileName: "test3.spec.js",
+      name: "",
+      moduleIds: ["test/test3.spec.ts", "src/moduleC.ts"],
+    },
+  ];
 
   it("returns affected test file when a test file itself is changed", () => {
-    const result = findImpactedTests("test/test1.spec.ts", mockMetafileOutputs);
-    expect(result).toEqual(["units/test1.spec.js"]);
+    const result = findImpactedTests("test/test1.spec.ts", mockBuildMetadata);
+    expect(result).toEqual(["test1.spec.js"]);
   });
 
   it("returns affected test files when a source file is changed", () => {
-    const result = findImpactedTests("src/moduleA.ts", mockMetafileOutputs);
-    expect(result).toEqual(["units/test1.spec.js"]);
+    const result = findImpactedTests("src/moduleA.ts", mockBuildMetadata);
+    expect(result).toEqual(["test1.spec.js"]);
   });
 
   it("returns multiple affected test files when multiple tests depend on the changed file", () => {
-    const result = findImpactedTests("src/moduleC.ts", mockMetafileOutputs);
-    expect(result).toEqual(["units/test2.spec.js", "units/test3.spec.js"]);
+    const result = findImpactedTests("src/moduleC.ts", mockBuildMetadata);
+    expect(result).toEqual(["test2.spec.js", "test3.spec.js"]);
   });
 
   it("returns an empty array if no test file is affected", () => {
-    const result = findImpactedTests("src/unrelated.ts", mockMetafileOutputs);
+    const result = findImpactedTests("src/unrelated.ts", mockBuildMetadata);
     expect(result).toEqual([]);
   });
 });

src/core/tester/test-bundler.ts

@@ -1,17 +1,18 @@
-import type { BuildContext, BuildResult } from "esbuild";
+import type { InputOptions, OutputChunk, OutputOptions, RolldownOutput } from "rolldown";
 import type { Context } from "../../types/index.js";
-import { resolve } from "node:path";
-import { context } from "esbuild";
+import { relative, resolve } from "node:path";
+import { cwd } from "node:process";
 import { copy, outputFile, outputJSON, pathExists } from "fs-extra/esm";
+import { rolldown } from "rolldown";
 import { glob } from "tinyglobby";
-import { CACHE_DIR, TESTER_PLUGIN_DIR } from "../../constant.js";
+import { CACHE_DIR, TESTER_PLUGIN_DIR, TESTER_PLUGIN_TESTS_DIR } from "../../constant.js";
 import { saveResource } from "../../utils/file.js";
 import { logger } from "../../utils/logger.js";
-import { toArray } from "../../utils/string.js";
+import { normalizePath, toArray } from "../../utils/string.js";
 import { generateBootstrap, generateHtml, generateManifest, generateMochaSetup } from "./test-bundler-template/index.js";
 
 export class TestBundler {
-  private esbuildContext?: BuildContext;
+  private rolldownOutput?: RolldownOutput;
   constructor(
     private ctx: Context,
     private port: number,
@@ -35,10 +36,11 @@ export class TestBundler {
 
   async regenerate(changedFile: string): Promise<void> {
     // re-bundle tests
-    const esbuildResult = await this.esbuildContext?.rebuild();
+    await this.bundleTests();
 
-    // get affected tests
-    const tests = findImpactedTests(changedFile, esbuildResult?.metafile);
+    // get affected tests based on changed file
+    const metadata = transformRolldownOutputToMetafile(this.rolldownOutput?.output);
+    const tests = findImpactedTests(changedFile, metadata);
 
     // this.generateTestPage
     //   mocha setup
@@ -110,21 +112,28 @@ export class TestBundler {
 
   private async bundleTests() {
     const testDirs = toArray(this.ctx.test.entries);
-    // Because esbuild only support `*` and `**`，
-    // so we need glob ourselves.
-    // https://esbuild.github.io/api/#glob-style-entry-points
+    // Find all test files
     const entryPoints = (await Promise.all(testDirs.map(dir => glob(`${dir}/**/*.{spec,test}.[jt]s`))))
       .flat();
 
-    // Bundle all test files, including both JavaScript and TypeScript
-    this.esbuildContext = await context({
-      entryPoints,
-      outdir: `${TESTER_PLUGIN_DIR}/content/units`,
-      bundle: true,
-      target: "firefox115",
-      metafile: true,
-    });
-    await this.esbuildContext.rebuild();
+    // configure rolldown options
+    const rolldownInputOptions: InputOptions = {
+      input: entryPoints,
+      treeshake: false,
+      preserveEntrySignatures: "allow-extension",
+    };
+
+    const outputOptions: OutputOptions = {
+      dir: `${TESTER_PLUGIN_DIR}/content/units`,
+      format: "esm",
+      sourcemap: true,
+      codeSplitting: false,
+    };
+
+    const rolldownBuild = await rolldown(rolldownInputOptions);
+    this.rolldownOutput = await rolldownBuild.write(outputOptions);
+
+    await rolldownBuild.close();
   }
 
   private async createTestHtml(tests: string[] = []) {
@@ -139,38 +148,55 @@ export class TestBundler {
     // html
     let testFiles = tests;
     if (testFiles.length === 0) {
-      testFiles = (await glob(`**/*.{spec,test}.js`, { cwd: `${TESTER_PLUGIN_DIR}/content` })).sort();
+      testFiles = (await glob(`**/*.{spec,test}.js`, { cwd: `${TESTER_PLUGIN_TESTS_DIR}` })).sort();
     }
     const html = generateHtml(setupCode, testFiles);
     await outputFile(`${TESTER_PLUGIN_DIR}/content/index.xhtml`, html);
   }
 }
 
+interface _MetaData extends Pick<OutputChunk, "fileName" | "name" | "moduleIds"> {}
+export type MetaData = _MetaData[];
+
+function transformRolldownOutputToMetafile(output?: RolldownOutput["output"]): MetaData {
+  if (!output)
+    return [];
+
+  return output
+    .flat()
+    .filter(r => r.type === "chunk")
+    .map(r => ({
+      fileName: normalizePath(r.fileName),
+      name: r.name,
+      moduleIds: r.moduleIds.map(id => relative(cwd(), id)).map(normalizePath),
+    }));
+}
+
 /**
- * Determines which test files are impacted by a given changed file based on the esbuild metafile.
+ * Determines which test files are impacted by a given changed file based on rolldown build output.
  *
  * This function analyzes the build metadata to find test files that depend on the changed file
- * either directly as an entry point or indirectly as an input. It is useful in a watch mode setup
- * to selectively rerun only the affected tests.
+ * either directly as an entry point or indirectly as an input.
  *
  * @param {string} changedFilePath - The file path of the changed source file.
- * @param {BuildResult["metafile"]} buildMetadata - The esbuild metafile containing dependency information.
- * @returns {string[]} An array of impacted test file paths that need to be re-executed.
+ * @param {MetaData} buildMetadata - The transfromed rolldown build outputs.
+ * @returns {string[]} An array of impacted test file names that need to be re-executed.
  */
-export function findImpactedTests(changedFilePath: string, buildMetadata: BuildResult["metafile"]): string[] {
-  if (!buildMetadata)
-    return [];
-
-  const resolvedChangedFile = resolve(changedFilePath);
+export function findImpactedTests(
+  changedFilePath: string,
+  buildMetadata: MetaData,
+): string[] {
+  const normalizedChangedFile = resolve(changedFilePath);
   const impactedTestFiles = new Set<string>();
 
-  for (const [outputFilePath, outputInfo] of Object.entries(buildMetadata.outputs)) {
-    const testFilePath = outputFilePath.replace(`${TESTER_PLUGIN_DIR}/content/`, "");
-    // const resolvedEntryPoint = outputInfo.entryPoint ? resolve(outputInfo.entryPoint) : null;
-
-    if (Object.keys(outputInfo.inputs).some(inputPath => resolve(inputPath) === resolvedChangedFile)) {
-      impactedTestFiles.add(testFilePath);
+  for (const { fileName, moduleIds } of buildMetadata) {
+    for (const moduleId of moduleIds) {
+      const normalizedModuleId = resolve(moduleId);
+      if (normalizedModuleId === normalizedChangedFile) {
+        impactedTestFiles.add(fileName);
+      }
     }
   }
+
   return Array.from(impactedTestFiles);
 }

src/utils/string.ts

@@ -53,3 +53,7 @@ export function parseRepoUrl(url?: string): {
   const [, owner, repo] = match;
   return { owner, repo };
 }
+
+export function normalizePath(path: string) {
+  return path.replace(/\\/g, "/");
+}