Skip to content

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

fix(dispatcher): lift progress controller creation before instrumentation (#41643)

Simon Knottb5e3a77db112
diff --git a/packages/playwright-core/src/server/dispatchers/dispatcher.ts b/packages/playwright-core/src/server/dispatchers/dispatcher.ts
index 6a0c8a8728..1cf7edeb70 100644
--- a/packages/playwright-core/src/server/dispatchers/dispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/dispatcher.ts
@@ -55,7 +55,6 @@ export class Dispatcher<Type extends SdkObject, ChannelType, ParentScopeType ext
private _dispatchers = new Map<string, DispatcherScope>();
protected _disposed = false;
protected _eventListeners: RegisteredListener[] = [];
- readonly _activeProgressControllers = new Map<string, ProgressController>();
readonly _guid: string;
readonly _type: string;
@@ -103,14 +102,8 @@ export class Dispatcher<Type extends SdkObject, ChannelType, ParentScopeType ext
this.connection.sendAdopt(this, child);
}
- async _runCommand(callMetadata: CallMetadata, method: string, validParams: any) {
- const controller = ProgressController.createForSdkObject(this._object, callMetadata);
- this._activeProgressControllers.set(callMetadata.id, controller);
- try {
- return await controller.run(progress => (this as any)[method](validParams, progress), validParams?.timeout);
- } finally {
- this._activeProgressControllers.delete(callMetadata.id);
- }
+ createProgressController(callMetadata: CallMetadata): ProgressController {
+ return ProgressController.createForSdkObject(this._object, callMetadata);
}
_dispatchEvent<T extends keyof channels.EventsTraits<ChannelType>>(method: T, params?: channels.EventsTraits<ChannelType>[T]) {
@@ -132,14 +125,14 @@ export class Dispatcher<Type extends SdkObject, ChannelType, ParentScopeType ext
}
async stopPendingOperations(error: Error) {
- const controllers: ProgressController[] = [];
+ const guids = new Set<string>();
const collect = (dispatcher: DispatcherScope) => {
- controllers.push(...dispatcher._activeProgressControllers.values());
+ guids.add(dispatcher._guid);
for (const child of [...dispatcher._dispatchers.values()])
collect(child);
};
collect(this);
- await Promise.all(controllers.map(controller => controller.abort(error)));
+ await this.connection.abortControllersForGuids(guids, error);
}
private _disposeRecursively(error: Error) {
@@ -195,12 +188,22 @@ export class DispatcherConnection {
readonly _dispatchersByBucket = new Map<string, Set<string>>();
onmessage = (message: object) => {};
private _waitOperations = new Map<string, CallMetadata>();
+ private _activeProgressControllers = new Map<string, ProgressController>();
private _isInProcess: boolean;
constructor(isInProcess?: boolean) {
this._isInProcess = !!isInProcess;
}
+ async abortControllersForGuids(guids: Set<string>, error: Error) {
+ const controllers: ProgressController[] = [];
+ for (const controller of this._activeProgressControllers.values()) {
+ if (controller.metadata.objectId && guids.has(controller.metadata.objectId))
+ controllers.push(controller);
+ }
+ await Promise.all(controllers.map(controller => controller.abort(error)));
+ }
+
sendEvent(dispatcher: DispatcherScope, event: string, params: any) {
const validator = findValidator(dispatcher._type, event, 'Event');
params = validator(params, '', this._validatorToWireContext());
@@ -309,7 +312,7 @@ export class DispatcherConnection {
return;
}
if (method === '__abort__') {
- await dispatcher?._activeProgressControllers.get(`call@${params.id}`)?.abort(new AbortError(undefined, { cause: params.reason }));
+ await this._activeProgressControllers.get(`call@${params.id}`)?.abort(new AbortError(undefined, { cause: params.reason }));
return;
}
if (!dispatcher) {
@@ -355,6 +358,8 @@ export class DispatcherConnection {
params: params || {},
log: [],
};
+ const controller = dispatcher.createProgressController(callMetadata);
+ this._activeProgressControllers.set(callMetadata.id, controller);
await sdkObject.instrumentation.onBeforeCall(sdkObject, callMetadata);
const response: any = { id };
@@ -362,7 +367,7 @@ export class DispatcherConnection {
// If the dispatcher has been disposed while running the instrumentation call, error out.
if (this._dispatcherByGuid.get(guid) !== dispatcher)
throw new TargetClosedError(sdkObject.closeReason());
- const result = await dispatcher._runCommand(callMetadata, method, validParams);
+ const result = await controller.run(progress => (dispatcher as any)[method](validParams, progress), validParams?.timeout);
const validator = findValidator(dispatcher._type, method, 'Result');
response.result = validator(result, '', this._validatorToWireContext());
callMetadata.result = result;
@@ -388,6 +393,7 @@ export class DispatcherConnection {
await sdkObject.instrumentation.onAfterCall(sdkObject, callMetadata);
if (metainfo?.slowMo)
await this._doSlowMo(sdkObject);
+ this._activeProgressControllers.delete(callMetadata.id);
}
if (response.error)
diff --git a/packages/playwright-core/src/server/progress.ts b/packages/playwright-core/src/server/progress.ts
index 22787d0cee..8e97ce83aa 100644
--- a/packages/playwright-core/src/server/progress.ts
+++ b/packages/playwright-core/src/server/progress.ts
@@ -39,6 +39,7 @@ export class ProgressController {
private _donePromise = new ManualPromise<void>();
private _state: 'before' | 'running' | { error: Error } | 'finished' = 'before';
private _onCallLog?: (message: string) => void;
+ private _pendingAbortError?: Error;
readonly metadata: CallMetadata;
private _controller: AbortController;
@@ -68,6 +69,9 @@ export class ProgressController {
this._state = { error };
this._forceAbortPromise.reject(error);
this._controller.abort(error);
+ } else if (this._state === 'before') {
+ (error as any)[kAbortErrorSymbol] = true;
+ this._pendingAbortError = error;
}
await this._donePromise;
}
@@ -76,6 +80,7 @@ export class ProgressController {
const deadline = timeout ? monotonicTime() + timeout : 0;
assert(this._state === 'before');
this._state = 'running';
+
let timer: NodeJS.Timeout | undefined;
let outerProgress: string | undefined;
@@ -139,6 +144,8 @@ export class ProgressController {
}
try {
+ if (this._pendingAbortError)
+ throw this._pendingAbortError;
const result = await task(progress);
this._state = 'finished';
return result;