2020-04-28 12:26:37 +00:00
|
|
|
/**
|
|
|
|
* Copyright 2017 Google Inc. 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.
|
|
|
|
*/
|
|
|
|
|
2020-05-07 10:54:55 +00:00
|
|
|
import { helper, assert } from './helper';
|
|
|
|
import { Target } from './Target';
|
2020-06-02 08:32:02 +00:00
|
|
|
import * as EventEmitter from 'events';
|
2020-05-07 10:54:55 +00:00
|
|
|
import { Events } from './Events';
|
2020-05-21 16:04:05 +00:00
|
|
|
import Protocol from './protocol';
|
2020-05-07 10:54:55 +00:00
|
|
|
import { Connection } from './Connection';
|
|
|
|
import { Page } from './Page';
|
|
|
|
import { ChildProcess } from 'child_process';
|
2020-06-04 10:47:13 +00:00
|
|
|
import { Viewport } from './PuppeteerViewport';
|
2020-04-28 12:26:37 +00:00
|
|
|
|
|
|
|
type BrowserCloseCallback = () => Promise<void> | void;
|
|
|
|
|
|
|
|
export class Browser extends EventEmitter {
|
2020-05-07 10:54:55 +00:00
|
|
|
static async create(
|
|
|
|
connection: Connection,
|
|
|
|
contextIds: string[],
|
|
|
|
ignoreHTTPSErrors: boolean,
|
|
|
|
defaultViewport?: Viewport,
|
|
|
|
process?: ChildProcess,
|
|
|
|
closeCallback?: BrowserCloseCallback
|
|
|
|
): Promise<Browser> {
|
|
|
|
const browser = new Browser(
|
|
|
|
connection,
|
|
|
|
contextIds,
|
|
|
|
ignoreHTTPSErrors,
|
|
|
|
defaultViewport,
|
|
|
|
process,
|
|
|
|
closeCallback
|
|
|
|
);
|
|
|
|
await connection.send('Target.setDiscoverTargets', { discover: true });
|
2020-04-28 12:26:37 +00:00
|
|
|
return browser;
|
|
|
|
}
|
2020-05-07 10:54:55 +00:00
|
|
|
_ignoreHTTPSErrors: boolean;
|
|
|
|
_defaultViewport?: Viewport;
|
|
|
|
_process?: ChildProcess;
|
|
|
|
_connection: Connection;
|
|
|
|
_closeCallback: BrowserCloseCallback;
|
|
|
|
_defaultContext: BrowserContext;
|
|
|
|
_contexts: Map<string, BrowserContext>;
|
|
|
|
// TODO: once Target is in TypeScript we can type this properly.
|
|
|
|
_targets: Map<string, Target>;
|
|
|
|
|
|
|
|
constructor(
|
|
|
|
connection: Connection,
|
|
|
|
contextIds: string[],
|
|
|
|
ignoreHTTPSErrors: boolean,
|
|
|
|
defaultViewport?: Viewport,
|
|
|
|
process?: ChildProcess,
|
|
|
|
closeCallback?: BrowserCloseCallback
|
|
|
|
) {
|
|
|
|
super();
|
|
|
|
this._ignoreHTTPSErrors = ignoreHTTPSErrors;
|
|
|
|
this._defaultViewport = defaultViewport;
|
|
|
|
this._process = process;
|
|
|
|
this._connection = connection;
|
|
|
|
this._closeCallback = closeCallback || function (): void {};
|
|
|
|
|
|
|
|
this._defaultContext = new BrowserContext(this._connection, this, null);
|
|
|
|
this._contexts = new Map();
|
|
|
|
for (const contextId of contextIds)
|
|
|
|
this._contexts.set(
|
|
|
|
contextId,
|
|
|
|
new BrowserContext(this._connection, this, contextId)
|
|
|
|
);
|
|
|
|
|
|
|
|
this._targets = new Map();
|
|
|
|
this._connection.on(Events.Connection.Disconnected, () =>
|
|
|
|
this.emit(Events.Browser.Disconnected)
|
|
|
|
);
|
|
|
|
this._connection.on('Target.targetCreated', this._targetCreated.bind(this));
|
|
|
|
this._connection.on(
|
|
|
|
'Target.targetDestroyed',
|
|
|
|
this._targetDestroyed.bind(this)
|
|
|
|
);
|
|
|
|
this._connection.on(
|
|
|
|
'Target.targetInfoChanged',
|
|
|
|
this._targetInfoChanged.bind(this)
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
process(): ChildProcess | null {
|
|
|
|
return this._process;
|
|
|
|
}
|
|
|
|
|
|
|
|
async createIncognitoBrowserContext(): Promise<BrowserContext> {
|
|
|
|
const { browserContextId } = await this._connection.send(
|
|
|
|
'Target.createBrowserContext'
|
|
|
|
);
|
|
|
|
const context = new BrowserContext(
|
|
|
|
this._connection,
|
|
|
|
this,
|
|
|
|
browserContextId
|
|
|
|
);
|
|
|
|
this._contexts.set(browserContextId, context);
|
|
|
|
return context;
|
|
|
|
}
|
|
|
|
|
|
|
|
browserContexts(): BrowserContext[] {
|
|
|
|
return [this._defaultContext, ...Array.from(this._contexts.values())];
|
|
|
|
}
|
|
|
|
|
|
|
|
defaultBrowserContext(): BrowserContext {
|
|
|
|
return this._defaultContext;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-04-28 12:26:37 +00:00
|
|
|
* @param {?string} contextId
|
|
|
|
*/
|
2020-05-07 10:54:55 +00:00
|
|
|
async _disposeContext(contextId?: string): Promise<void> {
|
|
|
|
await this._connection.send('Target.disposeBrowserContext', {
|
|
|
|
browserContextId: contextId || undefined,
|
|
|
|
});
|
|
|
|
this._contexts.delete(contextId);
|
|
|
|
}
|
|
|
|
|
|
|
|
async _targetCreated(
|
|
|
|
event: Protocol.Target.targetCreatedPayload
|
|
|
|
): Promise<void> {
|
|
|
|
const targetInfo = event.targetInfo;
|
|
|
|
const { browserContextId } = targetInfo;
|
|
|
|
const context =
|
|
|
|
browserContextId && this._contexts.has(browserContextId)
|
|
|
|
? this._contexts.get(browserContextId)
|
|
|
|
: this._defaultContext;
|
|
|
|
|
|
|
|
const target = new Target(
|
|
|
|
targetInfo,
|
|
|
|
context,
|
|
|
|
() => this._connection.createSession(targetInfo),
|
|
|
|
this._ignoreHTTPSErrors,
|
2020-05-07 13:49:42 +00:00
|
|
|
this._defaultViewport
|
2020-05-07 10:54:55 +00:00
|
|
|
);
|
|
|
|
assert(
|
|
|
|
!this._targets.has(event.targetInfo.targetId),
|
|
|
|
'Target should not exist before targetCreated'
|
|
|
|
);
|
|
|
|
this._targets.set(event.targetInfo.targetId, target);
|
|
|
|
|
|
|
|
if (await target._initializedPromise) {
|
|
|
|
this.emit(Events.Browser.TargetCreated, target);
|
|
|
|
context.emit(Events.BrowserContext.TargetCreated, target);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-04-28 12:26:37 +00:00
|
|
|
* @param {{targetId: string}} event
|
|
|
|
*/
|
2020-05-07 10:54:55 +00:00
|
|
|
async _targetDestroyed(event: { targetId: string }): Promise<void> {
|
|
|
|
const target = this._targets.get(event.targetId);
|
|
|
|
target._initializedCallback(false);
|
|
|
|
this._targets.delete(event.targetId);
|
|
|
|
target._closedCallback();
|
|
|
|
if (await target._initializedPromise) {
|
|
|
|
this.emit(Events.Browser.TargetDestroyed, target);
|
|
|
|
target
|
|
|
|
.browserContext()
|
|
|
|
.emit(Events.BrowserContext.TargetDestroyed, target);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-04-28 12:26:37 +00:00
|
|
|
* @param {!Protocol.Target.targetInfoChangedPayload} event
|
|
|
|
*/
|
2020-05-07 10:54:55 +00:00
|
|
|
_targetInfoChanged(event: Protocol.Target.targetInfoChangedPayload): void {
|
|
|
|
const target = this._targets.get(event.targetInfo.targetId);
|
|
|
|
assert(target, 'target should exist before targetInfoChanged');
|
|
|
|
const previousURL = target.url();
|
|
|
|
const wasInitialized = target._isInitialized;
|
|
|
|
target._targetInfoChanged(event.targetInfo);
|
|
|
|
if (wasInitialized && previousURL !== target.url()) {
|
|
|
|
this.emit(Events.Browser.TargetChanged, target);
|
|
|
|
target.browserContext().emit(Events.BrowserContext.TargetChanged, target);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
wsEndpoint(): string {
|
|
|
|
return this._connection.url();
|
|
|
|
}
|
|
|
|
|
|
|
|
async newPage(): Promise<Page> {
|
|
|
|
return this._defaultContext.newPage();
|
|
|
|
}
|
|
|
|
|
|
|
|
async _createPageInContext(contextId?: string): Promise<Page> {
|
|
|
|
const { targetId } = await this._connection.send('Target.createTarget', {
|
|
|
|
url: 'about:blank',
|
|
|
|
browserContextId: contextId || undefined,
|
|
|
|
});
|
|
|
|
const target = await this._targets.get(targetId);
|
|
|
|
assert(
|
|
|
|
await target._initializedPromise,
|
|
|
|
'Failed to create target for page'
|
|
|
|
);
|
|
|
|
const page = await target.page();
|
|
|
|
return page;
|
|
|
|
}
|
|
|
|
|
|
|
|
targets(): Target[] {
|
|
|
|
return Array.from(this._targets.values()).filter(
|
|
|
|
(target) => target._isInitialized
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
target(): Target {
|
|
|
|
return this.targets().find((target) => target.type() === 'browser');
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-04-28 12:26:37 +00:00
|
|
|
* @param {function(!Target):boolean} predicate
|
|
|
|
* @param {{timeout?: number}=} options
|
2020-06-12 10:38:24 +00:00
|
|
|
* @returns {!Promise<!Target>}
|
2020-04-28 12:26:37 +00:00
|
|
|
*/
|
2020-05-07 10:54:55 +00:00
|
|
|
async waitForTarget(
|
|
|
|
predicate: (x: Target) => boolean,
|
|
|
|
options: { timeout?: number } = {}
|
|
|
|
): Promise<Target> {
|
|
|
|
const { timeout = 30000 } = options;
|
|
|
|
const existingTarget = this.targets().find(predicate);
|
|
|
|
if (existingTarget) return existingTarget;
|
|
|
|
let resolve;
|
|
|
|
const targetPromise = new Promise<Target>((x) => (resolve = x));
|
|
|
|
this.on(Events.Browser.TargetCreated, check);
|
|
|
|
this.on(Events.Browser.TargetChanged, check);
|
|
|
|
try {
|
|
|
|
if (!timeout) return await targetPromise;
|
|
|
|
return await helper.waitWithTimeout<Target>(
|
|
|
|
targetPromise,
|
|
|
|
'target',
|
|
|
|
timeout
|
|
|
|
);
|
|
|
|
} finally {
|
|
|
|
this.removeListener(Events.Browser.TargetCreated, check);
|
|
|
|
this.removeListener(Events.Browser.TargetChanged, check);
|
|
|
|
}
|
|
|
|
|
|
|
|
function check(target: Target): void {
|
|
|
|
if (predicate(target)) resolve(target);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
async pages(): Promise<Page[]> {
|
|
|
|
const contextPages = await Promise.all(
|
|
|
|
this.browserContexts().map((context) => context.pages())
|
|
|
|
);
|
|
|
|
// Flatten array.
|
|
|
|
return contextPages.reduce((acc, x) => acc.concat(x), []);
|
|
|
|
}
|
|
|
|
|
|
|
|
async version(): Promise<string> {
|
|
|
|
const version = await this._getVersion();
|
|
|
|
return version.product;
|
|
|
|
}
|
|
|
|
|
|
|
|
async userAgent(): Promise<string> {
|
|
|
|
const version = await this._getVersion();
|
|
|
|
return version.userAgent;
|
|
|
|
}
|
|
|
|
|
|
|
|
async close(): Promise<void> {
|
|
|
|
await this._closeCallback.call(null);
|
|
|
|
this.disconnect();
|
|
|
|
}
|
|
|
|
|
|
|
|
disconnect(): void {
|
|
|
|
this._connection.dispose();
|
|
|
|
}
|
|
|
|
|
|
|
|
isConnected(): boolean {
|
|
|
|
return !this._connection._closed;
|
|
|
|
}
|
|
|
|
|
|
|
|
_getVersion(): Promise<Protocol.Browser.getVersionReturnValue> {
|
|
|
|
return this._connection.send('Browser.getVersion');
|
|
|
|
}
|
2020-04-28 12:26:37 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
export class BrowserContext extends EventEmitter {
|
|
|
|
_connection: Connection;
|
|
|
|
_browser: Browser;
|
|
|
|
_id?: string;
|
|
|
|
|
|
|
|
constructor(connection: Connection, browser: Browser, contextId?: string) {
|
|
|
|
super();
|
|
|
|
this._connection = connection;
|
|
|
|
this._browser = browser;
|
|
|
|
this._id = contextId;
|
|
|
|
}
|
|
|
|
|
2020-04-29 14:18:09 +00:00
|
|
|
targets(): Target[] {
|
2020-05-07 10:54:55 +00:00
|
|
|
return this._browser
|
|
|
|
.targets()
|
|
|
|
.filter((target) => target.browserContext() === this);
|
2020-04-28 12:26:37 +00:00
|
|
|
}
|
|
|
|
|
2020-05-07 10:54:55 +00:00
|
|
|
waitForTarget(
|
|
|
|
predicate: (x: Target) => boolean,
|
|
|
|
options: { timeout?: number }
|
|
|
|
): Promise<Target> {
|
|
|
|
return this._browser.waitForTarget(
|
|
|
|
(target) => target.browserContext() === this && predicate(target),
|
|
|
|
options
|
|
|
|
);
|
2020-04-28 12:26:37 +00:00
|
|
|
}
|
|
|
|
|
2020-05-05 12:53:22 +00:00
|
|
|
async pages(): Promise<Page[]> {
|
2020-04-28 12:26:37 +00:00
|
|
|
const pages = await Promise.all(
|
2020-05-07 10:54:55 +00:00
|
|
|
this.targets()
|
|
|
|
.filter((target) => target.type() === 'page')
|
|
|
|
.map((target) => target.page())
|
2020-04-28 12:26:37 +00:00
|
|
|
);
|
2020-05-07 10:54:55 +00:00
|
|
|
return pages.filter((page) => !!page);
|
2020-04-28 12:26:37 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
isIncognito(): boolean {
|
|
|
|
return !!this._id;
|
|
|
|
}
|
|
|
|
|
2020-05-07 10:54:55 +00:00
|
|
|
async overridePermissions(
|
|
|
|
origin: string,
|
|
|
|
permissions: Protocol.Browser.PermissionType[]
|
|
|
|
): Promise<void> {
|
|
|
|
const webPermissionToProtocol = new Map<
|
|
|
|
string,
|
|
|
|
Protocol.Browser.PermissionType
|
|
|
|
>([
|
2020-04-28 12:26:37 +00:00
|
|
|
['geolocation', 'geolocation'],
|
|
|
|
['midi', 'midi'],
|
|
|
|
['notifications', 'notifications'],
|
|
|
|
// TODO: push isn't a valid type?
|
|
|
|
// ['push', 'push'],
|
|
|
|
['camera', 'videoCapture'],
|
|
|
|
['microphone', 'audioCapture'],
|
|
|
|
['background-sync', 'backgroundSync'],
|
|
|
|
['ambient-light-sensor', 'sensors'],
|
|
|
|
['accelerometer', 'sensors'],
|
|
|
|
['gyroscope', 'sensors'],
|
|
|
|
['magnetometer', 'sensors'],
|
|
|
|
['accessibility-events', 'accessibilityEvents'],
|
|
|
|
['clipboard-read', 'clipboardReadWrite'],
|
|
|
|
['clipboard-write', 'clipboardReadWrite'],
|
|
|
|
['payment-handler', 'paymentHandler'],
|
|
|
|
// chrome-specific permissions we have.
|
|
|
|
['midi-sysex', 'midiSysex'],
|
|
|
|
]);
|
2020-05-07 10:54:55 +00:00
|
|
|
permissions = permissions.map((permission) => {
|
2020-04-28 12:26:37 +00:00
|
|
|
const protocolPermission = webPermissionToProtocol.get(permission);
|
|
|
|
if (!protocolPermission)
|
|
|
|
throw new Error('Unknown permission: ' + permission);
|
|
|
|
return protocolPermission;
|
|
|
|
});
|
2020-05-07 10:54:55 +00:00
|
|
|
await this._connection.send('Browser.grantPermissions', {
|
|
|
|
origin,
|
|
|
|
browserContextId: this._id || undefined,
|
|
|
|
permissions,
|
|
|
|
});
|
2020-04-28 12:26:37 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
async clearPermissionOverrides(): Promise<void> {
|
2020-05-07 10:54:55 +00:00
|
|
|
await this._connection.send('Browser.resetPermissions', {
|
|
|
|
browserContextId: this._id || undefined,
|
|
|
|
});
|
2020-04-28 12:26:37 +00:00
|
|
|
}
|
|
|
|
|
2020-05-05 12:53:22 +00:00
|
|
|
newPage(): Promise<Page> {
|
2020-04-28 12:26:37 +00:00
|
|
|
return this._browser._createPageInContext(this._id);
|
|
|
|
}
|
|
|
|
|
|
|
|
browser(): Browser {
|
|
|
|
return this._browser;
|
|
|
|
}
|
|
|
|
|
|
|
|
async close(): Promise<void> {
|
|
|
|
assert(this._id, 'Non-incognito profiles cannot be closed!');
|
|
|
|
await this._browser._disposeContext(this._id);
|
|
|
|
}
|
|
|
|
}
|