playwright/packages/playwright-test/src/runner/uiMode.ts

/**
 * Copyright Microsoft Corporation. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import type { FullResult } from 'packages/playwright-test/reporter';
import type { Page } from 'playwright-core/lib/server/page';
import { showTraceViewer, serverSideCallMetadata } from 'playwright-core/lib/server';
import { clearCompilationCache } from '../common/compilationCache';
import type { FullConfigInternal } from '../common/types';
import ListReporter from '../reporters/list';
import { Multiplexer } from '../reporters/multiplexer';
import { TeleReporterEmitter } from '../reporters/teleEmitter';
import { createTaskRunnerForList, createTaskRunnerForWatch, createTaskRunnerForWatchSetup } from './tasks';
import type { TaskRunnerState } from './tasks';
import { createReporter } from './reporters';

export async function runUIMode(config: FullConfigInternal): Promise<FullResult['status']> {
  // Reset the settings that don't apply to watch.
  config._internal.passWithNoTests = true;
  for (const p of config.projects)
    p.retries = 0;

  {
    // Global setup.
    const reporter = await createReporter(config, 'watch');
    const taskRunner = createTaskRunnerForWatchSetup(config, reporter);
    reporter.onConfigure(config);
    const context: TaskRunnerState = {
      config,
      reporter,
      phases: [],
    };
    const { status, cleanup: globalCleanup } = await taskRunner.runDeferCleanup(context, 0);
    if (status !== 'passed')
      return await globalCleanup();
  }

  // Show trace viewer.
  const page = await showTraceViewer([], 'chromium', { watchMode: true });
  await page.mainFrame()._waitForFunctionExpression(serverSideCallMetadata(), '!!window.dispatch', false, undefined, { timeout: 0 });
  {
    // List
    const controller = new Controller(config, page);
    const listReporter = new TeleReporterEmitter(message => controller!.send(message));
    const reporter = new Multiplexer([listReporter]);
    const taskRunner = createTaskRunnerForList(config, reporter);
    const context: TaskRunnerState = {
      config,
      reporter,
      phases: [],
    };
    reporter.onConfigure(config);
    const { status, cleanup: globalCleanup } = await taskRunner.runDeferCleanup(context, 0);
    if (status !== 'passed')
      return await globalCleanup();
    await taskRunner.run(context, 0);
  }

  await new Promise(() => {});
  // TODO: implement watch queue with the sigint watcher and global teardown.
  return 'passed';
}


class Controller {
  private _page: Page;
  private _queue = Promise.resolve();
  private _runReporter: TeleReporterEmitter;

  constructor(config: FullConfigInternal, page: Page) {
    this._page = page;
    this._runReporter = new TeleReporterEmitter(message => this!.send(message));
    this._page.exposeBinding('binding', false, (source, data) => {
      const { method, params } = data;
      if (method === 'run') {
        const { location, testIds } = params;
        if (location)
          config._internal.cliArgs = [location];
        if (testIds) {
          const testIdSet = testIds ? new Set<string>(testIds) : null;
          config._internal.testIdMatcher = id => !testIdSet || testIdSet.has(id);
        }
        this._queue = this._queue.then(() => runTests(config, this._runReporter));
        return this._queue;
      }
    });
  }

  send(message: any) {
    const func = (message: any) => {
      (window as any).dispatch(message);
    };
    // eslint-disable-next-line no-console
    this._page.mainFrame().evaluateExpression(String(func), true, message).catch(e => console.log(e));
  }
}

async function runTests(config: FullConfigInternal, teleReporter: TeleReporterEmitter) {
  const reporter = new Multiplexer([new ListReporter(), teleReporter]);
  config._internal.configCLIOverrides.use = config._internal.configCLIOverrides.use || {};
  config._internal.configCLIOverrides.use.trace = 'on';

  const taskRunner = createTaskRunnerForWatch(config, reporter);
  const context: TaskRunnerState = {
    config,
    reporter,
    phases: [],
  };
  clearCompilationCache();
  reporter.onConfigure(config);
  const status = await taskRunner.run(context, 0);
  await reporter.onExit({ status });
}