Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

chore: merge various server-side markers for storage state page (#36893)

Dmitry Gozman52f9a0f4c2dd
diff --git a/packages/playwright-core/src/server/bidi/bidiBrowser.ts b/packages/playwright-core/src/server/bidi/bidiBrowser.ts
index 76847bd5d3..d91b3b6ade 100644
--- a/packages/playwright-core/src/server/bidi/bidiBrowser.ts
+++ b/packages/playwright-core/src/server/bidi/bidiBrowser.ts
@@ -180,7 +180,6 @@ export class BidiBrowser extends Browser {
export class BidiBrowserContext extends BrowserContext {
declare readonly _browser: BidiBrowser;
private _originToPermissions = new Map<string, string[]>();
- private _blockingPageCreations: Set<Promise<unknown>> = new Set();
private _initScriptIds = new Map<InitScript, string>();
constructor(browser: BidiBrowser, browserContextId: string | undefined, options: types.BrowserContextOptions) {
@@ -212,30 +211,12 @@ export class BidiBrowserContext extends BrowserContext {
return this._bidiPages().map(bidiPage => bidiPage._page);
}
- override async doCreateNewPage(markAsServerSideOnly?: boolean): Promise<Page> {
- const promise = this._createNewPageImpl(markAsServerSideOnly);
- if (markAsServerSideOnly)
- this._blockingPageCreations.add(promise);
- try {
- return await promise;
- } finally {
- this._blockingPageCreations.delete(promise);
- }
- }
-
- private async _createNewPageImpl(markAsServerSideOnly?: boolean): Promise<Page> {
+ override async doCreateNewPage(): Promise<Page> {
const { context } = await this._browser._browserSession.send('browsingContext.create', {
type: bidi.BrowsingContext.CreateType.Window,
userContext: this._browserContextId,
});
- const page = this._browser._bidiPages.get(context)!._page;
- if (markAsServerSideOnly)
- page.markAsServerSideOnly();
- return page;
- }
-
- async waitForBlockingPageCreations() {
- await Promise.all([...this._blockingPageCreations].map(command => command.catch(() => {})));
+ return this._browser._bidiPages.get(context)!._page;
}
async doGetCookies(urls: string[]): Promise<channels.NetworkCookie[]> {
diff --git a/packages/playwright-core/src/server/bidi/bidiPage.ts b/packages/playwright-core/src/server/bidi/bidiPage.ts
index 97d07698f1..d9807955a6 100644
--- a/packages/playwright-core/src/server/bidi/bidiPage.ts
+++ b/packages/playwright-core/src/server/bidi/bidiPage.ts
@@ -94,10 +94,6 @@ export class BidiPage implements PageDelegate {
this.updateRequestInterception(),
// If the page is created by the Playwright client's call, some initialization
// may be pending. Wait for it to complete before reporting the page as new.
- //
- // TODO: ideally we'd wait only for the commands that created this page, but currently
- // there is no way in Bidi to track which command created this page.
- this._browserContext.waitForBlockingPageCreations(),
]);
}
diff --git a/packages/playwright-core/src/server/browserContext.ts b/packages/playwright-core/src/server/browserContext.ts
index d91f2f9668..1c52248f9a 100644
--- a/packages/playwright-core/src/server/browserContext.ts
+++ b/packages/playwright-core/src/server/browserContext.ts
@@ -244,7 +244,7 @@ export abstract class BrowserContext extends SdkObject {
// BrowserContext methods.
abstract possiblyUninitializedPages(): Page[];
- abstract doCreateNewPage(markAsServerSideOnly?: boolean): Promise<Page>;
+ abstract doCreateNewPage(): Promise<Page>;
abstract addCookies(cookies: channels.SetNetworkCookie[]): Promise<void>;
abstract setGeolocation(geolocation?: types.Geolocation): Promise<void>;
abstract setUserAgent(userAgent: string | undefined): Promise<void>;
@@ -418,7 +418,7 @@ export abstract class BrowserContext extends SdkObject {
// Workaround for:
// - chromium fails to change isMobile for existing page;
// - webkit fails to change locale for existing page.
- await this.newPage(progress, false);
+ await this.newPage(progress);
await defaultPage.close();
}
}
@@ -538,9 +538,11 @@ export abstract class BrowserContext extends SdkObject {
await this._closePromise;
}
- async newPage(progress: Progress, isServerSide: boolean): Promise<Page> {
- const page = await progress.race(this.doCreateNewPage(isServerSide));
+ async newPage(progress: Progress, forStorageState?: boolean): Promise<Page> {
+ let page: Page | undefined;
try {
+ this._creatingStorageStatePage = !!forStorageState;
+ page = await progress.race(this.doCreateNewPage());
const pageOrError = await progress.race(page.waitForInitializedOrError());
if (pageOrError instanceof Page) {
if (pageOrError.isClosed())
@@ -549,8 +551,10 @@ export abstract class BrowserContext extends SdkObject {
}
throw pageOrError;
} catch (error) {
- await page.close({ reason: 'Failed to create page' }).catch(() => {});
+ await page?.close({ reason: 'Failed to create page' }).catch(() => {});
throw error;
+ } finally {
+ this._creatingStorageStatePage = false;
}
}
@@ -589,7 +593,7 @@ export abstract class BrowserContext extends SdkObject {
// If there are still origins to save, create a blank page to iterate over origins.
if (originsToSave.size) {
- const page = await this.newPage(progress, true);
+ const page = await this.newPage(progress, true /* forStorageState */);
try {
await page.addRequestInterceptor(progress, route => {
route.fulfill({ body: '<html></html>' }).catch(() => {});
@@ -629,14 +633,8 @@ export abstract class BrowserContext extends SdkObject {
if (allOrigins.size) {
if (mode === 'resetForReuse')
page = this.pages()[0];
- if (!page) {
- try {
- this._creatingStorageStatePage = mode !== 'resetForReuse';
- page = await this.newPage(progress, this._creatingStorageStatePage);
- } finally {
- this._creatingStorageStatePage = false;
- }
- }
+ if (!page)
+ page = await this.newPage(progress, mode !== 'resetForReuse' /* forStorageState */);
interceptor = (route: network.Route) => {
route.fulfill({ body: '<html></html>' }).catch(() => {});
diff --git a/packages/playwright-core/src/server/chromium/crBrowser.ts b/packages/playwright-core/src/server/chromium/crBrowser.ts
index 37b9a7d47e..decbf3a861 100644
--- a/packages/playwright-core/src/server/chromium/crBrowser.ts
+++ b/packages/playwright-core/src/server/chromium/crBrowser.ts
@@ -370,12 +370,9 @@ export class CRBrowserContext extends BrowserContext {
return this._crPages().map(crPage => crPage._page);
}
- override async doCreateNewPage(markAsServerSideOnly?: boolean): Promise<Page> {
+ override async doCreateNewPage(): Promise<Page> {
const { targetId } = await this._browser._session.send('Target.createTarget', { url: 'about:blank', browserContextId: this._browserContextId });
- const page = this._browser._crPages.get(targetId)!._page;
- if (markAsServerSideOnly)
- page.markAsServerSideOnly();
- return page;
+ return this._browser._crPages.get(targetId)!._page;
}
async doGetCookies(urls: string[]): Promise<channels.NetworkCookie[]> {
diff --git a/packages/playwright-core/src/server/chromium/crPage.ts b/packages/playwright-core/src/server/chromium/crPage.ts
index 79cb7d51ba..34e9e892d2 100644
--- a/packages/playwright-core/src/server/chromium/crPage.ts
+++ b/packages/playwright-core/src/server/chromium/crPage.ts
@@ -446,8 +446,7 @@ class FrameSession {
}
async _initialize(hasUIWindow: boolean) {
- const isSettingStorageState = this._page.browserContext.isCreatingStorageStatePage();
- if (!isSettingStorageState && hasUIWindow &&
+ if (!this._page.isStorageStatePage && hasUIWindow &&
!this._crPage._browserContext._browser.isClank() &&
!this._crPage._browserContext._options.noDefaultViewport) {
const { windowId } = await this._client.send('Browser.getWindowForTarget');
@@ -455,7 +454,7 @@ class FrameSession {
}
let screencastOptions: types.PageScreencastOptions | undefined;
- if (!isSettingStorageState && this._isMainFrame() && this._crPage._browserContext._options.recordVideo && hasUIWindow) {
+ if (!this._page.isStorageStatePage && this._isMainFrame() && this._crPage._browserContext._options.recordVideo && hasUIWindow) {
const screencastId = createGuid();
const outputFile = path.join(this._crPage._browserContext._options.recordVideo.dir, screencastId + '.webm');
screencastOptions = {
@@ -527,7 +526,7 @@ class FrameSession {
]
}),
];
- if (!isSettingStorageState) {
+ if (!this._page.isStorageStatePage) {
if (this._crPage._browserContext.needsPlaywrightBinding())
promises.push(this.exposePlaywrightBinding());
if (this._isMainFrame())
diff --git a/packages/playwright-core/src/server/debugController.ts b/packages/playwright-core/src/server/debugController.ts
index 89b133d997..295b18c136 100644
--- a/packages/playwright-core/src/server/debugController.ts
+++ b/packages/playwright-core/src/server/debugController.ts
@@ -91,7 +91,7 @@ export class DebugController extends SdkObject {
if (!pages.length) {
const [browser] = this._playwright.allBrowsers();
const context = await browser.newContextForReuse(progress, {});
- await context.newPage(progress, false /* isServerSide */);
+ await context.newPage(progress);
}
// Update test id attribute.
if (params.testIdAttributeName) {
diff --git a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
index 6803d00e52..a62fcd607f 100644
--- a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
@@ -249,7 +249,7 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
}
async newPage(params: channels.BrowserContextNewPageParams, progress: Progress): Promise<channels.BrowserContextNewPageResult> {
- return { page: PageDispatcher.from(this, await this._context.newPage(progress, false /* isServerSide */)) };
+ return { page: PageDispatcher.from(this, await this._context.newPage(progress)) };
}
async cookies(params: channels.BrowserContextCookiesParams, progress: Progress): Promise<channels.BrowserContextCookiesResult> {
diff --git a/packages/playwright-core/src/server/firefox/ffBrowser.ts b/packages/playwright-core/src/server/firefox/ffBrowser.ts
index e019d6dd50..b9ae8f2d36 100644
--- a/packages/playwright-core/src/server/firefox/ffBrowser.ts
+++ b/packages/playwright-core/src/server/firefox/ffBrowser.ts
@@ -250,7 +250,7 @@ export class FFBrowserContext extends BrowserContext {
return this._ffPages().map(ffPage => ffPage._page);
}
- override async doCreateNewPage(markAsServerSideOnly?: boolean): Promise<Page> {
+ override async doCreateNewPage(): Promise<Page> {
const { targetId } = await this._browser.session.send('Browser.newPage', {
browserContextId: this._browserContextId
}).catch(e => {
@@ -258,11 +258,7 @@ export class FFBrowserContext extends BrowserContext {
throw new Error(`Invalid timezone ID: ${this._options.timezoneId}`);
throw e;
});
- const page = this._browser._ffPages.get(targetId)!._page;
- if (markAsServerSideOnly)
- page.markAsServerSideOnly();
- return page;
-
+ return this._browser._ffPages.get(targetId)!._page;
}
async doGetCookies(urls: string[]): Promise<channels.NetworkCookie[]> {
diff --git a/packages/playwright-core/src/server/page.ts b/packages/playwright-core/src/server/page.ts
index 172014360e..20883814b8 100644
--- a/packages/playwright-core/src/server/page.ts
+++ b/packages/playwright-core/src/server/page.ts
@@ -161,7 +161,7 @@ export class Page extends SdkObject {
readonly requestInterceptors: network.RouteHandler[] = [];
video: Artifact | null = null;
private _opener: Page | undefined;
- private _isServerSideOnly = false;
+ readonly isStorageStatePage: boolean;
private _locatorHandlers = new Map<number, { selector: string, noWaitAfter?: boolean, resolved?: ManualPromise<void> }>();
private _lastLocatorHandlerUid = 0;
private _locatorHandlerRunningCounter = 0;
@@ -186,6 +186,7 @@ export class Page extends SdkObject {
if (delegate.pdf)
this.pdf = delegate.pdf.bind(delegate);
this.coverage = delegate.coverage ? delegate.coverage() : null;
+ this.isStorageStatePage = browserContext.isCreatingStorageStatePage();
}
async reportAsNew(opener: Page | undefined, error: Error | undefined = undefined, contextEvent: string = BrowserContext.Events.Page) {
@@ -234,13 +235,13 @@ export class Page extends SdkObject {
}
emitOnContext(event: string | symbol, ...args: any[]) {
- if (this._isServerSideOnly)
+ if (this.isStorageStatePage)
return;
this.browserContext.emit(event, ...args);
}
emitOnContextOnceInitialized(event: string | symbol, ...args: any[]) {
- if (this._isServerSideOnly)
+ if (this.isStorageStatePage)
return;
// Some events, like console messages, may come before page is ready.
// In this case, postpone the event until page is initialized,
@@ -813,10 +814,6 @@ export class Page extends SdkObject {
await Promise.all(this.frames().map(frame => frame.hideHighlight().catch(() => {})));
}
- markAsServerSideOnly() {
- this._isServerSideOnly = true;
- }
-
async snapshotForAI(progress: Progress): Promise<string> {
this.lastSnapshotFrameIds = [];
const snapshot = await snapshotFrameForAI(progress, this.mainFrame(), 0, this.lastSnapshotFrameIds);
diff --git a/packages/playwright-core/src/server/webkit/wkBrowser.ts b/packages/playwright-core/src/server/webkit/wkBrowser.ts
index f6b26c7e7b..5ee778b830 100644
--- a/packages/playwright-core/src/server/webkit/wkBrowser.ts
+++ b/packages/playwright-core/src/server/webkit/wkBrowser.ts
@@ -244,12 +244,9 @@ export class WKBrowserContext extends BrowserContext {
return this._wkPages().map(wkPage => wkPage._page);
}
- override async doCreateNewPage(markAsServerSideOnly?: boolean): Promise<Page> {
+ override async doCreateNewPage(): Promise<Page> {
const { pageProxyId } = await this._browser._browserSession.send('Playwright.createPage', { browserContextId: this._browserContextId });
- const page = this._browser._wkPages.get(pageProxyId)!._page;
- if (markAsServerSideOnly)
- page.markAsServerSideOnly();
- return page;
+ return this._browser._wkPages.get(pageProxyId)!._page;
}
async doGetCookies(urls: string[]): Promise<channels.NetworkCookie[]> {
diff --git a/packages/playwright-core/src/server/webkit/wkPage.ts b/packages/playwright-core/src/server/webkit/wkPage.ts
index ed27e46710..0452a22552 100644
--- a/packages/playwright-core/src/server/webkit/wkPage.ts
+++ b/packages/playwright-core/src/server/webkit/wkPage.ts
@@ -113,7 +113,7 @@ export class WKPage implements PageDelegate {
}
private async _initializePageProxySession() {
- if (this._page.browserContext.isCreatingStorageStatePage())
+ if (this._page.isStorageStatePage)
return;
const promises: Promise<any>[] = [
this._pageProxySession.send('Dialog.enable'),
@@ -187,7 +187,7 @@ export class WKPage implements PageDelegate {
promises.push(session.send('Network.setResourceCachingDisabled', { disabled: true }));
promises.push(session.send('Network.addInterception', { url: '.*', stage: 'request', isRegex: true }));
}
- if (this._page.browserContext.isCreatingStorageStatePage()) {
+ if (this._page.isStorageStatePage) {
await Promise.all(promises);
return;
}