playwright 1.55.1 → 1.56.1

package/lib/mcp/test/testBackend.js

@@ -0,0 +1,97 @@
+"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 testBackend_exports = {};
+__export(testBackend_exports, {
+  TestServerBackend: () => TestServerBackend
+});
+module.exports = __toCommonJS(testBackend_exports);
+var mcp = __toESM(require("../sdk/exports"));
+var import_testContext = require("./testContext");
+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");
+class TestServerBackend {
+  constructor(configOption, options) {
+    this.name = "Playwright";
+    this.version = "0.0.1";
+    this._tools = [
+      plannerTools.setupPage,
+      generatorTools.setupPage,
+      generatorTools.generatorReadLog,
+      generatorTools.generatorWriteTest,
+      testTools.listTests,
+      testTools.runTests,
+      testTools.debugTest
+    ];
+    this._context = new import_testContext.TestContext(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 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);
+  }
+  async callTool(name, args, progress) {
+    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);
+  }
+  serverClosed() {
+    void this._context.close();
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  TestServerBackend
+});

package/lib/mcp/test/testContext.js

@@ -0,0 +1,176 @@
+"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 testContext_exports = {};
+__export(testContext_exports, {
+  GeneratorJournal: () => GeneratorJournal,
+  TestContext: () => TestContext
+});
+module.exports = __toCommonJS(testContext_exports);
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+var import_utils = require("playwright-core/lib/utils");
+var import_base = require("../../reporters/base");
+var import_list = __toESM(require("../../reporters/list"));
+var import_streams = require("./streams");
+var import_util = require("../../util");
+var import_testRunner = require("../../runner/testRunner");
+var import_seed = require("./seed");
+class GeneratorJournal {
+  constructor(rootPath, plan, seed) {
+    this._rootPath = rootPath;
+    this._plan = plan;
+    this._seed = seed;
+    this._steps = [];
+  }
+  logStep(title, code) {
+    if (title)
+      this._steps.push({ title, code });
+  }
+  journal() {
+    const result = [];
+    result.push(`# Plan`);
+    result.push(this._plan);
+    result.push(`# Seed file: ${import_path.default.relative(this._rootPath, this._seed.file)}`);
+    result.push("```ts");
+    result.push(this._seed.content);
+    result.push("```");
+    result.push(`# Steps`);
+    result.push(this._steps.map((step) => `### ${step.title}
+\`\`\`ts
+${step.code}
+\`\`\``).join("\n\n"));
+    result.push(bestPracticesMarkdown);
+    return result.join("\n\n");
+  }
+}
+class TestContext {
+  constructor(options) {
+    this.options = options;
+  }
+  initialize(rootPath, configLocation) {
+    this.configLocation = configLocation;
+    this.rootPath = rootPath || configLocation.configDir;
+  }
+  existingTestRunner() {
+    return this._testRunner;
+  }
+  async createTestRunner() {
+    if (this._testRunner)
+      await this._testRunner.stopTests();
+    const testRunner = new import_testRunner.TestRunner(this.configLocation, {});
+    await testRunner.initialize({});
+    this._testRunner = testRunner;
+    testRunner.on(import_testRunner.TestRunnerEvent.TestFilesChanged, (testFiles) => {
+      this._testRunner?.emit(import_testRunner.TestRunnerEvent.TestFilesChanged, testFiles);
+    });
+    this._testRunner = testRunner;
+    return testRunner;
+  }
+  async getOrCreateSeedFile(seedFile, projectName) {
+    const configDir = this.configLocation.configDir;
+    const testRunner = await this.createTestRunner();
+    const config = await testRunner.loadConfig();
+    const project = (0, import_seed.seedProject)(config, projectName);
+    if (!seedFile) {
+      seedFile = await (0, import_seed.ensureSeedTest)(project, false);
+    } else {
+      const candidateFiles = [];
+      const testDir = project.project.testDir;
+      candidateFiles.push(import_path.default.resolve(testDir, seedFile));
+      candidateFiles.push(import_path.default.resolve(configDir, seedFile));
+      candidateFiles.push(import_path.default.resolve(this.rootPath, seedFile));
+      let resolvedSeedFile;
+      for (const candidateFile of candidateFiles) {
+        if (await (0, import_util.fileExistsAsync)(candidateFile)) {
+          resolvedSeedFile = candidateFile;
+          break;
+        }
+      }
+      if (!resolvedSeedFile)
+        throw new Error("seed test not found.");
+      seedFile = resolvedSeedFile;
+    }
+    const seedFileContent = await import_fs.default.promises.readFile(seedFile, "utf8");
+    return {
+      file: seedFile,
+      content: seedFileContent,
+      projectName: project.project.name
+    };
+  }
+  async runSeedTest(seedFile, projectName, progress) {
+    const { screen } = this.createScreen(progress);
+    const configDir = this.configLocation.configDir;
+    const reporter = new import_list.default({ configDir, screen });
+    const testRunner = await this.createTestRunner();
+    const result = await testRunner.runTests(reporter, {
+      headed: !this.options?.headless,
+      locations: ["/" + (0, import_utils.escapeRegExp)(seedFile) + "/"],
+      projects: [projectName],
+      timeout: 0,
+      workers: 1,
+      pauseAtEnd: true,
+      disableConfigReporters: true,
+      failOnLoadErrors: true
+    });
+    if (result.status === "passed" && !reporter.suite?.allTests().length)
+      throw new Error("seed test not found.");
+    if (result.status !== "passed")
+      throw new Error("Errors while running the seed test.");
+  }
+  createScreen(progress) {
+    const stream = new import_streams.StringWriteStream(progress);
+    const screen = {
+      ...import_base.terminalScreen,
+      isTTY: false,
+      colors: import_utils.noColors,
+      stdout: stream,
+      stderr: stream
+    };
+    return { screen, stream };
+  }
+  async close() {
+  }
+}
+const bestPracticesMarkdown = `
+# Best practices
+- Do not improvise, do not add directives that were not asked for
+- Use clear, descriptive assertions to validate the expected behavior
+- Use reliable locators from this log
+- Use local variables for locators that are used multiple times
+- Use Playwright waiting assertions and best practices from this log
+- NEVER! use page.waitForLoadState()
+- NEVER! use page.waitForNavigation()
+- NEVER! use page.waitForTimeout()
+- NEVER! use page.evaluate()
+`;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  GeneratorJournal,
+  TestContext
+});

