ember-cli-code-coverage · RobbieTheWagner · Feb 22, 2024 · Jan 29, 2024 · SergeAstapov · Feb 21, 2024
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -20,7 +20,7 @@ jobs:
       - uses: pnpm/action-setup@v2
         name: Install pnpm
         with:
-          version: 8.10.3
+          version: 8.15.1
           run_install: false
       - name: Get pnpm store directory
         shell: bash

diff --git a/README.md b/README.md
@@ -154,6 +154,8 @@ Configuration is optional. It should be put in a file at `config/coverage.js` (`
 
 - `excludes`: Defaults to `['*/mirage/**/*']`. An array of globs to exclude from instrumentation. Useful to exclude files from coverage statistics.
 
+- `extension`: Defaults to `['.gjs', '.gts', '.js', '.ts', '.cjs', '.mjs', '.mts', '.cts']`. Tell Istanbul to instrument only files with the provided extensions.
- `extension`: Defaults to `['.gjs', '.gts', '.js', '.ts', '.cjs', '.mjs', '.mts', '.cts']`. Tell Istanbul to instrument only files with the provided extensions.
+- `extensions`: Defaults to `['.gjs', '.gts', '.js', '.ts', '.cjs', '.mjs', '.mts', '.cts']`. Tells Istanbul to instrument only files with the provided extensions.
- `extension`: Defaults to `['.gjs', '.gts', '.js', '.ts', '.cjs', '.mjs', '.mts', '.cts']`. Tell Istanbul to instrument only files with the provided extensions.
+- `extensions`: Defaults to `['.gjs', '.gts', '.js', '.ts', '.cjs', '.mjs', '.mts', '.cts']`. Tells Istanbul to instrument only files with the provided extensions.
+
 - `coverageFolder`: Defaults to `coverage`. A folder relative to the root of your project to store coverage results.
 
 - `parallel`: Defaults to `false`. Should be set to true if parallel testing is being used for separate test runs, for example when using [ember-exam](https://github.com/trentmwillis/ember-exam) with the `--partition` flag. This will generate the coverage reports in directories suffixed with `_<random_string>` to avoid overwriting other threads reports. These reports can be joined by using the `ember coverage-merge` command (potentially as part of the [posttest hook](https://docs.npmjs.com/misc/scripts) in your `package.json`).

diff --git a/package.json b/package.json
@@ -8,6 +8,7 @@
     "test": "vitest"
   },
   "devDependencies": {
+    "@babel/core": "^7.23.9",
     "@release-it-plugins/lerna-changelog": "^6.0.0",
     "@release-it-plugins/workspaces": "^4.0.0",
     "chai-files": "^1.4.0",
@@ -46,6 +47,6 @@
   "version": "2.0.3",
   "volta": {
     "node": "16.20.2",
-    "pnpm": "8.10.2"
+    "pnpm": "8.15.1"
   }
 }
diff --git a/packages/ember-cli-code-coverage/index.js b/packages/ember-cli-code-coverage/index.js
@@ -29,6 +29,16 @@ module.exports = {
   buildBabelPlugin(opts = {}) {
     let cwd = opts.cwd || process.cwd();
     let exclude = ['*/mirage/**/*', '*/node_modules/**/*'];
+    let extension = [
+      '.gjs',
+      '.gts',
+      '.js',
+      '.ts',
+      '.cjs',
+      '.mjs',
+      '.mts',
+      '.cts',
+    ];
     let coverageEnvVar = 'COVERAGE';
     let configBase = 'config';
 
@@ -48,19 +58,25 @@ module.exports = {
       if (config.coverageEnvVar) {
         coverageEnvVar = config.coverageEnvVar;
       }
+
+      if (config.extension) {
+        extension = config.extension;
+      }
     }
 
     if (process.env[coverageEnvVar] !== 'true') {
       return [];
     }
 
+    let useStringLookupForPlugin = false;
     if (opts.embroider === true) {
       try {
         // Attempt to import the utility @embroider/compat uses in >3.1 to locate the embroider working directory
         // the presence of this `locateEmbroiderWorkingDir` method coincides with the shift to utilize `rewritten-app` tmp dir
         // eslint-disable-next-line node/no-missing-require
         let { locateEmbroiderWorkingDir } = require('@embroider/core');
         cwd = path.resolve(locateEmbroiderWorkingDir(cwd), 'rewritten-app');
+        useStringLookupForPlugin = true;
       } catch (err) {
         // otherwise, fall back to the method used in embroider <3.1
         let {
@@ -72,7 +88,13 @@ module.exports = {
     }
 
     const IstanbulPlugin = require.resolve('babel-plugin-istanbul');
-    return [[IstanbulPlugin, { cwd, include: '**/*', exclude }]];
+    return [
+      // String lookup is needed to workaround https://github.com/embroider-build/embroider/issues/1525
+      useStringLookupForPlugin
+        ? 'ember-cli-code-coverage/lib/gjs-gts-istanbul-ignore-template-plugin'
+        : require('./lib/gjs-gts-istanbul-ignore-template-plugin'),
+      [IstanbulPlugin, { cwd, include: '**/*', exclude, extension }],
+    ];
   },
 
   includedCommands() {

diff --git a/packages/ember-cli-code-coverage/lib/attach-middleware.js b/packages/ember-cli-code-coverage/lib/attach-middleware.js
@@ -8,6 +8,9 @@ const getConfig = require('./config');
 const path = require('path');
 const crypto = require('crypto');
 const fs = require('fs-extra');
+const libSourceMaps = require('istanbul-lib-source-maps');
+
+const sourceMapStore = libSourceMaps.createSourceMapStore();
 
 const WRITE_COVERAGE = '/write-coverage';
 
@@ -134,17 +137,22 @@ function adjustCoverage(coverage, options) {
       namespaceMappings,
       modifyAssetLocation
     );
-    coverage[filePath].path = path.relative(root, relativeToProjectRoot);
-    memo[path.relative(root, relativeToProjectRoot)] = coverage[filePath];
+    coverage[filePath].data.path = path.relative(root, relativeToProjectRoot);
+    memo[path.relative(root, relativeToProjectRoot)] = coverage[filePath].data;
     return memo;
   }, {});
 
   return adjustedCoverage;
 }
 
-function writeCoverage(coverage, options, map) {
+async function writeCoverage(coverage, options, map) {
   let { root } = options;
-  const adjustedCoverage = adjustCoverage(coverage, options);
+
+  const remappedCoverage = await sourceMapStore.transformCoverage(
+    libCoverage.createCoverageMap(coverage)
+  );
+
+  const adjustedCoverage = adjustCoverage(remappedCoverage.data, options);
 
   Object.entries(adjustedCoverage).forEach(([relativePath, cov]) => {
     // this filters out files that dont reside within the project
@@ -187,8 +195,8 @@ function reportCoverage(map, root, configPath) {
   });
 }
 
-function coverageHandler(map, options, req, res) {
-  writeCoverage(req.body, options, map);
+async function coverageHandler(map, options, req, res) {
+  await writeCoverage(req.body, options, map);
   reportCoverage(map, options.root, options.configPath);
 
   res.send(map.getCoverageSummary().toJSON());

diff --git a/packages/ember-cli-code-coverage/lib/gjs-gts-istanbul-ignore-template-plugin.js b/packages/ember-cli-code-coverage/lib/gjs-gts-istanbul-ignore-template-plugin.js
@@ -0,0 +1,65 @@
+/**
+ * When gjs/gts is converted to js it looks like this
+ *
+ * @example
+ * template(`
+ *   <div>
+ *    template code
+ *   </div>`
+ * , {
+ *   eval() {
+ *     return eval(arguments[0]);
+ *   }
+ *});
+ *
+ * The problem is Istanbul's babel plugin will try to instrument the `eval` method which can skew coverage results.
+ * In order to avoid this we add this plugin to add Istanbul ignore comments above `eval` to make sure it won't be instrumented by babel
+ */
+const gjsGtsTemplateIgnoreVisitor = {
+  CallExpression(path) {
+    const { node } = path;
+    let { callee } = node;
+
+    if (callee.name !== 'template') {
+      return;
+    }
+
+    const callScopeBinding = path.scope.getBinding('template');
+
+    if (
+      callScopeBinding.kind === 'module' &&
+      callScopeBinding.path.parent.source.value === '@ember/template-compiler'
+    ) {
+      const babelIgnoreComment = {
+        type: 'CommentBlock',
+        value: ' istanbul ignore next ',
+      };
+
+      if (!path.findParent((path) => path.isStatement()).node.leadingComments) {
+        path.findParent((path) => path.isStatement()).node.leadingComments = [];
+      }
+      path
+        .findParent((path) => path.isStatement())
+        .node.leadingComments.push(babelIgnoreComment);
+    }
+  },
+};
+
+module.exports = function () {
+  return {
+    visitor: {
+      Program: {
+        enter(path, state) {
+          const filename = state.file.opts.filename;
+
+          if (!filename?.match(/\.g[tj]s$/)) {
+            return;
+          }
+
+          // We need to do early traverse to make sure this runs before istanbuls plugin
+          path.traverse(gjsGtsTemplateIgnoreVisitor, state);
+        },
+      },
+    },
+  };
+};
diff --git a/packages/ember-cli-code-coverage/package.json b/packages/ember-cli-code-coverage/package.json
@@ -42,6 +42,7 @@
     "istanbul-lib-coverage": "^3.2.1",
     "istanbul-lib-report": "^3.0.1",
     "istanbul-reports": "^3.1.6",
+    "istanbul-lib-source-maps": "^4.0.1",
     "node-dir": "^0.1.17",
     "walk-sync": "^2.1.0"
   },

diff --git a/packages/ember-cli-code-coverage/pnpm-lock.yaml b/packages/ember-cli-code-coverage/pnpm-lock.yaml