Address changes in jest 30.x

Author: cmalonzo

build-tests-samples/heft-node-basic-tutorial/src/test/__snapshots__/ExampleTest.test.ts.snap

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`Example Test Correctly handles snapshots 1`] = `
 Object {

build-tests-samples/heft-node-rig-tutorial/src/test/__snapshots__/ExampleTest.test.ts.snap

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`Example Test Correctly handles snapshots 1`] = `
 Object {

build-tests/api-extractor-test-05/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.57.8"
+      "packageVersion": "7.58.0"
     }
   ]
 }

build-tests/heft-node-everything-test/src/test/__snapshots__/ExampleTest.test.ts.snap

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`Example Test Correctly handles snapshots 1`] = `
 Object {

heft-plugins/heft-jest-plugin/src/JestRealPathPatch.ts

@@ -10,14 +10,10 @@ const jestResolvePackageFolder: string = path.dirname(require.resolve('jest-reso
 const jestUtilPackageFolder: string = path.dirname(
   require.resolve('jest-util/package.json', { paths: [jestResolvePackageFolder] })
 );
-const jestUtilTryRealpathPath: string = path.resolve(jestUtilPackageFolder, './build/tryRealpath.js');
 
 const { realNodeModulePath }: RealNodeModulePathResolver = new RealNodeModulePathResolver();
 
-const tryRealpathModule: {
-  default: (filePath: string) => string;
-} = require(jestUtilTryRealpathPath);
-tryRealpathModule.default = (input: string): string => {
+const customTryRealpath = (input: string): string => {
   try {
     return realNodeModulePath(input);
   } catch (error) {
@@ -30,3 +26,31 @@ tryRealpathModule.default = (input: string): string => {
   }
   return input;
 };
+
+const jestUtilPackageJson: { version: string } = require(path.join(jestUtilPackageFolder, 'package.json'));
+const jestUtilMajorVersion: number = parseInt(jestUtilPackageJson.version.split('.')[0], 10);
+
+if (jestUtilMajorVersion >= 30) {
+  // jest-util 30+: everything is bundled in index.js.
+  // tryRealpath is exported as a non-configurable getter, so we can't set it directly.
+  // Instead, replace the require-cache entry with an object that shadows the getter.
+  const jestUtilIndexPath: string = require.resolve('jest-util', {
+    paths: [jestResolvePackageFolder]
+  });
+  const jestUtilExports: object = require(jestUtilIndexPath);
+  const patchedExports: object = Object.create(jestUtilExports);
+  Object.defineProperty(patchedExports, 'tryRealpath', {
+    value: customTryRealpath,
+    writable: true,
+    enumerable: true,
+    configurable: true
+  });
+  require.cache[jestUtilIndexPath]!.exports = patchedExports;
+} else {
+  // jest-util < 30: tryRealpath is a standalone module; replace its default export.
+  const jestUtilTryRealpathPath: string = path.resolve(jestUtilPackageFolder, './build/tryRealpath.js');
+  const tryRealpathModule: {
+    default: (filePath: string) => string;
+  } = require(jestUtilTryRealpathPath);
+  tryRealpathModule.default = customTryRealpath;
+}

heft-plugins/heft-jest-plugin/src/patches/jestWorkerPatch.ts

@@ -4,6 +4,7 @@
 /* eslint-disable no-console */
 
 import * as path from 'node:path';
+import { createRequire } from 'node:module';
 
 import { Import, FileSystem } from '@rushstack/node-core-library';
 
@@ -62,41 +63,44 @@ function applyPatch(): void {
       useNodeJSResolver: true
     });
 
-    const baseWorkerPoolPath: string = path.join(jestWorkerFolder, 'build/base/BaseWorkerPool.js');
-    const baseWorkerPoolFilename: string = path.basename(baseWorkerPoolPath); // BaseWorkerPool.js
+    // jest-worker 30.x switched to a webpack-bundled single-file architecture.
+    // For 29.x and earlier, patch build/base/BaseWorkerPool.js directly.
+    // For 30.x and later, patch build/index.js (the webpack bundle).
+    const jestWorkerPackageJson: { version: string } = require(path.join(jestWorkerFolder, 'package.json'));
+    const jestWorkerMajorVersion: number = parseInt(jestWorkerPackageJson.version.split('.')[0], 10);
+    const isBundled: boolean = jestWorkerMajorVersion >= 30;
 
-    if (!FileSystem.exists(baseWorkerPoolPath)) {
+    const targetPath: string = isBundled
+      ? path.join(jestWorkerFolder, 'build/index.js')
+      : path.join(jestWorkerFolder, 'build/base/BaseWorkerPool.js');
+
+    if (!FileSystem.exists(targetPath)) {
       throw new Error(
-        'The BaseWorkerPool.js file was not found in the expected location:\n' + baseWorkerPoolPath
+        `The ${path.basename(targetPath)} file was not found in the expected location:\n` + targetPath
       );
     }
 
     // Load the module
-    const baseWorkerPoolModule: IBaseWorkerPoolModule = require(baseWorkerPoolPath);
+    const targetModule: IBaseWorkerPoolModule = require(targetPath);
 
     // Obtain the metadata for the module
-    let baseWorkerPoolModuleMetadata: NodeModule | undefined = undefined;
+    let targetModuleMetadata: NodeModule | undefined = undefined;
     for (const childModule of module.children) {
-      if (path.basename(childModule.filename || '').toUpperCase() === baseWorkerPoolFilename.toUpperCase()) {
-        if (baseWorkerPoolModuleMetadata) {
+      // Match by full path to avoid false positives (e.g. many modules named index.js)
+      if (childModule.filename === targetPath) {
+        if (targetModuleMetadata) {
           throw new Error('More than one child module matched while detecting Node.js module metadata');
         }
-        baseWorkerPoolModuleMetadata = childModule;
+        targetModuleMetadata = childModule;
       }
     }
 
-    if (!baseWorkerPoolModuleMetadata) {
-      throw new Error('Failed to detect the Node.js module metadata for BaseWorkerPool.js');
+    if (!targetModuleMetadata) {
+      throw new Error(`Failed to detect the Node.js module metadata for ${path.basename(targetPath)}`);
     }
 
     // Load the original file contents
-    const originalFileContent: string = FileSystem.readFile(baseWorkerPoolPath);
-
-    // Add boilerplate so that eval() will return the exports
-    let patchedCode: string =
-      '// PATCHED BY HEFT USING eval()\n\nexports = {}\n' +
-      originalFileContent +
-      '\n// return value:\nexports';
+    const originalFileContent: string = FileSystem.readFile(targetPath);
 
     // Apply the patch.  We will replace this:
     //
@@ -106,7 +110,7 @@ function applyPatch(): void {
     //
     //    const FORCE_EXIT_DELAY = 7000;
     let matched: boolean = false;
-    patchedCode = patchedCode.replace(
+    const patchedCode: string = originalFileContent.replace(
       /(const\s+FORCE_EXIT_DELAY\s*=\s*)(\d+)(\s*\;)/,
       (matchedString: string, leftPart: string, middlePart: string, rightPart: string): string => {
         matched = true;
@@ -115,24 +119,47 @@ function applyPatch(): void {
     );
 
     if (!matched) {
-      throw new Error('The expected pattern was not found in the file:\n' + baseWorkerPoolPath);
+      throw new Error('The expected pattern was not found in the file:\n' + targetPath);
     }
 
-    function evalInContext(): IBaseWorkerPoolModule {
-      // Remap the require() function for the eval() context
+    if (isBundled) {
+      // jest-worker 30.x: webpack bundle uses `module.exports = __webpack_exports__` at the top level.
+      // Shadow `module` with a shim so that assignment writes to our object, then copy the
+      // resulting exports over the already-cached module exports in-place.
+      function evalInContextBundled(): Record<string, unknown> {
+        // createRequire(targetPath) produces a proper require function with resolve/cache/etc.
+        // and the right module-resolution context (resolves relative to jest-worker's build dir).
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const require: NodeRequire = createRequire(targetPath);
+        // Shadow `module` so the bundle's `module.exports = ...` writes to our shim
+        const module: { exports: Record<string, unknown> } = { exports: {} };
+        // eslint-disable-next-line no-eval
+        eval(patchedCode);
+        return module.exports;
+      }
 
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars
-      function require(modulePath: string): void {
-        return baseWorkerPoolModuleMetadata!.require(modulePath);
+      const patchedExports: Record<string, unknown> = evalInContextBundled();
+      // Can't mutate the cached exports in-place (webpack defines them as read-only getters).
+      // Replace the exports object in the require cache entirely so future require() calls
+      // return the patched version.
+      require.cache[targetModuleMetadata.filename]!.exports = patchedExports;
+    } else {
+      // jest-worker < 30: BaseWorkerPool.js uses bare `exports`, wrap for eval return value
+      const wrappedCode: string =
+        '// PATCHED BY HEFT USING eval()\n\nexports = {}\n' + patchedCode + '\n// return value:\nexports';
+
+      function evalInContext(): IBaseWorkerPoolModule {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        function require(modulePath: string): void {
+          return targetModuleMetadata!.require(modulePath);
+        }
+        // eslint-disable-next-line no-eval
+        return eval(wrappedCode);
       }
 
-      // eslint-disable-next-line no-eval
-      return eval(patchedCode);
+      const patchedModule: IBaseWorkerPoolModule = evalInContext();
+      targetModule.default = patchedModule.default;
     }
-
-    const patchedModule: IBaseWorkerPoolModule = evalInContext();
-
-    baseWorkerPoolModule.default = patchedModule.default;
   } catch (e) {
     console.error();
     console.error(`ERROR: ${patchName} failed to patch the "jest-worker" package:`);

libraries/typings-generator/src/test/__snapshots__/StringValuesTypingsGenerator.test.ts.snap

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`StringValuesTypingsGenerator default exports overrides for individual files with exportAsDefault filled overriding with { exportAsDefault: false } should generate typings 1`] = `
 Object {