Skip to content

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

chore(firefox): switch to ffmpeg for video encoding (#38539)

Yury Semikhatskye14ebec0cda8
diff --git a/packages/playwright-core/browsers.json b/packages/playwright-core/browsers.json
index 38797a89a4..bdb14456a3 100644
--- a/packages/playwright-core/browsers.json
+++ b/packages/playwright-core/browsers.json
@@ -31,14 +31,14 @@
},
{
"name": "firefox",
- "revision": "1504",
+ "revision": "1507",
"installByDefault": true,
"browserVersion": "145.0.2",
"title": "Firefox"
},
{
"name": "firefox-beta",
- "revision": "1499",
+ "revision": "1502",
"installByDefault": false,
"browserVersion": "146.0b8",
"title": "Firefox Beta"
diff --git a/packages/playwright-core/src/server/chromium/crPage.ts b/packages/playwright-core/src/server/chromium/crPage.ts
index ce74f66027..2cb3df9678 100644
--- a/packages/playwright-core/src/server/chromium/crPage.ts
+++ b/packages/playwright-core/src/server/chromium/crPage.ts
@@ -877,7 +877,7 @@ class FrameSession {
_onScreencastFrame(payload: Protocol.Page.screencastFramePayload) {
this._page.screencast.throttleFrameAck(() => {
- this._client.send('Page.screencastFrameAck', { sessionId: payload.sessionId }).catch(() => {});
+ this._client._sendMayFail('Page.screencastFrameAck', { sessionId: payload.sessionId });
});
const buffer = Buffer.from(payload.data, 'base64');
this._page.emit(Page.Events.ScreencastFrame, {
diff --git a/packages/playwright-core/src/server/firefox/ffBrowser.ts b/packages/playwright-core/src/server/firefox/ffBrowser.ts
index 1738295ce8..b734c48100 100644
--- a/packages/playwright-core/src/server/firefox/ffBrowser.ts
+++ b/packages/playwright-core/src/server/firefox/ffBrowser.ts
@@ -78,7 +78,6 @@ export class FFBrowser extends Browser {
this.session.on('Browser.detachedFromTarget', this._onDetachedFromTarget.bind(this));
this.session.on('Browser.downloadCreated', this._onDownloadCreated.bind(this));
this.session.on('Browser.downloadFinished', this._onDownloadFinished.bind(this));
- this.session.on('Browser.videoRecordingFinished', this._onVideoRecordingFinished.bind(this));
}
async _initVersion() {
@@ -157,10 +156,6 @@ export class FFBrowser extends Browser {
this._downloadFinished(payload.uuid, error);
}
- _onVideoRecordingFinished(payload: Protocol.Browser.videoRecordingFinishedPayload) {
- this._takeVideo(payload.screencastId)?.reportFinished();
- }
-
_onDisconnect() {
for (const video of this._idToVideo.values())
video.artifact.reportFinished(new TargetClosedError(this.closeReason()));
@@ -220,15 +215,13 @@ export class FFBrowserContext extends BrowserContext {
promises.push(this.doUpdateOffline());
promises.push(this.doUpdateDefaultEmulatedMedia());
if (this._options.recordVideo) {
- promises.push(this._ensureVideosPath().then(() => {
- return this._browser.session.send('Browser.setVideoRecordingOptions', {
- // validateBrowserContextOptions ensures correct video size.
- options: {
- ...this._options.recordVideo!.size!,
- dir: this._options.recordVideo!.dir,
- },
- browserContextId: this._browserContextId
- });
+ promises.push(this._browser.session.send('Browser.setScreencastOptions', {
+ // validateBrowserContextOptions ensures correct video size.
+ options: {
+ ...this._options.recordVideo!.size!,
+ quality: 90,
+ },
+ browserContextId: this._browserContextId
}));
}
const proxy = this._options.proxyOverride || this._options.proxy;
@@ -424,12 +417,8 @@ export class FFBrowserContext extends BrowserContext {
async doClose(reason: string | undefined) {
if (!this._browserContextId) {
- if (this._options.recordVideo) {
- await this._browser.session.send('Browser.setVideoRecordingOptions', {
- options: undefined,
- browserContextId: this._browserContextId
- });
- }
+ if (this._options.recordVideo)
+ await Promise.all(this._ffPages().map(ffPage => ffPage._page.screencast.stopVideoRecording()));
// Closing persistent context should close the browser.
await this._browser.close({ reason });
} else {
diff --git a/packages/playwright-core/src/server/firefox/ffPage.ts b/packages/playwright-core/src/server/firefox/ffPage.ts
index e4bd6a407f..c6f478016c 100644
--- a/packages/playwright-core/src/server/firefox/ffPage.ts
+++ b/packages/playwright-core/src/server/firefox/ffPage.ts
@@ -24,9 +24,9 @@ import { FFSession } from './ffConnection';
import { createHandle, FFExecutionContext } from './ffExecutionContext';
import { RawKeyboardImpl, RawMouseImpl, RawTouchscreenImpl } from './ffInput';
import { FFNetworkManager } from './ffNetworkManager';
-import { debugLogger } from '../utils/debugLogger';
import { splitErrorMessage } from '../../utils/isomorphic/stackTrace';
import { TargetClosedError } from '../errors';
+import { debugLogger } from '../utils/debugLogger';
import type { Progress } from '../progress';
import type { FFBrowserContext } from './ffBrowser';
@@ -89,7 +89,6 @@ export class FFPage implements PageDelegate {
eventsHelper.addEventListener(this._session, 'Page.workerDestroyed', this._onWorkerDestroyed.bind(this)),
eventsHelper.addEventListener(this._session, 'Page.dispatchMessageFromWorker', this._onDispatchMessageFromWorker.bind(this)),
eventsHelper.addEventListener(this._session, 'Page.crashed', this._onCrashed.bind(this)),
- eventsHelper.addEventListener(this._session, 'Page.videoRecordingStarted', this._onVideoRecordingStarted.bind(this)),
eventsHelper.addEventListener(this._session, 'Page.webSocketCreated', this._onWebSocketCreated.bind(this)),
eventsHelper.addEventListener(this._session, 'Page.webSocketClosed', this._onWebSocketClosed.bind(this)),
@@ -98,6 +97,12 @@ export class FFPage implements PageDelegate {
eventsHelper.addEventListener(this._session, 'Page.screencastFrame', this._onScreencastFrame.bind(this)),
];
+
+ const screencast = this._page.screencast;
+ const videoOptions = screencast.launchVideoRecorder();
+ if (videoOptions)
+ screencast.startVideoRecording(videoOptions).catch(e => debugLogger.log('error', e));
+
this._session.once('Page.ready', () => {
if (this._reportedAsNew)
return;
@@ -311,9 +316,6 @@ export class FFPage implements PageDelegate {
this._page._didCrash();
}
- _onVideoRecordingStarted(event: Protocol.Page.videoRecordingStartedPayload) {
- this._browserContext._browser._videoStarted(this._browserContext, event.screencastId, event.file, this._page.waitForInitializedOrError());
- }
didClose() {
this._markAsError(new TargetClosedError(this._page.closeReason()));
@@ -479,20 +481,16 @@ export class FFPage implements PageDelegate {
}
async startScreencast(options: { width: number, height: number, quality: number }): Promise<void> {
- const { screencastId } = await this._session.send('Page.startScreencast', options);
- this._screencastId = screencastId;
+ await this._session.send('Page.startScreencast', options);
}
async stopScreencast(): Promise<void> {
- await this._session.send('Page.stopScreencast');
+ await this._session.sendMayFail('Page.stopScreencast');
}
private _onScreencastFrame(event: Protocol.Page.screencastFramePayload) {
- if (!this._screencastId)
- return;
- const screencastId = this._screencastId;
this._page.screencast.throttleFrameAck(() => {
- this._session.send('Page.screencastFrameAck', { screencastId }).catch(e => debugLogger.log('error', e));
+ this._session.sendMayFail('Page.screencastFrameAck');
});
const buffer = Buffer.from(event.data, 'base64');
diff --git a/packages/playwright-core/src/server/firefox/protocol.d.ts b/packages/playwright-core/src/server/firefox/protocol.d.ts
index 1b0d25a2bf..d559c15874 100644
--- a/packages/playwright-core/src/server/firefox/protocol.d.ts
+++ b/packages/playwright-core/src/server/firefox/protocol.d.ts
@@ -70,9 +70,6 @@ export namespace Protocol {
canceled?: boolean;
error?: string;
}
- export type videoRecordingFinishedPayload = {
- screencastId: string;
- }
export type enableParameters = {
attachToDefaultContext: boolean;
userPrefs?: {
@@ -306,15 +303,15 @@ export namespace Protocol {
contrast: ("less"|"more"|"custom"|"no-preference")|null;
};
export type setContrastReturnValue = void;
- export type setVideoRecordingOptionsParameters = {
+ export type setScreencastOptionsParameters = {
browserContextId?: string;
options?: {
- dir: string;
width: number;
height: number;
+ quality: number;
};
};
- export type setVideoRecordingOptionsReturnValue = void;
+ export type setScreencastOptionsReturnValue = void;
export type cancelDownloadParameters = {
uuid?: string;
};
@@ -463,10 +460,6 @@ export namespace Protocol {
workerId: string;
message: string;
}
- export type videoRecordingStartedPayload = {
- screencastId: string;
- file: string;
- }
export type webSocketCreatedPayload = {
frameId: string;
wsid: string;
@@ -589,8 +582,7 @@ export namespace Protocol {
export type goForwardReturnValue = {
success: boolean;
};
- export type reloadParameters = {
- };
+ export type reloadParameters = void;
export type reloadReturnValue = void;
export type adoptNodeParameters = {
frameId: string;
@@ -698,8 +690,7 @@ export namespace Protocol {
text: string;
};
export type insertTextReturnValue = void;
- export type crashParameters = {
- };
+ export type crashParameters = void;
export type crashReturnValue = void;
export type handleDialogParameters = {
dialogId: string;
@@ -722,12 +713,8 @@ export namespace Protocol {
height: number;
quality: number;
};
- export type startScreencastReturnValue = {
- screencastId: string;
- };
- export type screencastFrameAckParameters = {
- screencastId: string;
- };
+ export type startScreencastReturnValue = void;
+ export type screencastFrameAckParameters = void;
export type screencastFrameAckReturnValue = void;
export type stopScreencastParameters = void;
export type stopScreencastReturnValue = void;
@@ -997,7 +984,6 @@ export namespace Protocol {
["Browser.detachedFromTarget"]: [Browser.detachedFromTargetPayload];
["Browser.downloadCreated"]: [Browser.downloadCreatedPayload];
["Browser.downloadFinished"]: [Browser.downloadFinishedPayload];
- ["Browser.videoRecordingFinished"]: [Browser.videoRecordingFinishedPayload];
["Page.ready"]: [Page.readyPayload];
["Page.crashed"]: [Page.crashedPayload];
["Page.eventFired"]: [Page.eventFiredPayload];
@@ -1017,7 +1003,6 @@ export namespace Protocol {
["Page.workerCreated"]: [Page.workerCreatedPayload];
["Page.workerDestroyed"]: [Page.workerDestroyedPayload];
["Page.dispatchMessageFromWorker"]: [Page.dispatchMessageFromWorkerPayload];
- ["Page.videoRecordingStarted"]: [Page.videoRecordingStartedPayload];
["Page.webSocketCreated"]: [Page.webSocketCreatedPayload];
["Page.webSocketOpened"]: [Page.webSocketOpenedPayload];
["Page.webSocketClosed"]: [Page.webSocketClosedPayload];
@@ -1070,7 +1055,7 @@ export namespace Protocol {
"Browser.setReducedMotion": Browser.setReducedMotionParameters;
"Browser.setForcedColors": Browser.setForcedColorsParameters;
"Browser.setContrast": Browser.setContrastParameters;
- "Browser.setVideoRecordingOptions": Browser.setVideoRecordingOptionsParameters;
+ "Browser.setScreencastOptions": Browser.setScreencastOptionsParameters;
"Browser.cancelDownload": Browser.cancelDownloadParameters;
"Heap.collectGarbage": Heap.collectGarbageParameters;
"Page.close": Page.closeParameters;
@@ -1152,7 +1137,7 @@ export namespace Protocol {
"Browser.setReducedMotion": Browser.setReducedMotionReturnValue;
"Browser.setForcedColors": Browser.setForcedColorsReturnValue;
"Browser.setContrast": Browser.setContrastReturnValue;
- "Browser.setVideoRecordingOptions": Browser.setVideoRecordingOptionsReturnValue;
+ "Browser.setScreencastOptions": Browser.setScreencastOptionsReturnValue;
"Browser.cancelDownload": Browser.cancelDownloadReturnValue;
"Heap.collectGarbage": Heap.collectGarbageReturnValue;
"Page.close": Page.closeReturnValue;
diff --git a/packages/playwright-core/src/server/webkit/wkPage.ts b/packages/playwright-core/src/server/webkit/wkPage.ts
index 9d6b9d69d3..23505467c5 100644
--- a/packages/playwright-core/src/server/webkit/wkPage.ts
+++ b/packages/playwright-core/src/server/webkit/wkPage.ts
@@ -33,7 +33,6 @@ import { RawKeyboardImpl, RawMouseImpl, RawTouchscreenImpl } from './wkInput';
import { WKInterceptableRequest, WKRouteImpl } from './wkInterceptableRequest';
import { WKProvisionalPage } from './wkProvisionalPage';
import { WKWorkers } from './wkWorkers';
-import { debugLogger } from '../utils/debugLogger';
import { translatePathToWSL } from './webkit';
import type { Protocol } from './protocol';
@@ -918,7 +917,7 @@ export class WKPage implements PageDelegate {
private _onScreencastFrame(event: Protocol.Screencast.screencastFramePayload) {
const generation = this._screencastGeneration;
this._page.screencast.throttleFrameAck(() => {
- this._pageProxySession.send('Screencast.screencastFrameAck', { generation }).catch(e => debugLogger.log('error', e));
+ this._pageProxySession.sendMayFail('Screencast.screencastFrameAck', { generation });
});
const buffer = Buffer.from(event.data, 'base64');
this._page.emit(Page.Events.ScreencastFrame, {