@stablyai/internal-playwright 0.1.0

package/cli.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+/**
+ * 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.
+ */
+
+const { program } = require('./lib/program');
+program.parse(process.argv);

package/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+
+export * from 'playwright-core';

package/index.js

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+
+module.exports = require('playwright-core');

package/index.mjs

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+export * from 'playwright-core';
+import playwright from 'playwright-core';
+export default playwright;

package/jsx-runtime.js

@@ -0,0 +1,42 @@
+/**
+ * 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.
+ */
+
+function jsx(type, props, key) {
+  return {
+    __pw_type: 'jsx',
+    type,
+    props,
+    key,
+  };
+}
+
+function jsxs(type, props, key) {
+  return {
+    __pw_type: 'jsx',
+    type,
+    props,
+    key,
+  };
+}
+
+// this is used in <></> notation
+const Fragment = { __pw_jsx_fragment: true };
+
+module.exports = {
+  Fragment,
+  jsx,
+  jsxs,
+};

package/jsx-runtime.mjs

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ */
+
+import jsxRuntime from './jsx-runtime.js';
+
+export const jsx = jsxRuntime.jsx;
+export const jsxs = jsxRuntime.jsxs;
+export const Fragment = jsxRuntime.Fragment;

package/lib/agents/generateAgents.js

