fix: collect coverage from vm script

CHANGELOG.md

@@ -17,6 +17,7 @@
 - `[jest-circus]` Update message printed on test timeout ([#13830](https://github.com/facebook/jest/pull/13830))
 - `[jest-circus]` Avoid creating the word "testfalse" when `takesDoneCallback` is `false` in the message printed on test timeout AND updated timeouts test ([#13954](https://github.com/facebook/jest/pull/13954))
 - `[@jest/test-result]` Allow `TestResultsProcessor` type to return a Promise ([#13950](https://github.com/facebook/jest/pull/13950))
+- `[jest-runtime]` Support coverage with v8 for scripts loaded with `vm.runInContext`. Note: `collectCoverageFrom` must be set for it to work ([#](https://github.com/facebook/jest/pull/13962))
 
 ### Chore & Maintenance
 

e2e/__tests__/__snapshots__/coverageProviderV8.test.ts.snap

@@ -105,3 +105,12 @@ All files     |   59.37 |    33.33 |   33.33 |   59.37 |
  uncovered.js |       0 |        0 |       0 |       0 | 1-8               
 --------------|---------|----------|---------|---------|-------------------"
 `;
+
+exports[`vm script coverage generator 1`] = `
+"-------------|---------|----------|---------|---------|-------------------
+File         | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s 
+-------------|---------|----------|---------|---------|-------------------
+All files    |   88.88 |      100 |   66.66 |   88.88 |                   
+ vmscript.js |   88.88 |      100 |   66.66 |   88.88 | 20-22             
+-------------|---------|----------|---------|---------|-------------------"
+`;

e2e/__tests__/coverageProviderV8.test.ts

@@ -106,3 +106,15 @@ test('prints correct coverage report, if a TS module is transpiled by custom tra
   expect(exitCode).toBe(0);
   expect(stdout).toMatchSnapshot();
 });
+
+test('vm script coverage generator', () => {
+  const dir = path.resolve(__dirname, '../vmscript-coverage');
+  const {stdout, exitCode} = runJest(
+    dir,
+    ['--coverage', '--coverage-provider', 'v8'],
+    {stripAnsi: true},
+  );
+
+  expect(exitCode).toBe(0);
+  expect(stdout).toMatchSnapshot();
+});

e2e/vmscript-coverage/__tests__/extract-coverage.test.js

@@ -0,0 +1,42 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+const fs = require('fs');
+const path = require('path');
+const vm = require('vm');
+const filePath = path.resolve(__dirname, '../package/vmscript.js');
+
+test('extract coverage', () => {
+  const content = fs.readFileSync(filePath, {encoding: 'utf8'});
+
+  const case1 = vm.runInNewContext(
+    content,
+    {
+      inputObject: {
+        number: 0,
+      },
+    },
+    {
+      filename: filePath,
+    },
+  );
+
+  const case2 = vm.runInNewContext(
+    content,
+    {
+      inputObject: {
+        number: 7,
+      },
+    },
+    {
+      filename: filePath,
+    },
+  );
+
+  expect(case1).toBe(false);
+  expect(case2).toBe(true);
+});

e2e/vmscript-coverage/package.json

@@ -0,0 +1,9 @@
+{
+  "jest": {
+    "rootDir": "./",
+    "testEnvironment": "node",
+    "collectCoverageFrom": [
+      "package/**/*.js"
+    ]
+  }
+}

e2e/vmscript-coverage/package/vmscript.js

@@ -0,0 +1,27 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+function addOne(inputNumber) {
+  return ++inputNumber;
+}
+
+function isEven(inputNumber) {
+  if (inputNumber % 2 === 0) {
+    return true;
+  } else {
+    return false;
+  }
+}
+
+function notCovered() {
+  return 'not covered';
+}
+
+/* global inputObject */
+if (inputObject.number / 1 === inputObject.number) {
+  isEven(addOne(inputObject.number));
+}

packages/jest-runtime/src/index.ts

@@ -53,7 +53,12 @@ import type {MockMetadata, ModuleMocker} from 'jest-mock';
 import {escapePathForRegex} from 'jest-regex-util';
 import Resolver, {ResolveModuleConfig} from 'jest-resolve';
 import {EXTENSION as SnapshotExtension} from 'jest-snapshot';
-import {createDirectory, deepCyclicCopy} from 'jest-util';
+import {
+  createDirectory,
+  deepCyclicCopy,
+  globsToMatcher,
+  replacePathSepForGlob,
+} from 'jest-util';
 import {
   createOutsideJestVmPath,
   decodePossibleOutsideJestVmPath,
@@ -1260,14 +1265,26 @@ export default class Runtime {
       throw new Error('You need to call `stopCollectingV8Coverage` first.');
     }
 
+    const coverageMatcher = this._coverageOptions.collectCoverageFrom.length
+      ? globsToMatcher(this._coverageOptions.collectCoverageFrom)
+      : undefined;
+    const matchesCoveragePattern = (file: string) => {
+      if (coverageMatcher) {
+        return coverageMatcher(
+          replacePathSepForGlob(path.relative(this._config.rootDir, file)),
+        );
+      }
+      return this._v8CoverageSources!.has(file);
+    };
+
     return this._v8CoverageResult
       .filter(res => res.url.startsWith('file://'))
       .map(res => ({...res, url: fileURLToPath(res.url)}))
       .filter(
         res =>
           // TODO: will this work on windows? It might be better if `shouldInstrument` deals with it anyways
           res.url.startsWith(this._config.rootDir) &&
-          this._v8CoverageSources!.has(res.url) &&
+          matchesCoveragePattern(res.url) &&
           shouldInstrument(res.url, this._coverageOptions, this._config),
       )
       .map(result => {