Add a module with utilities to work with node:test generated errors

Author: alcuadrado

v-next/hardhat-node-test-reporter/src/error-formatting.ts

@@ -4,24 +4,25 @@ import { inspect } from "node:util";
 import chalk from "chalk";
 import { diff } from "jest-diff";
 
+import {
+  cleanupTestFailError,
+  isCancelledByParentError,
+} from "./node-test-error-utils.js";
+
 // TODO: Clean up the node internal fames from the stack trace
 export function formatError(error: Error): string {
-  if ("code" in error && error.code === "ERR_TEST_FAILURE") {
-    if (error.cause instanceof Error) {
-      error = error.cause;
-    }
-
-    if ("failureType" in error && error.failureType === "cancelledByParent") {
-      return (
-        chalk.red("Test cancelled by parent error") +
-        "\n" +
-        chalk.gray(
-          "    This test was cancelled due to an error in its parent suite/it or test/it, or in one of its before/beforeEach",
-        )
-      );
-    }
+  if (isCancelledByParentError(error)) {
+    return (
+      chalk.red("Test cancelled by parent error") +
+      "\n" +
+      chalk.gray(
+        "    This test was cancelled due to an error in its parent suite/it or test/it, or in one of its before/beforeEach",
+      )
+    );
   }
 
+  error = cleanupTestFailError(error);
+
   const defaultFormat = inspect(error);
   const indexOfMessage = defaultFormat.indexOf(error.message);
 

v-next/hardhat-node-test-reporter/src/node-test-error-utils.ts

@@ -0,0 +1,41 @@
+/**
+ * Returns true if the error represents that a test/suite failed because one of
+ * its subtests failed.
+ */
+export function isSubtestFailedError(error: Error): boolean {
+  return (
+    "code" in error &&
+    "failureType" in error &&
+    error.code === "ERR_TEST_FAILURE" &&
+    error.failureType === "subtestsFailed"
+  );
+}
+
+/**
+ * Returns true if the error represents that a test was cancelled because its
+ * parent failed.
+ */
+export function isCancelledByParentError(error: Error): boolean {
+  return (
+    "code" in error &&
+    "failureType" in error &&
+    error.code === "ERR_TEST_FAILURE" &&
+    error.failureType === "cancelledByParent"
+  );
+}
+
+/**
+ * Cleans the test:fail event error, as it's usually wrapped by a node:test
+ * error.
+ */
+export function cleanupTestFailError(error: Error): Error {
+  if (
+    "code" in error &&
+    error.code === "ERR_TEST_FAILURE" &&
+    error.cause instanceof Error
+  ) {
+    return error.cause;
+  }
+
+  return error;
+}

v-next/hardhat-node-test-reporter/src/reporter.ts

@@ -11,6 +11,7 @@ import {
   formatSlowTestInfo,
   Failure,
 } from "./formatting.js";
+import { isSubtestFailedError } from "./node-test-error-utils.js";
 import {
   TestEventData,
   TestEventSource,
@@ -56,14 +57,7 @@ export default async function* customReporter(
           // If a suite failed for a reason other than a subtest failing, we
           // want to print its failure, so we push it to the failures array.
           if (event.type === "test:fail") {
-            if (
-              !(
-                "code" in event.data.details.error &&
-                "failureType" in event.data.details.error &&
-                event.data.details.error.code === "ERR_TEST_FAILURE" &&
-                event.data.details.error.failureType === "subtestsFailed"
-              )
-            ) {
+            if (!isSubtestFailedError(event.data.details.error)) {
               preFormattedFailureReasons.push(
                 formatFailureReason({
                   index: preFormattedFailureReasons.length,