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(worker): reject in-flight calls when the page closes or crashes (#43223)
Pavel Feldman27d46fa3cde9
diff --git a/packages/playwright-core/src/server/page.ts b/packages/playwright-core/src/server/page.tsindex 314d13e1be..57fe5df06c 100644--- a/packages/playwright-core/src/server/page.ts+++ b/packages/playwright-core/src/server/page.ts@@ -299,6 +299,7 @@ export class Page extends SdkObject<PageEventMap> {if (this.openScope.isClosed())return;this.frameManager.dispose(error);+ this.clearWorkers(error);this.screencast.dispose();this.overlay.dispose();this.highlightController.dispose();@@ -880,9 +881,9 @@ export class Page extends SdkObject<PageEventMap> {this._workers.delete(workerId);}- clearWorkers() {+ clearWorkers(error?: TargetClosedError) {for (const [workerId, worker] of this._workers) {- worker.didClose();+ worker.didClose(error);this._workers.delete(workerId);}}@@ -1025,19 +1026,24 @@ export class Worker extends SdkObject<WorkerEventMap> {this._executionContextPromise.resolve(this.existingExecutionContext);}- didClose() {+ didClose(error?: TargetClosedError) {if (this.existingExecutionContext)- this.existingExecutionContext.contextDestroyed('Worker was closed');+ this.existingExecutionContext.contextDestroyed(error?.message ?? 'Worker was closed');this.emit(Worker.Events.Close, this);- this.openScope.close(new Error('Worker closed'));+ this.openScope.close(error ?? new TargetClosedError(this.closeReason()));}async evaluateExpression(progress: Progress, expression: string, isFunction: boolean | undefined, arg: any): Promise<any> {- return progress.race(js.evaluateExpression(await this._executionContextPromise, expression, { returnByValue: true, isFunction }, arg));+ return progress.race(js.evaluateExpression(await this._executionContext(progress), expression, { returnByValue: true, isFunction }, arg));}async evaluateExpressionHandle(progress: Progress, expression: string, isFunction: boolean | undefined, arg: any): Promise<any> {- return progress.race(js.evaluateExpression(await this._executionContextPromise, expression, { returnByValue: false, isFunction }, arg));+ return progress.race(js.evaluateExpression(await this._executionContext(progress), expression, { returnByValue: false, isFunction }, arg));+ }++ private async _executionContext(progress: Progress): Promise<js.ExecutionContext> {+ // The worker may close before its execution context is ready.+ return await progress.race(this.openScope.race(this._executionContextPromise));}async disconnect(progress: Progress, options: { reason?: string } = {}) {diff --git a/tests/library/page-event-crash.spec.ts b/tests/library/page-event-crash.spec.tsindex 0512c1e7e5..09817f525e 100644--- a/tests/library/page-event-crash.spec.ts+++ b/tests/library/page-event-crash.spec.ts@@ -114,15 +114,21 @@ test('should be able to close page after crash', {expect(page.context().pages()).toEqual([]);});-test.fixme('should reject in-flight worker.evaluate when page crashes', async ({ page, crash, server }) => {+test('should reject in-flight worker.evaluate when page crashes', {+ annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright/issues/43204' },+}, async ({ page, crash, server }) => {await page.goto(server.EMPTY_PAGE);const [worker] = await Promise.all([page.waitForEvent('worker'),page.evaluate(() => new Worker(URL.createObjectURL(new Blob(['self.onmessage = () => {}'], { type: 'application/javascript' })))),]);+ const closePromise = new Promise(f => worker.once('close', f));const evalPromise = worker.evaluate(() => new Promise(() => {})).catch((e: Error) => e); // never resolves in-workercrash();const error = await evalPromise as Error;- expect(error.message).toContain('crash');+ // Chromium may detach the worker before it reports the crash.+ expect(error.message).toMatch(/Page crashed|Target page, context or browser has been closed/);+ await closePromise;+ expect(page.workers()).toEqual([]);});diff --git a/tests/page/workers.spec.ts b/tests/page/workers.spec.tsindex 03362021da..69724feb32 100644--- a/tests/page/workers.spec.ts+++ b/tests/page/workers.spec.ts@@ -50,6 +50,22 @@ it('should emit created and destroyed events', async function({ page }) {expect(error.message).toContain(kTargetClosedErrorMessage);});+it('should reject in-flight evaluate and emit close when page closes', {+ annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright/issues/43204' },+}, async function({ page, server }) {+ await page.goto(server.EMPTY_PAGE);+ const [worker] = await Promise.all([+ page.waitForEvent('worker'),+ page.evaluate(() => new Worker(URL.createObjectURL(new Blob(['1'], { type: 'application/javascript' })))),+ ]);+ const closePromise = new Promise(x => worker.once('close', x));+ const evalPromise = worker.evaluate(() => new Promise(() => {})).catch((e: Error) => e);+ await page.close();+ const error = await evalPromise as Error;+ expect(error.message).toContain('worker.evaluate');+ expect(await closePromise).toBe(worker);+});+it('should report console logs', async function({ page }) {const [message] = await Promise.all([page.waitForEvent('console'),