/** * Copyright (c) Microsoft Corporation. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import debug from 'debug'; import * as playwright from 'playwright'; import { callOnPageNoTrace, waitForCompletion } from './tools/utils.js'; import { ManualPromise } from './manualPromise.js'; import { Tab } from './tab.js'; import { outputFile } from './config.js'; import type { ModalState, Tool, ToolActionResult } from './tools/tool.js'; import type { FullConfig } from './config.js'; import type { BrowserContextFactory } from './browserContextFactory.js'; type PendingAction = { dialogShown: ManualPromise; }; const testDebug = debug('pw:mcp:test'); export class Context { readonly tools: Tool[]; readonly config: FullConfig; private _browserContextPromise: Promise<{ browserContext: playwright.BrowserContext, close: () => Promise }> | undefined; private _browserContextFactory: BrowserContextFactory; private _tabs: Tab[] = []; private _currentTab: Tab | undefined; private _modalStates: (ModalState & { tab: Tab })[] = []; private _pendingAction: PendingAction | undefined; private _downloads: { download: playwright.Download, finished: boolean, outputFile: string }[] = []; clientVersion: { name: string; version: string; } | undefined; constructor(tools: Tool[], config: FullConfig, browserContextFactory: BrowserContextFactory) { this.tools = tools; this.config = config; this._browserContextFactory = browserContextFactory; testDebug('create context'); } clientSupportsImages(): boolean { if (this.config.imageResponses === 'omit') return false; return true; } modalStates(): ModalState[] { return this._modalStates; } setModalState(modalState: ModalState, inTab: Tab) { this._modalStates.push({ ...modalState, tab: inTab }); } clearModalState(modalState: ModalState) { this._modalStates = this._modalStates.filter(state => state !== modalState); } modalStatesMarkdown(): string[] { const result: string[] = ['### Modal state']; if (this._modalStates.length === 0) result.push('- There is no modal state present'); for (const state of this._modalStates) { const tool = this.tools.find(tool => tool.clearsModalState === state.type); result.push(`- [${state.description}]: can be handled by the "${tool?.schema.name}" tool`); } return result; } tabs(): Tab[] { return this._tabs; } currentTabOrDie(): Tab { if (!this._currentTab) throw new Error('No current snapshot available. Capture a snapshot or navigate to a new location first.'); return this._currentTab; } async newTab(): Promise { const { browserContext } = await this._ensureBrowserContext(); const page = await browserContext.newPage(); this._currentTab = this._tabs.find(t => t.page === page)!; return this._currentTab; } async selectTab(index: number) { this._currentTab = this._tabs[index]; await this._currentTab.page.bringToFront(); } async ensureTab(): Promise { const { browserContext } = await this._ensureBrowserContext(); if (!this._currentTab) await browserContext.newPage(); return this._currentTab!; } async listTabsMarkdown(): Promise { if (!this._tabs.length) return '### No tabs open'; const lines: string[] = ['### Open tabs']; for (let i = 0; i < this._tabs.length; i++) { const tab = this._tabs[i]; const title = await tab.title(); const url = tab.page.url(); const current = tab === this._currentTab ? ' (current)' : ''; lines.push(`- ${i}:${current} [${title}] (${url})`); } return lines.join('\n'); } async closeTab(index: number | undefined) { const tab = index === undefined ? this._currentTab : this._tabs[index]; await tab?.page.close(); return await this.listTabsMarkdown(); } async run(tool: Tool, params: Record | undefined) { // Tab management is done outside of the action() call. const toolResult = await tool.handle(this, tool.schema.inputSchema.parse(params || {})); const { code, action, waitForNetwork, captureSnapshot, resultOverride } = toolResult; if (resultOverride) return resultOverride; if (!this._currentTab) { return { content: [{ type: 'text', text: 'No open pages available. Use the "browser_navigate" tool to navigate to a page first.', }], }; } const tab = this.currentTabOrDie(); // TODO: race against modal dialogs to resolve clicks. const actionResult = await this._raceAgainstModalDialogs(async () => { try { if (waitForNetwork) return await waitForCompletion(this, tab, async () => action?.()) ?? undefined; else return await action?.() ?? undefined; } finally { if (captureSnapshot && !this._javaScriptBlocked()) await tab.captureSnapshot(); } }); const result: string[] = []; result.push(`### Ran Playwright code \`\`\`js ${code.join('\n')} \`\`\``); if (this.modalStates().length) { result.push('', ...this.modalStatesMarkdown()); return { content: [{ type: 'text', text: result.join('\n'), }], }; } const messages = tab.takeRecentConsoleMessages(); if (messages.length) { result.push('', `### New console messages`); for (const message of messages) result.push(`- ${trim(message.toString(), 100)}`); } if (this._downloads.length) { result.push('', '### Downloads'); for (const entry of this._downloads) { if (entry.finished) result.push(`- Downloaded file ${entry.download.suggestedFilename()} to ${entry.outputFile}`); else result.push(`- Downloading file ${entry.download.suggestedFilename()} ...`); } } if (captureSnapshot && tab.hasSnapshot()) { if (this.tabs().length > 1) result.push('', await this.listTabsMarkdown()); if (this.tabs().length > 1) result.push('', '### Current tab'); else result.push('', '### Page state'); result.push( `- Page URL: ${tab.page.url()}`, `- Page Title: ${await tab.title()}` ); result.push(tab.snapshotOrDie().text()); } const content = actionResult?.content ?? []; return { content: [ ...content, { type: 'text', text: result.join('\n'), } ], }; } async waitForTimeout(time: number) { if (!this._currentTab || this._javaScriptBlocked()) { await new Promise(f => setTimeout(f, time)); return; } await callOnPageNoTrace(this._currentTab.page, page => { return page.evaluate(() => new Promise(f => setTimeout(f, 1000))); }); } private async _raceAgainstModalDialogs(action: () => Promise): Promise { this._pendingAction = { dialogShown: new ManualPromise(), }; let result: ToolActionResult | undefined; try { await Promise.race([ action().then(r => result = r), this._pendingAction.dialogShown, ]); } finally { this._pendingAction = undefined; } return result; } private _javaScriptBlocked(): boolean { return this._modalStates.some(state => state.type === 'dialog'); } dialogShown(tab: Tab, dialog: playwright.Dialog) { this.setModalState({ type: 'dialog', description: `"${dialog.type()}" dialog with message "${dialog.message()}"`, dialog, }, tab); this._pendingAction?.dialogShown.resolve(); } async downloadStarted(tab: Tab, download: playwright.Download) { const entry = { download, finished: false, outputFile: await outputFile(this.config, download.suggestedFilename()) }; this._downloads.push(entry); await download.saveAs(entry.outputFile); entry.finished = true; } private _onPageCreated(page: playwright.Page) { const tab = new Tab(this, page, tab => this._onPageClosed(tab)); this._tabs.push(tab); if (!this._currentTab) this._currentTab = tab; } private _onPageClosed(tab: Tab) { this._modalStates = this._modalStates.filter(state => state.tab !== tab); const index = this._tabs.indexOf(tab); if (index === -1) return; this._tabs.splice(index, 1); if (this._currentTab === tab) this._currentTab = this._tabs[Math.min(index, this._tabs.length - 1)]; if (!this._tabs.length) void this.close(); } async close() { if (!this._browserContextPromise) return; testDebug('close context'); const promise = this._browserContextPromise; this._browserContextPromise = undefined; await promise.then(async ({ browserContext, close }) => { if (this.config.saveTrace) await browserContext.tracing.stop(); await close(); }); } private async _setupRequestInterception(context: playwright.BrowserContext) { if (this.config.network?.allowedOrigins?.length) { await context.route('**', route => route.abort('blockedbyclient')); for (const origin of this.config.network.allowedOrigins) await context.route(`*://${origin}/**`, route => route.continue()); } if (this.config.network?.blockedOrigins?.length) { for (const origin of this.config.network.blockedOrigins) await context.route(`*://${origin}/**`, route => route.abort('blockedbyclient')); } } private _ensureBrowserContext() { if (!this._browserContextPromise) { this._browserContextPromise = this._setupBrowserContext(); this._browserContextPromise.catch(() => { this._browserContextPromise = undefined; }); } return this._browserContextPromise; } private async _setupBrowserContext(): Promise<{ browserContext: playwright.BrowserContext, close: () => Promise }> { // TODO: move to the browser context factory to make it based on isolation mode. const result = await this._browserContextFactory.createContext(); const { browserContext } = result; await this._setupRequestInterception(browserContext); for (const page of browserContext.pages()) this._onPageCreated(page); browserContext.on('page', page => this._onPageCreated(page)); if (this.config.saveTrace) { await browserContext.tracing.start({ name: 'trace', screenshots: false, snapshots: true, sources: false, }); } return result; } } function trim(text: string, maxLength: number) { if (text.length <= maxLength) return text; return text.slice(0, maxLength) + '...'; }