Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

4.0 KB
Raw Blame
/**
 * Copyright (c) Microsoft Corporation.
 *
 * 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.
 */

/* eslint-disable no-console */

import fs from 'fs';

import { PipeTransport } from '@utils/pipeTransport';
import { gracefullyProcessExitDoNotHang } from '@utils/processLauncher';
import { playwright } from '../inprocess';
import { PlaywrightServer } from '../remote/playwrightServer';
import { DispatcherConnection, PlaywrightDispatcher, RootDispatcher, createPlaywright } from '../server';

import type { BrowserType } from '../client/browserType';
import type { LaunchServerOptions } from '../client/types';

export function runDriver() {
  const dispatcherConnection = new DispatcherConnection();
  // Certain Language Binding JSON parsers (e.g. .NET) do not like strings with lone surrogates.
  // The client tells us whether it supports them when it initializes.
  let replacer: ((key: string, value: any) => any) | undefined;
  new RootDispatcher(dispatcherConnection, async (rootScope, { sdkLanguage, supportsLoneSurrogates }) => {
    if (!supportsLoneSurrogates)
      replacer = (key, value) => typeof value === 'string' ? value.toWellFormed() : value;
    const playwright = createPlaywright({ sdkLanguage, isClientCollocatedWithServer: true });
    return new PlaywrightDispatcher(rootScope, playwright);
  });
  // eslint-disable-next-line no-restricted-properties
  const transport = new PipeTransport(process.stdout, process.stdin);
  // The client may exit while messages are still in flight. Ignore the EPIPE so the
  // driver keeps running until stdin closes, and then closes the browsers gracefully.
  // eslint-disable-next-line no-restricted-properties
  process.stdout.on('error', () => {});
  transport.onmessage = (message: string) => dispatcherConnection.dispatch(JSON.parse(message));
  dispatcherConnection.onmessage = message => transport.send(JSON.stringify(message, replacer));
  transport.onclose = () => {
    // Drop any messages during shutdown on the floor.
    dispatcherConnection.onmessage = () => {};
    gracefullyProcessExitDoNotHang(0);
  };
  // Ignore the SIGINT signal in the driver process so the parent can gracefully close the connection.
  // We still will destruct everything (close browsers and exit) when the transport pipe closes.
  process.on('SIGINT', () => {
    // Keep the process running.
  });
}

export type RunServerOptions = {
  port?: number,
  host?: string,
  path?: string,
  extension?: boolean,
  maxConnections?: number,
  browserProxyMode?: 'client' | 'tether',
  ownedByTetherClient?: boolean,
  artifactsDir?: string,
  unsafe?: boolean,
};

export async function runServer(options: RunServerOptions) {
  const {
    port,
    host,
    path = '/',
    maxConnections = Infinity,
    extension,
    artifactsDir,
    unsafe,
  } = options;
  const server = new PlaywrightServer({ mode: extension ? 'extension' : 'default', path, maxConnections, artifactsDir, unsafe });
  const wsEndpoint = await server.listen(port, host);
  process.on('exit', () => server.close().catch(console.error));
  console.log('Listening on ' + wsEndpoint);
  process.stdin.on('close', () => gracefullyProcessExitDoNotHang(0));
}

export async function launchBrowserServer(browserName: string, configFile?: string) {
  let options: LaunchServerOptions = {};
  if (configFile)
    options = JSON.parse(fs.readFileSync(configFile).toString());
  const browserType = (playwright as any)[browserName] as BrowserType;
  const server = await browserType.launchServer(options);
  console.log(server.wsEndpoint());
}