fix: context clonning error when creating custom reporter (fix #614) (#…

…630)

packages/vitest/src/node/core.ts

@@ -7,7 +7,7 @@ import c from 'picocolors'
 import { ViteNodeServer } from 'vite-node/server'
 import type { ArgumentsType, RawSourceMap, Reporter, ResolvedConfig, UserConfig } from '../types'
 import { SnapshotManager } from '../integrations/snapshot/manager'
-import { clone, deepMerge, hasFailed, noop, slash, toArray } from '../utils'
+import { deepMerge, hasFailed, noop, slash, toArray } from '../utils'
 import { cleanCoverage, reportCoverage } from '../coverage'
 import { DefaultReporter, ReportersMap } from './reporters'
 import { createPool } from './pool'
@@ -92,9 +92,23 @@ export class Vitest {
   }
 
   getConfig() {
+    const hasCustomReporter = toArray(this.config.reporters)
+      .some(reporter => typeof reporter !== 'string')
+
+    if (!hasCustomReporter && !this.configOverride)
+      return this.config
+
+    const config = deepMerge({}, this.config)
+
     if (this.configOverride)
-      return deepMerge(clone(this.config), this.configOverride) as ResolvedConfig
-    return this.config
+      deepMerge(config, this.configOverride)
+
+    // Custom reporters cannot be serialized for sending to workers #614
+    // but workers don't need reporters anyway
+    if (hasCustomReporter)
+      config.reporters = []
+
+    return config as ResolvedConfig
   }
 
   async start(filters?: string[]) {

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

@@ -0,0 +1,23 @@
+import type { Reporter } from 'vitest'
+import type { Vitest } from 'vitest/src/node'
+
+import { defineConfig } from 'vite'
+
+class TestReporter implements Reporter {
+  ctx!: Vitest
+
+  onInit(ctx) {
+    this.ctx = ctx
+  }
+
+  onFinished() {
+    this.ctx.log('hello from custom reporter')
+  }
+}
+
+export default defineConfig({
+  test: {
+    include: ['tests/reporters.spec.ts'],
+    reporters: ['default', new TestReporter()],
+  },
+})

test/reporters/package.json

@@ -2,9 +2,10 @@
   "name": "@vitest/test-reporters",
   "private": true,
   "scripts": {
-    "test": "vitest --global"
+    "test": "vitest"
   },
   "devDependencies": {
+    "execa": "^6.0.0",
     "vitest": "workspace:*"
   }
 }

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

@@ -0,0 +1,18 @@
+import { execa } from 'execa'
+import { resolve } from 'pathe'
+import { expect, test } from 'vitest'
+
+test('custom resolvers work with threads', async() => {
+  const root = resolve(__dirname, '..')
+
+  const { stdout } = await execa('npx', ['vitest', 'run', '--config', 'custom-reporter.vitest.config.ts'], {
+    cwd: root,
+    env: {
+      ...process.env,
+      CI: 'true',
+      NO_COLOR: 'true',
+    },
+  })
+
+  expect(stdout).toContain('hello from custom reporter')
+}, 20000)

test/reporters/tests/reporters.spec.ts

@@ -1,4 +1,4 @@
-import { expect, test, vi } from 'vitest'
+import { afterEach, beforeEach, expect, test, vi } from 'vitest'
 import { JsonReporter } from '../../../packages/vitest/src/node/reporters/json'
 import { JUnitReporter } from '../../../packages/vitest/src/node/reporters/junit'
 import { TapReporter } from '../../../packages/vitest/src/node/reporters/tap'