fix: load deps reporter (#2249)

* test: load deps reporter

* chore: update

* fix: lint

* feat: more timeout

* feat: absolute path will executeId

* chore: update

* chore: update

* test: load report no base on root

* chore: update

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

@@ -6,7 +6,7 @@ import type { BenchmarkBuiltinReporters, BuiltinReporters } from './index'
 async function loadCustomReporterModule<C extends Reporter>(path: string, runner: ViteNodeRunner): Promise<new () => C> {
   let customReporterModule: { default: new () => C }
   try {
-    customReporterModule = await runner.executeFile(path)
+    customReporterModule = await runner.executeId(path)
   }
   catch (customReporterModuleError) {
     throw new Error(`Failed to load custom Reporter from ${path}`, { cause: customReporterModuleError as Error })

test/reporters/deps-reporter.vitest.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    include: ['tests/reporters.spec.ts'],
+    reporters: ['pkg-reporter'],
+  },
+})

test/reporters/package.json

@@ -6,6 +6,7 @@
   },
   "devDependencies": {
     "execa": "^6.1.0",
+    "pkg-reporter": "./reportPkg/",
     "vitest": "workspace:*"
   }
 }

test/reporters/reportPkg/index.js

@@ -0,0 +1,9 @@
+export default class PackageReporter {
+  onInit(ctx) {
+    this.ctx = ctx
+  }
+
+  onFinished() {
+    this.ctx.logger.log('hello from package reporter')
+  }
+}

test/reporters/reportPkg/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "pkg-reporter",
+  "main": "./index.js"
+}

test/reporters/reportTest2/custom-reporter-path.vitest.config.ts

@@ -0,0 +1,13 @@
+import { resolve } from 'pathe'
+import { defineConfig } from 'vitest/config'
+
+const customReporter = resolve(__dirname, '../src/custom-reporter.ts')
+
+export default defineConfig({
+  root: __dirname,
+  test: {
+    root: __dirname,
+    include: ['../tests/reporters.spec.ts'],
+    reporters: [customReporter],
+  },
+})

test/reporters/tests/custom-reporter.spec.ts

@@ -45,6 +45,16 @@ describe.concurrent('custom reporters', () => {
     expect(stdout).includes('hello from custom reporter')
   }, 40000)
 
+  test('load no base on root custom reporter instances defined in configuration works', async () => {
+    const stdout = await runWithRetry('--config', './reportTest2/custom-reporter-path.vitest.config.ts')
+    expect(stdout).includes('hello from custom reporter')
+  }, 50000)
+
+  test('package.json dependencies reporter instances defined in configuration works', async () => {
+    const stdout = await runWithRetry('--config', 'deps-reporter.vitest.config.ts')
+    expect(stdout).includes('hello from package reporter')
+  }, 50000)
+
   test('a path to a custom reporter defined in configuration works', async () => {
     const stdout = await runWithRetry('--config', 'custom-reporter-path.vitest.config.ts', '--reporter', customJSReporterPath)
     expect(stdout).includes('hello from custom reporter')

test/reporters/tests/utils.test.ts

@@ -10,7 +10,7 @@ import TestReporter from '../src/custom-reporter'
 
 const customReporterPath = resolve(__dirname, '../src/custom-reporter.js')
 const fetchModule = {
-  executeFile: (id: string) => import(id),
+  executeId: (id: string) => import(id),
 } as ViteNodeRunner
 
 describe('Reporter Utils', () => {