/** * 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 { BrowserBase, BrowserOptions } from '../browser'; import { assertBrowserContextIsNotOwned, BrowserContext, BrowserContextBase, BrowserContextOptions, validateBrowserContextOptions, verifyGeolocation } from '../browserContext'; import { Events as CommonEvents } from '../events'; import { assert, helper } from '../helper'; import * as network from '../network'; import { Page, PageBinding, Worker } from '../page'; import { ConnectionTransport, SlowMoTransport } from '../transport'; import * as types from '../types'; import { ConnectionEvents, CRConnection, CRSession } from './crConnection'; import { CRPage } from './crPage'; import { readProtocolStream } from './crProtocolHelper'; import { Events } from './events'; import { Protocol } from './protocol'; import { CRExecutionContext } from './crExecutionContext'; import { logError } from '../logger'; import { CRDevTools } from '../debug/crDevTools'; export class CRBrowser extends BrowserBase { readonly _connection: CRConnection; _session: CRSession; private _clientRootSessionPromise: Promise | null = null; readonly _contexts = new Map(); _crPages = new Map(); _backgroundPages = new Map(); _serviceWorkers = new Map(); _devtools?: CRDevTools; private _tracingRecording = false; private _tracingPath: string | null = ''; private _tracingClient: CRSession | undefined; static async connect(transport: ConnectionTransport, options: BrowserOptions, devtools?: CRDevTools): Promise { const connection = new CRConnection(SlowMoTransport.wrap(transport, options.slowMo), options.logger); const browser = new CRBrowser(connection, options); browser._devtools = devtools; const session = connection.rootSession; if (!options.persistent) { await session.send('Target.setAutoAttach', { autoAttach: true, waitForDebuggerOnStart: true, flatten: true }); return browser; } browser._defaultContext = new CRBrowserContext(browser, null, options.persistent); const existingTargetAttachPromises: Promise[] = []; // First page, background pages and their service workers in the persistent context // are created automatically and may be initialized before we enable auto-attach. function attachToExistingPage({targetInfo}: Protocol.Target.targetCreatedPayload) { if (targetInfo.type !== 'page' && targetInfo.type !== 'background_page' && targetInfo.type !== 'service_worker') return; // TODO: should we handle the error during 'Target.attachToTarget'? Can the target disappear? existingTargetAttachPromises.push(session.send('Target.attachToTarget', {targetId: targetInfo.targetId, flatten: true})); } session.on('Target.targetCreated', attachToExistingPage); const startDiscover = session.send('Target.setDiscoverTargets', { discover: true }); const autoAttachAndStopDiscover = session.send('Target.setAutoAttach', { autoAttach: true, waitForDebuggerOnStart: true, flatten: true }).then(() => { // All targets collected before setAutoAttach response will not be auto-attached, the rest will be. // TODO: We should fix this upstream and remove this tricky logic. session.off('Target.targetCreated', attachToExistingPage); return session.send('Target.setDiscoverTargets', { discover: false }); }); await Promise.all([ startDiscover, autoAttachAndStopDiscover, (browser._defaultContext as CRBrowserContext)._initialize(), ]); // Wait for initial targets to arrive. await Promise.all(existingTargetAttachPromises); return browser; } constructor(connection: CRConnection, options: BrowserOptions) { super(options); this._connection = connection; this._session = this._connection.rootSession; this._connection.on(ConnectionEvents.Disconnected, () => { for (const context of this._contexts.values()) context._browserClosed(); this.emit(CommonEvents.Browser.Disconnected); }); this._session.on('Target.attachedToTarget', this._onAttachedToTarget.bind(this)); this._session.on('Target.detachedFromTarget', this._onDetachedFromTarget.bind(this)); } async newContext(options: BrowserContextOptions = {}): Promise { options = validateBrowserContextOptions(options); const { browserContextId } = await this._session.send('Target.createBrowserContext', { disposeOnDetach: true }); const context = new CRBrowserContext(this, browserContextId, options); await context._initialize(); this._contexts.set(browserContextId, context); return context; } contexts(): BrowserContext[] { return Array.from(this._contexts.values()); } _onAttachedToTarget({targetInfo, sessionId, waitingForDebugger}: Protocol.Target.attachedToTargetPayload) { if (targetInfo.type === 'browser') return; const session = this._connection.session(sessionId)!; assert(targetInfo.browserContextId, 'targetInfo: ' + JSON.stringify(targetInfo, null, 2)); let context = this._contexts.get(targetInfo.browserContextId) || null; if (!context) { // TODO: auto attach only to pages from our contexts. // assert(this._defaultContext); context = this._defaultContext as CRBrowserContext; } if (targetInfo.type === 'other' && targetInfo.url.startsWith('devtools://devtools') && this._devtools) { this._devtools.install(session); return; } if (targetInfo.type === 'other' || !context) { if (waitingForDebugger) { // Ideally, detaching should resume any target, but there is a bug in the backend. session.send('Runtime.runIfWaitingForDebugger').catch(logError(this)).then(() => { this._session.send('Target.detachFromTarget', { sessionId }).catch(logError(this)); }); } return; } assert(!this._crPages.has(targetInfo.targetId), 'Duplicate target ' + targetInfo.targetId); assert(!this._backgroundPages.has(targetInfo.targetId), 'Duplicate target ' + targetInfo.targetId); assert(!this._serviceWorkers.has(targetInfo.targetId), 'Duplicate target ' + targetInfo.targetId); if (targetInfo.type === 'background_page') { const backgroundPage = new CRPage(session, targetInfo.targetId, context, null, false); this._backgroundPages.set(targetInfo.targetId, backgroundPage); backgroundPage.pageOrError().then(() => { context!.emit(Events.CRBrowserContext.BackgroundPage, backgroundPage._page); }); return; } if (targetInfo.type === 'page') { const opener = targetInfo.openerId ? this._crPages.get(targetInfo.openerId) || null : null; const crPage = new CRPage(session, targetInfo.targetId, context, opener, !!this._options.headful); this._crPages.set(targetInfo.targetId, crPage); crPage.pageOrError().then(() => { context!.emit(CommonEvents.BrowserContext.Page, crPage._page); if (opener) { opener.pageOrError().then(openerPage => { if (openerPage instanceof Page && !openerPage.isClosed()) openerPage.emit(CommonEvents.Page.Popup, crPage._page); }); } }); return; } if (targetInfo.type === 'service_worker') { const serviceWorker = new CRServiceWorker(context, session, targetInfo.url); this._serviceWorkers.set(targetInfo.targetId, serviceWorker); context.emit(Events.CRBrowserContext.ServiceWorker, serviceWorker); return; } assert(false, 'Unknown target type: ' + targetInfo.type); } _onDetachedFromTarget(payload: Protocol.Target.detachFromTargetParameters) { const targetId = payload.targetId!; const crPage = this._crPages.get(targetId); if (crPage) { this._crPages.delete(targetId); crPage.didClose(); return; } const backgroundPage = this._backgroundPages.get(targetId); if (backgroundPage) { this._backgroundPages.delete(targetId); backgroundPage.didClose(); return; } const serviceWorker = this._serviceWorkers.get(targetId); if (serviceWorker) { this._serviceWorkers.delete(targetId); serviceWorker.emit(CommonEvents.Worker.Close); return; } } async _closePage(crPage: CRPage) { await this._session.send('Target.closeTarget', { targetId: crPage._targetId }); } _disconnect() { this._connection.close(); } async newBrowserCDPSession(): Promise { return await this._connection.createBrowserSession(); } async startTracing(page?: Page, 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)._mainFrameSession._client : this._session; 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.'); const [event] = await Promise.all([ new Promise(f => this._tracingClient!.once('Tracing.tracingComplete', f)), this._tracingClient.send('Tracing.end') ]); const result = await readProtocolStream(this._tracingClient, (event as any).stream!, this._tracingPath); this._tracingRecording = false; return result; } isConnected(): boolean { return !this._connection._closed; } async _clientRootSession(): Promise { if (!this._clientRootSessionPromise) this._clientRootSessionPromise = this._connection.createBrowserSession(); return this._clientRootSessionPromise; } } class CRServiceWorker extends Worker { readonly _browserContext: CRBrowserContext; constructor(browserContext: CRBrowserContext, session: CRSession, url: string) { super(browserContext, url); this._browserContext = browserContext; session.once('Runtime.executionContextCreated', event => { this._createExecutionContext(new CRExecutionContext(session, event.context)); }); // This might fail if the target is closed before we receive all execution contexts. session.send('Runtime.enable', {}).catch(e => {}); session.send('Runtime.runIfWaitingForDebugger').catch(e => {}); } } export class CRBrowserContext extends BrowserContextBase { readonly _browser: CRBrowser; readonly _browserContextId: string | null; readonly _evaluateOnNewDocumentSources: string[]; constructor(browser: CRBrowser, browserContextId: string | null, options: BrowserContextOptions) { super(browser, options); this._browser = browser; this._browserContextId = browserContextId; this._evaluateOnNewDocumentSources = []; } async _initialize() { assert(!Array.from(this._browser._crPages.values()).some(page => page._browserContext === this)); const promises: Promise[] = [ super._initialize() ]; if (this._browser._options.downloadsPath) { promises.push(this._browser._session.send('Browser.setDownloadBehavior', { behavior: this._options.acceptDownloads ? 'allowAndName' : 'deny', browserContextId: this._browserContextId || undefined, downloadPath: this._browser._options.downloadsPath })); } if (this._options.permissions) promises.push(this.grantPermissions(this._options.permissions)); await Promise.all(promises); } pages(): Page[] { const result: Page[] = []; for (const crPage of this._browser._crPages.values()) { if (crPage._browserContext === this && crPage._initializedPage) result.push(crPage._initializedPage); } return result; } async newPage(): Promise { assertBrowserContextIsNotOwned(this); const { targetId } = await this._browser._session.send('Target.createTarget', { url: 'about:blank', browserContextId: this._browserContextId || undefined }); const crPage = this._browser._crPages.get(targetId)!; const result = await crPage.pageOrError(); if (result instanceof Page) { if (result.isClosed()) throw new Error('Page has been closed.'); return result; } throw result; } async cookies(urls?: string | string[]): Promise { const { cookies } = await this._browser._session.send('Storage.getCookies', { browserContextId: this._browserContextId || undefined }); return network.filterCookies(cookies.map(c => { const copy: any = { sameSite: 'None', ...c }; delete copy.size; delete copy.priority; delete copy.session; return copy as network.NetworkCookie; }), urls); } async addCookies(cookies: network.SetNetworkCookieParam[]) { await this._browser._session.send('Storage.setCookies', { cookies: network.rewriteCookies(cookies), browserContextId: this._browserContextId || undefined }); } async clearCookies() { await this._browser._session.send('Storage.clearCookies', { browserContextId: this._browserContextId || undefined }); } async _doGrantPermissions(origin: string, permissions: string[]) { 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._browser._session.send('Browser.grantPermissions', { origin: origin === '*' ? undefined : origin, browserContextId: this._browserContextId || undefined, permissions: filtered }); } async _doClearPermissions() { await this._browser._session.send('Browser.resetPermissions', { browserContextId: this._browserContextId || undefined }); } async setGeolocation(geolocation: types.Geolocation | null): Promise { if (geolocation) geolocation = verifyGeolocation(geolocation); this._options.geolocation = geolocation || undefined; for (const page of this.pages()) await (page._delegate as CRPage).updateGeolocation(); } async setExtraHTTPHeaders(headers: network.Headers): Promise { this._options.extraHTTPHeaders = network.verifyHeaders(headers); for (const page of this.pages()) await (page._delegate as CRPage).updateExtraHTTPHeaders(); } async setOffline(offline: boolean): Promise { this._options.offline = offline; for (const page of this.pages()) await (page._delegate as CRPage).updateOffline(); } async setHTTPCredentials(httpCredentials: types.Credentials | null): Promise { this._options.httpCredentials = httpCredentials || undefined; for (const page of this.pages()) await (page._delegate as CRPage).updateHttpCredentials(); } async addInitScript(script: Function | string | { path?: string, content?: string }, arg?: any) { const source = await helper.evaluationScript(script, arg); this._evaluateOnNewDocumentSources.push(source); for (const page of this.pages()) await (page._delegate as CRPage).evaluateOnNewDocument(source); } async _doExposeBinding(binding: PageBinding) { for (const page of this.pages()) await (page._delegate as CRPage).exposeBinding(binding); } async route(url: types.URLMatch, handler: network.RouteHandler): Promise { this._routes.push({ url, handler }); for (const page of this.pages()) await (page._delegate as CRPage).updateRequestInterception(); } async unroute(url: types.URLMatch, handler?: network.RouteHandler): Promise { this._routes = this._routes.filter(route => route.url !== url || (handler && route.handler !== handler)); for (const page of this.pages()) await (page._delegate as CRPage).updateRequestInterception(); } async close() { if (this._closed) return; if (!this._browserContextId) { // Default context is only created in 'persistent' mode and closing it should close // the browser. await this._browser.close(); return; } await this._browser._session.send('Target.disposeBrowserContext', { browserContextId: this._browserContextId }); this._browser._contexts.delete(this._browserContextId); await this._didCloseInternal(); } backgroundPages(): Page[] { const result: Page[] = []; for (const backgroundPage of this._browser._backgroundPages.values()) { if (backgroundPage._browserContext === this && backgroundPage._initializedPage) result.push(backgroundPage._initializedPage); } return result; } serviceWorkers(): Worker[] { return Array.from(this._browser._serviceWorkers.values()).filter(serviceWorker => serviceWorker._browserContext === this); } async newCDPSession(page: Page): Promise { const targetId = (page._delegate as CRPage)._targetId; const rootSession = await this._browser._clientRootSession(); const { sessionId } = await rootSession.send('Target.attachToTarget', { targetId, flatten: true }); return this._browser._connection.session(sessionId)!; } }