Add testLocationInResults support to jest-circus

Part of jestjs#4362

Author: captbaritone

integration-tests/__tests__/location_in_results.test.js

@@ -29,5 +29,8 @@ it('adds correct location info when provided with flag', () => {
   expect(result.success).toBe(true);
   expect(result.numTotalTests).toBe(2);
   expect(assertions[0].location).toEqual({column: 1, line: 10});
+
+  // Technically the column should be 3, but callsites is not correct.
+  // jest-circus uses stack-utils + asyncErrors which resolves this.
   expect(assertions[1].location).toEqual({column: 2, line: 15});
 });

packages/jest-circus/package.json

@@ -14,7 +14,8 @@
     "jest-matcher-utils": "^23.0.0",
     "jest-message-util": "^23.0.0",
     "jest-snapshot": "^23.0.0",
-    "pretty-format": "^23.0.0"
+    "pretty-format": "^23.0.0",
+    "stack-utils": "^1.0.1"
   },
   "devDependencies": {
     "jest-runtime": "^23.0.0"

packages/jest-circus/src/legacy_code_todo_rewrite/jest_adapter_init.js

@@ -100,7 +100,7 @@ export const runAndTransformResultsToJestFormat = async ({
   globalConfig: GlobalConfig,
   testPath: string,
 }): Promise<TestResult> => {
-  const result = await run();
+  const result = await run(config);
 
   let numFailingTests = 0;
   let numPassingTests = 0;
@@ -124,12 +124,12 @@ export const runAndTransformResultsToJestFormat = async ({
     );
     const title = ancestorTitles.pop();
 
-    // $FlowFixMe Types are slightly incompatible and need to be refactored
     return {
       ancestorTitles,
       duration: testResult.duration,
       failureMessages: testResult.errors,
       fullName: ancestorTitles.concat(title).join(' '),
+      location: testResult.location,
       numPassingAsserts: 0,
       status,
       title: testResult.testPath[testResult.testPath.length - 1],

packages/jest-circus/src/run.js

@@ -7,6 +7,8 @@
  * @flow strict-local
  */
 
+import type {ProjectConfig} from 'types/Config';
+
 import type {
   TestEntry,
   TestResults,
@@ -25,12 +27,12 @@ import {
   makeTestResults,
 } from './utils';
 
-const run = async (): Promise<TestResults> => {
+const run = async (config: ProjectConfig): Promise<TestResults> => {
   const {rootDescribeBlock} = getState();
   dispatch({name: 'run_start'});
   await _runTestsForDescribeBlock(rootDescribeBlock);
   dispatch({name: 'run_finish'});
-  return makeTestResults(getState().rootDescribeBlock);
+  return makeTestResults(rootDescribeBlock, config);
 };
 
 const _runTestsForDescribeBlock = async (describeBlock: DescribeBlock) => {

packages/jest-circus/src/utils.js

@@ -7,6 +7,7 @@
  * @flow strict-local
  */
 
+import type {ProjectConfig} from 'types/Config';
 import type {
   AsyncFn,
   BlockMode,
@@ -22,6 +23,8 @@ import type {
   TestResults,
 } from 'types/Circus';
 
+import StackUtils from 'stack-utils';
+
 import prettyFormat from 'pretty-format';
 
 export const makeDescribe = (
@@ -213,7 +216,11 @@ export const getTestDuration = (test: TestEntry): ?number => {
   return startedAt ? Date.now() - startedAt : null;
 };
 
-export const makeTestResults = (describeBlock: DescribeBlock): TestResults => {
+export const makeTestResults = (
+  describeBlock: DescribeBlock,
+  config: ProjectConfig,
+): TestResults => {
+  const stackUtils = new StackUtils();
   let testResults = [];
   for (const test of describeBlock.tests) {
     const testPath = [];
@@ -227,16 +234,25 @@ export const makeTestResults = (describeBlock: DescribeBlock): TestResults => {
     if (!status) {
       throw new Error('Status should be present after tests are run.');
     }
+
+    let location = null;
+    if (config.testLocationInResults) {
+      const stackLine = test.asyncError.stack.split('\n')[1];
+      const {line, column} = stackUtils.parseLine(stackLine);
+      location = {column, line};
+    }
+
     testResults.push({
       duration: test.duration,
       errors: test.errors.map(_formatError),
+      location,
       status,
       testPath,
     });
   }
 
   for (const child of describeBlock.children) {
-    testResults = testResults.concat(makeTestResults(child));
+    testResults = testResults.concat(makeTestResults(child, config));
   }
 
   return testResults;

packages/jest-runner/src/run_test.js

@@ -69,7 +69,7 @@ async function runTestInternal(
   /* $FlowFixMe */
   const TestEnvironment = (require(testEnvironment): EnvironmentClass);
   /* $FlowFixMe */
-  const testFramework = (require(config.testRunner): TestFramework);
+  const testFramework = (require(testFramework): TestFramework);
   /* $FlowFixMe */
   const Runtime = (require(config.moduleLoader || 'jest-runtime'): Class<
     RuntimeClass,

types/Circus.js

@@ -137,6 +137,7 @@ export type TestResult = {|
   duration: ?number,
   errors: Array<FormattedError>,
   status: TestStatus,
+  location: ?{|column: number, line: number|},
   testPath: Array<TestName>,
 |};