/** * Copyright 2017 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 { Events } from './events'; import { Events as CommonEvents } from '../events'; import { assert, helper } from '../helper'; import { BrowserContext, BrowserContextOptions } from '../browserContext'; import { CRConnection, ConnectionEvents, CRSession } from './crConnection'; import { Page, Worker } from '../page'; import { CRTarget } from './crTarget'; import { Protocol } from './protocol'; import { CRPage } from './crPage'; import { Browser } from '../browser'; import * as network from '../network'; import * as types from '../types'; import * as platform from '../platform'; import { ConnectionTransport, SlowMoTransport } from '../transport'; import { readProtocolStream } from './crProtocolHelper'; export type CRConnectOptions = { slowMo?: number, browserWSEndpoint?: string; browserURL?: string; transport?: ConnectionTransport; }; export class CRBrowser extends platform.EventEmitter implements Browser { _connection: CRConnection; _client: CRSession; private _defaultContext: BrowserContext; private _contexts = new Map(); _targets = new Map(); private _tracingRecording = false; private _tracingPath = ''; private _tracingClient: CRSession | undefined; static async connect(options: CRConnectOptions): Promise { const transport = await createTransport(options); const connection = new CRConnection(transport); const { browserContextIds } = await connection.rootSession.send('Target.getBrowserContexts'); const browser = new CRBrowser(connection, browserContextIds); await connection.rootSession.send('Target.setDiscoverTargets', { discover: true }); await browser.waitForTarget(t => t.type() === 'page'); return browser; } constructor(connection: CRConnection, contextIds: string[]) { super(); this._connection = connection; this._client = connection.rootSession; this._defaultContext = this._createBrowserContext(null, {}); for (const contextId of contextIds) this._contexts.set(contextId, this._createBrowserContext(contextId, {})); this._connection.on(ConnectionEvents.Disconnected, () => this.emit(CommonEvents.Browser.Disconnected)); this._client.on('Target.targetCreated', this._targetCreated.bind(this)); this._client.on('Target.targetDestroyed', this._targetDestroyed.bind(this)); this._client.on('Target.targetInfoChanged', this._targetInfoChanged.bind(this)); } _createBrowserContext(contextId: string | null, options: BrowserContextOptions): BrowserContext { const context = new BrowserContext({ pages: async (): Promise => { const targets = this._allTargets().filter(target => target.browserContext() === context && target.type() === 'page'); const pages = await Promise.all(targets.map(target => target.page())); return pages.filter(page => !!page); }, newPage: async (): Promise => { const { targetId } = await this._client.send('Target.createTarget', { url: 'about:blank', browserContextId: contextId || undefined }); const target = this._targets.get(targetId); assert(await target._initializedPromise, 'Failed to create target for page'); return target.page(); }, close: async (): Promise => { assert(contextId, 'Non-incognito profiles cannot be closed!'); await this._client.send('Target.disposeBrowserContext', {browserContextId: contextId || undefined}); this._contexts.delete(contextId); }, cookies: async (): Promise => { const { cookies } = await this._client.send('Storage.getCookies', { browserContextId: contextId || undefined }); return cookies.map(c => { const copy: any = { sameSite: 'None', ...c }; delete copy.size; delete copy.priority; return copy as network.NetworkCookie; }); }, clearCookies: async (): Promise => { await this._client.send('Storage.clearCookies', { browserContextId: contextId || undefined }); }, setCookies: async (cookies: network.SetNetworkCookieParam[]): Promise => { await this._client.send('Storage.setCookies', { cookies, browserContextId: contextId || undefined }); }, setPermissions: async (origin: string, permissions: string[]): Promise => { const webPermissionToProtocol = new Map([ ['geolocation', 'geolocation'], ['midi', 'midi'], ['notifications', 'notifications'], ['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', 'clipboardSanitizedWrite'], ['payment-handler', 'paymentHandler'], // chrome-specific permissions we have. ['midi-sysex', 'midiSysex'], ]); const filtered = permissions.map(permission => { const protocolPermission = webPermissionToProtocol.get(permission); if (!protocolPermission) throw new Error('Unknown permission: ' + permission); return protocolPermission; }); await this._client.send('Browser.grantPermissions', { origin, browserContextId: contextId || undefined, permissions: filtered }); }, clearPermissions: async () => { await this._client.send('Browser.resetPermissions', { browserContextId: contextId || undefined }); }, setGeolocation: async (geolocation: types.Geolocation | null): Promise => { for (const page of await context.pages()) await (page._delegate as CRPage)._client.send('Emulation.setGeolocationOverride', geolocation || {}); } }, options); return context; } async newContext(options: BrowserContextOptions = {}): Promise { const { browserContextId } = await this._client.send('Target.createBrowserContext'); const context = this._createBrowserContext(browserContextId, options); this._contexts.set(browserContextId, context); return context; } browserContexts(): BrowserContext[] { return [this._defaultContext, ...Array.from(this._contexts.values())]; } defaultContext(): BrowserContext { return this._defaultContext; } async _targetCreated(event: Protocol.Target.targetCreatedPayload) { const targetInfo = event.targetInfo; const {browserContextId} = targetInfo; const context = (browserContextId && this._contexts.has(browserContextId)) ? this._contexts.get(browserContextId) : this._defaultContext; const target = new CRTarget(this, targetInfo, context, () => this._connection.createSession(targetInfo)); assert(!this._targets.has(event.targetInfo.targetId), 'Target should not exist before targetCreated'); this._targets.set(event.targetInfo.targetId, target); if (target._isInitialized || await target._initializedPromise) this.emit(Events.CRBrowser.TargetCreated, target); } async _targetDestroyed(event: { targetId: string; }) { const target = this._targets.get(event.targetId); target._initializedCallback(false); this._targets.delete(event.targetId); target._didClose(); if (await target._initializedPromise) this.emit(Events.CRBrowser.TargetDestroyed, target); } _targetInfoChanged(event: Protocol.Target.targetInfoChangedPayload) { 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.CRBrowser.TargetChanged, target); } async _closePage(page: Page) { await this._client.send('Target.closeTarget', { targetId: CRTarget.fromPage(page)._targetId }); } _allTargets(): CRTarget[] { return Array.from(this._targets.values()).filter(target => target._isInitialized); } async waitForTarget(predicate: (arg0: CRTarget) => boolean, options: { timeout?: number; } | undefined = {}): Promise { const { timeout = 30000 } = options; const existingTarget = this._allTargets().find(predicate); if (existingTarget) return existingTarget; let resolve: (target: CRTarget) => void; const targetPromise = new Promise(x => resolve = x); this.on(Events.CRBrowser.TargetCreated, check); this.on(Events.CRBrowser.TargetChanged, check); try { if (!timeout) return await targetPromise; return await helper.waitWithTimeout(targetPromise, 'target', timeout); } finally { this.removeListener(Events.CRBrowser.TargetCreated, check); this.removeListener(Events.CRBrowser.TargetChanged, check); } function check(target: CRTarget) { if (predicate(target)) resolve(target); } } async close() { const disconnected = new Promise(f => this._connection.once(ConnectionEvents.Disconnected, f)); await this._connection.rootSession.send('Browser.close'); await disconnected; } browserTarget(): CRTarget { return [...this._targets.values()].find(t => t.type() === 'browser'); } serviceWorker(target: CRTarget): Promise { return target._worker(); } async startTracing(page: Page | undefined, options: { path?: string; screenshots?: boolean; categories?: string[]; } = {}) { assert(!this._tracingRecording, 'Cannot start recording trace while already recording trace.'); this._tracingClient = page ? (page._delegate as CRPage)._client : this._client; const defaultCategories = [ '-*', 'devtools.timeline', 'v8.execute', 'disabled-by-default-devtools.timeline', 'disabled-by-default-devtools.timeline.frame', 'toplevel', 'blink.console', 'blink.user_timing', 'latencyInfo', 'disabled-by-default-devtools.timeline.stack', 'disabled-by-default-v8.cpu_profiler', 'disabled-by-default-v8.cpu_profiler.hires' ]; const { path = null, screenshots = false, categories = defaultCategories, } = options; if (screenshots) categories.push('disabled-by-default-devtools.screenshot'); this._tracingPath = path; this._tracingRecording = true; await this._tracingClient.send('Tracing.start', { transferMode: 'ReturnAsStream', categories: categories.join(',') }); } async stopTracing(): Promise { assert(this._tracingClient, 'Tracing was not started.'); let fulfill: (buffer: platform.BufferType) => void; const contentPromise = new Promise(x => fulfill = x); this._tracingClient.once('Tracing.tracingComplete', event => { readProtocolStream(this._tracingClient, event.stream, this._tracingPath).then(fulfill); }); await this._tracingClient.send('Tracing.end'); this._tracingRecording = false; return contentPromise; } targets(context?: BrowserContext): CRTarget[] { const targets = this._allTargets(); return context ? targets.filter(t => t.browserContext() === context) : targets; } pageTarget(page: Page): CRTarget { return CRTarget.fromPage(page); } disconnect() { this._connection.dispose(); } isConnected(): boolean { return !this._connection._closed; } } export async function createTransport(options: CRConnectOptions): Promise { assert(Number(!!options.browserWSEndpoint) + Number(!!options.browserURL) + Number(!!options.transport) === 1, 'Exactly one of browserWSEndpoint, browserURL or transport must be passed to connect'); let transport: ConnectionTransport | undefined; if (options.transport) { transport = options.transport; } else if (options.browserWSEndpoint) { transport = await platform.createWebSocketTransport(options.browserWSEndpoint); } else if (options.browserURL) { let connectionURL: string; try { const data = await platform.fetchUrl(new URL('/json/version', options.browserURL).href); connectionURL = JSON.parse(data).webSocketDebuggerUrl; } catch (e) { e.message = `Failed to fetch browser webSocket url from ${options.browserURL}: ` + e.message; throw e; } transport = await platform.createWebSocketTransport(connectionURL); } return SlowMoTransport.wrap(transport, options.slowMo); }