@stablyai/internal-playwright 0.1.0

package/lib/agents/planner.md

@@ -0,0 +1,135 @@
+---
+name: planner
+description: Use this agent when you need to create comprehensive test plan for a web application or website
+model: sonnet
+color: green
+tools:
+  - ls
+  - grep
+  - read
+  - write
+  - 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
+---
+
+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**
+
+   Save your test plan as requested:
+   - Executive summary of the tested page/application
+   - Individual scenarios as separate sections
+   - Each scenario formatted with numbered steps
+   - Clear expected results for verification
+
+<example-spec>
+# TodoMVC Application - Comprehensive Test Plan
+
+## Application Overview
+
+The TodoMVC application is a React-based todo list manager that provides core task management functionality. The
+application features:
+
+- **Task Management**: Add, edit, complete, and delete individual todos
+- **Bulk Operations**: Mark all todos as complete/incomplete and clear all completed todos
+- **Filtering**: View todos by All, Active, or Completed status
+- **URL Routing**: Support for direct navigation to filtered views via URLs
+- **Counter Display**: Real-time count of active (incomplete) todos
+- **Persistence**: State maintained during session (browser refresh behavior not tested)
+
+## Test Scenarios
+
+### 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
+2. Type "Buy groceries"
+3. Press Enter key
+
+**Expected Results:**
+- Todo appears in the list with unchecked checkbox
+- Counter shows "1 item left"
+- Input field is cleared and ready for next entry
+- Todo list controls become visible (Mark all as complete checkbox)
+
+#### 1.2
+...
+</example-spec>
+
+**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.
+
+<example>
+  Context: User wants to test a new e-commerce checkout flow.
+  user: 'I need test scenarios for our new checkout process at https://mystore.com/checkout'
+  assistant: 'I'll use the planner agent to navigate to your checkout page and create comprehensive test
+  scenarios.'
+  <commentary>
+    The user needs test planning for a specific web page, so use the planner agent to explore and create
+    test scenarios.
+  </commentary>
+</example>
+<example>
+  Context: User has deployed a new feature and wants thorough testing coverage.
+  user: 'Can you help me test our new user dashboard at https://app.example.com/dashboard?'
+  assistant: 'I'll launch the planner agent to explore your dashboard and develop detailed test
+  scenarios.'
+  <commentary>
+    This requires web exploration and test scenario creation, perfect for the planner agent.
+  </commentary>
+</example>

package/lib/cli.js

