Merge pull request #276 from kwonoj/test-e2e-path

kwonoj · web-flow · commit 0933eb72de22 · 2025-09-14T18:23:19.000-07:00
diff --git a/.github/workflows/ci_main.yml b/.github/workflows/ci_main.yml
@@ -9,7 +9,10 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
     name: Run test
 
     steps:
@@ -44,6 +47,7 @@ jobs:
       run: |
         cargo check
     - name: Generate code coverage
+      if: matrix.os == 'ubuntu-latest'
       run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info
     - uses: codecov/codecov-action@v2
       with:
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,4 @@
 /target
-Cargo.lock
 node_modules/
 .swc/
 *.log
@@ -10,4 +9,4 @@ spec/swc-coverage-custom-transform/target/
 a.js
 swc-plugin-coverage-*.tgz
 /tmp
-trace-*.json
+trace-*.json
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -12,7 +12,7 @@ resolver = "2"
 #lto = true
 
   [workspace.dependencies]
-  istanbul-oxide          = { path = "./packages/istanbul-oxide", version = "0.0.29" }
+  istanbul-oxide          = { path = "./packages/istanbul-oxide", version = "0.0.30" }
   swc-coverage-instrument = { path = "./packages/swc-coverage-instrument" }
 
   getrandom          = { version = "0.2.15" }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "swc-plugin-coverage-instrument",
