feat: on-demand re-run

Author: northword

packages/scaffold/src/constant.ts

@@ -8,6 +8,6 @@ export const TESTER_BASE_PATH = `${BASE_DIR}/test`;
 export const TESTER_PROFILE_DIR = `${TESTER_BASE_PATH}/profile`;
 export const TESTER_DATA_DIR = `${TESTER_BASE_PATH}/data`;
 export const TESTER_PLUGIN_DIR = `${TESTER_BASE_PATH}/resource`;
-export const TESTER_PLUGIN_TESTS_DIR = `${TESTER_PLUGIN_DIR}/tests`;
+export const TESTER_PLUGIN_TESTS_DIR = `${TESTER_PLUGIN_DIR}/content/units`;
 export const TESTER_PLUGIN_REF = "zotero-plugin-scaffold-test-runner";
 export const TESTER_PLUGIN_ID = "[email protected]";

packages/scaffold/src/core/tester/test-runner-plugin.ts

@@ -2,6 +2,7 @@ import type { BuildContext, BuildResult } from "esbuild";
 import type { Context } from "../..//types/index.js";
 import { context } from "esbuild";
 import { copy, outputFile, outputJSON, pathExists } from "fs-extra/esm";
+import { resolve } from "pathe";
 import { glob } from "tinyglobby";
 import { CACHE_DIR, TESTER_PLUGIN_DIR } from "../../constant.js";
 import { saveResource } from "../../utils/file.js";
@@ -38,7 +39,7 @@ export class TestRunnerPlugin {
     const esbuildResult = await this.esbuildContext?.rebuild();
 
     // get affected tests
-    const tests = this.getAffectedTests(changedFile, esbuildResult?.metafile);
+    const tests = findImpactedTests(changedFile, esbuildResult?.metafile);
 
     // this.generateTestPage
     //   mocha setup
@@ -144,24 +145,33 @@ export class TestRunnerPlugin {
     const html = generateHtml(setupCode, testFiles);
     await outputFile(`${TESTER_PLUGIN_DIR}/content/index.xhtml`, html);
   }
+}
 
-  /**
-   * 给定源码路径，查找导入了该文件的所有 output file
-   */
-  private getAffectedTests(changedFile: string, metafile: BuildResult["metafile"]): string[] {
-    if (!metafile)
-      return [];
-
-    const affectedEntries = new Set<string>();
-
-    for (const [path, info] of Object.entries(metafile.outputs)) {
-      for (const imp of info.imports) {
-        if (imp.path === changedFile) {
-          affectedEntries.add(path);
-        }
-      }
+/**
+ * Determines which test files are impacted by a given changed file based on the esbuild metafile.
+ *
+ * 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.
+ *
+ * @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.
+ */
+export function findImpactedTests(changedFilePath: string, buildMetadata: BuildResult["metafile"]): string[] {
+  if (!buildMetadata)
+    return [];
+
+  const resolvedChangedFile = 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);
     }
-
-    return [...affectedEntries];
   }
+  return Array.from(impactedTestFiles);
 }

packages/scaffold/test/unit/tester.test.ts

@@ -0,0 +1,58 @@
+import type { Metafile } from "esbuild";
+import { describe, expect, it, vi } from "vitest";
+import { findImpactedTests } from "../../src/core/tester/test-runner-plugin.js";
+
+// Mock resolve function
+vi.mock("path", async () => {
+  const actual = await vi.importActual<typeof import("path")>("path");
+  return { ...actual, resolve: (p: string) => p };
+});
+
+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": {},
+        },
+      },
+    },
+  } as unknown as Metafile;
+
+  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"]);
+  });
+
+  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"]);
+  });
+
+  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"]);
+  });
+
+  it("returns an empty array if no test file is affected", () => {
+    const result = findImpactedTests("src/unrelated.ts", mockMetafileOutputs);
+    expect(result).toEqual([]);
+  });
+});