Skip to content

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

feat: record all actions in the trace and filter them in UI (#36929)

Dmitry Gozman9e155016b69a
diff --git a/packages/playwright-core/src/client/browserContext.ts b/packages/playwright-core/src/client/browserContext.ts
index fa309a7b5c..2b2e59f1e1 100644
--- a/packages/playwright-core/src/client/browserContext.ts
+++ b/packages/playwright-core/src/client/browserContext.ts
@@ -236,7 +236,7 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
this._routes.splice(index, 1);
const handled = await routeHandler.handle(route);
if (!this._routes.length)
- this._updateInterceptionPatterns().catch(() => {});
+ this._updateInterceptionPatterns({ internal: true }).catch(() => {});
if (handled)
return;
}
@@ -351,12 +351,12 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
async route(url: URLMatch, handler: network.RouteHandlerCallback, options: { times?: number } = {}): Promise<void> {
this._routes.unshift(new network.RouteHandler(this._platform, this._options.baseURL, url, handler, options.times));
- await this._updateInterceptionPatterns();
+ await this._updateInterceptionPatterns({ title: 'Route requests' });
}
async routeWebSocket(url: URLMatch, handler: network.WebSocketRouteHandlerCallback): Promise<void> {
this._webSocketRoutes.unshift(new network.WebSocketRouteHandler(this._options.baseURL, url, handler));
- await this._updateWebSocketInterceptionPatterns();
+ await this._updateWebSocketInterceptionPatterns({ title: 'Route WebSockets' });
}
async _recordIntoHAR(har: string, page: Page | null, options: { url?: string | RegExp, updateContent?: 'attach' | 'embed' | 'omit', updateMode?: 'minimal' | 'full'} = {}): Promise<void> {
@@ -415,17 +415,17 @@ export class BrowserContext extends ChannelOwner<channels.BrowserContextChannel>
const promises = removed.map(routeHandler => routeHandler.stop(behavior));
await Promise.all(promises);
}
- await this._updateInterceptionPatterns();
+ await this._updateInterceptionPatterns({ title: 'Unroute requests' });
}
- private async _updateInterceptionPatterns() {
+ private async _updateInterceptionPatterns(options: { internal: true } | { title: string }) {
const patterns = network.RouteHandler.prepareInterceptionPatterns(this._routes);
- await this._channel.setNetworkInterceptionPatterns({ patterns });
+ await this._wrapApiCall(() => this._channel.setNetworkInterceptionPatterns({ patterns }), options);
}
- private async _updateWebSocketInterceptionPatterns() {
+ private async _updateWebSocketInterceptionPatterns(options: { internal: true } | { title: string }) {
const patterns = network.WebSocketRouteHandler.prepareInterceptionPatterns(this._webSocketRoutes);
- await this._channel.setWebSocketInterceptionPatterns({ patterns });
+ await this._wrapApiCall(() => this._channel.setWebSocketInterceptionPatterns({ patterns }), options);
}
_effectiveCloseReason(): string | undefined {
diff --git a/packages/playwright-core/src/client/page.ts b/packages/playwright-core/src/client/page.ts
index 2d621a0fe0..4dbf85ab03 100644
--- a/packages/playwright-core/src/client/page.ts
+++ b/packages/playwright-core/src/client/page.ts
@@ -203,7 +203,7 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
this._routes.splice(index, 1);
const handled = await routeHandler.handle(route);
if (!this._routes.length)
- this._updateInterceptionPatterns().catch(() => {});
+ this._updateInterceptionPatterns({ internal: true }).catch(() => {});
if (handled)
return;
}
@@ -520,7 +520,7 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
async route(url: URLMatch, handler: RouteHandlerCallback, options: { times?: number } = {}): Promise<void> {
this._routes.unshift(new RouteHandler(this._platform, this._browserContext._options.baseURL, url, handler, options.times));
- await this._updateInterceptionPatterns();
+ await this._updateInterceptionPatterns({ title: 'Route requests' });
}
async routeFromHAR(har: string, options: { url?: string | RegExp, notFound?: 'abort' | 'fallback', update?: boolean, updateContent?: 'attach' | 'embed', updateMode?: 'minimal' | 'full'} = {}): Promise<void> {
@@ -538,7 +538,7 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
async routeWebSocket(url: URLMatch, handler: WebSocketRouteHandlerCallback): Promise<void> {
this._webSocketRoutes.unshift(new WebSocketRouteHandler(this._browserContext._options.baseURL, url, handler));
- await this._updateWebSocketInterceptionPatterns();
+ await this._updateWebSocketInterceptionPatterns({ title: 'Route WebSockets' });
}
private _disposeHarRouters() {
@@ -569,17 +569,17 @@ export class Page extends ChannelOwner<channels.PageChannel> implements api.Page
const promises = removed.map(routeHandler => routeHandler.stop(behavior));
await Promise.all(promises);
}
- await this._updateInterceptionPatterns();
+ await this._updateInterceptionPatterns({ title: 'Unroute requests' });
}
- private async _updateInterceptionPatterns() {
+ private async _updateInterceptionPatterns(options: { internal: true } | { title: string }) {
const patterns = RouteHandler.prepareInterceptionPatterns(this._routes);
- await this._channel.setNetworkInterceptionPatterns({ patterns });
+ await this._wrapApiCall(() => this._channel.setNetworkInterceptionPatterns({ patterns }), options);
}
- private async _updateWebSocketInterceptionPatterns() {
+ private async _updateWebSocketInterceptionPatterns(options: { internal: true } | { title: string }) {
const patterns = WebSocketRouteHandler.prepareInterceptionPatterns(this._webSocketRoutes);
- await this._channel.setWebSocketInterceptionPatterns({ patterns });
+ await this._wrapApiCall(() => this._channel.setWebSocketInterceptionPatterns({ patterns }), options);
}
async screenshot(options: Omit<channels.PageScreenshotOptions, 'mask'> & TimeoutOptions & { path?: string, mask?: api.Locator[] } = {}): Promise<Buffer> {
diff --git a/packages/playwright-core/src/client/tracing.ts b/packages/playwright-core/src/client/tracing.ts
index 24c2157683..536d1673b8 100644
--- a/packages/playwright-core/src/client/tracing.ts
+++ b/packages/playwright-core/src/client/tracing.ts
@@ -35,20 +35,24 @@ export class Tracing extends ChannelOwner<channels.TracingChannel> implements ap
}
async start(options: { name?: string, title?: string, snapshots?: boolean, screenshots?: boolean, sources?: boolean, _live?: boolean } = {}) {
- this._includeSources = !!options.sources;
- await this._channel.tracingStart({
- name: options.name,
- snapshots: options.snapshots,
- screenshots: options.screenshots,
- live: options._live,
+ await this._wrapApiCall(async () => {
+ this._includeSources = !!options.sources;
+ await this._channel.tracingStart({
+ name: options.name,
+ snapshots: options.snapshots,
+ screenshots: options.screenshots,
+ live: options._live,
+ });
+ const { traceName } = await this._channel.tracingStartChunk({ name: options.name, title: options.title });
+ await this._startCollectingStacks(traceName);
});
- const { traceName } = await this._channel.tracingStartChunk({ name: options.name, title: options.title });
- await this._startCollectingStacks(traceName);
}
async startChunk(options: { name?: string, title?: string } = {}) {
- const { traceName } = await this._channel.tracingStartChunk(options);
- await this._startCollectingStacks(traceName);
+ await this._wrapApiCall(async () => {
+ const { traceName } = await this._channel.tracingStartChunk(options);
+ await this._startCollectingStacks(traceName);
+ });
}
async group(name: string, options: { location?: { file: string, line?: number, column?: number } } = {}) {
@@ -69,12 +73,16 @@ export class Tracing extends ChannelOwner<channels.TracingChannel> implements ap
}
async stopChunk(options: { path?: string } = {}) {
- await this._doStopChunk(options.path);
+ await this._wrapApiCall(async () => {
+ await this._doStopChunk(options.path);
+ });
}
async stop(options: { path?: string } = {}) {
- await this._doStopChunk(options.path);
- await this._channel.tracingStop();
+ await this._wrapApiCall(async () => {
+ await this._doStopChunk(options.path);
+ await this._channel.tracingStop();
+ });
}
private async _doStopChunk(filePath: string | undefined) {
diff --git a/packages/playwright-core/src/server/trace/recorder/tracing.ts b/packages/playwright-core/src/server/trace/recorder/tracing.ts
index 219438ef0b..de2a0597e3 100644
--- a/packages/playwright-core/src/server/trace/recorder/tracing.ts
+++ b/packages/playwright-core/src/server/trace/recorder/tracing.ts
@@ -20,6 +20,7 @@ import path from 'path';
import { Snapshotter } from './snapshotter';
import { methodMetainfo } from '../../../utils/isomorphic/protocolMetainfo';
+import { getActionGroup } from '../../../utils/isomorphic/protocolFormatter';
import { assert } from '../../../utils/isomorphic/assert';
import { monotonicTime } from '../../../utils/isomorphic/time';
import { eventsHelper } from '../../utils/eventsHelper';
@@ -650,7 +651,7 @@ function visitTraceEvent(object: any, sha1s: Set<string>): any {
return object;
}
-export function shouldCaptureSnapshot(metadata: CallMetadata): boolean {
+function shouldCaptureSnapshot(metadata: CallMetadata): boolean {
const metainfo = methodMetainfo.get(metadata.type + '.' + metadata.method);
return !!metainfo?.snapshot;
}
@@ -668,6 +669,7 @@ function createBeforeActionTraceEvent(metadata: CallMetadata, parentId?: string)
params: metadata.params,
stepId: metadata.stepId,
pageId: metadata.pageId,
+ visibility: getActionGroup(metadata) ? 'hidden' : undefined,
};
if (parentId)
event.parentId = parentId;
diff --git a/packages/playwright-core/src/utils/isomorphic/protocolFormatter.ts b/packages/playwright-core/src/utils/isomorphic/protocolFormatter.ts
index d2994a7c62..584a1f9517 100644
--- a/packages/playwright-core/src/utils/isomorphic/protocolFormatter.ts
+++ b/packages/playwright-core/src/utils/isomorphic/protocolFormatter.ts
@@ -64,3 +64,7 @@ export function renderTitleForCall(metadata: { title?: string, type: string, met
return formatProtocolParam(metadata.params, p1) ?? fullMatch;
});
}
+
+export function getActionGroup(metadata: { type: string, method: string }) {
+ return methodMetainfo.get(metadata.type + '.' + metadata.method)?.group as undefined | 'configuration' | 'route' | 'getter';
+}
diff --git a/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts b/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
index ccec3047e3..1becd4c97f 100644
--- a/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
+++ b/packages/playwright-core/src/utils/isomorphic/protocolMetainfo.ts
@@ -16,11 +16,11 @@
// This file is generated by generate_channels.js, do not edit manually.
-export const methodMetainfo = new Map<string, { internal?: boolean, title?: string, slowMo?: boolean, snapshot?: boolean, pausesBeforeInput?: boolean }>([
+export const methodMetainfo = new Map<string, { internal?: boolean, title?: string, slowMo?: boolean, snapshot?: boolean, pausesBeforeInput?: boolean, group?: string }>([
['APIRequestContext.fetch', { title: '{method} "{url}"', }],
- ['APIRequestContext.fetchResponseBody', { internal: true, }],
+ ['APIRequestContext.fetchResponseBody', { title: 'Get response body', group: 'getter', }],
['APIRequestContext.fetchLog', { internal: true, }],
- ['APIRequestContext.storageState', { internal: true, }],
+ ['APIRequestContext.storageState', { title: 'Get storage state', }],
['APIRequestContext.disposeAPIResponse', { internal: true, }],
['APIRequestContext.dispose', { internal: true, }],
['LocalUtils.zip', { internal: true, }],
@@ -55,38 +55,38 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['Browser.newContext', { title: 'Create context', }],
['Browser.newContextForReuse', { internal: true, }],
['Browser.disconnectFromReusedContext', { internal: true, }],
- ['Browser.newBrowserCDPSession', { internal: true, title: 'Create CDP session', }],
- ['Browser.startTracing', { internal: true, }],
- ['Browser.stopTracing', { internal: true, }],
+ ['Browser.newBrowserCDPSession', { title: 'Create CDP session', group: 'configuration', }],
+ ['Browser.startTracing', { title: 'Start browser tracing', group: 'configuration', }],
+ ['Browser.stopTracing', { title: 'Stop browser tracing', group: 'configuration', }],
['EventTarget.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
['BrowserContext.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
['Page.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
['WebSocket.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
['ElectronApplication.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
['AndroidDevice.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
- ['BrowserContext.addCookies', { title: 'Add cookies', }],
- ['BrowserContext.addInitScript', { title: 'Add init script', }],
- ['BrowserContext.clearCookies', { title: 'Clear cookies', }],
- ['BrowserContext.clearPermissions', { title: 'Clear permissions', }],
+ ['BrowserContext.addCookies', { title: 'Add cookies', group: 'configuration', }],
+ ['BrowserContext.addInitScript', { title: 'Add init script', group: 'configuration', }],
+ ['BrowserContext.clearCookies', { title: 'Clear cookies', group: 'configuration', }],
+ ['BrowserContext.clearPermissions', { title: 'Clear permissions', group: 'configuration', }],
['BrowserContext.close', { title: 'Close context', }],
- ['BrowserContext.cookies', { title: 'Get cookies', }],
- ['BrowserContext.exposeBinding', { title: 'Expose binding', }],
- ['BrowserContext.grantPermissions', { title: 'Grant permissions', }],
+ ['BrowserContext.cookies', { title: 'Get cookies', group: 'getter', }],
+ ['BrowserContext.exposeBinding', { title: 'Expose binding', group: 'configuration', }],
+ ['BrowserContext.grantPermissions', { title: 'Grant permissions', group: 'configuration', }],
['BrowserContext.newPage', { title: 'Create page', }],
['BrowserContext.registerSelectorEngine', { internal: true, }],
['BrowserContext.setTestIdAttributeName', { internal: true, }],
- ['BrowserContext.setExtraHTTPHeaders', { title: 'Set extra HTTP headers', }],
- ['BrowserContext.setGeolocation', { title: 'Set geolocation', }],
- ['BrowserContext.setHTTPCredentials', { title: 'Set HTTP credentials', }],
- ['BrowserContext.setNetworkInterceptionPatterns', { internal: true, }],
- ['BrowserContext.setWebSocketInterceptionPatterns', { internal: true, }],
+ ['BrowserContext.setExtraHTTPHeaders', { title: 'Set extra HTTP headers', group: 'configuration', }],
+ ['BrowserContext.setGeolocation', { title: 'Set geolocation', group: 'configuration', }],
+ ['BrowserContext.setHTTPCredentials', { title: 'Set HTTP credentials', group: 'configuration', }],
+ ['BrowserContext.setNetworkInterceptionPatterns', { title: 'Route requests', group: 'route', }],
+ ['BrowserContext.setWebSocketInterceptionPatterns', { title: 'Route WebSockets', group: 'route', }],
['BrowserContext.setOffline', { title: 'Set offline mode', }],
['BrowserContext.storageState', { title: 'Get storage state', }],
- ['BrowserContext.setStorageState', { title: 'Set storage state', }],
+ ['BrowserContext.setStorageState', { title: 'Set storage state', group: 'configuration', }],
['BrowserContext.pause', { title: 'Pause', }],
['BrowserContext.enableRecorder', { internal: true, }],
['BrowserContext.disableRecorder', { internal: true, }],
- ['BrowserContext.newCDPSession', { internal: true, }],
+ ['BrowserContext.newCDPSession', { title: 'Create CDP session', group: 'configuration', }],
['BrowserContext.harStart', { internal: true, }],
['BrowserContext.harExport', { internal: true, }],
['BrowserContext.createTempFiles', { internal: true, }],
@@ -99,22 +99,22 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['BrowserContext.clockSetFixedTime', { title: 'Set fixed time "{timeNumber|timeString}"', }],
['BrowserContext.clockSetSystemTime', { title: 'Set system time "{timeNumber|timeString}"', }],
['BrowserContext.clockUninstall', { title: 'Uninstall clock', }],
- ['Page.addInitScript', { }],
+ ['Page.addInitScript', { title: 'Add init script', group: 'configuration', }],
['Page.close', { title: 'Close page', }],
['Page.emulateMedia', { title: 'Emulate media', snapshot: true, }],
- ['Page.exposeBinding', { title: 'Expose binding', }],
+ ['Page.exposeBinding', { title: 'Expose binding', group: 'configuration', }],
['Page.goBack', { title: 'Go back', slowMo: true, snapshot: true, }],
['Page.goForward', { title: 'Go forward', slowMo: true, snapshot: true, }],
- ['Page.requestGC', { title: 'Request garbage collection', }],
+ ['Page.requestGC', { title: 'Request garbage collection', group: 'configuration', }],
['Page.registerLocatorHandler', { title: 'Register locator handler', }],
['Page.resolveLocatorHandlerNoReply', { internal: true, }],
['Page.unregisterLocatorHandler', { title: 'Unregister locator handler', }],
['Page.reload', { title: 'Reload', slowMo: true, snapshot: true, }],
['Page.expectScreenshot', { title: 'Expect screenshot', snapshot: true, }],
['Page.screenshot', { title: 'Screenshot', snapshot: true, }],
- ['Page.setExtraHTTPHeaders', { title: 'Set extra HTTP headers', }],
- ['Page.setNetworkInterceptionPatterns', { internal: true, }],
- ['Page.setWebSocketInterceptionPatterns', { internal: true, }],
+ ['Page.setExtraHTTPHeaders', { title: 'Set extra HTTP headers', group: 'configuration', }],
+ ['Page.setNetworkInterceptionPatterns', { title: 'Route requests', group: 'route', }],
+ ['Page.setWebSocketInterceptionPatterns', { title: 'Route WebSockets', group: 'route', }],
['Page.setViewportSize', { title: 'Set viewport size', snapshot: true, }],
['Page.keyboardDown', { title: 'Key down "{key}"', slowMo: true, snapshot: true, }],
['Page.keyboardUp', { title: 'Key up "{key}"', slowMo: true, snapshot: true, }],
@@ -127,13 +127,13 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['Page.mouseClick', { title: 'Click', slowMo: true, snapshot: true, }],
['Page.mouseWheel', { title: 'Mouse wheel', slowMo: true, snapshot: true, }],
['Page.touchscreenTap', { title: 'Tap', slowMo: true, snapshot: true, }],
- ['Page.accessibilitySnapshot', { internal: true, snapshot: true, }],
+ ['Page.accessibilitySnapshot', { title: 'Accessibility snapshot', group: 'getter', }],
['Page.pdf', { title: 'PDF', }],
- ['Page.snapshotForAI', { internal: true, snapshot: true, }],
- ['Page.startJSCoverage', { internal: true, }],
- ['Page.stopJSCoverage', { internal: true, }],
- ['Page.startCSSCoverage', { internal: true, }],
- ['Page.stopCSSCoverage', { internal: true, }],
+ ['Page.snapshotForAI', { internal: true, }],
+ ['Page.startJSCoverage', { title: 'Start JS coverage', group: 'configuration', }],
+ ['Page.stopJSCoverage', { title: 'Stop JS coverage', group: 'configuration', }],
+ ['Page.startCSSCoverage', { title: 'Start CSS coverage', group: 'configuration', }],
+ ['Page.stopCSSCoverage', { title: 'Stop CSS coverage', group: 'configuration', }],
['Page.bringToFront', { title: 'Bring to front', }],
['Page.updateSubscription', { internal: true, }],
['Frame.evalOnSelector', { title: 'Evaluate', snapshot: true, }],
@@ -152,21 +152,21 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['Frame.evaluateExpressionHandle', { title: 'Evaluate', snapshot: true, }],
['Frame.fill', { title: 'Fill "{value}"', slowMo: true, snapshot: true, pausesBeforeInput: true, }],
['Frame.focus', { title: 'Focus', slowMo: true, snapshot: true, }],
- ['Frame.frameElement', { internal: true, }],
+ ['Frame.frameElement', { title: 'Get frame element', group: 'getter', }],
['Frame.resolveSelector', { internal: true, }],
- ['Frame.highlight', { internal: true, }],
- ['Frame.getAttribute', { internal: true, snapshot: true, }],
+ ['Frame.highlight', { title: 'Highlight element', group: 'configuration', }],
+ ['Frame.getAttribute', { title: 'Get attribute "{name}"', snapshot: true, group: 'getter', }],
['Frame.goto', { title: 'Navigate to "{url}"', slowMo: true, snapshot: true, }],
['Frame.hover', { title: 'Hover', slowMo: true, snapshot: true, pausesBeforeInput: true, }],
- ['Frame.innerHTML', { title: 'Get HTML', snapshot: true, }],
- ['Frame.innerText', { title: 'Get inner text', snapshot: true, }],
- ['Frame.inputValue', { title: 'Get input value', snapshot: true, }],
- ['Frame.isChecked', { title: 'Is checked', snapshot: true, }],
- ['Frame.isDisabled', { title: 'Is disabled', snapshot: true, }],
- ['Frame.isEnabled', { title: 'Is enabled', snapshot: true, }],
- ['Frame.isHidden', { title: 'Is hidden', snapshot: true, }],
- ['Frame.isVisible', { title: 'Is visible', snapshot: true, }],
- ['Frame.isEditable', { title: 'Is editable', snapshot: true, }],
+ ['Frame.innerHTML', { title: 'Get HTML', snapshot: true, group: 'getter', }],
+ ['Frame.innerText', { title: 'Get inner text', snapshot: true, group: 'getter', }],
+ ['Frame.inputValue', { title: 'Get input value', snapshot: true, group: 'getter', }],
+ ['Frame.isChecked', { title: 'Is checked', snapshot: true, group: 'getter', }],
+ ['Frame.isDisabled', { title: 'Is disabled', snapshot: true, group: 'getter', }],
+ ['Frame.isEnabled', { title: 'Is enabled', snapshot: true, group: 'getter', }],
+ ['Frame.isHidden', { title: 'Is hidden', snapshot: true, group: 'getter', }],
+ ['Frame.isVisible', { title: 'Is visible', snapshot: true, group: 'getter', }],
+ ['Frame.isEditable', { title: 'Is editable', snapshot: true, group: 'getter', }],
['Frame.press', { title: 'Press "{key}"', slowMo: true, snapshot: true, pausesBeforeInput: true, }],
['Frame.querySelector', { title: 'Query selector', snapshot: true, }],
['Frame.querySelectorAll', { title: 'Query selector all', snapshot: true, }],
@@ -175,9 +175,9 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['Frame.setContent', { title: 'Set content', snapshot: true, }],
['Frame.setInputFiles', { title: 'Set input files', slowMo: true, snapshot: true, pausesBeforeInput: true, }],
['Frame.tap', { title: 'Tap', slowMo: true, snapshot: true, pausesBeforeInput: true, }],
- ['Frame.textContent', { title: 'Get text content', snapshot: true, }],
- ['Frame.title', { internal: true, }],
- ['Frame.type', { title: 'Type', slowMo: true, snapshot: true, pausesBeforeInput: true, }],
+ ['Frame.textContent', { title: 'Get text content', snapshot: true, group: 'getter', }],
+ ['Frame.title', { title: 'Get page title', group: 'getter', }],
+ ['Frame.type', { title: 'Type "{text}"', slowMo: true, snapshot: true, pausesBeforeInput: true, }],
['Frame.uncheck', { title: 'Uncheck', slowMo: true, snapshot: true, pausesBeforeInput: true, }],
['Frame.waitForTimeout', { title: 'Wait for timeout', snapshot: true, }],
['Frame.waitForFunction', { title: 'Wait for function', snapshot: true, }],
@@ -185,40 +185,40 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['Frame.expect', { title: 'Expect "{expression}"', snapshot: true, }],
['Worker.evaluateExpression', { title: 'Evaluate', }],
['Worker.evaluateExpressionHandle', { title: 'Evaluate', }],
- ['JSHandle.dispose', { }],
- ['ElementHandle.dispose', { }],
+ ['JSHandle.dispose', { internal: true, }],
+ ['ElementHandle.dispose', { internal: true, }],
['JSHandle.evaluateExpression', { title: 'Evaluate', snapshot: true, }],
['ElementHandle.evaluateExpression', { title: 'Evaluate', snapshot: true, }],
['JSHandle.evaluateExpressionHandle', { title: 'Evaluate', snapshot: true, }],
['ElementHandle.evaluateExpressionHandle', { title: 'Evaluate', snapshot: true, }],
- ['JSHandle.getPropertyList', { internal: true, }],
- ['ElementHandle.getPropertyList', { internal: true, }],
- ['JSHandle.getProperty', { internal: true, }],
- ['ElementHandle.getProperty', { internal: true, }],
- ['JSHandle.jsonValue', { internal: true, }],
- ['ElementHandle.jsonValue', { internal: true, }],
+ ['JSHandle.getPropertyList', { title: 'Get property list', group: 'getter', }],
+ ['ElementHandle.getPropertyList', { title: 'Get property list', group: 'getter', }],
+ ['JSHandle.getProperty', { title: 'Get JS property', group: 'getter', }],
+ ['ElementHandle.getProperty', { title: 'Get JS property', group: 'getter', }],
+ ['JSHandle.jsonValue', { title: 'Get JSON value', group: 'getter', }],
+ ['ElementHandle.jsonValue', { title: 'Get JSON value', group: 'getter', }],
['ElementHandle.evalOnSelector', { title: 'Evaluate', snapshot: true, }],
['ElementHandle.evalOnSelectorAll', { title: 'Evaluate', snapshot: true, }],
['ElementHandle.boundingBox', { title: 'Get bounding box', snapshot: true, }],
['ElementHandle.check', { title: 'Check', slowMo: true, snapshot: true, pausesBeforeInput: true, }],
['ElementHandle.click', { title: 'Click', slowMo: true, snapshot: true, pausesBeforeInput: true, }],
- ['ElementHandle.contentFrame', { internal: true, snapshot: true, }],
+ ['ElementHandle.contentFrame', { title: 'Get content frame', snapshot: true, group: 'getter', }],
['ElementHandle.dblclick', { title: 'Double click', slowMo: true, snapshot: true, pausesBeforeInput: true, }],
['ElementHandle.dispatchEvent', { title: 'Dispatch event', slowMo: true, snapshot: true, }],
['ElementHandle.fill', { title: 'Fill "{value}"', slowMo: true, snapshot: true, pausesBeforeInput: true, }],
['ElementHandle.focus', { title: 'Focus', slowMo: true, snapshot: true, }],
- ['ElementHandle.getAttribute', { internal: true, }],
+ ['ElementHandle.getAttribute', { title: 'Get attribute', group: 'getter', }],
['ElementHandle.hover', { title: 'Hover', slowMo: true, snapshot: true, pausesBeforeInput: true, }],
- ['ElementHandle.innerHTML', { title: 'Get HTML', snapshot: true, }],
- ['ElementHandle.innerText', { title: 'Get inner text', snapshot: true, }],
- ['ElementHandle.inputValue', { title: 'Get input value', snapshot: true, }],
- ['ElementHandle.isChecked', { title: 'Is checked', snapshot: true, }],
- ['ElementHandle.isDisabled', { title: 'Is disabled', snapshot: true, }],
- ['ElementHandle.isEditable', { title: 'Is editable', snapshot: true, }],
- ['ElementHandle.isEnabled', { title: 'Is enabled', snapshot: true, }],
- ['ElementHandle.isHidden', { title: 'Is hidden', snapshot: true, }],
- ['ElementHandle.isVisible', { title: 'Is visible', snapshot: true, }],
- ['ElementHandle.ownerFrame', { title: 'Get owner frame', }],
+ ['ElementHandle.innerHTML', { title: 'Get HTML', snapshot: true, group: 'getter', }],
+ ['ElementHandle.innerText', { title: 'Get inner text', snapshot: true, group: 'getter', }],
+ ['ElementHandle.inputValue', { title: 'Get input value', snapshot: true, group: 'getter', }],
+ ['ElementHandle.isChecked', { title: 'Is checked', snapshot: true, group: 'getter', }],
+ ['ElementHandle.isDisabled', { title: 'Is disabled', snapshot: true, group: 'getter', }],
+ ['ElementHandle.isEditable', { title: 'Is editable', snapshot: true, group: 'getter', }],
+ ['ElementHandle.isEnabled', { title: 'Is enabled', snapshot: true, group: 'getter', }],
+ ['ElementHandle.isHidden', { title: 'Is hidden', snapshot: true, group: 'getter', }],
+ ['ElementHandle.isVisible', { title: 'Is visible', snapshot: true, group: 'getter', }],
+ ['ElementHandle.ownerFrame', { title: 'Get owner frame', group: 'getter', }],
['ElementHandle.press', { title: 'Press "{key}"', slowMo: true, snapshot: true, pausesBeforeInput: true, }],
['ElementHandle.querySelector', { title: 'Query selector', snapshot: true, }],
['ElementHandle.querySelectorAll', { title: 'Query selector all', snapshot: true, }],
@@ -228,7 +228,7 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['ElementHandle.selectText', { title: 'Select text', slowMo: true, snapshot: true, }],
['ElementHandle.setInputFiles', { title: 'Set input files', slowMo: true, snapshot: true, pausesBeforeInput: true, }],
['ElementHandle.tap', { title: 'Tap', slowMo: true, snapshot: true, pausesBeforeInput: true, }],
- ['ElementHandle.textContent', { title: 'Get text content', snapshot: true, }],
+ ['ElementHandle.textContent', { title: 'Get text content', snapshot: true, group: 'getter', }],
['ElementHandle.type', { title: 'Type', slowMo: true, snapshot: true, pausesBeforeInput: true, }],
['ElementHandle.uncheck', { title: 'Uncheck', slowMo: true, snapshot: true, pausesBeforeInput: true, }],
['ElementHandle.waitForElementState', { title: 'Wait for state', snapshot: true, }],
@@ -236,16 +236,16 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['Request.response', { internal: true, }],
['Request.rawRequestHeaders', { internal: true, }],
['Route.redirectNavigationRequest', { internal: true, }],
- ['Route.abort', { }],
- ['Route.continue', { internal: true, }],
- ['Route.fulfill', { internal: true, }],
- ['WebSocketRoute.connect', { internal: true, }],
+ ['Route.abort', { title: 'Abort request', group: 'route', }],
+ ['Route.continue', { title: 'Continue request', group: 'route', }],
+ ['Route.fulfill', { title: 'Fulfill request', group: 'route', }],
+ ['WebSocketRoute.connect', { title: 'Connect WebSocket to server', group: 'route', }],
['WebSocketRoute.ensureOpened', { internal: true, }],
- ['WebSocketRoute.sendToPage', { internal: true, }],
- ['WebSocketRoute.sendToServer', { internal: true, }],
+ ['WebSocketRoute.sendToPage', { title: 'Send WebSocket message', group: 'route', }],
+ ['WebSocketRoute.sendToServer', { title: 'Send WebSocket message', group: 'route', }],
['WebSocketRoute.closePage', { internal: true, }],
['WebSocketRoute.closeServer', { internal: true, }],
- ['Response.body', { internal: true, }],
+ ['Response.body', { title: 'Get response body', group: 'getter', }],
['Response.securityDetails', { internal: true, }],
['Response.serverAddr', { internal: true, }],
['Response.rawResponseHeaders', { internal: true, }],
@@ -254,12 +254,12 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['BindingCall.resolve', { internal: true, }],
['Dialog.accept', { title: 'Accept dialog', }],
['Dialog.dismiss', { title: 'Dismiss dialog', }],
- ['Tracing.tracingStart', { internal: true, }],
- ['Tracing.tracingStartChunk', { internal: true, }],
+ ['Tracing.tracingStart', { title: 'Start tracing', group: 'configuration', }],
+ ['Tracing.tracingStartChunk', { title: 'Start tracing', group: 'configuration', }],
['Tracing.tracingGroup', { title: 'Trace "{name}"', }],
['Tracing.tracingGroupEnd', { title: 'Group end', }],
- ['Tracing.tracingStopChunk', { internal: true, }],
- ['Tracing.tracingStop', { internal: true, }],
+ ['Tracing.tracingStopChunk', { title: 'Stop tracing', group: 'configuration', }],
+ ['Tracing.tracingStop', { title: 'Stop tracing', group: 'configuration', }],
['Artifact.pathAfterFinished', { internal: true, }],
['Artifact.saveAs', { internal: true, }],
['Artifact.saveAsStream', { internal: true, }],
@@ -271,8 +271,8 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['Stream.close', { internal: true, }],
['WritableStream.write', { internal: true, }],
['WritableStream.close', { internal: true, }],
- ['CDPSession.send', { internal: true, }],
- ['CDPSession.detach', { internal: true, }],
+ ['CDPSession.send', { title: 'Send CDP command', group: 'configuration', }],
+ ['CDPSession.detach', { title: 'Detach CDP session', group: 'configuration', }],
['Electron.launch', { title: 'Launch electron', }],
['ElectronApplication.browserWindow', { internal: true, }],
['ElectronApplication.evaluateExpression', { title: 'Evaluate', }],
@@ -281,7 +281,7 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['Android.devices', { internal: true, }],
['AndroidSocket.write', { internal: true, }],
['AndroidSocket.close', { internal: true, }],
- ['AndroidDevice.wait', { }],
+ ['AndroidDevice.wait', { title: 'Wait', }],
['AndroidDevice.fill', { title: 'Fill "{text}"', }],
['AndroidDevice.tap', { title: 'Tap', }],
['AndroidDevice.drag', { title: 'Drag', }],
@@ -300,10 +300,10 @@ export const methodMetainfo = new Map<string, { internal?: boolean, title?: stri
['AndroidDevice.inputDrag', { title: 'Drag', }],
['AndroidDevice.launchBrowser', { title: 'Launch browser', }],
['AndroidDevice.open', { title: 'Open app', }],
- ['AndroidDevice.shell', { internal: true, }],
+ ['AndroidDevice.shell', { title: 'Execute shell command', group: 'configuration', }],
['AndroidDevice.installApk', { title: 'Install apk', }],
['AndroidDevice.push', { title: 'Push', }],
- ['AndroidDevice.connectToWebView', { internal: true, }],
+ ['AndroidDevice.connectToWebView', { title: 'Connect to Web View', }],
['AndroidDevice.close', { internal: true, }],
['JsonPipe.send', { internal: true, }],
['JsonPipe.close', { internal: true, }]
diff --git a/packages/playwright/src/index.ts b/packages/playwright/src/index.ts
index 7abd4342c2..f2552760e1 100644
--- a/packages/playwright/src/index.ts
+++ b/packages/playwright/src/index.ts
@@ -18,7 +18,7 @@ import fs from 'fs';
import path from 'path';
import * as playwrightLibrary from 'playwright-core';
-import { setBoxedStackPrefixes, createGuid, currentZone, debugMode, jsonStringifyForceASCII, asLocatorDescription, renderTitleForCall } from 'playwright-core/lib/utils';
+import { setBoxedStackPrefixes, createGuid, currentZone, debugMode, jsonStringifyForceASCII, asLocatorDescription, renderTitleForCall, getActionGroup } from 'playwright-core/lib/utils';
import { currentTestInfo } from './common/globals';
import { rootTestType } from './common/testType';
@@ -280,6 +280,7 @@ const playwrightFixtures: Fixtures<TestFixtures, WorkerFixtures> = ({
title: renderTitle(channel.type, channel.method, channel.params, data.title),
apiName: data.apiName,
params: channel.params,
+ visibility: getActionGroup({ type: channel.type, method: channel.method }) ? 'hidden' : undefined,
}, tracingGroupSteps[tracingGroupSteps.length - 1]);
data.userData = step;
data.stepId = step.stepId;
diff --git a/packages/playwright/src/worker/testInfo.ts b/packages/playwright/src/worker/testInfo.ts
index ddb0b68c98..64056bb9e2 100644
--- a/packages/playwright/src/worker/testInfo.ts
+++ b/packages/playwright/src/worker/testInfo.ts
@@ -34,7 +34,7 @@ import type { TestCase } from '../common/test';
import type { StackFrame } from '@protocol/channels';
import type { TestStepCategory } from '../util';
-export type TestStepVisibility = 'default' | 'internal' | 'hidden';
+export type TestStepVisibility = 'internal' | 'hidden';
interface TestStepData {
title: string;
@@ -287,7 +287,7 @@ export class TestInfoImpl implements TestInfo {
}
location = location || filteredStack[0];
const visibility = (parentStep?.visibility === 'internal' || data.visibility === 'internal') ? 'internal' :
- (parentStep?.visibility === 'hidden' || data.visibility === 'hidden' ? 'hidden' : 'default');
+ (parentStep?.visibility === 'hidden' || data.visibility === 'hidden' ? 'hidden' : undefined);
const step: TestStepInternal = {
...data,
@@ -325,7 +325,7 @@ export class TestInfoImpl implements TestInfo {
}
}
- if (visibility === 'default') {
+ if (!step.visibility) {
const payload: StepEndPayload = {
testId: this.testId,
stepId,
@@ -336,7 +336,7 @@ export class TestInfoImpl implements TestInfo {
};
this._onStepEnd(payload);
}
- if (visibility !== 'internal') {
+ if (step.visibility !== 'internal') {
const errorForTrace = step.error ? { name: '', message: step.error.message || '', stack: step.error.stack } : undefined;
const attachments = step.attachmentIndices.map(i => this.attachments[i]);
this._tracing.appendAfterActionForStep(stepId, errorForTrace, attachments, step.info.annotations);
@@ -347,7 +347,7 @@ export class TestInfoImpl implements TestInfo {
parentStepList.push(step);
this._stepMap.set(stepId, step);
- if (visibility === 'default') {
+ if (!step.visibility) {
const payload: StepBeginPayload = {
testId: this.testId,
stepId,
@@ -359,7 +359,7 @@ export class TestInfoImpl implements TestInfo {
};
this._onStepBegin(payload);
}
- if (visibility !== 'internal') {
+ if (step.visibility !== 'internal') {
this._tracing.appendBeforeActionForStep({
stepId,
parentId: parentStep?.stepId,
@@ -367,7 +367,7 @@ export class TestInfoImpl implements TestInfo {
category: step.category,
params: step.params,
stack: step.location ? [step.location] : [],
- visibility: visibility === 'hidden' ? 'hidden' : undefined,
+ visibility: step.visibility,
});
}
diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.yml
index bf240c86a8..31e9aedc74 100644
--- a/packages/protocol/src/protocol.yml
+++ b/packages/protocol/src/protocol.yml
@@ -402,7 +402,8 @@ APIRequestContext:
response: APIResponse
fetchResponseBody:
- internal: true
+ title: Get response body
+ group: getter
parameters:
fetchUid: string
returns:
@@ -418,7 +419,7 @@ APIRequestContext:
items: string
storageState:
- internal: true
+ title: Get storage state
parameters:
indexedDB: boolean?
returns:
@@ -1105,12 +1106,13 @@ Browser:
newBrowserCDPSession:
title: Create CDP session
- internal: true
+ group: configuration
returns:
session: CDPSession
startTracing:
- internal: true
+ title: Start browser tracing
+ group: configuration
parameters:
page: Page?
screenshots: boolean?
@@ -1119,7 +1121,8 @@ Browser:
items: string
stopTracing:
- internal: true
+ title: Stop browser tracing
+ group: configuration
returns:
artifact: Artifact
@@ -1188,6 +1191,7 @@ BrowserContext:
addCookies:
title: Add cookies
+ group: configuration
parameters:
cookies:
type: array
@@ -1195,11 +1199,13 @@ BrowserContext:
addInitScript:
title: Add init script
+ group: configuration
parameters:
source: string
clearCookies:
title: Clear cookies
+ group: configuration
parameters:
name: string?
nameRegexSource: string?
@@ -1213,6 +1219,7 @@ BrowserContext:
clearPermissions:
title: Clear permissions
+ group: configuration
close:
title: Close context
@@ -1221,6 +1228,7 @@ BrowserContext:
cookies:
title: Get cookies
+ group: getter
parameters:
urls:
type: array
@@ -1232,12 +1240,14 @@ BrowserContext:
exposeBinding:
title: Expose binding
+ group: configuration
parameters:
name: string
needsHandle: boolean?
grantPermissions:
title: Grant permissions
+ group: configuration
parameters:
permissions:
type: array
@@ -1261,6 +1271,7 @@ BrowserContext:
setExtraHTTPHeaders:
title: Set extra HTTP headers
+ group: configuration
parameters:
headers:
type: array
@@ -1268,6 +1279,7 @@ BrowserContext:
setGeolocation:
title: Set geolocation
+ group: configuration
parameters:
geolocation:
type: object?
@@ -1278,6 +1290,7 @@ BrowserContext:
setHTTPCredentials:
title: Set HTTP credentials
+ group: configuration
parameters:
httpCredentials:
type: object?
@@ -1287,7 +1300,8 @@ BrowserContext:
origin: string?
setNetworkInterceptionPatterns:
- internal: true
+ title: Route requests
+ group: route
parameters:
patterns:
type: array
@@ -1299,7 +1313,8 @@ BrowserContext:
regexFlags: string?
setWebSocketInterceptionPatterns:
- internal: true
+ title: Route WebSockets
+ group: route
parameters:
patterns:
type: array
@@ -1329,6 +1344,7 @@ BrowserContext:
setStorageState:
title: Set storage state
+ group: configuration
parameters:
storageState:
type: object
@@ -1371,7 +1387,8 @@ BrowserContext:
internal: true
newCDPSession:
- internal: true
+ title: Create CDP session
+ group: configuration
parameters:
page: Page?
frame: Frame?
@@ -1566,6 +1583,8 @@ Page:
commands:
addInitScript:
+ title: Add init script
+ group: configuration
parameters:
source: string
@@ -1614,6 +1633,7 @@ Page:
exposeBinding:
title: Expose binding
+ group: configuration
parameters:
name: string
needsHandle: boolean?
@@ -1642,6 +1662,7 @@ Page:
requestGC:
title: Request garbage collection
+ group: configuration
registerLocatorHandler:
title: Register locator handler
@@ -1723,13 +1744,15 @@ Page:
setExtraHTTPHeaders:
title: Set extra HTTP headers
+ group: configuration
parameters:
headers:
type: array
items: NameValue
setNetworkInterceptionPatterns:
- internal: true
+ title: Route requests
+ group: route
parameters:
patterns:
type: array
@@ -1741,7 +1764,8 @@ Page:
regexFlags: string?
setWebSocketInterceptionPatterns:
- internal: true
+ title: Route WebSockets
+ group: route
parameters:
patterns:
type: array
@@ -1879,14 +1903,13 @@ Page:
snapshot: true
accessibilitySnapshot:
- internal: true
+ title: Accessibility snapshot
+ group: getter
parameters:
interestingOnly: boolean?
root: ElementHandle?
returns:
rootAXNode: AXNode?
- flags:
- snapshot: true
pdf:
title: PDF
@@ -1920,17 +1943,17 @@ Page:
timeout: float
returns:
snapshot: string
- flags:
- snapshot: true
startJSCoverage:
- internal: true
+ title: Start JS coverage
+ group: configuration
parameters:
resetOnNavigation: boolean?
reportAnonymousScripts: boolean?
stopJSCoverage:
- internal: true
+ title: Stop JS coverage
+ group: configuration
returns:
entries:
type: array
@@ -1957,12 +1980,14 @@ Page:
count: int
startCSSCoverage:
- internal: true
+ title: Start CSS coverage
+ group: configuration
parameters:
resetOnNavigation: boolean?
stopCSSCoverage:
- internal: true
+ title: Stop CSS coverage
+ group: configuration
returns:
entries:
type: array
@@ -2298,7 +2323,8 @@ Frame:
snapshot: true
frameElement:
- internal: true
+ title: Get frame element
+ group: getter
returns:
element: ElementHandle
@@ -2310,12 +2336,14 @@ Frame:
resolvedSelector: string
highlight:
- internal: true
+ title: Highlight element
+ group: configuration
parameters:
selector: string
getAttribute:
- internal: true
+ title: Get attribute "{name}"
+ group: getter
parameters:
selector: string
strict: boolean?
@@ -2365,6 +2393,7 @@ Frame:
innerHTML:
title: Get HTML
+ group: getter
parameters:
selector: string
strict: boolean?
@@ -2376,6 +2405,7 @@ Frame:
innerText:
title: Get inner text
+ group: getter
parameters:
selector: string
strict: boolean?
@@ -2387,6 +2417,7 @@ Frame:
inputValue:
title: Get input value
+ group: getter
parameters:
selector: string
strict: boolean?
@@ -2398,6 +2429,7 @@ Frame:
isChecked:
title: Is checked
+ group: getter
parameters:
selector: string
strict: boolean?
@@ -2409,6 +2441,7 @@ Frame:
isDisabled:
title: Is disabled
+ group: getter
parameters:
selector: string
strict: boolean?
@@ -2420,6 +2453,7 @@ Frame:
isEnabled:
title: Is enabled
+ group: getter
parameters:
selector: string
strict: boolean?
@@ -2431,6 +2465,7 @@ Frame:
isHidden:
title: Is hidden
+ group: getter
parameters:
# Note: compared to other isFoo methods, isHidden is a one-shot operation without a timeout.
selector: string
@@ -2442,6 +2477,7 @@ Frame:
isVisible:
title: Is visible
+ group: getter
parameters:
# Note: compared to other isFoo methods, isVisible is a one-shot operation without a timeout.
selector: string
@@ -2453,6 +2489,7 @@ Frame:
isEditable:
title: Is editable
+ group: getter
parameters:
selector: string
strict: boolean?
@@ -2597,6 +2634,7 @@ Frame:
textContent:
title: Get text content
+ group: getter
parameters:
selector: string
strict: boolean?
@@ -2607,12 +2645,13 @@ Frame:
snapshot: true
title:
- internal: true
+ title: Get page title
+ group: getter
returns:
value: string
type:
- title: Type
+ title: Type "{text}"
parameters:
selector: string
strict: boolean?
@@ -2761,6 +2800,7 @@ JSHandle:
commands:
dispose:
+ internal: true
evaluateExpression:
title: Evaluate
@@ -2785,7 +2825,8 @@ JSHandle:
snapshot: true
getPropertyList:
- internal: true
+ title: Get property list
+ group: getter
returns:
properties:
type: array
@@ -2796,14 +2837,16 @@ JSHandle:
value: JSHandle
getProperty:
- internal: true
+ title: Get JS property
+ group: getter
parameters:
name: string
returns:
handle: JSHandle
jsonValue:
- internal: true
+ title: Get JSON value
+ group: getter
returns:
value: SerializedValue
@@ -2898,7 +2941,8 @@ ElementHandle:
pausesBeforeInput: true
contentFrame:
- internal: true
+ title: Get content frame
+ group: getter
returns:
frame: Frame?
flags:
@@ -2960,7 +3004,8 @@ ElementHandle:
snapshot: true
getAttribute:
- internal: true
+ title: Get attribute
+ group: getter
parameters:
name: string
returns:
@@ -2990,6 +3035,7 @@ ElementHandle:
innerHTML:
title: Get HTML
+ group: getter
returns:
value: string
flags:
@@ -2997,6 +3043,7 @@ ElementHandle:
innerText:
title: Get inner text
+ group: getter
returns:
value: string
flags:
@@ -3004,6 +3051,7 @@ ElementHandle:
inputValue:
title: Get input value
+ group: getter
returns:
value: string
flags:
@@ -3011,6 +3059,7 @@ ElementHandle:
isChecked:
title: Is checked
+ group: getter
returns:
value: boolean
flags:
@@ -3018,6 +3067,7 @@ ElementHandle:
isDisabled:
title: Is disabled
+ group: getter
returns:
value: boolean
flags:
@@ -3025,6 +3075,7 @@ ElementHandle:
isEditable:
title: Is editable
+ group: getter
returns:
value: boolean
flags:
@@ -3032,6 +3083,7 @@ ElementHandle:
isEnabled:
title: Is enabled
+ group: getter
returns:
value: boolean
flags:
@@ -3039,6 +3091,7 @@ ElementHandle:
isHidden:
title: Is hidden
+ group: getter
returns:
value: boolean
flags:
@@ -3046,6 +3099,7 @@ ElementHandle:
isVisible:
title: Is visible
+ group: getter
returns:
value: boolean
flags:
@@ -3053,6 +3107,7 @@ ElementHandle:
ownerFrame:
title: Get owner frame
+ group: getter
returns:
frame: Frame?
@@ -3198,6 +3253,7 @@ ElementHandle:
textContent:
title: Get text content
+ group: getter
returns:
value: string?
flags:
@@ -3306,11 +3362,14 @@ Route:
url: string
abort:
+ title: Abort request
+ group: route
parameters:
errorCode: string?
continue:
- internal: true
+ title: Continue request
+ group: route
parameters:
url: string?
method: string?
@@ -3321,7 +3380,8 @@ Route:
isFallback: boolean
fulfill:
- internal: true
+ title: Fulfill request
+ group: route
parameters:
# default is 200
status: int?
@@ -3342,19 +3402,22 @@ WebSocketRoute:
commands:
connect:
- internal: true
+ title: Connect WebSocket to server
+ group: route
ensureOpened:
internal: true
sendToPage:
- internal: true
+ title: Send WebSocket message
+ group: route
parameters:
message: string
isBase64: boolean
sendToServer:
- internal: true
+ title: Send WebSocket message
+ group: route
parameters:
message: string
isBase64: boolean
@@ -3428,7 +3491,8 @@ Response:
commands:
body:
- internal: true
+ title: Get response body
+ group: getter
returns:
binary: binary
@@ -3558,7 +3622,8 @@ Tracing:
commands:
tracingStart:
- internal: true
+ title: Start tracing
+ group: configuration
parameters:
name: string?
snapshots: boolean?
@@ -3566,7 +3631,8 @@ Tracing:
live: boolean?
tracingStartChunk:
- internal: true
+ title: Start tracing
+ group: configuration
parameters:
name: string?
title: string?
@@ -3588,7 +3654,8 @@ Tracing:
title: Group end
tracingStopChunk:
- internal: true
+ title: Stop tracing
+ group: configuration
parameters:
mode:
type: enum
@@ -3606,7 +3673,8 @@ Tracing:
items: NameValue
tracingStop:
- internal: true
+ title: Stop tracing
+ group: configuration
Artifact:
@@ -3687,7 +3755,8 @@ CDPSession:
commands:
send:
- internal: true
+ title: Send CDP command
+ group: configuration
parameters:
method: string
params: json?
@@ -3695,7 +3764,8 @@ CDPSession:
result: json
detach:
- internal: true
+ title: Detach CDP session
+ group: configuration
events:
@@ -3870,7 +3940,7 @@ AndroidDevice:
commands:
wait:
- hidden: Wait
+ title: Wait
parameters:
androidSelector: AndroidSelector
state:
@@ -4036,7 +4106,8 @@ AndroidDevice:
socket: AndroidSocket
shell:
- internal: true
+ title: Execute shell command
+ group: configuration
parameters:
command: string
returns:
@@ -4058,7 +4129,7 @@ AndroidDevice:
mode: int?
connectToWebView:
- internal: true
+ title: Connect to Web View
parameters:
socketName: string
returns:
diff --git a/packages/trace-viewer/src/ui/defaultSettingsView.tsx b/packages/trace-viewer/src/ui/defaultSettingsView.tsx
index 5829873c99..13f5393c7f 100644
--- a/packages/trace-viewer/src/ui/defaultSettingsView.tsx
+++ b/packages/trace-viewer/src/ui/defaultSettingsView.tsx
@@ -44,6 +44,7 @@ export const DefaultSettingsView: React.FC<{}> = () => {
value: showAllActions,
set: setShowAllActions,
name: 'Show all actions',
+ title: 'Show all actions including routes, getters, boxed fixtures, etc.',
},
]}
/>
diff --git a/tests/config/traceViewerFixtures.ts b/tests/config/traceViewerFixtures.ts
index d4d6284c8b..9c68c07dc4 100644
--- a/tests/config/traceViewerFixtures.ts
+++ b/tests/config/traceViewerFixtures.ts
@@ -51,6 +51,7 @@ class TraceViewerPage {
settingsDialog: Locator;
darkModeSetting: Locator;
displayCanvasContentSetting: Locator;
+ showAllActionsSetting: Locator;
constructor(public page: Page) {
this.actionTitles = page.locator('.action-title');
@@ -69,6 +70,7 @@ class TraceViewerPage {
this.settingsDialog = page.getByTestId('settings-toolbar-dialog');
this.darkModeSetting = page.locator('.setting').getByText('Dark mode');
this.displayCanvasContentSetting = page.locator('.setting').getByText('Display canvas content');
+ this.showAllActionsSetting = page.locator('.setting').getByText('Show all actions');
}
stackFrames(options: { selected?: boolean } = {}) {
diff --git a/tests/library/inspector/pause.spec.ts b/tests/library/inspector/pause.spec.ts
index e5c1c5fbf8..c4c92d84ee 100644
--- a/tests/library/inspector/pause.spec.ts
+++ b/tests/library/inspector/pause.spec.ts
@@ -266,6 +266,8 @@ it.describe('pause', () => {
await recorderPage.waitForSelector('.source-line-paused:has-text("page.pause({ __testHookKeepTestTimeout: true }); // 2")');
expect(await sanitizeLog(recorderPage)).toEqual([
'Pause- XXms',
+ 'Start tracing- XXms',
+ 'Stop tracing- XXms',
'Pause',
]);
await recorderPage.click('[title="Resume (F8)"]');
diff --git a/tests/library/trace-viewer.spec.ts b/tests/library/trace-viewer.spec.ts
index 80502d8ea6..abf35f6234 100644
--- a/tests/library/trace-viewer.spec.ts
+++ b/tests/library/trace-viewer.spec.ts
@@ -911,6 +911,9 @@ test('should highlight target elements', async ({ page, runAndTrace, browserName
});
}
+ await traceViewer.showSettings();
+ await traceViewer.showAllActionsSetting.click();
+
const framePageClick = await traceViewer.snapshotFrame('Click');
await expect.poll(() => highlightedDivs(framePageClick)).toEqual(['t1']);
const box1 = await framePageClick.getByText('t1').boundingBox();
@@ -1480,6 +1483,8 @@ test('should open snapshot in new browser context', async ({ browser, page, runA
test('should show similar actions from legacy library-only trace', async ({ showTraceViewer, asset }) => {
const traceViewer = await showTraceViewer([asset('trace-library-1.46.zip')]);
+ await traceViewer.showSettings();
+ await traceViewer.showAllActionsSetting.click();
await expect(traceViewer.actionTitles).toHaveText([
/page\.setContent/,
/locator\.getAttribute/,
@@ -1543,13 +1548,17 @@ test('should not record network actions', {
annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright/issues/33558' },
}, async ({ page, runAndTrace, server }) => {
const traceViewer = await runAndTrace(async () => {
+ let counter = 0;
page.on('request', async request => {
await request.allHeaders();
+ ++counter;
});
page.on('response', async response => {
await response.text();
+ ++counter;
});
await page.goto(server.EMPTY_PAGE);
+ await expect.poll(() => counter).toBe(2);
});
await expect(traceViewer.actionTitles).toHaveText([
@@ -1946,3 +1955,31 @@ test('should load trace from HTTP with progress indicator', async ({ showTraceVi
await expect(dialog).not.toBeVisible();
await expect(traceViewer.actionTitles).toContainText([/Create page/]);
});
+
+test('should show all actions', async ({ runAndTrace, page }) => {
+ const traceViewer = await runAndTrace(async () => {
+ await page.route('**/*', async route => {
+ await route.fulfill({ contentType: 'text/html', body: '<input type=checkbox checked>' });
+ });
+ await page.goto('https://does.not.exist');
+ await page.locator('input').getAttribute('checked');
+ await expect(page.locator('input')).toBeChecked();
+ });
+
+ await expect(traceViewer.actionTitles).toHaveText([
+ /Navigate to/,
+ /Expect "toBeChecked"/,
+ ]);
+
+ await traceViewer.showSettings();
+ await expect(traceViewer.showAllActionsSetting).not.toBeChecked();
+ await traceViewer.showAllActionsSetting.click();
+
+ await expect(traceViewer.actionTitles).toHaveText([
+ /Route requests/,
+ /Navigate to/,
+ /Fulfill request/,
+ /Get attribute "checked"/,
+ /Expect "toBeChecked"/,
+ ]);
+});
diff --git a/tests/library/tracing.spec.ts b/tests/library/tracing.spec.ts
index 6a81df0c62..b65fa3db1d 100644
--- a/tests/library/tracing.spec.ts
+++ b/tests/library/tracing.spec.ts
@@ -85,7 +85,9 @@ test('should use the correct title for event driven callbacks', async ({ context
const { events, actions } = await parseTraceRaw(testInfo.outputPath('trace.zip'));
expect(events[0].type).toBe('context-options');
expect(actions).toEqual([
+ 'Route requests',
'Navigate to "/empty.html"',
+ 'Continue request',
'Navigate to "/grid.html"',
'Evaluate',
'Reload',
diff --git a/tests/playwright-test/playwright.trace.spec.ts b/tests/playwright-test/playwright.trace.spec.ts
index 6ea56bb378..cf694c244c 100644
--- a/tests/playwright-test/playwright.trace.spec.ts
+++ b/tests/playwright-test/playwright.trace.spec.ts
@@ -1018,7 +1018,6 @@ test('should not produce an action entry for calling a binding', async ({ runInl
' Create context',
' Fixture "page"',
' Create page',
- 'Expose binding',
'Evaluate',
'Expect "toBe"',
'Expect "toBe"',
diff --git a/tests/playwright-test/test-step.spec.ts b/tests/playwright-test/test-step.spec.ts
index 3949bf1527..355e68ee64 100644
--- a/tests/playwright-test/test-step.spec.ts
+++ b/tests/playwright-test/test-step.spec.ts
@@ -1716,7 +1716,7 @@ test('show api calls inside expects', async ({ runInlineTest }) => {
const expect = baseExpect.extend({
async toBeInvisible(locator: Locator) {
try {
- await expect.poll(() => locator.isVisible()).toBe(false);
+ await expect.poll(() => locator.filter({ visible: true }).count()).toBe(0);
return { name: 'toBeInvisible', pass: true, message: '' };
} catch (e) {
return { name: 'toBeInvisible', pass: false, message: () => 'Expected to be invisible, got visible!' };
@@ -1747,19 +1747,19 @@ pw:api | Create page
pw:api |Set content @ a.test.ts:16
expect |toBeInvisible @ a.test.ts:17
test.step | Expect "poll toBe" @ a.test.ts:7
-pw:api | Is visible locator('div') @ a.test.ts:7
+pw:api | Query count locator('div').filter({ visible: true }) @ a.test.ts:7
expect | toBe @ a.test.ts:7
expect | ↪ error: Error: expect(received).toBe(expected) // Object.is equality
-pw:api | Is visible locator('div') @ a.test.ts:7
+pw:api | Query count locator('div').filter({ visible: true }) @ a.test.ts:7
expect | toBe @ a.test.ts:7
expect | ↪ error: Error: expect(received).toBe(expected) // Object.is equality
-pw:api | Is visible locator('div') @ a.test.ts:7
+pw:api | Query count locator('div').filter({ visible: true }) @ a.test.ts:7
expect | toBe @ a.test.ts:7
expect | ↪ error: Error: expect(received).toBe(expected) // Object.is equality
-pw:api | Is visible locator('div') @ a.test.ts:7
+pw:api | Query count locator('div').filter({ visible: true }) @ a.test.ts:7
expect | toBe @ a.test.ts:7
expect | ↪ error: Error: expect(received).toBe(expected) // Object.is equality
-pw:api | Is visible locator('div') @ a.test.ts:7
+pw:api | Query count locator('div').filter({ visible: true }) @ a.test.ts:7
expect | toBe @ a.test.ts:7
pw:api |Wait for timeout @ a.test.ts:18
pw:api |Set content @ a.test.ts:19
diff --git a/utils/generate_channels.js b/utils/generate_channels.js
index 77ae55d234..c5c81ed26a 100755
--- a/utils/generate_channels.js
+++ b/utils/generate_channels.js
@@ -284,12 +284,25 @@ for (const [name, item] of Object.entries(protocol)) {
for (const className of [name, ...(derivedClasses.get(name) || [])]) {
+ if (method.flags?.slowMo && method.internal)
+ throw new Error(`Method "${className}.${methodName}" has "slowMo" flag, so cannot be "internal" in protocol.yml`);
+ if (method.flags?.snapshot && method.internal)
+ throw new Error(`Method "${className}.${methodName}" has "snapshot" flag, so cannot be "internal" in protocol.yml`);
+ if (method.flags?.pausesBeforeInput && method.internal)
+ throw new Error(`Method "${className}.${methodName}" has "pausesBeforeInput" flag, so cannot be "internal" in protocol.yml`);
+ if (!method.title && !method.internal)
+ throw new Error(`Method "${className}.${methodName}" must have a "title" because it is not "internal" in protocol.yml`);
+ if (method.group && method.internal)
+ throw new Error(`Method "${className}.${methodName}" must should not specify "group" because it is "internal" in protocol.yml`);
+ if (method.group && !['getter', 'configuration', 'route', 'default'].includes(method.group))
+ throw new Error(`Unknown group "${method.group}" for method "${className}.${methodName}" in protocol.yml`);
const internalProp = method.internal ? ` internal: ${method.internal},` : '';
const titleProp = method.title ? ` title: '${method.title}',` : '';
+ const groupProp = method.group ? ` group: '${method.group}',` : '';
const slowMoProp = method.flags?.slowMo ? ` slowMo: ${method.flags.slowMo},` : '';
const snapshotProp = method.flags?.snapshot ? ` snapshot: ${method.flags.snapshot},` : '';
const pauseProp = method.flags?.pausesBeforeInput ? ` pausesBeforeInput: ${method.flags.pausesBeforeInput},` : '';
- methodMetainfo.push(`['${className + '.' + methodName}', {${internalProp}${titleProp}${slowMoProp}${snapshotProp}${pauseProp} }]`);
+ methodMetainfo.push(`['${className + '.' + methodName}', {${internalProp}${titleProp}${slowMoProp}${snapshotProp}${pauseProp}${groupProp} }]`);
}
const parameters = objectType(method.parameters || {}, '');
@@ -333,7 +346,7 @@ 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 }>([
+metainfo_ts.push(`export const methodMetainfo = new Map<string, { internal?: boolean, title?: string, slowMo?: boolean, snapshot?: boolean, pausesBeforeInput?: boolean, group?: string }>([
${methodMetainfo.join(`,\n `)}
]);`);