fix: show AggregateError to display

Closes jestjs#14704
BondarenkoAlex · Oct 17, 2024 · d9d869a · d9d869a
1 parent 0a0a9f7
commit d9d869a
Show file tree

Hide file tree

Showing 5 changed files with 58 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -49,6 +49,7 @@
 
 ### Fixes
 
+- `[expect]` Show `AggregateError` to display ([#15346](https://github.com/facebook/jest/pull/15346))
 - `[babel-plugin-jest-hoist]` Use `denylist` instead of the deprecated `blacklist` for Babel 8 support ([#14109](https://github.com/jestjs/jest/pull/14109))
 - `[expect]` Check error instance type for `toThrow/toThrowError` ([#14576](https://github.com/jestjs/jest/pull/14576))
 - `[expect]` Improve diff for failing `expect.objectContaining` ([#15038](https://github.com/jestjs/jest/pull/15038))

diff --git a/package.json b/package.json
@@ -101,6 +101,7 @@
     "jest-jasmine-ci": "yarn jest-jasmine --color --config jest.config.ci.mjs",
     "jest-coverage": "yarn jest --coverage",
     "lint": "eslint . --cache --ext js,jsx,cjs,mjs,ts,tsx,md",
+    "lint:fix": "eslint ./packages/expect/src/toThrowMatchers.ts --cache --fix",
     "lint:prettier-script": "prettier . \"!**/*.{js,jsx,cjs,mjs,ts,tsx}\" --cache",
     "lint:prettier": "yarn lint:prettier-script --write",
     "lint:prettier:ci": "yarn lint:prettier-script --check",

diff --git a/packages/expect/src/__tests__/toThrowMatchers.test.ts b/packages/expect/src/__tests__/toThrowMatchers.test.ts
@@ -332,6 +332,36 @@ describe('toThrow', () => {
     });
   });
 
+  describe('aggregate-errors', () => {
+    const fetchFromApi1 = Promise.reject(new Error('API 1 failed'));
+    const fetchFromApi2 = Promise.reject(new Error('API 2 failed'));
+    const promiseAny = Promise.any([fetchFromApi1, fetchFromApi2]);
+
+    test('string', () => {
+      jestExpect(promiseAny).rejects.toThrow('All promises were rejected');
+    });
+
+    test('undefined', () => {
+      jestExpect(promiseAny).rejects.toThrow();
+    });
+
+    test('asymmetricMatch', () => {
+      jestExpect(promiseAny).rejects.toThrow(
+        expect.objectContaining({
+          message: 'All promises were rejected',
+        }),
+      );
+    });
+
+    test('regexp', () => {
+      jestExpect(promiseAny).rejects.toThrow(/All promises were rejected/);
+    });
+
+    test('class', () => {
+      jestExpect(promiseAny).rejects.toThrow(AggregateError);
+    });
+  });
+
   describe('asymmetric', () => {
     describe('any-Class', () => {
       describe('pass', () => {

diff --git a/packages/expect/src/__tests__/tsconfig.json b/packages/expect/src/__tests__/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "extends": "../../../../tsconfig.test.json",
   "compilerOptions": {
-    "lib": ["es2022.error"],
+    "lib": ["es2022.error", "es2021.promise"],
     "types": ["node", "@jest/test-globals"]
   },
   "include": ["./**/*"],

diff --git a/packages/expect/src/toThrowMatchers.ts b/packages/expect/src/toThrowMatchers.ts
@@ -20,7 +20,11 @@ import {
   printReceived,
   printWithType,
 } from 'jest-matcher-utils';
-import {formatStackTrace, separateMessageFromStack} from 'jest-message-util';
+import {
+  formatExecError,
+  formatStackTrace,
+  separateMessageFromStack,
+} from 'jest-message-util';
 import {
   printExpectedConstructorName,
   printExpectedConstructorNameNot,
@@ -453,19 +457,28 @@ const formatReceived = (
   return '';
 };
 
-const formatStack = (thrown: Thrown | null) =>
-  thrown === null || !thrown.isError
-    ? ''
-    : formatStackTrace(
+const formatStack = (thrown: Thrown | null) => {
+  if (thrown === null || !thrown.isError) {
+    return '';
+  } else {
+    const config = {
+      rootDir: process.cwd(),
+      testMatch: [],
+    };
+    const options = {
+      noStackTrace: false,
+    };
+    if (thrown.value instanceof AggregateError) {
+      return formatExecError(thrown.value, config, options);
+    } else {
+      return formatStackTrace(
         separateMessageFromStack(thrown.value.stack!).stack,
-        {
-          rootDir: process.cwd(),
-          testMatch: [],
-        },
-        {
-          noStackTrace: false,
-        },
+        config,
+        options,
       );
+    }
+  }
+};
 
 function createMessageAndCauseMessage(error: Error): string {
   if (error.cause instanceof Error) {