fix: adjusted assert.throws error format

fixes #13264
jestjs · Sep 26, 2022 · 96cbd79 · 96cbd79
1 parent 35e8b6a
commit 96cbd79
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 0 deletions.
diff --git a/e2e/failures/__tests__/assertionError.test.js b/e2e/failures/__tests__/assertionError.test.js
@@ -76,6 +76,23 @@ test('assert.throws', () => {
   assert.throws(() => {});
 });
 
+test('assert.throws with different error messages', () => {
+  assert.throws(
+    () => {
+      throw new Error('message 1');
+    },
+    {
+      message: 'message 2',
+    },
+  );
+});
+
+test('assert.throws with different error types', () => {
+  assert.throws(() => {
+    throw new SyntaxError('message 1');
+  }, TypeError);
+});
+
 test('async', async () => {
   assert.equal('hello\ngoodbye', 'hello', 'hmmm');
 });

diff --git a/packages/jest-circus/src/formatNodeAssertErrors.ts b/packages/jest-circus/src/formatNodeAssertErrors.ts
@@ -150,6 +150,15 @@ function assertionErrorMessage(
   }
 
   if (operatorName === 'throws') {
+    if (error.generatedMessage) {
+      // Thrown error do not match expected one
+      return (
+        buildHintString(assertThrowingMatcherHint(operatorName)) +
+        chalk.reset(error.message) +
+        chalk.reset(hasCustomMessage ? `\n\nMessage:\n  ${message}` : '') +
+        trimmedStack
+      );
+    }
     return (
       buildHintString(assertThrowingMatcherHint(operatorName)) +
       chalk.reset('Expected the function to throw an error.\n') +

diff --git a/packages/jest-jasmine2/src/assertionErrorMessage.ts b/packages/jest-jasmine2/src/assertionErrorMessage.ts
@@ -111,6 +111,14 @@ function assertionErrorMessage(
   }
 
   if (operatorName === 'throws') {
+    if (error.generatedMessage) {
+      return (
+        buildHintString(assertThrowingMatcherHint(operatorName)) +
+        chalk.reset(error.message) +
+        chalk.reset(hasCustomMessage ? `\n\nMessage:\n  ${message}` : '') +
+        trimmedStack
+      );
+    }
     return (
       buildHintString(assertThrowingMatcherHint(operatorName)) +
       chalk.reset('Expected the function to throw an error.\n') +