fix: don't use Custom type internally (#7032)

Author: sheremet-va

packages/runner/src/collect.ts

@@ -60,7 +60,7 @@ export async function collectTests(
       mergeHooks(fileHooks, getHooks(defaultTasks))
 
       for (const c of [...defaultTasks.tasks, ...collectorContext.tasks]) {
-        if (c.type === 'test' || c.type === 'custom' || c.type === 'suite') {
+        if (c.type === 'test' || c.type === 'suite') {
           file.tasks.push(c)
         }
         else if (c.type === 'collector') {

packages/runner/src/run.ts

@@ -2,7 +2,6 @@ import type { Awaitable } from '@vitest/utils'
 import type { DiffOptions } from '@vitest/utils/diff'
 import type { FileSpec, VitestRunner } from './types/runner'
 import type {
-  Custom,
   File,
   HookCleanupCallback,
   HookListener,
@@ -177,7 +176,7 @@ async function callCleanupHooks(cleanups: HookCleanupCallback[]) {
   )
 }
 
-export async function runTest(test: Test | Custom, runner: VitestRunner): Promise<void> {
+export async function runTest(test: Test, runner: VitestRunner): Promise<void> {
   await runner.onBeforeRunTask?.(test)
 
   if (test.mode !== 'run') {
@@ -471,7 +470,7 @@ export async function runSuite(suite: Suite, runner: VitestRunner): Promise<void
 let limitMaxConcurrency: ReturnType<typeof limitConcurrency>
 
 async function runSuiteChild(c: Task, runner: VitestRunner) {
-  if (c.type === 'test' || c.type === 'custom') {
+  if (c.type === 'test') {
     return limitMaxConcurrency(() => runTest(c, runner))
   }
   else if (c.type === 'suite') {

packages/runner/src/suite.ts

@@ -1,8 +1,6 @@
 import type { FixtureItem } from './fixture'
 import type { VitestRunner } from './types/runner'
 import type {
-  Custom,
-  CustomAPI,
   File,
   Fixtures,
   RunMode,
@@ -294,7 +292,7 @@ function createSuiteCollector(
   each?: boolean,
   suiteOptions?: TestOptions,
 ) {
-  const tasks: (Test | Custom | Suite | SuiteCollector)[] = []
+  const tasks: (Test | Suite | SuiteCollector)[] = []
   const factoryQueue: (Test | Suite | SuiteCollector)[] = []
 
   let suite: Suite
@@ -609,7 +607,7 @@ function createSuite() {
 export function createTaskCollector(
   fn: (...args: any[]) => any,
   context?: Record<string, unknown>,
-): CustomAPI {
+): TestAPI {
   const taskFn = fn as any
 
   taskFn.each = function <T>(
@@ -730,7 +728,7 @@ export function createTaskCollector(
   const _test = createChainable(
     ['concurrent', 'sequential', 'skip', 'only', 'todo', 'fails'],
     taskFn,
-  ) as CustomAPI
+  ) as TestAPI
 
   if (context) {
     (_test as any).mergeContext(context)

packages/runner/src/test-state.ts

@@ -1,11 +1,11 @@
-import type { Custom, Test } from './types/tasks.ts'
+import type { Test } from './types/tasks.ts'
 
-let _test: Test | Custom | undefined
+let _test: Test | undefined
 
-export function setCurrentTest<T extends Test | Custom>(test: T | undefined): void {
+export function setCurrentTest<T extends Test>(test: T | undefined): void {
   _test = test
 }
 
-export function getCurrentTest<T extends Test | Custom | undefined>(): T {
+export function getCurrentTest<T extends Test | undefined>(): T {
   return _test as T
 }

packages/runner/src/types.ts

@@ -12,6 +12,7 @@ export type {
   BeforeAllListener,
   BeforeEachListener,
   Custom,
+  /** @deprecated use `TestAPI` instead */
   CustomAPI,
   DoneCallback,
   ExtendedContext,

packages/runner/src/types/runner.ts

@@ -1,6 +1,5 @@
 import type { DiffOptions } from '@vitest/utils/diff'
 import type {
-  Custom,
   ExtendedContext,
   File,
   SequenceHooks,
@@ -91,7 +90,7 @@ export interface VitestRunner {
   /**
    * When the task has finished running, but before cleanup hooks are called
    */
-  onTaskFinished?: (test: Test | Custom) => unknown
+  onTaskFinished?: (test: Test) => unknown
   /**
    * Called after result and state are set.
    */

packages/runner/src/types/tasks.ts

@@ -223,18 +223,9 @@ export interface Test<ExtraContext = object> extends TaskPopulated {
 /**
  * @deprecated Use `Test` instead. `type: 'custom'` is not used since 2.2
  */
-export interface Custom<ExtraContext = object> extends TaskPopulated {
-  /**
-   * @deprecated use `test` instead. `custom` is not used since 2.2
-   */
-  type: 'custom'
-  /**
-   * Task context that will be passed to the test function.
-   */
-  context: TaskContext<Test> & ExtraContext & TestContext
-}
+export type Custom<ExtraContext = object> = Test<ExtraContext>
 
-export type Task = Test | Suite | Custom | File
+export type Task = Test | Suite | File
 
 /**
  * @deprecated Vitest doesn't provide `done()` anymore
@@ -441,6 +432,7 @@ export type TestAPI<ExtraContext = object> = ChainableTestAPI<ExtraContext> &
     }>
   }
 
+/** @deprecated use `TestAPI` instead */
 export type { TestAPI as CustomAPI }
 
 export interface FixtureOptions {
@@ -578,8 +570,6 @@ export interface SuiteCollector<ExtraContext = object> {
   test: TestAPI<ExtraContext>
   tasks: (
     | Suite
-    // TODO: remove in Vitest 3
-    | Custom<ExtraContext>
     | Test<ExtraContext>
     | SuiteCollector<ExtraContext>
   )[]

packages/runner/src/utils/index.ts

@@ -18,4 +18,5 @@ export {
   hasFailed,
   hasTests,
   isAtomTest,
+  isTestCase,
 } from './tasks'

packages/runner/src/utils/tasks.ts

@@ -1,19 +1,19 @@
-import type { Custom, Suite, Task, Test } from '../types/tasks'
+import type { Suite, Task, Test } from '../types/tasks'
 import { type Arrayable, toArray } from '@vitest/utils'
 
 /**
  * @deprecated use `isTestCase` instead
  */
-export function isAtomTest(s: Task): s is Test | Custom {
+export function isAtomTest(s: Task): s is Test {
   return isTestCase(s)
 }
 
-export function isTestCase(s: Task): s is Test | Custom {
-  return s.type === 'test' || s.type === 'custom'
+export function isTestCase(s: Task): s is Test {
+  return s.type === 'test'
 }
 
-export function getTests(suite: Arrayable<Task>): (Test | Custom)[] {
-  const tests: (Test | Custom)[] = []
+export function getTests(suite: Arrayable<Task>): Test[] {
+  const tests: Test[] = []
   const arraySuites = toArray(suite)
   for (const s of arraySuites) {
     if (isTestCase(s)) {

packages/ui/client/components/views/ViewReport.vue

@@ -19,7 +19,7 @@ function collectFailed(task: Task, level: number): LeveledTask[] {
     return []
   }
 
-  if (task.type === 'test' || task.type === 'custom') {
+  if (task.type === 'test') {
     return [{ ...task, level }]
   }
   else {