@cotestdev/mcp_playwright 0.0.14 → 0.0.15

package/lib/mcp/sdk/http.js

@@ -28,61 +28,63 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var http_exports = {};
 __export(http_exports, {
-  httpAddressToString: () => httpAddressToString,
-  installHttpTransport: () => installHttpTransport,
-  startHttpServer: () => startHttpServer
+  addressToString: () => addressToString,
+  startMcpHttpServer: () => startMcpHttpServer
 });
 module.exports = __toCommonJS(http_exports);
 var import_assert = __toESM(require("assert"));
-var import_http = __toESM(require("http"));
 var import_crypto = __toESM(require("crypto"));
 var import_utilsBundle = require("playwright-core/lib/utilsBundle");
-var mcpBundle = __toESM(require("./bundle"));
+var mcpBundle = __toESM(require("playwright-core/lib/mcpBundle"));
+var import_utils = require("playwright-core/lib/utils");
 var mcpServer = __toESM(require("./server"));
 const testDebug = (0, import_utilsBundle.debug)("pw:mcp:test");
-async function startHttpServer(config, abortSignal) {
-  const { host, port } = config;
-  const httpServer = import_http.default.createServer();
-  decorateServer(httpServer);
-  await new Promise((resolve, reject) => {
-    httpServer.on("error", reject);
-    abortSignal?.addEventListener("abort", () => {
-      httpServer.close();
-      reject(new Error("Aborted"));
-    });
-    httpServer.listen(port, host, () => {
-      resolve();
-      httpServer.removeListener("error", reject);
-    });
-  });
-  return httpServer;
+async function startMcpHttpServer(config, serverBackendFactory, allowedHosts) {
+  const httpServer = (0, import_utils.createHttpServer)();
+  await (0, import_utils.startHttpServer)(httpServer, config);
+  return await installHttpTransport(httpServer, serverBackendFactory, allowedHosts);
 }
-function httpAddressToString(address) {
+function addressToString(address, options) {
   (0, import_assert.default)(address, "Could not bind server socket");
   if (typeof address === "string")
-    return address;
-  const resolvedPort = address.port;
-  let resolvedHost = address.family === "IPv4" ? address.address : `[${address.address}]`;
-  if (resolvedHost === "0.0.0.0" || resolvedHost === "[::]")
-    resolvedHost = "localhost";
-  return `http://${resolvedHost}:${resolvedPort}`;
+    throw new Error("Unexpected address type: " + address);
+  let host = address.family === "IPv4" ? address.address : `[${address.address}]`;
+  if (options.normalizeLoopback && (host === "0.0.0.0" || host === "[::]" || host === "[::1]" || host === "127.0.0.1"))
+    host = "localhost";
+  return `${options.protocol}://${host}:${address.port}`;
 }
-async function installHttpTransport(httpServer, serverBackendFactory) {
+async function installHttpTransport(httpServer, serverBackendFactory, allowedHosts) {
+  const url = addressToString(httpServer.address(), { protocol: "http", normalizeLoopback: true });
+  const host = new URL(url).host;
+  allowedHosts = (allowedHosts || [host]).map((h) => h.toLowerCase());
+  const allowAnyHost = allowedHosts.includes("*");
   const sseSessions = /* @__PURE__ */ new Map();
   const streamableSessions = /* @__PURE__ */ new Map();
   httpServer.on("request", async (req, res) => {
-    const url = new URL(`http://localhost${req.url}`);
-    if (url.pathname === "/killkillkill" && req.method === "GET") {
+    if (!allowAnyHost) {
+      const host2 = req.headers.host?.toLowerCase();
+      if (!host2) {
+        res.statusCode = 400;
+        return res.end("Missing host");
+      }
+      if (!allowedHosts.includes(host2)) {
+        res.statusCode = 403;
+        return res.end("Access is only allowed at " + allowedHosts.join(", "));
+      }
+    }
+    const url2 = new URL(`http://localhost${req.url}`);
+    if (url2.pathname === "/killkillkill" && req.method === "GET") {
       res.statusCode = 200;
       res.end("Killing process");
       process.emit("SIGINT");
       return;
     }
-    if (url.pathname.startsWith("/sse"))
-      await handleSSE(serverBackendFactory, req, res, url, sseSessions);
+    if (url2.pathname.startsWith("/sse"))
+      await handleSSE(serverBackendFactory, req, res, url2, sseSessions);
     else
       await handleStreamable(serverBackendFactory, req, res, streamableSessions);
   });
+  return url;
 }
 async function handleSSE(serverBackendFactory, req, res, url, sessions) {
   if (req.method === "POST") {
@@ -143,23 +145,8 @@ async function handleStreamable(serverBackendFactory, req, res, sessions) {
   res.statusCode = 400;
   res.end("Invalid request");
 }
-function decorateServer(server) {
-  const sockets = /* @__PURE__ */ new Set();
-  server.on("connection", (socket) => {
-    sockets.add(socket);
-    socket.once("close", () => sockets.delete(socket));
-  });
-  const close = server.close;
-  server.close = (callback) => {
-    for (const socket of sockets)
-      socket.destroy();
-    sockets.clear();
-    return close.call(server, callback);
-  };
-}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  httpAddressToString,
-  installHttpTransport,
-  startHttpServer
+  addressToString,
+  startMcpHttpServer
 });

package/lib/mcp/sdk/server.js

@@ -32,23 +32,33 @@ __export(server_exports, {
   createServer: () => createServer,
   firstRootPath: () => firstRootPath,
   start: () => start,
+  wrapInClient: () => wrapInClient,
   wrapInProcess: () => wrapInProcess
 });
 module.exports = __toCommonJS(server_exports);
 var import_url = require("url");
 var import_utilsBundle = require("playwright-core/lib/utilsBundle");
-var mcpBundle = __toESM(require("./bundle"));
+var mcpBundle = __toESM(require("playwright-core/lib/mcpBundle"));
 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);
 }
-async function wrapInProcess(backend) {
+function wrapInProcess(backend) {
   const server = createServer("Internal", "0.0.0", backend, false);
   return new import_inProcessTransport.InProcessTransport(server);
 }
+async function wrapInClient(backend, options) {
+  const server = createServer("Internal", "0.0.0", backend, false);
+  const transport = new import_inProcessTransport.InProcessTransport(server);
+  const client = new mcpBundle.Client({ name: options.name, version: options.version });
+  await client.connect(transport);
+  await client.ping();
+  return client;
+}
 function createServer(name, version, backend, runHeartbeat) {
   const server = new mcpBundle.Server({ name, version }, {
     capabilities: {
@@ -61,13 +71,30 @@ function createServer(name, version, backend, runHeartbeat) {
     return { tools };
   });
   let initializePromise;
-  server.setRequestHandler(mcpBundle.CallToolRequestSchema, async (request) => {
+  server.setRequestHandler(mcpBundle.CallToolRequestSchema, async (request, extra) => {
     serverDebug("callTool", request);
+    const progressToken = request.params._meta?.progressToken;
+    let progressCounter = 0;
+    const progress = progressToken ? (params) => {
+      extra.sendNotification({
+        method: "notifications/progress",
+        params: {
+          progressToken,
+          progress: params.progress ?? ++progressCounter,
+          total: params.total,
+          message: params.message
+        }
+      }).catch(serverDebug);
+    } : () => {
+    };
     try {
       if (!initializePromise)
         initializePromise = initializeServer(server, backend, runHeartbeat);
       await initializePromise;
-      return await backend.callTool(request.params.name, request.params.arguments || {});
+      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) }],
@@ -94,7 +121,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);
 };
@@ -123,9 +150,7 @@ async function start(serverBackendFactory, options) {
     await connect(serverBackendFactory, new mcpBundle.StdioServerTransport(), false);
     return;
   }
-  const httpServer = await (0, import_http.startHttpServer)(options);
-  await (0, import_http.installHttpTransport)(httpServer, serverBackendFactory);
-  const url = (0, import_http.httpAddressToString)(httpServer.address());
+  const url = await (0, import_http.startMcpHttpServer)(options, serverBackendFactory, options.allowedHosts);
   const mcpConfig = { mcpServers: {} };
   mcpConfig.mcpServers[serverBackendFactory.nameInConfig] = {
     url: `${url}/mcp`
@@ -143,7 +168,33 @@ 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 = [];
+  const testParts = [];
+  for (const part of result.content) {
+    if (part.type === "text") {
+      testParts.push(part.text);
+      continue;
+    }
+    if (testParts.length > 0) {
+      content.push({ type: "text", text: testParts.join("\n") });
+      testParts.length = 0;
+    }
+    content.push(part);
+  }
+  if (testParts.length > 0)
+    content.push({ type: "text", text: testParts.join("\n") });
+  return {
+    ...result,
+    content
+  };
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -151,5 +202,6 @@ function firstRootPath(clientInfo) {
   createServer,
   firstRootPath,
   start,
+  wrapInClient,
   wrapInProcess
 });

package/lib/mcp/sdk/tool.js

@@ -22,16 +22,17 @@ __export(tool_exports, {
   toMcpTool: () => toMcpTool
 });
 module.exports = __toCommonJS(tool_exports);
-var import_bundle = require("../sdk/bundle");
+var import_mcpBundle = require("playwright-core/lib/mcpBundle");
 function toMcpTool(tool) {
+  const readOnly = tool.type === "readOnly" || tool.type === "assertion";
   return {
     name: tool.name,
     description: tool.description,
-    inputSchema: (0, import_bundle.zodToJsonSchema)(tool.inputSchema, { strictUnions: true }),
+    inputSchema: (0, import_mcpBundle.zodToJsonSchema)(tool.inputSchema, { strictUnions: true }),
     annotations: {
       title: tool.title,
-      readOnlyHint: tool.type === "readOnly",
-      destructiveHint: tool.type === "destructive",
+      readOnlyHint: readOnly,
+      destructiveHint: !readOnly,
       openWorldHint: true
     }
   };

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,76 +15,84 @@ 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,
-  runBrowserBackendOnError: () => runBrowserBackendOnError
+  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");
-async function runBrowserBackendOnError(page, message) {
-  const testInfo = (0, import_globals.currentTestInfo)();
-  if (!testInfo || !testInfo._pauseOnError())
-    return;
-  const config = {
-    ...import_config.defaultConfig,
-    capabilities: ["testing"]
-  };
-  const snapshot = await page._snapshotForAI();
-  const introMessage = `### Paused on error:
-${(0, import_util.stripAnsiEscapes)(message())}
-
-### Current page snapshot:
-${snapshot}
-
-### Task
-Try recovering from the error prior to continuing`;
-  await mcp.runOnPauseBackendLoop(new import_browserServerBackend.BrowserServerBackend(config, identityFactory(page.context())), introMessage);
-}
-async function runBrowserBackendAtEnd(context) {
-  const testInfo = (0, import_globals.currentTestInfo)();
-  if (!testInfo || !testInfo._pauseAtEnd())
-    return;
-  const page = context.pages()[0];
-  if (!page)
-    return;
-  const snapshot = await page._snapshotForAI();
-  const introMessage = `### Paused at end of test. ready for interaction
-
-### Current page snapshot:
-${snapshot}`;
-  const config = {
-    ...import_config.defaultConfig,
-    capabilities: ["testing"]
+var import_tab = require("../browser/tab");
+var import_util = require("../../util");
+var import_browserContextFactory = require("../browser/browserContextFactory");
+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"] }, (0, import_browserContextFactory.identityBrowserContextFactory)(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");
   };
-  await mcp.runOnPauseBackendLoop(new import_browserServerBackend.BrowserServerBackend(config, identityFactory(context)), introMessage);
 }
-function identityFactory(browserContext) {
-  return {
-    createContext: async (clientInfo, abortSignal, toolName) => {
-      return {
-        browserContext,
-        close: async () => {
-        }
-      };
+async function generatePausedMessage(testInfo, context) {
+  const lines = [];
+  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";
+    lines.push(
+      "",
+      `### Page ${stateSuffix}`,
+      `- Page URL: ${page.url()}`,
+      `- Page Title: ${await page.title()}`.trim()
+    );
+    let console = testInfo.errors.length ? await import_tab.Tab.collectConsoleMessages(page) : [];
+    console = console.filter((msg) => msg.type === "error");
+    if (console.length) {
+      lines.push("- Console Messages:");
+      for (const message of console)
+        lines.push(`  - ${message.toString()}`);
     }
-  };
+    lines.push(
+      `- Page Snapshot:`,
+      "```yaml",
+      (await page._snapshotForAI()).full,
+      "```"
+    );
+  }
+  lines.push("");
+  if (testInfo.errors.length)
+    lines.push(`### Task`, `Try recovering from the error prior to continuing`);
+  return lines.join("\n");
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  runBrowserBackendAtEnd,
-  runBrowserBackendOnError
+  createCustomMessageHandler
 });

package/lib/mcp/test/generatorTools.js

@@ -0,0 +1,122 @@
+"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)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  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 generatorTools_exports = {};
+__export(generatorTools_exports, {
+  generatorReadLog: () => generatorReadLog,
+  generatorWriteTest: () => generatorWriteTest,
+  setupPage: () => setupPage
+});
+module.exports = __toCommonJS(generatorTools_exports);
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+var import_mcpBundle = require("playwright-core/lib/mcpBundle");
+var import_testTool = require("./testTool");
+var import_testContext = require("./testContext");
+const setupPage = (0, import_testTool.defineTestTool)({
+  schema: {
+    name: "generator_setup_page",
+    title: "Setup generator page",
+    description: "Setup the page for test.",
+    inputSchema: import_mcpBundle.z.object({
+      plan: import_mcpBundle.z.string().describe("The plan for the test. This should be the actual test plan with all the steps."),
+      project: import_mcpBundle.z.string().optional().describe('Project to use for setup. For example: "chromium", if no project is provided uses the first project in the config.'),
+      seedFile: import_mcpBundle.z.string().optional().describe('A seed file contains a single test that is used to setup the page for testing, for example: "tests/seed.spec.ts". If no seed file is provided, a default seed file is created.')
+    }),
+    type: "readOnly"
+  },
+  handle: async (context, params) => {
+    const seed = await context.getOrCreateSeedFile(params.seedFile, params.project);
+    context.generatorJournal = new import_testContext.GeneratorJournal(context.rootPath, params.plan, seed);
+    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)({
+  schema: {
+    name: "generator_read_log",
+    title: "Retrieve test log",
+    description: "Retrieve the performed test log",
+    inputSchema: import_mcpBundle.z.object({}),
+    type: "readOnly"
+  },
+  handle: async (context) => {
+    if (!context.generatorJournal)
+      throw new Error(`Please setup page using "${setupPage.schema.name}" first.`);
+    const result = context.generatorJournal.journal();
+    return { content: [{
+      type: "text",
+      text: result
+    }] };
+  }
+});
+const generatorWriteTest = (0, import_testTool.defineTestTool)({
+  schema: {
+    name: "generator_write_test",
+    title: "Write test",
+    description: "Write the generated test to the test file",
+    inputSchema: import_mcpBundle.z.object({
+      fileName: import_mcpBundle.z.string().describe("The file to write the test to"),
+      code: import_mcpBundle.z.string().describe("The generated test code")
+    }),
+    type: "readOnly"
+  },
+  handle: async (context, params) => {
+    if (!context.generatorJournal)
+      throw new Error(`Please setup page using "${setupPage.schema.name}" first.`);
+    const testRunner = context.existingTestRunner();
+    if (!testRunner)
+      throw new Error("No test runner found, please setup page and perform actions first.");
+    const config = await testRunner.loadConfig();
+    const dirs = [];
+    for (const project of config.projects) {
+      const testDir = import_path.default.relative(context.rootPath, project.project.testDir).replace(/\\/g, "/");
+      const fileName = params.fileName.replace(/\\/g, "/");
+      if (fileName.startsWith(testDir)) {
+        const resolvedFile = import_path.default.resolve(context.rootPath, fileName);
+        await import_fs.default.promises.mkdir(import_path.default.dirname(resolvedFile), { recursive: true });
+        await import_fs.default.promises.writeFile(resolvedFile, params.code);
+        return {
+          content: [{
+            type: "text",
+            text: `### Result
+Test written to ${params.fileName}`
+          }]
+        };
+      }
+      dirs.push(testDir);
+    }
+    throw new Error(`Test file did not match any of the test dirs: ${dirs.join(", ")}`);
+  }
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  generatorReadLog,
+  generatorWriteTest,
+  setupPage
+});