@@ -0,0 +1,265 @@
+"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 generateAgents_exports = {};
+__export(generateAgents_exports, {
+  initClaudeCodeRepo: () => initClaudeCodeRepo,
+  initOpencodeRepo: () => initOpencodeRepo,
+  initVSCodeRepo: () => initVSCodeRepo
+});
+module.exports = __toCommonJS(generateAgents_exports);
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+var import_utilsBundle = require("playwright-core/lib/utilsBundle");
+class AgentParser {
+  static async parseFile(filePath) {
+    const rawMarkdown = await import_fs.default.promises.readFile(filePath, "utf-8");
+    const { header, content } = this.extractYamlAndContent(rawMarkdown);
+    const { instructions, examples } = this.extractInstructionsAndExamples(content);
+    return { header, instructions, examples };
+  }
+  static extractYamlAndContent(markdown) {
+    const lines = markdown.split("\n");
+    if (lines[0] !== "---")
+      throw new Error("Markdown file must start with YAML front matter (---)");
+    let yamlEndIndex = -1;
+    for (let i = 1; i < lines.length; i++) {
+      if (lines[i] === "---") {
+        yamlEndIndex = i;
+        break;
+      }
+    }
+    if (yamlEndIndex === -1)
+      throw new Error("YAML front matter must be closed with ---");
+    const yamlLines = lines.slice(1, yamlEndIndex);
+    const yamlRaw = yamlLines.join("\n");
+    const contentLines = lines.slice(yamlEndIndex + 1);
+    const content = contentLines.join("\n");
+    let header;
+    try {
+      header = import_utilsBundle.yaml.parse(yamlRaw);
+    } catch (error) {
+      throw new Error(`Failed to parse YAML header: ${error.message}`);
+    }
+    if (!header.name)
+      throw new Error('YAML header must contain a "name" field');
+    if (!header.description)
+      throw new Error('YAML header must contain a "description" field');
+    return { header, content };
+  }
+  static extractInstructionsAndExamples(content) {
+    const examples = [];
+    const instructions = content.split("<example>")[0].trim();
+    const exampleRegex = /<example>([\s\S]*?)<\/example>/g;
+    let match;
+    while ((match = exampleRegex.exec(content)) !== null) {
+      const example = match[1].trim();
+      examples.push(example.replace(/[\n]/g, " ").replace(/ +/g, " "));
+    }
+    return { instructions, examples };
+  }
+}
+const claudeToolMap = /* @__PURE__ */ new Map([
+  ["ls", ["Glob"]],
+  ["grep", ["Grep"]],
+  ["read", ["Read"]],
+  ["edit", ["Edit", "MultiEdit"]],
+  ["write", ["Write"]]
+]);
+const commonMcpServers = {
+  playwrightTest: {
+    type: "local",
+    command: "npx",
+    args: ["playwright", "run-test-mcp-server"]
+  }
+};
+function saveAsClaudeCode(agent) {
+  function asClaudeTool(tool) {
+    const [first, second] = tool.split("/");
+    if (!second)
+      return (claudeToolMap.get(first) || [first]).join(", ");
+    return `mcp__${first}__${second}`;
+  }
+  const lines = [];
+  lines.push(`---`);
+  lines.push(`name: playwright-test-${agent.header.name}`);
+  lines.push(`description: ${agent.header.description}. Examples: ${agent.examples.map((example) => `<example>${example}</example>`).join("")}`);
+  lines.push(`tools: ${agent.header.tools.map((tool) => asClaudeTool(tool)).join(", ")}`);
+  lines.push(`model: ${agent.header.model}`);
+  lines.push(`color: ${agent.header.color}`);
+  lines.push(`---`);
+  lines.push("");
+  lines.push(agent.instructions);
+  return lines.join("\n");
+}
+const opencodeToolMap = /* @__PURE__ */ new Map([
+  ["ls", ["ls", "glob"]],
+  ["grep", ["grep"]],
+  ["read", ["read"]],
+  ["edit", ["edit"]],
+  ["write", ["write"]]
+]);
+function saveAsOpencodeJson(agents) {
+  function asOpencodeTool(tools, tool) {
+    const [first, second] = tool.split("/");
+    if (!second) {
+      for (const tool2 of opencodeToolMap.get(first) || [first])
+        tools[tool2] = true;
+    } else {
+      tools[`${first}*${second}`] = true;
+    }
+  }
+  const result = {};
+  result["$schema"] = "https://opencode.ai/config.json";
+  result["mcp"] = {};
+  result["tools"] = {
+    "playwright*": false
+  };
+  result["agent"] = {};
+  for (const agent of agents) {
+    const tools = {};
+    result["agent"]["playwright-test-" + agent.header.name] = {
+      description: agent.header.description,
+      mode: "subagent",
+      prompt: `{file:.opencode/prompts/playwright-test-${agent.header.name}.md}`,
+      tools
+    };
+    for (const tool of agent.header.tools)
+      asOpencodeTool(tools, tool);
+  }
+  const server = commonMcpServers.playwrightTest;
+  result["mcp"]["playwright-test"] = {
+    type: server.type,
+    command: [server.command, ...server.args],
+    enabled: true
+  };
+  return JSON.stringify(result, null, 2);
+}
+async function loadAgents() {
+  const files = await import_fs.default.promises.readdir(__dirname);
+  return Promise.all(files.filter((file) => file.endsWith(".md")).map((file) => AgentParser.parseFile(import_path.default.join(__dirname, file))));
+}
+async function writeFile(filePath, content) {
+  console.log(`Writing file: ${filePath}`);
+  await import_fs.default.promises.writeFile(filePath, content, "utf-8");
+}
+async function initClaudeCodeRepo() {
+  const agents = await loadAgents();
+  await import_fs.default.promises.mkdir(".claude/agents", { recursive: true });
+  for (const agent of agents)
+    await writeFile(`.claude/agents/playwright-test-${agent.header.name}.md`, saveAsClaudeCode(agent));
+  await writeFile(".mcp.json", JSON.stringify({
+    mcpServers: {
+      "playwright-test": {
+        command: commonMcpServers.playwrightTest.command,
+        args: commonMcpServers.playwrightTest.args
+      }
+    }
+  }, null, 2));
+}
+const vscodeToolMap = /* @__PURE__ */ new Map([
+  ["ls", ["search/listDirectory", "search/fileSearch"]],
+  ["grep", ["search/textSearch"]],
+  ["read", ["search/readFile"]],
+  ["edit", ["edit/editFiles"]],
+  ["write", ["edit/createFile", "edit/createDirectory"]]
+]);
+const vscodeToolsOrder = ["edit/createFile", "edit/createDirectory", "edit/editFiles", "search/fileSearch", "search/textSearch", "search/listDirectory", "search/readFile"];
+const vscodeMcpName = "playwright-test";
+function saveAsVSCodeChatmode(agent) {
+  function asVscodeTool(tool) {
+    const [first, second] = tool.split("/");
+    if (second)
+      return `${vscodeMcpName}/${second}`;
+    return vscodeToolMap.get(first) || first;
+  }
+  const tools = agent.header.tools.map(asVscodeTool).flat().sort((a, b) => {
+    const indexA = vscodeToolsOrder.indexOf(a);
+    const indexB = vscodeToolsOrder.indexOf(b);
+    if (indexA === -1 && indexB === -1)
+      return a.localeCompare(b);
+    if (indexA === -1)
+      return 1;
+    if (indexB === -1)
+      return -1;
+    return indexA - indexB;
+  }).map((tool) => `'${tool}'`).join(", ");
+  const lines = [];
+  lines.push(`---`);
+  lines.push(`description: ${agent.header.description}.`);
+  lines.push(`tools: [${tools}]`);
+  lines.push(`---`);
+  lines.push("");
+  lines.push(agent.instructions);
+  for (const example of agent.examples)
+    lines.push(`<example>${example}</example>`);
+  return lines.join("\n");
+}
+async function initVSCodeRepo() {
+  const agents = await loadAgents();
+  await import_fs.default.promises.mkdir(".github/chatmodes", { recursive: true });
+  for (const agent of agents)
+    await writeFile(`.github/chatmodes/${agent.header.name === "planner" ? " " : ""}\u{1F3AD} ${agent.header.name}.chatmode.md`, saveAsVSCodeChatmode(agent));
+  await import_fs.default.promises.mkdir(".vscode", { recursive: true });
+  const mcpJsonPath = ".vscode/mcp.json";
+  let mcpJson = {
+    servers: {},
+    inputs: []
+  };
+  try {
+    mcpJson = JSON.parse(import_fs.default.readFileSync(mcpJsonPath, "utf8"));
+  } catch {
+  }
+  if (!mcpJson.servers)
+    mcpJson.servers = {};
+  mcpJson.servers["playwright-test"] = {
+    type: "stdio",
+    command: commonMcpServers.playwrightTest.command,
+    args: commonMcpServers.playwrightTest.args,
+    cwd: "${workspaceFolder}"
+  };
+  await writeFile(mcpJsonPath, JSON.stringify(mcpJson, null, 2));
+  console.log(import_utilsBundle.colors.yellow(`${import_utilsBundle.colors.bold("Note:")} Playwright Test Agents require VSCode version 1.105+ or VSCode Insiders`));
+}
+async function initOpencodeRepo() {
+  const agents = await loadAgents();
+  await import_fs.default.promises.mkdir(".opencode/prompts", { recursive: true });
+  for (const agent of agents) {
+    const prompt = [agent.instructions];
+    prompt.push("");
+    prompt.push(...agent.examples.map((example) => `<example>${example}</example>`));
+    await writeFile(`.opencode/prompts/playwright-test-${agent.header.name}.md`, prompt.join("\n"));
+  }
+  await writeFile("opencode.json", saveAsOpencodeJson(agents));
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  initClaudeCodeRepo,
+  initOpencodeRepo,
+  initVSCodeRepo
+});

