assert: add default operator to assert.fail()

This makes sure `assert.fail()` contains an operator instead of being undefined. On top of that it also fixes the `err.generatedMessage` property. Before, it was not always set correct. PR-URL: #22694 Reviewed-By: John-David Dalton <john.david.dalton@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
nodejs · Sep 19, 2018 · 5cb642e · 5cb642e
1 parent dfef9a9
commit 5cb642e
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 12 deletions.
diff --git a/lib/assert.js b/lib/assert.js
@@ -86,8 +86,9 @@ function innerFail(obj) {
 function fail(actual, expected, message, operator, stackStartFn) {
   const argsLen = arguments.length;
 
+  let internalMessage;
   if (argsLen === 0) {
-    message = 'Failed';
+    internalMessage = 'Failed';
   } else if (argsLen === 1) {
     message = actual;
     actual = undefined;
@@ -105,13 +106,23 @@ function fail(actual, expected, message, operator, stackStartFn) {
       operator = '!=';
   }
 
-  innerFail({
+  if (message instanceof Error) throw message;
+
+  const errArgs = {
     actual,
     expected,
-    message,
-    operator,
+    operator: operator === undefined ? 'fail' : operator,
     stackStartFn: stackStartFn || fail
-  });
+  };
+  if (message !== undefined) {
+    errArgs.message = message;
+  }
+  const err = new AssertionError(errArgs);
+  if (internalMessage) {
+    err.message = internalMessage;
+    err.generatedMessage = true;
+  }
+  throw err;
 }
 
 assert.fail = fail;

diff --git a/test/parallel/test-assert-fail-deprecation.js b/test/parallel/test-assert-fail-deprecation.js
@@ -19,7 +19,8 @@ assert.throws(() => {
   message: '\'first\' != \'second\'',
   operator: '!=',
   actual: 'first',
-  expected: 'second'
+  expected: 'second',
+  generatedMessage: true
 });
 
 // Three args
@@ -29,9 +30,10 @@ assert.throws(() => {
   code: 'ERR_ASSERTION',
   name: 'AssertionError [ERR_ASSERTION]',
   message: 'another custom message',
-  operator: undefined,
+  operator: 'fail',
   actual: 'ignored',
-  expected: 'ignored'
+  expected: 'ignored',
+  generatedMessage: false
 });
 
 // Three args with custom Error

diff --git a/test/parallel/test-assert-fail.js b/test/parallel/test-assert-fail.js
@@ -10,9 +10,10 @@ assert.throws(
     code: 'ERR_ASSERTION',
     name: 'AssertionError [ERR_ASSERTION]',
     message: 'Failed',
-    operator: undefined,
+    operator: 'fail',
     actual: undefined,
-    expected: undefined
+    expected: undefined,
+    generatedMessage: true
   }
 );
 
@@ -23,9 +24,10 @@ assert.throws(() => {
   code: 'ERR_ASSERTION',
   name: 'AssertionError [ERR_ASSERTION]',
   message: 'custom message',
-  operator: undefined,
+  operator: 'fail',
   actual: undefined,
-  expected: undefined
+  expected: undefined,
+  generatedMessage: false
 });
 
 // One arg = Error