fix(lib/test): stack traces when res.name is Error, not string

When executing tests, the res.name property (as constructed in the ./lib/test.js#_assert method) is actually not a string but the error that was thrown. This (assuming edge case) combined with extra.error and opts.error both being falsy ends up producing this situation where feeding res.name into the Error constructor makes the original error's stack trace disappear and only it's message remains with the newly constructed Error instance holding a completely generic stack trace that's internal to tape's source code (and therefore not much use when a test is failing due to some code is throwing exceptions instead of failing an assertion). Signed-off-by: Peter Somogyvari <peter.metz@unarin.com>
tape-testing · Oct 16, 2020 · c40ec63 · c40ec63
1 parent e142c29
commit c40ec63
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 4 deletions.
diff --git a/lib/test.js b/lib/test.js
@@ -257,7 +257,8 @@ Test.prototype._assert = function assert(ok, opts) {
     this._ok = !!(this._ok && ok);
 
     if (!ok && !res.todo) {
-        res.error = defined(extra.error, opts.error, new Error(res.name));
+        var anError = res.name instanceof Error ? res.name : new Error(res.name);
+        res.error = defined(extra.error, opts.error, anError);
     }
 
     if (!ok) {

diff --git a/test/async-await.js b/test/async-await.js
@@ -219,7 +219,8 @@ tap.test('async-error', function (t) {
             '  ---',
             '    operator: fail',
             '    stack: |-',
-            '      Error: Error: oopsie',
+            '      Error: oopsie',
+            '          at Test.myTest ($TEST/async-await/async-error.js:$LINE:$COL)',
             '          [... stack stripped ...]',
             '  ...',
             '',

diff --git a/test/promise_fail.js b/test/promise_fail.js
@@ -34,7 +34,10 @@ tap.test('callback returning rejected promise should cause that test (and only t
             '  ---',
             '    operator: fail',
             '    stack: |-',
-            '      Error: Error: rejection message',
+            '      Error: rejection message',
+            '          at $TEST/promises/fail.js:$LINE:$COL',
+            '          [... stack stripped ...]',
+            '          at Test.<anonymous> ($TEST/promises/fail.js:$LINE:$COL)',
             '          [... stack stripped ...]',
             '  ...',
             '# after',
@@ -78,7 +81,10 @@ tap.test('subtest callback returning rejected promise should cause that subtest
             '  ---',
             '    operator: fail',
             '    stack: |-',
-            '      Error: Error: rejection message',
+            '      Error: rejection message',
+            '          at $TEST/promises/subTests.js:$LINE:$COL',
+            '          [... stack stripped ...]',
+            '          at Test.<anonymous> ($TEST/promises/subTests.js:$LINE:$COL)',
             '          [... stack stripped ...]',
             '  ...',
             '# sub test that should pass',