npm - @browsermation/browser-engine - Versions diffs - 0.0.12 → 0.0.16 - Mend

@browsermation/browser-engine 0.0.12 → 0.0.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (513) hide show

package/dist/node_modules/playwright/lib/agents/playwright-test-generator.agent.md ADDED Viewed

@@ -0,0 +1,88 @@
+---
+name: playwright-test-generator
+description: Use this agent when you need to create automated browser tests using Playwright
+model: sonnet
+color: blue
+tools:
+  - search
+  - 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 generate a test for the test plan item.
+  <test-suite><!-- Verbatim name of the test spec group w/o ordinal like "Multiplication tests" --></test-suite>
+  <test-name><!-- Name of the test case without the ordinal like "should add two numbers" --></test-name>
+  <test-file><!-- Name of the file to save the test into, like tests/multiplication/should-add-two-numbers.spec.ts --></test-file>
+  <seed-file><!-- Seed file path from test plan --></seed-file>
+  <body><!-- Test case content including steps and expectations --></body>
+</example>

package/dist/node_modules/playwright/lib/agents/playwright-test-heal.prompt.md ADDED Viewed

@@ -0,0 +1,6 @@
+---
+agent: playwright-test-healer
+description: Fix tests
+---
+Run all my tests and fix the failing ones.

package/dist/node_modules/playwright/lib/agents/playwright-test-healer.agent.md ADDED Viewed

@@ -0,0 +1,55 @@
+---
+name: playwright-test-healer
+description: Use this agent when you need to debug and fix failing Playwright tests
+model: sonnet
+color: red
+tools:
+  - search
+  - 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 `test_run` tool to identify failing tests
+2. **Debug failed tests**: For each failing test run `test_debug`.
+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

package/dist/node_modules/playwright/lib/agents/playwright-test-plan.prompt.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+agent: playwright-test-planner
+description: Create test plan
+---
+Create test plan for "add to cart" functionality of my app.
+- Seed file: `${seedFile}`
+- Test plan: `specs/coverage.plan.md`

package/dist/node_modules/playwright/lib/agents/playwright-test-planner.agent.md ADDED Viewed

@@ -0,0 +1,72 @@
+---
+name: playwright-test-planner
+description: Use this agent when you need to create comprehensive test plan for a web application or website
+model: sonnet
+color: green
+tools:
+  - search
+  - playwright-test/browser_click
+  - playwright-test/browser_close
+  - playwright-test/browser_console_messages
+  - 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_navigate_back
+  - playwright-test/browser_network_requests
+  - playwright-test/browser_press_key
+  - playwright-test/browser_select_option
+  - playwright-test/browser_snapshot
+  - playwright-test/browser_take_screenshot
+  - playwright-test/browser_type
+  - playwright-test/browser_wait_for
+  - playwright-test/planner_setup_page
+  - playwright-test/planner_save_plan
+---
+You are an expert web test planner with extensive experience in quality assurance, user experience testing, and test
+scenario design. Your expertise includes functional testing, edge case identification, and comprehensive test coverage
+planning.
+You will:
+1. **Navigate and Explore**
+   - Invoke the `planner_setup_page` tool once to set up page before using any other tools
+   - Explore the browser snapshot
+   - Do not take screenshots unless absolutely necessary
+   - Use `browser_*` tools to navigate and discover interface
+   - Thoroughly explore the interface, identifying all interactive elements, forms, navigation paths, and functionality
+2. **Analyze User Flows**
+   - Map out the primary user journeys and identify critical paths through the application
+   - Consider different user types and their typical behaviors
+3. **Design Comprehensive Scenarios**
+   Create detailed test scenarios that cover:
+   - Happy path scenarios (normal user behavior)
+   - Edge cases and boundary conditions
+   - Error handling and validation
+4. **Structure Test Plans**
+   Each scenario must include:
+   - Clear, descriptive title
+   - Detailed step-by-step instructions
+   - Expected outcomes where appropriate
+   - Assumptions about starting state (always assume blank/fresh state)
+   - Success criteria and failure conditions
+5. **Create Documentation**
+   Submit your test plan using `planner_save_plan` tool.
+**Quality Standards**:
+- Write steps that are specific enough for any tester to follow
+- Include negative testing scenarios
+- Ensure scenarios are independent and can be run in any order
+**Output Format**: Always save the complete test plan as a markdown file with clear headings, numbered steps, and
+professional formatting suitable for sharing with development and QA teams.

package/dist/node_modules/playwright/lib/common/config.js ADDED Viewed

