"use strict"; /** * 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. */ Object.defineProperty(exports, "__esModule", { value: true }); exports.BrowserContext = exports.Browser = void 0; const helper_1 = require("./helper"); const Target_1 = require("./Target"); const EventEmitter = require("events"); const Events_1 = require("./Events"); class Browser extends EventEmitter { constructor(connection, contextIds, ignoreHTTPSErrors, defaultViewport, process, closeCallback) { super(); this._ignoreHTTPSErrors = ignoreHTTPSErrors; this._defaultViewport = defaultViewport; this._process = process; this._connection = connection; this._closeCallback = closeCallback || function () { }; 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_1.Events.Connection.Disconnected, () => this.emit(Events_1.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)); } static async create(connection, contextIds, ignoreHTTPSErrors, defaultViewport, process, closeCallback) { const browser = new Browser(connection, contextIds, ignoreHTTPSErrors, defaultViewport, process, closeCallback); await connection.send('Target.setDiscoverTargets', { discover: true }); return browser; } process() { return this._process; } async createIncognitoBrowserContext() { const { browserContextId } = await this._connection.send('Target.createBrowserContext'); const context = new BrowserContext(this._connection, this, browserContextId); this._contexts.set(browserContextId, context); return context; } browserContexts() { return [this._defaultContext, ...Array.from(this._contexts.values())]; } defaultBrowserContext() { return this._defaultContext; } /** * @param {?string} contextId */ async _disposeContext(contextId) { await this._connection.send('Target.disposeBrowserContext', { browserContextId: contextId || undefined, }); this._contexts.delete(contextId); } async _targetCreated(event) { const targetInfo = event.targetInfo; const { browserContextId } = targetInfo; const context = browserContextId && this._contexts.has(browserContextId) ? this._contexts.get(browserContextId) : this._defaultContext; const target = new Target_1.Target(targetInfo, context, () => this._connection.createSession(targetInfo), this._ignoreHTTPSErrors, this._defaultViewport); helper_1.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_1.Events.Browser.TargetCreated, target); context.emit(Events_1.Events.BrowserContext.TargetCreated, target); } } /** * @param {{targetId: string}} event */ async _targetDestroyed(event) { const target = this._targets.get(event.targetId); target._initializedCallback(false); this._targets.delete(event.targetId); target._closedCallback(); if (await target._initializedPromise) { this.emit(Events_1.Events.Browser.TargetDestroyed, target); target .browserContext() .emit(Events_1.Events.BrowserContext.TargetDestroyed, target); } } /** * @param {!Protocol.Target.targetInfoChangedPayload} event */ _targetInfoChanged(event) { const target = this._targets.get(event.targetInfo.targetId); helper_1.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_1.Events.Browser.TargetChanged, target); target.browserContext().emit(Events_1.Events.BrowserContext.TargetChanged, target); } } wsEndpoint() { return this._connection.url(); } async newPage() { return this._defaultContext.newPage(); } async _createPageInContext(contextId) { const { targetId } = await this._connection.send('Target.createTarget', { url: 'about:blank', browserContextId: contextId || undefined, }); const target = await this._targets.get(targetId); helper_1.assert(await target._initializedPromise, 'Failed to create target for page'); const page = await target.page(); return page; } targets() { return Array.from(this._targets.values()).filter((target) => target._isInitialized); } target() { return this.targets().find((target) => target.type() === 'browser'); } /** * @param {function(!Target):boolean} predicate * @param {{timeout?: number}=} options * @return {!Promise} */ async waitForTarget(predicate, options = {}) { const { timeout = 30000 } = options; const existingTarget = this.targets().find(predicate); if (existingTarget) return existingTarget; let resolve; const targetPromise = new Promise((x) => (resolve = x)); this.on(Events_1.Events.Browser.TargetCreated, check); this.on(Events_1.Events.Browser.TargetChanged, check); try { if (!timeout) return await targetPromise; return await helper_1.helper.waitWithTimeout(targetPromise, 'target', timeout); } finally { this.removeListener(Events_1.Events.Browser.TargetCreated, check); this.removeListener(Events_1.Events.Browser.TargetChanged, check); } function check(target) { if (predicate(target)) resolve(target); } } async pages() { const contextPages = await Promise.all(this.browserContexts().map((context) => context.pages())); // Flatten array. return contextPages.reduce((acc, x) => acc.concat(x), []); } async version() { const version = await this._getVersion(); return version.product; } async userAgent() { const version = await this._getVersion(); return version.userAgent; } async close() { await this._closeCallback.call(null); this.disconnect(); } disconnect() { this._connection.dispose(); } isConnected() { return !this._connection._closed; } _getVersion() { return this._connection.send('Browser.getVersion'); } } exports.Browser = Browser; class BrowserContext extends EventEmitter { constructor(connection, browser, contextId) { super(); this._connection = connection; this._browser = browser; this._id = contextId; } targets() { return this._browser .targets() .filter((target) => target.browserContext() === this); } waitForTarget(predicate, options) { return this._browser.waitForTarget((target) => target.browserContext() === this && predicate(target), options); } async pages() { const pages = await Promise.all(this.targets() .filter((target) => target.type() === 'page') .map((target) => target.page())); return pages.filter((page) => !!page); } isIncognito() { return !!this._id; } async overridePermissions(origin, permissions) { const webPermissionToProtocol = new Map([ ['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'], ]); permissions = permissions.map((permission) => { const protocolPermission = webPermissionToProtocol.get(permission); if (!protocolPermission) throw new Error('Unknown permission: ' + permission); return protocolPermission; }); await this._connection.send('Browser.grantPermissions', { origin, browserContextId: this._id || undefined, permissions, }); } async clearPermissionOverrides() { await this._connection.send('Browser.resetPermissions', { browserContextId: this._id || undefined, }); } newPage() { return this._browser._createPageInContext(this._id); } browser() { return this._browser; } async close() { helper_1.assert(this._id, 'Non-incognito profiles cannot be closed!'); await this._browser._disposeContext(this._id); } } exports.BrowserContext = BrowserContext;