feat(jest-haste-map): support dependencyExtractor written in ESM

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ### Features
 
+- `[jest-core, jest-haste-map, jest-runtime]` Add support for `dependencyExtractor` written in ESM ([#12008](https://github.com/facebook/jest/pull/12008))
 - `[jest-core]` Add support for `testResultsProcessor` written in ESM ([#12006](https://github.com/facebook/jest/pull/12006))
 - `[jest-diff, pretty-format]` Add `compareKeys` option for custom sorting of object keys ([#11992](https://github.com/facebook/jest/pull/11992))
 

e2e/__tests__/findRelatedFiles.test.ts

@@ -8,6 +8,7 @@
 import {tmpdir} from 'os';
 import * as path from 'path';
 import {wrap} from 'jest-snapshot-serializer-raw';
+import {onNodeVersions} from '@jest/test-utils';
 import {cleanup, extractSummary, writeFiles} from '../Utils';
 import runJest from '../runJest';
 
@@ -117,6 +118,60 @@ describe('--findRelatedTests flag', () => {
     expect(stderr).toMatch(summaryMsg);
   });
 
+  // The versions where vm.Module exists and commonjs with "exports" is not broken
+  onNodeVersions('>=12.16.0', () => {
+    test('runs tests related to filename with a custom dependency extractor written in ESM', () => {
+      writeFiles(DIR, {
+        '.watchmanconfig': '',
+        '__tests__/test-skip-deps.test.js': `
+        const dynamicImport = path => Promise.resolve(require(path));
+        test('a', () => dynamicImport('../a').then(a => {
+          expect(a.foo).toBe(5);
+        }));
+        `,
+        '__tests__/test.test.js': `
+          const dynamicImport = path => Promise.resolve(require(path));
+          test('a', () => dynamicImport('../a').then(a => {
+            expect(a.foo).toBe(5);
+          }));
+        `,
+        'a.js': 'module.exports = {foo: 5};',
+        'dependencyExtractor.mjs': `
+          const DYNAMIC_IMPORT_RE = /(?:^|[^.]\\s*)(\\bdynamicImport\\s*?\\(\\s*?)([\`'"])([^\`'"]+)(\\2\\s*?\\))/g;
+          export function extract(code, filePath) {
+            const dependencies = new Set();
+            if (filePath.includes('skip-deps')) {
+              return dependencies;
+            }
+            const addDependency = (match, pre, quot, dep, post) => {
+              dependencies.add(dep);
+              return match;
+            };
+            code.replace(DYNAMIC_IMPORT_RE, addDependency);
+            return dependencies;
+          };
+        `,
+        'package.json': JSON.stringify({
+          jest: {
+            dependencyExtractor: '<rootDir>/dependencyExtractor.mjs',
+            testEnvironment: 'node',
+          },
+        }),
+      });
+
+      const {stdout} = runJest(DIR, ['a.js']);
+      expect(stdout).toMatch('');
+
+      const {stderr} = runJest(DIR, ['--findRelatedTests', 'a.js']);
+      expect(stderr).toMatch('PASS __tests__/test.test.js');
+      expect(stderr).not.toMatch('PASS __tests__/test-skip-deps.test.js');
+
+      const summaryMsg =
+        'Ran all test suites related to files matching /a.js/i.';
+      expect(stderr).toMatch(summaryMsg);
+    });
+  });
+
   test('generates coverage report for filename', () => {
     writeFiles(DIR, {
       '.watchmanconfig': '',

e2e/__tests__/hasteMapMockChanged.test.ts

@@ -37,11 +37,11 @@ test('should not warn when a mock file changes', async () => {
   writeFiles(DIR, {
     '__mocks__/fs.js': '"foo fs"',
   });
-  await new JestHasteMap(hasteConfig).build();
+  await (await JestHasteMap.create(hasteConfig)).build();
 
   // This will throw if the mock file being updated triggers a warning.
   writeFiles(DIR, {
     '__mocks__/fs.js': '"foo fs!"',
   });
-  await new JestHasteMap(hasteConfig).build();
+  await (await JestHasteMap.create(hasteConfig)).build();
 });

e2e/__tests__/hasteMapSha1.test.ts

@@ -26,7 +26,7 @@ test('exits the process after test are done but before timers complete', async (
     'node_modules/bar/index.js': '"node modules bar"',
   });
 
-  const haste = new JestHasteMap({
+  const haste = await JestHasteMap.create({
     computeSha1: true,
     extensions: ['js', 'json', 'png'],
     forceNodeFilesystemAPI: true,

e2e/__tests__/hasteMapSize.test.ts

@@ -37,13 +37,13 @@ const options = {
 };
 
 test('reports the correct file size', async () => {
-  const hasteMap = new HasteMap(options);
+  const hasteMap = await HasteMap.create(options);
   const hasteFS = (await hasteMap.build()).hasteFS;
   expect(hasteFS.getSize(path.join(DIR, 'file.js'))).toBe(5);
 });
 
 test('updates the file size when a file changes', async () => {
-  const hasteMap = new HasteMap({...options, watch: true});
+  const hasteMap = await HasteMap.create({...options, watch: true});
   await hasteMap.build();
 
   writeFiles(DIR, {

packages/jest-core/src/cli/index.ts

@@ -134,7 +134,7 @@ const buildContextsAndHasteMaps = async (
   const contexts = await Promise.all(
     configs.map(async (config, index) => {
       createDirectory(config.cacheDirectory);
-      const hasteMapInstance = Runtime.createHasteMap(config, {
+      const hasteMapInstance = await Runtime.createHasteMap(config, {
         console: new CustomConsole(outputStream, outputStream),
         maxWorkers: Math.max(
           1,

packages/jest-haste-map/src/__tests__/dependencyExtractor.mjs

@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+const blockCommentRe = /\/\*[^]*?\*\//g;
+const lineCommentRe = /\/\/.*/g;
+const LOAD_MODULE_RE =
+  /(?:^|[^.]\s*)(\bloadModule\s*?\(\s*?)([`'"])([^`'"]+)(\2\s*?\))/g;
+
+export function extract(code, filePath, defaultDependencyExtractor) {
+  const dependencies = defaultDependencyExtractor(code);
+
+  const addDependency = (match, pre, quot, dep, post) => {
+    dependencies.add(dep);
+    return match;
+  };
+
+  code
+    .replace(blockCommentRe, '')
+    .replace(lineCommentRe, '')
+    .replace(LOAD_MODULE_RE, addDependency);
+
+  return dependencies;
+}
+
+let cacheKey;
+
+export function getCacheKey() {
+  return cacheKey;
+}
+
+export function setCacheKey(key) {
+  cacheKey = key;
+}

packages/jest-haste-map/src/__tests__/includes_dotfiles.test.ts

@@ -21,13 +21,13 @@ const commonOptions = {
 };
 
 test('watchman crawler and node crawler both include dotfiles', async () => {
-  const hasteMapWithWatchman = new HasteMap({
+  const hasteMapWithWatchman = await HasteMap.create({
     ...commonOptions,
     name: 'withWatchman',
     useWatchman: true,
   });
 
-  const hasteMapWithNode = new HasteMap({
+  const hasteMapWithNode = await HasteMap.create({
     ...commonOptions,
     name: 'withNode',
     useWatchman: false,