-  "version": "0.0.29",
+  "version": "0.0.30",
   "description": "SWC coverage instrumentation plugin",
   "main": "./target/wasm32-wasip1/release/swc_plugin_coverage.wasm",
   "napi": {
diff --git a/packages/istanbul-oxide/Cargo.toml b/packages/istanbul-oxide/Cargo.toml
@@ -5,7 +5,7 @@ edition     = "2021"
 license     = "MIT"
 name        = "istanbul-oxide"
 repository  = "https://github.com/kwonoj/swc-coverage-instrument"
-version     = "0.0.29"
+version     = "0.0.30"
 
 [dependencies]
 indexmap = { workspace = true, features = ["serde"] }
diff --git a/packages/swc-coverage-instrument/Cargo.toml b/packages/swc-coverage-instrument/Cargo.toml
@@ -5,7 +5,7 @@ edition     = "2021"
 license     = "MIT"
 name        = "swc-coverage-instrument"
 repository  = "https://github.com/kwonoj/swc-coverage-instrument"
-version     = "0.0.29"
+version     = "0.0.30"
 
 [dependencies]
 istanbul-oxide = { workspace = true }
diff --git a/packages/swc-plugin-coverage/Cargo.toml b/packages/swc-plugin-coverage/Cargo.toml
@@ -5,7 +5,7 @@ edition     = "2021"
 license     = "MIT"
 name        = "swc-plugin-coverage"
 repository  = "https://github.com/kwonoj/swc-coverage-instrument"
-version     = "0.0.29"
+version     = "0.0.30"
 
 [lib]
 crate-type = ["cdylib"]
diff --git a/packages/swc-plugin-coverage/src/lib.rs b/packages/swc-plugin-coverage/src/lib.rs
@@ -14,7 +14,7 @@ use typed_path::Utf8TypedPath;
 use wax::Pattern;
 
 /// Normalize a file path to use forward slashes for consistent glob matching
-fn normalize_path_for_glob_matching(path: &str) -> String {
+fn normalize_path(path: &str) -> String {
     let typed_path = Utf8TypedPath::derive(path);
     if typed_path.is_windows() {
         typed_path.with_unix_encoding().to_string()
@@ -77,9 +77,14 @@ pub fn process(program: Program, metadata: TransformPluginProgramMetadata) -> Pr
     // compatible glob and the filename matches the pattern, the file will not be instrumented.
     // Note that the filename is provided by swc's core, may not be the full absolute path to the file name.
     if let Some(exclude) = &instrument_options.unstable_exclude {
-        match wax::any(exclude.iter().map(|s| s.as_ref()).collect::<Vec<&str>>()) {
+        let normalized_patterns = exclude
+            .iter()
+            .map(|s| normalize_path(s))
+            .collect::<Vec<_>>();
+
+        match wax::any(normalized_patterns.iter().map(|s| s.as_str())) {
             Ok(p) => {
-                let normalized_filename = normalize_path_for_glob_matching(filename);
+                let normalized_filename = normalize_path(filename);
                 if p.is_match(normalized_filename.as_str()) {
                     return program;
                 }
@@ -110,32 +115,32 @@ mod tests {
     #[test]
     fn test_normalize_path_for_glob_matching() {
         // Test Windows paths are normalized to Unix-style
-        let result = normalize_path_for_glob_matching(r"C:\Users\project\test\index.test.ts");
+        let result = normalize_path(r"C:\Users\project\test\index.test.ts");
         println!("Windows path result: {}", result);
         // The typed-path crate converts Windows paths to Unix format, but may strip the drive letter
         // The important thing is that backslashes are converted to forward slashes
         assert!(result.contains("/Users/project/test/index.test.ts"));
 
         // Test mixed separators are normalized
-        let result = normalize_path_for_glob_matching(r"C:\Users/project\test/file.js");
+        let result = normalize_path(r"C:\Users/project\test/file.js");
         println!("Mixed separators result: {}", result);
         assert!(result.contains("/Users/project/test/file.js"));
 
         // Test Unix paths remain unchanged
         assert_eq!(
-            normalize_path_for_glob_matching("/home/user/project/src/utils/helper.js"),
+            normalize_path("/home/user/project/src/utils/helper.js"),
             "/home/user/project/src/utils/helper.js"
         );
 
         // Test relative Unix paths remain unchanged
         assert_eq!(
-            normalize_path_for_glob_matching("src/components/Button.tsx"),
+            normalize_path("src/components/Button.tsx"),
             "src/components/Button.tsx"
         );
 
         // Test that backslashes are converted to forward slashes
         let windows_path = r"project\src\test\file.ts";
-        let result = normalize_path_for_glob_matching(windows_path);
+        let result = normalize_path(windows_path);
         println!("Relative Windows path result: {}", result);
         assert!(result.contains("project/src/test/file.ts"));
     }
diff --git a/spec/e2e/e2e.spec.ts b/spec/e2e/e2e.spec.ts
@@ -0,0 +1,99 @@
+import { assert } from "chai";
+import { instrumentSync } from "../util/verifier";
+import * as fs from "fs";
+import * as path from "path";
+
+// Custom transform test doesn't use plugin's exclude option
+const tryDescribe = process.env.SWC_TRANSFORM_CUSTOM ? describe.skip : describe;
+
+tryDescribe("e2e", () => {
+  it("issue-274", () => {
+    const testFiles = [
+      {
+        path: path.resolve(__dirname, "fixtures", "should-be-excluded.test.js"),
+        shouldBeExcluded: true,
+        description: "Test file with .test. extension should be excluded",
+      },
+      {
+        path: path.resolve(__dirname, "fixtures", "should-be-included.js"),
+        shouldBeExcluded: false,
+        description: "Regular file should be included",
+      },
+    ];
+
+    const exclusionPattern = [
+      "**/node_modules/**",
+      "**/dist/**",
+      "**/test/**",
+      "**/__tests__/**",
+      "**/__mocks__/**",
+      "**/*.{test,spec}.[jt]s",
+      "**/*.{test,spec}.[c|m][jt]s",
+      "**/*.{test,spec}.[jt]sx",
+      "**/*.{test,spec}.[c|m][jt]sx",
+    ];
+
+    testFiles.forEach((testFile) => {
+      // Read the actual file content
+      const fileContent = fs.readFileSync(testFile.path, "utf8");
+
+      // Transform the file using SWC with exclusion patterns
+      const output = instrumentSync(fileContent, testFile.path, undefined, {
+        unstableExclude: exclusionPattern,
+      });
+
+      if (testFile.shouldBeExcluded) {
+        // File should be excluded - no coverage instrumentation
+        assert.notInclude(
+          output.code,
+          "__coverage__",
+          `${testFile.description}: File should not contain coverage variables`,
+        );
+        assert.notInclude(
+          output.code,
+          "cov_",
+          `${testFile.description}: File should not contain coverage function calls`,
+        );
+      } else {
+        // File should be included - should have coverage instrumentation
+        assert.include(
+          output.code,
+          "__coverage__",
+          `${testFile.description}: File should be instrumented with coverage`,
+        );
+        assert.include(
+          output.code,
+          "cov_",
+          `${testFile.description}: File should contain coverage function calls`,
+        );
+      }
+    });
+
+    // Test cross-platform path normalization with different path formats
+    const testCode = fs.readFileSync(testFiles[0].path, "utf8");
+    const pathVariations = [
+      "project/test/file.test.js", // Unix-style path
+      "project\\test\\file.test.js", // Windows-style path
+      "C:\\Users\\project\\test\\file.test.js", // Windows absolute path
+      "/home/user/project/test/file.test.js", // Unix absolute path
+    ];
+
+    pathVariations.forEach((testPath) => {
+      const output = instrumentSync(testCode, testPath, undefined, {
+        unstableExclude: ["**/*.test.*"],
+      });
+
+      // All should be excluded since they all match the *.test.* pattern
+      assert.notInclude(
+        output.code,
+        "__coverage__",
+        `Path ${testPath} should be excluded regardless of separator style`,
+      );
+      assert.notInclude(
+        output.code,
+        "cov_",
+        `Path ${testPath} should not contain coverage calls`,
+      );
+    });
+  });
+});
diff --git a/spec/e2e/fixtures/should-be-excluded.test.js b/spec/e2e/fixtures/should-be-excluded.test.js
@@ -0,0 +1,28 @@
+// This file should be excluded from coverage instrumentation
+// because it matches the **/*.test.* pattern
+
+function calculateSum(a, b) {
+  return a + b;
+}
+
+function calculateProduct(x, y) {
+  return x * y;
+}
+
+const testHelper = {
+  setup: function () {
+    console.log("Setting up test");
+  },
+
+  teardown: function () {
+    console.log("Tearing down test");
+  },
+};
+
+if (typeof module !== "undefined") {
+  module.exports = {
+    calculateSum,
+    calculateProduct,
+    testHelper,
+  };
+}
diff --git a/spec/e2e/fixtures/should-be-included.js b/spec/e2e/fixtures/should-be-included.js
@@ -0,0 +1,48 @@
+// This file should be included in coverage instrumentation
+// because it does NOT match any exclusion patterns
+
+function add(a, b) {
+  if (typeof a !== "number" || typeof b !== "number") {
+    throw new Error("Both arguments must be numbers");
+  }
+  return a + b;
+}
+
+function multiply(x, y) {
+  if (x === 0 || y === 0) {
+    return 0;
+  }
+  return x * y;
+}
+
+function divide(dividend, divisor) {
+  if (divisor === 0) {
+    throw new Error("Cannot divide by zero");
+  }
+  return dividend / divisor;
+}
+
+const mathUtils = {
+  isEven: function (num) {
+    return num % 2 === 0;
+  },
+
+  isOdd: function (num) {
+    return num % 2 !== 0;
+  },
+
+  factorial: function (n) {
+    if (n < 0) return undefined;
+    if (n === 0) return 1;
+    return n * this.factorial(n - 1);
+  },
+};
+
+if (typeof module !== "undefined") {
+  module.exports = {
+    add,
+    multiply,
+    divide,
+    mathUtils,
+  };
+}
diff --git a/spec/swc-coverage-custom-transform/Cargo.lock b/spec/swc-coverage-custom-transform/Cargo.lock
diff --git a/spec/swc-coverage-custom-transform/Cargo.toml b/spec/swc-coverage-custom-transform/Cargo.toml

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "swc-plugin-coverage-instrument",`
`3`		`- "version": "0.0.29",`
	`3`	`+ "version": "0.0.30",`
`4`	`4`	`"description": "SWC coverage instrumentation plugin",`
`5`	`5`	`"main": "./target/wasm32-wasip1/release/swc_plugin_coverage.wasm",`
`6`	`6`	`"napi": {`