mirror of
https://github.com/microsoft/playwright.git
synced 2025-06-26 21:40:17 +00:00
382 lines
16 KiB
TypeScript
382 lines
16 KiB
TypeScript
/**
|
|
* Copyright 2018 Google Inc. All rights reserved.
|
|
* Modifications 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 { kBrowserClosedError } from '../../common/errors';
|
|
import { assert } from '../../utils';
|
|
import type { BrowserOptions } from '../browser';
|
|
import { Browser } from '../browser';
|
|
import { assertBrowserContextIsNotOwned, BrowserContext, verifyGeolocation } from '../browserContext';
|
|
import * as network from '../network';
|
|
import type { Page, PageBinding, PageDelegate } from '../page';
|
|
import type { ConnectionTransport } from '../transport';
|
|
import type * as types from '../types';
|
|
import { ConnectionEvents, FFConnection } from './ffConnection';
|
|
import { FFPage } from './ffPage';
|
|
import type { Protocol } from './protocol';
|
|
|
|
export class FFBrowser extends Browser {
|
|
_connection: FFConnection;
|
|
readonly _ffPages: Map<string, FFPage>;
|
|
readonly _contexts: Map<string, FFBrowserContext>;
|
|
private _version = '';
|
|
private _userAgent: string = '';
|
|
|
|
static async connect(transport: ConnectionTransport, options: BrowserOptions): Promise<FFBrowser> {
|
|
const connection = new FFConnection(transport, options.protocolLogger, options.browserLogsCollector);
|
|
const browser = new FFBrowser(connection, options);
|
|
if ((options as any).__testHookOnConnectToBrowser)
|
|
await (options as any).__testHookOnConnectToBrowser();
|
|
const promises: Promise<any>[] = [
|
|
connection.send('Browser.enable', { attachToDefaultContext: !!options.persistent }),
|
|
browser._initVersion(),
|
|
];
|
|
if (options.persistent) {
|
|
browser._defaultContext = new FFBrowserContext(browser, undefined, options.persistent);
|
|
promises.push((browser._defaultContext as FFBrowserContext)._initialize());
|
|
}
|
|
if (options.proxy)
|
|
promises.push(browser._connection.send('Browser.setBrowserProxy', toJugglerProxyOptions(options.proxy)));
|
|
await Promise.all(promises);
|
|
return browser;
|
|
}
|
|
|
|
constructor(connection: FFConnection, options: BrowserOptions) {
|
|
super(options);
|
|
this._connection = connection;
|
|
this._ffPages = new Map();
|
|
this._contexts = new Map();
|
|
this._connection.on(ConnectionEvents.Disconnected, () => this._onDisconnect());
|
|
this._connection.on('Browser.attachedToTarget', this._onAttachedToTarget.bind(this));
|
|
this._connection.on('Browser.detachedFromTarget', this._onDetachedFromTarget.bind(this));
|
|
this._connection.on('Browser.downloadCreated', this._onDownloadCreated.bind(this));
|
|
this._connection.on('Browser.downloadFinished', this._onDownloadFinished.bind(this));
|
|
this._connection.on('Browser.videoRecordingFinished', this._onVideoRecordingFinished.bind(this));
|
|
}
|
|
|
|
async _initVersion() {
|
|
const result = await this._connection.send('Browser.getInfo');
|
|
this._version = result.version.substring(result.version.indexOf('/') + 1);
|
|
this._userAgent = result.userAgent;
|
|
}
|
|
|
|
isConnected(): boolean {
|
|
return !this._connection._closed;
|
|
}
|
|
|
|
async doCreateNewContext(options: types.BrowserContextOptions): Promise<BrowserContext> {
|
|
if (options.isMobile)
|
|
throw new Error('options.isMobile is not supported in Firefox');
|
|
const { browserContextId } = await this._connection.send('Browser.createBrowserContext', { removeOnDetach: true });
|
|
const context = new FFBrowserContext(this, browserContextId, options);
|
|
await context._initialize();
|
|
this._contexts.set(browserContextId, context);
|
|
return context;
|
|
}
|
|
|
|
contexts(): BrowserContext[] {
|
|
return Array.from(this._contexts.values());
|
|
}
|
|
|
|
version(): string {
|
|
return this._version;
|
|
}
|
|
|
|
userAgent(): string {
|
|
return this._userAgent;
|
|
}
|
|
|
|
_onDetachedFromTarget(payload: Protocol.Browser.detachedFromTargetPayload) {
|
|
const ffPage = this._ffPages.get(payload.targetId)!;
|
|
this._ffPages.delete(payload.targetId);
|
|
ffPage.didClose();
|
|
}
|
|
|
|
_onAttachedToTarget(payload: Protocol.Browser.attachedToTargetPayload) {
|
|
const { targetId, browserContextId, openerId, type } = payload.targetInfo;
|
|
assert(type === 'page');
|
|
const context = browserContextId ? this._contexts.get(browserContextId)! : this._defaultContext as FFBrowserContext;
|
|
assert(context, `Unknown context id:${browserContextId}, _defaultContext: ${this._defaultContext}`);
|
|
const session = this._connection.createSession(payload.sessionId);
|
|
const opener = openerId ? this._ffPages.get(openerId)! : null;
|
|
const ffPage = new FFPage(session, context, opener);
|
|
this._ffPages.set(targetId, ffPage);
|
|
}
|
|
|
|
_onDownloadCreated(payload: Protocol.Browser.downloadCreatedPayload) {
|
|
const ffPage = this._ffPages.get(payload.pageTargetId)!;
|
|
assert(ffPage);
|
|
if (!ffPage)
|
|
return;
|
|
let originPage = ffPage._initializedPage;
|
|
// If it's a new window download, report it on the opener page.
|
|
if (!originPage) {
|
|
// Resume the page creation with an error. The page will automatically close right
|
|
// after the download begins.
|
|
ffPage._markAsError(new Error('Starting new page download'));
|
|
if (ffPage._opener)
|
|
originPage = ffPage._opener._initializedPage;
|
|
}
|
|
if (!originPage)
|
|
return;
|
|
this._downloadCreated(originPage, payload.uuid, payload.url, payload.suggestedFileName);
|
|
}
|
|
|
|
_onDownloadFinished(payload: Protocol.Browser.downloadFinishedPayload) {
|
|
const error = payload.canceled ? 'canceled' : payload.error;
|
|
this._downloadFinished(payload.uuid, error);
|
|
}
|
|
|
|
_onVideoRecordingFinished(payload: Protocol.Browser.videoRecordingFinishedPayload) {
|
|
this._takeVideo(payload.screencastId)?.reportFinished();
|
|
}
|
|
|
|
_onDisconnect() {
|
|
for (const video of this._idToVideo.values())
|
|
video.artifact.reportFinished(kBrowserClosedError);
|
|
this._idToVideo.clear();
|
|
this._didClose();
|
|
}
|
|
}
|
|
|
|
export class FFBrowserContext extends BrowserContext {
|
|
declare readonly _browser: FFBrowser;
|
|
|
|
constructor(browser: FFBrowser, browserContextId: string | undefined, options: types.BrowserContextOptions) {
|
|
super(browser, options, browserContextId);
|
|
}
|
|
|
|
override async _initialize() {
|
|
assert(!this._ffPages().length);
|
|
const browserContextId = this._browserContextId;
|
|
const promises: Promise<any>[] = [ super._initialize() ];
|
|
promises.push(this._browser._connection.send('Browser.setDownloadOptions', {
|
|
browserContextId,
|
|
downloadOptions: {
|
|
behavior: this._options.acceptDownloads ? 'saveToDisk' : 'cancel',
|
|
downloadsDir: this._browser.options.downloadsPath,
|
|
},
|
|
}));
|
|
if (this._options.viewport) {
|
|
const viewport = {
|
|
viewportSize: { width: this._options.viewport.width, height: this._options.viewport.height },
|
|
deviceScaleFactor: this._options.deviceScaleFactor || 1,
|
|
};
|
|
promises.push(this._browser._connection.send('Browser.setDefaultViewport', { browserContextId, viewport }));
|
|
}
|
|
if (this._options.hasTouch)
|
|
promises.push(this._browser._connection.send('Browser.setTouchOverride', { browserContextId, hasTouch: true }));
|
|
if (this._options.userAgent)
|
|
promises.push(this._browser._connection.send('Browser.setUserAgentOverride', { browserContextId, userAgent: this._options.userAgent }));
|
|
if (this._options.bypassCSP)
|
|
promises.push(this._browser._connection.send('Browser.setBypassCSP', { browserContextId, bypassCSP: true }));
|
|
if (this._options.ignoreHTTPSErrors)
|
|
promises.push(this._browser._connection.send('Browser.setIgnoreHTTPSErrors', { browserContextId, ignoreHTTPSErrors: true }));
|
|
if (this._options.javaScriptEnabled === false)
|
|
promises.push(this._browser._connection.send('Browser.setJavaScriptDisabled', { browserContextId, javaScriptDisabled: true }));
|
|
if (this._options.locale)
|
|
promises.push(this._browser._connection.send('Browser.setLocaleOverride', { browserContextId, locale: this._options.locale }));
|
|
if (this._options.timezoneId)
|
|
promises.push(this._browser._connection.send('Browser.setTimezoneOverride', { browserContextId, timezoneId: this._options.timezoneId }));
|
|
if (this._options.permissions)
|
|
promises.push(this.grantPermissions(this._options.permissions));
|
|
if (this._options.extraHTTPHeaders || this._options.locale)
|
|
promises.push(this.setExtraHTTPHeaders(this._options.extraHTTPHeaders || []));
|
|
if (this._options.httpCredentials)
|
|
promises.push(this.setHTTPCredentials(this._options.httpCredentials));
|
|
if (this._options.geolocation)
|
|
promises.push(this.setGeolocation(this._options.geolocation));
|
|
if (this._options.offline)
|
|
promises.push(this.setOffline(this._options.offline));
|
|
promises.push(this._browser._connection.send('Browser.setColorScheme', {
|
|
browserContextId,
|
|
colorScheme: this._options.colorScheme !== undefined ? this._options.colorScheme : 'light',
|
|
}));
|
|
promises.push(this._browser._connection.send('Browser.setReducedMotion', {
|
|
browserContextId,
|
|
reducedMotion: this._options.reducedMotion !== undefined ? this._options.reducedMotion : 'no-preference',
|
|
}));
|
|
promises.push(this._browser._connection.send('Browser.setForcedColors', {
|
|
browserContextId,
|
|
forcedColors: this._options.forcedColors !== undefined ? this._options.forcedColors : 'none',
|
|
}));
|
|
if (this._options.recordVideo) {
|
|
promises.push(this._ensureVideosPath().then(() => {
|
|
return this._browser._connection.send('Browser.setVideoRecordingOptions', {
|
|
// validateBrowserContextOptions ensures correct video size.
|
|
options: {
|
|
...this._options.recordVideo!.size!,
|
|
dir: this._options.recordVideo!.dir,
|
|
},
|
|
browserContextId: this._browserContextId
|
|
});
|
|
}));
|
|
}
|
|
if (this._options.proxy) {
|
|
promises.push(this._browser._connection.send('Browser.setContextProxy', {
|
|
browserContextId: this._browserContextId,
|
|
...toJugglerProxyOptions(this._options.proxy)
|
|
}));
|
|
}
|
|
|
|
await Promise.all(promises);
|
|
}
|
|
|
|
_ffPages(): FFPage[] {
|
|
return Array.from(this._browser._ffPages.values()).filter(ffPage => ffPage._browserContext === this);
|
|
}
|
|
|
|
pages(): Page[] {
|
|
return this._ffPages().map(ffPage => ffPage._initializedPage).filter(pageOrNull => !!pageOrNull) as Page[];
|
|
}
|
|
|
|
async newPageDelegate(): Promise<PageDelegate> {
|
|
assertBrowserContextIsNotOwned(this);
|
|
const { targetId } = await this._browser._connection.send('Browser.newPage', {
|
|
browserContextId: this._browserContextId
|
|
}).catch(e => {
|
|
if (e.message.includes('Failed to override timezone'))
|
|
throw new Error(`Invalid timezone ID: ${this._options.timezoneId}`);
|
|
throw e;
|
|
});
|
|
return this._browser._ffPages.get(targetId)!;
|
|
}
|
|
|
|
async doGetCookies(urls: string[]): Promise<types.NetworkCookie[]> {
|
|
const { cookies } = await this._browser._connection.send('Browser.getCookies', { browserContextId: this._browserContextId });
|
|
return network.filterCookies(cookies.map(c => {
|
|
const copy: any = { ... c };
|
|
delete copy.size;
|
|
delete copy.session;
|
|
return copy as types.NetworkCookie;
|
|
}), urls);
|
|
}
|
|
|
|
async addCookies(cookies: types.SetNetworkCookieParam[]) {
|
|
const cc = network.rewriteCookies(cookies).map(c => ({
|
|
...c,
|
|
expires: c.expires && c.expires !== -1 ? c.expires : undefined,
|
|
}));
|
|
await this._browser._connection.send('Browser.setCookies', { browserContextId: this._browserContextId, cookies: cc });
|
|
}
|
|
|
|
async clearCookies() {
|
|
await this._browser._connection.send('Browser.clearCookies', { browserContextId: this._browserContextId });
|
|
}
|
|
|
|
async doGrantPermissions(origin: string, permissions: string[]) {
|
|
const webPermissionToProtocol = new Map<string, 'geo' | 'desktop-notification' | 'persistent-storage' | 'push'>([
|
|
['geolocation', 'geo'],
|
|
['persistent-storage', 'persistent-storage'],
|
|
['push', 'push'],
|
|
['notifications', 'desktop-notification'],
|
|
]);
|
|
const filtered = permissions.map(permission => {
|
|
const protocolPermission = webPermissionToProtocol.get(permission);
|
|
if (!protocolPermission)
|
|
throw new Error('Unknown permission: ' + permission);
|
|
return protocolPermission;
|
|
});
|
|
await this._browser._connection.send('Browser.grantPermissions', { origin: origin, browserContextId: this._browserContextId, permissions: filtered });
|
|
}
|
|
|
|
async doClearPermissions() {
|
|
await this._browser._connection.send('Browser.resetPermissions', { browserContextId: this._browserContextId });
|
|
}
|
|
|
|
async setGeolocation(geolocation?: types.Geolocation): Promise<void> {
|
|
verifyGeolocation(geolocation);
|
|
this._options.geolocation = geolocation;
|
|
await this._browser._connection.send('Browser.setGeolocationOverride', { browserContextId: this._browserContextId, geolocation: geolocation || null });
|
|
}
|
|
|
|
async setExtraHTTPHeaders(headers: types.HeadersArray): Promise<void> {
|
|
this._options.extraHTTPHeaders = headers;
|
|
let allHeaders = this._options.extraHTTPHeaders;
|
|
if (this._options.locale)
|
|
allHeaders = network.mergeHeaders([allHeaders, network.singleHeader('Accept-Language', this._options.locale)]);
|
|
await this._browser._connection.send('Browser.setExtraHTTPHeaders', { browserContextId: this._browserContextId, headers: allHeaders });
|
|
}
|
|
|
|
async setOffline(offline: boolean): Promise<void> {
|
|
this._options.offline = offline;
|
|
await this._browser._connection.send('Browser.setOnlineOverride', { browserContextId: this._browserContextId, override: offline ? 'offline' : 'online' });
|
|
}
|
|
|
|
async doSetHTTPCredentials(httpCredentials?: types.Credentials): Promise<void> {
|
|
this._options.httpCredentials = httpCredentials;
|
|
await this._browser._connection.send('Browser.setHTTPCredentials', { browserContextId: this._browserContextId, credentials: httpCredentials || null });
|
|
}
|
|
|
|
async doAddInitScript(source: string) {
|
|
await this._browser._connection.send('Browser.setInitScripts', { browserContextId: this._browserContextId, scripts: this.initScripts.map(script => ({ script })) });
|
|
}
|
|
|
|
async doRemoveInitScripts() {
|
|
await this._browser._connection.send('Browser.setInitScripts', { browserContextId: this._browserContextId, scripts: [] });
|
|
}
|
|
|
|
async doExposeBinding(binding: PageBinding) {
|
|
await this._browser._connection.send('Browser.addBinding', { browserContextId: this._browserContextId, name: binding.name, script: binding.source });
|
|
}
|
|
|
|
async doRemoveExposedBindings() {
|
|
// TODO: implement me.
|
|
}
|
|
|
|
async doUpdateRequestInterception(): Promise<void> {
|
|
await this._browser._connection.send('Browser.setRequestInterception', { browserContextId: this._browserContextId, enabled: !!this._requestInterceptor });
|
|
}
|
|
|
|
onClosePersistent() {}
|
|
|
|
async doClose() {
|
|
assert(this._browserContextId);
|
|
await this._browser._connection.send('Browser.removeBrowserContext', { browserContextId: this._browserContextId });
|
|
this._browser._contexts.delete(this._browserContextId);
|
|
}
|
|
|
|
async cancelDownload(uuid: string) {
|
|
await this._browser._connection.send('Browser.cancelDownload', { uuid });
|
|
}
|
|
}
|
|
|
|
function toJugglerProxyOptions(proxy: types.ProxySettings) {
|
|
const proxyServer = new URL(proxy.server);
|
|
let port = parseInt(proxyServer.port, 10);
|
|
let type: 'http' | 'https' | 'socks' | 'socks4' = 'http';
|
|
if (proxyServer.protocol === 'socks5:')
|
|
type = 'socks';
|
|
else if (proxyServer.protocol === 'socks4:')
|
|
type = 'socks4';
|
|
else if (proxyServer.protocol === 'https:')
|
|
type = 'https';
|
|
if (proxyServer.port === '') {
|
|
if (proxyServer.protocol === 'http:')
|
|
port = 80;
|
|
else if (proxyServer.protocol === 'https:')
|
|
port = 443;
|
|
}
|
|
return {
|
|
type,
|
|
bypass: proxy.bypass ? proxy.bypass.split(',').map(domain => domain.trim()) : [],
|
|
host: proxyServer.hostname,
|
|
port,
|
|
username: proxy.username,
|
|
password: proxy.password
|
|
};
|
|
}
|