patchright-bun-core 1.58.2 → 1.59.0

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

@@ -0,0 +1,157 @@
+"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_path = __toESM(require("path"));
+var import_network = require("../../server/utils/network");
+var import_fileUtils = require("../../server/utils/fileUtils");
+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");
+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)) {
+    try {
+      await import_fs.default.promises.unlink(socketPath);
+    } catch (error) {
+      throw error;
+    }
+  }
+  const backend = new import_browserBackend.BrowserBackend(contextConfig, browserContext, import_tools.browserTools);
+  await backend.initialize({ cwd: process.cwd() });
+  if (browserContext.isClosed())
+    throw new Error("Browser context was closed before the daemon could start");
+  const server = import_net.default.createServer((socket) => {
+    const connection = new import_socketConnection.SocketConnection(socket);
+    connection.onmessage = async (message) => {
+      const { id, method, params } = message;
+      try {
+        if (method === "stop") {
+          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) {
+        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", reject);
+    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) {
+  return (0, import_fileUtils.makeSocketPath)("cli", `${clientInfo.workspaceDirHash}-${sessionName}`);
+}
+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,177 @@
+"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_zodBundle = require("../../zodBundle");
+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 isBooleanSchema(schema) {
+  return unwrapZodType(schema) instanceof import_zodBundle.z.ZodBoolean;
+}
+function generateHelpJSON() {
+  const booleanOptions = /* @__PURE__ */ new Set();
+  const commandEntries = {};
+  for (const [name, command] of Object.entries(import_commands.commands)) {
+    const flags = {};
+    if (command.options) {
+      const optionsShape = command.options.shape;
+      for (const [flagName, schema] of Object.entries(optionsShape)) {
+        const isBoolean = isBooleanSchema(schema);
+        flags[flagName] = isBoolean ? "boolean" : "string";
+        if (isBoolean)
+          booleanOptions.add(flagName);
+      }
+    }
+    commandEntries[name] = { help: generateCommandHelp(command), flags };
+  }
+  return {
+    global: generateHelp(),
+    commands: commandEntries,
+    booleanOptions: [...booleanOptions]
+  };
+}
+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,129 @@
+"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 __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 import_fs = __toESM(require("fs"));
+var import_os = __toESM(require("os"));
+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");
+var import_registry2 = require("../../server/registry/index");
+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; by default uses .playwright/cli.config.json in the project directory and ~/.playwright/cli.config.json as global config").option("--endpoint <endpoint>", "attach to a running Playwright browser endpoint").option("--init-workspace", "initialize workspace").option("--init-skills <value>", 'install skills for the given agent type ("claude" or "agents")').action(async (sessionName, options) => {
+  if (options.initWorkspace) {
+    await initWorkspace(options.initSkills);
+    return;
+  }
+  (0, import_watchdog.setupExitWatchdog)();
+  const clientInfo = (0, import_registry.createClientInfo)();
+  const mcpConfig = await configUtils.resolveCLIConfigForCLI(clientInfo.daemonProfilesDir, 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");
+}
+function globalConfigFile() {
+  return import_path.default.join(process.env["PWTEST_CLI_GLOBAL_CONFIG"] ?? import_os.default.homedir(), ".playwright", "cli.config.json");
+}
+async function initWorkspace(initSkills) {
+  const cwd = process.cwd();
+  const playwrightDir = import_path.default.join(cwd, ".playwright");
+  await import_fs.default.promises.mkdir(playwrightDir, { recursive: true });
+  console.log(`\u2705 Workspace initialized at \`${cwd}\`.`);
+  if (initSkills) {
+    const skillSourceDir = import_path.default.join(__dirname, "../cli-client/skill");
+    const target = initSkills === "agents" ? "agents" : "claude";
+    const skillDestDir = import_path.default.join(cwd, `.${target}`, "skills", "playwright-cli");
+    if (!import_fs.default.existsSync(skillSourceDir)) {
+      console.error("\u274C Skills source directory not found:", skillSourceDir);
+      process.exit(1);
+    }
+    await import_fs.default.promises.cp(skillSourceDir, skillDestDir, { recursive: true });
+    console.log(`\u2705 Skills installed to \`${import_path.default.relative(cwd, skillDestDir)}\`.`);
+  }
+  await ensureConfiguredBrowserInstalled();
+}
+async function ensureConfiguredBrowserInstalled() {
+  if (import_fs.default.existsSync(defaultConfigFile()) || import_fs.default.existsSync(globalConfigFile())) {
+    const clientInfo = (0, import_registry.createClientInfo)();
+    const config = await configUtils.resolveCLIConfigForCLI(clientInfo.daemonProfilesDir, "default", {});
+    const browserName = config.browser.browserName;
+    const channel = config.browser.launchOptions.channel;
+    if (!channel || channel.startsWith("chromium")) {
+      const executable = import_registry2.registry.findExecutable(channel ?? browserName);
+      if (executable && !import_fs.default.existsSync(executable.executablePath()))
+        await import_registry2.registry.install([executable]);
+    }
+  } else {
+    const channel = await findOrInstallDefaultBrowser();
+    if (channel !== "chrome")
+      await createDefaultConfig(channel);
+  }
+}
+async function findOrInstallDefaultBrowser() {
+  const channels = ["chrome", "msedge"];
+  for (const channel of channels) {
+    const executable = import_registry2.registry.findExecutable(channel);
+    if (!executable?.executablePath())
+      continue;
+    console.log(`\u2705 Found ${channel}, will use it as the default browser.`);
+    return channel;
+  }
+  const chromiumExecutable = import_registry2.registry.findExecutable("chromium");
+  if (!import_fs.default.existsSync(chromiumExecutable?.executablePath()))
+    await import_registry2.registry.install([chromiumExecutable]);
+  return "chromium";
+}
+async function createDefaultConfig(channel) {
+  const config = {
+    browser: {
+      browserName: "chromium",
+      launchOptions: { channel }
+    }
+  };
+  await import_fs.default.promises.writeFile(defaultConfigFile(), JSON.stringify(config, null, 2));
+  console.log(`\u2705 Created default config for ${channel} at ${import_path.default.relative(process.cwd(), defaultConfigFile())}.`);
+}