mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
revert: refactor: adopt core/UserContext
on BidiBrowserContext
(#11721)
This commit is contained in:
parent
ab5d4ac602
commit
d17a9df027
@ -27,7 +27,6 @@ import {BrowsingContext, BrowsingContextEvent} from './BrowsingContext.js';
|
|||||||
import type {BidiConnection} from './Connection.js';
|
import type {BidiConnection} from './Connection.js';
|
||||||
import type {Browser as BrowserCore} from './core/Browser.js';
|
import type {Browser as BrowserCore} from './core/Browser.js';
|
||||||
import {Session} from './core/Session.js';
|
import {Session} from './core/Session.js';
|
||||||
import type {UserContext} from './core/UserContext.js';
|
|
||||||
import {
|
import {
|
||||||
BiDiBrowserTarget,
|
BiDiBrowserTarget,
|
||||||
BiDiBrowsingContextTarget,
|
BiDiBrowsingContextTarget,
|
||||||
@ -96,8 +95,9 @@ export class BidiBrowser extends Browser {
|
|||||||
#closeCallback?: BrowserCloseCallback;
|
#closeCallback?: BrowserCloseCallback;
|
||||||
#browserCore: BrowserCore;
|
#browserCore: BrowserCore;
|
||||||
#defaultViewport: Viewport | null;
|
#defaultViewport: Viewport | null;
|
||||||
|
#defaultContext: BidiBrowserContext;
|
||||||
#targets = new Map<string, BidiTarget>();
|
#targets = new Map<string, BidiTarget>();
|
||||||
#browserContexts = new WeakMap<UserContext, BidiBrowserContext>();
|
#contexts: BidiBrowserContext[] = [];
|
||||||
#browserTarget: BiDiBrowserTarget;
|
#browserTarget: BiDiBrowserTarget;
|
||||||
|
|
||||||
#connectionEventHandlers = new Map<
|
#connectionEventHandlers = new Map<
|
||||||
@ -111,14 +111,18 @@ export class BidiBrowser extends Browser {
|
|||||||
['browsingContext.navigationStarted', this.#onContextNavigation.bind(this)],
|
['browsingContext.navigationStarted', this.#onContextNavigation.bind(this)],
|
||||||
]);
|
]);
|
||||||
|
|
||||||
private constructor(browserCore: BrowserCore, opts: BidiBrowserOptions) {
|
constructor(browserCore: BrowserCore, opts: BidiBrowserOptions) {
|
||||||
super();
|
super();
|
||||||
this.#process = opts.process;
|
this.#process = opts.process;
|
||||||
this.#closeCallback = opts.closeCallback;
|
this.#closeCallback = opts.closeCallback;
|
||||||
this.#browserCore = browserCore;
|
this.#browserCore = browserCore;
|
||||||
this.#defaultViewport = opts.defaultViewport;
|
this.#defaultViewport = opts.defaultViewport;
|
||||||
this.#browserTarget = new BiDiBrowserTarget(this);
|
this.#defaultContext = new BidiBrowserContext(this, {
|
||||||
this.#createBrowserContext(this.#browserCore.defaultUserContext);
|
defaultViewport: this.#defaultViewport,
|
||||||
|
isDefault: true,
|
||||||
|
});
|
||||||
|
this.#browserTarget = new BiDiBrowserTarget(this.#defaultContext);
|
||||||
|
this.#contexts.push(this.#defaultContext);
|
||||||
}
|
}
|
||||||
|
|
||||||
#initialize() {
|
#initialize() {
|
||||||
@ -146,14 +150,6 @@ export class BidiBrowser extends Browser {
|
|||||||
throw new UnsupportedOperation();
|
throw new UnsupportedOperation();
|
||||||
}
|
}
|
||||||
|
|
||||||
#createBrowserContext(userContext: UserContext) {
|
|
||||||
const browserContext = new BidiBrowserContext(this, userContext, {
|
|
||||||
defaultViewport: this.#defaultViewport,
|
|
||||||
});
|
|
||||||
this.#browserContexts.set(userContext, browserContext);
|
|
||||||
return browserContext;
|
|
||||||
}
|
|
||||||
|
|
||||||
#onContextDomLoaded(event: Bidi.BrowsingContext.Info) {
|
#onContextDomLoaded(event: Bidi.BrowsingContext.Info) {
|
||||||
const target = this.#targets.get(event.context);
|
const target = this.#targets.get(event.context);
|
||||||
if (target) {
|
if (target) {
|
||||||
@ -259,8 +255,13 @@ export class BidiBrowser extends Browser {
|
|||||||
override async createIncognitoBrowserContext(
|
override async createIncognitoBrowserContext(
|
||||||
_options?: BrowserContextOptions
|
_options?: BrowserContextOptions
|
||||||
): Promise<BidiBrowserContext> {
|
): Promise<BidiBrowserContext> {
|
||||||
const userContext = await this.#browserCore.createUserContext();
|
// TODO: implement incognito context https://github.com/w3c/webdriver-bidi/issues/289.
|
||||||
return this.#createBrowserContext(userContext);
|
const context = new BidiBrowserContext(this, {
|
||||||
|
defaultViewport: this.#defaultViewport,
|
||||||
|
isDefault: false,
|
||||||
|
});
|
||||||
|
this.#contexts.push(context);
|
||||||
|
return context;
|
||||||
}
|
}
|
||||||
|
|
||||||
override async version(): Promise<string> {
|
override async version(): Promise<string> {
|
||||||
@ -268,17 +269,28 @@ export class BidiBrowser extends Browser {
|
|||||||
}
|
}
|
||||||
|
|
||||||
override browserContexts(): BidiBrowserContext[] {
|
override browserContexts(): BidiBrowserContext[] {
|
||||||
return [...this.#browserCore.userContexts].map(context => {
|
// TODO: implement incognito context https://github.com/w3c/webdriver-bidi/issues/289.
|
||||||
return this.#browserContexts.get(context)!;
|
return this.#contexts;
|
||||||
|
}
|
||||||
|
|
||||||
|
async _closeContext(browserContext: BidiBrowserContext): Promise<void> {
|
||||||
|
this.#contexts = this.#contexts.filter(c => {
|
||||||
|
return c !== browserContext;
|
||||||
});
|
});
|
||||||
|
for (const target of browserContext.targets()) {
|
||||||
|
const page = await target?.page();
|
||||||
|
await page?.close().catch(error => {
|
||||||
|
debugError(error);
|
||||||
|
});
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
override defaultBrowserContext(): BidiBrowserContext {
|
override defaultBrowserContext(): BidiBrowserContext {
|
||||||
return this.#browserContexts.get(this.#browserCore.defaultUserContext)!;
|
return this.#defaultContext;
|
||||||
}
|
}
|
||||||
|
|
||||||
override newPage(): Promise<Page> {
|
override newPage(): Promise<Page> {
|
||||||
return this.defaultBrowserContext().newPage();
|
return this.#defaultContext.newPage();
|
||||||
}
|
}
|
||||||
|
|
||||||
override targets(): Target[] {
|
override targets(): Target[] {
|
||||||
|
@ -11,12 +11,10 @@ import {BrowserContext} from '../api/BrowserContext.js';
|
|||||||
import type {Page} from '../api/Page.js';
|
import type {Page} from '../api/Page.js';
|
||||||
import type {Target} from '../api/Target.js';
|
import type {Target} from '../api/Target.js';
|
||||||
import {UnsupportedOperation} from '../common/Errors.js';
|
import {UnsupportedOperation} from '../common/Errors.js';
|
||||||
import {debugError} from '../common/util.js';
|
|
||||||
import type {Viewport} from '../common/Viewport.js';
|
import type {Viewport} from '../common/Viewport.js';
|
||||||
|
|
||||||
import type {BidiBrowser} from './Browser.js';
|
import type {BidiBrowser} from './Browser.js';
|
||||||
import type {BidiConnection} from './Connection.js';
|
import type {BidiConnection} from './Connection.js';
|
||||||
import {UserContext} from './core/UserContext.js';
|
|
||||||
import type {BidiPage} from './Page.js';
|
import type {BidiPage} from './Page.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -24,6 +22,7 @@ import type {BidiPage} from './Page.js';
|
|||||||
*/
|
*/
|
||||||
export interface BidiBrowserContextOptions {
|
export interface BidiBrowserContextOptions {
|
||||||
defaultViewport: Viewport | null;
|
defaultViewport: Viewport | null;
|
||||||
|
isDefault: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -33,18 +32,14 @@ export class BidiBrowserContext extends BrowserContext {
|
|||||||
#browser: BidiBrowser;
|
#browser: BidiBrowser;
|
||||||
#connection: BidiConnection;
|
#connection: BidiConnection;
|
||||||
#defaultViewport: Viewport | null;
|
#defaultViewport: Viewport | null;
|
||||||
#userContext: UserContext;
|
#isDefault = false;
|
||||||
|
|
||||||
constructor(
|
constructor(browser: BidiBrowser, options: BidiBrowserContextOptions) {
|
||||||
browser: BidiBrowser,
|
|
||||||
userContext: UserContext,
|
|
||||||
options: BidiBrowserContextOptions
|
|
||||||
) {
|
|
||||||
super();
|
super();
|
||||||
this.#browser = browser;
|
this.#browser = browser;
|
||||||
this.#userContext = userContext;
|
|
||||||
this.#connection = this.#browser.connection;
|
this.#connection = this.#browser.connection;
|
||||||
this.#defaultViewport = options.defaultViewport;
|
this.#defaultViewport = options.defaultViewport;
|
||||||
|
this.#isDefault = options.isDefault;
|
||||||
}
|
}
|
||||||
|
|
||||||
override targets(): Target[] {
|
override targets(): Target[] {
|
||||||
@ -95,19 +90,11 @@ export class BidiBrowserContext extends BrowserContext {
|
|||||||
}
|
}
|
||||||
|
|
||||||
override async close(): Promise<void> {
|
override async close(): Promise<void> {
|
||||||
if (!this.isIncognito()) {
|
if (this.#isDefault) {
|
||||||
throw new Error('Default context cannot be closed!');
|
throw new Error('Default context cannot be closed!');
|
||||||
}
|
}
|
||||||
|
|
||||||
// TODO: Remove once we have adopted the new browsing contexts.
|
await this.#browser._closeContext(this);
|
||||||
for (const target of this.targets()) {
|
|
||||||
const page = await target?.page();
|
|
||||||
await page?.close().catch(error => {
|
|
||||||
debugError(error);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
await this.#userContext.remove();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
override browser(): BidiBrowser {
|
override browser(): BidiBrowser {
|
||||||
@ -126,7 +113,7 @@ export class BidiBrowserContext extends BrowserContext {
|
|||||||
}
|
}
|
||||||
|
|
||||||
override isIncognito(): boolean {
|
override isIncognito(): boolean {
|
||||||
return this.#userContext.id !== UserContext.DEFAULT;
|
return !this.#isDefault;
|
||||||
}
|
}
|
||||||
|
|
||||||
override overridePermissions(): never {
|
override overridePermissions(): never {
|
||||||
|
@ -53,14 +53,7 @@ export abstract class BidiTarget extends Target {
|
|||||||
/**
|
/**
|
||||||
* @internal
|
* @internal
|
||||||
*/
|
*/
|
||||||
export class BiDiBrowserTarget extends Target {
|
export class BiDiBrowserTarget extends BidiTarget {
|
||||||
#browser: BidiBrowser;
|
|
||||||
|
|
||||||
constructor(browser: BidiBrowser) {
|
|
||||||
super();
|
|
||||||
this.#browser = browser;
|
|
||||||
}
|
|
||||||
|
|
||||||
override url(): string {
|
override url(): string {
|
||||||
return '';
|
return '';
|
||||||
}
|
}
|
||||||
@ -68,26 +61,6 @@ export class BiDiBrowserTarget extends Target {
|
|||||||
override type(): TargetType {
|
override type(): TargetType {
|
||||||
return TargetType.BROWSER;
|
return TargetType.BROWSER;
|
||||||
}
|
}
|
||||||
|
|
||||||
override asPage(): Promise<Page> {
|
|
||||||
throw new UnsupportedOperation();
|
|
||||||
}
|
|
||||||
|
|
||||||
override browser(): BidiBrowser {
|
|
||||||
return this.#browser;
|
|
||||||
}
|
|
||||||
|
|
||||||
override browserContext(): BidiBrowserContext {
|
|
||||||
return this.#browser.defaultBrowserContext();
|
|
||||||
}
|
|
||||||
|
|
||||||
override opener(): never {
|
|
||||||
throw new UnsupportedOperation();
|
|
||||||
}
|
|
||||||
|
|
||||||
override createCDPSession(): Promise<CDPSession> {
|
|
||||||
throw new UnsupportedOperation();
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -52,7 +52,7 @@ export class Browser extends EventEmitter<{
|
|||||||
|
|
||||||
// keep-sorted start
|
// keep-sorted start
|
||||||
#reason: string | undefined;
|
#reason: string | undefined;
|
||||||
readonly #userContexts = new Map<string, UserContext>();
|
readonly #userContexts = new Map();
|
||||||
readonly session: Session;
|
readonly session: Session;
|
||||||
// keep-sorted end
|
// keep-sorted end
|
||||||
|
|
||||||
@ -63,10 +63,7 @@ export class Browser extends EventEmitter<{
|
|||||||
this.session = session;
|
this.session = session;
|
||||||
// keep-sorted end
|
// keep-sorted end
|
||||||
|
|
||||||
this.#userContexts.set(
|
this.#userContexts.set('', UserContext.create(this, ''));
|
||||||
UserContext.DEFAULT,
|
|
||||||
UserContext.create(this, UserContext.DEFAULT)
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async #initialize() {
|
async #initialize() {
|
||||||
@ -130,7 +127,7 @@ export class Browser extends EventEmitter<{
|
|||||||
|
|
||||||
get defaultUserContext(): UserContext {
|
get defaultUserContext(): UserContext {
|
||||||
// SAFETY: A UserContext is always created for the default context.
|
// SAFETY: A UserContext is always created for the default context.
|
||||||
return this.#userContexts.get(UserContext.DEFAULT)!;
|
return this.#userContexts.get('')!;
|
||||||
}
|
}
|
||||||
|
|
||||||
get userContexts(): Iterable<UserContext> {
|
get userContexts(): Iterable<UserContext> {
|
||||||
@ -190,21 +187,4 @@ export class Browser extends EventEmitter<{
|
|||||||
script,
|
script,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
async createUserContext(): Promise<UserContext> {
|
|
||||||
// TODO: implement incognito context https://github.com/w3c/webdriver-bidi/issues/289.
|
|
||||||
// TODO: Call `createUserContext` once available.
|
|
||||||
// Generating a monotonically increasing context id.
|
|
||||||
const context = `${++id}`;
|
|
||||||
|
|
||||||
const userContext = UserContext.create(this, context);
|
|
||||||
userContext.once('destroyed', () => {
|
|
||||||
this.#userContexts.delete(context);
|
|
||||||
});
|
|
||||||
|
|
||||||
this.#userContexts.set(userContext.id, userContext);
|
|
||||||
return userContext;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
let id = 0;
|
|
||||||
|
@ -33,16 +33,7 @@ export class UserContext extends EventEmitter<{
|
|||||||
/** The new browsing context. */
|
/** The new browsing context. */
|
||||||
browsingContext: BrowsingContext;
|
browsingContext: BrowsingContext;
|
||||||
};
|
};
|
||||||
/**
|
|
||||||
* Emitted when the user context is destroyed.
|
|
||||||
*/
|
|
||||||
destroyed: {
|
|
||||||
/** The user context that was destroyed. */
|
|
||||||
userContext: UserContext;
|
|
||||||
};
|
|
||||||
}> {
|
}> {
|
||||||
static DEFAULT = 'default';
|
|
||||||
|
|
||||||
static create(browser: Browser, id: string): UserContext {
|
static create(browser: Browser, id: string): UserContext {
|
||||||
const context = new UserContext(browser, id);
|
const context = new UserContext(browser, id);
|
||||||
context.#initialize();
|
context.#initialize();
|
||||||
@ -52,6 +43,8 @@ export class UserContext extends EventEmitter<{
|
|||||||
// keep-sorted start
|
// keep-sorted start
|
||||||
// Note these are only top-level contexts.
|
// Note these are only top-level contexts.
|
||||||
readonly #browsingContexts = new Map<string, BrowsingContext>();
|
readonly #browsingContexts = new Map<string, BrowsingContext>();
|
||||||
|
// @ts-expect-error -- TODO: This will be used once the WebDriver BiDi
|
||||||
|
// protocol supports it.
|
||||||
readonly #id: string;
|
readonly #id: string;
|
||||||
readonly browser: Browser;
|
readonly browser: Browser;
|
||||||
// keep-sorted end
|
// keep-sorted end
|
||||||
@ -98,9 +91,6 @@ export class UserContext extends EventEmitter<{
|
|||||||
get browsingContexts(): Iterable<BrowsingContext> {
|
get browsingContexts(): Iterable<BrowsingContext> {
|
||||||
return this.#browsingContexts.values();
|
return this.#browsingContexts.values();
|
||||||
}
|
}
|
||||||
get id(): string {
|
|
||||||
return this.#id;
|
|
||||||
}
|
|
||||||
// keep-sorted end
|
// keep-sorted end
|
||||||
|
|
||||||
async createBrowsingContext(
|
async createBrowsingContext(
|
||||||
@ -125,9 +115,11 @@ export class UserContext extends EventEmitter<{
|
|||||||
return browsingContext;
|
return browsingContext;
|
||||||
}
|
}
|
||||||
|
|
||||||
async remove(): Promise<void> {
|
async close(): Promise<void> {
|
||||||
// TODO: Call `removeUserContext` once available.
|
const promises = [];
|
||||||
this.emit('destroyed', {userContext: this});
|
for (const browsingContext of this.#browsingContexts.values()) {
|
||||||
this.removeAllListeners();
|
promises.push(browsingContext.close());
|
||||||
|
}
|
||||||
|
await Promise.all(promises);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user