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
chore(cli): hint to install ffmpeg (#39019)
Pavel Feldmanafbc025c34d3
diff --git a/packages/playwright-core/src/client/video.ts b/packages/playwright-core/src/client/video.tsindex ad3f767c4a..6a022647c6 100644--- a/packages/playwright-core/src/client/video.ts+++ b/packages/playwright-core/src/client/video.ts@@ -26,6 +26,7 @@ export class Video implements api.Video {private _artifactReadyPromise: ManualPromise<Artifact>;private _isRemote = false;private _page: Page;+ private _path: string | undefined;constructor(page: Page, connection: Connection) {this._page = page;@@ -39,7 +40,8 @@ export class Video implements api.Video {}async start(options: { size?: { width: number, height: number } } = {}): Promise<void> {- await this._page._channel.videoStart(options);+ const result = await this._page._channel.videoStart(options);+ this._path = result.path;this._artifactReadyPromise = new ManualPromise<Artifact>();this._artifact = this._page._closedOrCrashedScope.safeRace(this._artifactReadyPromise);}@@ -55,6 +57,9 @@ export class Video implements api.Video {async path(): Promise<string> {if (this._isRemote)throw new Error(`Path is not available when connecting remotely. Use saveAs() to save a local copy.`);+ if (this._path)+ return this._path;+const artifact = await this._artifact;if (!artifact)throw new Error('Page did not produce any video frames');diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.tsindex a0f2bee782..3ce0a40bbf 100644--- a/packages/playwright-core/src/protocol/validator.ts+++ b/packages/playwright-core/src/protocol/validator.ts@@ -1495,7 +1495,9 @@ scheme.PageVideoStartParams = tObject({height: tInt,})),});-scheme.PageVideoStartResult = tOptional(tObject({}));+scheme.PageVideoStartResult = tObject({+ path: tString,+});scheme.PageVideoStopParams = tOptional(tObject({}));scheme.PageVideoStopResult = tOptional(tObject({}));scheme.PageUpdateSubscriptionParams = tObject({diff --git a/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts b/packages/playwright-core/src/server/dispatchers/pageDispatcher.tsindex 2979fb061b..6eef750677 100644--- a/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts+++ b/packages/playwright-core/src/server/dispatchers/pageDispatcher.ts@@ -337,12 +337,12 @@ export class PageDispatcher extends Dispatcher<Page, channels.PageChannel, Browsawait progress.race(this._page.bringToFront());}- async videoStart(params: channels.PageVideoStartParams, progress: Progress): Promise<void> {- await this._page.screencast.startExplicitVideoRecording(params);+ async videoStart(params: channels.PageVideoStartParams, progress: Progress): Promise<channels.PageVideoStartResult> {+ return await this._page.screencast.startExplicitVideoRecording(params);}async videoStop(params: channels.PageVideoStopParams, progress: Progress): Promise<channels.PageVideoStopResult> {- await this._page.screencast.stopVideoRecording();+ await this._page.screencast.stopExplicitVideoRecording();}async startJSCoverage(params: channels.PageStartJSCoverageParams, progress: Progress): Promise<void> {diff --git a/packages/playwright-core/src/server/registry/index.ts b/packages/playwright-core/src/server/registry/index.tsindex 0024a9eede..7a62ea36d4 100644--- a/packages/playwright-core/src/server/registry/index.ts+++ b/packages/playwright-core/src/server/registry/index.ts@@ -589,21 +589,37 @@ export class Registry {const currentDockerVersion = readDockerVersionSync();const preferredDockerVersion = currentDockerVersion ? dockerVersion(currentDockerVersion.dockerImageNameTemplate) : null;const isOutdatedDockerImage = currentDockerVersion && preferredDockerVersion && currentDockerVersion.dockerImageName !== preferredDockerVersion.dockerImageName;- const prettyMessage = isOutdatedDockerImage ? [- `Looks like ${sdkLanguage === 'javascript' ? 'Playwright Test or ' : ''}Playwright was just updated to ${preferredDockerVersion.driverVersion}.`,- `Please update docker image as well.`,- `- current: ${currentDockerVersion.dockerImageName}`,- `- required: ${preferredDockerVersion.dockerImageName}`,- ``,- `<3 Playwright Team`,- ].join('\n') : [- `Looks like ${sdkLanguage === 'javascript' ? 'Playwright Test or ' : ''}Playwright was just installed or updated.`,- `Please run the following command to download new browser${installByDefault ? 's' : ''}:`,- ``,- ` ${installCommand}`,- ``,- `<3 Playwright Team`,- ].join('\n');+ const isFfmpeg = name === 'ffmpeg';+ let prettyMessage;+ if (isOutdatedDockerImage) {+ prettyMessage = [+ `Looks like Playwright was just updated to ${preferredDockerVersion.driverVersion}.`,+ `Please update docker image as well.`,+ `- current: ${currentDockerVersion.dockerImageName}`,+ `- required: ${preferredDockerVersion.dockerImageName}`,+ ``,+ `<3 Playwright Team`,+ ].join('\n');+ } else if (isFfmpeg) {+ prettyMessage = [+ `Video rendering requires ffmpeg binary.`,+ `Downloading it will not affect any of the system-wide settings.`,+ `Please run the following command:`,+ ``,+ ` ${buildPlaywrightCLICommand(sdkLanguage, 'install ffmpeg')}`,+ ``,+ `<3 Playwright Team`,+ ].join('\n');+ } else {+ prettyMessage = [+ `Looks like Playwright was just installed or updated.`,+ `Please run the following command to download new browser${installByDefault ? 's' : ''}:`,+ ``,+ ` ${installCommand}`,+ ``,+ `<3 Playwright Team`,+ ].join('\n');+ }throw new Error(`Executable doesn't exist at ${e}\n${wrapInASCIIBox(prettyMessage, 1)}`);}return e;diff --git a/packages/playwright-core/src/server/screencast.ts b/packages/playwright-core/src/server/screencast.tsindex b8c1a803bf..a51996c14d 100644--- a/packages/playwright-core/src/server/screencast.ts+++ b/packages/playwright-core/src/server/screencast.ts@@ -69,13 +69,16 @@ export class Screencast {private _launchVideoRecorder(dir: string, size: { width: number, height: number }): types.VideoOptions {assert(!this._videoId);+ // Do this first, it likes to throw.+ const ffmpegPath = registry.findExecutable('ffmpeg')!.executablePathOrDie(this._page.browserContext._browser.sdkLanguage());+this._videoId = createGuid();const outputFile = path.join(dir, this._videoId + '.webm');const videoOptions = {...size,outputFile,};- const ffmpegPath = registry.findExecutable('ffmpeg')!.executablePathOrDie(this._page.browserContext._browser.sdkLanguage());+this._videoRecorder = new VideoRecorder(ffmpegPath, videoOptions);this._frameListener = eventsHelper.addEventListener(this._page, Page.Events.ScreencastFrame, frame => this._videoRecorder!.writeFrame(frame.buffer, frame.frameSwapWallTime / 1000));this._page.waitForInitializedOrError().then(p => {@@ -125,6 +128,13 @@ export class Screencast {const size = validateVideoSize(options.size, this._page.emulatedSize()?.viewport);const videoOptions = this._launchVideoRecorder(this._page.browserContext._browser.options.artifactsDir, size);await this.startVideoRecording(videoOptions);+ return { path: videoOptions.outputFile };+ }++ async stopExplicitVideoRecording() {+ if (!this._videoId)+ throw new Error('Video is not being recorded');+ await this.stopVideoRecording();}private async _setOptions(options: { width: number, height: number, quality: number } | null): Promise<void> {diff --git a/packages/playwright/src/mcp/browser/tools/video.ts b/packages/playwright/src/mcp/browser/tools/video.tsindex defa36cdef..6474accdf6 100644--- a/packages/playwright/src/mcp/browser/tools/video.ts+++ b/packages/playwright/src/mcp/browser/tools/video.ts@@ -54,13 +54,13 @@ const stopVideo = defineTabTool({},handle: async (tab, params, response) => {- const tmpPath = await tab.page.video().path();let videoPath: string | undefined;if (params.filename) {const suggestedFilename = params.filename ?? dateAsFileName('video', 'webm');videoPath = await tab.context.outputFile(suggestedFilename, { origin: 'llm', title: 'Saving video' });}await tab.page.video().stop({ path: videoPath });+ const tmpPath = await tab.page.video().path();response.addTextResult(`Video recording stopped: ${videoPath ?? tmpPath}`);},});diff --git a/packages/playwright/src/mcp/terminal/program.ts b/packages/playwright/src/mcp/terminal/program.tsindex 71c17c7228..db033f67f0 100644--- a/packages/playwright/src/mcp/terminal/program.ts+++ b/packages/playwright/src/mcp/terminal/program.ts@@ -472,7 +472,7 @@ export async function program(options: { version: string }) {export async function printResponse(response: StructuredResponse) {const { sections } = response;if (!sections) {- console.log('### Error\n' + response.text);+ console.log(response.text);return;}diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.tsindex 406072af18..395a252733 100644--- a/packages/protocol/src/channels.d.ts+++ b/packages/protocol/src/channels.d.ts@@ -2602,7 +2602,9 @@ export type PageVideoStartOptions = {height: number,},};-export type PageVideoStartResult = void;+export type PageVideoStartResult = {+ path: string,+};export type PageVideoStopParams = {};export type PageVideoStopOptions = {};export type PageVideoStopResult = void;diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.ymlindex b202cd7d2a..67428bf8d4 100644--- a/packages/protocol/src/protocol.yml+++ b/packages/protocol/src/protocol.yml@@ -2023,6 +2023,8 @@ Page:properties:width: intheight: int+ returns:+ path: stringvideoStop:title: Stop video recordingdiff --git a/tests/library/video.spec.ts b/tests/library/video.spec.tsindex 4c87d78c5e..a260ba6ae4 100644--- a/tests/library/video.spec.ts+++ b/tests/library/video.spec.ts@@ -843,6 +843,8 @@ it.describe('screencast', () => {const page = await context.newPage();await page.video().start({ size });+ const tmpPath1 = await page.video().path();+ expect(tmpPath1).toBeDefined();await page.evaluate(() => document.body.style.backgroundColor = 'red');await rafraf(page, 100);const videoPath1 = testInfo.outputPath('video1.webm');@@ -850,6 +852,9 @@ it.describe('screencast', () => {expectRedFrames(videoPath1, size);await page.video().start({ size });+ const tmpPath2 = await page.video().path();+ expect(tmpPath2).toBeDefined();+ expect(tmpPath2).not.toEqual(tmpPath1);await page.evaluate(() => document.body.style.backgroundColor = 'rgb(100,100,100)');await rafraf(page, 100);const videoPath2 = testInfo.outputPath('video2.webm');