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(mcp): save video files to outputDir/videos (#38669)
Yury Semikhatsky91a21b472566
diff --git a/packages/playwright/src/mcp/browser/browserContextFactory.ts b/packages/playwright/src/mcp/browser/browserContextFactory.tsindex db84d10316..f751922c6d 100644--- a/packages/playwright/src/mcp/browser/browserContextFactory.ts+++ b/packages/playwright/src/mcp/browser/browserContextFactory.ts@@ -23,7 +23,7 @@ import * as playwright from 'playwright-core';import { registryDirectory } from 'playwright-core/lib/server/registry/index';import { startTraceViewerServer } from 'playwright-core/lib/server';import { logUnhandledError, testDebug } from '../log';-import { outputFile, tmpDir } from './config';+import { outputFile } from './config';import { firstRootPath } from '../sdk/server';import type { FullConfig } from './config';@@ -44,7 +44,7 @@ export function contextFactory(config: FullConfig): BrowserContextFactory {export type BrowserContextFactoryResult = {browserContext: playwright.BrowserContext;- close: (afterClose: () => Promise<void>) => Promise<void>;+ close: () => Promise<void>;};export interface BrowserContextFactory {@@ -94,24 +94,23 @@ class BaseContextFactory implements BrowserContextFactory {async createContext(clientInfo: ClientInfo): Promise<BrowserContextFactoryResult> {testDebug(`create browser context (${this._logName})`);const browser = await this._obtainBrowser(clientInfo);- const browserContext = await this._doCreateContext(browser);+ const browserContext = await this._doCreateContext(browser, clientInfo);await addInitScript(browserContext, this.config.browser.initScript);return {browserContext,- close: (afterClose: () => Promise<void>) => this._closeBrowserContext(browserContext, browser, afterClose)+ close: () => this._closeBrowserContext(browserContext, browser)};}- protected async _doCreateContext(browser: playwright.Browser): Promise<playwright.BrowserContext> {+ protected async _doCreateContext(browser: playwright.Browser, clientInfo: ClientInfo): Promise<playwright.BrowserContext> {throw new Error('Not implemented');}- private async _closeBrowserContext(browserContext: playwright.BrowserContext, browser: playwright.Browser, afterClose: () => Promise<void>) {+ private async _closeBrowserContext(browserContext: playwright.BrowserContext, browser: playwright.Browser) {testDebug(`close browser context (${this._logName})`);if (browser.contexts().length === 1)this._browserPromise = undefined;await browserContext.close().catch(logUnhandledError);- await afterClose();if (browser.contexts().length === 0) {testDebug(`close browser (${this._logName})`);await browser.close().catch(logUnhandledError);@@ -142,8 +141,8 @@ class IsolatedContextFactory extends BaseContextFactory {});}- protected override async _doCreateContext(browser: playwright.Browser): Promise<playwright.BrowserContext> {- return browser.newContext(browserContextOptionsFromConfig(this.config));+ protected override async _doCreateContext(browser: playwright.Browser, clientInfo: ClientInfo): Promise<playwright.BrowserContext> {+ return browser.newContext(await browserContextOptionsFromConfig(this.config, clientInfo));}}@@ -206,7 +205,7 @@ class PersistentContextFactory implements BrowserContextFactory {const launchOptions: LaunchOptions & BrowserContextOptions = {tracesDir,...this.config.browser.launchOptions,- ...browserContextOptionsFromConfig(this.config),+ ...await browserContextOptionsFromConfig(this.config, clientInfo),handleSIGINT: false,handleSIGTERM: false,ignoreDefaultArgs: [@@ -217,7 +216,7 @@ class PersistentContextFactory implements BrowserContextFactory {try {const browserContext = await browserType.launchPersistentContext(userDataDir, launchOptions);await addInitScript(browserContext, this.config.browser.initScript);- const close = (afterClose: () => Promise<void>) => this._closeBrowserContext(browserContext, userDataDir, afterClose);+ const close = () => this._closeBrowserContext(browserContext, userDataDir);return { browserContext, close };} catch (error: any) {if (error.message.includes('Executable doesn\'t exist'))@@ -233,11 +232,10 @@ class PersistentContextFactory implements BrowserContextFactory {throw new Error(`Browser is already in use for ${userDataDir}, use --isolated to run multiple instances of the same browser`);}- private async _closeBrowserContext(browserContext: playwright.BrowserContext, userDataDir: string, afterClose: () => Promise<void>) {+ private async _closeBrowserContext(browserContext: playwright.BrowserContext, userDataDir: string) {testDebug('close browser context (persistent)');testDebug('release user data dir', userDataDir);await browserContext.close().catch(() => {});- await afterClose();this._userDataDirs.delete(userDataDir);if (process.env.PWMCP_PROFILES_DIR_FOR_TEST && userDataDir.startsWith(process.env.PWMCP_PROFILES_DIR_FOR_TEST))await fs.promises.rm(userDataDir, { recursive: true }).catch(logUnhandledError);@@ -336,7 +334,7 @@ export class SharedContextFactory implements BrowserContextFactory {if (!contextPromise)return;const { close } = await contextPromise;- await close(async () => {});+ await close();}}@@ -346,11 +344,12 @@ async function computeTracesDir(config: FullConfig, clientInfo: ClientInfo): Proreturn await outputFile(config, clientInfo, `traces`, { origin: 'code', reason: 'Collecting trace' });}-function browserContextOptionsFromConfig(config: FullConfig): playwright.BrowserContextOptions {+async function browserContextOptionsFromConfig(config: FullConfig, clientInfo: ClientInfo): Promise<playwright.BrowserContextOptions> {const result = { ...config.browser.contextOptions };if (config.saveVideo) {+ const dir = await outputFile(config, clientInfo, `videos`, { origin: 'code', reason: 'Saving video' });result.recordVideo = {- dir: tmpDir(),+ dir,size: config.saveVideo,};}diff --git a/packages/playwright/src/mcp/browser/config.ts b/packages/playwright/src/mcp/browser/config.tsindex 970ecb19bb..6a87338be9 100644--- a/packages/playwright/src/mcp/browser/config.ts+++ b/packages/playwright/src/mcp/browser/config.ts@@ -325,7 +325,7 @@ async function loadConfig(configFile: string | undefined): Promise<Config> {}}-export function tmpDir(): string {+function tmpDir(): string {return path.join(process.env.PW_TMPDIR_FOR_TEST ?? os.tmpdir(), 'playwright-mcp-output');}diff --git a/packages/playwright/src/mcp/browser/context.ts b/packages/playwright/src/mcp/browser/context.tsindex 5d823058e1..f916051314 100644--- a/packages/playwright/src/mcp/browser/context.ts+++ b/packages/playwright/src/mcp/browser/context.ts@@ -14,8 +14,6 @@* limitations under the License.*/-import fs from 'fs';-import { debug } from 'playwright-core/lib/utilsBundle';import { escapeWithQuotes } from 'playwright-core/lib/utils';import { selectors } from 'playwright-core';@@ -25,7 +23,6 @@ import os from 'os';import { logUnhandledError } from '../log';import { Tab } from './tab';import { outputFile } from './config';-import { dateAsFileName } from './tools/utils';import type * as playwright from '../../../types/test';import type { FullConfig } from './config';@@ -169,29 +166,7 @@ export class Context {await promise.then(async ({ browserContext, close }) => {if (this.config.saveTrace)await browserContext.tracing.stop();- const videos = this.config.saveVideo ? browserContext.pages().map(page => page.video()).filter(video => !!video) : [];- await close(async () => {- for (const video of videos) {- const name = await this.outputFile(dateAsFileName('webm'), { origin: 'code', reason: 'Saving video' });- const p = await video.path();- // video.saveAs() does not work for persistent contexts.- if (fs.existsSync(p)) {- try {- await fs.promises.rename(p, name);- } catch (e) {- if (e.code !== 'EXDEV')- logUnhandledError(e);- // Retry operation (possibly cross-fs) with copy and unlink- try {- await fs.promises.copyFile(p, name);- await fs.promises.unlink(p);- } catch (e) {- logUnhandledError(e);- }- }- }- }- });+ await close();});}diff --git a/tests/mcp/video.spec.ts b/tests/mcp/video.spec.tsindex b413d3c502..3ee00efee8 100644--- a/tests/mcp/video.spec.ts+++ b/tests/mcp/video.spec.ts@@ -15,6 +15,7 @@*/import fs from 'fs';+import path from 'path';import { test, expect } from './fixtures';import type { Client } from '@modelcontextprotocol/sdk/client/index.js';@@ -31,14 +32,12 @@ for (const mode of ['isolated', 'persistent']) {});await navigateToTestPage(client, server);- await expect(async () => {- await produceFrames(client);- await checkIntermediateVideoFileExists();- }).toPass();+ await produceFrames(client);await closeBrowser(client);- const [file] = await fs.promises.readdir(outputDir);- expect(file).toMatch(/page-.*\.webm/);+ const videosDir = path.join(outputDir, 'videos');+ const [file] = await fs.promises.readdir(videosDir);+ expect(file).toMatch(/.*\.webm/);});test(`should work with { saveVideo } (${mode})`, async ({ startClient, server }, testInfo) => {@@ -53,14 +52,12 @@ for (const mode of ['isolated', 'persistent']) {});await navigateToTestPage(client, server);- await expect(async () => {- await produceFrames(client);- await checkIntermediateVideoFileExists();- }).toPass();+ await produceFrames(client);await closeBrowser(client);- const [file] = await fs.promises.readdir(outputDir);- expect(file).toMatch(/page-.*\.webm/);+ const videosDir = path.join(outputDir, 'videos');+ const [file] = await fs.promises.readdir(videosDir);+ expect(file).toMatch(/.*\.webm/);});test(`should work with recordVideo (${mode})`, async ({ startClient, server }, testInfo) => {@@ -83,10 +80,7 @@ for (const mode of ['isolated', 'persistent']) {});await navigateToTestPage(client, server);- await expect(async () => {- await produceFrames(client);- await checkIntermediateVideoFileExists(videosDir);- }).toPass();+ await produceFrames(client);await closeBrowser(client);});}@@ -113,12 +107,16 @@ async function produceFrames(client: Client) {name: 'browser_evaluate',arguments: {function: `async () => {+ async function rafraf(count) {+ for (let i = 0; i < count; i++)+ await new Promise(f => requestAnimationFrame(() => requestAnimationFrame(f)));+ }document.body.style.backgroundColor = "red";- await new Promise(resolve => setTimeout(resolve, 100));+ await rafraf(30);document.body.style.backgroundColor = "green";- await new Promise(resolve => setTimeout(resolve, 100));+ await rafraf(30);document.body.style.backgroundColor = "blue";- await new Promise(resolve => setTimeout(resolve, 100));+ await rafraf(30);return 'ok';}`,},@@ -126,8 +124,3 @@ async function produceFrames(client: Client) {result: '"ok"',});}--async function checkIntermediateVideoFileExists(videosDir?: string) {- const files = await fs.promises.readdir(videosDir ?? test.info().outputPath('tmp', 'playwright-mcp-output'));- expect(files[0]).toMatch(/\.webm/);-}