package/lib/mcp/test/testTool.js

@@ -0,0 +1,30 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var testTool_exports = {};
+__export(testTool_exports, {
+  defineTestTool: () => defineTestTool
+});
+module.exports = __toCommonJS(testTool_exports);
+function defineTestTool(tool) {
+  return tool;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  defineTestTool
+});

package/lib/mcp/test/testTools.js

@@ -0,0 +1,115 @@
+"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 testTools_exports = {};
+__export(testTools_exports, {
+  debugTest: () => debugTest,
+  listTests: () => listTests,
+  runTests: () => runTests
+});
+module.exports = __toCommonJS(testTools_exports);
+var import_bundle = require("../sdk/bundle");
+var import_list = __toESM(require("../../reporters/list"));
+var import_listModeReporter = __toESM(require("../../reporters/listModeReporter"));
+var import_testTool = require("./testTool");
+const listTests = (0, import_testTool.defineTestTool)({
+  schema: {
+    name: "test_list",
+    title: "List tests",
+    description: "List tests",
+    inputSchema: import_bundle.z.object({}),
+    type: "readOnly"
+  },
+  handle: async (context, _, progress) => {
+    const { screen } = context.createScreen(progress);
+    const reporter = new import_listModeReporter.default({ screen, includeTestId: true });
+    const testRunner = await context.createTestRunner();
+    await testRunner.listTests(reporter, {});
+    return { content: [] };
+  }
+});
+const runTests = (0, import_testTool.defineTestTool)({
+  schema: {
+    name: "test_run",
+    title: "Run tests",
+    description: "Run tests",
+    inputSchema: import_bundle.z.object({
+      locations: import_bundle.z.array(import_bundle.z.string()).optional().describe('Folder, file or location to run: "test/e2e" or "test/e2e/file.spec.ts" or "test/e2e/file.spec.ts:20"'),
+      projects: import_bundle.z.array(import_bundle.z.string()).optional().describe('Projects to run, projects from playwright.config.ts, by default runs all projects. Running with "chromium" is a good start')
+    }),
+    type: "readOnly"
+  },
+  handle: async (context, params, progress) => {
+    const { screen } = context.createScreen(progress);
+    const configDir = context.configLocation.configDir;
+    const reporter = new import_list.default({ configDir, screen, includeTestId: true, prefixStdio: "out" });
+    const testRunner = await context.createTestRunner();
+    await testRunner.runTests(reporter, {
+      locations: params.locations,
+      projects: params.projects,
+      disableConfigReporters: true
+    });
+    return { content: [] };
+  }
+});
+const debugTest = (0, import_testTool.defineTestTool)({
+  schema: {
+    name: "test_debug",
+    title: "Debug single test",
+    description: "Debug single test",
+    inputSchema: import_bundle.z.object({
+      test: import_bundle.z.object({
+        id: import_bundle.z.string().describe("Test ID to debug."),
+        title: import_bundle.z.string().describe("Human readable test title for granting permission to debug the test.")
+      })
+    }),
+    type: "readOnly"
+  },
+  handle: async (context, params, progress) => {
+    const { screen } = context.createScreen(progress);
+    const configDir = context.configLocation.configDir;
+    const reporter = new import_list.default({ configDir, screen, includeTestId: true, prefixStdio: "out" });
+    const testRunner = await context.createTestRunner();
+    await testRunner.runTests(reporter, {
+      headed: !context.options?.headless,
+      testIds: [params.test.id],
+      // For automatic recovery
+      timeout: 0,
+      workers: 1,
+      pauseOnError: true,
+      disableConfigReporters: true
+    });
+    return { content: [] };
+  }
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  debugTest,
+  listTests,
+  runTests
+});