Skip to content

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

test(codegen): add logging (#39196)

Simon Knott19bb594fea68
diff --git a/packages/injected/src/recorder/pollingRecorder.ts b/packages/injected/src/recorder/pollingRecorder.ts
index dc567b37c0..62aa15b49c 100644
--- a/packages/injected/src/recorder/pollingRecorder.ts
+++ b/packages/injected/src/recorder/pollingRecorder.ts
@@ -29,6 +29,7 @@ interface Embedder {
__pw_recorderSetMode(mode: Mode): Promise<void>;
__pw_recorderSetOverlayState(state: OverlayState): Promise<void>;
__pw_refreshOverlay(): void;
+ __pw_recorderLog(args: any[]): Promise<void>;
}
export class PollingRecorder implements RecorderDelegate {
@@ -95,6 +96,11 @@ export class PollingRecorder implements RecorderDelegate {
async setOverlayState(state: OverlayState): Promise<void> {
await this._embedder.__pw_recorderSetOverlayState(state);
}
+
+ async log(...args: any[]) {
+ if (this._recorder.injectedScript.isUnderTest)
+ await this._embedder.__pw_recorderLog(args);
+ }
}
export default PollingRecorder;
diff --git a/packages/injected/src/recorder/recorder.ts b/packages/injected/src/recorder/recorder.ts
index 35bbbf76e6..0fd2b0c8dd 100644
--- a/packages/injected/src/recorder/recorder.ts
+++ b/packages/injected/src/recorder/recorder.ts
@@ -41,6 +41,7 @@ export interface RecorderDelegate {
setMode?(mode: Mode): Promise<void>;
setOverlayState?(state: OverlayState): Promise<void>;
highlightUpdated?(): void;
+ log?(...args: any[]): void;
}
interface RecorderTool {
@@ -1524,6 +1525,7 @@ export class Recorder {
}
private _onClick(event: MouseEvent) {
+ this._delegate.log?.('_onClick', { x: event.clientX, y: event.clientY, target: event.target ? (event.target as Element).nodeName : 'unknown' });
if (!event.isTrusted)
return;
if (this.overlay?.onClick(event))
@@ -1534,6 +1536,7 @@ export class Recorder {
}
private _onDblClick(event: MouseEvent) {
+ this._delegate.log?.('_onDblClick', { x: event.clientX, y: event.clientY, target: event.target ? (event.target as Element).nodeName : 'unknown' });
if (!event.isTrusted)
return;
if (this.overlay?.onDblClick(event))
@@ -1544,6 +1547,7 @@ export class Recorder {
}
private _onContextMenu(event: MouseEvent) {
+ this._delegate.log?.('_onContextMenu', { x: event.clientX, y: event.clientY, target: event.target ? (event.target as Element).nodeName : 'unknown' });
if (!event.isTrusted)
return;
// Note: in chromium windows, context menu event always includes overlay,
@@ -1554,6 +1558,7 @@ export class Recorder {
}
private _onDragStart(event: DragEvent) {
+ this._delegate.log?.('_onDragStart', { x: event.clientX, y: event.clientY, target: event.target ? (event.target as Element).nodeName : 'unknown' });
if (!event.isTrusted)
return;
if (this._ignoreOverlayEvent(event))
@@ -1562,6 +1567,7 @@ export class Recorder {
}
private _onPointerDown(event: PointerEvent) {
+ this._delegate.log?.('_onPointerDown', { x: event.clientX, y: event.clientY, target: event.target ? (event.target as Element).nodeName : 'unknown' });
if (!event.isTrusted)
return;
if (this._ignoreOverlayEvent(event))
@@ -1570,6 +1576,7 @@ export class Recorder {
}
private _onPointerUp(event: PointerEvent) {
+ this._delegate.log?.('_onPointerUp', { x: event.clientX, y: event.clientY, target: event.target ? (event.target as Element).nodeName : 'unknown' });
if (!event.isTrusted)
return;
if (this._ignoreOverlayEvent(event))
@@ -1578,6 +1585,7 @@ export class Recorder {
}
private _onMouseDown(event: MouseEvent) {
+ this._delegate.log?.('_onMouseDown', { x: event.clientX, y: event.clientY, target: event.target ? (event.target as Element).nodeName : 'unknown' });
if (!event.isTrusted)
return;
if (this._ignoreOverlayEvent(event))
@@ -1586,6 +1594,7 @@ export class Recorder {
}
private _onMouseUp(event: MouseEvent) {
+ this._delegate.log?.('_onMouseUp', { x: event.clientX, y: event.clientY, target: event.target ? (event.target as Element).nodeName : 'unknown' });
if (!event.isTrusted)
return;
if (this.overlay?.onMouseUp(event))
@@ -1596,6 +1605,7 @@ export class Recorder {
}
private _onMouseMove(event: MouseEvent) {
+ this._delegate.log?.('_onMouseMove', { x: event.clientX, y: event.clientY, target: event.target ? (event.target as Element).nodeName : 'unknown' });
if (!event.isTrusted)
return;
if (this.overlay?.onMouseMove(event))
@@ -1606,6 +1616,7 @@ export class Recorder {
}
private _onMouseEnter(event: MouseEvent) {
+ this._delegate.log?.('_onMouseEnter', { x: event.clientX, y: event.clientY, target: event.target ? (event.target as Element).nodeName : 'unknown' });
if (!event.isTrusted)
return;
if (this._ignoreOverlayEvent(event))
@@ -1614,6 +1625,7 @@ export class Recorder {
}
private _onMouseLeave(event: MouseEvent) {
+ this._delegate.log?.('_onMouseLeave', { x: event.clientX, y: event.clientY, target: event.target ? (event.target as Element).nodeName : 'unknown' });
if (!event.isTrusted)
return;
if (this._ignoreOverlayEvent(event))
@@ -1622,6 +1634,7 @@ export class Recorder {
}
private _onFocus(event: Event) {
+ this._delegate.log?.('_onFocus', { target: event.target ? (event.target as Element).nodeName : 'unknown' });
if (!event.isTrusted)
return;
if (this._ignoreOverlayEvent(event))
@@ -1630,6 +1643,7 @@ export class Recorder {
}
private _onScroll(event: Event) {
+ this._delegate.log?.('_onScroll', { target: event.target ? (event.target as Element).nodeName : 'unknown' });
if (!event.isTrusted)
return;
this._lastHighlightedSelector = undefined;
@@ -1639,12 +1653,14 @@ export class Recorder {
}
private _onInput(event: Event) {
+ this._delegate.log?.('_onInput', { target: event.target ? (event.target as Element).nodeName : 'unknown' });
if (this._ignoreOverlayEvent(event))
return;
this._currentTool.onInput?.(event);
}
private _onKeyDown(event: KeyboardEvent) {
+ this._delegate.log?.('_onKeyDown', { key: event.key, target: event.target ? (event.target as Element).nodeName : 'unknown' });
if (!event.isTrusted)
return;
if (this._ignoreOverlayEvent(event))
@@ -1653,6 +1669,7 @@ export class Recorder {
}
private _onKeyUp(event: KeyboardEvent) {
+ this._delegate.log?.('_onKeyUp', { key: event.key, target: event.target ? (event.target as Element).nodeName : 'unknown' });
if (!event.isTrusted)
return;
if (this._ignoreOverlayEvent(event))
diff --git a/packages/playwright-core/src/server/recorder.ts b/packages/playwright-core/src/server/recorder.ts
index cb29fcfd3a..88c817895a 100644
--- a/packages/playwright-core/src/server/recorder.ts
+++ b/packages/playwright-core/src/server/recorder.ts
@@ -149,6 +149,12 @@ export class Recorder extends EventEmitter<RecorderEventMap> implements Instrume
}
}
+ private async _debugLog(...args: any[]) {
+ if (isUnderTest())
+ // eslint-disable-next-line no-console
+ console.log(monotonicTime(), ...args);
+ }
+
private async _install() {
this.emit(RecorderEvent.ModeChanged, this._mode);
this.emit(RecorderEvent.PausedStateChanged, this._debugger.isPaused());
@@ -161,6 +167,11 @@ export class Recorder extends EventEmitter<RecorderEventMap> implements Instrume
const controller = new ProgressController();
await controller.run(async progress => {
+ if (isUnderTest()) {
+ await this._context.exposeBinding(progress, '__pw_recorderLog', false, async ({ frame }, args: any[]) => {
+ this._debugLog('__pw_recorderLog', ...args);
+ });
+ }
await this._context.exposeBinding(progress, '__pw_recorderState', false, async source => {
let actionSelector: string | undefined;
let actionPoint: Point | undefined;
@@ -183,27 +194,33 @@ export class Recorder extends EventEmitter<RecorderEventMap> implements Instrume
testIdAttributeName: this._testIdAttributeName(),
overlay: this._overlayState,
};
+ this._debugLog('__pw_recorderState', uiState);
return uiState;
});
await this._context.exposeBinding(progress, '__pw_recorderElementPicked', false, async ({ frame }, elementInfo: ElementInfo) => {
+ this._debugLog('__pw_recorderElementPicked', elementInfo);
const selectorChain = await generateFrameSelector(frame);
+ this._debugLog('__pw_recorderElementPicked selector', selectorChain);
this.emit(RecorderEvent.ElementPicked, { selector: buildFullSelector(selectorChain, elementInfo.selector), ariaSnapshot: elementInfo.ariaSnapshot }, true);
});
await this._context.exposeBinding(progress, '__pw_recorderSetMode', false, async ({ frame }, mode: Mode) => {
+ this._debugLog('__pw_recorderSetMode', mode);
if (frame.parentFrame())
return;
this.setMode(mode);
});
await this._context.exposeBinding(progress, '__pw_recorderSetOverlayState', false, async ({ frame }, state: OverlayState) => {
+ this._debugLog('__pw_recorderSetOverlayState', state);
if (frame.parentFrame())
return;
this._overlayState = state;
});
await this._context.exposeBinding(progress, '__pw_resume', false, () => {
+ this._debugLog('__pw_resume');
this._debugger.resume(false);
});
@@ -234,6 +251,7 @@ export class Recorder extends EventEmitter<RecorderEventMap> implements Instrume
}
private _pausedStateChanged() {
+ this._debugLog('_pausedStateChanged');
// If we are called upon page.pause, we don't have metadatas, populate them.
for (const { metadata, sdkObject } of this._debugger.pausedDetails()) {
if (!this._currentCallsMetadata.has(metadata))
@@ -249,6 +267,7 @@ export class Recorder extends EventEmitter<RecorderEventMap> implements Instrume
}
setMode(mode: Mode) {
+ this._debugLog('setMode', mode);
if (this._mode === mode)
return;
this._highlightedElement = {};
@@ -267,6 +286,7 @@ export class Recorder extends EventEmitter<RecorderEventMap> implements Instrume
}
setHighlightedSelector(selector: string) {
+ this._debugLog('setHighlightedSelector', selector);
this._highlightedElement = { selector: locatorOrSelectorAsSelector(this._currentLanguage, selector, this._context.selectors().testIdAttributeName()) };
this._refreshOverlay();
}
@@ -360,6 +380,7 @@ export class Recorder extends EventEmitter<RecorderEventMap> implements Instrume
async onBeforeCall(sdkObject: SdkObject, metadata: CallMetadata) {
if (this._omitCallTracking || this._isRecording())
return;
+ this._debugLog('onBeforeCall', metadata.method, metadata.params);
this._currentCallsMetadata.set(metadata, sdkObject);
this._updateUserSources();
this.updateCallLog([metadata]);
@@ -372,6 +393,7 @@ export class Recorder extends EventEmitter<RecorderEventMap> implements Instrume
async onAfterCall(sdkObject: SdkObject, metadata: CallMetadata) {
if (this._omitCallTracking || this._isRecording())
return;
+ this._debugLog('onAfterCall', metadata.method, metadata.params);
if (!metadata.error)
this._currentCallsMetadata.delete(metadata);
this._updateUserSources();
@@ -446,9 +468,11 @@ export class Recorder extends EventEmitter<RecorderEventMap> implements Instrume
}
private async _onPage(page: Page) {
+ this._debugLog('_onPage', page.guid);
// First page is called page, others are called popup1, popup2, etc.
const frame = page.mainFrame();
page.on(Page.Events.Close, () => {
+ this._debugLog('close');
this._signalProcessor.addAction({
frame: this._describeMainFrame(page),
action: {
@@ -461,6 +485,7 @@ export class Recorder extends EventEmitter<RecorderEventMap> implements Instrume
this._filePrimaryURLChanged();
});
frame.on(Frame.Events.InternalNavigation, event => {
+ this._debugLog('internal navigation');
if (event.isPublic) {
this._onFrameNavigated(frame, page);
this._filePrimaryURLChanged();
@@ -531,6 +556,7 @@ export class Recorder extends EventEmitter<RecorderEventMap> implements Instrume
}
private async _performAction(frame: Frame, action: actions.PerformOnRecordAction) {
+ this._debugLog('_performAction', action);
const actionInContext = await this._createActionInContext(frame, action);
this._signalProcessor.addAction(actionInContext);
if (actionInContext.action.name !== 'openPage' && actionInContext.action.name !== 'closePage')
@@ -539,6 +565,7 @@ export class Recorder extends EventEmitter<RecorderEventMap> implements Instrume
}
private async _recordAction(frame: Frame, action: actions.Action) {
+ this._debugLog('_recordAction', action);
const actionInContext = await this._createActionInContext(frame, action);
this._signalProcessor.addAction(actionInContext);
}
@@ -549,18 +576,21 @@ export class Recorder extends EventEmitter<RecorderEventMap> implements Instrume
}
private _onPopup(page: Page, popup: Page) {
+ this._debugLog('popup');
const pageAlias = this._pageAliases.get(page)!;
const popupAlias = this._pageAliases.get(popup)!;
this._signalProcessor.signal(pageAlias, page.mainFrame(), { name: 'popup', popupAlias });
}
private _onDownload(page: Page) {
+ this._debugLog('download');
const pageAlias = this._pageAliases.get(page)!;
++this._lastDownloadOrdinal;
this._signalProcessor.signal(pageAlias, page.mainFrame(), { name: 'download', downloadAlias: this._lastDownloadOrdinal ? String(this._lastDownloadOrdinal) : '' });
}
private _onDialog(page: Page) {
+ this._debugLog('onDialog');
const pageAlias = this._pageAliases.get(page)!;
++this._lastDialogOrdinal;
this._signalProcessor.signal(pageAlias, page.mainFrame(), { name: 'dialog', dialogAlias: this._lastDialogOrdinal ? String(this._lastDialogOrdinal) : '' });