electron-playwright-cli 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) Microsoft Corporation.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,69 @@
+# electron-playwright-cli
+
+A fork of [playwright-cli](https://github.com/microsoft/playwright-cli) that adds Electron desktop app support. All standard Playwright CLI commands work, plus Electron-specific ones for interacting with the main process and listing windows.
+
+## Install
+
+```bash
+npm install -g electron-playwright-cli playwright
+```
+
+`playwright` is a peer dependency and must be installed alongside.
+
+## Configuration
+
+Create `.playwright/cli.config.json` in your project root:
+
+```json
+{
+  "browser": {
+    "launchOptions": {
+      "args": ["path/to/your/main.js"]
+    }
+  }
+}
+```
+
+The `args` array is passed to Electron. Point it at your app's main process entry point.
+
+Optional launch options:
+- `executablePath`: path to the Electron binary (defaults to the one in node_modules)
+- `cwd`: working directory for the Electron process
+- `env`: additional environment variables
+- `timeout`: launch timeout in milliseconds
+
+## Usage
+
+```bash
+# take a snapshot of the running app
+electron-playwright-cli snapshot
+
+# interact with elements using refs from the snapshot
+electron-playwright-cli click e15
+electron-playwright-cli fill e3 "hello world"
+electron-playwright-cli type "search query"
+electron-playwright-cli press Enter
+
+# take a screenshot
+electron-playwright-cli screenshot --filename=app.png
+
+# evaluate in the electron main process
+electron-playwright-cli electron_evaluate "electron => electron.app.getName()"
+
+# list all electron windows
+electron-playwright-cli electron_windows
+```
+
+All standard commands from playwright-cli are available: `goto`, `snapshot`, `click`, `fill`, `type`, `press`, `screenshot`, `tab-list`, `tab-select`, `cookie-list`, `localstorage-get`, `route`, `console`, `network`, `tracing-start`, `tracing-stop`, `run-code`, and more. See the [skill reference](skills/playwright-cli/SKILL.md) for the full command list.
+
+## How it works
+
+electron-playwright-cli replaces the standard browser launch flow with a custom daemon that composes Playwright's internal `BrowserServerBackend` with an `ElectronContextFactory`. When you run a command, the CLI client spawns (or connects to) a background daemon process that launches your Electron app via `playwright._electron.launch()`, registers Electron-specific tools (like `electron_evaluate` and `electron_windows`) into Playwright's tool registry, and exposes the full Playwright CLI command surface over a Unix socket using newline-delimited JSON.
+
+## Upstream
+
+This project is a fork of [microsoft/playwright-cli](https://github.com/microsoft/playwright-cli), licensed under Apache-2.0.
+
+## License
+
+Apache-2.0

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "electron-playwright-cli",
+  "version": "0.1.0",
+  "description": "Playwright CLI with Electron app support",
+  "keywords": [
+    "playwright",
+    "electron",
+    "cli",
+    "testing",
+    "automation",
+    "desktop"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/spacecake-labs/electron-playwright-cli.git"
+  },
+  "homepage": "https://github.com/spacecake-labs/electron-playwright-cli",
+  "bugs": {
+    "url": "https://github.com/spacecake-labs/electron-playwright-cli/issues"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "author": {
+    "name": "Spacecake Labs"
+  },
+  "license": "Apache-2.0",
+  "scripts": {
+    "check": "npm run fmt:check && npm run lint && npm run typecheck",
+    "fmt": "oxfmt .",
+    "fmt:check": "oxfmt --check .",
+    "lint": "oxlint .",
+    "typecheck": "tsc --noEmit",
+    "test": "playwright test",
+    "changeset": "changeset",
+    "version-packages": "changeset version",
+    "release": "changeset publish"
+  },
+  "files": [
+    "playwright-cli.js",
+    "playwright-electron/",
+    "skills/"
+  ],
+  "devDependencies": {
+    "@playwright/test": "1.59.0-alpha-1771104257000",
+    "@types/node": "^25.2.1",
+    "electron": "^35.0.0",
+    "oxfmt": "^0.7.0",
+    "oxlint": "^0.16.0",
+    "typescript": "^5.7.0",
+    "@changesets/cli": "^2.27.0"
+  },
+  "dependencies": {
+    "minimist": "^1.2.5"
+  },
+  "peerDependencies": {
+    "playwright": ">=1.52.0"
+  },
+  "bin": {
+    "electron-playwright-cli": "playwright-cli.js"
+  }
+}

package/playwright-cli.js

@@ -0,0 +1,256 @@
+#!/usr/bin/env node
+"use strict";
+
+// playwright CLI wrapper that adds electron support.
+// re-implements the terminal client with shorter socket paths
+// (macOS unix socket limit is 104 bytes) and spawns our electron
+// daemon which composes playwright internals directly.
+
+const crypto = require("crypto");
+const fs = require("fs");
+const net = require("net");
+const os = require("os");
+const path = require("path");
+const cp = require("child_process");
+
+// --- socket path computation (uses tmpdir for short paths) ---
+
+const installationHash = crypto
+  .createHash("sha1")
+  .update(require.resolve("playwright/package.json"))
+  .digest("hex")
+  .substring(0, 16);
+
+function daemonSocketDir() {
+  const socketsDir = path.join(os.tmpdir(), "playwright-cli");
+  return path.join(socketsDir, installationHash);
+}
+
+function daemonSocketPath(sessionName) {
+  if (os.platform() === "win32")
+    return `\\\\.\\pipe\\${installationHash}-${sessionName}.sock`;
+  const socketPath = path.join(daemonSocketDir(), `${sessionName}.sock`);
+  if (Buffer.byteLength(socketPath) > 104)
+    throw new Error(
+      `Socket path too long (${Buffer.byteLength(socketPath)} bytes, max 104). Use a shorter --session name.`,
+    );
+  return socketPath;
+}
+
+// --- socket session (newline-delimited JSON protocol) ---
+
+class SocketSession {
+  constructor(socket) {
+    this._nextId = 1;
+    this._callbacks = new Map();
+    this._pendingBuffers = [];
+    this._socket = socket;
+
+    socket.on("data", (buf) => this._onData(buf));
+    socket.on("close", () => this.dispose());
+    socket.on("error", () => {});
+  }
+
+  async runCliCommand(args) {
+    return this._send("runCliCommand", { args });
+  }
+
+  async _send(method, params = {}) {
+    const id = this._nextId++;
+    const msg = JSON.stringify({ id, method, params }) + "\n";
+    await new Promise((resolve, reject) => {
+      this._socket.write(msg, (err) => (err ? reject(err) : resolve()));
+    });
+    return new Promise((resolve, reject) => {
+      this._callbacks.set(id, { resolve, reject });
+    });
+  }
+
+  dispose() {
+    for (const cb of this._callbacks.values()) cb.reject(new Error("Disposed"));
+    this._callbacks.clear();
+    this._socket.destroy();
+  }
+
+  _onData(buffer) {
+    let end = buffer.indexOf("\n");
+    if (end === -1) {
+      this._pendingBuffers.push(buffer);
+      return;
+    }
+    this._pendingBuffers.push(buffer.slice(0, end));
+    this._dispatch(Buffer.concat(this._pendingBuffers).toString());
+    let start = end + 1;
+    end = buffer.indexOf("\n", start);
+    while (end !== -1) {
+      this._dispatch(buffer.toString(undefined, start, end));
+      start = end + 1;
+      end = buffer.indexOf("\n", start);
+    }
+    this._pendingBuffers = [buffer.slice(start)];
+  }
+
+  _dispatch(message) {
+    let obj;
+    try {
+      obj = JSON.parse(message);
+    } catch {
+      console.error("Failed to parse daemon message:", message);
+      return;
+    }
+    if (obj.id && this._callbacks.has(obj.id)) {
+      const cb = this._callbacks.get(obj.id);
+      this._callbacks.delete(obj.id);
+      if (obj.error) cb.reject(new Error(obj.error));
+      else cb.resolve(obj.result);
+    }
+  }
+}
+
+// --- daemon management ---
+
+async function socketExists(socketPath) {
+  try {
+    const stat = await fs.promises.stat(socketPath);
+    return stat?.isSocket();
+  } catch {
+    return false;
+  }
+}
+
+async function connectToSocket(socketPath) {
+  return new Promise((resolve, reject) => {
+    const socket = net.createConnection(socketPath, () => resolve(socket));
+    socket.on("error", reject);
+  });
+}
+
+async function connectToDaemon(sessionName) {
+  const socketPath = daemonSocketPath(sessionName);
+
+  // try to connect to existing daemon
+  if (await socketExists(socketPath)) {
+    try {
+      const socket = await connectToSocket(socketPath);
+      return new SocketSession(socket);
+    } catch {
+      if (os.platform() !== "win32")
+        await fs.promises.unlink(socketPath).catch(() => {});
+    }
+  }
+
+  // ensure socket directory exists
+  await fs.promises.mkdir(daemonSocketDir(), { recursive: true });
+
+  // spawn the electron daemon
+  const daemonScript = path.resolve(
+    __dirname,
+    "playwright-electron",
+    "electron-daemon.js",
+  );
+  const userDataDir = path.resolve(
+    daemonSocketDir(),
+    `${sessionName}-user-data`,
+  );
+
+  const args = [
+    daemonScript,
+    `--daemon=${socketPath}`,
+    `--user-data-dir=${userDataDir}`,
+  ];
+
+  // auto-inject config file if available
+  const configFile =
+    process.env.PLAYWRIGHT_MCP_CONFIG ||
+    path.resolve(process.cwd(), ".playwright", "cli.config.json");
+  if (fs.existsSync(configFile)) args.push(`--config=${configFile}`);
+
+  const stderrLog = path.join(daemonSocketDir(), `${sessionName}-stderr.log`);
+  const stderrFd = fs.openSync(stderrLog, "w");
+  const child = cp.spawn(process.execPath, args, {
+    detached: true,
+    stdio: ["ignore", "ignore", stderrFd],
+    cwd: process.cwd(),
+  });
+  child.unref();
+  fs.closeSync(stderrFd);
+
+  // retry connection
+  const maxRetries = 50;
+  for (let i = 0; i < maxRetries; i++) {
+    await new Promise((r) => setTimeout(r, 100));
+    try {
+      const socket = await connectToSocket(socketPath);
+      return new SocketSession(socket);
+    } catch (e) {
+      if (e.code !== "ENOENT" && e.code !== "ECONNREFUSED") throw e;
+    }
+  }
+  let detail = "";
+  try {
+    detail = fs.readFileSync(stderrLog, "utf-8").trim();
+  } catch {}
+  throw new Error(
+    `Failed to connect to daemon at ${socketPath} after ${maxRetries * 100}ms` +
+      (detail ? `\nDaemon stderr:\n${detail}` : ""),
+  );
+}
+
+// --- main ---
+
+async function main() {
+  const argv = process.argv.slice(2);
+  const args = require("minimist")(argv);
+
+  if (args.version || args.v) {
+    const pkg = require("playwright/package.json");
+    console.log(pkg.version);
+    process.exit(0);
+  }
+
+  // load help from playwright's terminal CLI
+  const playwrightDir = path.dirname(
+    require.resolve("playwright/package.json"),
+  );
+  let help;
+  try {
+    help = require(path.join(playwrightDir, "lib/mcp/terminal/help.json"));
+  } catch {
+    help = {
+      commands: {},
+      global: "electron-playwright-cli <command> [options]",
+    };
+  }
+
+  const commandName = args._[0];
+
+  if (args.help || args.h) {
+    if (help.commands[commandName]) {
+      console.log(help.commands[commandName]);
+    } else {
+      console.log(
+        "electron-playwright-cli - run playwright mcp commands for electron apps\n",
+      );
+      console.log(help.global);
+    }
+    process.exit(0);
+  }
+
+  if (!commandName) {
+    console.error("No command specified.\n");
+    console.log(help.global);
+    process.exit(1);
+  }
+
+  const sessionName =
+    args.session || process.env.PLAYWRIGHT_CLI_SESSION || "default";
+  const session = await connectToDaemon(sessionName);
+  const result = await session.runCliCommand(args);
+  console.log(result);
+  session.dispose();
+}
+
+main().catch((e) => {
+  console.error(e.message);
+  process.exit(1);
+});

package/playwright-electron/electron-context-factory.js

@@ -0,0 +1,49 @@
+"use strict";
+
+// electron context factory — launches an electron app and returns
+// its browser context for the playwright CLI daemon.
+
+const playwright = require("playwright-core");
+
+class ElectronContextFactory {
+  constructor(config) {
+    this.config = config;
+  }
+
+  async createContext(_clientInfo, _abortSignal, _options) {
+    const launchOptions = this.config.browser.launchOptions || {};
+    const electronApp = await playwright._electron.launch({
+      executablePath: launchOptions.executablePath,
+      args: launchOptions.args || ["."],
+      cwd: launchOptions.cwd || process.cwd(),
+      env: launchOptions.env
+        ? { ...process.env, ...launchOptions.env }
+        : undefined,
+      timeout: launchOptions.timeout,
+    });
+
+    try {
+      const browserContext = electronApp.context();
+      // store the electron app reference on the context for tools
+      // @ts-ignore — custom property used by electron-tools.js
+      browserContext._electronApp = electronApp;
+
+      // if there are no pages yet, wait for the first window
+      if (browserContext.pages().length === 0) {
+        await electronApp.firstWindow();
+      }
+
+      return {
+        browserContext,
+        close: async () => {
+          await electronApp.close().catch(() => {});
+        },
+      };
+    } catch (e) {
+      await electronApp.close().catch(() => {});
+      throw e;
+    }
+  }
+}
+
+module.exports = { ElectronContextFactory };