playwright 1.56.1 → 1.57.0

package/lib/mcp/sdk/proxyBackend.js

@@ -40,7 +40,7 @@ class ProxyBackend {
     this._mcpProviders = mcpProviders;
     this._contextSwitchTool = this._defineContextSwitchTool();
   }
-  async initialize(server, clientInfo) {
+  async initialize(clientInfo) {
     this._clientInfo = clientInfo;
   }
   async listTools() {

package/lib/mcp/sdk/server.js

@@ -41,6 +41,7 @@ var mcpBundle = __toESM(require("./bundle"));
 var import_http = require("./http");
 var import_inProcessTransport = require("./inProcessTransport");
 const serverDebug = (0, import_utilsBundle.debug)("pw:mcp:server");
+const serverDebugResponse = (0, import_utilsBundle.debug)("pw:mcp:server:response");
 async function connect(factory, transport, runHeartbeat) {
   const server = createServer(factory.name, factory.version, factory.create(), runHeartbeat);
   await server.connect(transport);
@@ -81,7 +82,10 @@ function createServer(name, version, backend, runHeartbeat) {
       if (!initializePromise)
         initializePromise = initializeServer(server, backend, runHeartbeat);
       await initializePromise;
-      return mergeTextParts(await backend.callTool(request.params.name, request.params.arguments || {}, progress));
+      const toolResult = await backend.callTool(request.params.name, request.params.arguments || {}, progress);
+      const mergedResult = mergeTextParts(toolResult);
+      serverDebugResponse("callResult", mergedResult);
+      return mergedResult;
     } catch (error) {
       return {
         content: [{ type: "text", text: "### Result\n" + String(error) }],
@@ -108,7 +112,7 @@ const initializeServer = async (server, backend, runHeartbeat) => {
     roots: clientRoots,
     timestamp: Date.now()
   };
-  await backend.initialize?.(server, clientInfo);
+  await backend.initialize?.(clientInfo);
   if (runHeartbeat)
     startHeartbeat(server);
 };
@@ -138,8 +142,7 @@ async function start(serverBackendFactory, options) {
     return;
   }
   const httpServer = await (0, import_http.startHttpServer)(options);
-  const url = (0, import_http.httpAddressToString)(httpServer.address());
-  await (0, import_http.installHttpTransport)(httpServer, serverBackendFactory, options.allowedHosts);
+  const url = await (0, import_http.installHttpTransport)(httpServer, serverBackendFactory, false, options.allowedHosts);
   const mcpConfig = { mcpServers: {} };
   mcpConfig.mcpServers[serverBackendFactory.nameInConfig] = {
     url: `${url}/mcp`
@@ -157,7 +160,12 @@ function firstRootPath(clientInfo) {
     return void 0;
   const firstRootUri = clientInfo.roots[0]?.uri;
   const url = firstRootUri ? new URL(firstRootUri) : void 0;
-  return url ? (0, import_url.fileURLToPath)(url) : void 0;
+  try {
+    return url ? (0, import_url.fileURLToPath)(url) : void 0;
+  } catch (error) {
+    serverDebug(error);
+    return void 0;
+  }
 }
 function mergeTextParts(result) {
   const content = [];

package/lib/mcp/sdk/tool.js

@@ -23,16 +23,12 @@ __export(tool_exports, {
 });
 module.exports = __toCommonJS(tool_exports);
 var import_bundle = require("../sdk/bundle");
-const typesWithIntent = ["action", "assertion", "input"];
-function toMcpTool(tool, options) {
-  const inputSchema = options?.addIntent && typesWithIntent.includes(tool.type) ? tool.inputSchema.extend({
-    intent: import_bundle.z.string().describe("The intent of the call, for example the test step description plan idea")
-  }) : tool.inputSchema;
+function toMcpTool(tool) {
   const readOnly = tool.type === "readOnly" || tool.type === "assertion";
   return {
     name: tool.name,
     description: tool.description,
-    inputSchema: (0, import_bundle.zodToJsonSchema)(inputSchema, { strictUnions: true }),
+    inputSchema: (0, import_bundle.zodToJsonSchema)(tool.inputSchema, { strictUnions: true }),
     annotations: {
       title: tool.title,
       readOnlyHint: readOnly,

package/lib/mcp/test/browserBackend.js

@@ -1,9 +1,7 @@
 "use strict";
-var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -17,38 +15,54 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var browserBackend_exports = {};
 __export(browserBackend_exports, {
-  runBrowserBackendAtEnd: () => runBrowserBackendAtEnd
+  createCustomMessageHandler: () => createCustomMessageHandler
 });
 module.exports = __toCommonJS(browserBackend_exports);
-var mcp = __toESM(require("../sdk/exports"));
-var import_globals = require("../../common/globals");
-var import_util = require("../../util");
 var import_config = require("../browser/config");
 var import_browserServerBackend = require("../browser/browserServerBackend");
 var import_tab = require("../browser/tab");
-async function runBrowserBackendAtEnd(context, errorMessage) {
-  const testInfo = (0, import_globals.currentTestInfo)();
-  if (!testInfo)
-    return;
-  const shouldPause = errorMessage ? testInfo?._pauseOnError() : testInfo?._pauseAtEnd();
-  if (!shouldPause)
-    return;
+var import_util = require("../../util");
+function createCustomMessageHandler(testInfo, context) {
+  let backend;
+  return async (data) => {
+    if (data.initialize) {
+      if (backend)
+        throw new Error("MCP backend is already initialized");
+      backend = new import_browserServerBackend.BrowserServerBackend({ ...import_config.defaultConfig, capabilities: ["testing"] }, identityFactory(context));
+      await backend.initialize(data.initialize.clientInfo);
+      const pausedMessage = await generatePausedMessage(testInfo, context);
+      return { initialize: { pausedMessage } };
+    }
+    if (data.listTools) {
+      if (!backend)
+        throw new Error("MCP backend is not initialized");
+      return { listTools: await backend.listTools() };
+    }
+    if (data.callTool) {
+      if (!backend)
+        throw new Error("MCP backend is not initialized");
+      return { callTool: await backend.callTool(data.callTool.name, data.callTool.arguments) };
+    }
+    if (data.close) {
+      backend?.serverClosed();
+      backend = void 0;
+      return { close: {} };
+    }
+    throw new Error("Unknown MCP request");
+  };
+}
+async function generatePausedMessage(testInfo, context) {
   const lines = [];
-  if (errorMessage)
-    lines.push(`### Paused on error:`, (0, import_util.stripAnsiEscapes)(errorMessage));
-  else
+  if (testInfo.errors.length) {
+    lines.push(`### Paused on error:`);
+    for (const error of testInfo.errors)
+      lines.push((0, import_util.stripAnsiEscapes)(error.message || ""));
+  } else {
     lines.push(`### Paused at end of test. ready for interaction`);
+  }
   for (let i = 0; i < context.pages().length; i++) {
     const page = context.pages()[i];
     const stateSuffix = context.pages().length > 1 ? i + 1 + " of " + context.pages().length : "state";
@@ -58,7 +72,7 @@ async function runBrowserBackendAtEnd(context, errorMessage) {
       `- Page URL: ${page.url()}`,
       `- Page Title: ${await page.title()}`.trim()
     );
-    let console = errorMessage ? await import_tab.Tab.collectConsoleMessages(page) : [];
+    let console = testInfo.errors.length ? await import_tab.Tab.collectConsoleMessages(page) : [];
     console = console.filter((msg) => !msg.type || msg.type === "error");
     if (console.length) {
       lines.push("- Console Messages:");
@@ -68,18 +82,14 @@ async function runBrowserBackendAtEnd(context, errorMessage) {
     lines.push(
       `- Page Snapshot:`,
       "```yaml",
-      await page._snapshotForAI(),
+      (await page._snapshotForAI()).full,
       "```"
     );
   }
   lines.push("");
-  if (errorMessage)
+  if (testInfo.errors.length)
     lines.push(`### Task`, `Try recovering from the error prior to continuing`);
-  const config = {
-    ...import_config.defaultConfig,
-    capabilities: ["testing"]
-  };
-  await mcp.runOnPauseBackendLoop(new import_browserServerBackend.BrowserServerBackend(config, identityFactory(context)), lines.join("\n"));
+  return lines.join("\n");
 }
 function identityFactory(browserContext) {
   return {
@@ -94,5 +104,5 @@ function identityFactory(browserContext) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  runBrowserBackendAtEnd
+  createCustomMessageHandler
 });

package/lib/mcp/test/generatorTools.js

@@ -50,11 +50,11 @@ const setupPage = (0, import_testTool.defineTestTool)({
     }),
     type: "readOnly"
   },
-  handle: async (context, params, progress) => {
+  handle: async (context, params) => {
     const seed = await context.getOrCreateSeedFile(params.seedFile, params.project);
     context.generatorJournal = new import_testContext.GeneratorJournal(context.rootPath, params.plan, seed);
-    await context.runSeedTest(seed.file, seed.projectName, progress);
-    return { content: [] };
+    const { output, status } = await context.runSeedTest(seed.file, seed.projectName);
+    return { content: [{ type: "text", text: output }], isError: status !== "paused" };
   }
 });
 const generatorReadLog = (0, import_testTool.defineTestTool)({

package/lib/mcp/test/plannerTools.js

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -15,12 +17,24 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var plannerTools_exports = {};
 __export(plannerTools_exports, {
-  setupPage: () => setupPage
+  saveTestPlan: () => saveTestPlan,
+  setupPage: () => setupPage,
+  submitTestPlan: () => submitTestPlan
 });
 module.exports = __toCommonJS(plannerTools_exports);
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
 var import_bundle = require("../sdk/bundle");
 var import_testTool = require("./testTool");
 const setupPage = (0, import_testTool.defineTestTool)({
@@ -34,13 +48,97 @@ const setupPage = (0, import_testTool.defineTestTool)({
     }),
     type: "readOnly"
   },
-  handle: async (context, params, progress) => {
+  handle: async (context, params) => {
     const seed = await context.getOrCreateSeedFile(params.seedFile, params.project);
-    await context.runSeedTest(seed.file, seed.projectName, progress);
-    return { content: [] };
+    const { output, status } = await context.runSeedTest(seed.file, seed.projectName);
+    return { content: [{ type: "text", text: output }], isError: status !== "paused" };
+  }
+});
+const planSchema = import_bundle.z.object({
+  overview: import_bundle.z.string().describe("A brief overview of the application to be tested"),
+  suites: import_bundle.z.array(import_bundle.z.object({
+    name: import_bundle.z.string().describe("The name of the suite"),
+    seedFile: import_bundle.z.string().describe("A seed file that was used to setup the page for testing."),
+    tests: import_bundle.z.array(import_bundle.z.object({
+      name: import_bundle.z.string().describe("The name of the test"),
+      file: import_bundle.z.string().describe('The file the test should be saved to, for example: "tests/<suite-name>/<test-name>.spec.ts".'),
+      steps: import_bundle.z.array(import_bundle.z.string().describe(`The steps to be executed to perform the test. For example: 'Click on the "Submit" button'`)),
+      expectedResults: import_bundle.z.array(import_bundle.z.string().describe("The expected results of the steps for test to verify."))
+    }))
+  }))
+});
+const submitTestPlan = (0, import_testTool.defineTestTool)({
+  schema: {
+    name: "planner_submit_plan",
+    title: "Submit test plan",
+    description: "Submit the test plan to the test planner",
+    inputSchema: planSchema,
+    type: "readOnly"
+  },
+  handle: async (context, params) => {
+    return {
+      content: [{
+        type: "text",
+        text: JSON.stringify(params, null, 2)
+      }]
+    };
+  }
+});
+const saveTestPlan = (0, import_testTool.defineTestTool)({
+  schema: {
+    name: "planner_save_plan",
+    title: "Save test plan as markdown file",
+    description: "Save the test plan as a markdown file",
+    inputSchema: planSchema.extend({
+      name: import_bundle.z.string().describe('The name of the test plan, for example: "Test Plan".'),
+      fileName: import_bundle.z.string().describe('The file to save the test plan to, for example: "spec/test.plan.md". Relative to the workspace root.')
+    }),
+    type: "readOnly"
+  },
+  handle: async (context, params) => {
+    const lines = [];
+    lines.push(`# ${params.name}`);
+    lines.push(``);
+    lines.push(`## Application Overview`);
+    lines.push(``);
+    lines.push(params.overview);
+    lines.push(``);
+    lines.push(`## Test Scenarios`);
+    for (let i = 0; i < params.suites.length; i++) {
+      lines.push(``);
+      const suite = params.suites[i];
+      lines.push(`### ${i + 1}. ${suite.name}`);
+      lines.push(``);
+      lines.push(`**Seed:** \`${suite.seedFile}\``);
+      for (let j = 0; j < suite.tests.length; j++) {
+        lines.push(``);
+        const test = suite.tests[j];
+        lines.push(`#### ${i + 1}.${j + 1}. ${test.name}`);
+        lines.push(``);
+        lines.push(`**File:** \`${test.file}\``);
+        lines.push(``);
+        lines.push(`**Steps:**`);
+        for (let k = 0; k < test.steps.length; k++)
+          lines.push(`  ${k + 1}. ${test.steps[k]}`);
+        lines.push(``);
+        lines.push(`**Expected Results:**`);
+        for (const result of test.expectedResults)
+          lines.push(`  - ${result}`);
+      }
+    }
+    lines.push(``);
+    await import_fs.default.promises.writeFile(import_path.default.resolve(context.rootPath, params.fileName), lines.join("\n"));
+    return {
+      content: [{
+        type: "text",
+        text: `Test plan saved to ${params.fileName}`
+      }]
+    };
   }
 });
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  setupPage
+  saveTestPlan,
+  setupPage,
+  submitTestPlan
 });

package/lib/mcp/test/seed.js

@@ -28,7 +28,10 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var seed_exports = {};
 __export(seed_exports, {
-  ensureSeedTest: () => ensureSeedTest,
+  defaultSeedFile: () => defaultSeedFile,
+  ensureSeedFile: () => ensureSeedFile,
+  findSeedFile: () => findSeedFile,
+  seedFileContent: () => seedFileContent,
   seedProject: () => seedProject
 });
 module.exports = __toCommonJS(seed_exports);
@@ -44,29 +47,36 @@ function seedProject(config, projectName) {
     throw new Error(`Project ${projectName} not found`);
   return project;
 }
-async function ensureSeedTest(project, logNew) {
+async function findSeedFile(project) {
   const files = await (0, import_projectUtils.collectFilesForProject)(project);
-  const seed = files.find((file) => import_path.default.basename(file).includes("seed"));
-  if (seed)
-    return seed;
+  return files.find((file) => import_path.default.basename(file).includes("seed"));
+}
+function defaultSeedFile(project) {
   const testDir = project.project.testDir;
-  const seedFile = import_path.default.resolve(testDir, "seed.spec.ts");
-  if (logNew) {
-    console.log(`Writing file: ${import_path.default.relative(process.cwd(), seedFile)}`);
-  }
-  await (0, import_utils.mkdirIfNeeded)(seedFile);
-  await import_fs.default.promises.writeFile(seedFile, `import { test, expect } from '@playwright/test';
+  return import_path.default.resolve(testDir, "seed.spec.ts");
+}
+async function ensureSeedFile(project) {
+  const seedFile = await findSeedFile(project);
+  if (seedFile)
+    return seedFile;
+  const seedFilePath = defaultSeedFile(project);
+  await (0, import_utils.mkdirIfNeeded)(seedFilePath);
+  await import_fs.default.promises.writeFile(seedFilePath, seedFileContent);
+  return seedFilePath;
+}
+const seedFileContent = `import { test, expect } from '@playwright/test';
 
 test.describe('Test group', () => {
   test('seed', async ({ page }) => {
     // generate code here.
   });
 });
-`);
-  return seedFile;
-}
+`;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  ensureSeedTest,
+  defaultSeedFile,
+  ensureSeedFile,
+  findSeedFile,
+  seedFileContent,
   seedProject
 });

package/lib/mcp/test/streams.js

@@ -22,14 +22,19 @@ __export(streams_exports, {
 });
 module.exports = __toCommonJS(streams_exports);
 var import_stream = require("stream");
+var import_util = require("../../util");
 class StringWriteStream extends import_stream.Writable {
-  constructor(progress) {
+  constructor(output, stdio) {
     super();
-    this._progress = progress;
+    this._output = output;
+    this._prefix = stdio === "stdout" ? "" : "[err] ";
   }
   _write(chunk, encoding, callback) {
-    const text = chunk.toString();
-    this._progress({ message: text.endsWith("\n") ? text.slice(0, -1) : text });
+    let text = (0, import_util.stripAnsiEscapes)(chunk.toString());
+    if (text.endsWith("\n"))
+      text = text.slice(0, -1);
+    if (text)
+      this._output.push(this._prefix + text);
     callback();
   }
 }

package/lib/mcp/test/testBackend.js

@@ -37,60 +37,62 @@ var testTools = __toESM(require("./testTools.js"));
 var generatorTools = __toESM(require("./generatorTools.js"));
 var plannerTools = __toESM(require("./plannerTools.js"));
 var import_tools = require("../browser/tools");
-var import_configLoader = require("../../common/configLoader");
-var import_response = require("../browser/response");
+var import_bundle = require("../sdk/bundle");
 class TestServerBackend {
   constructor(configOption, options) {
     this.name = "Playwright";
     this.version = "0.0.1";
     this._tools = [
+      plannerTools.saveTestPlan,
       plannerTools.setupPage,
+      plannerTools.submitTestPlan,
       generatorTools.setupPage,
       generatorTools.generatorReadLog,
       generatorTools.generatorWriteTest,
       testTools.listTests,
       testTools.runTests,
-      testTools.debugTest
+      testTools.debugTest,
+      ...import_tools.browserTools.map((tool) => wrapBrowserTool(tool))
     ];
-    this._context = new import_testContext.TestContext(options);
+    this._options = options || {};
     this._configOption = configOption;
   }
-  async initialize(server, clientInfo) {
-    const rootPath = mcp.firstRootPath(clientInfo);
-    if (this._configOption) {
-      this._context.initialize(rootPath, (0, import_configLoader.resolveConfigLocation)(this._configOption));
-      return;
-    }
-    if (rootPath) {
-      this._context.initialize(rootPath, (0, import_configLoader.resolveConfigLocation)(rootPath));
-      return;
-    }
-    this._context.initialize(rootPath, (0, import_configLoader.resolveConfigLocation)(void 0));
+  async initialize(clientInfo) {
+    this._context = new import_testContext.TestContext(clientInfo, this._configOption, this._options);
   }
   async listTools() {
-    return [
-      ...this._tools.map((tool) => mcp.toMcpTool(tool.schema)),
-      ...import_tools.browserTools.map((tool) => mcp.toMcpTool(tool.schema, { addIntent: true }))
-    ];
-  }
-  async afterCallTool(name, args, result) {
-    if (!import_tools.browserTools.find((tool) => tool.schema.name === name))
-      return;
-    const response = (0, import_response.parseResponse)(result);
-    if (response && !response.isError && response.code && typeof args?.["intent"] === "string")
-      this._context.generatorJournal?.logStep(args["intent"], response.code);
+    return this._tools.map((tool) => mcp.toMcpTool(tool.schema));
   }
-  async callTool(name, args, progress) {
+  async callTool(name, args) {
     const tool = this._tools.find((tool2) => tool2.schema.name === name);
     if (!tool)
       throw new Error(`Tool not found: ${name}. Available tools: ${this._tools.map((tool2) => tool2.schema.name).join(", ")}`);
-    const parsedArguments = tool.schema.inputSchema.parse(args || {});
-    return await tool.handle(this._context, parsedArguments, progress);
+    try {
+      return await tool.handle(this._context, tool.schema.inputSchema.parse(args || {}));
+    } catch (e) {
+      return { content: [{ type: "text", text: String(e) }], isError: true };
+    }
   }
   serverClosed() {
     void this._context.close();
   }
 }
+const typesWithIntent = ["action", "assertion", "input"];
+function wrapBrowserTool(tool) {
+  const inputSchema = typesWithIntent.includes(tool.schema.type) ? tool.schema.inputSchema.extend({
+    intent: import_bundle.z.string().describe("The intent of the call, for example the test step description plan idea")
+  }) : tool.schema.inputSchema;
+  return {
+    schema: {
+      ...tool.schema,
+      inputSchema
+    },
+    handle: async (context, params) => {
+      const response = await context.sendMessageToPausedTest({ callTool: { name: tool.schema.name, arguments: params } });
+      return response.callTool;
+    }
+  };
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   TestServerBackend