/** * 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 { BrowserChannel, BrowserInitializer, BrowserNewContextParams } from '../../protocol/channels'; import { BrowserContext } from './browserContext'; import { Page } from './page'; import { ChannelOwner } from './channelOwner'; import { Events } from './events'; import { BrowserType } from './browserType'; import { BrowserContextOptions } from './types'; import { validateHeaders } from './network'; import { headersObjectToArray } from '../../utils/utils'; export class Browser extends ChannelOwner { readonly _contexts = new Set(); private _isConnected = true; private _isClosedOrClosing = false; private _closedPromise: Promise; readonly _browserType: BrowserType; static from(browser: BrowserChannel): Browser { return (browser as any)._object; } static fromNullable(browser: BrowserChannel | null): Browser | null { return browser ? Browser.from(browser) : null; } constructor(parent: ChannelOwner, type: string, guid: string, initializer: BrowserInitializer) { super(parent, type, guid, initializer); this._browserType = parent as BrowserType; this._channel.on('close', () => this._didClose()); this._closedPromise = new Promise(f => this.once(Events.Browser.Disconnected, f)); } async newContext(options: BrowserContextOptions = {}): Promise { const logger = options.logger; return this._wrapApiCall('browser.newContext', async () => { if (options.extraHTTPHeaders) validateHeaders(options.extraHTTPHeaders); const contextOptions: BrowserNewContextParams = { ...options, viewport: options.viewport === null ? undefined : options.viewport, noDefaultViewport: options.viewport === null, extraHTTPHeaders: options.extraHTTPHeaders ? headersObjectToArray(options.extraHTTPHeaders) : undefined, }; const context = BrowserContext.from((await this._channel.newContext(contextOptions)).context); this._contexts.add(context); context._logger = logger || this._logger; return context; }); } contexts(): BrowserContext[] { return [...this._contexts]; } version(): string { return this._initializer.version; } async newPage(options: BrowserContextOptions = {}): Promise { const context = await this.newContext(options); const page = await context.newPage(); page._ownedContext = context; context._ownerPage = page; return page; } isConnected(): boolean { return this._isConnected; } async close(): Promise { return this._wrapApiCall('browser.close', async () => { if (!this._isClosedOrClosing) { this._isClosedOrClosing = true; await this._channel.close(); } await this._closedPromise; }); } _didClose() { this._isConnected = false; this.emit(Events.Browser.Disconnected); this._isClosedOrClosing = true; } }