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: abstract tool from specific context types (#36445)
Pavel Feldman8529ff081e95
diff --git a/packages/playwright-mdd/src/tools/assert.ts b/packages/playwright-mdd/src/browser/assert.tssimilarity index 100%rename from packages/playwright-mdd/src/tools/assert.tsrename to packages/playwright-mdd/src/browser/assert.tsdiff --git a/packages/playwright-mdd/src/context.ts b/packages/playwright-mdd/src/browser/context.tssimilarity index 86%rename from packages/playwright-mdd/src/context.tsrename to packages/playwright-mdd/src/browser/context.tsindex d998e51247..e296e101bc 100644--- a/packages/playwright-mdd/src/context.ts+++ b/packages/playwright-mdd/src/browser/context.ts@@ -14,13 +14,14 @@* limitations under the License.*/-import debug from 'debug';import * as playwright from 'playwright';-import { callOnPageNoTrace, waitForCompletion } from './tools/utils';-import { ManualPromise } from './manualPromise';+import { callOnPageNoTrace, waitForCompletion } from './utils';+import { ManualPromise } from '../manualPromise';+import { tools } from './tools';+import { runTasks } from '../loop';-import type { ModalState, Tool, ToolActionResult } from './tools/tool';+import type { ModalState, Tool, ToolActionResult } from './tool';type PendingAction = {dialogShown: ManualPromise<void>;@@ -30,30 +31,27 @@ type PageEx = playwright.Page & {_snapshotForAI: () => Promise<string>;};-const testDebug = debug('pw:mcp:test');-export class Context {readonly browser: playwright.Browser;readonly page: playwright.Page;- readonly tools: Tool[];+ readonly tools = tools;private _modalStates: ModalState[] = [];private _pendingAction: PendingAction | undefined;private _downloads: { download: playwright.Download, finished: boolean, outputFile: string }[] = [];+ private _codeCollector: string[] = [];- constructor(browser: playwright.Browser, page: playwright.Page, tools: Tool[]) {+ constructor(browser: playwright.Browser, page: playwright.Page) {this.browser = browser;this.page = page;- this.tools = tools;- testDebug('create context');}- static async create(tools: Tool[]): Promise<Context> {+ static async create(): Promise<Context> {const browser = await playwright.chromium.launch({headless: false,});const context = await browser.newContext();const page = await context.newPage();- return new Context(browser, page, tools);+ return new Context(browser, page);}async close() {@@ -83,7 +81,24 @@ export class Context {return result;}- async run(tool: Tool, params: Record<string, unknown> | undefined): Promise<{ content: string, code: string[] }> {+ async runScript(tasks: string[]): Promise<string> {+ this._codeCollector = [+ `test('generated code', async ({ page }) => {`,+ ];+ await runTasks(this, tasks);+ this._codeCollector.push('});');+ return this._codeCollector.join('\n');+ }++ async beforeTask(task: string) {+ this._codeCollector.push(`// ${task}`);+ }++ async afterTask() {+ this._codeCollector.push('');+ }++ async runTool(tool: Tool, params: Record<string, unknown> | undefined): Promise<{ content: string }> {const toolResult = await tool.handle(this, tool.schema.inputSchema.parse(params || {}));const { code, action, waitForNetwork, captureSnapshot } = toolResult;const racingAction = action ? () => this._raceAgainstModalDialogs(action) : undefined;@@ -98,7 +113,6 @@ export class Context {if (this.modalStates().length) {result.push(...this.modalStatesMarkdown());return {- code,content: result.join('\n'),};}@@ -122,10 +136,8 @@ export class Context {if (captureSnapshot && !this._javaScriptBlocked())result.push(await this._snapshot());- return {- code,- content: result.join('\n'),- };+ this._codeCollector.push(...code.map(c => ` ${c}`));+ return { content: result.join('\n') };}async title(): Promise<string> {diff --git a/packages/playwright-mdd/src/tools/done.ts b/packages/playwright-mdd/src/browser/done.tssimilarity index 100%rename from packages/playwright-mdd/src/tools/done.tsrename to packages/playwright-mdd/src/browser/done.tsdiff --git a/packages/playwright-mdd/src/format.ts b/packages/playwright-mdd/src/browser/format.tssimilarity index 100%rename from packages/playwright-mdd/src/format.tsrename to packages/playwright-mdd/src/browser/format.tsdiff --git a/packages/playwright-mdd/src/tools/navigate.ts b/packages/playwright-mdd/src/browser/navigate.tssimilarity index 100%rename from packages/playwright-mdd/src/tools/navigate.tsrename to packages/playwright-mdd/src/browser/navigate.tsdiff --git a/packages/playwright-mdd/src/tools/snapshot.ts b/packages/playwright-mdd/src/browser/snapshot.tssimilarity index 99%rename from packages/playwright-mdd/src/tools/snapshot.tsrename to packages/playwright-mdd/src/browser/snapshot.tsindex b3979af095..1eebc16134 100644--- a/packages/playwright-mdd/src/tools/snapshot.ts+++ b/packages/playwright-mdd/src/browser/snapshot.ts@@ -17,7 +17,7 @@import { z } from 'zod';import { defineTool } from './tool';-import * as format from '../format';+import * as format from './format';import { generateLocator } from './utils';const snapshot = defineTool({diff --git a/packages/playwright-mdd/src/tools/tool.ts b/packages/playwright-mdd/src/browser/tool.tssimilarity index 80%rename from packages/playwright-mdd/src/tools/tool.tsrename to packages/playwright-mdd/src/browser/tool.tsindex 9f840051eb..184bf77341 100644--- a/packages/playwright-mdd/src/tools/tool.ts+++ b/packages/playwright-mdd/src/browser/tool.ts@@ -16,15 +16,8 @@import type { z } from 'zod';import type * as playwright from 'playwright-core';-import type { Context } from '../context';--export type ToolSchema<Input extends InputType> = {- name: string;- description: string;- inputSchema: Input;-};--type InputType = z.Schema;+import type { Context } from './context';+import type { ToolSchema } from '../loop';export type FileUploadModalState = {type: 'fileChooser';@@ -49,12 +42,12 @@ export type ToolResult = {waitForNetwork: boolean;};-export type Tool<Input extends InputType = InputType> = {+export type Tool<Input extends z.Schema = z.Schema> = {schema: ToolSchema<Input>;clearsModalState?: ModalState['type'];handle: (context: Context, params: z.output<Input>) => Promise<ToolResult>;};-export function defineTool<Input extends InputType>(tool: Tool<Input>): Tool<Input> {+export function defineTool<Input extends z.Schema>(tool: Tool<Input>): Tool<Input> {return tool;}diff --git a/packages/playwright-mdd/src/tools.ts b/packages/playwright-mdd/src/browser/tools.tssimilarity index 77%rename from packages/playwright-mdd/src/tools.tsrename to packages/playwright-mdd/src/browser/tools.tsindex 5cbee6a3c1..7c13f96ac0 100644--- a/packages/playwright-mdd/src/tools.ts+++ b/packages/playwright-mdd/src/browser/tools.ts@@ -14,12 +14,12 @@* limitations under the License.*/-import assert from './tools/assert';-import snapshot from './tools/snapshot';-import done from './tools/done';-import navigate from './tools/navigate';+import assert from './assert';+import snapshot from './snapshot';+import done from './done';+import navigate from './navigate';-import type { Tool } from './tools/tool.js';+import type { Tool } from './tool.js';export const tools: Tool<any>[] = [...assert,diff --git a/packages/playwright-mdd/src/tools/utils.ts b/packages/playwright-mdd/src/browser/utils.tssimilarity index 98%rename from packages/playwright-mdd/src/tools/utils.tsrename to packages/playwright-mdd/src/browser/utils.tsindex d82095edc8..be1a20d3cf 100644--- a/packages/playwright-mdd/src/tools/utils.ts+++ b/packages/playwright-mdd/src/browser/utils.ts@@ -15,7 +15,7 @@*/import type * as playwright from 'playwright';-import type { Context } from '../context';+import type { Context } from './context';export async function waitForCompletion<R>(context: Context, callback: () => Promise<R>): Promise<R> {const requests = new Set<playwright.Request>();diff --git a/packages/playwright-mdd/src/loop.ts b/packages/playwright-mdd/src/loop.tsindex 5b5b84bec2..0ee4994d56 100644--- a/packages/playwright-mdd/src/loop.ts+++ b/packages/playwright-mdd/src/loop.ts@@ -14,36 +14,39 @@* limitations under the License.*/+import { z } from 'zod';import OpenAI from 'openai';import debug from 'debug';import { zodToJsonSchema } from 'zod-to-json-schema';-import { Tool } from './tools/tool';-import { Context } from './context';-/* eslint-disable no-console */-export async function runTasks(context: Context, tasks: string[]): Promise<string> {+export interface Context {+ readonly tools: Tool<any>[];+ beforeTask?(task: string): Promise<void>;+ runTool(tool: Tool<any>, params: Record<string, unknown>): Promise<{ content: string }>;+ afterTask?(): Promise<void>;+}++export type ToolSchema<Input extends z.Schema> = {+ name: string;+ description: string;+ inputSchema: Input;+};++export type Tool<Input extends z.Schema = z.Schema> = {+ schema: ToolSchema<Input>;+};++export async function runTasks(context: Context, tasks: string[]) {const openai = new OpenAI();- const allCode: string[] = [- `test('generated code', async ({ page }) => {`,- ];- for (const task of tasks) {- const { taskCode } = await runTask(openai, context, task);- if (taskCode.length)- allCode.push('', ...taskCode.map(code => ` ${code}`));- }- allCode.push('});');- return allCode.join('\n');+ for (const task of tasks)+ await runTask(openai, context, task);}-async function runTask(openai: OpenAI, context: Context, task: string): Promise<{ taskCode: string[] }> {+async function runTask(openai: OpenAI, context: Context, task: string) {console.log('Perform task:', task);- const taskCode: string[] = [- `// ${task}`,- ];-const messages: OpenAI.Chat.Completions.ChatCompletionMessageParam[] = [{role: 'user',@@ -51,6 +54,8 @@ async function runTask(openai: OpenAI, context: Context, task: string): Promise<}];+ await context.beforeTask?.(task);+for (let iteration = 0; iteration < 5; ++iteration) {debug('history')(messages);const response = await openai.chat.completions.create({@@ -69,7 +74,6 @@ async function runTask(openai: OpenAI, context: Context, task: string): Promise<tool_calls: message.tool_calls});- let hasPreviousError = false;for (const toolCall of message.tool_calls) {const functionCall = toolCall.function;console.log('Call tool:', functionCall.name, functionCall.arguments);@@ -78,34 +82,33 @@ async function runTask(openai: OpenAI, context: Context, task: string): Promise<if (!tool)throw new Error('Unknown tool: ' + functionCall.name);- if (hasPreviousError) {- messages.push({- role: 'tool',- tool_call_id: toolCall.id,- content: `This tool call is skipped due to previous error.`,- });- continue;+ if (functionCall.name === 'done') {+ await context.afterTask?.();+ return;}- if (functionCall.name === 'done')- return { taskCode };-try {- const { code, content } = await context.run(tool, JSON.parse(functionCall.arguments));- taskCode.push(...code);+ const { content } = await context.runTool(tool, JSON.parse(functionCall.arguments));messages.push({role: 'tool',tool_call_id: toolCall.id,content,});} catch (error) {- hasPreviousError = true;console.log('Tool error:', error);messages.push({role: 'tool',tool_call_id: toolCall.id,content: `Error while executing tool "${functionCall.name}": ${error instanceof Error ? error.message : String(error)}\n\nPlease try to recover and complete the task.`,});+ for (const ignoredToolCall of message.tool_calls.slice(message.tool_calls.indexOf(toolCall) + 1)) {+ messages.push({+ role: 'tool',+ tool_call_id: ignoredToolCall.id,+ content: `This tool call is skipped due to previous error.`,+ });+ }+ break;}}}diff --git a/packages/playwright-mdd/src/program.ts b/packages/playwright-mdd/src/program.tsindex d85b24de7c..4d9a4f4963 100644--- a/packages/playwright-mdd/src/program.ts+++ b/packages/playwright-mdd/src/program.ts@@ -17,9 +17,7 @@import dotenv from 'dotenv';import { program } from 'commander';-import { runTasks } from './loop';-import { Context } from './context';-import { tools } from './tools';+import { Context } from './browser/context';/* eslint-disable no-console */@@ -31,8 +29,8 @@ program.version('Version ' + packageJSON.version).name(packageJSON.name).action(async () => {- const context = await Context.create(tools);- const code = await runTasks(context, script);+ const context = await Context.create();+ const code = await context.runScript(script);console.log('Output code:');console.log('```javascript');console.log(code);