phantomwright-driver 1.57.0

package/lib/mcp/test/testContext.js

@@ -0,0 +1,279 @@
+"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,
+  createScreen: () => createScreen
+});
+module.exports = __toCommonJS(testContext_exports);
+var import_fs = __toESM(require("fs"));
+var import_os = __toESM(require("os"));
+var import_path = __toESM(require("path"));
+var import_utils = require("phantomwright-driver-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");
+var import_exports = require("../sdk/exports");
+var import_configLoader = require("../../common/configLoader");
+var import_response = require("../browser/response");
+var import_log = require("../log");
+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(clientInfo, configPath, options) {
+    this._clientInfo = clientInfo;
+    const rootPath = (0, import_exports.firstRootPath)(clientInfo);
+    this._configLocation = (0, import_configLoader.resolveConfigLocation)(configPath || rootPath);
+    this.rootPath = rootPath || this._configLocation.configDir;
+    if (options?.headless !== void 0)
+      this.computedHeaded = !options.headless;
+    else
+      this.computedHeaded = !process.env.CI && !(import_os.default.platform() === "linux" && !process.env.DISPLAY);
+  }
+  existingTestRunner() {
+    return this._testRunnerAndScreen?.testRunner;
+  }
+  async _cleanupTestRunner() {
+    if (!this._testRunnerAndScreen)
+      return;
+    await this._testRunnerAndScreen.testRunner.stopTests();
+    this._testRunnerAndScreen.claimStdio();
+    try {
+      await this._testRunnerAndScreen.testRunner.runGlobalTeardown();
+    } finally {
+      this._testRunnerAndScreen.releaseStdio();
+      this._testRunnerAndScreen = void 0;
+    }
+  }
+  async createTestRunner() {
+    await this._cleanupTestRunner();
+    const testRunner = new import_testRunner.TestRunner(this._configLocation, {});
+    await testRunner.initialize({});
+    const testPaused = new import_utils.ManualPromise();
+    const testRunnerAndScreen = {
+      ...createScreen(),
+      testRunner,
+      waitForTestPaused: () => testPaused
+    };
+    this._testRunnerAndScreen = testRunnerAndScreen;
+    testRunner.on(import_testRunner.TestRunnerEvent.TestPaused, (params) => {
+      testRunnerAndScreen.sendMessageToPausedTest = params.sendMessage;
+      testPaused.resolve();
+    });
+    return testRunnerAndScreen;
+  }
+  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.ensureSeedFile)(project);
+    } 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) {
+    const result = await this.runTestsWithGlobalSetupAndPossiblePause({
+      headed: this.computedHeaded,
+      locations: ["/" + (0, import_utils.escapeRegExp)(seedFile) + "/"],
+      projects: [projectName],
+      timeout: 0,
+      workers: 1,
+      pauseAtEnd: true,
+      disableConfigReporters: true,
+      failOnLoadErrors: true
+    });
+    if (result.status === "passed")
+      result.output += "\nError: seed test not found.";
+    else if (result.status !== "paused")
+      result.output += "\nError while running the seed test.";
+    return result;
+  }
+  async runTestsWithGlobalSetupAndPossiblePause(params) {
+    const configDir = this._configLocation.configDir;
+    const testRunnerAndScreen = await this.createTestRunner();
+    const { testRunner, screen, claimStdio, releaseStdio } = testRunnerAndScreen;
+    claimStdio();
+    try {
+      const setupReporter = new import_list.default({ configDir, screen, includeTestId: true });
+      const { status: status2 } = await testRunner.runGlobalSetup([setupReporter]);
+      if (status2 !== "passed")
+        return { output: testRunnerAndScreen.output.join("\n"), status: status2 };
+    } finally {
+      releaseStdio();
+    }
+    let status = "passed";
+    const cleanup = async () => {
+      claimStdio();
+      try {
+        const result = await testRunner.runGlobalTeardown();
+        if (status === "passed")
+          status = result.status;
+      } finally {
+        releaseStdio();
+      }
+    };
+    try {
+      const reporter = new import_list.default({ configDir, screen, includeTestId: true });
+      status = await Promise.race([
+        testRunner.runTests(reporter, params).then((result) => result.status),
+        testRunnerAndScreen.waitForTestPaused().then(() => "paused")
+      ]);
+      if (status === "paused") {
+        const response = await testRunnerAndScreen.sendMessageToPausedTest({ request: { initialize: { clientInfo: this._clientInfo } } });
+        if (response.error)
+          throw new Error(response.error.message);
+        testRunnerAndScreen.output.push(response.response.initialize.pausedMessage);
+        return { output: testRunnerAndScreen.output.join("\n"), status };
+      }
+    } catch (e) {
+      status = "failed";
+      testRunnerAndScreen.output.push(String(e));
+      await cleanup();
+      return { output: testRunnerAndScreen.output.join("\n"), status };
+    }
+    await cleanup();
+    return { output: testRunnerAndScreen.output.join("\n"), status };
+  }
+  async close() {
+    await this._cleanupTestRunner().catch(import_log.logUnhandledError);
+  }
+  async sendMessageToPausedTest(request) {
+    const sendMessage = this._testRunnerAndScreen?.sendMessageToPausedTest;
+    if (!sendMessage)
+      throw new Error("Must setup test before interacting with the page");
+    const result = await sendMessage({ request });
+    if (result.error)
+      throw new Error(result.error.message);
+    if (typeof request?.callTool?.arguments?.["intent"] === "string") {
+      const response = (0, import_response.parseResponse)(result.response.callTool);
+      if (response && !response.isError && response.code)
+        this.generatorJournal?.logStep(request.callTool.arguments["intent"], response.code);
+    }
+    return result.response;
+  }
+}
+function createScreen() {
+  const output = [];
+  const stdout = new import_streams.StringWriteStream(output, "stdout");
+  const stderr = new import_streams.StringWriteStream(output, "stderr");
+  const screen = {
+    ...import_base.terminalScreen,
+    isTTY: false,
+    colors: import_utils.noColors,
+    stdout,
+    stderr
+  };
+  const originalStdoutWrite = process.stdout.write;
+  const originalStderrWrite = process.stderr.write;
+  const claimStdio = () => {
+    process.stdout.write = (chunk) => {
+      stdout.write(chunk);
+      return true;
+    };
+    process.stderr.write = (chunk) => {
+      stderr.write(chunk);
+      return true;
+    };
+  };
+  const releaseStdio = () => {
+    process.stdout.write = originalStdoutWrite;
+    process.stderr.write = originalStderrWrite;
+  };
+  return { screen, claimStdio, releaseStdio, output };
+}
+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,
+  createScreen
+});

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,106 @@
+"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_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) => {
+    const { testRunner, screen, output } = await context.createTestRunner();
+    const reporter = new import_listModeReporter.default({ screen, includeTestId: true });
+    await testRunner.listTests(reporter, {});
+    return { content: output.map((text) => ({ type: "text", text })) };
+  }
+});
+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) => {
+    const { output } = await context.runTestsWithGlobalSetupAndPossiblePause({
+      locations: params.locations,
+      projects: params.projects,
+      disableConfigReporters: true
+    });
+    return { content: [{ type: "text", text: output }] };
+  }
+});
+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) => {
+    const { output, status } = await context.runTestsWithGlobalSetupAndPossiblePause({
+      headed: context.computedHeaded,
+      testIds: [params.test.id],
+      // For automatic recovery
+      timeout: 0,
+      workers: 1,
+      pauseOnError: true,
+      disableConfigReporters: true,
+      actionTimeout: 5e3
+    });
+    return { content: [{ type: "text", text: output }], isError: status !== "paused" && status !== "passed" };
+  }
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  debugTest,
+  listTests,
+  runTests
+});