fix(reporter): correct error source position in json report (#1909)

Co-authored-by: Anthony Fu <anthonyfu117@hotmail.com>

packages/vitest/src/node/reporters/json.ts

@@ -4,7 +4,7 @@ import type { Vitest } from '../../node'
 import type { File, Reporter, Suite, TaskState, Test } from '../../types'
 import { getSuites, getTests } from '../../utils'
 import { getOutputFile } from '../../utils/config-helpers'
-import { parseStacktrace } from '../../utils/source-map'
+import { interpretSourcePos, parseStacktrace } from '../../utils/source-map'
 
 // for compatibility reasons, the reporter produces a JSON similar to the one produced by the Jest JSON reporter
 // the following types are extracted from the Jest repository (and simplified)
@@ -94,7 +94,7 @@ export class JsonReporter implements Reporter {
         startTime = this.start
 
       const endTime = tests.reduce((prev, next) => Math.max(prev, (next.result?.startTime ?? 0) + (next.result?.duration ?? 0)), startTime)
-      const assertionResults = tests.map((t) => {
+      const assertionResults = await Promise.all(tests.map(async (t) => {
         const ancestorTitles = [] as string[]
         let iter: Suite | undefined = t.suite
         while (iter) {
@@ -110,9 +110,9 @@ export class JsonReporter implements Reporter {
           title: t.name,
           duration: t.result?.duration,
           failureMessages: t.result?.error?.message == null ? [] : [t.result.error.message],
-          location: this.getFailureLocation(t),
+          location: await this.getFailureLocation(t),
         } as FormattedAssertionResult
-      })
+      }))
 
       if (tests.some(t => t.result?.state === 'run')) {
         this.ctx.logger.warn('WARNING: Some tests are still running when generating the JSON report.'
@@ -180,12 +180,13 @@ export class JsonReporter implements Reporter {
     }
   }
 
-  protected getFailureLocation(test: Test): Callsite | undefined {
+  protected async getFailureLocation(test: Test): Promise<Callsite | undefined> {
     const error = test.result?.error
     if (!error)
       return
 
     const stack = parseStacktrace(error)
+    await interpretSourcePos(stack, this.ctx)
     const frame = stack[stack.length - 1]
     if (!frame)
       return

test/reporters/fixtures/json-fail.test.ts

@@ -0,0 +1,7 @@
+import { expect, test } from 'vitest'
+
+// I am comment1
+// I am comment2
+test('should fail', () => {
+  expect(2).toEqual(1)
+})

test/reporters/fixtures/vitest.config.ts

@@ -0,0 +1,4 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+})

test/reporters/src/context.ts

@@ -1,3 +1,4 @@
+import type { ModuleGraph, ViteDevServer } from 'vite'
 import type { Logger } from '../../../packages/vitest/src/node/logger'
 import type { Vitest } from '../../../packages/vitest/src/node'
 import type { StateManager } from '../../../packages/vitest/src/node/state'
@@ -15,13 +16,22 @@ export function getContext(): Context {
     root: '/',
   }
 
+  const moduleGraph: Partial<ModuleGraph> = {
+    getModuleById: () => undefined,
+  }
+
+  const server: Partial<ViteDevServer> = {
+    moduleGraph: moduleGraph as ModuleGraph,
+  }
+
   const state: Partial<StateManager> = {
     filesMap: new Map<string, File>(),
   }
 
   const context: Partial<Vitest> = {
     state: state as StateManager,
     config: config as ResolvedConfig,
+    server: server as ViteDevServer,
   }
 
   context.logger = {

test/reporters/tests/__snapshots__/json.test.ts.snap

@@ -0,0 +1,19 @@
+// Vitest Snapshot v1
+
+exports[`json reporter > generates correct report 1`] = `
+{
+  "ancestorTitles": [
+    "",
+  ],
+  "failureMessages": [
+    "expected 2 to deeply equal 1",
+  ],
+  "fullName": " should fail",
+  "location": {
+    "column": 12,
+    "line": 6,
+  },
+  "status": "failed",
+  "title": "should fail",
+}
+`;

test/reporters/tests/json.test.ts

@@ -0,0 +1,30 @@
+import { resolve } from 'pathe'
+import { execa } from 'execa'
+import { describe, expect, it } from 'vitest'
+
+describe('json reporter', async () => {
+  const root = resolve(__dirname, '../fixtures')
+
+  const skip = (process.platform === 'win32' || process.platform === 'darwin') && process.env.CI
+
+  it.skipIf(skip)('generates correct report', async () => {
+    const { stdout } = await execa('npx', ['vitest', 'run', 'json-fail', '--reporter=json'], {
+      cwd: root,
+      env: {
+        ...process.env,
+        CI: 'true',
+        NO_COLOR: 'true',
+      },
+      stdio: 'pipe',
+    }).catch(e => e)
+
+    const data = JSON.parse(stdout)
+
+    expect(data.testResults).toHaveLength(1)
+    expect(data.testResults[0].assertionResults).toHaveLength(1)
+
+    const result = data.testResults[0].assertionResults[0]
+    delete result.duration
+    expect(result).toMatchSnapshot()
+  }, 40000)
+})

test/reporters/vitest.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    exclude: ['node_modules', 'fixtures', 'dist'],
+    testTimeout: 100000,
+  },
+})