jestjs#15638 Fix destruction of core nodejs modules that was introduced in jestjs#15215

Author: eyalroth

.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:

.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:

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",

packages/jest-environment-node/package.json

@@ -27,7 +27,8 @@
     "jest-util": "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"

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();
+    });
+  });
 });

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();
+    });
+  });
 });

packages/jest-environment-node/src/index.ts

@@ -102,7 +102,7 @@ export default class NodeEnvironment implements JestEnvironment<Timer> {
       Object.getOwnPropertyNames(global) as GlobalProperties,
     );
     for (const [nodeGlobalsKey, descriptor] of nodeGlobals) {
-      protectProperties(globalThis[nodeGlobalsKey]);
+      protectProperties(globalThis[nodeGlobalsKey], [], 2);
       if (!contextGlobals.has(nodeGlobalsKey)) {
         if (descriptor.configurable) {
           Object.defineProperty(global, nodeGlobalsKey, {
@@ -270,20 +270,14 @@ class GlobalProxy implements ProxyHandler<typeof globalThis> {
    * 2. Properties protected by {@link #protectProperties}.
    */
   clear(): void {
-    for (const {property, value} of [
+    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);
     }
     this.propertyToValue.clear();
     this.leftovers = [];
@@ -334,7 +328,7 @@ class GlobalProxy implements ProxyHandler<typeof globalThis> {
     const currentValue = this.propertyToValue.get(property);
     if (value !== currentValue) {
       if (!this.isEnvSetup && canDeleteProperties(value)) {
-        protectProperties(value);
+        protectProperties(value, [], 2);
       }
       if (currentValue) {
         this.leftovers.push({property, value: currentValue});

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, [], 2);
+    return coreModule;
   }
 
   private _importCoreModule(moduleName: string, context: VMContext) {

packages/jest-util/src/garbage-collection-utils.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const PROTECT_PROPERTY = Symbol.for('$$jest-protect-from-deletion');
+const PROTECT_SYMBOL = Symbol.for('$$jest-protect-from-deletion');
 
 /**
  * Deletes all the properties from the given value (if it's an object),
@@ -15,12 +15,13 @@ const PROTECT_PROPERTY = Symbol.for('$$jest-protect-from-deletion');
  */
 export function deleteProperties(value: unknown): void {
   if (canDeleteProperties(value)) {
-    const protectedProperties = Reflect.get(value, PROTECT_PROPERTY);
-    if (!Array.isArray(protectedProperties) || protectedProperties.length > 0) {
-      for (const key of Reflect.ownKeys(value)) {
-        if (!protectedProperties?.includes(key)) {
-          Reflect.deleteProperty(value, key);
-        }
+    const protectedKeys = getProtectedKeys(
+      value,
+      Reflect.get(value, PROTECT_SYMBOL),
+    );
+    for (const key of Reflect.ownKeys(value)) {
+      if (!protectedKeys.includes(key) && key !== PROTECT_SYMBOL) {
+        Reflect.deleteProperty(value, key);
       }
     }
   }
@@ -31,15 +32,32 @@ export function deleteProperties(value: unknown): void {
  *
  * @param value The given value.
  * @param properties If the array contains any property,
- * then only these properties will not be deleted; otherwise if the array is empty,
- * all properties will not be deleted.
+ * then only these properties will be protected; otherwise if the array is empty,
+ * all properties will be protected.
+ * @param depth By default, this function protects only the top-most properties of the given value.
+ * To protect nested properties as well, set this to a number greater than 0.
  */
-export function protectProperties<T extends object>(
+export function protectProperties<T>(
   value: T,
   properties: Array<keyof T> = [],
+  depth = 0,
 ): boolean {
-  if (canDeleteProperties(value)) {
-    return Reflect.set(value, PROTECT_PROPERTY, properties);
+  if (
+    depth >= 0 &&
+    canDeleteProperties(value) &&
+    !Reflect.has(value, PROTECT_SYMBOL)
+  ) {
+    const result = Reflect.set(value, PROTECT_SYMBOL, properties);
+    for (const key of getProtectedKeys(value, properties)) {
+      try {
+        const nested = Reflect.get(value, key);
+        protectProperties(nested, [], depth - 1);
+      } catch {
+        // Reflect.get might fail in certain edge-cases
+        // Instead of failing the entire process, we will skip the property.
+      }
+    }
+    return result;
   }
   return false;
 }
@@ -57,3 +75,15 @@ export function canDeleteProperties(value: unknown): value is object {
 
   return false;
 }
+
+function getProtectedKeys<T extends object>(
+  value: T,
+  properties: Array<keyof T> | undefined,
+): Array<string | symbol | number> {
+  if (properties === undefined) {
+    return [];
+  }
+  const protectedKeys =
+    properties.length > 0 ? properties : Reflect.ownKeys(value);
+  return protectedKeys.filter(key => PROTECT_SYMBOL !== key);
+}

yarn.lock

@@ -13869,6 +13869,7 @@ __metadata:
     "@jest/test-utils": "workspace:*"
     "@jest/types": "workspace:*"
     "@types/node": "*"
+    clsx: ^2.0.0
     jest-mock: "workspace:*"
     jest-util: "workspace:*"
   languageName: unknown