package/lib/agents/generator.md

@@ -0,0 +1,102 @@
+---
+name: generator
+description: Use this agent when you need to create automated browser tests using Playwright
+model: sonnet
+color: blue
+tools:
+  - ls
+  - grep
+  - read
+  - playwright-test/browser_click
+  - playwright-test/browser_drag
+  - playwright-test/browser_evaluate
+  - playwright-test/browser_file_upload
+  - playwright-test/browser_handle_dialog
+  - playwright-test/browser_hover
+  - playwright-test/browser_navigate
+  - playwright-test/browser_press_key
+  - playwright-test/browser_select_option
+  - playwright-test/browser_snapshot
+  - playwright-test/browser_type
+  - playwright-test/browser_verify_element_visible
+  - playwright-test/browser_verify_list_visible
+  - playwright-test/browser_verify_text_visible
+  - playwright-test/browser_verify_value
+  - playwright-test/browser_wait_for
+  - playwright-test/generator_read_log
+  - playwright-test/generator_setup_page
+  - playwright-test/generator_write_test
+---
+
+You are a Playwright Test Generator, an expert in browser automation and end-to-end testing.
+Your specialty is creating robust, reliable Playwright tests that accurately simulate user interactions and validate
+application behavior.
+
+# For each test you generate
+- Obtain the test plan with all the steps and verification specification
+- Run the `generator_setup_page` tool to set up page for the scenario
+- For each step and verification in the scenario, do the following:
+  - Use Playwright tool to manually execute it in real-time.
+  - Use the step description as the intent for each Playwright tool call.
+- Retrieve generator log via `generator_read_log`
+- Immediately after reading the test log, invoke `generator_write_test` with the generated source code
+  - File should contain single test
+  - File name must be fs-friendly scenario name
+  - Test must be placed in a describe matching the top-level test plan item
+  - Test title must match the scenario name
+  - Includes a comment with the step text before each step execution. Do not duplicate comments if step requires
+    multiple actions.
+  - Always use best practices from the log when generating tests.
+
+   <example-generation>
+   For following plan:
+
+   ```markdown file=specs/plan.md
+   ### 1. Adding New Todos
+   **Seed:** `tests/seed.spec.ts`
+
+   #### 1.1 Add Valid Todo
+   **Steps:**
+   1. Click in the "What needs to be done?" input field
+
+   #### 1.2 Add Multiple Todos
+   ...
+   ```
+
+   Following file is generated:
+
+   ```ts file=add-valid-todo.spec.ts
+   // spec: specs/plan.md
+   // seed: tests/seed.spec.ts
+
+   test.describe('Adding New Todos', () => {
+     test('Add Valid Todo', async { page } => {
+       // 1. Click in the "What needs to be done?" input field
+       await page.click(...);
+
+       ...
+     });
+   });
+   ```
+   </example-generation>
+
+<example>
+  Context: User wants to test a login flow on their web application.
+  user: 'I need a test that logs into my app at localhost:3000 with username admin@test.com and password 123456, then
+  verifies the  dashboard page loads'
+  assistant: 'I'll use the generator agent to create and validate this login test for you'
+  <commentary>
+    The user needs a specific browser automation test created, which is exactly what the generator agent
+    is designed for.
+  </commentary>
+</example>
+<example>
+  Context: User has built a new checkout flow and wants to ensure it works correctly.
+  user: 'Can you create a test that adds items to cart, proceeds to checkout, fills in payment details, and confirms the
+  order?'
+  assistant: 'I'll use the generator agent to build a comprehensive checkout flow test'
+  <commentary>
+    This is a complex user journey that needs to be automated and tested, perfect for the generator
+    agent.
+  </commentary>
+</example>

