Prefix subcase recorder error stacks with the subcase name (#2086)

The deferred nature of subcases makes it hard to tell which failures
came from which subcases. Prefix all error messages from subcases with
their subcase name.

Author: austinEng

src/common/internal/test_group.ts

@@ -525,13 +525,21 @@ class RunCaseSpecific implements RunCase {
             // Make a recorder that will defer all calls until `allPreviousSubcasesFinalizedPromise`
             // resolves. Waiting on `allPreviousSubcasesFinalizedPromise` ensures that
             // logs from all the previous subcases have been flushed before flushing new logs.
+            const subcasePrefix = 'subcase: ' + stringifyPublicParams(subParams);
             const subRec = new Proxy(rec, {
               get: (target, k: keyof TestCaseRecorder) => {
                 const prop = TestCaseRecorder.prototype[k];
                 if (typeof prop === 'function') {
                   testHeartbeatCallback();
                   return function (...args: Parameters<typeof prop>) {
                     void allPreviousSubcasesFinalizedPromise.then(() => {
+                      // Prepend the subcase name to all error messages.
+                      for (const arg of args) {
+                        if (arg instanceof Error) {
+                          arg.message = subcasePrefix + '\n' + arg.message;
+                        }
+                      }
+
                       // eslint-disable-next-line @typescript-eslint/no-explicit-any
                       const rv = (prop as any).apply(target, args);
                       // Because this proxy executes functions in a deferred manner,
@@ -544,8 +552,6 @@ class RunCaseSpecific implements RunCase {
               },
             });
 
-            subRec.info(new Error('subcase: ' + stringifyPublicParams(subParams)));
-
             const params = mergeParams(this.params, subParams);
             const subcaseQuery = new TestQuerySingleCase(
               selfQuery.suite,
@@ -573,6 +579,9 @@ class RunCaseSpecific implements RunCase {
               /* throwSkip */ true,
               getExpectedStatus(subcaseQuery)
             )
+              .then(() => {
+                subRec.info(new Error('OK'));
+              })
               .catch(ex => {
                 if (ex instanceof SkipTestCase) {
                   // Convert SkipTestCase to info messages