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
chore: make navigation actions' progress "strict" (#36321)
Dmitry Gozman55cb7c916c82
diff --git a/packages/playwright-core/src/server/frames.ts b/packages/playwright-core/src/server/frames.tsindex 8623e4b130..4d2d62df9a 100644--- a/packages/playwright-core/src/server/frames.ts+++ b/packages/playwright-core/src/server/frames.ts@@ -583,7 +583,7 @@ export class Frame extends SdkObject {}}- async raceNavigationAction(progress: Progress, options: types.GotoOptions, action: () => Promise<network.Response | null>): Promise<network.Response | null> {+ async raceNavigationAction(progress: Progress, action: () => Promise<network.Response | null>): Promise<network.Response | null> {return LongStandingScope.raceMultiple([this._detachedScope,this._page.openScope,@@ -592,7 +592,7 @@ export class Frame extends SdkObject {const data = this._redirectedNavigations.get(e.documentId);if (data) {progress.log(`waiting for redirected navigation to "${data.url}"`);- return data.gotoPromise;+ return progress.race(data.gotoPromise);}}throw e;@@ -600,7 +600,7 @@ export class Frame extends SdkObject {}redirectNavigation(url: string, documentId: string, referer: string | undefined) {- const controller = new ProgressController(serverSideCallMetadata(), this);+ const controller = new ProgressController(serverSideCallMetadata(), this, 'strict');const data = {url,gotoPromise: controller.run(progress => this.gotoImpl(progress, url, { referer }), 0),@@ -610,10 +610,10 @@ export class Frame extends SdkObject {}async goto(metadata: CallMetadata, url: string, options: types.GotoOptions): Promise<network.Response | null> {- const constructedNavigationURL = constructURLBasedOnBaseURL(this._page.browserContext._options.baseURL, url);- const controller = new ProgressController(metadata, this);+ const controller = new ProgressController(metadata, this, 'strict');return controller.run(progress => {- return this.raceNavigationAction(progress, options, async () => this.gotoImpl(progress, constructedNavigationURL, options));+ const constructedNavigationURL = constructURLBasedOnBaseURL(this._page.browserContext._options.baseURL, url);+ return this.raceNavigationAction(progress, async () => this.gotoImpl(progress, constructedNavigationURL, options));}, options.timeout);}@@ -633,7 +633,7 @@ export class Frame extends SdkObject {const navigationEvents: NavigationEvent[] = [];const collectNavigations = (arg: NavigationEvent) => navigationEvents.push(arg);this.on(Frame.Events.InternalNavigation, collectNavigations);- const navigateResult = await this._page.delegate.navigateFrame(this, url, referer).finally(+ const navigateResult = await progress.race(this._page.delegate.navigateFrame(this, url, referer)).finally(() => this.off(Frame.Events.InternalNavigation, collectNavigations));let event: NavigationEvent;@@ -669,7 +669,7 @@ export class Frame extends SdkObject {await helper.waitForEvent(progress, this, Frame.Events.AddLifecycle, (e: types.LifecycleEvent) => e === waitUntil).promise;const request = event.newDocument ? event.newDocument.request : undefined;- const response = request ? request._finalRequest().response() : null;+ const response = request ? progress.race(request._finalRequest().response()) : null;return response;}@@ -693,7 +693,7 @@ export class Frame extends SdkObject {await helper.waitForEvent(progress, this, Frame.Events.AddLifecycle, (e: types.LifecycleEvent) => e === waitUntil).promise;const request = navigationEvent.newDocument ? navigationEvent.newDocument.request : undefined;- return request ? request._finalRequest().response() : null;+ return request ? progress.race(request._finalRequest().response()) : null;}async _waitForLoadState(progress: Progress, state: types.LifecycleEvent): Promise<void> {@@ -871,26 +871,27 @@ export class Frame extends SdkObject {}async setContent(metadata: CallMetadata, html: string, options: types.NavigateOptions): Promise<void> {- const controller = new ProgressController(metadata, this);+ const controller = new ProgressController(metadata, this, 'strict');return controller.run(async progress => {- await this.raceNavigationAction(progress, options, async () => {+ await this.raceNavigationAction(progress, async () => {const waitUntil = options.waitUntil === undefined ? 'load' : options.waitUntil;progress.log(`setting frame content, waiting until "${waitUntil}"`);const tag = `--playwright--set--content--${this._id}--${++this._setContentCounter}--`;- const context = await this._utilityContext();- const lifecyclePromise = new Promise((resolve, reject) => {- this._page.frameManager._consoleMessageTags.set(tag, () => {- // Clear lifecycle right after document.open() - see 'tag' below.- this._onClearLifecycle();- this._waitForLoadState(progress, waitUntil).then(resolve).catch(reject);- });+ const context = await progress.race(this._utilityContext());+ const tagPromise = new ManualPromise<void>();+ this._page.frameManager._consoleMessageTags.set(tag, () => {+ // Clear lifecycle right after document.open() - see 'tag' below.+ this._onClearLifecycle();+ tagPromise.resolve();});- const contentPromise = context.evaluate(({ html, tag }) => {+ progress.cleanupWhenAborted(() => this._page.frameManager._consoleMessageTags.delete(tag));+ const lifecyclePromise = progress.race(tagPromise).then(() => this._waitForLoadState(progress, waitUntil));+ const contentPromise = progress.race(context.evaluate(({ html, tag }) => {document.open();console.debug(tag); // eslint-disable-line no-consoledocument.write(html);document.close();- }, { html, tag });+ }, { html, tag }));await Promise.all([contentPromise, lifecyclePromise]);return null;});diff --git a/packages/playwright-core/src/server/helper.ts b/packages/playwright-core/src/server/helper.tsindex e5bf38dd77..fb6622846c 100644--- a/packages/playwright-core/src/server/helper.ts+++ b/packages/playwright-core/src/server/helper.ts@@ -72,7 +72,7 @@ class Helper {});const dispose = () => eventsHelper.removeEventListeners(listeners);progress.cleanupWhenAborted(dispose);- return { promise, dispose };+ return { promise: progress.race(promise), dispose };}static secondsToRoundishMillis(value: number): number {diff --git a/packages/playwright-core/src/server/network.ts b/packages/playwright-core/src/server/network.tsindex 739c109d8c..5536693c75 100644--- a/packages/playwright-core/src/server/network.ts+++ b/packages/playwright-core/src/server/network.ts@@ -190,7 +190,7 @@ export class Request extends SdkObject {return this._overrides?.headers || this._rawRequestHeadersPromise;}- response(): PromiseLike<Response | null> {+ response(): Promise<Response | null> {return this._waitForResponsePromise;}diff --git a/packages/playwright-core/src/server/page.ts b/packages/playwright-core/src/server/page.tsindex 13da603752..7e56b07abc 100644--- a/packages/playwright-core/src/server/page.ts+++ b/packages/playwright-core/src/server/page.ts@@ -369,22 +369,22 @@ export class Page extends SdkObject {}async reload(metadata: CallMetadata, options: types.NavigateOptions): Promise<network.Response | null> {- const controller = new ProgressController(metadata, this);- return controller.run(progress => this.mainFrame().raceNavigationAction(progress, options, async () => {+ const controller = new ProgressController(metadata, this, 'strict');+ return controller.run(progress => this.mainFrame().raceNavigationAction(progress, async () => {// Note: waitForNavigation may fail before we get response to reload(),// so we should await it immediately.const [response] = await Promise.all([// Reload must be a new document, and should not be confused with a stray pushState.this.mainFrame()._waitForNavigation(progress, true /* requiresNewDocument */, options),- this.delegate.reload(),+ progress.race(this.delegate.reload()),]);return response;}), options.timeout);}async goBack(metadata: CallMetadata, options: types.NavigateOptions): Promise<network.Response | null> {- const controller = new ProgressController(metadata, this);- return controller.run(progress => this.mainFrame().raceNavigationAction(progress, options, async () => {+ const controller = new ProgressController(metadata, this, 'strict');+ return controller.run(progress => this.mainFrame().raceNavigationAction(progress, async () => {// Note: waitForNavigation may fail before we get response to goBack,// so we should catch it immediately.let error: Error | undefined;@@ -392,9 +392,11 @@ export class Page extends SdkObject {error = e;return null;});- const result = await this.delegate.goBack();- if (!result)+ const result = await progress.race(this.delegate.goBack());+ if (!result) {+ waitPromise.catch(() => {}); // Avoid an unhandled rejection.return null;+ }const response = await waitPromise;if (error)throw error;@@ -403,8 +405,8 @@ export class Page extends SdkObject {}async goForward(metadata: CallMetadata, options: types.NavigateOptions): Promise<network.Response | null> {- const controller = new ProgressController(metadata, this);- return controller.run(progress => this.mainFrame().raceNavigationAction(progress, options, async () => {+ const controller = new ProgressController(metadata, this, 'strict');+ return controller.run(progress => this.mainFrame().raceNavigationAction(progress, async () => {// Note: waitForNavigation may fail before we get response to goForward,// so we should catch it immediately.let error: Error | undefined;@@ -412,9 +414,11 @@ export class Page extends SdkObject {error = e;return null;});- const result = await this.delegate.goForward();- if (!result)+ const result = await progress.race(this.delegate.goForward());+ if (!result) {+ waitPromise.catch(() => {}); // Avoid an unhandled rejection.return null;+ }const response = await waitPromise;if (error)throw error;diff --git a/tests/page/page-set-content.spec.ts b/tests/page/page-set-content.spec.tsindex 27fe18c860..38f5f111cc 100644--- a/tests/page/page-set-content.spec.ts+++ b/tests/page/page-set-content.spec.ts@@ -129,3 +129,31 @@ it('should return empty content there is no iframe src', async ({ page, browserNexpect(page.frames().length).toBe(2);expect(await page.frames()[1].content()).toBe('<html><head></head><body></body></html>');});++it('should handle timeout properly', async ({ page, toImpl, browserName }) => {+ it.skip(browserName === 'firefox', 'tampering with console.debug in utility world does not work');++ await toImpl(page).mainFrame().evaluateExpression(String(() => {+ window['saved'] = console.debug.bind(console);+ console.debug = () => {};+ }), { isFunction: true, world: 'utility' });+ const error = await page.setContent(`<div>hello</div>`, { timeout: 1000 }).catch(e => e);+ expect(error.message).toContain('page.setContent: Timeout 1000ms exceeded');++ // Should recover after timeout.+ await toImpl(page).mainFrame().evaluateExpression(String(() => {+ console.debug = window['saved'];+ }), { isFunction: true, world: 'utility' });+ await page.setContent(`<div>world</div>`);+ await expect(page.locator('div')).toHaveText('world');+});++it('should handle timeout properly 2', async ({ page, toImpl }) => {+ await toImpl(page).mainFrame().evaluateExpression(String(() => {+ document.close = () => {+ while (true) {}+ };+ }), { isFunction: true, world: 'utility' });+ const error = await page.setContent(`<div>hello</div>`, { timeout: 1000 }).catch(e => e);+ expect(error.message).toContain('page.setContent: Timeout 1000ms exceeded');+});