refactor: cleanup, review

Author: sheremet-va

docs/guide/test-context.md

@@ -702,6 +702,10 @@ export default defineConfig({
 
 You can override fixture values for a specific suite and its children using `test.override`. This is useful when you need different fixture values for different test scenarios.
 
+::: tip
+Vitest will automatically inherit the options, if they are not provided when overriding. Note that you cannot override fixture's `scope` or `auto` options.
+:::
+
 #### Builder Pattern (Recommended)
 
 ```ts

packages/runner/src/fixture.ts

@@ -2,24 +2,25 @@ import type { FixtureFn, Suite, VitestRunner } from './types'
 import type { File, FixtureOptions, TestContext } from './types/tasks'
 import { createDefer, filterOutComments, isObject } from '@vitest/utils/helpers'
 import { FixtureDependencyError } from './errors'
-import { getTestFixturesManager } from './map'
+import { getTestFixtures } from './map'
 import { getCurrentSuite } from './suite'
 
 export interface TestFixtureItem extends FixtureOptions {
   name: string
   value: unknown
   scope: 'test' | 'file' | 'worker'
   deps: Set<string>
-  // so it's possible to call { parent } inside the same fixture
+  // so it's possible to call base fixture inside ({ a: ({ a }, use) => {} })
   parent?: TestFixtureItem
 }
 
-export type TestFixtureRecord = Record<string, TestFixtureItem>
+export type UserFixtures = Record<string, unknown>
+export type FixtureRegistrations = Map<string, TestFixtureItem>
 
 export class TestFixtures {
-  private _suiteContexts: WeakMap<Suite | symbol, Record<string, any>>
-  private _overrides = new WeakMap<Suite, Map<string, TestFixtureItem>>()
-  private _registrations: Map<string, TestFixtureItem>
+  private _suiteContexts: WeakMap<Suite | symbol, /* context object */ Record<string, unknown>>
+  private _overrides = new WeakMap<Suite, FixtureRegistrations>()
+  private _registrations: FixtureRegistrations
 
   private static _definitions: TestFixtures[] = []
   private static _builtinFixtures: string[] = [
@@ -47,22 +48,20 @@ export class TestFixtures {
     return TestFixtures._definitions.map(f => f.getFileContext(file))
   }
 
-  constructor(
-    registrations?: Map<string, TestFixtureItem>,
-  ) {
+  constructor(registrations?: FixtureRegistrations) {
     this._registrations = registrations ?? new Map()
     this._suiteContexts = new WeakMap()
     TestFixtures._definitions.push(this)
   }
 
-  extend(runner: VitestRunner, userFixtures: Record<string, any>): TestFixtures {
+  extend(runner: VitestRunner, userFixtures: UserFixtures): TestFixtures {
     const { suite } = getCurrentSuite()
     const isTopLevel = !suite || suite.file === suite
     const registrations = this.parseUserFixtures(runner, userFixtures, isTopLevel)
     return new TestFixtures(registrations)
   }
 
-  get(suite: Suite): Map<string, TestFixtureItem> {
+  get(suite: Suite): FixtureRegistrations {
     let currentSuite: Suite | undefined = suite
     while (currentSuite) {
       const overrides = this._overrides.get(currentSuite)
@@ -78,16 +77,16 @@ export class TestFixtures {
     return this._registrations
   }
 
-  override(runner: VitestRunner, userFixtures: Record<string, any>): void {
+  override(runner: VitestRunner, userFixtures: UserFixtures): void {
     const { suite: currentSuite, file } = getCurrentSuite()
     const suite = currentSuite || file
     const isTopLevel = !currentSuite || currentSuite.file === currentSuite
     // Create a copy of the closest parent's registrations to avoid modifying them
     // For chained calls, this.get(suite) returns this suite's overrides; for first call, returns parent's
     const suiteRegistrations = new Map(this.get(suite))
     const registrations = this.parseUserFixtures(runner, userFixtures, isTopLevel, suiteRegistrations)
-    // if defined in top-level, just override all registrations,
-    // we don't support overriding suite-level fixtures anyway (it will throw an error)
+    // If defined in top-level, just override all registrations
+    // We don't support overriding suite-level fixtures anyway (it will throw an error)
     if (isTopLevel) {
       this._registrations = registrations
     }
@@ -112,7 +111,7 @@ export class TestFixtures {
 
   private parseUserFixtures(
     runner: VitestRunner,
-    userFixtures: Record<string, any>,
+    userFixtures: UserFixtures,
     supportNonTest: boolean,
     registrations = new Map<string, TestFixtureItem>(this._registrations),
   ) {
@@ -272,7 +271,7 @@ export async function callFixtureCleanupFrom(context: object, fromIndex: number)
 
 const contextHasFixturesCache = new WeakMap<TestContext, WeakSet<TestFixtureItem>>()
 
-export function withFixtures(runner: VitestRunner, fn: Function, testContext?: TestContext) {
+export function withFixtures(fn: Function, testContext?: TestContext) {
   const collector = getCurrentSuite()
   const suite = collector.suite || collector.file
   return async (hookContext?: TestContext): Promise<any> => {
@@ -282,20 +281,20 @@ export function withFixtures(runner: VitestRunner, fn: Function, testContext?: T
       return fn({})
     }
 
-    const fixturesManager = getTestFixturesManager(context)
-    if (!fixturesManager) {
+    const fixtures = getTestFixtures(context)
+    if (!fixtures) {
       return fn(context)
     }
 
-    const fixtures = fixturesManager.get(suite)
-    if (!fixtures.size) {
+    const registrations = fixtures.get(suite)
+    if (!registrations.size) {
       return fn(context)
     }
 
     const usedFixtures: TestFixtureItem[] = []
     const usedProps = getUsedProps(fn)
 
-    for (const fixture of fixtures.values()) {
+    for (const fixture of registrations.values()) {
       if (fixture.auto || usedProps.has(fixture.name)) {
         usedFixtures.push(fixture)
       }
@@ -310,7 +309,7 @@ export function withFixtures(runner: VitestRunner, fn: Function, testContext?: T
     }
     const cleanupFnArray = cleanupFnArrayMap.get(context)!
 
-    const pendingFixtures = resolveDeps(usedFixtures, fixtures)
+    const pendingFixtures = resolveDeps(usedFixtures, registrations)
 
     if (!pendingFixtures.length) {
       return fn(context)
@@ -344,7 +343,7 @@ export function withFixtures(runner: VitestRunner, fn: Function, testContext?: T
       }
       else {
         const resolvedValue = await resolveScopeFixtureValue(
-          fixturesManager,
+          fixtures,
           suite,
           fixture,
         )
@@ -459,7 +458,7 @@ async function resolveFixtureFunction(
 
 function resolveDeps(
   usedFixtures: TestFixtureItem[],
-  fixtures: Map<string, TestFixtureItem>,
+  registrations: FixtureRegistrations,
   depSet = new Set<TestFixtureItem>(),
   pendingFixtures: TestFixtureItem[] = [],
 ) {
@@ -487,8 +486,8 @@ function resolveDeps(
 
     depSet.add(fixture)
     resolveDeps(
-      [...fixture.deps].map(n => n === fixture.name ? fixture.parent : fixtures.get(n)).filter(n => !!n),
-      fixtures,
+      [...fixture.deps].map(n => n === fixture.name ? fixture.parent : registrations.get(n)).filter(n => !!n),
+      registrations,
       depSet,
       pendingFixtures,
     )

packages/runner/src/hooks.ts

@@ -1,4 +1,3 @@
-import type { VitestRunner } from './types'
 import type {
   AfterAllListener,
   AfterEachListener,
@@ -144,12 +143,11 @@ export function beforeEach<ExtraContext = object>(
 ): void {
   assertTypes(fn, '"beforeEach" callback', ['function'])
   const stackTraceError = new Error('STACK_TRACE_ERROR')
-  const runner = getRunner()
   return getCurrentSuite<ExtraContext>().on(
     'beforeEach',
     Object.assign(
       withTimeout(
-        withFixtures(runner, fn),
+        withFixtures(fn),
         timeout ?? getDefaultHookTimeout(),
         true,
         stackTraceError,
@@ -185,11 +183,10 @@ export function afterEach<ExtraContext = object>(
   timeout?: number,
 ): void {
   assertTypes(fn, '"afterEach" callback', ['function'])
-  const runner = getRunner()
   return getCurrentSuite<ExtraContext>().on(
     'afterEach',
     withTimeout(
-      withFixtures(runner, fn),
+      withFixtures(fn),
       timeout ?? getDefaultHookTimeout(),
       true,
       new Error('STACK_TRACE_ERROR'),
@@ -351,11 +348,10 @@ export function aroundEach<ExtraContext = object>(
   assertTypes(fn, '"aroundEach" callback', ['function'])
   const stackTraceError = new Error('STACK_TRACE_ERROR')
   const resolvedTimeout = timeout ?? getDefaultHookTimeout()
-  const runner = getRunner()
 
   // Create a wrapper function that supports fixtures in the second argument (context)
   // withFixtures resolves fixtures into context, then we call fn with all 3 args
-  const wrappedFn: AroundEachListener<ExtraContext> = withAroundEachFixtures(runner, fn)
+  const wrappedFn: AroundEachListener<ExtraContext> = withAroundEachFixtures(fn)
 
   // Store timeout and stack trace on the function for use in callAroundEachHooks
   // Setup and teardown phases will each have their own timeout
@@ -376,7 +372,6 @@ export function aroundEach<ExtraContext = object>(
  * - Third arg is suite
  */
 function withAroundEachFixtures<ExtraContext>(
-  runner: VitestRunner,
   fn: AroundEachListener<ExtraContext>,
 ): AroundEachListener<ExtraContext> {
   // Create the wrapper that will be returned
@@ -390,7 +385,7 @@ function withAroundEachFixtures<ExtraContext>(
     ;(innerFn as any).toString = () => fn.toString()
 
     // Use withFixtures to resolve fixtures, passing context as the hook context
-    const fixtureResolver = withFixtures(runner, innerFn)
+    const fixtureResolver = withFixtures(innerFn)
     return fixtureResolver(context)
   }
 

packages/runner/src/map.ts

@@ -22,7 +22,7 @@ export function setTestFixture(
   testFixtureMap.set(key, fixture)
 }
 
-export function getTestFixturesManager<Context = TestContext>(key: Context): TestFixtures {
+export function getTestFixtures<Context = TestContext>(key: Context): TestFixtures {
   return testFixtureMap.get(key as any)
 }
 

packages/runner/src/suite.ts

@@ -1,4 +1,4 @@
-import type { TestFixtureRecord } from './fixture'
+import type { UserFixtures } from './fixture'
 import type { VitestRunner } from './types/runner'
 import type {
   File,
@@ -413,7 +413,7 @@ function createSuiteCollector(
       setFn(
         task,
         withTimeout(
-          withAwaitAsyncAssertions(withFixtures(runner, handler, context), task),
+          withAwaitAsyncAssertions(withFixtures(handler, context), task),
           timeout,
           false,
           stackTraceError,
@@ -840,10 +840,10 @@ export function createTaskCollector(
    * Handles both builder pattern (name, options?, value) and object syntax.
    */
   function parseBuilderFixtures(
-    fixturesOrName: TestFixtureRecord | string,
+    fixturesOrName: UserFixtures | string,
     optionsOrFn?: object | ((...args: any[]) => any),
     maybeFn?: (...args: any[]) => any,
-  ): TestFixtureRecord {
+  ): UserFixtures {
     // Object syntax: just return as-is
     if (typeof fixturesOrName !== 'string') {
       return fixturesOrName
@@ -917,7 +917,7 @@ export function createTaskCollector(
 
   taskFn.override = function (
     this: TestAPI,
-    fixturesOrName: TestFixtureRecord | string,
+    fixturesOrName: UserFixtures | string,
     optionsOrFn?: object | ((...args: any[]) => any),
     maybeFn?: (...args: any[]) => any,
   ) {
@@ -926,14 +926,14 @@ export function createTaskCollector(
     return this
   }
 
-  taskFn.scoped = function (fixtures: TestFixtureRecord) {
+  taskFn.scoped = function (fixtures: UserFixtures) {
     console.warn(`test.scoped() is deprecated and will be removed in future versions. Please use test.override() instead.`)
     return this.override(fixtures)
   }
 
   taskFn.extend = function (
     this: TestAPI,
-    fixturesOrName: TestFixtureRecord | string,
+    fixturesOrName: UserFixtures | string,
     optionsOrFn?: object | ((...args: any[]) => any),
     maybeFn?: (...args: any[]) => any,
   ) {