refactor(@jest/reporters): improve annotation formatting of GitHubActionsReporter

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ### Features
 
+- `[@jest/reporters]` Improve `GitHubActionsReporter`s annotation format ([#12826](https://github.com/facebook/jest/pull/12826))
+
 ### Fixes
 
 ### Chore & Maintenance
@@ -12,7 +14,7 @@
 
 ### Features
 
-- `[jest-circus]` Add `failing` test modifier that inverts the behaviour of tests ([#12610](https://github.com/facebook/jest/pull/12610))
+- `[jest-circus]` Add `failing` test modifier that inverts the behavior of tests ([#12610](https://github.com/facebook/jest/pull/12610))
 - `[jest-environment-node, jest-environment-jsdom]` Allow specifying `customExportConditions` ([#12774](https://github.com/facebook/jest/pull/12774))
 
 ### Fixes

packages/jest-reporters/package.json

@@ -29,6 +29,7 @@
     "istanbul-lib-report": "^3.0.0",
     "istanbul-lib-source-maps": "^4.0.0",
     "istanbul-reports": "^3.1.3",
+    "jest-message-util": "^28.1.0",
     "jest-util": "^28.1.0",
     "jest-worker": "^28.1.0",
     "slash": "^3.0.0",

packages/jest-reporters/src/GitHubActionsReporter.ts

@@ -5,55 +5,50 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+import {relative} from 'path';
+import slash = require('slash');
 import stripAnsi = require('strip-ansi');
-import type {
-  AggregatedResult,
-  TestContext,
-  TestResult,
-} from '@jest/test-result';
+import type {Test, TestCaseResult} from '@jest/test-result';
+import {
+  getStackTraceLines,
+  getTopFrame,
+  separateMessageFromStack,
+} from 'jest-message-util';
 import BaseReporter from './BaseReporter';
 
-const lineAndColumnInStackTrace = /^.*?:([0-9]+):([0-9]+).*$/;
-
-function replaceEntities(s: string): string {
-  // https://github.com/actions/toolkit/blob/b4639928698a6bfe1c4bdae4b2bfdad1cb75016d/packages/core/src/command.ts#L80-L85
-  const substitutions: Array<[RegExp, string]> = [
-    [/%/g, '%25'],
-    [/\r/g, '%0D'],
-    [/\n/g, '%0A'],
-  ];
-  return substitutions.reduce((acc, sub) => acc.replace(...sub), s);
-}
+const errorTitleSeparator = ' \u203A ';
 
 export default class GitHubActionsReporter extends BaseReporter {
   static readonly filename = __filename;
 
-  override onRunComplete(
-    _testContexts?: Set<TestContext>,
-    aggregatedResults?: AggregatedResult,
+  override onTestCaseResult(
+    test: Test,
+    {failureMessages, ancestorTitles, title}: TestCaseResult,
   ): void {
-    const messages = getMessages(aggregatedResults?.testResults);
-
-    for (const message of messages) {
-      this.log(message);
-    }
+    failureMessages.forEach(failure => {
+      const {message, stack} = separateMessageFromStack(stripAnsi(failure));
+
+      const relativeTestPath = slash(relative('', test.path));
+      const stackLines = getStackTraceLines(stack);
+      const normalizedStackLines = stackLines.map(line =>
+        line.replace(test.path, relativeTestPath),
+      );
+
+      const topFrame = getTopFrame(stackLines);
+
+      const errorTitle = [...ancestorTitles, title].join(errorTitleSeparator);
+      const errorMessage = normalizeMessage(
+        [message, ...normalizedStackLines].join('\n'),
+      );
+
+      this.log(
+        `\n::error file=${test.path},line=${topFrame?.line},title=${errorTitle}::${errorMessage}`,
+      );
+    });
   }
 }
 
-function getMessages(results: Array<TestResult> | undefined) {
-  if (!results) return [];
-
-  return results.flatMap(({testFilePath, testResults}) =>
-    testResults
-      .filter(r => r.status === 'failed')
-      .flatMap(r => r.failureMessages)
-      .map(m => stripAnsi(m))
-      .map(m => replaceEntities(m))
-      .map(m => lineAndColumnInStackTrace.exec(m))
-      .filter((m): m is RegExpExecArray => m !== null)
-      .map(
-        ([message, line, col]) =>
-          `\n::error file=${testFilePath},line=${line},col=${col}::${message}`,
-      ),
-  );
+// copied from: https://github.com/actions/toolkit/blob/main/packages/core/src/command.ts
+function normalizeMessage(input: string): string {
+  return input.replace(/%/g, '%25').replace(/\r/g, '%0D').replace(/\n/g, '%0A');
 }

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

@@ -0,0 +1,103 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import type {Test, TestCaseResult} from '@jest/test-result';
+import GitHubActionsReporter from '../GitHubActionsReporter';
+
+jest.mock('path', () => ({
+  relative: () => '__tests__/example.test.js',
+}));
+
+jest.spyOn(process.stderr, 'write').mockImplementation(jest.fn());
+
+afterEach(() => {
+  jest.clearAllMocks();
+});
+
+const reporter = new GitHubActionsReporter();
+
+const testMeta = {
+  context: {config: {rootDir: '/user/project'}},
+  path: '/user/project/__tests__/example.test.js',
+} as Test;
+
+const expectationsErrorMessage =
+  'Error: \x1B[2mexpect(\x1B[22m\x1B[31mreceived\x1B[39m\x1B[2m).\x1B[22mtoBe\x1B[2m(\x1B[22m\x1B[32mexpected\x1B[39m\x1B[2m) // Object.is equality\x1B[22m\n' +
+  '\n' +
+  'Expected: \x1B[32m1\x1B[39m\n' +
+  'Received: \x1B[31m10\x1B[39m\n' +
+  '    at Object.toBe (/user/project/__tests__/example.test.js:20:14)\n' +
+  '    at Promise.then.completed (/user/project/jest/packages/jest-circus/build/utils.js:333:28)\n' +
+  '    at new Promise (<anonymous>)\n' +
+  '    at callAsyncCircusFn (/user/project/jest/packages/jest-circus/build/utils.js:259:10)\n' +
+  '    at _callCircusTest (/user/project/jest/packages/jest-circus/build/run.js:276:40)\n' +
+  '    at processTicksAndRejections (node:internal/process/task_queues:95:5)\n' +
+  '    at _runTest (/user/project/jest/packages/jest-circus/build/run.js:208:3)\n' +
+  '    at _runTestsForDescribeBlock (/user/project/jest/packages/jest-circus/build/run.js:96:9)\n' +
+  '    at run (/user/project/jest/packages/jest-circus/build/run.js:31:3)\n' +
+  '    at runAndTransformResultsToJestFormat (/user/project/jest/packages/jest-circus/build/legacy-code-todo-rewrite/jestAdapterInit.js:135:21)';
+
+const referenceErrorMessage =
+  'ReferenceError: abc is not defined\n' +
+  '    at Object.abc (/user/project/__tests__/example.test.js:25:12)\n' +
+  '    at Promise.then.completed (/user/project/jest/packages/jest-circus/build/utils.js:333:28)\n' +
+  '    at new Promise (<anonymous>)\n' +
+  '    at callAsyncCircusFn (/user/project/jest/packages/jest-circus/build/utils.js:259:10)\n' +
+  '    at _callCircusTest (/user/project/jest/packages/jest-circus/build/run.js:276:40)\n' +
+  '    at processTicksAndRejections (node:internal/process/task_queues:95:5)\n' +
+  '    at _runTest (/user/project/jest/packages/jest-circus/build/run.js:208:3)\n' +
+  '    at _runTestsForDescribeBlock (/user/project/jest/packages/jest-circus/build/run.js:96:9)\n' +
+  '    at _runTestsForDescribeBlock (/user/project/jest/packages/jest-circus/build/run.js:90:9)\n' +
+  '    at run (/user/project/jest/packages/jest-circus/build/run.js:31:3)';
+
+const testCaseResult = {
+  ancestorTitles: [] as Array<string>,
+  failureMessages: [expectationsErrorMessage],
+  title: 'some test',
+} as TestCaseResult;
+
+describe("passes test case report to '@actions/core'", () => {
+  test('when expect returns an error', () => {
+    reporter.onTestCaseResult(testMeta, {
+      ...testCaseResult,
+      failureMessages: [expectationsErrorMessage],
+    });
+
+    expect(jest.mocked(process.stderr.write)).toBeCalledTimes(1);
+    expect(jest.mocked(process.stderr.write).mock.calls[0]).toMatchSnapshot();
+  });
+
+  test('when a test has reference error', () => {
+    reporter.onTestCaseResult(
+      {...testMeta, path: '/user/project/__tests__/example.test.js:25:12'},
+      {
+        ...testCaseResult,
+        failureMessages: [referenceErrorMessage],
+      },
+    );
+
+    expect(jest.mocked(process.stderr.write)).toBeCalledTimes(1);
+    expect(jest.mocked(process.stderr.write).mock.calls[0]).toMatchSnapshot();
+  });
+
+  test('when test is wrapped in describe block', () => {
+    reporter.onTestCaseResult(testMeta, {
+      ...testCaseResult,
+      ancestorTitles: ['describe'],
+    });
+
+    expect(jest.mocked(process.stderr.write)).toBeCalledTimes(1);
+    expect(jest.mocked(process.stderr.write).mock.calls[0]).toMatchSnapshot();
+  });
+
+  test('when test not is wrapped in describe block', () => {
+    reporter.onTestCaseResult(testMeta, testCaseResult);
+
+    expect(jest.mocked(process.stderr.write)).toBeCalledTimes(1);
+    expect(jest.mocked(process.stderr.write).mock.calls[0]).toMatchSnapshot();
+  });
+});

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

@@ -0,0 +1,33 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`passes test case report to '@actions/core' when a test has reference error 1`] = `
+Array [
+  "
+::error file=/user/project/__tests__/example.test.js:25:12,line=25,title=some test::ReferenceError: abc is not defined%0A%0A    at Object.abc (__tests__/example.test.js)
+",
+]
+`;
+
+exports[`passes test case report to '@actions/core' when expect returns an error 1`] = `
+Array [
+  "
+::error file=/user/project/__tests__/example.test.js,line=20,title=some test::expect(received).toBe(expected) // Object.is equality%0A%0AExpected: 1%0AReceived: 10%0A%0A    at Object.toBe (__tests__/example.test.js:20:14)
+",
+]
+`;
+
+exports[`passes test case report to '@actions/core' when test is wrapped in describe block 1`] = `
+Array [
+  "
+::error file=/user/project/__tests__/example.test.js,line=20,title=describe › some test::expect(received).toBe(expected) // Object.is equality%0A%0AExpected: 1%0AReceived: 10%0A%0A    at Object.toBe (__tests__/example.test.js:20:14)
+",
+]
+`;
+
+exports[`passes test case report to '@actions/core' when test not is wrapped in describe block 1`] = `
+Array [
+  "
+::error file=/user/project/__tests__/example.test.js,line=20,title=some test::expect(received).toBe(expected) // Object.is equality%0A%0AExpected: 1%0AReceived: 10%0A%0A    at Object.toBe (__tests__/example.test.js:20:14)
+",
+]
+`;

packages/jest-reporters/tsconfig.json

@@ -8,6 +8,7 @@
   "exclude": ["./**/__tests__/**/*"],
   "references": [
     {"path": "../jest-console"},
+    {"path": "../jest-message-util"},
     {"path": "../jest-resolve"},
     {"path": "../jest-test-result"},
     {"path": "../jest-transform"},

yarn.lock

@@ -2767,6 +2767,7 @@ __metadata:
     istanbul-lib-report: ^3.0.0
     istanbul-lib-source-maps: ^4.0.0
     istanbul-reports: ^3.1.3
+    jest-message-util: ^28.1.0
     jest-resolve: ^28.1.0
     jest-util: ^28.1.0
     jest-worker: ^28.1.0