Skip to content

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

chore(server): pass action point/box as onBeforeInputAction args (#40695)

Dmitry Gozmanc8ce3aa99671
diff --git a/packages/playwright-core/src/server/debugger.ts b/packages/playwright-core/src/server/debugger.ts
index cb440cdfa5..338a34635b 100644
--- a/packages/playwright-core/src/server/debugger.ts
+++ b/packages/playwright-core/src/server/debugger.ts
@@ -42,7 +42,9 @@ export class Debugger extends SdkObject implements InstrumentationListener {
super(context, 'debugger');
this._context = context;
(this._context as any)[symbol] = this;
- context.instrumentation.addListener(this, context);
+ // Register as a last listener so the debugger pause runs after other listeners
+ // (e.g. recorder action-point capture) have recorded their state.
+ context.instrumentation.addListener(this, context, { order: 'last' });
this._context.once(BrowserContext.Events.Close, () => {
this._context.instrumentation.removeListener(this);
});
diff --git a/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts b/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts
index 81b4d804e4..885b892c8a 100644
--- a/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts
@@ -326,7 +326,6 @@ export class PageDispatcher extends Dispatcher<Page, channels.PageChannel, Brows
}
async touchscreenTap(params: channels.PageTouchscreenTapParams, progress: Progress): Promise<void> {
- progress.metadata.point = { x: params.x, y: params.y };
await this._page.touchscreen.apiTap(progress, params.x, params.y);
}
diff --git a/packages/playwright-core/src/server/dom.ts b/packages/playwright-core/src/server/dom.ts
index 13b34fb336..75f8abc7be 100644
--- a/packages/playwright-core/src/server/dom.ts
+++ b/packages/playwright-core/src/server/dom.ts
@@ -449,9 +449,7 @@ export class ElementHandle<T extends Node = Node> extends js.JSHandle<T> {
if (typeof maybeResult === 'string')
return maybeResult;
const point = roundPoint(maybeResult.point);
- progress.metadata.point = point;
- progress.metadata.box = maybeResult.box;
- await progress.race(this.instrumentation.onBeforeInputAction(this, progress.metadata));
+ await progress.race(this.instrumentation.onBeforeInputAction(this, progress.metadata, point, maybeResult.box));
let hitTargetInterceptionHandle: js.JSHandle<HitTargetInterceptionResult> | undefined;
if (force) {
@@ -573,16 +571,10 @@ export class ElementHandle<T extends Node = Node> extends js.JSHandle<T> {
return throwRetargetableDOMError(result);
}
- private async _beforeNonPointerAction(progress: Progress) {
- if (progress.metadata.annotate)
- progress.metadata.box = await this.boundingBox(progress) || undefined;
- await progress.race(this.instrumentation.onBeforeInputAction(this, progress.metadata));
- }
-
async _selectOption(progress: Progress, elements: ElementHandle[], values: types.SelectOption[], options: types.CommonActionOptions): Promise<string[] | 'error:notconnected'> {
let resultingOptions: string[] = [];
const result = await this._retryAction(progress, 'select option', async progress => {
- await this._beforeNonPointerAction(progress);
+ await progress.race(this.instrumentation.onBeforeInputAction(this, progress.metadata));
if (!options.force)
progress.log(` waiting for element to be visible and enabled`);
const optionsToSelect = [...elements, ...values];
@@ -615,7 +607,7 @@ export class ElementHandle<T extends Node = Node> extends js.JSHandle<T> {
async _fill(progress: Progress, value: string, options: types.CommonActionOptions): Promise<'error:notconnected' | 'done'> {
progress.log(` fill("${value}")`);
return await this._retryAction(progress, 'fill', async progress => {
- await this._beforeNonPointerAction(progress);
+ await progress.race(this.instrumentation.onBeforeInputAction(this, progress.metadata));
if (!options.force)
progress.log(' waiting for element to be visible, enabled and editable');
const result = await progress.race(this.evaluateInUtility(async ([injected, node, { value, force }]) => {
@@ -749,7 +741,7 @@ export class ElementHandle<T extends Node = Node> extends js.JSHandle<T> {
if (result === 'error:notconnected' || !result.asElement())
return 'error:notconnected';
const retargeted = result.asElement() as ElementHandle<HTMLInputElement>;
- await this._beforeNonPointerAction(progress);
+ await progress.race(this.instrumentation.onBeforeInputAction(this, progress.metadata));
if (localPaths || localDirectory) {
const localPathsOrDirectory = localDirectory ? [localDirectory] : localPaths!;
await progress.race(Promise.all((localPathsOrDirectory).map(localPath => (
@@ -790,7 +782,7 @@ export class ElementHandle<T extends Node = Node> extends js.JSHandle<T> {
async _type(progress: Progress, text: string, options: { delay?: number } & types.StrictOptions): Promise<'error:notconnected' | 'done'> {
progress.log(`elementHandle.type("${text}")`);
- await this._beforeNonPointerAction(progress);
+ await progress.race(this.instrumentation.onBeforeInputAction(this, progress.metadata));
const result = await this._focus(progress, true /* resetSelectionIfNotFocused */);
if (result !== 'done')
return result;
@@ -806,7 +798,7 @@ export class ElementHandle<T extends Node = Node> extends js.JSHandle<T> {
async _press(progress: Progress, key: string, options: { delay?: number, noWaitAfter?: boolean } & types.StrictOptions): Promise<'error:notconnected' | 'done'> {
progress.log(`elementHandle.press("${key}")`);
- await this._beforeNonPointerAction(progress);
+ await progress.race(this.instrumentation.onBeforeInputAction(this, progress.metadata));
return this._page.frameManager.waitForSignalsCreatedBy(progress, !options.noWaitAfter, async progress => {
const result = await this._focus(progress, true /* resetSelectionIfNotFocused */);
if (result !== 'done')
diff --git a/packages/playwright-core/src/server/input.ts b/packages/playwright-core/src/server/input.ts
index 9ff1f8bc8d..74bde697bf 100644
--- a/packages/playwright-core/src/server/input.ts
+++ b/packages/playwright-core/src/server/input.ts
@@ -214,8 +214,7 @@ export class Mouse {
}
async apiMove(progress: Progress, x: number, y: number, options: { steps?: number, forClick?: boolean } = {}) {
- progress.metadata.point = { x, y };
- await progress.race(this._page.instrumentation.onBeforeInputAction(this._page, progress.metadata));
+ await progress.race(this._page.instrumentation.onBeforeInputAction(this._page, progress.metadata, { x, y }));
await this.move(progress, x, y, options);
}
@@ -233,8 +232,7 @@ export class Mouse {
}
async apiDown(progress: Progress, options: { button?: types.MouseButton, clickCount?: number } = {}) {
- progress.metadata.point = this._currentPoint();
- await progress.race(this._page.instrumentation.onBeforeInputAction(this._page, progress.metadata));
+ await progress.race(this._page.instrumentation.onBeforeInputAction(this._page, progress.metadata, this._currentPoint()));
await this.down(progress, options);
}
@@ -246,8 +244,7 @@ export class Mouse {
}
async apiUp(progress: Progress, options: { button?: types.MouseButton, clickCount?: number } = {}) {
- progress.metadata.point = this._currentPoint();
- await progress.race(this._page.instrumentation.onBeforeInputAction(this._page, progress.metadata));
+ await progress.race(this._page.instrumentation.onBeforeInputAction(this._page, progress.metadata, this._currentPoint()));
await this.up(progress, options);
}
@@ -259,8 +256,7 @@ export class Mouse {
}
async apiClick(progress: Progress, x: number, y: number, options: { delay?: number, button?: types.MouseButton, clickCount?: number, steps?: number } = {}) {
- progress.metadata.point = { x, y };
- await progress.race(this._page.instrumentation.onBeforeInputAction(this._page, progress.metadata));
+ await progress.race(this._page.instrumentation.onBeforeInputAction(this._page, progress.metadata, { x, y }));
await this.click(progress, x, y, options);
}
@@ -374,7 +370,7 @@ export class Touchscreen {
async apiTap(progress: Progress, x: number, y: number) {
if (!this._page.browserContext._options.hasTouch)
throw new Error('hasTouch must be enabled on the browser context before using the touchscreen.');
- await progress.race(this._page.instrumentation.onBeforeInputAction(this._page, progress.metadata));
+ await progress.race(this._page.instrumentation.onBeforeInputAction(this._page, progress.metadata, { x, y }));
await this.tap(progress, x, y);
}
diff --git a/packages/playwright-core/src/server/instrumentation.ts b/packages/playwright-core/src/server/instrumentation.ts
index 250e360969..729a2ec7d7 100644
--- a/packages/playwright-core/src/server/instrumentation.ts
+++ b/packages/playwright-core/src/server/instrumentation.ts
@@ -28,6 +28,7 @@ import type { APIRequestContext } from './fetch';
import type { Frame } from './frames';
import type { Page, Worker } from './page';
import type { Playwright } from './playwright';
+import type * as types from './types';
import type { CallMetadata } from '@protocol/callMetadata';
export type { CallMetadata } from '@protocol/callMetadata';
import type { LogName } from '@utils/debugLogger';
@@ -79,11 +80,13 @@ export function createRootSdkObject() {
return root;
}
+export type AddListenerOptions = { order?: 'last' };
+
export interface Instrumentation {
- addListener(listener: InstrumentationListener, context: BrowserContext | APIRequestContext | null): void;
+ addListener(listener: InstrumentationListener, context: BrowserContext | APIRequestContext | null, options?: AddListenerOptions): void;
removeListener(listener: InstrumentationListener): void;
onBeforeCall(sdkObject: SdkObject, metadata: CallMetadata, parentId?: string): Promise<void>;
- onBeforeInputAction(sdkObject: SdkObject, metadata: CallMetadata): Promise<void>;
+ onBeforeInputAction(sdkObject: SdkObject, metadata: CallMetadata, point?: types.Point, box?: types.Rect): Promise<void>;
onCallLog(sdkObject: SdkObject, metadata: CallMetadata, logName: string, message: string): void;
onAfterCall(sdkObject: SdkObject, metadata: CallMetadata): Promise<void>;
onPageOpen(page: Page): void;
@@ -96,7 +99,7 @@ export interface Instrumentation {
export interface InstrumentationListener {
onBeforeCall?(sdkObject: SdkObject, metadata: CallMetadata, parentId?: string): Promise<void>;
- onBeforeInputAction?(sdkObject: SdkObject, metadata: CallMetadata): Promise<void>;
+ onBeforeInputAction?(sdkObject: SdkObject, metadata: CallMetadata, point?: types.Point, box?: types.Rect): Promise<void>;
onCallLog?(sdkObject: SdkObject, metadata: CallMetadata, logName: string, message: string): void;
onAfterCall?(sdkObject: SdkObject, metadata: CallMetadata): Promise<void>;
onPageOpen?(page: Page): void;
@@ -109,14 +112,25 @@ export interface InstrumentationListener {
export function createInstrumentation(): Instrumentation {
const listeners = new Map<InstrumentationListener, BrowserContext | APIRequestContext | null>();
+ const lastListeners = new Map<InstrumentationListener, BrowserContext | APIRequestContext | null>();
return new Proxy({}, {
get: (obj: any, prop: string | symbol) => {
if (typeof prop !== 'string')
return obj[prop];
- if (prop === 'addListener')
- return (listener: InstrumentationListener, context: BrowserContext | APIRequestContext | null) => listeners.set(listener, context);
- if (prop === 'removeListener')
- return (listener: InstrumentationListener) => listeners.delete(listener);
+ if (prop === 'addListener') {
+ return (listener: InstrumentationListener, context: BrowserContext | APIRequestContext | null, options?: AddListenerOptions) => {
+ if (options?.order === 'last')
+ lastListeners.set(listener, context);
+ else
+ listeners.set(listener, context);
+ };
+ }
+ if (prop === 'removeListener') {
+ return (listener: InstrumentationListener) => {
+ listeners.delete(listener);
+ lastListeners.delete(listener);
+ };
+ }
if (!prop.startsWith('on'))
return obj[prop];
return async (sdkObject: SdkObject, ...params: any[]) => {
@@ -124,6 +138,10 @@ export function createInstrumentation(): Instrumentation {
if (!context || sdkObject.attribution.context === context)
await (listener as any)[prop]?.(sdkObject, ...params);
}
+ for (const [listener, context] of lastListeners) {
+ if (!context || sdkObject.attribution.context === context)
+ await (listener as any)[prop]?.(sdkObject, ...params);
+ }
};
},
});
diff --git a/packages/playwright-core/src/server/recorder.ts b/packages/playwright-core/src/server/recorder.ts
index c0a8c6dd9c..e67f56ac50 100644
--- a/packages/playwright-core/src/server/recorder.ts
+++ b/packages/playwright-core/src/server/recorder.ts
@@ -81,6 +81,7 @@ export class Recorder extends EventEmitter<RecorderEventMap> implements Instrume
private _highlightedElement: { selector?: string, ariaTemplate?: AriaTemplateNode } = {};
private _overlayState: OverlayState = { offsetX: 0 };
private _currentCallsMetadata = new Map<CallMetadata, SdkObject>();
+ private _actionPoints = new Map<string, Point>();
private _userSources = new Map<string, Source>();
private _debugger: Debugger;
private _omitCallTracking = false;
@@ -175,7 +176,7 @@ export class Recorder extends EventEmitter<RecorderEventMap> implements Instrume
actionSelector = await this._scopeHighlightedSelectorToFrame(source.frame);
for (const [metadata, sdkObject] of this._currentCallsMetadata) {
if (source.page === sdkObject.attribution.page) {
- actionPoint = metadata.point || actionPoint;
+ actionPoint = this._actionPoints.get(metadata.id) || actionPoint;
actionSelector = actionSelector || metadata.params.selector;
}
}
@@ -415,6 +416,7 @@ export class Recorder extends EventEmitter<RecorderEventMap> implements Instrume
}
async onAfterCall(sdkObject: SdkObject, metadata: CallMetadata) {
+ this._actionPoints.delete(metadata.id);
if (this._omitCallTracking || this._isRecording())
return;
if (!metadata.error)
@@ -423,6 +425,11 @@ export class Recorder extends EventEmitter<RecorderEventMap> implements Instrume
this._updateCallLog([metadata]);
}
+ async onBeforeInputAction(sdkObject: SdkObject, metadata: CallMetadata, point?: Point): Promise<void> {
+ if (point)
+ this._actionPoints.set(metadata.id, point);
+ }
+
private _updateUserSources() {
// Remove old decorations.
for (const source of this._userSources.values()) {
diff --git a/packages/playwright-core/src/server/screencast.ts b/packages/playwright-core/src/server/screencast.ts
index 6401075dec..2ef83140e9 100644
--- a/packages/playwright-core/src/server/screencast.ts
+++ b/packages/playwright-core/src/server/screencast.ts
@@ -18,9 +18,11 @@ import { ManualPromise } from '@isomorphic/manualPromise';
import { renderTitleForCall } from '@isomorphic/protocolFormatter';
import { debugLogger } from '@utils/debugLogger';
import { Page } from './page';
+import { nullProgress } from './progress';
+import { ElementHandle } from './dom';
-import type * as types from './types';
import type { CallMetadata, InstrumentationListener, SdkObject } from './instrumentation';
+import type * as types from './types';
export type ScreencastClient = {
onFrame: (frame: types.ScreencastFrame) => Promise<void> | void;
@@ -47,7 +49,7 @@ export class Screencast implements InstrumentationListener {
constructor(page: Page) {
this.page = page;
- this.page.instrumentation.addListener(this, page.browserContext);
+ this.page.instrumentation.addListener(this, this.page.browserContext);
}
async handlePageOrContextClose() {
@@ -152,20 +154,17 @@ export class Screencast implements InstrumentationListener {
}
}
- async onBeforeCall(sdkObject: SdkObject, metadata: CallMetadata, parentId?: string): Promise<void> {
- if (!this._actions)
- return;
- metadata.annotate = true;
- }
-
- async onBeforeInputAction(sdkObject: SdkObject, metadata: CallMetadata): Promise<void> {
+ async onBeforeInputAction(sdkObject: SdkObject, metadata: CallMetadata, point?: types.Point, box?: types.Rect): Promise<void> {
if (!this._actions)
return;
const page = sdkObject.attribution.page;
- if (!page)
+ if (page !== this.page)
return;
+ if (!box && (sdkObject instanceof ElementHandle))
+ box = await sdkObject.boundingBox(nullProgress) || undefined;
+
const actionTitle = renderTitleForCall(metadata);
const utility = await page.mainFrame().utilityContext();
@@ -178,8 +177,8 @@ export class Screencast implements InstrumentationListener {
}, {
injected: await utility.injectedScript(),
duration: this._actions?.duration ?? 500,
- point: metadata.point,
- box: metadata.box,
+ point,
+ box,
actionTitle,
position: this._actions?.position,
fontSize: this._actions?.fontSize,
diff --git a/packages/playwright-core/src/server/trace/recorder/tracing.ts b/packages/playwright-core/src/server/trace/recorder/tracing.ts
index f6f30684a7..b5633943d4 100644
--- a/packages/playwright-core/src/server/trace/recorder/tracing.ts
+++ b/packages/playwright-core/src/server/trace/recorder/tracing.ts
@@ -492,11 +492,11 @@ export class Tracing extends SdkObject implements InstrumentationListener, Snaps
return this._captureSnapshot(event.beforeSnapshot, sdkObject, metadata);
}
- onBeforeInputAction(sdkObject: SdkObject, metadata: CallMetadata) {
+ onBeforeInputAction(sdkObject: SdkObject, metadata: CallMetadata, point?: types.Point) {
// IMPORTANT: no awaits in this method, this._appendTraceEvent must be called synchronously.
if (!this._state?.callIds.has(metadata.id))
return Promise.resolve();
- const event = createInputActionTraceEvent(metadata);
+ const event = createInputActionTraceEvent(metadata, point);
if (!event)
return Promise.resolve();
this._temporarilyDisableThrottling(sdkObject.attribution.page);
@@ -736,13 +736,13 @@ function createBeforeActionTraceEvent(metadata: CallMetadata, parentId?: string)
return event;
}
-function createInputActionTraceEvent(metadata: CallMetadata): trace.InputActionTraceEvent | null {
+function createInputActionTraceEvent(metadata: CallMetadata, point: types.Point | undefined): trace.InputActionTraceEvent | null {
if (metadata.internal || metadata.method.startsWith('tracing'))
return null;
return {
type: 'input',
callId: metadata.id,
- point: metadata.point,
+ point,
};
}
@@ -766,7 +766,6 @@ function createAfterActionTraceEvent(metadata: CallMetadata): trace.AfterActionT
endTime: metadata.endTime,
error: metadata.error?.error,
result: metadata.result,
- point: metadata.point,
};
}
diff --git a/packages/protocol/src/callMetadata.d.ts b/packages/protocol/src/callMetadata.d.ts
index ab598f79a2..ed9d3fd768 100644
--- a/packages/protocol/src/callMetadata.d.ts
+++ b/packages/protocol/src/callMetadata.d.ts
@@ -14,7 +14,7 @@
* limitations under the License.
*/
-import type { Point, Rect, SerializedError } from './channels';
+import type { SerializedError } from './channels';
export type CallMetadata = {
id: string;
@@ -35,11 +35,8 @@ export type CallMetadata = {
log: string[];
error?: SerializedError;
result?: any;
- point?: Point;
- box? : Rect;
objectId?: string;
pageId?: string;
frameId?: string;
potentiallyClosesScope?: boolean;
- annotate?: boolean;
};