mirror of
https://github.com/microsoft/playwright.git
synced 2025-06-26 21:40:17 +00:00
f5ecbff16e
This patch: - removes `browserType.downloadBrowserIfNeeded()` method. The method turned out to be ill-behaving and cannot not be used as we'd like to (see #1085) - adds a `browserType.setExecutablePath` method to set a browser exectuable. With this patch, we take the following approach towards managing browser downloads: - `playwright-core` doesn't download any browsers. In `playwright-core`, `playwright.chromium.executablePath()` returns `null` (same for firefox and webkit). - clients of `playwright-core` (e.g. `playwright` and others) download browsers one way or another. They can then configure `playwright` with executable paths and re-export the `playwright` object to their clients. - `playwright`, `playwright-firefox`, `playwright-chromium` and `playwright-webkit` download browsers. Once browsers are downloaded, their executable paths are saved to a `.downloaded-browsers.json` file. This file is read in `playwright/index.js` to configure browser executable paths and re-export the API. - special case is `install-from-github.js` that also cleans up old browsers.
50 lines
1.6 KiB
TypeScript
50 lines
1.6 KiB
TypeScript
/**
|
|
* 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.
|
|
*/
|
|
|
|
import { Browser, ConnectOptions } from '../browser';
|
|
import { BrowserContext } from '../browserContext';
|
|
import { BrowserServer } from './browserServer';
|
|
|
|
export type BrowserArgOptions = {
|
|
headless?: boolean,
|
|
args?: string[],
|
|
devtools?: boolean,
|
|
};
|
|
|
|
export type LaunchOptions = BrowserArgOptions & {
|
|
executablePath?: string,
|
|
ignoreDefaultArgs?: boolean | string[],
|
|
handleSIGINT?: boolean,
|
|
handleSIGTERM?: boolean,
|
|
handleSIGHUP?: boolean,
|
|
timeout?: number,
|
|
/**
|
|
* Whether to dump stdio of the browser, this is useful for example when
|
|
* diagnosing browser launch issues.
|
|
*/
|
|
dumpio?: boolean,
|
|
env?: {[key: string]: string} | undefined
|
|
};
|
|
|
|
export interface BrowserType {
|
|
executablePath(): string;
|
|
name(): string;
|
|
launch(options?: LaunchOptions & { slowMo?: number }): Promise<Browser>;
|
|
launchServer(options?: LaunchOptions & { port?: number }): Promise<BrowserServer>;
|
|
launchPersistentContext(userDataDir: string, options?: LaunchOptions): Promise<BrowserContext>;
|
|
connect(options: ConnectOptions): Promise<Browser>;
|
|
}
|