feat: provide entity to onConsoleLog (#8159)

sheremet-va · web-flow · commit 437d461aae71 · 2025-06-20T17:10:25.000+02:00
diff --git a/docs/config/index.md b/docs/config/index.md
@@ -2233,9 +2233,15 @@ Retry the test specific number of times if it fails.
 
 ### onConsoleLog<NonProjectOption />
 
-- **Type**: `(log: string, type: 'stdout' | 'stderr') => boolean | void`
+```ts
+function onConsoleLog(
+  log: string,
+  type: 'stdout' | 'stderr',
+  entity: TestModule | TestSuite | TestCase | undefined,
+): boolean | void
+```
 
-Custom handler for `console.log` in tests. If you return `false`, Vitest will not print the log to the console.
+Custom handler for `console` methods in tests. If you return `false`, Vitest will not print the log to the console. Note that Vitest ignores all other falsy values.
 
 Can be useful for filtering out logs from third-party libraries.
 
diff --git a/packages/vitest/src/node/reporters/base.ts b/packages/vitest/src/node/reporters/base.ts
@@ -433,9 +433,13 @@ export abstract class BaseReporter implements Reporter {
       return false
     }
 
-    const shouldLog = this.ctx.config.onConsoleLog?.(log.content, log.type)
-    if (shouldLog === false) {
-      return shouldLog
+    if (this.ctx.config.onConsoleLog) {
+      const task = log.taskId ? this.ctx.state.idMap.get(log.taskId) : undefined
+      const entity = task && this.ctx.state.getReportedEntity(task)
+      const shouldLog = this.ctx.config.onConsoleLog(log.content, log.type, entity)
+      if (shouldLog === false) {
+        return shouldLog
+      }
     }
     return true
   }
diff --git a/packages/vitest/src/node/types/config.ts b/packages/vitest/src/node/types/config.ts
@@ -14,6 +14,7 @@ import type {
   BuiltinReporterOptions,
   BuiltinReporters,
 } from '../reporters'
+import type { TestCase, TestModule, TestSuite } from '../reporters/reported-tasks'
 import type { TestSequencerConstructor } from '../sequencers/types'
 import type { WatcherTriggerPattern } from '../watcher'
 import type { BenchmarkUserOptions } from './benchmark'
@@ -661,7 +662,7 @@ export interface InlineConfig {
    *
    * Return `false` to ignore the log.
    */
-  onConsoleLog?: (log: string, type: 'stdout' | 'stderr') => boolean | void
+  onConsoleLog?: (log: string, type: 'stdout' | 'stderr', entity: TestModule | TestCase | TestSuite | undefined) => boolean | void
 
   /**
    * Enable stack trace filtering. If absent, all stack trace frames
diff --git a/test/cli/test/console.test.ts b/test/cli/test/console.test.ts
@@ -1,7 +1,7 @@
-import { resolve } from 'pathe'
+import { relative, resolve } from 'pathe'
 import { expect, test } from 'vitest'
 import { DefaultReporter } from 'vitest/reporters'
-import { runVitest } from '../../test-utils'
+import { runInlineTests, runVitest } from '../../test-utils'
 
 test('can run custom pools with Vitest', async () => {
   const reporter = new DefaultReporter()
@@ -72,3 +72,77 @@ test('can run custom pools with Vitest', async () => {
     `)
   }
 })
+
+test('onConsoleLog receives the entity', async () => {
+  const logs: {
+    log: string
+    type: 'stderr' | 'stdout'
+    entity: { type: string; name: string } | undefined
+  }[] = []
+  const { stderr } = await runInlineTests(
+    {
+      'basic.test.ts': `
+    console.log('module')
+
+    describe('suite', () => {
+      beforeAll(() => {
+        console.log('suite')
+      })
+
+      test('test', () => {
+        console.log('test')
+      })
+    })
+    `,
+    },
+    {
+      globals: true,
+      onConsoleLog(log, type, entity) {
+        logs.push({
+          log,
+          type,
+          entity: entity
+            ? {
+                type: entity.type,
+                name: entity.type === 'module'
+                  ? relative(entity.project.config.root, entity.moduleId)
+                  : entity.name,
+              }
+            : undefined,
+        })
+      },
+    },
+  )
+  expect(stderr).toBe('')
+  expect(logs).toMatchInlineSnapshot(`
+    [
+      {
+        "entity": {
+          "name": "basic.test.ts",
+          "type": "module",
+        },
+        "log": "module
+    ",
+        "type": "stdout",
+      },
+      {
+        "entity": {
+          "name": "suite",
+          "type": "suite",
+        },
+        "log": "suite
+    ",
+        "type": "stdout",
+      },
+      {
+        "entity": {
+          "name": "test",
+          "type": "test",
+        },
+        "log": "test
+    ",
+        "type": "stdout",
+      },
+    ]
+  `)
+})

Original file line number	Diff line number	Diff line change
`@@ -433,9 +433,13 @@ export abstract class BaseReporter implements Reporter {`
`433`	`433`	`return false`
`434`	`434`	`}`
`435`	`435`
`436`		`- const shouldLog = this.ctx.config.onConsoleLog?.(log.content, log.type)`
`437`		`- if (shouldLog === false) {`
`438`		`- return shouldLog`
	`436`	`+ if (this.ctx.config.onConsoleLog) {`
	`437`	`+ const task = log.taskId ? this.ctx.state.idMap.get(log.taskId) : undefined`
	`438`	`+ const entity = task && this.ctx.state.getReportedEntity(task)`
	`439`	`+ const shouldLog = this.ctx.config.onConsoleLog(log.content, log.type, entity)`
	`440`	`+ if (shouldLog === false) {`
	`441`	`+ return shouldLog`
	`442`	`+ }`
`439`	`443`	`}`
`440`	`444`	`return true`
`441`	`445`	`}`