fix: isolate esm async import bug

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 ### Fixes
 
+- `[jest-runtime]` Fix dynamic esm import module bug when loaded module through `jest.isolateModulesAsync`  ([14397](https://github.com/jestjs/jest/pull/14397))
+
 ### Chore & Maintenance
 
 ### Performance

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

@@ -0,0 +1,9 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`runs test with async ESM import 1`] = `
+"Test Suites: 1 passed, 1 total
+Tests:       1 passed, 1 total
+Snapshots:   0 total
+Time:        <<REPLACED>>
+Ran all test suites."
+`;

e2e/__tests__/asyncESMImport.test.ts

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+
+import {extractSummary} from '../Utils';
+import runJest from '../runJest';
+
+test('runs test with async ESM import', () => {
+  const {exitCode, stderr} = runJest('async-esm-import', [], {
+    nodeOptions: '--experimental-vm-modules --no-warnings',
+  });
+
+  const {summary} = extractSummary(stderr);
+
+  expect(summary).toMatchSnapshot();
+  expect(exitCode).toBe(0);
+});

e2e/async-esm-import/__tests__/main.js

@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+import {jest} from '@jest/globals';
+
+test('should have a fresh module state in each isolateModulesAsync context', async () => {
+  await jest.isolateModulesAsync(async () => {
+    const {getState, incState} = await import('../main.js');
+    expect(getState()).toBe(0);
+    incState();
+    expect(getState()).toBe(1);
+  });
+  await jest.isolateModulesAsync(async () => {
+    const {getState, incState} = await import('../main.js');
+    expect(getState()).toBe(0);
+    incState();
+    expect(getState()).toBe(1);
+  });
+});

e2e/async-esm-import/main.js

@@ -0,0 +1,15 @@
+/**
+ * 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.
+ */
+let myState = 0;
+
+export function incState() {
+  myState += 1;
+}
+
+export function getState() {
+  return myState;
+}

e2e/async-esm-import/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "async-esm-import",
+  "type": "module",
+  "jest": {
+    "transform": {},
+    "testEnvironment": "node"
+  }
+}

packages/jest-runtime/src/index.ts

@@ -179,6 +179,7 @@ export default class Runtime {
   private readonly _moduleMockFactories: Map<string, () => unknown>;
   private readonly _moduleMocker: ModuleMocker;
   private _isolatedModuleRegistry: ModuleRegistry | null;
+  private _isolatedESMModuleRegistry: ModuleRegistry | null;
   private _moduleRegistry: ModuleRegistry;
   private readonly _esmoduleRegistry: Map<string, VMModule>;
   private readonly _cjsNamedExports: Map<string, Set<string>>;
@@ -242,6 +243,7 @@ export default class Runtime {
     this._moduleMocker = this._environment.moduleMocker;
     this._isolatedModuleRegistry = null;
     this._isolatedMockRegistry = null;
+    this._isolatedESMModuleRegistry = null;
     this._moduleRegistry = new Map();
     this._esmoduleRegistry = new Map();
     this._cjsNamedExports = new Map();
@@ -416,12 +418,15 @@ export default class Runtime {
     query = '',
   ): Promise<VMModule> {
     const cacheKey = modulePath + query;
+    const registry = this._isolatedESMModuleRegistry
+      ? this._isolatedESMModuleRegistry
+      : this._esmoduleRegistry;
 
     if (this._fileTransformsMutex.has(cacheKey)) {
       await this._fileTransformsMutex.get(cacheKey);
     }
 
-    if (!this._esmoduleRegistry.has(cacheKey)) {
+    if (!registry.has(cacheKey)) {
       invariant(
         typeof this._environment.getVmContext === 'function',
         'ES Modules are only supported if your test environment has the `getVmContext` function',
@@ -454,15 +459,15 @@ export default class Runtime {
           context,
         );
 
-        this._esmoduleRegistry.set(cacheKey, wasm);
+        registry.set(cacheKey, wasm);
 
         transformResolve();
         return wasm;
       }
 
       if (this._resolver.isCoreModule(modulePath)) {
         const core = this._importCoreModule(modulePath, context);
-        this._esmoduleRegistry.set(cacheKey, core);
+        registry.set(cacheKey, core);
 
         transformResolve();
 
@@ -526,11 +531,11 @@ export default class Runtime {
         }
 
         invariant(
-          !this._esmoduleRegistry.has(cacheKey),
+          !registry.has(cacheKey),
           `Module cache already has entry ${cacheKey}. This is a bug in Jest, please report it!`,
         );
 
-        this._esmoduleRegistry.set(cacheKey, module);
+        registry.set(cacheKey, module);
 
         transformResolve();
       } catch (error) {
@@ -539,7 +544,7 @@ export default class Runtime {
       }
     }
 
-    const module = this._esmoduleRegistry.get(cacheKey);
+    const module = registry.get(cacheKey);
 
     invariant(
       module,
@@ -563,14 +568,18 @@ export default class Runtime {
       return;
     }
 
+    const registry = this._isolatedESMModuleRegistry
+      ? this._isolatedESMModuleRegistry
+      : this._esmoduleRegistry;
+
     if (specifier === '@jest/globals') {
-      const fromCache = this._esmoduleRegistry.get('@jest/globals');
+      const fromCache = registry.get('@jest/globals');
 
       if (fromCache) {
         return fromCache;
       }
       const globals = this.getGlobalsForEsm(referencingIdentifier, context);
-      this._esmoduleRegistry.set('@jest/globals', globals);
+      registry.set('@jest/globals', globals);
 
       return globals;
     }
@@ -586,7 +595,7 @@ export default class Runtime {
         return this.importMock(referencingIdentifier, specifier, context);
       }
 
-      const fromCache = this._esmoduleRegistry.get(specifier);
+      const fromCache = registry.get(specifier);
 
       if (fromCache) {
         return fromCache;
@@ -662,7 +671,7 @@ export default class Runtime {
         }
       }
 
-      this._esmoduleRegistry.set(specifier, module);
+      registry.set(specifier, module);
       return module;
     }
 
@@ -1164,21 +1173,28 @@ export default class Runtime {
   }
 
   async isolateModulesAsync(fn: () => Promise<void>): Promise<void> {
-    if (this._isolatedModuleRegistry || this._isolatedMockRegistry) {
+    if (
+      this._isolatedModuleRegistry ||
+      this._isolatedMockRegistry ||
+      this._isolatedESMModuleRegistry
+    ) {
       throw new Error(
         'isolateModulesAsync cannot be nested inside another isolateModulesAsync or isolateModules.',
       );
     }
     this._isolatedModuleRegistry = new Map();
     this._isolatedMockRegistry = new Map();
+    this._isolatedESMModuleRegistry = new Map();
     try {
       await fn();
     } finally {
       // might be cleared within the callback
       this._isolatedModuleRegistry?.clear();
       this._isolatedMockRegistry?.clear();
+      this._isolatedESMModuleRegistry?.clear();
       this._isolatedModuleRegistry = null;
       this._isolatedMockRegistry = null;
+      this._isolatedESMModuleRegistry = null;
     }
   }