Skip to content

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

chore: abort pending operations upon disconnect (#36496)

Dmitry Gozman3fb78b65847b
diff --git a/packages/playwright-core/src/client/browser.ts b/packages/playwright-core/src/client/browser.ts
index f0903329c6..34ba2b0a7c 100644
--- a/packages/playwright-core/src/client/browser.ts
+++ b/packages/playwright-core/src/client/browser.ts
@@ -60,19 +60,20 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap
}
async _newContextForReuse(options: BrowserContextOptions = {}): Promise<BrowserContext> {
- return await this._wrapApiCall(async () => {
- for (const context of this._contexts) {
- await this._instrumentation.runBeforeCloseBrowserContext(context);
- for (const page of context.pages())
- page._onClose();
- context._onClose();
- }
- return await this._innerNewContext(options, true);
- }, { internal: true });
+ return await this._wrapApiCall(() => this._innerNewContext(options, true), { internal: true });
}
- async _stopPendingOperations(reason: string) {
- await this._channel.stopPendingOperations({ reason });
+ async _disconnectFromReusedContext(reason: string) {
+ return await this._wrapApiCall(async () => {
+ const context = [...this._contexts].find(context => context._forReuse);
+ if (!context)
+ return;
+ await this._instrumentation.runBeforeCloseBrowserContext(context);
+ for (const page of context.pages())
+ page._onClose();
+ context._onClose();
+ await this._channel.disconnectFromReusedContext({ reason });
+ }, { internal: true });
}
async _innerNewContext(options: BrowserContextOptions = {}, forReuse: boolean): Promise<BrowserContext> {
@@ -83,6 +84,8 @@ export class Browser extends ChannelOwner<channels.BrowserChannel> implements ap
const contextOptions = await prepareBrowserContextParams(this._platform, options);
const response = forReuse ? await this._channel.newContextForReuse(contextOptions) : await this._channel.newContext(contextOptions);
const context = BrowserContext.from(response.context);
+ if (forReuse)
+ context._forReuse = true;
if (options.logger)
context._logger = options.logger;
await context._initializeHarFromOptions(options.recordHar);
diff --git a/packages/playwright-core/src/client/browserContext.ts b/packages/playwright-core/src/client/browserContext.ts
index 830bbb3cf4..2c7c2ecc43 100644
--- a/packages/playwright-core/src/client/browserContext.ts
+++ b/packages/playwright-core/src/client/browserContext.ts
@@ -57,6 +57,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
readonly _bindings = new Map<string, (source: structs.BindingSource, ...args: any[]) => any>();
_timeoutSettings: TimeoutSettings;
_ownerPage: Page | undefined;
+ _forReuse = false;
private _closedPromise: Promise<void>;
readonly _options: channels.BrowserNewContextParams;
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.ts
index 801383caf7..8cb98e1d82 100644
--- a/packages/playwright-core/src/protocol/validator.ts
+++ b/packages/playwright-core/src/protocol/validator.ts
@@ -817,10 +817,10 @@ scheme.BrowserNewContextForReuseParams = tObject({
scheme.BrowserNewContextForReuseResult = tObject({
context: tChannel(['BrowserContext']),
});
-scheme.BrowserStopPendingOperationsParams = tObject({
+scheme.BrowserDisconnectFromReusedContextParams = tObject({
reason: tString,
});
-scheme.BrowserStopPendingOperationsResult = tOptional(tObject({}));
+scheme.BrowserDisconnectFromReusedContextResult = tOptional(tObject({}));
scheme.BrowserNewBrowserCDPSessionParams = tOptional(tObject({}));
scheme.BrowserNewBrowserCDPSessionResult = tObject({
session: tChannel(['CDPSession']),
diff --git a/packages/playwright-core/src/remote/playwrightConnection.ts b/packages/playwright-core/src/remote/playwrightConnection.ts
index 8a529f4b7a..8741a46fa4 100644
--- a/packages/playwright-core/src/remote/playwrightConnection.ts
+++ b/packages/playwright-core/src/remote/playwrightConnection.ts
@@ -112,6 +112,7 @@ export class PlaywrightConnection {
private async _onDisconnect(error?: Error) {
this._disconnected = true;
debugLogger.log('server', `[${this._id}] disconnected. error: ${error}`);
+ await this._root.stopPendingOperations(new Error('Disconnected')).catch(() => {});
this._root._dispose();
debugLogger.log('server', `[${this._id}] starting cleanup`);
for (const cleanup of this._cleanups)
diff --git a/packages/playwright-core/src/remote/playwrightServer.ts b/packages/playwright-core/src/remote/playwrightServer.ts
index dd339aec9d..49053eb249 100644
--- a/packages/playwright-core/src/remote/playwrightServer.ts
+++ b/packages/playwright-core/src/remote/playwrightServer.ts
@@ -221,8 +221,6 @@ export class PlaywrightServer {
for (const context of browser.contexts()) {
if (!context.pages().length)
await context.close({ reason: 'Connection terminated' });
- else
- await context.stopPendingOperations('Connection closed');
}
}
};
diff --git a/packages/playwright-core/src/server/browser.ts b/packages/playwright-core/src/server/browser.ts
index b989bb0eb0..073731ba8e 100644
--- a/packages/playwright-core/src/server/browser.ts
+++ b/packages/playwright-core/src/server/browser.ts
@@ -116,20 +116,20 @@ export abstract class Browser extends SdkObject {
return context;
}
- async newContextForReuse(progress: Progress, params: channels.BrowserNewContextForReuseParams): Promise<{ context: BrowserContext, needsReset: boolean }> {
+ async newContextForReuse(progress: Progress, params: channels.BrowserNewContextForReuseParams): Promise<BrowserContext> {
const hash = BrowserContext.reusableContextHash(params);
if (!this._contextForReuse || hash !== this._contextForReuse.hash || !this._contextForReuse.context.canResetForReuse()) {
if (this._contextForReuse)
await this._contextForReuse.context.close({ reason: 'Context reused' });
this._contextForReuse = { context: await this.newContext(progress, params), hash };
- return { context: this._contextForReuse.context, needsReset: false };
+ return this._contextForReuse.context;
}
- await this._contextForReuse.context.stopPendingOperations('Context recreated');
- return { context: this._contextForReuse.context, needsReset: true };
+ await this._contextForReuse.context.resetForReuse(progress, params);
+ return this._contextForReuse.context;
}
- async stopPendingOperations(reason: string) {
- await this._contextForReuse?.context?.stopPendingOperations(reason);
+ contextForReuse() {
+ return this._contextForReuse?.context;
}
_downloadCreated(page: Page, uuid: string, url: string, suggestedFilename?: string) {
diff --git a/packages/playwright-core/src/server/browserContext.ts b/packages/playwright-core/src/server/browserContext.ts
index f53e40d5ba..e78d7ce498 100644
--- a/packages/playwright-core/src/server/browserContext.ts
+++ b/packages/playwright-core/src/server/browserContext.ts
@@ -35,7 +35,6 @@ import { RecorderApp } from './recorder/recorderApp';
import { Selectors } from './selectors';
import { Tracing } from './trace/recorder/tracing';
import * as rawStorageSource from '../generated/storageScriptSource';
-import { ProgressController } from './progress';
import type { Artifact } from './artifact';
import type { Browser, BrowserOptions } from './browser';
@@ -67,7 +66,6 @@ export abstract class BrowserContext extends SdkObject {
};
readonly _pageBindings = new Map<string, PageBinding>();
- readonly _activeProgressControllers = new Set<ProgressController>();
readonly _options: types.BrowserContextOptions;
readonly requestInterceptors: network.RouteHandler[] = [];
private _isPersistentContext: boolean;
@@ -163,14 +161,6 @@ export abstract class BrowserContext extends SdkObject {
return true;
}
- async stopPendingOperations(reason: string) {
- // When using context reuse, stop pending operations to gracefully terminate all the actions
- // with a user-friendly error message containing operation log.
- await Promise.all(Array.from(this._activeProgressControllers).map(controller => controller.abort(reason)));
- // Let rejections in microtask generate events before returning.
- await new Promise(f => setTimeout(f, 0));
- }
-
static reusableContextHash(params: channels.BrowserNewContextForReuseParams): string {
const paramsCopy = { ...params };
diff --git a/packages/playwright-core/src/server/debugController.ts b/packages/playwright-core/src/server/debugController.ts
index 81d400eb9e..5b3ea9c0eb 100644
--- a/packages/playwright-core/src/server/debugController.ts
+++ b/packages/playwright-core/src/server/debugController.ts
@@ -104,7 +104,7 @@ export class DebugController extends SdkObject {
const pages = this._playwright.allPages();
if (!pages.length) {
const [browser] = this._playwright.allBrowsers();
- const { context } = await browser.newContextForReuse(progress, {});
+ const context = await browser.newContextForReuse(progress, {});
await context.newPage(progress, false /* isServerSide */);
}
// Update test id attribute.
diff --git a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
index 9fd5f53a65..9059389958 100644
--- a/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/browserContextDispatcher.ts
@@ -52,7 +52,7 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
private _subscriptions = new Set<channels.BrowserContextUpdateSubscriptionParams['event']>();
_webSocketInterceptionPatterns: channels.BrowserContextSetWebSocketInterceptionPatternsParams['patterns'] = [];
private _bindings: PageBinding[] = [];
- private _initScritps: InitScript[] = [];
+ private _initScripts: InitScript[] = [];
private _dialogHandler: (dialog: Dialog) => boolean;
private _clockPaused = false;
private _requestInterceptor: RouteHandler;
@@ -297,7 +297,7 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
}
async addInitScript(params: channels.BrowserContextAddInitScriptParams, progress: Progress): Promise<void> {
- this._initScritps.push(await this._context.addInitScript(progress, params.source));
+ this._initScripts.push(await this._context.addInitScript(progress, params.source));
}
async setNetworkInterceptionPatterns(params: channels.BrowserContextSetNetworkInterceptionPatternsParams, progress: Progress): Promise<void> {
@@ -415,8 +415,8 @@ export class BrowserContextDispatcher extends Dispatcher<BrowserContext, channel
this._context.removeRequestInterceptor(this._requestInterceptor).catch(() => {});
this._context.removeExposedBindings(this._bindings).catch(() => {});
this._bindings = [];
- this._context.removeInitScripts(this._initScritps).catch(() => {});
- this._initScritps = [];
+ this._context.removeInitScripts(this._initScripts).catch(() => {});
+ this._initScripts = [];
if (this._clockPaused)
this._context.clock.resumeNoReply();
this._clockPaused = false;
diff --git a/packages/playwright-core/src/server/dispatchers/browserDispatcher.ts b/packages/playwright-core/src/server/dispatchers/browserDispatcher.ts
index f4f9062eb5..d15db5ea49 100644
--- a/packages/playwright-core/src/server/dispatchers/browserDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/browserDispatcher.ts
@@ -76,20 +76,19 @@ export class BrowserDispatcher extends Dispatcher<Browser, channels.BrowserChann
}
async newContextForReuse(params: channels.BrowserNewContextForReuseParams, progress: Progress): Promise<channels.BrowserNewContextForReuseResult> {
- const { context, needsReset } = await this._object.newContextForReuse(progress, params);
- if (needsReset) {
- const oldContextDispatcher = this.connection.existingDispatcher<BrowserContextDispatcher>(context);
- if (oldContextDispatcher)
- oldContextDispatcher._dispose();
- await context.resetForReuse(progress, params);
- }
+ const context = await this._object.newContextForReuse(progress, params);
const contextDispatcher = BrowserContextDispatcher.from(this, context);
this._dispatchEvent('context', { context: contextDispatcher });
return { context: contextDispatcher };
}
- async stopPendingOperations(params: channels.BrowserStopPendingOperationsParams, progress: Progress): Promise<channels.BrowserStopPendingOperationsResult> {
- await this._object.stopPendingOperations(params.reason);
+ async disconnectFromReusedContext(params: channels.BrowserDisconnectFromReusedContextParams, progress: Progress): Promise<void> {
+ const context = this._object.contextForReuse();
+ const contextDispatcher = context ? this.connection.existingDispatcher<BrowserContextDispatcher>(context) : undefined;
+ if (contextDispatcher) {
+ await contextDispatcher.stopPendingOperations(new Error(params.reason));
+ contextDispatcher._dispose();
+ }
}
async close(params: channels.BrowserCloseParams, progress: Progress): Promise<void> {
diff --git a/packages/playwright-core/src/server/dispatchers/dispatcher.ts b/packages/playwright-core/src/server/dispatchers/dispatcher.ts
index 6f073edc9d..b868690877 100644
--- a/packages/playwright-core/src/server/dispatchers/dispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/dispatcher.ts
@@ -18,13 +18,13 @@ import { EventEmitter } from 'events';
import { eventsHelper } from '../utils/eventsHelper';
import { ValidationError, createMetadataValidator, findValidator } from '../../protocol/validator';
-import { LongStandingScope, assert, monotonicTime, rewriteErrorMessage } from '../../utils';
+import { assert, monotonicTime, rewriteErrorMessage } from '../../utils';
import { isUnderTest } from '../utils/debug';
import { TargetClosedError, isTargetClosedError, serializeError } from '../errors';
import { createRootSdkObject, SdkObject } from '../instrumentation';
import { isProtocolError } from '../protocolError';
import { compressCallLog } from '../callLog';
-import { methodMetainfo, progressTypes } from '../../utils/isomorphic/protocolMetainfo';
+import { methodMetainfo } from '../../utils/isomorphic/protocolMetainfo';
import { Progress, ProgressController } from '../progress';
import type { CallMetadata } from '../instrumentation';
@@ -48,18 +48,16 @@ function maxDispatchersForBucket(gcBucket: string) {
export class Dispatcher<Type extends SdkObject, ChannelType, ParentScopeType extends DispatcherScope> extends EventEmitter implements channels.Channel {
readonly connection: DispatcherConnection;
- // Parent is always "isScope".
private _parent: ParentScopeType | undefined;
- // Only "isScope" channel owners have registered dispatchers inside.
private _dispatchers = new Map<string, DispatcherScope>();
protected _disposed = false;
protected _eventListeners: RegisteredListener[] = [];
+ private _activeProgressControllers = new Set<ProgressController>();
readonly _guid: string;
readonly _type: string;
readonly _gcBucket: string;
_object: Type;
- private _openScope = new LongStandingScope();
constructor(parent: ParentScopeType | DispatcherConnection, object: Type, type: string, initializer: channels.InitializerTraits<ChannelType>, gcBucket?: string) {
super();
@@ -102,22 +100,13 @@ export class Dispatcher<Type extends SdkObject, ChannelType, ParentScopeType ext
this.connection.sendAdopt(this, child);
}
- private _runCommand(callMetadata: CallMetadata, method: string, validParams: any) {
- if (progressTypes.has(this._type)) {
- const controller = new ProgressController(callMetadata, this._object);
- return controller.run(progress => (this as any)[method](validParams, progress), validParams?.timeout);
- }
- return (this as any)[method](validParams, callMetadata);
- }
-
- async _handleCommand(callMetadata: CallMetadata, method: string, validParams: any) {
- const commandPromise = this._runCommand(callMetadata, method, validParams);
+ async _runCommand(callMetadata: CallMetadata, method: string, validParams: any) {
+ const controller = new ProgressController(callMetadata, this._object);
+ this._activeProgressControllers.add(controller);
try {
- return await this._openScope.race(commandPromise);
- } catch (e) {
- if (callMetadata.potentiallyClosesScope && isTargetClosedError(e))
- return await commandPromise;
- throw e;
+ return await controller.run(progress => (this as any)[method](validParams, progress), validParams?.timeout);
+ } finally {
+ this._activeProgressControllers.delete(controller);
}
}
@@ -139,8 +128,23 @@ export class Dispatcher<Type extends SdkObject, ChannelType, ParentScopeType ext
protected _onDispose() {
}
+ async stopPendingOperations(error: Error) {
+ const controllers: ProgressController[] = [];
+ const collect = (dispatcher: DispatcherScope) => {
+ controllers.push(...dispatcher._activeProgressControllers);
+ for (const child of [...dispatcher._dispatchers.values()])
+ collect(child);
+ };
+ collect(this);
+ await Promise.all(controllers.map(controller => controller.abort(error)));
+ }
+
private _disposeRecursively(error: Error) {
assert(!this._disposed, `${this._guid} is disposed more than once`);
+ for (const controller of this._activeProgressControllers) {
+ if (!controller.metadata.potentiallyClosesScope)
+ controller.abort(error).catch(() => {});
+ }
this._onDispose();
this._disposed = true;
eventsHelper.removeEventListeners(this._eventListeners);
@@ -156,7 +160,6 @@ export class Dispatcher<Type extends SdkObject, ChannelType, ParentScopeType ext
for (const dispatcher of [...this._dispatchers.values()])
dispatcher._disposeRecursively(error);
this._dispatchers.clear();
- this._openScope.close(error);
}
_debugScopeState(): any {
@@ -369,7 +372,7 @@ export class DispatcherConnection {
await sdkObject.instrumentation.onBeforeCall(sdkObject, callMetadata);
const response: any = { id };
try {
- const result = await dispatcher._handleCommand(callMetadata, method, validParams);
+ const result = await dispatcher._runCommand(callMetadata, method, validParams);
const validator = findValidator(dispatcher._type, method, 'Result');
response.result = validator(result, '', this._validatorToWireContext());
callMetadata.result = result;
diff --git a/packages/playwright-core/src/server/fetch.ts b/packages/playwright-core/src/server/fetch.ts
index 4fd6dcbe72..af6f4db0db 100644
--- a/packages/playwright-core/src/server/fetch.ts
+++ b/packages/playwright-core/src/server/fetch.ts
@@ -27,7 +27,7 @@ import { BrowserContext, verifyClientCertificates } from './browserContext';
import { Cookie, CookieStore, domainMatches, parseRawCookie } from './cookieStore';
import { MultipartFormData } from './formData';
import { SdkObject } from './instrumentation';
-import { isAbortError, ProgressController } from './progress';
+import { isAbortError } from './progress';
import { getMatchingTLSOptionsForOrigin, rewriteOpenSSLErrorIfNeeded } from './socksClientCertificatesInterceptor';
import { httpHappyEyeballsAgent, httpsHappyEyeballsAgent, timingForSocket } from './utils/happyEyeballs';
import { Tracing } from './trace/recorder/tracing';
@@ -100,7 +100,6 @@ export abstract class APIRequestContext extends SdkObject {
readonly fetchResponses: Map<string, Buffer> = new Map();
readonly fetchLog: Map<string, string[]> = new Map();
protected static allInstances: Set<APIRequestContext> = new Set();
- readonly _activeProgressControllers = new Set<ProgressController>();
_closeReason: string | undefined;
static findResponseBody(guid: string): Buffer | undefined {
diff --git a/packages/playwright-core/src/server/progress.ts b/packages/playwright-core/src/server/progress.ts
index 124099de8c..0e0b076b0c 100644
--- a/packages/playwright-core/src/server/progress.ts
+++ b/packages/playwright-core/src/server/progress.ts
@@ -57,9 +57,9 @@ export class ProgressController {
this._logName = logName;
}
- async abort(message: string) {
+ async abort(error: Error) {
if (this._state === 'running') {
- const error = new AbortedError(message);
+ (error as any)[kAbortErrorSymbol] = true;
this._state = { error };
this._forceAbortPromise.reject(error);
}
@@ -70,7 +70,6 @@ export class ProgressController {
async run<T>(task: (progress: Progress) => Promise<T>, timeout?: number): Promise<T> {
assert(this._state === 'before');
this._state = 'running';
- this.sdkObject.attribution.context?._activeProgressControllers.add(this);
let customErrorHandler: ((error: Error) => any) | undefined;
const deadline = timeout ? Math.min(monotonicTime() + timeout, 2147483647) : 0; // 2^31-1 safe setTimeout in Node.
@@ -82,6 +81,7 @@ export class ProgressController {
return;
const onTimeout = () => {
if (this._state === 'running') {
+ (timeoutError as any)[kAbortErrorSymbol] = true;
this._state = { error: timeoutError };
this._forceAbortPromise.reject(timeoutError);
}
@@ -162,7 +162,6 @@ export class ProgressController {
return customErrorHandler(error);
throw error;
} finally {
- this.sdkObject.attribution.context?._activeProgressControllers.delete(this);
clearTimeout(timer);
this._donePromise.resolve();
}
@@ -176,8 +175,8 @@ async function runCleanup(error: Error | undefined, cleanup: (error: Error | und
}
}
-class AbortedError extends Error {}
+const kAbortErrorSymbol = Symbol('kAbortError');
export function isAbortError(error: Error): boolean {
- return error instanceof AbortedError || error instanceof TimeoutError;
+ return !!(error as any)[kAbortErrorSymbol];
}
diff --git a/packages/playwright-core/src/server/types.ts b/packages/playwright-core/src/server/types.ts
index 59d2973311..089ef21fdf 100644
--- a/packages/playwright-core/src/server/types.ts
+++ b/packages/playwright-core/src/server/types.ts
@@ -19,8 +19,6 @@ import type { HeadersArray, Point, Size } from '../utils/isomorphic/types';
export type { HeadersArray, Point, Quad, Rect, Size } from '../utils/isomorphic/types';
import type * as channels from '@protocol/channels';
-export type TimeoutOptions = { timeout: number };
-
export type StrictOptions = {
strict?: boolean,
};
@@ -29,8 +27,6 @@ export type QueryOnSelectorOptions = StrictOptions;
export type WaitForElementOptions = StrictOptions & { state?: 'attached' | 'detached' | 'visible' | 'hidden' } & { omitReturnValue?: boolean };
-export type WaitForFunctionOptions = TimeoutOptions & { pollingInterval?: number };
-
export type LifecycleEvent = 'load' | 'domcontentloaded' | 'networkidle' | 'commit';
export const kLifecycleEvents: Set<LifecycleEvent> = new Set(['load', 'domcontentloaded', 'networkidle', 'commit']);
diff --git a/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts b/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
index 1f5865c39e..6739497d09 100644
--- a/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
+++ b/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
@@ -58,7 +58,7 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['Browser.defaultUserAgentForTest', { internal: true, }],
['Browser.newContext', { title: 'Create context', }],
['Browser.newContextForReuse', { internal: true, }],
- ['Browser.stopPendingOperations', { internal: true, title: 'Stop pending operations', }],
+ ['Browser.disconnectFromReusedContext', { internal: true, }],
['Browser.newBrowserCDPSession', { internal: true, title: 'Create CDP session', }],
['Browser.startTracing', { internal: true, }],
['Browser.stopTracing', { internal: true, }],
@@ -309,38 +309,3 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['JsonPipe.send', { internal: true, }],
['JsonPipe.close', { internal: true, }]
]);
-
-export const progressTypes = new Set<string>([
- 'APIRequestContext',
- 'LocalUtils',
- 'Root',
- 'Playwright',
- 'DebugController',
- 'SocksSupport',
- 'BrowserType',
- 'Browser',
- 'BrowserContext',
- 'Page',
- 'Frame',
- 'Worker',
- 'JSHandle',
- 'ElementHandle',
- 'Request',
- 'Route',
- 'WebSocketRoute',
- 'Response',
- 'WebSocket',
- 'BindingCall',
- 'Dialog',
- 'Tracing',
- 'Artifact',
- 'Stream',
- 'WritableStream',
- 'CDPSession',
- 'Electron',
- 'ElectronApplication',
- 'Android',
- 'AndroidSocket',
- 'AndroidDevice',
- 'JsonPipe'
-]);
diff --git a/packages/playwright/src/index.ts b/packages/playwright/src/index.ts
index 0864329ae8..c145cf3b63 100644
--- a/packages/playwright/src/index.ts
+++ b/packages/playwright/src/index.ts
@@ -414,10 +414,9 @@ const playwrightFixtures: Fixtures<TestFixtures, WorkerFixtures> = ({
const defaultContextOptions = (playwright.chromium as any)._defaultContextOptions as BrowserContextOptions;
const context = await (browser as any)._newContextForReuse(defaultContextOptions);
- (context as any)[kIsReusedContext] = true;
await use(context);
const closeReason = testInfo.status === 'timedOut' ? 'Test timeout of ' + testInfo.timeout + 'ms exceeded.' : 'Test ended.';
- await (browser as any)._stopPendingOperations(closeReason);
+ await (browser as any)._disconnectFromReusedContext(closeReason);
},
page: async ({ context, _reuseContext }, use) => {
@@ -508,7 +507,6 @@ function resolveClientCerticates(clientCertificates: ClientCertificates): Client
}
const kTracingStarted = Symbol('kTracingStarted');
-const kIsReusedContext = Symbol('kReusedContext');
function connectOptionsFromEnv() {
const wsEndpoint = process.env.PW_TEST_CONNECT_WS_ENDPOINT;
@@ -618,12 +616,10 @@ class ArtifactsRecorder {
_testInfo!: TestInfoImpl;
_playwright: PlaywrightImpl;
_artifactsDir: string;
- private _reusedContexts = new Set<BrowserContext>();
private _startedCollectingArtifacts: symbol;
private _screenshotRecorder: SnapshotRecorder;
private _pageSnapshot: string | undefined;
- private _sourceCache: Map<string, string> = new Map();
constructor(playwright: PlaywrightImpl, artifactsDir: string, screenshot: ScreenshotOption) {
this._playwright = playwright;
@@ -643,16 +639,9 @@ class ArtifactsRecorder {
this._screenshotRecorder.fixOrdinal();
// Process existing contexts.
- await Promise.all(this._playwright._allContexts().map(async context => {
- if ((context as any)[kIsReusedContext])
- this._reusedContexts.add(context);
- else
- await this.didCreateBrowserContext(context);
- }));
- {
- const existingApiRequests: APIRequestContext[] = Array.from((this._playwright.request as any)._contexts as Set<APIRequestContext>);
- await Promise.all(existingApiRequests.map(c => this.didCreateRequestContext(c)));
- }
+ await Promise.all(this._playwright._allContexts().map(context => this.didCreateBrowserContext(context)));
+ const existingApiRequests = Array.from((this._playwright.request as any)._contexts as Set<APIRequestContext>);
+ await Promise.all(existingApiRequests.map(c => this.didCreateRequestContext(c)));
}
async didCreateBrowserContext(context: BrowserContext) {
@@ -660,12 +649,7 @@ class ArtifactsRecorder {
}
async willCloseBrowserContext(context: BrowserContext) {
- // When reusing context, we get all previous contexts closed at the start of next test.
- // Do not record empty traces and useless screenshots for them.
- if (this._reusedContexts.has(context))
- return;
await this._stopTracing(context.tracing);
-
await this._screenshotRecorder.captureTemporary(context);
await this._takePageSnapshot(context);
}
@@ -702,8 +686,8 @@ class ArtifactsRecorder {
async didFinishTest() {
await this.didFinishTestFunction();
- const leftoverContexts = this._playwright._allContexts().filter(context => !this._reusedContexts.has(context));
- const leftoverApiRequests: APIRequestContext[] = Array.from((this._playwright.request as any)._contexts as Set<APIRequestContext>);
+ const leftoverContexts = this._playwright._allContexts();
+ const leftoverApiRequests = Array.from((this._playwright.request as any)._contexts as Set<APIRequestContext>);
// Collect traces/screenshots for remaining contexts.
await Promise.all(leftoverContexts.map(async context => {
diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.ts
index 9deceac198..7b8e8a90ed 100644
--- a/packages/protocol/src/channels.d.ts
+++ b/packages/protocol/src/channels.d.ts
@@ -1177,7 +1177,7 @@ export interface BrowserChannel extends BrowserEventTarget, Channel {
defaultUserAgentForTest(params?: BrowserDefaultUserAgentForTestParams, progress?: Progress): Promise<BrowserDefaultUserAgentForTestResult>;
newContext(params: BrowserNewContextParams, progress?: Progress): Promise<BrowserNewContextResult>;
newContextForReuse(params: BrowserNewContextForReuseParams, progress?: Progress): Promise<BrowserNewContextForReuseResult>;
- stopPendingOperations(params: BrowserStopPendingOperationsParams, progress?: Progress): Promise<BrowserStopPendingOperationsResult>;
+ disconnectFromReusedContext(params: BrowserDisconnectFromReusedContextParams, progress?: Progress): Promise<BrowserDisconnectFromReusedContextResult>;
newBrowserCDPSession(params?: BrowserNewBrowserCDPSessionParams, progress?: Progress): Promise<BrowserNewBrowserCDPSessionResult>;
startTracing(params: BrowserStartTracingParams, progress?: Progress): Promise<BrowserStartTracingResult>;
stopTracing(params?: BrowserStopTracingParams, progress?: Progress): Promise<BrowserStopTracingResult>;
@@ -1479,13 +1479,13 @@ export type BrowserNewContextForReuseOptions = {
export type BrowserNewContextForReuseResult = {
context: BrowserContextChannel,
};
-export type BrowserStopPendingOperationsParams = {
+export type BrowserDisconnectFromReusedContextParams = {
reason: string,
};
-export type BrowserStopPendingOperationsOptions = {
+export type BrowserDisconnectFromReusedContextOptions = {
};
-export type BrowserStopPendingOperationsResult = void;
+export type BrowserDisconnectFromReusedContextResult = void;
export type BrowserNewBrowserCDPSessionParams = {};
export type BrowserNewBrowserCDPSessionOptions = {};
export type BrowserNewBrowserCDPSessionResult = {
@@ -1519,7 +1519,7 @@ export interface EventTargetEventTarget {
}
export interface EventTargetChannel extends EventTargetEventTarget, Channel {
_type_EventTarget: boolean;
- waitForEventInfo(params: EventTargetWaitForEventInfoParams, metadata?: CallMetadata): Promise<EventTargetWaitForEventInfoResult>;
+ waitForEventInfo(params: EventTargetWaitForEventInfoParams, progress?: Progress): Promise<EventTargetWaitForEventInfoResult>;
}
export type EventTargetWaitForEventInfoParams = {
info: {
diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.yml
index 9fc510d327..fe889d8407 100644
--- a/packages/protocol/src/protocol.yml
+++ b/packages/protocol/src/protocol.yml
@@ -359,7 +359,6 @@ FormField:
APIRequestContext:
type: interface
- progress: true
initializer:
tracing: Tracing
@@ -630,7 +629,6 @@ ContextOptions:
LocalUtils:
type: interface
- progress: true
initializer:
deviceDescriptors:
@@ -770,7 +768,6 @@ LocalUtils:
Root:
type: interface
- progress: true
commands:
@@ -789,7 +786,6 @@ Root:
Playwright:
type: interface
- progress: true
initializer:
chromium: BrowserType
@@ -881,7 +877,6 @@ RecorderSource:
DebugController:
type: interface
- progress: true
commands:
initialize:
@@ -968,7 +963,6 @@ DebugController:
SocksSupport:
type: interface
- progress: true
commands:
socksConnected:
@@ -1020,7 +1014,6 @@ SocksSupport:
BrowserType:
type: interface
- progress: true
initializer:
executablePath: string
@@ -1062,7 +1055,6 @@ BrowserType:
Browser:
type: interface
- progress: true
initializer:
version: string
@@ -1129,9 +1121,8 @@ Browser:
returns:
context: BrowserContext
- stopPendingOperations:
+ disconnectFromReusedContext:
internal: true
- title: Stop pending operations
parameters:
reason: string
@@ -1204,7 +1195,6 @@ EventTarget:
BrowserContext:
type: interface
- progress: true
extends: EventTarget
@@ -1552,7 +1542,6 @@ BrowserContext:
Page:
type: interface
- progress: true
extends: EventTarget
@@ -2063,7 +2052,6 @@ Page:
Frame:
type: interface
- progress: true
initializer:
url: string
@@ -2726,7 +2714,6 @@ Frame:
Worker:
type: interface
- progress: true
initializer:
url: string
@@ -2758,7 +2745,6 @@ Worker:
JSHandle:
type: interface
- progress: true
initializer:
preview: string
@@ -2822,7 +2808,6 @@ JSHandle:
ElementHandle:
type: interface
- progress: true
extends: JSHandle
@@ -3269,7 +3254,6 @@ ElementHandle:
Request:
type: interface
- progress: true
initializer:
frame: Frame?
@@ -3301,7 +3285,6 @@ Request:
Route:
type: interface
- progress: true
initializer:
request: Request
@@ -3343,7 +3326,6 @@ Route:
WebSocketRoute:
type: interface
- progress: true
initializer:
url: string
@@ -3421,7 +3403,6 @@ ResourceTiming:
Response:
type: interface
- progress: true
initializer:
request: Request
@@ -3492,7 +3473,6 @@ RemoteAddr:
WebSocket:
type: interface
- progress: true
extends: EventTarget
@@ -3521,7 +3501,6 @@ WebSocket:
BindingCall:
type: interface
- progress: true
initializer:
frame: Frame
@@ -3547,7 +3526,6 @@ BindingCall:
Dialog:
type: interface
- progress: true
initializer:
page: Page?
@@ -3567,7 +3545,6 @@ Dialog:
Tracing:
type: interface
- progress: true
commands:
@@ -3625,7 +3602,6 @@ Tracing:
Artifact:
type: interface
- progress: true
initializer:
absolutePath: string
@@ -3668,7 +3644,6 @@ Artifact:
Stream:
type: interface
- progress: true
commands:
@@ -3685,7 +3660,6 @@ Stream:
WritableStream:
type: interface
- progress: true
commands:
@@ -3700,7 +3674,6 @@ WritableStream:
CDPSession:
type: interface
- progress: true
commands:
@@ -3725,7 +3698,6 @@ CDPSession:
Electron:
type: interface
- progress: true
commands:
@@ -3796,7 +3768,6 @@ Electron:
ElectronApplication:
type: interface
- progress: true
extends: EventTarget
@@ -3847,7 +3818,6 @@ ElectronApplication:
Android:
type: interface
- progress: true
commands:
@@ -3864,7 +3834,6 @@ Android:
AndroidSocket:
type: interface
- progress: true
commands:
write:
@@ -3883,7 +3852,6 @@ AndroidSocket:
AndroidDevice:
type: interface
- progress: true
extends: EventTarget
@@ -4164,7 +4132,6 @@ AndroidElementInfo:
JsonPipe:
type: interface
- progress: true
commands:
send:
diff --git a/tests/library/browsercontext-reuse.spec.ts b/tests/library/browsercontext-reuse.spec.ts
index 5d5c6a5edd..104c81bbaf 100644
--- a/tests/library/browsercontext-reuse.spec.ts
+++ b/tests/library/browsercontext-reuse.spec.ts
@@ -20,11 +20,16 @@ import type { BrowserContext, Page, BrowserContextOptions } from '@playwright/te
const test = browserTest.extend<{ reusedContext: (options?: BrowserContextOptions) => Promise<BrowserContext> }>({
reusedContext: async ({ browserType, browser }, use) => {
+ let context: BrowserContext | undefined;
await use(async options => {
+ if (context)
+ await (browser as any)._disconnectFromReusedContext('Disconnected');
const defaultContextOptions = (browserType as any)._playwright._defaultContextOptions;
- const context = await (browser as any)._newContextForReuse({ ...defaultContextOptions, ...options });
+ context = await (browser as any)._newContextForReuse({ ...defaultContextOptions, ...options });
return context;
});
+ if (context)
+ await (browser as any)._disconnectFromReusedContext('Disconnected');
},
});
diff --git a/tests/library/global-fetch.spec.ts b/tests/library/global-fetch.spec.ts
index 2bece94e45..da01a5d3f8 100644
--- a/tests/library/global-fetch.spec.ts
+++ b/tests/library/global-fetch.spec.ts
@@ -283,7 +283,7 @@ it('should abort requests when context is disposed', async ({ playwright, server
]);
for (const result of results.slice(0, -1)) {
expect(result instanceof Error).toBeTruthy();
- expect(result.message).toContain(kTargetClosedErrorMessage);
+ expect(result.message).toContain('Request context disposed.');
}
await connectionClosed;
await request.dispose();
diff --git a/tests/library/multiclient.spec.ts b/tests/library/multiclient.spec.ts
index c6a983c5d2..989b1b5803 100644
--- a/tests/library/multiclient.spec.ts
+++ b/tests/library/multiclient.spec.ts
@@ -14,6 +14,7 @@
* limitations under the License.
*/
+import { kTargetClosedErrorMessage } from '../config/errors';
import { expect, playwrightTest } from '../config/browserTest';
import type { Browser, BrowserServer, ConnectOptions, Page } from 'playwright-core';
@@ -323,3 +324,24 @@ test('should launch persistent', async ({ browserType }) => {
await browser.close();
await browserServer.close();
});
+
+test('should avoid side effects upon disconnect', async ({ twoPages, server }) => {
+ const { pageA, pageB } = twoPages;
+
+ let counter = 0;
+ pageB.on('console', () => ++counter);
+
+ const promise = pageA.waitForFunction(() => {
+ window['counter'] = (window['counter'] || 0) + 1;
+ console.log(window['counter']);
+ }, {}, { polling: 1, timeout: 10000 }).catch(e => e);
+
+ await disconnect(pageA);
+ const error = await promise;
+ const savedCounter = counter;
+
+ await pageB.waitForTimeout(2000); // Give it some time to produce more logs.
+
+ expect(error.message).toContain(kTargetClosedErrorMessage);
+ expect(counter).toBe(savedCounter);
+});
diff --git a/utils/generate_channels.js b/utils/generate_channels.js
index 6fff67a4b7..febc92fb40 100755
--- a/utils/generate_channels.js
+++ b/utils/generate_channels.js
@@ -179,7 +179,6 @@ const metainfo_ts = [
`];
const methodMetainfo = [];
-const progressTypes = new Set();
const yml = fs.readFileSync(path.join(__dirname, '..', 'packages', 'protocol', 'src', 'protocol.yml'), 'utf-8');
const protocol = yaml.parse(yml);
@@ -244,10 +243,6 @@ for (const [name, item] of Object.entries(protocol)) {
const initializerName = channelName + 'Initializer';
channels_ts.push(`export type ${initializerName} = ${init.ts};`);
- const useProgress = !!item.progress;
- if (useProgress)
- progressTypes.add(name);
-
let ancestorInit = init;
let ancestor = item;
while (!ancestor.initializer) {
@@ -309,8 +304,7 @@ for (const [name, item] of Object.entries(protocol)) {
for (const derived of derivedClasses.get(channelName) || [])
addScheme(`${derived}${titleCase(methodName)}Result`, `tType('${resultName}')`);
- const secondArg = useProgress ? `progress?: Progress` : 'metadata?: CallMetadata';
- channels_ts.push(` ${methodName}(params${method.parameters ? '' : '?'}: ${paramsName}, ${secondArg}): Promise<${resultName}>;`);
+ channels_ts.push(` ${methodName}(params${method.parameters ? '' : '?'}: ${paramsName}, progress?: Progress): Promise<${resultName}>;`);
}
channels_ts.push(`}`);
@@ -338,9 +332,6 @@ for (const [name, item] of Object.entries(protocol)) {
metainfo_ts.push(`export const methodMetainfo = new Map<string, { internal?: boolean, title?: string, slowMo?: boolean, snapshot?: boolean, pausesBeforeInput?: boolean }>([
${methodMetainfo.join(`,\n `)}
]);`);
-metainfo_ts.push(`\nexport const progressTypes = new Set<string>([
- ${[...progressTypes].map(s => `'${s}'`).join(`,\n `)}
-]);`);
let hasChanges = false;