Merge remote-tracking branch 'origin/jest-on-mock-hook' into jest-on-…

…mock-hook

CHANGELOG.md

@@ -86,6 +86,7 @@
   - [**BREAKING**] `--testPathPattern` is now `--testPathPatterns`
   - [**BREAKING**] Specifying `testPathPatterns` when programmatically calling `watch` must be specified as `new TestPathPatterns(patterns)`, where `TestPathPatterns` can be imported from `@jest/pattern`
 - `[jest-reporters, jest-runner]` Unhandled errors without stack get correctly logged to console ([#14619](https://github.com/jestjs/jest/pull/14619))
+- `[jest-util]` Always load `mjs` files with `import` ([#15447](https://github.com/jestjs/jest/pull/15447))
 - `[jest-worker]` Properly handle a circular reference error when worker tries to send an assertion fails where either the expected or actual value is circular ([#15191](https://github.com/jestjs/jest/pull/15191))
 - `[jest-worker]` Properly handle a BigInt when worker tries to send an assertion fails where either the expected or actual value is BigInt ([#15191](https://github.com/jestjs/jest/pull/15191))
 
@@ -122,6 +123,7 @@
 - `[docs]` Link NestJS documentation on testing with Jest ([#14940](https://github.com/jestjs/jest/pull/14940))
 - `[docs]` `Revised documentation for .toHaveBeenCalled()` to accurately depict its functionality. ([#14853](https://github.com/jestjs/jest/pull/14853))
 - `[docs]` Removed ExpressJS reference link from documentation due to dead link ([#15270](https://github.com/jestjs/jest/pull/15270))
+- `[docs]` Removed `Running AngularJS Tests with Jest reference` link from documentation due to dead link ([#15270](https://github.com/jestjs/jest/pull/15311))
 
 ## 29.7.0
 

docs/GlobalAPI.md

@@ -251,7 +251,7 @@ Use `describe.each` if you keep duplicating the same test suites with different
     - `%$` - Number of the test case.
     - `%%` - single percent sign ('%'). This does not consume an argument.
   - Or generate unique test titles by injecting properties of test case object with `$variable`
-    - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value` (only works for ["own" properites](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty), e.g. `$variable.constructor.name` wouldn't work)
+    - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value` (only works for ["own" properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty), e.g. `$variable.constructor.name` wouldn't work)
     - You can use `$#` to inject the index of the test case
     - You cannot use `$variable` with the `printf` formatting except for `%%`
 - `fn`: `Function` the suite of tests to be run, this is the function that will receive the parameters in each row as function arguments.
@@ -305,7 +305,7 @@ describe.each([
   - First row of variable name column headings separated with `|`
   - One or more subsequent rows of data supplied as template literal expressions using `${value}` syntax.
 - `name`: `String` the title of the test suite, use `$variable` to inject test data into the suite title from the tagged template expressions, and `$#` for the index of the row.
-  - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value` (only works for ["own" properites](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty), e.g. `$variable.constructor.name` wouldn't work)
+  - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value` (only works for ["own" properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty), e.g. `$variable.constructor.name` wouldn't work)
 - `fn`: `Function` the suite of tests to be run, this is the function that will receive the test data object.
 - Optionally, you can provide a `timeout` (in milliseconds) for specifying how long to wait for each row before aborting. The default timeout is 5 seconds.
 
@@ -574,7 +574,7 @@ test.concurrent.each([
   - First row of variable name column headings separated with `|`
   - One or more subsequent rows of data supplied as template literal expressions using `${value}` syntax.
 - `name`: `String` the title of the test, use `$variable` to inject test data into the test title from the tagged template expressions.
-  - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value` (only works for ["own" properites](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty), e.g. `$variable.constructor.name` wouldn't work)
+  - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value` (only works for ["own" properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty), e.g. `$variable.constructor.name` wouldn't work)
 - `fn`: `Function` the test to be run, this is the function that will receive the test data object, **this will have to be an asynchronous function**.
 - Optionally, you can provide a `timeout` (in milliseconds) for specifying how long to wait for each row before aborting. The default timeout is 5 seconds.
 
@@ -697,7 +697,7 @@ Use `test.each` if you keep duplicating the same test with different data. `test
     - `%$` - Number of the test case.
     - `%%` - single percent sign ('%'). This does not consume an argument.
   - Or generate unique test titles by injecting properties of test case object with `$variable`
-    - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value` (only works for ["own" properites](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty), e.g. `$variable.constructor.name` wouldn't work)
+    - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value` (only works for ["own" properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty), e.g. `$variable.constructor.name` wouldn't work)
     - You can use `$#` to inject the index of the test case
     - You cannot use `$variable` with the `printf` formatting except for `%%`
 - `fn`: `Function` the test to be run, this is the function that will receive the parameters in each row as function arguments.
@@ -731,7 +731,7 @@ test.each([
   - First row of variable name column headings separated with `|`
   - One or more subsequent rows of data supplied as template literal expressions using `${value}` syntax.
 - `name`: `String` the title of the test, use `$variable` to inject test data into the test title from the tagged template expressions.
-  - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value` (only works for ["own" properites](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty), e.g. `$variable.constructor.name` wouldn't work)
+  - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value` (only works for ["own" properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty), e.g. `$variable.constructor.name` wouldn't work)
 - `fn`: `Function` the test to be run, this is the function that will receive the test data object.
 - Optionally, you can provide a `timeout` (in milliseconds) for specifying how long to wait for each row before aborting. The default timeout is 5 seconds.
 

docs/TestingFrameworks.md

@@ -17,7 +17,6 @@ Jest is a universal testing platform, with the ability to adapt to any JavaScrip
 ## AngularJS
 
 - [Testing an AngularJS app with Jest](https://medium.com/aya-experience/testing-an-angularjs-app-with-jest-3029a613251) by Matthieu Lux ([@Swiip](https://twitter.com/Swiip))
-- [Running AngularJS Tests with Jest](https://engineering.talentpair.com/running-angularjs-tests-with-jest-49d0cc9c6d26) by Ben Brandt ([@benjaminbrandt](https://twitter.com/benjaminbrandt))
 - [AngularJS Unit Tests with Jest Actions (Traditional Chinese)](https://dwatow.github.io/2019/08-14-angularjs/angular-jest/?fbclid=IwAR2SrqYg_o6uvCQ79FdNPeOxs86dUqB6pPKgd9BgnHt1kuIDRyRM-ch11xg) by Chris Wang ([@dwatow](https://github.com/dwatow))
 
 ## Angular

e2e/esm-config/js/jest.config.js

@@ -5,7 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+const displayName = await Promise.resolve('Config from js file');
+
 export default {
-  displayName: 'Config from js file',
+  displayName,
   testEnvironment: 'node',
 };

e2e/esm-config/mjs/jest.config.mjs

@@ -5,7 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+const displayName = await Promise.resolve('Config from mjs file');
+
 export default {
-  displayName: 'Config from mjs file',
+  displayName,
   testEnvironment: 'node',
 };

e2e/native-esm/yarn.lock

@@ -341,13 +341,13 @@ __metadata:
   linkType: hard
 
 "cross-spawn@npm:^7.0.0":
-  version: 7.0.3
-  resolution: "cross-spawn@npm:7.0.3"
+  version: 7.0.6
+  resolution: "cross-spawn@npm:7.0.6"
   dependencies:
     path-key: ^3.1.0
     shebang-command: ^2.0.0
     which: ^2.0.1
-  checksum: 671cc7c7288c3a8406f3c69a3ae2fc85555c04169e9d611def9a675635472614f1c0ed0ef80955d5b6d4e724f6ced67f0ad1bb006c2ea643488fcfef994d7f52
+  checksum: 8d306efacaf6f3f60e0224c287664093fa9185680b2d195852ba9a863f85d02dcc737094c6e512175f8ee0161f9b87c73c6826034c2422e39de7d6569cf4503b
   languageName: node
   linkType: hard
 

package.json

@@ -78,7 +78,7 @@
     "strip-json-comments": "^3.1.1",
     "tempy": "^1.0.0",
     "ts-node": "^10.5.0",
-    "tstyche": "^2.0.0",
+    "tstyche": "^3.0.0",
     "typescript": "^5.0.4",
     "webpack": "^5.68.0",
     "webpack-node-externals": "^3.0.0",

packages/diff-sequences/package.json

@@ -32,7 +32,7 @@
   "devDependencies": {
     "@fast-check/jest": "^2.0.0",
     "benchmark": "^2.1.4",
-    "diff": "^5.0.0"
+    "diff": "^7.0.0"
   },
   "publishConfig": {
     "access": "public"

packages/jest-config/package.json

@@ -64,7 +64,7 @@
     "@types/graceful-fs": "^4.1.3",
     "@types/micromatch": "^4.0.7",
     "@types/parse-json": "^4.0.0",
-    "esbuild": "^0.23.0",
+    "esbuild": "^0.24.0",
     "esbuild-register": "^3.4.0",
     "semver": "^7.5.3",
     "ts-node": "^10.5.0",

packages/jest-config/src/__tests__/normalize.test.ts

@@ -26,6 +26,23 @@ jest
       ...realFs,
       statSync: () => ({isDirectory: () => true}),
     };
+  })
+  .mock('jest-util', () => {
+    const realUtil =
+      jest.requireActual<typeof import('jest-util')>('jest-util');
+
+    return {
+      ...realUtil,
+      requireOrImportModule: (filePath: string, interop = true) => {
+        const result = require(filePath);
+
+        if (interop) {
+          return realUtil.interopRequireDefault(result).default;
+        }
+
+        return result;
+      },
+    };
   });
 
 let root: string;

packages/jest-each/README.md

@@ -122,7 +122,7 @@ const each = require('jest-each').default;
     - `%$` - Number of the test case.
     - `%%` - single percent sign ('%'). This does not consume an argument.
   - Or generate unique test titles by injecting properties of test case object with `$variable`
-    - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value` (only works for ["own" properites](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty), e.g. `$variable.constructor.name` wouldn't work)
+    - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value` (only works for ["own" properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty), e.g. `$variable.constructor.name` wouldn't work)
     - You can use `$#` to inject the index of the test case
     - You cannot use `$variable` with the `printf` formatting except for `%%`
 - testFn: `Function` the test logic, this is the function that will receive the parameters of each row as function arguments
@@ -149,7 +149,7 @@ const each = require('jest-each').default;
     - `%$` - Number of the test case.
     - `%%` - single percent sign ('%'). This does not consume an argument.
   - Or generate unique test titles by injecting properties of test case object with `$variable`
-    - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value` (only works for ["own" properites](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty), e.g. `$variable.constructor.name` wouldn't work)
+    - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value` (only works for ["own" properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty), e.g. `$variable.constructor.name` wouldn't work)
     - You can use `$#` to inject the index of the test case
     - You cannot use `$variable` with the `printf` formatting except for `%%`
 - suiteFn: `Function` the suite of `test`/`it`s to be ran, this is the function that will receive the parameters in each row as function arguments
@@ -381,7 +381,7 @@ each`
 ##### `.test`:
 
 - name: `String` the title of the `test`, use `$variable` in the name string to inject test values into the test title from the tagged template expressions
-  - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value` (only works for ["own" properites](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty), e.g. `$variable.constructor.name` wouldn't work)
+  - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value` (only works for ["own" properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty), e.g. `$variable.constructor.name` wouldn't work)
   - You can use `$#` to inject the index of the table row.
 - testFn: `Function` the test logic, this is the function that will receive the parameters of each row as function arguments
 
@@ -418,7 +418,7 @@ each`
 ##### `.describe`:
 
 - name: `String` the title of the `test`, use `$variable` in the name string to inject test values into the test title from the tagged template expressions
-  - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value` (only works for ["own" properites](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty), e.g. `$variable.constructor.name` wouldn't work)
+  - To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value` (only works for ["own" properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwnProperty), e.g. `$variable.constructor.name` wouldn't work)
 - suiteFn: `Function` the suite of `test`/`it`s to be ran, this is the function that will receive the parameters in each row as function arguments
 
 ### Usage

packages/jest-environment/src/index.ts

@@ -207,6 +207,18 @@ export interface Jest {
     moduleFactory?: () => T,
     options?: {virtual?: boolean},
   ): Jest;
+  /**
+   * Registers a callback function that is invoked whenever a mock is generated for a module.
+   * This callback is passed the module name and the newly created mock object, and must return
+   * the (potentially modified) mock object.
+   *
+   * If multiple callbacks are registered, they will be called in the order they were added.
+   * Each callback receives the result of the previous callback as the `moduleMock` parameter,
+   * making it possible to apply sequential transformations.
+   *
+   * @param cb
+   */
+  onGenerateMock<T>(cb: (moduleName: string, moduleMock: T) => T): Jest;
   /**
    * Mocks a module with the provided module factory when it is being imported.
    */

packages/jest-expect/__typetests__/jest-expect.test.ts

@@ -29,9 +29,9 @@ describe('JestExpect', () => {
   });
 
   test('is superset of `Expect`', () => {
-    expect<typeof jestExpect>().type.toMatch<typeof _expect>();
+    expect(jestExpect).type.toBeAssignableTo(_expect);
 
-    expect<typeof _expect>().type.not.toMatch<typeof jestExpect>();
+    expect(_expect).type.not.toBeAssignableTo(jestExpect);
   });
 
   test('allows type inference of the `actual` argument', () => {

packages/jest-mock/__typetests__/mock-functions.test.ts

@@ -87,7 +87,7 @@ describe('jest.fn()', () => {
 
   test('models typings of mocked function', () => {
     // eslint-disable-next-line @typescript-eslint/ban-types
-    expect(fn()).type.toMatch<Function>();
+    expect(fn()).type.toBeAssignableTo<Function>();
 
     expect(fn()).type.toBe<Mock<(...args: Array<unknown>) => unknown>>();
     expect(fn(() => {})).type.toBe<Mock<() => void>>();
@@ -424,7 +424,7 @@ describe('jest.spyOn()', () => {
 
   test('models typings of spied object', () => {
     // eslint-disable-next-line @typescript-eslint/ban-types
-    expect(spy).type.not.toMatch<Function>();
+    expect(spy).type.not.toBeAssignableTo<Function>();
 
     expect(spy()).type.toRaiseError();
     expect(new spy()).type.toRaiseError();

packages/jest-util/src/requireOrImportModule.ts

@@ -9,6 +9,39 @@ import {isAbsolute} from 'path';
 import {pathToFileURL} from 'url';
 import interopRequireDefault from './interopRequireDefault';
 
+async function importModule(
+  filePath: string,
+  applyInteropRequireDefault: boolean,
+) {
+  try {
+    const moduleUrl = pathToFileURL(filePath);
+
+    // node `import()` supports URL, but TypeScript doesn't know that
+    const importedModule = await import(
+      /* webpackIgnore: true */ moduleUrl.href
+    );
+
+    if (!applyInteropRequireDefault) {
+      return importedModule;
+    }
+
+    if (!importedModule.default) {
+      throw new Error(
+        `Jest: Failed to load ESM at ${filePath} - did you use a default export?`,
+      );
+    }
+
+    return importedModule.default;
+  } catch (error: any) {
+    if (error.message === 'Not supported') {
+      throw new Error(
+        `Jest: Your version of Node does not support dynamic import - please enable it or use a .cjs file extension for file ${filePath}`,
+      );
+    }
+    throw error;
+  }
+}
+
 export default async function requireOrImportModule<T>(
   filePath: string,
   applyInteropRequireDefault = true,
@@ -19,40 +52,21 @@ export default async function requireOrImportModule<T>(
     );
   }
   try {
+    if (filePath.endsWith('.mjs')) {
+      return importModule(filePath, applyInteropRequireDefault);
+    }
+
     const requiredModule = require(filePath);
     if (!applyInteropRequireDefault) {
       return requiredModule;
     }
     return interopRequireDefault(requiredModule).default;
   } catch (error: any) {
-    if (error.code === 'ERR_REQUIRE_ESM') {
-      try {
-        const moduleUrl = pathToFileURL(filePath);
-
-        // node `import()` supports URL, but TypeScript doesn't know that
-        const importedModule = await import(
-          /* webpackIgnore: true */ moduleUrl.href
-        );
-
-        if (!applyInteropRequireDefault) {
-          return importedModule;
-        }
-
-        if (!importedModule.default) {
-          throw new Error(
-            `Jest: Failed to load ESM at ${filePath} - did you use a default export?`,
-          );
-        }
-
-        return importedModule.default;
-      } catch (innerError: any) {
-        if (innerError.message === 'Not supported') {
-          throw new Error(
-            `Jest: Your version of Node does not support dynamic import - please enable it or use a .cjs file extension for file ${filePath}`,
-          );
-        }
-        throw innerError;
-      }
+    if (
+      error.code === 'ERR_REQUIRE_ESM' ||
+      error.code === 'ERR_REQUIRE_ASYNC_MODULE'
+    ) {
+      return importModule(filePath, applyInteropRequireDefault);
     } else {
       throw error;
     }

tstyche.config.json

@@ -1,3 +1,4 @@
 {
-  "testFileMatch": ["packages/*/__typetests__/*.test.ts"]
+  "$schema": "https://tstyche.org/schemas/config.json",
+  "testFileMatch": ["packages/*/__typetests__/**/*.test.ts"]
 }