Configuration

Copyimport { defineConfig, Platform } from 'taqwright';

// Every config knob is listed here. Essentials are uncommented; everything
// else is a commented placeholder you can enable by removing the leading
// "// ". Hover any field in your editor for the full type docs.
export default defineConfig({
  testDir: './tests',
  timeout: 60_000,
  expectTimeout: 30_000,
  // 'html' writes playwright-report/ — view it with: npx taqwright show-report
  reporter: [['list'], ['html', { open: 'never' }]],

  // ─── Optional top-level overrides ─────────────────────────────────
  // retries: 1,
  // outputDir: './test-results',
  // fullyParallel: false,
  // forbidOnly: !!process.env.CI,
  // testMatch: ['**/*.spec.ts'],
  // testIgnore: ['**/wip/**'],
  // globalSetup: './setup.ts',
  // globalTeardown: './teardown.ts',

  projects: [
    {
      name: 'android',
      use: {
        platform: Platform.ANDROID,
        device: {
          provider: 'emulator',
          name: 'taqwright_api34',          // AVD from `taqwright install --with-avd`
          // osVersion: '14',
          // udid: 'emulator-5554',
          // orientation: 'portrait',
          //
          // ─── Parallel runs (optional) ────────────────────────────
          // Declare a pool of devices to fan tests out across, then
          // bump `workers` at the top of this config to match. Worker
          // N picks pool[N]; `workers > pool.length` fails fast. Each
          // worker gets its own Appium + driver ports auto-staggered.
          // pool: [
          //   { udid: 'emulator-5554', name: 'Pixel_7_API_34' },
          //   { udid: 'emulator-5556', name: 'Pixel_7_API_34_2' },
          //   { udid: 'emulator-5558', name: 'Pixel_7_API_34_3' },
          // ],
        },
        // Spawn `npx appium` automatically when nothing is listening on
        // the configured host:port. Set `autoStart: false` to manage
        // Appium yourself (e.g. when Appium runs in Docker — see the
        // `Run in Docker` guide).
        appium: {
          autoStart: true,
          // Boot an offline Android emulator automatically. Needs a
          // string device.name equal to the AVD id (e.g. 'Pixel_7_API_34',
          // see 'emulator -list-avds'); a RegExp name is rejected at
          // config load. iOS simulators boot via XCUITest regardless.
          autoStartDevice: true,   // cold-boots the taqwright_api34 AVD
          host: 'localhost',
          port: 4723,           // Appium 3 default
          path: '/',            // Appium 3 default (Appium 1.x used '/wd/hub')
          // newCommandTimeout: 240,
          // logLevel: 'warn',
        },

        // ─── Reset between tests ────────────────────────────────────
        // Bound to the bundled demo app (app/DemoApp-v1.0.0.apk).
        // resetBetweenTests reinstalls + relaunches it fresh before every
        // test, so each starts from a known state. All three are
        // type-required together.
        resetBetweenTests: true,
        buildPath: './app/DemoApp-v1.0.0.apk',
        appBundleId: 'com.taqelah.demo_app',

        // ─── Extra capabilities (escape hatch) ──────────────────────
        // Anything Appium accepts; merged on top of the auto-built caps.
        // capabilities: {
        //   'appium:autoGrantPermissions': true,
        //   'appium:autoAcceptAlerts': true,
        // },

        // ─── Per-project locator-action timeout (ms) ────────────────
        // Overrides the top-level `expectTimeout` for this project only.
        // expectTimeout: 30_000,

        // ─── Trace artifact ─────────────────────────────────────────
        // Captures a per-action screenshot + page-source timeline as a
        // self-contained `trace.html` under the test's output dir, also
        // attached to the Playwright HTML report. Adds one screenshot +
        // page-source round-trip per action (~100–300ms local, more
        // over USB) — recommended for CI: 'on-failure'.
        //   'off'                — no overhead (default)
        //   'on'                 — every test
        //   'on-failure'         — only failed tests
        //   'retain-on-failure'  — alias of 'on-failure' on mobile
        // trace: 'on-failure',

        // ─── Screen recording (video) ───────────────────────────────
        // Records the device screen via Appium for the whole run and
        // attaches a screen.mp4 to the Playwright HTML report (as
        // 'taqwright-video'). No per-action cost like trace, but every
        // run pays the device recorder + an mp4 transfer at teardown —
        // recommended for CI: 'on-failure'. iOS-simulator support varies.
        //   'off'                — no recording (default)
        //   'on'                 — every test
        //   'on-failure'         — only failed tests
        //   'retain-on-failure'  — alias of 'on-failure' on mobile
        // video: 'on-failure',
      },

      // ─── Per-project test-runner overrides ────────────────────────
      // timeout: 90_000,
      // retries: 2,
      // grep: /smoke/,
      // grepInvert: /flaky/,
      // dependencies: ['setup'],
      // testMatch: ['**/android/*.spec.ts'],
    },

    // ─── Cloud examples (BrowserStack / LambdaTest) ─────────────────
    // Uncomment a block below to add a cloud project. Set the matching
    // env vars before launching:
    //   BROWSERSTACK_USERNAME / BROWSERSTACK_ACCESS_KEY
    //   LAMBDATEST_USERNAME    / LAMBDATEST_ACCESS_KEY
    // For now, cloud devices are wired through the inspector
    // ('taqwright inspect'); cloud test-runner support lands separately.
    //
    // {
    //   name: 'browserstack',
    //   use: {
    //     platform: Platform.ANDROID,
    //     device: {
    //       provider: 'browserstack',
    //       name: 'Google Pixel 8',
    //       osVersion: '14.0',
    //       orientation: 'portrait',
    //     },
    //     resetBetweenTests: true,
    //     buildPath: 'bs://<app-id-from-app-upload>',
    //     appBundleId: 'com.example.app',
    //   },
    // },
    // {
    //   name: 'lambdatest',
    //   use: {
    //     platform: Platform.IOS,
    //     device: {
    //       provider: 'lambdatest',
    //       name: 'iPhone 15',
    //       osVersion: '17',
    //     },
    //     resetBetweenTests: true,
    //     buildPath: 'lt://<app-id-from-app-upload>',
    //     appBundleId: 'com.example.MyApp',
    //   },
    // },
  ],
});

Copycapabilities: {
  ...iosParallelCaps(0),                              // WDA ports + tunings (slot 0)
  'appium:forceSimulatorSoftwareKeyboardPresence': true, // your extra cap, merged on top
},

Copycapabilities: iosParallelCaps(0, {
  useNewWDA: false,           // reuse WDA across sessions
  wdaLaunchTimeout: 180_000,  // 3 min for slower CI machines
}),