Class DebugController

packages/playwright-core/src/server/debugController.ts:36–178

import type * as actions from '@recorder/actions';

export class DebugController extends SdkObject {
  static Events = {
    StateChanged: 'stateChanged',
    InspectRequested: 'inspectRequested',
    SourceChanged: 'sourceChanged',
    Paused: 'paused',
    SetModeRequested: 'setModeRequested',
  };

  private _trackHierarchyListener: InstrumentationListener | undefined;
  private _playwright: Playwright;
  _sdkLanguage: Language = 'javascript';
  _generateAutoExpect = false;

  constructor(playwright: Playwright) {
    super({ attribution: { isInternalPlaywright: true }, instrumentation: createInstrumentation() } as any, undefined, 'DebugController');
    this._playwright = playwright;
  }

  initialize(progress: Progress, codegenId: string, sdkLanguage: Language) {
    this._sdkLanguage = sdkLanguage;
  }

  dispose() {
    this._setReportStateChanged(false);
  }

  setReportStateChanged(progress: Progress, enabled: boolean) {
    this._setReportStateChanged(enabled);
  }

  private _setReportStateChanged(enabled: boolean) {
    if (enabled && !this._trackHierarchyListener) {
      this._trackHierarchyListener = {
        onPageOpen: () => this._emitSnapshot(false),
        onPageClose: () => this._emitSnapshot(false),
      };
      this._playwright.instrumentation.addListener(this._trackHierarchyListener, null);
      this._emitSnapshot(true);
    } else if (!enabled && this._trackHierarchyListener) {
      this._playwright.instrumentation.removeListener(this._trackHierarchyListener);
      this._trackHierarchyListener = undefined;
    }
  }

  async setRecorderMode(progress: Progress, params: { mode: Mode, testIdAttributeName?: string, generateAutoExpect?: boolean }) {
    await this._closeBrowsersWithoutPages(progress);
    this._generateAutoExpect = !!params.generateAutoExpect;

    if (params.mode === 'none') {
      const promises = [];
      for (const recorder of await progress.race(this._allRecorders())) {
        promises.push(recorder.hideHighlightedSelector());
        promises.push(recorder.setMode('none'));
      }
      await progress.race(Promise.all(promises));
      return;
    }