Class Fixture

packages/playwright/src/worker/fixtureRunner.ts:28–179

import type { Location } from '../../types/testReporter';

class Fixture {
  runner: FixtureRunner;
  registration: fixtures.FixtureRegistration;
  value: any;
  failed = false;

  private _useFuncFinished: ManualPromise<void> | undefined;
  private _selfTeardownComplete: Promise<void> | undefined;
  private _setupDescription: FixtureDescription;
  private _teardownDescription: FixtureDescription;
  private _stepInfo: { title: string, category: 'fixture', location?: Location, group?: string } | undefined;
  _deps = new Set<Fixture>();
  _usages = new Set<Fixture>();

  constructor(runner: FixtureRunner, registration: fixtures.FixtureRegistration) {
    this.runner = runner;
    this.registration = registration;
    this.value = null;
    const isUserFixture = this.registration.location && filterStackFile(this.registration.location.file);
    const title = this.registration.customTitle || this.registration.name;
    const location = isUserFixture ? this.registration.location : undefined;
    this._stepInfo = { title: `Fixture ${escapeWithQuotes(title, '"')}`, category: 'fixture', location };
    if (this.registration.box === 'self')
      this._stepInfo = undefined;
    else if (this.registration.box)
      this._stepInfo.group = isUserFixture ? 'configuration' : 'internal';
    this._setupDescription = {
      title,
      phase: 'setup',
      location,
      slot: this.registration.timeout !== undefined ? {
        timeout: this.registration.timeout,
        elapsed: 0,
      } : this.registration.scope === 'worker' ? {
        timeout: this.runner.workerFixtureTimeout,
        elapsed: 0,
      } : undefined,
    };
    this._teardownDescription = { ...this._setupDescription, phase: 'teardown' };
  }

  async setup(testInfo: TestInfoImpl, runnable: RunnableDescription) {
    this.runner.instanceForId.set(this.registration.id, this);

    if (typeof this.registration.fn !== 'function') {
      this.value = this.registration.fn;
      return;
    }

    const run = () => testInfo._runWithTimeout({ ...runnable, fixture: this._setupDescription }, () => this._setupInternal(testInfo));
    if (this._stepInfo)
      await testInfo._runAsStep(this._stepInfo, run);
    else
      await run();
  }

  private async _setupInternal(testInfo: TestInfoImpl) {
    const params: { [key: string]: any } = {};