Fix destruction of core nodejs modules (#15643)

eyalroth · web-flow · commit c2943fca2456 · 2025-06-04T08:32:18.000+09:00
diff --git a/.github/workflows/test-nightly.yml b/.github/workflows/test-nightly.yml
@@ -32,6 +32,8 @@ jobs:
       - name: Get number of CPU cores
         id: cpu-cores
         uses: SimenB/github-actions-cpu-cores@97ba232459a8e02ff6121db9362b09661c875ab8 # v2.0.0
+      - name: run node-env tests
+        run: yarn test-node-env
       - name: run tests
         uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08 # v3.0.2
         with:
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -35,6 +35,8 @@ jobs:
       - name: Get number of CPU cores
         id: cpu-cores
         uses: SimenB/github-actions-cpu-cores@97ba232459a8e02ff6121db9362b09661c875ab8 # v2.0.0
+      - name: run node-env tests
+        run: yarn test-node-env
       - name: run tests
         uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08 # v3.0.2
         with:
diff --git a/e2e/console-debugging/jest.config.js b/e2e/console-debugging/jest.config.js
@@ -10,5 +10,8 @@ require('./stdout-spy');
 
 module.exports = {
   testEnvironment: 'node',
+  testEnvironmentOptions: {
+    globalsCleanupMode: 'hard',
+  },
   verbose: true,
 };
diff --git a/e2e/esm-config/cjs/jest.config.cjs b/e2e/esm-config/cjs/jest.config.cjs
@@ -8,4 +8,7 @@
 module.exports = {
   displayName: 'Config from cjs file',
   testEnvironment: 'node',
+  testEnvironmentOptions: {
+    globalsCleanupMode: 'hard',
+  },
 };
diff --git a/e2e/esm-config/js/jest.config.js b/e2e/esm-config/js/jest.config.js
@@ -10,4 +10,7 @@ const displayName = await Promise.resolve('Config from js file');
 export default {
   displayName,
   testEnvironment: 'node',
+  testEnvironmentOptions: {
+    globalsCleanupMode: 'hard',
+  },
 };
diff --git a/e2e/esm-config/mjs/jest.config.mjs b/e2e/esm-config/mjs/jest.config.mjs
@@ -10,4 +10,7 @@ const displayName = await Promise.resolve('Config from mjs file');
 export default {
   displayName,
   testEnvironment: 'node',
+  testEnvironmentOptions: {
+    globalsCleanupMode: 'hard',
+  },
 };
diff --git a/e2e/esm-config/ts/jest.config.ts b/e2e/esm-config/ts/jest.config.ts
@@ -10,11 +10,17 @@
 type DummyConfig = {
   displayName: string;
   testEnvironment: string;
+  testEnvironmentOptions?: {
+    globalsCleanupMode: 'hard' | 'soft' | 'off';
+  };
 };
 
 const config: DummyConfig = {
   displayName: 'Config from ts file',
   testEnvironment: 'node',
+  testEnvironmentOptions: {
+    globalsCleanupMode: 'hard',
+  },
 };
 
 export default () => config;
diff --git a/e2e/typescript-config/modern-module-resolution/jest.config.ts b/e2e/typescript-config/modern-module-resolution/jest.config.ts
@@ -8,5 +8,8 @@
 const config = {
   displayName: 'Config from modern ts file',
   testEnvironment: 'node',
+  testEnvironmentOptions: {
+    globalsCleanupMode: 'hard',
+  },
 };
 export default config;
diff --git a/examples/react-native/jest.config.js b/examples/react-native/jest.config.js
@@ -2,6 +2,9 @@ const {resolve} = require('path');
 
 module.exports = {
   preset: 'react-native',
+  testEnvironmentOptions: {
+    globalsCleanupMode: 'soft',
+  },
   // this is specific to the Jest repo, not generally needed (the files we ignore will be in node_modules which is ignored by default)
   transformIgnorePatterns: [resolve(__dirname, '../../packages')],
 };
diff --git a/jest.config.mjs b/jest.config.mjs
@@ -37,6 +37,9 @@ export default {
     printBasicPrototype: true,
   },
   snapshotSerializers: [require.resolve('jest-serializer-ansi-escapes')],
+  testEnvironmentOptions: {
+    globalsCleanupMode: 'hard',
+  },
   testPathIgnorePatterns: [
     '/__arbitraries__/',
     '/__benchmarks__/',
diff --git a/package.json b/package.json
@@ -112,6 +112,7 @@
     "test-ts": "yarn jest --config jest.config.ts.mjs",
     "test-types": "yarn tstyche",
     "test-with-type-info": "yarn jest e2e/__tests__/jest.config.ts.test.ts",
+    "test-node-env": "yarn jest packages/jest-environment-node/src/__tests__",
     "test": "yarn lint && yarn jest",
     "typecheck": "yarn typecheck:examples && yarn typecheck:tests",
     "typecheck:examples": "tsc -p examples/expect-extend && tsc -p examples/typescript",
diff --git a/packages/jest-environment-node/package.json b/packages/jest-environment-node/package.json
@@ -24,10 +24,12 @@
     "@jest/types": "workspace:*",
     "@types/node": "*",
     "jest-mock": "workspace:*",
-    "jest-util": "workspace:*"
+    "jest-util": "workspace:*",
+    "jest-validate": "workspace:*"
   },
   "devDependencies": {
-    "@jest/test-utils": "workspace:*"
+    "@jest/test-utils": "workspace:*",
+    "clsx": "^2.0.0"
   },
   "engines": {
     "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0"
diff --git a/packages/jest-environment-node/src/__tests__/node_environment.test.ts b/packages/jest-environment-node/src/__tests__/node_environment.test.ts
@@ -6,8 +6,14 @@
  */
 
 import type {EnvironmentContext} from '@jest/environment';
-import {makeGlobalConfig, makeProjectConfig} from '@jest/test-utils';
+import {
+  makeGlobalConfig,
+  makeProjectConfig,
+  onNodeVersions,
+} from '@jest/test-utils';
 import NodeEnvironment from '../';
+import {AsyncLocalStorage, createHook} from 'async_hooks';
+import {clsx} from 'clsx';
 
 const context: EnvironmentContext = {
   console,
@@ -91,4 +97,24 @@ describe('NodeEnvironment', () => {
   test('dispatch event', () => {
     new EventTarget().dispatchEvent(new Event('foo'));
   });
+
+  test('set modules on global', () => {
+    (globalThis as any).async_hooks = require('async_hooks');
+    (globalThis as any).AsyncLocalStorage =
+      require('async_hooks').AsyncLocalStorage;
+    (globalThis as any).createHook = require('async_hooks').createHook;
+    (globalThis as any).clsx = require('clsx');
+    expect(AsyncLocalStorage).toBeDefined();
+    expect(clsx).toBeDefined();
+    expect(createHook).toBeDefined();
+    expect(createHook({})).toBeDefined();
+    expect(clsx()).toBeDefined();
+  });
+
+  onNodeVersions('>=19.8.0', () => {
+    test('use static function from core module set on global', () => {
+      expect(AsyncLocalStorage.snapshot).toBeDefined();
+      expect(AsyncLocalStorage.snapshot()).toBeDefined();
+    });
+  });
 });
diff --git a/packages/jest-environment-node/src/__tests__/node_environment_2.test.ts b/packages/jest-environment-node/src/__tests__/node_environment_2.test.ts
@@ -5,8 +5,32 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+import {AsyncLocalStorage, createHook} from 'async_hooks';
+import {clsx} from 'clsx';
+import {onNodeVersions} from '@jest/test-utils';
+
 describe('NodeEnvironment 2', () => {
   test('dispatch event', () => {
     new EventTarget().dispatchEvent(new Event('foo'));
   });
+
+  test('set modules on global', () => {
+    (globalThis as any).async_hooks = require('async_hooks');
+    (globalThis as any).AsyncLocalStorage =
+      require('async_hooks').AsyncLocalStorage;
+    (globalThis as any).createHook = require('async_hooks').createHook;
+    (globalThis as any).clsx = require('clsx');
+    expect(AsyncLocalStorage).toBeDefined();
+    expect(clsx).toBeDefined();
+    expect(createHook).toBeDefined();
+    expect(createHook({})).toBeDefined();
+    expect(clsx()).toBeDefined();
+  });
+
+  onNodeVersions('>=19.8.0', () => {
+    test('use static function from core module set on global', () => {
+      expect(AsyncLocalStorage.snapshot).toBeDefined();
+      expect(AsyncLocalStorage.snapshot()).toBeDefined();
+    });
+  });
 });
diff --git a/packages/jest-environment-node/src/index.ts b/packages/jest-environment-node/src/index.ts
@@ -15,11 +15,13 @@ import {LegacyFakeTimers, ModernFakeTimers} from '@jest/fake-timers';
 import type {Global} from '@jest/types';
 import {ModuleMocker} from 'jest-mock';
 import {
+  type DeletionMode,
   canDeleteProperties,
   deleteProperties,
   installCommonGlobals,
   protectProperties,
 } from 'jest-util';
+import {logValidationWarning} from 'jest-validate';
 
 type Timer = {
   id: number;
@@ -86,6 +88,7 @@ export default class NodeEnvironment implements JestEnvironment<Timer> {
   customExportConditions = ['node', 'node-addons'];
   private readonly _configuredExportConditions?: Array<string>;
   private _globalProxy: GlobalProxy;
+  private _globalsCleanupMode: 'off' | DeletionMode;
 
   // while `context` is unused, it should always be passed
   constructor(config: JestEnvironmentConfig, _context: EnvironmentContext) {
@@ -203,6 +206,27 @@ export default class NodeEnvironment implements JestEnvironment<Timer> {
     });
 
     this._globalProxy.envSetupCompleted();
+    this._globalsCleanupMode = (() => {
+      const rawConfig =
+        projectConfig.testEnvironmentOptions['globalsCleanupMode'];
+      const config = rawConfig?.toString()?.toLowerCase();
+      switch (config) {
+        case 'hard':
+        case 'soft':
+        case 'off':
+          return config;
+        default: {
+          if (config !== undefined) {
+            logValidationWarning(
+              'testEnvironmentOptions.globalsCleanupMode',
+              `Unknown value given: ${rawConfig}`,
+              'Available options are: [hard, soft, off]',
+            );
+          }
+          return 'soft';
+        }
+      }
+    })();
   }
 
   // eslint-disable-next-line @typescript-eslint/no-empty-function
@@ -218,7 +242,9 @@ export default class NodeEnvironment implements JestEnvironment<Timer> {
     this.context = null;
     this.fakeTimers = null;
     this.fakeTimersModern = null;
-    this._globalProxy.clear();
+    if (this._globalsCleanupMode !== 'off') {
+      this._globalProxy.clear(this._globalsCleanupMode);
+    }
   }
 
   exportConditions(): Array<string> {
@@ -268,22 +294,18 @@ class GlobalProxy implements ProxyHandler<typeof globalThis> {
    * Deletes any property that was set on the global object, except for:
    * 1. Properties that were set before {@link #envSetupCompleted} was invoked.
    * 2. Properties protected by {@link #protectProperties}.
+   *
+   * @param mode determines whether to soft or hard delete the properties.
    */
-  clear(): void {
-    for (const {property, value} of [
+  clear(mode: DeletionMode): void {
+    for (const {value} of [
       ...[...this.propertyToValue.entries()].map(([property, value]) => ({
         property,
         value,
       })),
       ...this.leftovers,
     ]) {
-      /*
-       * React Native's test setup invokes their custom `performance` property after env teardown.
-       * Once they start using `protectProperties`, we can get rid of this.
-       */
-      if (property !== 'performance') {
-        deleteProperties(value);
-      }
+      deleteProperties(value, mode);
     }
     this.propertyToValue.clear();
     this.leftovers = [];
diff --git a/packages/jest-environment-node/tsconfig.json b/packages/jest-environment-node/tsconfig.json
@@ -12,6 +12,7 @@
     {"path": "../jest-fake-timers"},
     {"path": "../jest-mock"},
     {"path": "../jest-types"},
-    {"path": "../jest-util"}
+    {"path": "../jest-util"},
+    {"path": "../jest-validate"}
   ]
 }
diff --git a/packages/jest-runtime/src/index.ts b/packages/jest-runtime/src/index.ts
@@ -55,6 +55,7 @@ import {
   deepCyclicCopy,
   invariant,
   isNonNullable,
+  protectProperties,
 } from 'jest-util';
 import {
   createOutsideJestVmPath,
@@ -1767,7 +1768,9 @@ export default class Runtime {
       return this._getMockedNativeModule();
     }
 
-    return require(moduleName);
+    const coreModule = require(moduleName);
+    protectProperties(coreModule);
+    return coreModule;
   }
 
   private _importCoreModule(moduleName: string, context: VMContext) {
diff --git a/packages/jest-util/package.json b/packages/jest-util/package.json
@@ -28,7 +28,8 @@
   },
   "devDependencies": {
     "@types/graceful-fs": "^4.1.3",
-    "@types/picomatch": "^4.0.0"
+    "@types/picomatch": "^4.0.0",
+    "lodash": "^4.17.19"
   },
   "engines": {
     "node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0"
diff --git a/packages/jest-util/src/__tests__/garbage-collection-utils.test.ts b/packages/jest-util/src/__tests__/garbage-collection-utils.test.ts
@@ -0,0 +1,18 @@
+/**
+ * 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 {protectProperties} from '../garbage-collection-utils';
+
+const omit = require('lodash').omit;
+
+it('protection symbol doesnt leak', () => {
+  const obj = {a: 1, b: 2};
+  protectProperties(obj);
+  expect(obj).toStrictEqual(obj);
+  expect(omit(obj, 'a')).toStrictEqual({b: 2});
+  expect({b: 2}).toStrictEqual(omit(obj, 'a'));
+});
diff --git a/packages/jest-util/src/garbage-collection-utils.ts b/packages/jest-util/src/garbage-collection-utils.ts
diff --git a/packages/jest-util/src/index.ts b/packages/jest-util/src/index.ts
diff --git a/yarn.lock b/yarn.lock
