playwright-codegen-pro-core 1.0.0

package/lib/tools/cli-daemon/daemon.js

@@ -0,0 +1,178 @@
+"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 daemon_exports = {};
+__export(daemon_exports, {
+  startCliDaemonServer: () => startCliDaemonServer
+});
+module.exports = __toCommonJS(daemon_exports);
+var import_fs = __toESM(require("fs"));
+var import_net = __toESM(require("net"));
+var import_os = __toESM(require("os"));
+var import_path = __toESM(require("path"));
+var import_utils = require("../../utils");
+var import_utilsBundle = require("../../utilsBundle");
+var import_network = require("../../server/utils/network");
+var import_processLauncher = require("../../server/utils/processLauncher");
+var import_browserBackend = require("../backend/browserBackend");
+var import_tools = require("../backend/tools");
+var import_command = require("./command");
+var import_commands = require("./commands");
+var import_socketConnection = require("../utils/socketConnection");
+var import_registry = require("../cli-client/registry");
+const daemonDebug = (0, import_utilsBundle.debug)("pw:daemon");
+async function socketExists(socketPath) {
+  try {
+    const stat = await import_fs.default.promises.stat(socketPath);
+    if (stat?.isSocket())
+      return true;
+  } catch (e) {
+  }
+  return false;
+}
+async function startCliDaemonServer(sessionName, browserContext, browserInfo, contextConfig = {}, clientInfo = (0, import_registry.createClientInfo)(), options) {
+  const sessionConfig = createSessionConfig(clientInfo, sessionName, browserInfo, options);
+  const { socketPath } = sessionConfig;
+  if (process.platform !== "win32" && await socketExists(socketPath)) {
+    daemonDebug(`Socket already exists, removing: ${socketPath}`);
+    try {
+      await import_fs.default.promises.unlink(socketPath);
+    } catch (error) {
+      daemonDebug(`Failed to remove existing socket: ${error}`);
+      throw error;
+    }
+  }
+  const backend = new import_browserBackend.BrowserBackend(contextConfig, browserContext, import_tools.browserTools);
+  await backend.initialize({ cwd: process.cwd() });
+  await import_fs.default.promises.mkdir(import_path.default.dirname(socketPath), { recursive: true });
+  if (browserContext.isClosed())
+    throw new Error("Browser context was closed before the daemon could start");
+  const server = import_net.default.createServer((socket) => {
+    daemonDebug("new client connection");
+    const connection = new import_socketConnection.SocketConnection(socket);
+    connection.onclose = () => {
+      daemonDebug("client disconnected");
+    };
+    connection.onmessage = async (message) => {
+      const { id, method, params } = message;
+      try {
+        daemonDebug("received command", method);
+        if (method === "stop") {
+          daemonDebug("stop command received, shutting down");
+          await deleteSessionFile(clientInfo, sessionConfig);
+          const sendAck = async () => connection.send({ id, result: "ok" }).catch(() => {
+          });
+          if (options?.exitOnClose)
+            (0, import_processLauncher.gracefullyProcessExitDoNotHang)(0, () => sendAck());
+          else
+            await sendAck();
+        } else if (method === "run") {
+          const { toolName, toolParams } = parseCliCommand(params.args);
+          if (params.cwd)
+            toolParams._meta = { cwd: params.cwd };
+          const response = await backend.callTool(toolName, toolParams);
+          await connection.send({ id, result: formatResult(response) });
+        } else {
+          throw new Error(`Unknown method: ${method}`);
+        }
+      } catch (e) {
+        daemonDebug("command failed", e);
+        const error = process.env.PWDEBUGIMPL ? e.stack || e.message : e.message;
+        connection.send({ id, error }).catch(() => {
+        });
+      }
+    };
+  });
+  (0, import_network.decorateServer)(server);
+  browserContext.on("close", () => Promise.resolve().then(async () => {
+    await deleteSessionFile(clientInfo, sessionConfig);
+    if (options?.exitOnClose)
+      (0, import_processLauncher.gracefullyProcessExitDoNotHang)(0);
+  }));
+  await new Promise((resolve, reject) => {
+    server.on("error", (error) => {
+      daemonDebug(`server error: ${error.message}`);
+      reject(error);
+    });
+    server.listen(socketPath, () => resolve());
+  });
+  await saveSessionFile(clientInfo, sessionConfig);
+  return socketPath;
+}
+async function saveSessionFile(clientInfo, sessionConfig) {
+  await import_fs.default.promises.mkdir(clientInfo.daemonProfilesDir, { recursive: true });
+  const sessionFile = import_path.default.join(clientInfo.daemonProfilesDir, `${sessionConfig.name}.session`);
+  await import_fs.default.promises.writeFile(sessionFile, JSON.stringify(sessionConfig, null, 2));
+}
+async function deleteSessionFile(clientInfo, sessionConfig) {
+  await import_fs.default.promises.unlink(sessionConfig.socketPath).catch(() => {
+  });
+  if (!sessionConfig.cli.persistent) {
+    const sessionFile = import_path.default.join(clientInfo.daemonProfilesDir, `${sessionConfig.name}.session`);
+    await import_fs.default.promises.rm(sessionFile).catch(() => {
+    });
+  }
+}
+function formatResult(result) {
+  const isError = result.isError;
+  const text = result.content[0].type === "text" ? result.content[0].text : void 0;
+  return { isError, text };
+}
+function parseCliCommand(args) {
+  const command = import_commands.commands[args._[0]];
+  if (!command)
+    throw new Error("Command is required");
+  return (0, import_command.parseCommand)(command, args);
+}
+function daemonSocketPath(clientInfo, sessionName) {
+  const userNameHash = (0, import_utils.calculateSha1)(process.env.USERNAME || "default").slice(0, 8);
+  const socketName = `${sessionName}-${userNameHash}.sock`;
+  if (process.platform === "win32")
+    return `\\\\.\\pipe\\${clientInfo.workspaceDirHash}-${socketName}`;
+  const socketsDir = process.env.PLAYWRIGHT_DAEMON_SOCKETS_DIR || import_path.default.join(import_os.default.tmpdir(), "playwright-cli");
+  return import_path.default.join(socketsDir, clientInfo.workspaceDirHash, socketName);
+}
+function createSessionConfig(clientInfo, sessionName, browserInfo, options = {}) {
+  return {
+    name: sessionName,
+    version: clientInfo.version,
+    timestamp: Date.now(),
+    socketPath: daemonSocketPath(clientInfo, sessionName),
+    workspaceDir: clientInfo.workspaceDir,
+    cli: { persistent: options.persistent },
+    browser: {
+      browserName: browserInfo.browserName,
+      launchOptions: browserInfo.launchOptions,
+      userDataDir: browserInfo.userDataDir
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  startCliDaemonServer
+});

package/lib/tools/cli-daemon/helpGenerator.js

@@ -0,0 +1,173 @@
+"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 helpGenerator_exports = {};
+__export(helpGenerator_exports, {
+  generateHelp: () => generateHelp,
+  generateHelpJSON: () => generateHelpJSON,
+  generateReadme: () => generateReadme
+});
+module.exports = __toCommonJS(helpGenerator_exports);
+var import_mcpBundle = require("../../mcpBundle");
+var import_commands = require("./commands");
+function commandArgs(command) {
+  const args = [];
+  const shape = command.args ? command.args.shape : {};
+  for (const [name, schema] of Object.entries(shape)) {
+    const zodSchema = schema;
+    const description = zodSchema.description ?? "";
+    args.push({ name, description, optional: zodSchema.safeParse(void 0).success });
+  }
+  return args;
+}
+function commandArgsText(args) {
+  return args.map((a) => a.optional ? `[${a.name}]` : `<${a.name}>`).join(" ");
+}
+function generateCommandHelp(command) {
+  const args = commandArgs(command);
+  const lines = [
+    `playwright-cli ${command.name} ${commandArgsText(args)}`,
+    "",
+    command.description,
+    ""
+  ];
+  if (args.length) {
+    lines.push("Arguments:");
+    lines.push(...args.map((a) => formatWithGap(`  ${a.optional ? `[${a.name}]` : `<${a.name}>`}`, a.description.toLowerCase())));
+  }
+  if (command.options) {
+    lines.push("Options:");
+    const optionsShape = command.options.shape;
+    for (const [name, schema] of Object.entries(optionsShape)) {
+      const zodSchema = schema;
+      const description = (zodSchema.description ?? "").toLowerCase();
+      lines.push(formatWithGap(`  --${name}`, description));
+    }
+  }
+  return lines.join("\n");
+}
+const categories = [
+  { name: "core", title: "Core" },
+  { name: "navigation", title: "Navigation" },
+  { name: "keyboard", title: "Keyboard" },
+  { name: "mouse", title: "Mouse" },
+  { name: "export", title: "Save as" },
+  { name: "tabs", title: "Tabs" },
+  { name: "storage", title: "Storage" },
+  { name: "network", title: "Network" },
+  { name: "devtools", title: "DevTools" },
+  { name: "install", title: "Install" },
+  { name: "config", title: "Configuration" },
+  { name: "browsers", title: "Browser sessions" }
+];
+function generateHelp() {
+  const lines = [];
+  lines.push("Usage: playwright-cli <command> [args] [options]");
+  lines.push("Usage: playwright-cli -s=<session> <command> [args] [options]");
+  const commandsByCategory = /* @__PURE__ */ new Map();
+  for (const c of categories)
+    commandsByCategory.set(c.name, []);
+  for (const command of Object.values(import_commands.commands)) {
+    if (command.hidden)
+      continue;
+    commandsByCategory.get(command.category).push(command);
+  }
+  for (const c of categories) {
+    const cc = commandsByCategory.get(c.name);
+    if (!cc.length)
+      continue;
+    lines.push(`
+${c.title}:`);
+    for (const command of cc)
+      lines.push(generateHelpEntry(command));
+  }
+  lines.push("\nGlobal options:");
+  lines.push(formatWithGap("  --help [command]", "print help"));
+  lines.push(formatWithGap("  --version", "print version"));
+  return lines.join("\n");
+}
+function generateReadme() {
+  const lines = [];
+  lines.push("\n## Commands");
+  const commandsByCategory = /* @__PURE__ */ new Map();
+  for (const c of categories)
+    commandsByCategory.set(c.name, []);
+  for (const command of Object.values(import_commands.commands))
+    commandsByCategory.get(command.category).push(command);
+  for (const c of categories) {
+    const cc = commandsByCategory.get(c.name);
+    if (!cc.length)
+      continue;
+    lines.push(`
+### ${c.title}
+`);
+    lines.push("```bash");
+    for (const command of cc)
+      lines.push(generateReadmeEntry(command));
+    lines.push("```");
+  }
+  return lines.join("\n");
+}
+function generateHelpEntry(command) {
+  const args = commandArgs(command);
+  const prefix = `  ${command.name} ${commandArgsText(args)}`;
+  const suffix = command.description.toLowerCase();
+  return formatWithGap(prefix, suffix);
+}
+function generateReadmeEntry(command) {
+  const args = commandArgs(command);
+  const prefix = `playwright-cli ${command.name} ${commandArgsText(args)}`;
+  const suffix = "# " + command.description.toLowerCase();
+  return formatWithGap(prefix, suffix, 40);
+}
+function unwrapZodType(schema) {
+  if ("unwrap" in schema && typeof schema.unwrap === "function")
+    return unwrapZodType(schema.unwrap());
+  return schema;
+}
+function generateHelpJSON() {
+  const booleanOptions = /* @__PURE__ */ new Set();
+  for (const command of Object.values(import_commands.commands)) {
+    if (!command.options)
+      continue;
+    const optionsShape = command.options.shape;
+    for (const [name, schema] of Object.entries(optionsShape)) {
+      const innerSchema = unwrapZodType(schema);
+      if (innerSchema instanceof import_mcpBundle.z.ZodBoolean)
+        booleanOptions.add(name);
+    }
+  }
+  const help = {
+    global: generateHelp(),
+    commands: Object.fromEntries(
+      Object.entries(import_commands.commands).map(([name, command]) => [name, generateCommandHelp(command)])
+    ),
+    booleanOptions: [...booleanOptions]
+  };
+  return help;
+}
+function formatWithGap(prefix, text, threshold = 30) {
+  const indent = Math.max(1, threshold - prefix.length);
+  return prefix + " ".repeat(indent) + text;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  generateHelp,
+  generateHelpJSON,
+  generateReadme
+});