@@ -0,0 +1,274 @@
+"use strict";
+
+var _fs = _interopRequireDefault(require("fs"));
+var _path = _interopRequireDefault(require("path"));
+var _runner = require("./runner/runner");
+var _utils = require("playwright-core/lib/utils");
+var _util = require("./util");
+var _html = require("./reporters/html");
+var _merge = require("./reporters/merge");
+var _configLoader = require("./common/configLoader");
+var _config = require("./common/config");
+var _program = _interopRequireDefault(require("playwright-core/lib/cli/program"));
+var _base = require("./reporters/base");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * 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.
+ */
+
+/* eslint-disable no-console */
+
+function addTestCommand(program) {
+  const command = program.command('test [test-filter...]');
+  command.description('run tests with Playwright Test');
+  const options = testOptions.sort((a, b) => a[0].replace(/-/g, '').localeCompare(b[0].replace(/-/g, '')));
+  options.forEach(([name, description]) => command.option(name, description));
+  command.action(async (args, opts) => {
+    try {
+      await runTests(args, opts);
+    } catch (e) {
+      console.error(e);
+      (0, _utils.gracefullyProcessExitDoNotHang)(1);
+    }
+  });
+  command.addHelpText('afterAll', `
+Arguments [test-filter...]:
+  Pass arguments to filter test files. Each argument is treated as a regular expression. Matching is performed against the absolute file paths.
+
+Examples:
+  $ npx playwright test my.spec.ts
+  $ npx playwright test some.spec.ts:42
+  $ npx playwright test --headed
+  $ npx playwright test --project=webkit`);
+}
+function addListFilesCommand(program) {
+  const command = program.command('list-files [file-filter...]', {
+    hidden: true
+  });
+  command.description('List files with Playwright Test tests');
+  command.option('-c, --config <file>', `Configuration file, or a test directory with optional "playwright.config.{m,c}?{js,ts}"`);
+  command.option('--project <project-name...>', `Only run tests from the specified list of projects (default: list all projects)`);
+  command.action(async (args, opts) => {
+    try {
+      await listTestFiles(opts);
+    } catch (e) {
+      console.error(e);
+      (0, _utils.gracefullyProcessExitDoNotHang)(1);
+    }
+  });
+}
+function addShowReportCommand(program) {
+  const command = program.command('show-report [report]');
+  command.description('show HTML report');
+  command.action((report, options) => (0, _html.showHTMLReport)(report, options.host, +options.port));
+  command.option('--host <host>', 'Host to serve report on', 'localhost');
+  command.option('--port <port>', 'Port to serve report on', '9323');
+  command.addHelpText('afterAll', `
+Arguments [report]:
+  When specified, opens given report, otherwise opens last generated report.
+
+Examples:
+  $ npx playwright show-report
+  $ npx playwright show-report playwright-report`);
+}
+function addMergeReportsCommand(program) {
+  const command = program.command('merge-reports [dir]', {
+    hidden: true
+  });
+  command.description('merge multiple blob reports (for sharded tests) into a single report');
+  command.action(async (dir, options) => {
+    try {
+      await mergeReports(dir, options);
+    } catch (e) {
+      console.error(e);
+      (0, _utils.gracefullyProcessExitDoNotHang)(1);
+    }
+  });
+  command.option('-c, --config <file>', `Configuration file. Can be used to specify additional configuration for the output report.`);
+  command.option('--reporter <reporter>', `Reporter to use, comma-separated, can be ${_config.builtInReporters.map(name => `"${name}"`).join(', ')} (default: "${_config.defaultReporter}")`);
+  command.addHelpText('afterAll', `
+Arguments [dir]:
+  Directory containing blob reports.
+
+Examples:
+  $ npx playwright merge-reports playwright-report`);
+}
+async function runTests(args, opts) {
+  await (0, _utils.startProfiling)();
+
+  // When no --config option is passed, let's look for the config file in the current directory.
+  const configFileOrDirectory = opts.config ? _path.default.resolve(process.cwd(), opts.config) : process.cwd();
+  const resolvedConfigFile = (0, _configLoader.resolveConfigFile)(configFileOrDirectory);
+  if (restartWithExperimentalTsEsm(resolvedConfigFile)) return;
+  const overrides = overridesFromOptions(opts);
+  const configLoader = new _configLoader.ConfigLoader(overrides);
+  let config;
+  if (resolvedConfigFile) config = await configLoader.loadConfigFile(resolvedConfigFile, opts.deps === false);else config = await configLoader.loadEmptyConfig(configFileOrDirectory);
+  config.cliArgs = args;
+  config.cliGrep = opts.grep;
+  config.cliGrepInvert = opts.grepInvert;
+  config.cliListOnly = !!opts.list;
+  config.cliProjectFilter = opts.project || undefined;
+  config.cliPassWithNoTests = !!opts.passWithNoTests;
+  const runner = new _runner.Runner(config);
+  let status;
+  if (opts.ui || opts.uiHost || opts.uiPort) status = await runner.uiAllTests({
+    host: opts.uiHost,
+    port: opts.uiPort ? +opts.uiPort : undefined
+  });else if (process.env.PWTEST_WATCH) status = await runner.watchAllTests();else status = await runner.runAllTests();
+  await (0, _utils.stopProfiling)('runner');
+  const exitCode = status === 'interrupted' ? 130 : status === 'passed' ? 0 : 1;
+  (0, _utils.gracefullyProcessExitDoNotHang)(exitCode);
+}
+async function listTestFiles(opts) {
+  // Redefine process.stdout.write in case config decides to pollute stdio.
+  const stdoutWrite = process.stdout.write.bind(process.stdout);
+  process.stdout.write = () => {};
+  process.stderr.write = () => {};
+  const configFileOrDirectory = opts.config ? _path.default.resolve(process.cwd(), opts.config) : process.cwd();
+  const resolvedConfigFile = (0, _configLoader.resolveConfigFile)(configFileOrDirectory);
+  if (restartWithExperimentalTsEsm(resolvedConfigFile)) return;
+  try {
+    const configLoader = new _configLoader.ConfigLoader();
+    const config = await configLoader.loadConfigFile(resolvedConfigFile);
+    const runner = new _runner.Runner(config);
+    const report = await runner.listTestFiles(opts.project);
+    stdoutWrite(JSON.stringify(report), () => {
+      (0, _utils.gracefullyProcessExitDoNotHang)(0);
+    });
+  } catch (e) {
+    const error = (0, _util.serializeError)(e);
+    error.location = (0, _base.prepareErrorStack)(e.stack).location;
+    stdoutWrite(JSON.stringify({
+      error
+    }), () => {
+      (0, _utils.gracefullyProcessExitDoNotHang)(0);
+    });
+  }
+}
+async function mergeReports(reportDir, opts) {
+  let configFile = opts.config;
+  if (configFile) {
+    configFile = _path.default.resolve(process.cwd(), configFile);
+    if (!_fs.default.existsSync(configFile)) throw new Error(`${configFile} does not exist`);
+    if (!_fs.default.statSync(configFile).isFile()) throw new Error(`${configFile} is not a file`);
+  }
+  if (restartWithExperimentalTsEsm(configFile)) return;
+  const configLoader = new _configLoader.ConfigLoader();
+  const config = await (configFile ? configLoader.loadConfigFile(configFile) : configLoader.loadEmptyConfig(process.cwd()));
+  const dir = _path.default.resolve(process.cwd(), reportDir || '');
+  const dirStat = await _fs.default.promises.stat(dir).catch(e => null);
+  if (!dirStat) throw new Error('Directory does not exist: ' + dir);
+  if (!dirStat.isDirectory()) throw new Error(`"${dir}" is not a directory`);
+  let reporterDescriptions = resolveReporterOption(opts.reporter);
+  if (!reporterDescriptions && configFile) reporterDescriptions = config.config.reporter;
+  if (!reporterDescriptions) reporterDescriptions = [[_config.defaultReporter]];
+  const rootDirOverride = configFile ? config.config.rootDir : undefined;
+  await (0, _merge.createMergedReport)(config, dir, reporterDescriptions, rootDirOverride);
+  (0, _utils.gracefullyProcessExitDoNotHang)(0);
+}
+function overridesFromOptions(options) {
+  const shardPair = options.shard ? options.shard.split('/').map(t => parseInt(t, 10)) : undefined;
+  const overrides = {
+    forbidOnly: options.forbidOnly ? true : undefined,
+    fullyParallel: options.fullyParallel ? true : undefined,
+    globalTimeout: options.globalTimeout ? parseInt(options.globalTimeout, 10) : undefined,
+    maxFailures: options.x ? 1 : options.maxFailures ? parseInt(options.maxFailures, 10) : undefined,
+    outputDir: options.output ? _path.default.resolve(process.cwd(), options.output) : undefined,
+    quiet: options.quiet ? options.quiet : undefined,
+    repeatEach: options.repeatEach ? parseInt(options.repeatEach, 10) : undefined,
+    retries: options.retries ? parseInt(options.retries, 10) : undefined,
+    reporter: resolveReporterOption(options.reporter),
+    shard: shardPair ? {
+      current: shardPair[0],
+      total: shardPair[1]
+    } : undefined,
+    timeout: options.timeout ? parseInt(options.timeout, 10) : undefined,
+    ignoreSnapshots: options.ignoreSnapshots ? !!options.ignoreSnapshots : undefined,
+    updateSnapshots: options.updateSnapshots ? 'all' : undefined,
+    workers: options.workers
+  };
+  if (options.browser) {
+    const browserOpt = options.browser.toLowerCase();
+    if (!['all', 'chromium', 'firefox', 'webkit'].includes(browserOpt)) throw new Error(`Unsupported browser "${options.browser}", must be one of "all", "chromium", "firefox" or "webkit"`);
+    const browserNames = browserOpt === 'all' ? ['chromium', 'firefox', 'webkit'] : [browserOpt];
+    overrides.projects = browserNames.map(browserName => {
+      return {
+        name: browserName,
+        use: {
+          browserName
+        }
+      };
+    });
+  }
+  if (options.headed || options.debug) overrides.use = {
+    headless: false
+  };
+  if (!options.ui && options.debug) {
+    overrides.maxFailures = 1;
+    overrides.timeout = 0;
+    overrides.workers = 1;
+    process.env.PWDEBUG = '1';
+  }
+  if (!options.ui && options.trace) {
+    if (!kTraceModes.includes(options.trace)) throw new Error(`Unsupported trace mode "${options.trace}", must be one of ${kTraceModes.map(mode => `"${mode}"`).join(', ')}`);
+    overrides.use = overrides.use || {};
+    overrides.use.trace = options.trace;
+  }
+  return overrides;
+}
+function resolveReporterOption(reporter) {
+  if (!reporter || !reporter.length) return undefined;
+  return reporter.split(',').map(r => [resolveReporter(r)]);
+}
+function resolveReporter(id) {
+  if (_config.builtInReporters.includes(id)) return id;
+  const localPath = _path.default.resolve(process.cwd(), id);
+  if (_fs.default.existsSync(localPath)) return localPath;
+  return require.resolve(id, {
+    paths: [process.cwd()]
+  });
+}
+function restartWithExperimentalTsEsm(configFile) {
+  const nodeVersion = +process.versions.node.split('.')[0];
+  // New experimental loader is only supported on Node 16+.
+  if (nodeVersion < 16) return false;
+  if (!configFile) return false;
+  if (process.env.PW_DISABLE_TS_ESM) return false;
+  if (process.env.PW_TS_ESM_ON) {
+    // clear execArgv after restart, so that childProcess.fork in user code does not inherit our loader.
+    process.execArgv = (0, _util.execArgvWithoutExperimentalLoaderOptions)();
+    return false;
+  }
+  if (!(0, _util.fileIsModule)(configFile)) return false;
+  const innerProcess = require('child_process').fork(require.resolve('./cli'), process.argv.slice(2), {
+    env: {
+      ...process.env,
+      PW_TS_ESM_ON: '1'
+    },
+    execArgv: (0, _util.execArgvWithExperimentalLoaderOptions)()
+  });
+  innerProcess.on('close', code => {
+    if (code !== 0 && code !== null) (0, _utils.gracefullyProcessExitDoNotHang)(code);
+  });
+  return true;
+}
+const kTraceModes = ['on', 'off', 'on-first-retry', 'on-all-retries', 'retain-on-failure'];
+const testOptions = [['--browser <browser>', `Browser to use for tests, one of "all", "chromium", "firefox" or "webkit" (default: "chromium")`], ['-c, --config <file>', `Configuration file, or a test directory with optional "playwright.config.{m,c}?{js,ts}"`], ['--debug', `Run tests with Playwright Inspector. Shortcut for "PWDEBUG=1" environment variable and "--timeout=0 --max-failures=1 --headed --workers=1" options`], ['--forbid-only', `Fail if test.only is called (default: false)`], ['--fully-parallel', `Run all tests in parallel (default: false)`], ['--global-timeout <timeout>', `Maximum time this test suite can run in milliseconds (default: unlimited)`], ['-g, --grep <grep>', `Only run tests matching this regular expression (default: ".*")`], ['-gv, --grep-invert <grep>', `Only run tests that do not match this regular expression`], ['--headed', `Run tests in headed browsers (default: headless)`], ['--ignore-snapshots', `Ignore screenshot and snapshot expectations`], ['--list', `Collect all the tests and report them, but do not run`], ['--max-failures <N>', `Stop after the first N failures`], ['--no-deps', 'Do not run project dependencies'], ['--output <dir>', `Folder for output artifacts (default: "test-results")`], ['--pass-with-no-tests', `Makes test run succeed even if no tests were found`], ['--project <project-name...>', `Only run tests from the specified list of projects (default: run all projects)`], ['--quiet', `Suppress stdio`], ['--repeat-each <N>', `Run each test N times (default: 1)`], ['--reporter <reporter>', `Reporter to use, comma-separated, can be ${_config.builtInReporters.map(name => `"${name}"`).join(', ')} (default: "${_config.defaultReporter}")`], ['--retries <retries>', `Maximum retry count for flaky tests, zero for no retries (default: no retries)`], ['--shard <shard>', `Shard tests and execute only the selected shard, specify in the form "current/all", 1-based, for example "3/5"`], ['--timeout <timeout>', `Specify test timeout threshold in milliseconds, zero for unlimited (default: ${_config.defaultTimeout})`], ['--trace <mode>', `Force tracing mode, can be ${kTraceModes.map(mode => `"${mode}"`).join(', ')}`], ['--ui', `Run tests in interactive UI mode`], ['--ui-host <host>', 'Host to serve UI on; specifying this option opens UI in a browser tab'], ['--ui-port <port>', 'Port to serve UI on, 0 for any free port; specifying this option opens UI in a browser tab'], ['-u, --update-snapshots', `Update snapshots with actual results (default: only create missing snapshots)`], ['-j, --workers <workers>', `Number of concurrent workers or percentage of logical CPU cores, use 1 to run in a single worker (default: 50%)`], ['-x', `Stop after the first failure`]];
+addTestCommand(_program.default);
+addShowReportCommand(_program.default);
+addListFilesCommand(_program.default);
+addMergeReportsCommand(_program.default);
+_program.default.parse(process.argv);