fix: harden error handling in lib/cli/run.js (#5074)

stalet · voxpelli · web-flow · commit 97dcbb282251 · 2024-03-26T13:12:42.000-04:00
* Bugfix: Output stacktrace to support typescript errors.

Before this patch the errorhandling would fail with the error: "ERROR: null". Debug showed that the error "caught error sometime before command handler: TypeError: Cannot convert object to primitive value"

* Update lib/cli/run.js

Co-authored-by: Pelle Wessman &lt;pelle@kodfabrik.se&gt;

* Fix minor typo.

* Update lib/cli/run.js

Do not change the original functionality.

Co-authored-by: Pelle Wessman &lt;pelle@kodfabrik.se&gt;

* Check that the toString method is available on the error.

* Opting for a simplified solution

* Fix tests

---------

Co-authored-by: Pelle Wessman &lt;pelle@kodfabrik.se&gt;
diff --git a/lib/cli/run.js b/lib/cli/run.js
@@ -369,7 +369,7 @@ exports.handler = async function (argv) {
   try {
     await runMocha(mocha, argv);
   } catch (err) {
-    console.error('\n' + (err.stack || `Error: ${err.message || err}`));
+    console.error('\n Exception during run:', err);
     process.exit(1);
   }
 };
diff --git a/test/integration/reporters.spec.js b/test/integration/reporters.spec.js
@@ -211,7 +211,7 @@ describe('reporters', function () {
             return;
           }
 
-          var pattern = `^Error: invalid or unsupported TAP version: "${invalidTapVersion}"`;
+          var pattern = `Error: invalid or unsupported TAP version: "${invalidTapVersion}"`;
           expect(res, 'to satisfy', {
             code: 1,
             output: new RegExp(pattern, 'm')

Original file line number	Diff line number	Diff line change
`@@ -369,7 +369,7 @@ exports.handler = async function (argv) {`
`369`	`369`	`try {`
`370`	`370`	`await runMocha(mocha, argv);`
`371`	`371`	`} catch (err) {`
`372`		- console.error('\n' + (err.stack \|\| `Error: ${err.message \|\| err}`));
	`372`	`+ console.error('\n Exception during run:', err);`
`373`	`373`	`process.exit(1);`
`374`	`374`	`}`
`375`	`375`	`};`
Original file line number	Diff line number	Diff line change
`@@ -211,7 +211,7 @@ describe('reporters', function () {`
`211`	`211`	`return;`
`212`	`212`	`}`
`213`	`213`
`214`		- var pattern = `^Error: invalid or unsupported TAP version: "${invalidTapVersion}"`;
	`214`	+ var pattern = `Error: invalid or unsupported TAP version: "${invalidTapVersion}"`;
`215`	`215`	`expect(res, 'to satisfy', {`
`216`	`216`	`code: 1,`
`217`	`217`	`output: new RegExp(pattern, 'm')`