@@ -0,0 +1,280 @@
+"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 config_exports = {};
+__export(config_exports, {
+  FullConfigInternal: () => FullConfigInternal,
+  FullProjectInternal: () => FullProjectInternal,
+  builtInReporters: () => builtInReporters,
+  defaultGrep: () => defaultGrep,
+  defaultReporter: () => defaultReporter,
+  defaultTimeout: () => defaultTimeout,
+  getProjectId: () => getProjectId,
+  takeFirst: () => takeFirst,
+  toReporters: () => toReporters
+});
+module.exports = __toCommonJS(config_exports);
+var import_fs = __toESM(require("fs"));
+var import_os = __toESM(require("os"));
+var import_path = __toESM(require("path"));
+var import_util = require("../util");
+const defaultTimeout = 3e4;
+class FullConfigInternal {
+  constructor(location, userConfig, configCLIOverrides, metadata) {
+    this.projects = [];
+    this.cliArgs = [];
+    this.cliListOnly = false;
+    this.preOnlyTestFilters = [];
+    this.postShardTestFilters = [];
+    this.defineConfigWasUsed = false;
+    this.globalSetups = [];
+    this.globalTeardowns = [];
+    if (configCLIOverrides.projects && userConfig.projects)
+      throw new Error(`Cannot use --browser option when configuration file defines projects. Specify browserName in the projects instead.`);
+    const { resolvedConfigFile, configDir } = location;
+    const packageJsonPath = (0, import_util.getPackageJsonPath)(configDir);
+    const packageJsonDir = packageJsonPath ? import_path.default.dirname(packageJsonPath) : process.cwd();
+    this.configDir = configDir;
+    this.configCLIOverrides = configCLIOverrides;
+    const privateConfiguration = userConfig["@playwright/test"];
+    this.plugins = (privateConfiguration?.plugins || []).map((p) => ({ factory: p }));
+    this.singleTSConfigPath = pathResolve(configDir, userConfig.tsconfig);
+    this.captureGitInfo = userConfig.captureGitInfo;
+    this.failOnFlakyTests = takeFirst(configCLIOverrides.failOnFlakyTests, userConfig.failOnFlakyTests, false);
+    this.globalSetups = (Array.isArray(userConfig.globalSetup) ? userConfig.globalSetup : [userConfig.globalSetup]).map((s) => resolveScript(s, configDir)).filter((script) => script !== void 0);
+    this.globalTeardowns = (Array.isArray(userConfig.globalTeardown) ? userConfig.globalTeardown : [userConfig.globalTeardown]).map((s) => resolveScript(s, configDir)).filter((script) => script !== void 0);
+    userConfig.metadata = userConfig.metadata || {};
+    const globalTags = Array.isArray(userConfig.tag) ? userConfig.tag : userConfig.tag ? [userConfig.tag] : [];
+    for (const tag of globalTags) {
+      if (tag[0] !== "@")
+        throw new Error(`Tag must start with "@" symbol, got "${tag}" instead.`);
+    }
+    this.config = {
+      configFile: resolvedConfigFile,
+      rootDir: pathResolve(configDir, userConfig.testDir) || configDir,
+      forbidOnly: takeFirst(configCLIOverrides.forbidOnly, userConfig.forbidOnly, false),
+      fullyParallel: takeFirst(configCLIOverrides.fullyParallel, userConfig.fullyParallel, false),
+      globalSetup: this.globalSetups[0] ?? null,
+      globalTeardown: this.globalTeardowns[0] ?? null,
+      globalTimeout: takeFirst(configCLIOverrides.debug ? 0 : void 0, configCLIOverrides.globalTimeout, userConfig.globalTimeout, 0),
+      grep: takeFirst(userConfig.grep, defaultGrep),
+      grepInvert: takeFirst(userConfig.grepInvert, null),
+      maxFailures: takeFirst(configCLIOverrides.debug ? 1 : void 0, configCLIOverrides.maxFailures, userConfig.maxFailures, 0),
+      metadata: metadata ?? userConfig.metadata,
+      preserveOutput: takeFirst(userConfig.preserveOutput, "always"),
+      reporter: takeFirst(configCLIOverrides.reporter, resolveReporters(userConfig.reporter, configDir), [[defaultReporter]]),
+      reportSlowTests: takeFirst(userConfig.reportSlowTests, {
+        max: 5,
+        threshold: 3e5
+        /* 5 minutes */
+      }),
+      quiet: takeFirst(configCLIOverrides.quiet, userConfig.quiet, false),
+      projects: [],
+      shard: takeFirst(configCLIOverrides.shard, userConfig.shard, null),
+      tags: globalTags,
+      updateSnapshots: takeFirst(configCLIOverrides.updateSnapshots, userConfig.updateSnapshots, "missing"),
+      updateSourceMethod: takeFirst(configCLIOverrides.updateSourceMethod, userConfig.updateSourceMethod, "patch"),
+      version: require("../../package.json").version,
+      workers: resolveWorkers(takeFirst(configCLIOverrides.debug ? 1 : void 0, configCLIOverrides.workers, userConfig.workers, "50%")),
+      webServer: null
+    };
+    for (const key in userConfig) {
+      if (key.startsWith("@"))
+        this.config[key] = userConfig[key];
+    }
+    this.config[configInternalSymbol] = this;
+    const webServers = takeFirst(userConfig.webServer, null);
+    if (Array.isArray(webServers)) {
+      this.config.webServer = null;
+      this.webServers = webServers;
+    } else if (webServers) {
+      this.config.webServer = webServers;
+      this.webServers = [webServers];
+    } else {
+      this.webServers = [];
+    }
+    const projectConfigs = configCLIOverrides.projects || userConfig.projects || [{ ...userConfig, workers: void 0 }];
+    this.projects = projectConfigs.map((p) => new FullProjectInternal(configDir, userConfig, this, p, this.configCLIOverrides, packageJsonDir));
+    resolveProjectDependencies(this.projects);
+    this._assignUniqueProjectIds(this.projects);
+    this.config.projects = this.projects.map((p) => p.project);
+  }
+  _assignUniqueProjectIds(projects) {
+    const usedNames = /* @__PURE__ */ new Set();
+    for (const p of projects) {
+      const name = p.project.name || "";
+      for (let i = 0; i < projects.length; ++i) {
+        const candidate = name + (i ? i : "");
+        if (usedNames.has(candidate))
+          continue;
+        p.id = candidate;
+        p.project.__projectId = p.id;
+        usedNames.add(candidate);
+        break;
+      }
+    }
+  }
+}
+class FullProjectInternal {
+  constructor(configDir, config, fullConfig, projectConfig, configCLIOverrides, packageJsonDir) {
+    this.id = "";
+    this.deps = [];
+    this.fullConfig = fullConfig;
+    const testDir = takeFirst(pathResolve(configDir, projectConfig.testDir), pathResolve(configDir, config.testDir), fullConfig.configDir);
+    this.snapshotPathTemplate = takeFirst(projectConfig.snapshotPathTemplate, config.snapshotPathTemplate);
+    this.project = {
+      grep: takeFirst(projectConfig.grep, config.grep, defaultGrep),
+      grepInvert: takeFirst(projectConfig.grepInvert, config.grepInvert, null),
+      outputDir: takeFirst(configCLIOverrides.outputDir, pathResolve(configDir, projectConfig.outputDir), pathResolve(configDir, config.outputDir), import_path.default.join(packageJsonDir, "test-results")),
+      // Note: we either apply the cli override for repeatEach or not, depending on whether the
+      // project is top-level vs dependency. See collectProjectsAndTestFiles in loadUtils.
+      repeatEach: takeFirst(projectConfig.repeatEach, config.repeatEach, 1),
+      retries: takeFirst(configCLIOverrides.retries, projectConfig.retries, config.retries, 0),
+      metadata: takeFirst(projectConfig.metadata, config.metadata, {}),
+      name: takeFirst(projectConfig.name, config.name, ""),
+      testDir,
+      snapshotDir: takeFirst(pathResolve(configDir, projectConfig.snapshotDir), pathResolve(configDir, config.snapshotDir), testDir),
+      testIgnore: takeFirst(projectConfig.testIgnore, config.testIgnore, []),
+      testMatch: takeFirst(projectConfig.testMatch, config.testMatch, "**/*.@(spec|test).?(c|m)[jt]s?(x)"),
+      timeout: takeFirst(configCLIOverrides.debug ? 0 : void 0, configCLIOverrides.timeout, projectConfig.timeout, config.timeout, defaultTimeout),
+      use: (0, import_util.mergeObjects)(config.use, projectConfig.use, configCLIOverrides.use),
+      dependencies: projectConfig.dependencies || [],
+      teardown: projectConfig.teardown
+    };
+    this.fullyParallel = takeFirst(configCLIOverrides.fullyParallel, projectConfig.fullyParallel, config.fullyParallel, void 0);
+    this.expect = takeFirst(projectConfig.expect, config.expect, {});
+    if (this.expect.toHaveScreenshot?.stylePath) {
+      const stylePaths = Array.isArray(this.expect.toHaveScreenshot.stylePath) ? this.expect.toHaveScreenshot.stylePath : [this.expect.toHaveScreenshot.stylePath];
+      this.expect.toHaveScreenshot.stylePath = stylePaths.map((stylePath) => import_path.default.resolve(configDir, stylePath));
+    }
+    this.respectGitIgnore = takeFirst(projectConfig.respectGitIgnore, config.respectGitIgnore, !projectConfig.testDir && !config.testDir);
+    this.ignoreSnapshots = takeFirst(configCLIOverrides.ignoreSnapshots, projectConfig.ignoreSnapshots, config.ignoreSnapshots, false);
+    this.workers = projectConfig.workers ? resolveWorkers(projectConfig.workers) : void 0;
+    if (configCLIOverrides.debug && this.workers)
+      this.workers = 1;
+  }
+}
+function takeFirst(...args) {
+  for (const arg of args) {
+    if (arg !== void 0)
+      return arg;
+  }
+  return void 0;
+}
+function pathResolve(baseDir, relative) {
+  if (!relative)
+    return void 0;
+  return import_path.default.resolve(baseDir, relative);
+}
+function resolveReporters(reporters, rootDir) {
+  return toReporters(reporters)?.map(([id, arg]) => {
+    if (builtInReporters.includes(id))
+      return [id, arg];
+    return [require.resolve(id, { paths: [rootDir] }), arg];
+  });
+}
+function resolveWorkers(workers) {
+  if (typeof workers === "string") {
+    if (workers.endsWith("%")) {
+      const cpus = import_os.default.cpus().length;
+      return Math.max(1, Math.floor(cpus * (parseInt(workers, 10) / 100)));
+    }
+    const parsedWorkers = parseInt(workers, 10);
+    if (isNaN(parsedWorkers))
+      throw new Error(`Workers ${workers} must be a number or percentage.`);
+    return parsedWorkers;
+  }
+  return workers;
+}
+function resolveProjectDependencies(projects) {
+  const teardownSet = /* @__PURE__ */ new Set();
+  for (const project of projects) {
+    for (const dependencyName of project.project.dependencies) {
+      const dependencies = projects.filter((p) => p.project.name === dependencyName);
+      if (!dependencies.length)
+        throw new Error(`Project '${project.project.name}' depends on unknown project '${dependencyName}'`);
+      if (dependencies.length > 1)
+        throw new Error(`Project dependencies should have unique names, reading ${dependencyName}`);
+      project.deps.push(...dependencies);
+    }
+    if (project.project.teardown) {
+      const teardowns = projects.filter((p) => p.project.name === project.project.teardown);
+      if (!teardowns.length)
+        throw new Error(`Project '${project.project.name}' has unknown teardown project '${project.project.teardown}'`);
+      if (teardowns.length > 1)
+        throw new Error(`Project teardowns should have unique names, reading ${project.project.teardown}`);
+      const teardown = teardowns[0];
+      project.teardown = teardown;
+      teardownSet.add(teardown);
+    }
+  }
+  for (const teardown of teardownSet) {
+    if (teardown.deps.length)
+      throw new Error(`Teardown project ${teardown.project.name} must not have dependencies`);
+  }
+  for (const project of projects) {
+    for (const dep of project.deps) {
+      if (teardownSet.has(dep))
+        throw new Error(`Project ${project.project.name} must not depend on a teardown project ${dep.project.name}`);
+    }
+  }
+}
+function toReporters(reporters) {
+  if (!reporters)
+    return;
+  if (typeof reporters === "string")
+    return [[reporters]];
+  return reporters;
+}
+const builtInReporters = ["list", "line", "dot", "json", "junit", "null", "github", "html", "blob"];
+function resolveScript(id, rootDir) {
+  if (!id)
+    return void 0;
+  const localPath = import_path.default.resolve(rootDir, id);
+  if (import_fs.default.existsSync(localPath))
+    return localPath;
+  return require.resolve(id, { paths: [rootDir] });
+}
+const defaultGrep = /.*/;
+const defaultReporter = process.env.CI ? "dot" : "list";
+const configInternalSymbol = Symbol("configInternalSymbol");
+function getProjectId(project) {
+  return project.__projectId;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  FullConfigInternal,
+  FullProjectInternal,
+  builtInReporters,
+  defaultGrep,
+  defaultReporter,
+  defaultTimeout,
+  getProjectId,
+  takeFirst,
+  toReporters
+});