fix(coverage): c8 to ignore vite's generated helpers (#3241)

packages/coverage-c8/package.json

@@ -45,7 +45,9 @@
     "vitest": ">=0.30.0 <1"
   },
   "dependencies": {
+    "@ampproject/remapping": "^2.2.0",
     "c8": "^7.13.0",
+    "magic-string": "^0.30.0",
     "picocolors": "^1.0.0",
     "std-env": "^3.3.2"
   },

packages/coverage-c8/src/provider.ts

@@ -1,6 +1,8 @@
 import { existsSync, promises as fs } from 'node:fs'
 import _url from 'node:url'
 import type { Profiler } from 'node:inspector'
+import MagicString from 'magic-string'
+import remapping from '@ampproject/remapping'
 import { extname, resolve } from 'pathe'
 import c from 'picocolors'
 import { provider } from 'std-env'
@@ -18,6 +20,9 @@ import { checkCoverages } from 'c8/lib/commands/check-coverage.js'
 
 type Options = ResolvedCoverageOptions<'c8'>
 
+// Note that this needs to match the line ending as well
+const VITE_EXPORTS_LINE_PATTERN = /Object\.defineProperty\(__vite_ssr_exports__.*\n/g
+
 export class C8CoverageProvider extends BaseCoverageProvider implements CoverageProvider {
   name = 'c8'
 
@@ -169,7 +174,7 @@ export class C8CoverageProvider extends BaseCoverageProvider implements Coverage
 
       return {
         sourceMap: {
-          sourcemap: data.map,
+          sourcemap: removeViteHelpersFromSourceMaps(data.source, data.map),
         },
         source: Array(offset).fill('.').join('') + data.source,
       }
@@ -193,3 +198,27 @@ export class C8CoverageProvider extends BaseCoverageProvider implements Coverage
     }
   }
 }
+
+/**
+ * Remove generated code from the source maps:
+ * - Vite's export helpers: e.g. `Object.defineProperty(__vite_ssr_exports__, "sum", { enumerable: true, configurable: true, get(){ return sum }});`
+ */
+function removeViteHelpersFromSourceMaps(source: string | undefined, map: EncodedSourceMap) {
+  if (!source || !source.match(VITE_EXPORTS_LINE_PATTERN))
+    return map
+
+  const sourceWithoutHelpers = new MagicString(source)
+  sourceWithoutHelpers.replaceAll(VITE_EXPORTS_LINE_PATTERN, '\n')
+
+  const mapWithoutHelpers = sourceWithoutHelpers.generateMap({
+    hires: true,
+  })
+
+  // A merged source map where the first one excludes helpers
+  const combinedMap = remapping(
+    [{ ...mapWithoutHelpers, version: 3 }, map],
+    () => null,
+  )
+
+  return combinedMap
+}