Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
fix: reset proper properties on reused context (#36501)
Dmitry Gozmanec13331627ec
diff --git a/packages/playwright-core/src/server/bidi/bidiBrowser.ts b/packages/playwright-core/src/server/bidi/bidiBrowser.tsindex 4c7a42fc8e..c1eb690fb7 100644--- a/packages/playwright-core/src/server/bidi/bidiBrowser.ts+++ b/packages/playwright-core/src/server/bidi/bidiBrowser.ts@@ -224,16 +224,7 @@ export class BidiBrowserContext extends BrowserContext {const promises: Promise<any>[] = [super._initialize(),];- if (this._options.viewport) {- promises.push(this._browser._browserSession.send('browsingContext.setViewport', {- viewport: {- width: this._options.viewport.width,- height: this._options.viewport.height- },- devicePixelRatio: this._options.deviceScaleFactor || 1,- userContexts: [this._userContextId()],- }));- }+ promises.push(this.doUpdateDefaultViewport());if (this._options.geolocation)promises.push(this.setGeolocation(this._options.geolocation));await Promise.all(promises);@@ -389,6 +380,22 @@ export class BidiBrowserContext extends BrowserContext {async doUpdateRequestInterception(): Promise<void> {}+ override async doUpdateDefaultViewport() {+ if (!this._options.viewport)+ return;+ await this._browser._browserSession.send('browsingContext.setViewport', {+ viewport: {+ width: this._options.viewport.width,+ height: this._options.viewport.height+ },+ devicePixelRatio: this._options.deviceScaleFactor || 1,+ userContexts: [this._userContextId()],+ });+ }++ override async doUpdateDefaultEmulatedMedia() {+ }+override async doExposePlaywrightBinding() {const args: bidi.Script.ChannelValue[] = [{type: 'channel',diff --git a/packages/playwright-core/src/server/browserContext.ts b/packages/playwright-core/src/server/browserContext.tsindex 32cc2caf46..0b8247bc63 100644--- a/packages/playwright-core/src/server/browserContext.ts+++ b/packages/playwright-core/src/server/browserContext.ts@@ -212,21 +212,17 @@ export abstract class BrowserContext extends SdkObject {// Navigate to about:blank first to ensure no page scripts are running after this point.await page?.mainFrame().gotoImpl(progress, 'about:blank', {});+ // Note: we only need to reset properties from the "paramsThatAllowContextReuse" list.+ // All other properties force a new context.await this._resetStorage(progress);-- const resetOptions = async () => {- await this.clock.resetForReuse();- // TODO: following can be optimized to not perform noops.- if (this._options.permissions)- await this.grantPermissions(this._options.permissions);- else- await this.clearPermissions();- await this.setGeolocation(this._options.geolocation);- await this.setUserAgent(this._options.userAgent);- await this.clearCache();- await this._resetCookies();- };- await progress.race(resetOptions());+ await progress.race(this.clock.resetForReuse());+ await progress.race(this.setUserAgent(this._options.userAgent));+ await progress.race(this.clearCache());+ await progress.race(this.doClearCookies());+ await progress.race(this.doUpdateDefaultEmulatedMedia());+ await progress.race(this.doUpdateDefaultViewport());+ if (this._options.storageState?.cookies)+ await progress.race(this.addCookies(this._options.storageState?.cookies));await page?.resetForReuse(progress);}@@ -273,6 +269,8 @@ export abstract class BrowserContext extends SdkObject {protected abstract doUpdateExtraHTTPHeaders(): Promise<void>;protected abstract doUpdateOffline(): Promise<void>;protected abstract doUpdateRequestInterception(): Promise<void>;+ protected abstract doUpdateDefaultViewport(): Promise<void>;+ protected abstract doUpdateDefaultEmulatedMedia(): Promise<void>;protected abstract doExposePlaywrightBinding(): Promise<void>;protected abstract doClose(reason: string | undefined): Promise<void>;protected abstract onClosePersistent(): void;@@ -624,12 +622,6 @@ export abstract class BrowserContext extends SdkObject {// It is safe to not restore the URL to about:blank since we are doing it in Page::resetForReuse.}- async _resetCookies() {- await this.doClearCookies();- if (this._options.storageState?.cookies)- await this.addCookies(this._options.storageState?.cookies);- }-isSettingStorageState(): boolean {return this._settingStorageState;}diff --git a/packages/playwright-core/src/server/chromium/crBrowser.ts b/packages/playwright-core/src/server/chromium/crBrowser.tsindex b58ac97986..626ee3d221 100644--- a/packages/playwright-core/src/server/chromium/crBrowser.ts+++ b/packages/playwright-core/src/server/chromium/crBrowser.ts@@ -523,6 +523,14 @@ export class CRBrowserContext extends BrowserContext {await (sw as CRServiceWorker).updateRequestInterception();}+ override async doUpdateDefaultViewport() {+ // No-op, because each page resets its own viewport.+ }++ override async doUpdateDefaultEmulatedMedia() {+ // No-op, because each page resets its own color scheme.+ }+override async doExposePlaywrightBinding() {for (const page of this._crPages())await page.exposePlaywrightBinding();diff --git a/packages/playwright-core/src/server/firefox/ffBrowser.ts b/packages/playwright-core/src/server/firefox/ffBrowser.tsindex 577ec2ac80..e019d6dd50 100644--- a/packages/playwright-core/src/server/firefox/ffBrowser.ts+++ b/packages/playwright-core/src/server/firefox/ffBrowser.ts@@ -195,13 +195,7 @@ export class FFBrowserContext extends BrowserContext {},}));}- if (this._options.viewport) {- const viewport = {- viewportSize: { width: this._options.viewport.width, height: this._options.viewport.height },- deviceScaleFactor: this._options.deviceScaleFactor || 1,- };- promises.push(this._browser.session.send('Browser.setDefaultViewport', { browserContextId, viewport }));- }+ promises.push(this.doUpdateDefaultViewport());if (this._options.hasTouch)promises.push(this._browser.session.send('Browser.setTouchOverride', { browserContextId, hasTouch: true }));if (this._options.userAgent)@@ -224,30 +218,7 @@ export class FFBrowserContext extends BrowserContext {promises.push(this.setGeolocation(this._options.geolocation));if (this._options.offline)promises.push(this.doUpdateOffline());- if (this._options.colorScheme !== 'no-override') {- promises.push(this._browser.session.send('Browser.setColorScheme', {- browserContextId,- colorScheme: this._options.colorScheme !== undefined ? this._options.colorScheme : 'light',- }));- }- if (this._options.reducedMotion !== 'no-override') {- promises.push(this._browser.session.send('Browser.setReducedMotion', {- browserContextId,- reducedMotion: this._options.reducedMotion !== undefined ? this._options.reducedMotion : 'no-preference',- }));- }- if (this._options.forcedColors !== 'no-override') {- promises.push(this._browser.session.send('Browser.setForcedColors', {- browserContextId,- forcedColors: this._options.forcedColors !== undefined ? this._options.forcedColors : 'none',- }));- }- if (this._options.contrast !== 'no-override') {- promises.push(this._browser.session.send('Browser.setContrast', {- browserContextId,- contrast: this._options.contrast !== undefined ? this._options.contrast : 'no-preference',- }));- }+ promises.push(this.doUpdateDefaultEmulatedMedia());if (this._options.recordVideo) {promises.push(this._ensureVideosPath().then(() => {return this._browser.session.send('Browser.setVideoRecordingOptions', {@@ -407,6 +378,43 @@ export class FFBrowserContext extends BrowserContext {]);}+ override async doUpdateDefaultViewport() {+ if (!this._options.viewport)+ return;+ const viewport = {+ viewportSize: { width: this._options.viewport.width, height: this._options.viewport.height },+ deviceScaleFactor: this._options.deviceScaleFactor || 1,+ };+ await this._browser.session.send('Browser.setDefaultViewport', { browserContextId: this._browserContextId, viewport });+ }++ override async doUpdateDefaultEmulatedMedia() {+ if (this._options.colorScheme !== 'no-override') {+ await this._browser.session.send('Browser.setColorScheme', {+ browserContextId: this._browserContextId,+ colorScheme: this._options.colorScheme !== undefined ? this._options.colorScheme : 'light',+ });+ }+ if (this._options.reducedMotion !== 'no-override') {+ await this._browser.session.send('Browser.setReducedMotion', {+ browserContextId: this._browserContextId,+ reducedMotion: this._options.reducedMotion !== undefined ? this._options.reducedMotion : 'no-preference',+ });+ }+ if (this._options.forcedColors !== 'no-override') {+ await this._browser.session.send('Browser.setForcedColors', {+ browserContextId: this._browserContextId,+ forcedColors: this._options.forcedColors !== undefined ? this._options.forcedColors : 'none',+ });+ }+ if (this._options.contrast !== 'no-override') {+ await this._browser.session.send('Browser.setContrast', {+ browserContextId: this._browserContextId,+ contrast: this._options.contrast !== undefined ? this._options.contrast : 'no-preference',+ });+ }+ }+override async doExposePlaywrightBinding() {this._browser.session.send('Browser.addBinding', { browserContextId: this._browserContextId, name: PageBinding.kBindingName, script: '' });}diff --git a/packages/playwright-core/src/server/page.ts b/packages/playwright-core/src/server/page.tsindex c8c9b9ec29..6395a2565e 100644--- a/packages/playwright-core/src/server/page.ts+++ b/packages/playwright-core/src/server/page.ts@@ -253,18 +253,16 @@ export class Page extends SdkObject {}async resetForReuse(progress: Progress) {- this._locatorHandlers.clear();-// Re-navigate once init scripts are gone.- // TODO: we should have a timeout for `resetForReuse`.await this.mainFrame().gotoImpl(progress, 'about:blank', {});+this._emulatedSize = undefined;this._emulatedMedia = {};this._extraHTTPHeaders = undefined;-await Promise.all([this.delegate.updateEmulatedViewportSize(),this.delegate.updateEmulateMedia(),+ this.delegate.updateExtraHTTPHeaders(),]);await this.delegate.resetForReuse(progress);diff --git a/packages/playwright-core/src/server/webkit/wkBrowser.ts b/packages/playwright-core/src/server/webkit/wkBrowser.tsindex 68a9d4edfe..f1eccfd100 100644--- a/packages/playwright-core/src/server/webkit/wkBrowser.ts+++ b/packages/playwright-core/src/server/webkit/wkBrowser.ts@@ -345,6 +345,14 @@ export class WKBrowserContext extends BrowserContext {await (page.delegate as WKPage).updateRequestInterception();}+ override async doUpdateDefaultViewport() {+ // No-op, because each page resets its own viewport.+ }++ override async doUpdateDefaultEmulatedMedia() {+ // No-op, because each page resets its own color scheme.+ }+override async doExposePlaywrightBinding() {for (const page of this.pages())await (page.delegate as WKPage).exposePlaywrightBinding();diff --git a/tests/library/browsercontext-reuse.spec.ts b/tests/library/browsercontext-reuse.spec.tsindex 801c92c753..5d5c6a5edd 100644--- a/tests/library/browsercontext-reuse.spec.ts+++ b/tests/library/browsercontext-reuse.spec.ts@@ -15,13 +15,14 @@*/import { browserTest, expect } from '../config/browserTest';-import type { BrowserContext, Page } from '@playwright/test';+import { verifyViewport } from '../config/utils';+import type { BrowserContext, Page, BrowserContextOptions } from '@playwright/test';-const test = browserTest.extend<{ reusedContext: () => Promise<BrowserContext> }>({+const test = browserTest.extend<{ reusedContext: (options?: BrowserContextOptions) => Promise<BrowserContext> }>({reusedContext: async ({ browserType, browser }, use) => {- await use(async () => {+ await use(async options => {const defaultContextOptions = (browserType as any)._playwright._defaultContextOptions;- const context = await (browser as any)._newContextForReuse(defaultContextOptions);+ const context = await (browser as any)._newContextForReuse({ ...defaultContextOptions, ...options });return context;});},@@ -326,3 +327,16 @@ test('should work with routeWebSocket', async ({ reusedContext, server, browserawait page.evaluate(() => (window as any).ws2.send('request'));await expect.poll(() => page.evaluate(() => window.log)).toEqual([`ws1:page-mock-after`, `ws2:context-mock-after`]);});++test('should update viewport and media', async ({ reusedContext }) => {+ let context = await reusedContext({ viewport: { width: 800, height: 600 }, colorScheme: 'dark' });+ let page = await context.newPage();+ expect(await page.evaluate(() => matchMedia('(prefers-color-scheme: dark)').matches)).toBe(true);+ await verifyViewport(page, 800, 600);+ await page.close();++ context = await reusedContext({ viewport: { width: 600, height: 800 }, colorScheme: 'light' });+ page = await context.newPage();+ expect(await page.evaluate(() => matchMedia('(prefers-color-scheme: light)').matches)).toBe(true);+ await verifyViewport(page, 600, 800);+});