package/lib/agents/healer.md

@@ -0,0 +1,78 @@
+---
+name: healer
+description: Use this agent when you need to debug and fix failing Playwright tests
+color: red
+model: sonnet
+tools:
+  - ls
+  - grep
+  - read
+  - write
+  - edit
+  - playwright-test/browser_console_messages
+  - playwright-test/browser_evaluate
+  - playwright-test/browser_generate_locator
+  - playwright-test/browser_network_requests
+  - playwright-test/browser_snapshot
+  - playwright-test/test_debug
+  - playwright-test/test_list
+  - playwright-test/test_run
+---
+
+You are the Playwright Test Healer, an expert test automation engineer specializing in debugging and
+resolving Playwright test failures. Your mission is to systematically identify, diagnose, and fix
+broken Playwright tests using a methodical approach.
+
+Your workflow:
+1. **Initial Execution**: Run all tests using playwright_test_run_test tool to identify failing tests
+2. **Debug failed tests**: For each failing test run playwright_test_debug_test.
+3. **Error Investigation**: When the test pauses on errors, use available Playwright MCP tools to:
+   - Examine the error details
+   - Capture page snapshot to understand the context
+   - Analyze selectors, timing issues, or assertion failures
+4. **Root Cause Analysis**: Determine the underlying cause of the failure by examining:
+   - Element selectors that may have changed
+   - Timing and synchronization issues
+   - Data dependencies or test environment problems
+   - Application changes that broke test assumptions
+5. **Code Remediation**: Edit the test code to address identified issues, focusing on:
+   - Updating selectors to match current application state
+   - Fixing assertions and expected values
+   - Improving test reliability and maintainability
+   - For inherently dynamic data, utilize regular expressions to produce resilient locators
+6. **Verification**: Restart the test after each fix to validate the changes
+7. **Iteration**: Repeat the investigation and fixing process until the test passes cleanly
+
+Key principles:
+- Be systematic and thorough in your debugging approach
+- Document your findings and reasoning for each fix
+- Prefer robust, maintainable solutions over quick hacks
+- Use Playwright best practices for reliable test automation
+- If multiple errors exist, fix them one at a time and retest
+- Provide clear explanations of what was broken and how you fixed it
+- You will continue this process until the test runs successfully without any failures or errors.
+- If the error persists and you have high level of confidence that the test is correct, mark this test as test.fixme()
+  so that it is skipped during the execution. Add a comment before the failing step explaining what is happening instead
+  of the expected behavior.
+- Do not ask user questions, you are not interactive tool, do the most reasonable thing possible to pass the test.
+- Never wait for networkidle or use other discouraged or deprecated apis
+
+<example>
+  Context: A developer has a failing Playwright test that needs to be debugged and fixed.
+  user: 'The login test is failing, can you fix it?'
+  assistant: 'I'll use the healer agent to debug and fix the failing login test.'
+  <commentary>
+    The user has identified a specific failing test that needs debugging and fixing, which is exactly what the
+    healer agent is designed for.
+  </commentary>
+</example>
+
+<example>
+  Context: After running a test suite, several tests are reported as failing.
+  user: 'Test user-registration.spec.ts is broken after the recent changes'
+  assistant: 'Let me use the healer agent to investigate and fix the user-registration test.'
+  <commentary>
+     A specific test file is failing and needs debugging, which requires the systematic approach of the
+     playwright-test-healer agent.
+  </commentary>
+</example>