feat: display test "path" when filtering (#8547)

Author: userquin

packages/vitest/src/node/stdin.ts

@@ -1,7 +1,9 @@
+import type { File, Task } from '@vitest/runner'
 import type { Writable } from 'node:stream'
 import type { Vitest } from './core'
+import type { FilterObject } from './watch-filter'
 import readline from 'node:readline'
-import { getTests } from '@vitest/runner/utils'
+import { isTestCase } from '@vitest/runner/utils'
 import { relative, resolve } from 'pathe'
 import prompt from 'prompts'
 import c from 'tinyrainbow'
@@ -38,6 +40,38 @@ ${keys
   )
 }
 
+function* traverseFilteredTestNames(parentName: string, filter: RegExp, t: Task): Generator<FilterObject> {
+  if (isTestCase(t)) {
+    if (t.name.match(filter)) {
+      const displayName = `${parentName} > ${t.name}`
+      yield { key: t.name, toString: () => displayName }
+    }
+  }
+  else {
+    parentName = parentName.length ? `${parentName} > ${t.name}` : t.name
+    for (const task of t.tasks) {
+      yield* traverseFilteredTestNames(parentName, filter, task)
+    }
+  }
+}
+
+function* getFilteredTestNames(pattern: string, suite: File[]): Generator<FilterObject> {
+  try {
+    const reg = new RegExp(pattern)
+    // TODO: we cannot run tests per workspace yet: filtering files
+    const files = new Set<string>()
+    for (const file of suite) {
+      if (!files.has(file.name)) {
+        files.add(file.name)
+        yield* traverseFilteredTestNames('', reg, file)
+      }
+    }
+  }
+  catch {
+    // `new RegExp` may throw error when input is invalid regexp
+  }
+}
+
 export function registerConsoleShortcuts(
   ctx: Vitest,
   stdin: NodeJS.ReadStream | undefined = process.stdin,
@@ -134,24 +168,13 @@ export function registerConsoleShortcuts(
 
   async function inputNamePattern() {
     off()
-    const watchFilter = new WatchFilter(
+    const watchFilter = new WatchFilter<'object'>(
       'Input test name pattern (RegExp)',
       stdin,
       stdout,
     )
     const filter = await watchFilter.filter((str: string) => {
-      const files = ctx.state.getFiles()
-      const tests = getTests(files)
-      try {
-        const reg = new RegExp(str)
-        return tests
-          .map(test => test.name)
-          .filter(testName => testName.match(reg))
-      }
-      catch {
-        // `new RegExp` may throw error when input is invalid regexp
-        return []
-      }
+      return [...getFilteredTestNames(str, ctx.state.getFiles())]
     })
 
     on()

packages/vitest/src/node/watch-filter.ts

@@ -9,13 +9,19 @@ const MAX_RESULT_COUNT = 10
 const SELECTION_MAX_INDEX = 7
 const ESC = '\u001B['
 
-type FilterFunc = (keyword: string) => Promise<string[]> | string[]
+export interface FilterObject {
+  key: string
+  toString: () => string
+}
+
+type FilterItemType<T extends 'string' | 'object' = 'string'> = T extends 'string' ? string : FilterObject
+type FilterFuncType<T extends 'string' | 'object' = 'string'> = (keyword: string) => Promise<FilterItemType<T>[]> | FilterItemType<T>[]
 
-export class WatchFilter {
+export class WatchFilter<T extends 'string' | 'object' = 'string'> {
   private filterRL: readline.Interface
   private currentKeyword: string | undefined = undefined
   private message: string
-  private results: string[] = []
+  private results: FilterItemType<T>[] = []
   private selectionIndex = -1
   private onKeyPress?: (str: string, key: any) => void
   private stdin: NodeJS.ReadStream
@@ -40,7 +46,7 @@ export class WatchFilter {
     }
   }
 
-  public async filter(filterFunc: FilterFunc): Promise<string | undefined> {
+  public async filter(filterFunc: FilterFuncType<T>): Promise<string | undefined> {
     this.write(this.promptLine())
 
     const resultPromise = createDefer<string | undefined>()
@@ -58,7 +64,7 @@ export class WatchFilter {
   }
 
   private filterHandler(
-    filterFunc: FilterFunc,
+    filterFunc: FilterFuncType<T>,
     onSubmit: (result?: string) => void,
   ) {
     return async (str: string | undefined, key: any) => {
@@ -78,12 +84,17 @@ export class WatchFilter {
           onSubmit(undefined)
           return
         case key?.name === 'enter':
-        case key?.name === 'return':
+        case key?.name === 'return': {
+          const selection = this.results[this.selectionIndex]
+          const result = typeof selection === 'string'
+            ? selection
+            : selection?.key
           onSubmit(
-            this.results[this.selectionIndex] || this.currentKeyword || '',
+            result || this.currentKeyword || '',
           )
           this.currentKeyword = undefined
           break
+        }
         case key?.name === 'up':
           if (this.selectionIndex && this.selectionIndex > 0) {
             this.selectionIndex--
@@ -229,6 +240,6 @@ export class WatchFilter {
   }
 
   public getLastResults(): string[] {
-    return this.results
+    return this.results.map(r => (typeof r === 'string' ? r : r.toString()))
   }
 }

test/cli/fixtures/path-filter/basic.test.ts

@@ -0,0 +1,10 @@
+import { describe, expect, test } from "vitest";
+
+describe('basic path filter', () => {
+  test("foo", () => {
+    expect(1).toBe(1);
+  })
+  test("bar", () => {
+    expect(1).toBe(1);
+  })
+})

test/cli/fixtures/path-filter/vitest.config.ts

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

test/cli/test/path-filter.test.ts

@@ -0,0 +1,16 @@
+import { test } from 'vitest'
+import { runVitest } from '../../test-utils'
+
+test('test path is shown when filtering', async () => {
+  const { vitest } = await runVitest({
+    root: 'fixtures/path-filter',
+    watch: true,
+  })
+
+  await vitest.waitForStdout('press h to show help, press q to quit')
+  vitest.write('t')
+  await vitest.waitForStdout(`? Input test name pattern (RegExp)`)
+  vitest.write('foo')
+  await vitest.waitForStdout('Pattern matches 1 result')
+  await vitest.waitForStdout('basic.test.ts > basic path filter > foo')
+})