chore: migrate jest-haste-map to ESM

jestjs · Nov 26, 2020 · 7d8028f · 7d8028f
1 parent 245a582
commit 7d8028f
Show file tree

Hide file tree

Showing 13 changed files with 36 additions and 45 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -36,6 +36,7 @@
 - `[jest-config]` [**BREAKING**] Remove `enabledTestsMap` config, use `filter` instead ([#10787](https://github.com/facebook/jest/pull/10787))
 - `[jest-console]` [**BREAKING**] Move `root` into `config` and take `GlobalConfig` as mandatory parameter for `getConsoleOutput` ([#10126](https://github.com/facebook/jest/pull/10126))
 - `[jest-fake-timers]` Clarify global behavior of `jest.useFakeTimers` and `jest.useRealTimers` ([#10867](https://github.com/facebook/jest/pull/10867))
+- `[jest-haste-map]` [**BREAKING**] Migrate to ESM ([#10875](https://github.com/facebook/jest/pull/10875))
 - `[jest-repl, jest-runtime]` [**BREAKING**] Move the `jest-runtime` CLI into `jest-repl` ([#10016](https://github.com/facebook/jest/pull/10016))
 - `[jest-resolve]` [**BREAKING**] Migrate to ESM ([#10688](https://github.com/facebook/jest/pull/10688))
 - `[jest-resolve-dependencies]` [**BREAKING**] Migrate to ESM ([#10876](https://github.com/facebook/jest/pull/10876))

diff --git a/e2e/__tests__/hasteMapMockChanged.test.ts b/e2e/__tests__/hasteMapMockChanged.test.ts
@@ -6,7 +6,7 @@
  */
 
 import * as path from 'path';
-import JestHasteMap = require('jest-haste-map');
+import JestHasteMap from 'jest-haste-map';
 import {cleanup, writeFiles} from '../Utils';
 
 // Directory must be here for Watchman to be enabled.

diff --git a/e2e/__tests__/hasteMapSha1.test.ts b/e2e/__tests__/hasteMapSha1.test.ts
@@ -7,7 +7,7 @@
 
 import {tmpdir} from 'os';
 import * as path from 'path';
-import JestHasteMap = require('jest-haste-map');
+import JestHasteMap from 'jest-haste-map';
 import {cleanup, writeFiles} from '../Utils';
 
 const DIR = path.resolve(tmpdir(), 'haste_map_sha1');

diff --git a/e2e/__tests__/hasteMapSize.test.ts b/e2e/__tests__/hasteMapSize.test.ts
@@ -8,7 +8,7 @@
 import {tmpdir} from 'os';
 import * as path from 'path';
 import {realpathSync} from 'graceful-fs';
-import HasteMap = require('jest-haste-map');
+import HasteMap from 'jest-haste-map';
 import {cleanup, writeFiles} from '../Utils';
 
 const DIR = path.resolve(realpathSync.native(tmpdir()), 'haste_map_size');

diff --git a/packages/jest-core/src/__tests__/watchFileChanges.test.ts b/packages/jest-core/src/__tests__/watchFileChanges.test.ts
@@ -12,7 +12,7 @@ import * as fs from 'graceful-fs';
 import rimraf = require('rimraf');
 import type {AggregatedResult} from '@jest/test-result';
 import {normalize} from 'jest-config';
-import HasteMap = require('jest-haste-map');
+import type HasteMap from 'jest-haste-map';
 import Runtime from 'jest-runtime';
 import {JestHook} from 'jest-watcher';
 

diff --git a/packages/jest-core/src/cli/index.ts b/packages/jest-core/src/cli/index.ts
@@ -13,7 +13,7 @@ import type {AggregatedResult} from '@jest/test-result';
 import type {Config} from '@jest/types';
 import type {ChangedFilesPromise} from 'jest-changed-files';
 import {readConfigs} from 'jest-config';
-import HasteMap = require('jest-haste-map');
+import type HasteMap from 'jest-haste-map';
 import Runtime, {Context} from 'jest-runtime';
 import {createDirectory, preRunMessage} from 'jest-util';
 import TestWatcher from '../TestWatcher';

diff --git a/packages/jest-core/src/watch.ts b/packages/jest-core/src/watch.ts
@@ -11,7 +11,10 @@ import chalk = require('chalk');
 import exit = require('exit');
 import slash = require('slash');
 import type {Config} from '@jest/types';
-import HasteMap = require('jest-haste-map');
+import type {
+  ChangeEvent as HasteChangeEvent,
+  default as HasteMap,
+} from 'jest-haste-map';
 import {formatExecError} from 'jest-message-util';
 import Resolver from 'jest-resolve';
 import type {Context} from 'jest-runtime';
@@ -234,7 +237,7 @@ export default function watch(
   hasteMapInstances.forEach((hasteMapInstance, index) => {
     hasteMapInstance.on(
       'change',
-      ({eventsQueue, hasteFS, moduleMap}: HasteMap.HasteChangeEvent) => {
+      ({eventsQueue, hasteFS, moduleMap}: HasteChangeEvent) => {
         const validPaths = eventsQueue.filter(({filePath}) =>
           isValidPath(globalConfig, filePath),
         );

diff --git a/packages/jest-haste-map/src/__tests__/index.test.js b/packages/jest-haste-map/src/__tests__/index.test.js
@@ -192,7 +192,7 @@ describe('HasteMap', () => {
     console.warn = jest.fn();
     console.error = jest.fn();
 
-    HasteMap = require('../');
+    HasteMap = require('../').default;
     H = HasteMap.H;
 
     getCacheFilePath = HasteMap.getCacheFilePath;
@@ -225,7 +225,7 @@ describe('HasteMap', () => {
 
   it('creates valid cache file paths', () => {
     jest.resetModules();
-    HasteMap = require('../');
+    HasteMap = require('../').default;
 
     expect(
       HasteMap.getCacheFilePath('/', '@scoped/package', 'random-value'),
@@ -238,15 +238,15 @@ describe('HasteMap', () => {
 
   it('creates different cache file paths for different roots', () => {
     jest.resetModules();
-    const HasteMap = require('../');
+    const HasteMap = require('../').default;
     const hasteMap1 = new HasteMap({...defaultConfig, rootDir: '/root1'});
     const hasteMap2 = new HasteMap({...defaultConfig, rootDir: '/root2'});
     expect(hasteMap1.getCacheFilePath()).not.toBe(hasteMap2.getCacheFilePath());
   });
 
   it('creates different cache file paths for different dependency extractor cache keys', () => {
     jest.resetModules();
-    const HasteMap = require('../');
+    const HasteMap = require('../').default;
     const dependencyExtractor = require('./dependencyExtractor');
     const config = {
       ...defaultConfig,
@@ -261,7 +261,7 @@ describe('HasteMap', () => {
 
   it('creates different cache file paths for different hasteImplModulePath cache keys', () => {
     jest.resetModules();
-    const HasteMap = require('../');
+    const HasteMap = require('../').default;
     const hasteImpl = require('./haste_impl');
     hasteImpl.setCacheKey('foo');
     const hasteMap1 = new HasteMap(defaultConfig);
@@ -272,7 +272,7 @@ describe('HasteMap', () => {
 
   it('creates different cache file paths for different projects', () => {
     jest.resetModules();
-    const HasteMap = require('../');
+    const HasteMap = require('../').default;
     const hasteMap1 = new HasteMap({...defaultConfig, name: '@scoped/package'});
     const hasteMap2 = new HasteMap({...defaultConfig, name: '-scoped-package'});
     expect(hasteMap1.getCacheFilePath()).not.toBe(hasteMap2.getCacheFilePath());

diff --git a/packages/jest-haste-map/src/index.ts b/packages/jest-haste-map/src/index.ts
@@ -19,9 +19,7 @@ import {escapePathForRegex} from 'jest-regex-util';
 import serializer from 'jest-serializer';
 import Worker from 'jest-worker';
 import HasteFS from './HasteFS';
-import HasteModuleMap, {
-  SerializableModuleMap as HasteSerializableModuleMap,
-} from './ModuleMap';
+import HasteModuleMap from './ModuleMap';
 import H from './constants';
 import nodeCrawl = require('./crawlers/node');
 import watchmanCrawl = require('./crawlers/watchman');
@@ -51,8 +49,6 @@ import {getSha1, worker} from './worker';
 // understand `require`.
 const {version: VERSION} = require('../package.json');
 
-type HType = typeof H;
-
 type Options = {
   cacheDirectory?: string;
   computeDependencies?: boolean;
@@ -106,14 +102,10 @@ type Watcher = {
 
 type WorkerInterface = {worker: typeof worker; getSha1: typeof getSha1};
 
-// TODO: Ditch namespace when this module exports ESM
-declare namespace HasteMap {
-  export type ModuleMap = HasteModuleMap;
-  export type SerializableModuleMap = HasteSerializableModuleMap;
-  export type FS = HasteFS;
-  export type HasteMapObject = InternalHasteMapObject;
-  export type HasteChangeEvent = ChangeEvent;
-}
+export {default as ModuleMap} from './ModuleMap';
+export type {SerializableModuleMap} from './ModuleMap';
+export type {default as FS} from './HasteFS';
+export type {ChangeEvent, HasteMap as HasteMapObject} from './types';
 
 const CHANGE_INTERVAL = 30;
 const MAX_WAIT_TIME = 240000;
@@ -215,7 +207,7 @@ function invariant(condition: unknown, message?: string): asserts condition {
  *     Worker processes can directly access the cache through `HasteMap.read()`.
  *
  */
-class HasteMap extends EventEmitter {
+export default class HasteMap extends EventEmitter {
   private _buildPromise: Promise<InternalHasteMapObject> | null;
   private _cachePath: Config.Path;
   private _changeInterval?: NodeJS.Timeout;
@@ -1093,12 +1085,10 @@ class HasteMap extends EventEmitter {
     };
   }
 
-  static H: HType;
-  static DuplicateError: typeof DuplicateError;
-  static ModuleMap: typeof HasteModuleMap;
+  static H = H;
 }
 
-class DuplicateError extends Error {
+export class DuplicateError extends Error {
   mockPath1: string;
   mockPath2: string;
 
@@ -1117,9 +1107,3 @@ function copy<T extends Record<string, unknown>>(object: T): T {
 function copyMap<K, V>(input: Map<K, V>): Map<K, V> {
   return new Map(input);
 }
-
-HasteMap.H = H;
-HasteMap.DuplicateError = DuplicateError;
-HasteMap.ModuleMap = HasteModuleMap;
-
-export = HasteMap;
diff --git a/packages/jest-runner/src/testWorker.ts b/packages/jest-runner/src/testWorker.ts
@@ -9,7 +9,7 @@
 import exit = require('exit');
 import type {SerializableError, TestResult} from '@jest/test-result';
 import type {Config} from '@jest/types';
-import HasteMap = require('jest-haste-map');
+import {ModuleMap, SerializableModuleMap} from 'jest-haste-map';
 import {separateMessageFromStack} from 'jest-message-util';
 import type Resolver from 'jest-resolve';
 import Runtime from 'jest-runtime';
@@ -23,7 +23,7 @@ import type {
 
 export type SerializableResolver = {
   config: Config.ProjectConfig;
-  serializableModuleMap: HasteMap.SerializableModuleMap;
+  serializableModuleMap: SerializableModuleMap;
 };
 
 type WorkerData = {
@@ -74,7 +74,7 @@ export function setup(setupData: {
     config,
     serializableModuleMap,
   } of setupData.serializableResolvers) {
-    const moduleMap = HasteMap.ModuleMap.fromJSON(serializableModuleMap);
+    const moduleMap = ModuleMap.fromJSON(serializableModuleMap);
     resolvers.set(config.name, Runtime.createResolver(config, moduleMap));
   }
 }

diff --git a/packages/jest-runtime/src/index.ts b/packages/jest-runtime/src/index.ts
@@ -41,7 +41,7 @@ import {
   shouldInstrument,
 } from '@jest/transform';
 import type {Config, Global} from '@jest/types';
-import HasteMap = require('jest-haste-map');
+import HasteMap, {ModuleMap} from 'jest-haste-map';
 import {formatStackTrace, separateMessageFromStack} from 'jest-message-util';
 import jestMock = require('jest-mock');
 import {escapePathForRegex} from 'jest-regex-util';
@@ -334,7 +334,7 @@ export default class Runtime {
 
   static createResolver(
     config: Config.ProjectConfig,
-    moduleMap: HasteMap.ModuleMap,
+    moduleMap: ModuleMap,
   ): Resolver {
     return new Resolver(moduleMap, {
       defaultPlatform: config.haste.defaultPlatform,

diff --git a/packages/jest-test-sequencer/src/index.ts b/packages/jest-test-sequencer/src/index.ts
@@ -7,7 +7,7 @@
 
 import * as fs from 'graceful-fs';
 import type {AggregatedResult} from '@jest/test-result';
-import {getCacheFilePath} from 'jest-haste-map';
+import HasteMap from 'jest-haste-map';
 import type {Test} from 'jest-runner';
 import type {Context} from 'jest-runtime';
 
@@ -36,7 +36,10 @@ export default class TestSequencer {
 
   _getCachePath(context: Context): string {
     const {config} = context;
-    return getCacheFilePath(config.cacheDirectory, 'perf-cache-' + config.name);
+    return HasteMap.getCacheFilePath(
+      config.cacheDirectory,
+      'perf-cache-' + config.name,
+    );
   }
 
   _getCache(test: Test): Cache {

diff --git a/packages/jest-transform/src/ScriptTransformer.ts b/packages/jest-transform/src/ScriptTransformer.ts
@@ -17,7 +17,7 @@ import {addHook} from 'pirates';
 import slash = require('slash');
 import {sync as writeFileAtomic} from 'write-file-atomic';
 import type {Config} from '@jest/types';
-import HasteMap = require('jest-haste-map');
+import HasteMap from 'jest-haste-map';
 import {
   createDirectory,
   interopRequireDefault,