Shorter output for reference errors (#15767)

Co-authored-by: Christoph Nakazawa <[email protected]>

Author: joshkel

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ### Features
 
+- `[jest-runtime]` Reduce redundant ReferenceError messages
 - `[jest-core]` Include test modules that failed to load when --onlyFailures is active
 
 ### Fixes

packages/jest-message-util/src/__tests__/__snapshots__/messages.test.ts.snap

@@ -75,8 +75,7 @@ exports[`formatStackTrace should properly handle string causes 1`] = `
 
     Cause:
     string cause
-<dim></intensity>
-<dim></intensity>
+
 "
 `;
 

packages/jest-message-util/src/index.ts

@@ -242,6 +242,10 @@ const removeInternalStackEntries = (
   let pathCounter = 0;
 
   return lines.filter(line => {
+    if (!line) {
+      return false;
+    }
+
     if (ANONYMOUS_FN_IGNORE.test(line)) {
       return false;
     }
@@ -368,17 +372,18 @@ export function formatStackTrace(
     }
   }
 
-  const stacktrace = lines
-    .filter(Boolean)
-    .map(
-      line =>
-        STACK_INDENT + formatPath(trimPaths(line), config, relativeTestPath),
-    )
-    .join('\n');
-
-  return renderedCallsite
-    ? `${renderedCallsite}\n${stacktrace}`
-    : `\n${stacktrace}`;
+  const stacktrace =
+    lines.length === 0
+      ? ''
+      : `\n${lines
+          .map(
+            line =>
+              STACK_INDENT +
+              formatPath(trimPaths(line), config, relativeTestPath),
+          )
+          .join('\n')}`;
+
+  return renderedCallsite + stacktrace;
 }
 
 type FailedResults = Array<{

packages/jest-reporters/src/__tests__/__snapshots__/GitHubActionsReporter.test.ts.snap

@@ -3,23 +3,23 @@
 exports[`annotations logs error annotation when a test has reference error 1`] = `
 Array [
   "
-::error file=/user/project/__tests__/example.test.js,line=25,title=example test::ReferenceError: abc is not defined%0A%0A    at Object.abc (__tests__/example.test.js:25:12)
+::error file=/user/project/__tests__/example.test.js,line=25,title=example test::ReferenceError: abc is not defined%0A    at Object.abc (__tests__/example.test.js:25:12)
 ",
 ]
 `;
 
 exports[`annotations logs error annotation when an expectation fails to pass 1`] = `
 Array [
   "
-::error file=/user/project/__tests__/example.test.js,line=20,title=example test::expect(received).toBe(expected) // Object.is equality%0A%0AExpected: 1%0AReceived: 10%0A%0A    at Object.toBe (__tests__/example.test.js:20:14)
+::error file=/user/project/__tests__/example.test.js,line=20,title=example test::expect(received).toBe(expected) // Object.is equality%0A%0AExpected: 1%0AReceived: 10%0A    at Object.toBe (__tests__/example.test.js:20:14)
 ",
 ]
 `;
 
 exports[`annotations logs error annotation when test is wrapped in describe block 1`] = `
 Array [
   "
-::error file=/user/project/__tests__/example.test.js,line=20,title=describe › example test::expect(received).toBe(expected) // Object.is equality%0A%0AExpected: 1%0AReceived: 10%0A%0A    at Object.toBe (__tests__/example.test.js:20:14)
+::error file=/user/project/__tests__/example.test.js,line=20,title=describe › example test::expect(received).toBe(expected) // Object.is equality%0A%0AExpected: 1%0AReceived: 10%0A    at Object.toBe (__tests__/example.test.js:20:14)
 ",
 ]
 `;
@@ -28,12 +28,12 @@ exports[`annotations logs warning annotation before logging errors when test res
 Array [
   Array [
     "
-::warning file=/user/project/__tests__/example.test.js,line=19,title=RETRY 1: example test::expect(received).toBeFalsy()%0A%0AReceived: true%0A%0A    at Object.toBeFalsy (__tests__/example.test.js:19:20)
+::warning file=/user/project/__tests__/example.test.js,line=19,title=RETRY 1: example test::expect(received).toBeFalsy()%0A%0AReceived: true%0A    at Object.toBeFalsy (__tests__/example.test.js:19:20)
 ",
   ],
   Array [
     "
-::error file=/user/project/__tests__/example.test.js,line=19,title=example test::expect(received).toBeFalsy()%0A%0AReceived: true%0A%0A    at Object.toBeFalsy (__tests__/example.test.js:19:20)
+::error file=/user/project/__tests__/example.test.js,line=19,title=example test::expect(received).toBeFalsy()%0A%0AReceived: true%0A    at Object.toBeFalsy (__tests__/example.test.js:19:20)
 ",
   ],
 ]

packages/jest-runtime/src/index.ts

@@ -213,6 +213,7 @@ export default class Runtime {
   private readonly cjsConditions: Array<string>;
   private isTornDown = false;
   private isInsideTestCode: boolean | undefined;
+  private readonly loggedReferenceErrors = new Set<string>();
 
   constructor(
     config: Config.ProjectConfig,
@@ -2462,11 +2463,14 @@ export default class Runtime {
 
     const {message, stack} = separateMessageFromStack(originalStack);
 
-    console.error(
-      `\n${message}\n${formatStackTrace(stack, this._config, {
-        noStackTrace: false,
-      })}`,
-    );
+    const stackTrace = formatStackTrace(stack, this._config, {
+      noStackTrace: false,
+    });
+    const formattedMessage = `\n${message}${stackTrace ? `\n${stackTrace}` : ''}`;
+    if (!this.loggedReferenceErrors.has(formattedMessage)) {
+      console.error(formattedMessage);
+      this.loggedReferenceErrors.add(formattedMessage);
+    }
   }
 
   private constructInjectedModuleParameters(): Array<string> {