package/lib/tools/cli-daemon/program.js

@@ -0,0 +1,118 @@
+"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 program_exports = {};
+__export(program_exports, {
+  resolveCLIConfig: () => resolveCLIConfig
+});
+module.exports = __toCommonJS(program_exports);
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+var import_daemon = require("./daemon");
+var import_watchdog = require("../mcp/watchdog");
+var import_browserFactory = require("../mcp/browserFactory");
+var configUtils = __toESM(require("../mcp/config"));
+var import_registry = require("../cli-client/registry");
+var import_utilsBundle = require("../../utilsBundle");
+import_utilsBundle.program.argument("[session-name]", "name of the session to create or connect to", "default").option("--headed", "run in headed mode (non-headless)").option("--extension", "run with the extension").option("--browser <name>", "browser to use (chromium, chrome, firefox, webkit)").option("--persistent", "use a persistent browser context").option("--profile <path>", "path to the user data dir").option("--config <path>", "path to the config file").option("--attach <name-or-endpoint>", "attach to a running Playwright browser by name or endpoint").action(async (sessionName, options) => {
+  (0, import_watchdog.setupExitWatchdog)();
+  const clientInfo = (0, import_registry.createClientInfo)();
+  const mcpConfig = await resolveCLIConfig(clientInfo, sessionName, options);
+  const clientInfoEx = {
+    cwd: process.cwd(),
+    sessionName,
+    workspaceDir: clientInfo.workspaceDir
+  };
+  try {
+    const { browser, browserInfo } = await (0, import_browserFactory.createBrowserWithInfo)(mcpConfig, clientInfoEx);
+    const browserContext = mcpConfig.browser.isolated ? await browser.newContext(mcpConfig.browser.contextOptions) : browser.contexts()[0];
+    if (!browserContext)
+      throw new Error("Error: unable to connect to a browser that does not have any contexts");
+    const persistent = options.persistent || options.profile || mcpConfig.browser.userDataDir ? true : void 0;
+    const socketPath = await (0, import_daemon.startCliDaemonServer)(sessionName, browserContext, browserInfo, mcpConfig, clientInfo, { persistent, exitOnClose: true });
+    console.log(`### Success
+Daemon listening on ${socketPath}`);
+    console.log("<EOF>");
+  } catch (error) {
+    const message = process.env.PWDEBUGIMPL ? error.stack || error.message : error.message;
+    console.log(`### Error
+${message}`);
+    console.log("<EOF>");
+  }
+});
+void import_utilsBundle.program.parseAsync();
+function defaultConfigFile() {
+  return import_path.default.resolve(".playwright", "cli.config.json");
+}
+async function resolveCLIConfig(clientInfo, sessionName, options) {
+  const config = options.config ? import_path.default.resolve(options.config) : void 0;
+  try {
+    if (!config && import_fs.default.existsSync(defaultConfigFile()))
+      options.config = defaultConfigFile();
+  } catch {
+  }
+  const daemonOverrides = configUtils.configFromCLIOptions({
+    config: options.config,
+    browser: options.browser,
+    headless: options.headed ? false : void 0,
+    extension: options.extension,
+    userDataDir: options.profile,
+    snapshotMode: "full"
+  });
+  daemonOverrides.browser.remoteEndpoint = options.attach;
+  const envOverrides = configUtils.configFromEnv();
+  const configFile = envOverrides.configFile ?? daemonOverrides.configFile;
+  const configInFile = await configUtils.loadConfig(configFile);
+  let result = configUtils.mergeConfig(configUtils.defaultConfig, {
+    browser: {
+      launchOptions: {
+        headless: true
+      }
+    }
+  });
+  result = configUtils.mergeConfig(result, configInFile);
+  result = configUtils.mergeConfig(result, daemonOverrides);
+  result = configUtils.mergeConfig(result, envOverrides);
+  if (result.browser.isolated === void 0)
+    result.browser.isolated = !options.profile && !options.persistent && !result.browser.userDataDir && !result.browser.remoteEndpoint && !result.extension;
+  if (!result.extension && !result.browser.isolated && !result.browser.userDataDir && !result.browser.remoteEndpoint) {
+    const browserToken = result.browser.launchOptions?.channel ?? result.browser?.browserName;
+    const userDataDir = import_path.default.resolve(clientInfo.daemonProfilesDir, `ud-${sessionName}-${browserToken}`);
+    result.browser.userDataDir = userDataDir;
+  }
+  result.configFile = configFile;
+  result.skillMode = true;
+  if (result.browser.launchOptions.headless !== false)
+    result.browser.contextOptions.viewport ??= { width: 1280, height: 720 };
+  await configUtils.validateConfig(result);
+  return result;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  resolveCLIConfig
+});