test_runner: verbous error when entire test tree is canceled

MoLow · danielleadams · commit b45ad007a3f2 · 2022-08-11T05:50:49.000-04:00
PR-URL: #44060 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
diff --git a/lib/internal/test_runner/harness.js b/lib/internal/test_runner/harness.js
@@ -14,7 +14,7 @@ const {
   },
 } = require('internal/errors');
 const { getOptionValue } = require('internal/options');
-const { Test, ItTest, Suite } = require('internal/test_runner/test');
+const { kCancelledByParent, Test, ItTest, Suite } = require('internal/test_runner/test');
 
 const isTestRunner = getOptionValue('--test');
 const testResources = new SafeMap();
@@ -77,7 +77,9 @@ function setup(root) {
     createProcessEventHandler('unhandledRejection', root);
 
   const exitHandler = () => {
-    root.postRun();
+    root.postRun(new ERR_TEST_FAILURE(
+      'Promise resolution is still pending but the event loop has already resolved',
+      kCancelledByParent));
 
     let passCount = 0;
     let failCount = 0;
diff --git a/lib/internal/test_runner/test.js b/lib/internal/test_runner/test.js
@@ -511,7 +511,7 @@ class Test extends AsyncResource {
     this.postRun();
   }
 
-  postRun() {
+  postRun(pendingSubtestsError) {
     let failedSubtests = 0;
 
     // If the test was failed before it even started, then the end time will
@@ -528,8 +528,8 @@ class Test extends AsyncResource {
       const subtest = this.subtests[i];
 
       if (!subtest.finished) {
-        subtest.cancel();
-        subtest.postRun();
+        subtest.cancel(pendingSubtestsError);
+        subtest.postRun(pendingSubtestsError);
       }
 
       if (!subtest.passed) {
@@ -691,4 +691,4 @@ class Suite extends Test {
   }
 }
 
-module.exports = { kDefaultIndent, kSubtestsFailed, kTestCodeFailure, Test, Suite, ItTest };
+module.exports = { kCancelledByParent, kDefaultIndent, kSubtestsFailed, kTestCodeFailure, Test, Suite, ItTest };
diff --git a/test/message/test_runner_no_refs.out b/test/message/test_runner_no_refs.out
@@ -5,7 +5,7 @@ TAP version 13
       ---
       duration_ms: *
       failureType: 'cancelledByParent'
-      error: 'test did not finish before its parent and was cancelled'
+      error: 'Promise resolution is still pending but the event loop has already resolved'
       code: 'ERR_TEST_FAILURE'
       stack: |-
         *
@@ -15,7 +15,7 @@ not ok 1 - does not keep event loop alive
   ---
   duration_ms: *
   failureType: 'cancelledByParent'
-  error: 'test did not finish before its parent and was cancelled'
+  error: 'Promise resolution is still pending but the event loop has already resolved'
   code: 'ERR_TEST_FAILURE'
   stack: |-
     *
diff --git a/test/message/test_runner_unresolved_promise.out b/test/message/test_runner_unresolved_promise.out
@@ -9,7 +9,7 @@ not ok 2 - never resolving promise
   ---
   duration_ms: *
   failureType: 'cancelledByParent'
-  error: 'test did not finish before its parent and was cancelled'
+  error: 'Promise resolution is still pending but the event loop has already resolved'
   code: 'ERR_TEST_FAILURE'
   stack: |-
     *
@@ -19,7 +19,7 @@ not ok 3 - fail
   ---
   duration_ms: 0
   failureType: 'cancelledByParent'
-  error: 'test did not finish before its parent and was cancelled'
+  error: 'Promise resolution is still pending but the event loop has already resolved'
   code: 'ERR_TEST_FAILURE'
   stack: |-
     *

Original file line number	Diff line number	Diff line change
`@@ -511,7 +511,7 @@ class Test extends AsyncResource {`
`511`	`511`	`this.postRun();`
`512`	`512`	`}`
`513`	`513`
`514`		`- postRun() {`
	`514`	`+ postRun(pendingSubtestsError) {`
`515`	`515`	`let failedSubtests = 0;`
`516`	`516`
`517`	`517`	`// If the test was failed before it even started, then the end time will`
`@@ -528,8 +528,8 @@ class Test extends AsyncResource {`
`528`	`528`	`const subtest = this.subtests[i];`
`529`	`529`
`530`	`530`	`if (!subtest.finished) {`
`531`		`- subtest.cancel();`
`532`		`- subtest.postRun();`
	`531`	`+ subtest.cancel(pendingSubtestsError);`
	`532`	`+ subtest.postRun(pendingSubtestsError);`
`533`	`533`	`}`
`534`	`534`
`535`	`535`	`if (!subtest.passed) {`
`@@ -691,4 +691,4 @@ class Suite extends Test {`
`691`	`691`	`}`
`692`	`692`	`}`
`693`	`693`
`694`		`-module.exports = { kDefaultIndent, kSubtestsFailed, kTestCodeFailure, Test, Suite, ItTest };`
	`694`	`+module.exports = { kCancelledByParent, kDefaultIndent, kSubtestsFailed, kTestCodeFailure, Test, Suite, ItTest };`