mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
128 lines
3.6 KiB
TypeScript
128 lines
3.6 KiB
TypeScript
/**
|
|
* Copyright 2022 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.
|
|
*/
|
|
|
|
import {BrowserContext as BrowserContextBase} from '../../api/BrowserContext.js';
|
|
import {Page as PageBase} from '../../api/Page.js';
|
|
import {Target} from '../../api/Target.js';
|
|
import {Viewport} from '../PuppeteerViewport.js';
|
|
|
|
import {Browser} from './Browser.js';
|
|
import {Connection} from './Connection.js';
|
|
import {Page} from './Page.js';
|
|
import {debugError} from './utils.js';
|
|
|
|
interface BrowserContextOptions {
|
|
defaultViewport: Viewport | null;
|
|
isDefault: boolean;
|
|
}
|
|
|
|
/**
|
|
* @internal
|
|
*/
|
|
export class BrowserContext extends BrowserContextBase {
|
|
#browser: Browser;
|
|
#connection: Connection;
|
|
#defaultViewport: Viewport | null;
|
|
#isDefault = false;
|
|
|
|
constructor(browser: Browser, options: BrowserContextOptions) {
|
|
super();
|
|
this.#browser = browser;
|
|
this.#connection = this.#browser.connection;
|
|
this.#defaultViewport = options.defaultViewport;
|
|
this.#isDefault = options.isDefault;
|
|
}
|
|
|
|
override targets(): Target[] {
|
|
return this.#browser.targets().filter(target => {
|
|
return target.browserContext() === this;
|
|
});
|
|
}
|
|
|
|
override waitForTarget(
|
|
predicate: (x: Target) => boolean | Promise<boolean>,
|
|
options: {timeout?: number} = {}
|
|
): Promise<Target> {
|
|
return this.#browser.waitForTarget(target => {
|
|
return target.browserContext() === this && predicate(target);
|
|
}, options);
|
|
}
|
|
|
|
get connection(): Connection {
|
|
return this.#connection;
|
|
}
|
|
|
|
override async newPage(): Promise<PageBase> {
|
|
const {result} = await this.#connection.send('browsingContext.create', {
|
|
type: 'tab',
|
|
});
|
|
const target = this.#browser._getTargetById(result.context);
|
|
|
|
// TODO: once BiDi has some concept matching BrowserContext, the newly
|
|
// created contexts should get automatically assigned to the right
|
|
// BrowserContext. For now, we assume that only explicitly created pages go
|
|
// to the current BrowserContext. Otherwise, the contexts get assigned to
|
|
// the default BrowserContext by the Browser.
|
|
target._setBrowserContext(this);
|
|
|
|
const page = await target.page();
|
|
if (!page) {
|
|
throw new Error('Page is not found');
|
|
}
|
|
if (this.#defaultViewport) {
|
|
try {
|
|
await page.setViewport(this.#defaultViewport);
|
|
} catch {
|
|
// No support for setViewport in Firefox.
|
|
}
|
|
}
|
|
|
|
return page;
|
|
}
|
|
|
|
override async close(): Promise<void> {
|
|
if (this.#isDefault) {
|
|
throw new Error('Default context cannot be closed!');
|
|
}
|
|
|
|
for (const target of this.targets()) {
|
|
const page = await target?.page();
|
|
await page?.close().catch(error => {
|
|
debugError(error);
|
|
});
|
|
}
|
|
}
|
|
|
|
override browser(): Browser {
|
|
return this.#browser;
|
|
}
|
|
|
|
override async pages(): Promise<PageBase[]> {
|
|
const results = await Promise.all(
|
|
[...this.targets()].map(t => {
|
|
return t.page();
|
|
})
|
|
);
|
|
return results.filter((p): p is Page => {
|
|
return p !== null;
|
|
});
|
|
}
|
|
|
|
override isIncognito(): boolean {
|
|
return false;
|
|
}
|
|
}
|