Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
feat(screencast): expose frame presentation timestamp on onFrame (#41162)
Simon Knottdcbe13111acf
diff --git a/docs/src/api/class-screencast.md b/docs/src/api/class-screencast.mdindex 12e3111ffe..e304733239 100644--- a/docs/src/api/class-screencast.md+++ b/docs/src/api/class-screencast.md@@ -22,8 +22,8 @@ await page.screencast.stop();```js// Capture framesawait page.screencast.start({- onFrame: ({ data, viewportWidth, viewportHeight }) => {- console.log(`frame size: ${data.length} (${viewportWidth}x${viewportHeight})`);+ onFrame: ({ data, timestamp, viewportWidth, viewportHeight }) => {+ console.log(`frame size: ${data.length} (${viewportWidth}x${viewportHeight}) at ${timestamp}`);},size: { width: 800, height: 600 },});@@ -36,6 +36,7 @@ await page.screencast.stop();- `onFrame` <[function]\([Object]\): [Promise]>* alias: ScreencastFrame- `data` <[Buffer]> JPEG-encoded frame data.+ - `timestamp` <[float]> The timestamp of when the frame was presented by the browser, in milliseconds since the Unix epoch.- `viewportWidth` <[int]> Width of the page viewport at the time the frame was captured.- `viewportHeight` <[int]> Height of the page viewport at the time the frame was captured.diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.tsindex d9902ca089..c80d5655a3 100644--- a/packages/playwright-client/types/types.d.ts+++ b/packages/playwright-client/types/types.d.ts@@ -16706,8 +16706,8 @@ export interface Screencast {* ```js* // Capture frames* await page.screencast.start({- * onFrame: ({ data, viewportWidth, viewportHeight }) => {- * console.log(`frame size: ${data.length} (${viewportWidth}x${viewportHeight})`);+ * onFrame: ({ data, timestamp, viewportWidth, viewportHeight }) => {+ * console.log(`frame size: ${data.length} (${viewportWidth}x${viewportHeight}) at ${timestamp}`);* },* size: { width: 800, height: 600 },* });@@ -16718,7 +16718,7 @@ export interface Screencast {* @param options*/start(options?: {- onFrame?: (frame: { data: Buffer, viewportWidth: number, viewportHeight: number }) => Promise<any>|any;+ onFrame?: (frame: { data: Buffer, timestamp: number, viewportWidth: number, viewportHeight: number }) => Promise<any>|any;path?: string;size?: {width: number;diff --git a/packages/playwright-core/src/client/screencast.ts b/packages/playwright-core/src/client/screencast.tsindex c9cdf535bf..de6f463311 100644--- a/packages/playwright-core/src/client/screencast.ts+++ b/packages/playwright-core/src/client/screencast.ts@@ -24,17 +24,17 @@ export class Screencast implements api.Screencast {private _page: Page;private _started = false;private _savePath: string | undefined;- private _onFrame: ((frame: { data: Buffer, viewportWidth: number, viewportHeight: number }) => Promise<any>) | null = null;+ private _onFrame: ((frame: { data: Buffer, timestamp: number, viewportWidth: number, viewportHeight: number }) => Promise<any>) | null = null;private _artifact: Artifact | undefined;constructor(page: Page) {this._page = page;- this._page._channel.on('screencastFrame', ({ data, viewportWidth, viewportHeight }) => {- void this._onFrame?.({ data, viewportWidth, viewportHeight });+ this._page._channel.on('screencastFrame', ({ data, timestamp, viewportWidth, viewportHeight }) => {+ void this._onFrame?.({ data, timestamp, viewportWidth, viewportHeight });});}- async start(options: { onFrame?: (frame: { data: Buffer, viewportWidth: number, viewportHeight: number }) => Promise<any>|any, path?: string, size?: { width: number, height: number }, quality?: number } = {}): Promise<DisposableStub> {+ async start(options: { onFrame?: (frame: { data: Buffer, timestamp: number, viewportWidth: number, viewportHeight: number }) => Promise<any>|any, path?: string, size?: { width: number, height: number }, quality?: number } = {}): Promise<DisposableStub> {if (this._started)throw new Error('Screencast is already started');this._started = true;diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.tsindex bbdc20aebf..75600eabe1 100644--- a/packages/playwright-core/src/protocol/validator.ts+++ b/packages/playwright-core/src/protocol/validator.ts@@ -2299,6 +2299,7 @@ scheme.PageRouteEvent = tObject({});scheme.PageScreencastFrameEvent = tObject({data: tBinary,+ timestamp: tFloat,viewportWidth: tInt,viewportHeight: tInt,});diff --git a/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts b/packages/playwright-core/src/server/dispatchers/pageDispatcher.tsindex 45eee1bbba..7fc4d2231e 100644--- a/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts+++ b/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts@@ -398,7 +398,7 @@ export class PageDispatcher extends Dispatcher<Page, channels.PageChannel, Browsif (params.sendFrames) {this._screencastClient = {onFrame: (frame: ScreencastFrame) => {- this._dispatchEvent('screencastFrame', { data: frame.buffer, viewportWidth: frame.viewportWidth, viewportHeight: frame.viewportHeight });+ this._dispatchEvent('screencastFrame', { data: frame.buffer, timestamp: frame.frameSwapWallTime, viewportWidth: frame.viewportWidth, viewportHeight: frame.viewportHeight });},dispose: () => {},size: params.size,diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.tsindex d9902ca089..c80d5655a3 100644--- a/packages/playwright-core/types/types.d.ts+++ b/packages/playwright-core/types/types.d.ts@@ -16706,8 +16706,8 @@ export interface Screencast {* ```js* // Capture frames* await page.screencast.start({- * onFrame: ({ data, viewportWidth, viewportHeight }) => {- * console.log(`frame size: ${data.length} (${viewportWidth}x${viewportHeight})`);+ * onFrame: ({ data, timestamp, viewportWidth, viewportHeight }) => {+ * console.log(`frame size: ${data.length} (${viewportWidth}x${viewportHeight}) at ${timestamp}`);* },* size: { width: 800, height: 600 },* });@@ -16718,7 +16718,7 @@ export interface Screencast {* @param options*/start(options?: {- onFrame?: (frame: { data: Buffer, viewportWidth: number, viewportHeight: number }) => Promise<any>|any;+ onFrame?: (frame: { data: Buffer, timestamp: number, viewportWidth: number, viewportHeight: number }) => Promise<any>|any;path?: string;size?: {width: number;diff --git a/packages/protocol/spec/page.yml b/packages/protocol/spec/page.ymlindex 73a3adc218..900dc11b57 100644--- a/packages/protocol/spec/page.yml+++ b/packages/protocol/spec/page.yml@@ -718,6 +718,7 @@ Page:screencastFrame:parameters:data: binary+ timestamp: floatviewportWidth: intviewportHeight: intdiff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.tsindex 09fb8655f9..c97f2e689d 100644--- a/packages/protocol/src/channels.d.ts+++ b/packages/protocol/src/channels.d.ts@@ -4140,6 +4140,7 @@ export type PageRouteEvent = {};export type PageScreencastFrameEvent = {data: Binary,+ timestamp: number,viewportWidth: number,viewportHeight: number,};diff --git a/tests/library/screencast.spec.ts b/tests/library/screencast.spec.tsindex 867766fb2d..468880b61e 100644--- a/tests/library/screencast.spec.ts+++ b/tests/library/screencast.spec.ts@@ -57,9 +57,9 @@ test('onFrame receives viewport size', async ({ browser, server, trace }) => {const context = await browser.newContext({ viewport: { width: 1000, height: 400 } });const page = await context.newPage();- const frames: { viewportWidth: number, viewportHeight: number }[] = [];+ const frames: { timestamp: number, viewportWidth: number, viewportHeight: number }[] = [];await page.screencast.start({- onFrame: ({ viewportWidth, viewportHeight }) => frames.push({ viewportWidth, viewportHeight }),+ onFrame: ({ timestamp, viewportWidth, viewportHeight }) => frames.push({ timestamp, viewportWidth, viewportHeight }),size: { width: 500, height: 400 },});await page.goto(server.EMPTY_PAGE);@@ -70,6 +70,7 @@ test('onFrame receives viewport size', async ({ browser, server, trace }) => {for (const frame of frames) {expect(frame.viewportWidth).toBe(1000);expect(frame.viewportHeight).toBe(400);+ expect(typeof frame.timestamp).toBe('number');}await context.close();diff --git a/utils/generate_types/overrides.d.ts b/utils/generate_types/overrides.d.tsindex 89ef7bd94f..4bdde3cd94 100644--- a/utils/generate_types/overrides.d.ts+++ b/utils/generate_types/overrides.d.ts@@ -255,7 +255,7 @@ export interface WebSocketRoute {export interface Screencast {start(options?: {- onFrame?: (frame: { data: Buffer, viewportWidth: number, viewportHeight: number }) => Promise<any>|any;+ onFrame?: (frame: { data: Buffer, timestamp: number, viewportWidth: number, viewportHeight: number }) => Promise<any>|any;path?: string;size?: {width: number;