@devicelab/maestro-runner-darwin-arm64 1.1.27 → 1.1.29

package/drivers/ios/WebDriverAgent/package.json

@@ -1,93 +1,29 @@
 {
   "name": "appium-webdriveragent",
-  "version": "11.1.3",
+  "version": "16.12.8",
   "description": "Package bundling WebDriverAgent",
-  "main": "./build/index.js",
-  "types": "./build/index.d.ts",
-  "scripts": {
-    "build": "tsc -b",
-    "dev": "npm run build -- --watch",
-    "clean": "npm run build -- --clean",
-    "lint": "eslint .",
-    "format": "prettier -w ./lib",
-    "lint:fix": "npm run lint -- --fix",
-    "prepare": "npm run build",
-    "version": "npm run sync-wda-version",
-    "test": "mocha --exit --timeout 1m \"./test/unit/**/*-specs.ts\"",
-    "e2e-test": "mocha --exit --timeout 10m \"./test/functional/**/*-specs.ts\"",
-    "bundle": "npm run bundle:ios && npm run bundle:tv",
-    "bundle:ios": "TARGET=runner SDK=sim node ./Scripts/build-webdriveragent.mjs",
-    "bundle:tv": "TARGET=tv_runner SDK=tv_sim node ./Scripts/build-webdriveragent.mjs",
-    "fetch-prebuilt-wda": "node ./Scripts/fetch-prebuilt-wda.mjs",
-    "sync-wda-version": "node ./Scripts/update-wda-version.mjs --package-version=${npm_package_version} && git add WebDriverAgentLib/Info.plist"
-  },
-  "engines": {
-    "node": "^20.19.0 || ^22.12.0 || >=24.0.0",
-    "npm": ">=10"
-  },
-  "prettier": {
-    "bracketSpacing": false,
-    "printWidth": 100,
-    "singleQuote": true
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/appium/WebDriverAgent.git"
-  },
   "keywords": [
     "Appium",
-    "iOS",
-    "WebDriver",
     "Selenium",
-    "WebDriverAgent"
+    "WebDriver",
+    "WebDriverAgent",
+    "iOS"
   ],
-  "author": "Appium Contributors",
-  "license": "Apache-2.0",
+  "homepage": "https://github.com/appium/WebDriverAgent#readme",
   "bugs": {
     "url": "https://github.com/appium/WebDriverAgent/issues"
   },
-  "homepage": "https://github.com/appium/WebDriverAgent#readme",
-  "devDependencies": {
-    "@appium/eslint-config-appium-ts": "^3.0.0",
-    "@appium/tsconfig": "^1.0.0-rc.1",
-    "@appium/types": "^1.0.0-rc.1",
-    "@semantic-release/changelog": "^6.0.1",
-    "@semantic-release/git": "^10.0.1",
-    "@types/bluebird": "^3.5.38",
-    "@types/lodash": "^4.14.196",
-    "@types/mocha": "^10.0.1",
-    "@types/node": "^25.0.0",
-    "appium-xcode": "^6.0.0",
-    "chai": "^6.0.0",
-    "chai-as-promised": "^8.0.0",
-    "conventional-changelog-conventionalcommits": "^9.0.0",
-    "node-simctl": "^8.0.0",
-    "mocha": "^11.0.1",
-    "prettier": "^3.0.0",
-    "semantic-release": "^25.0.2",
-    "semver": "^7.3.7",
-    "sinon": "^21.0.0",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.4.2"
-  },
-  "dependencies": {
-    "@appium/base-driver": "^10.0.0-rc.1",
-    "@appium/strongbox": "^1.0.0-rc.1",
-    "@appium/support": "^7.0.0-rc.1",
-    "appium-ios-device": "^3.0.0",
-    "appium-ios-simulator": "^8.0.0",
-    "async-lock": "^1.0.0",
-    "asyncbox": "^4.0.1",
-    "axios": "^1.4.0",
-    "bluebird": "^3.5.5",
-    "lodash": "^4.17.11",
-    "teen_process": "^4.0.7"
+  "license": "Apache-2.0",
+  "author": "Appium Contributors",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/appium/WebDriverAgent.git"
   },
   "files": [
-    "index.ts",
     "lib",
-    "build",
+    "build/lib",
     "Scripts/build.sh",
+    "Scripts/embed-runner-icon.sh",
     "Scripts/*.mjs",
     "Configurations",
     "PrivateHeaders",
@@ -96,7 +32,62 @@
     "WebDriverAgentRunner",
     "WebDriverAgentTests",
     "XCTWebDriverAgentLib",
-    "CHANGELOG.md",
-    "!build/test"
-  ]
+    "CHANGELOG.md"
+  ],
+  "type": "module",
+  "main": "./build/lib/index.js",
+  "types": "./build/lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./build/lib/index.d.ts",
+      "import": "./build/lib/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "dev": "npm run build -- --watch",
+    "clean": "npm run build -- --clean",
+    "lint": "oxlint -c oxlint.config.mjs .",
+    "lint:fix": "oxlint -c oxlint.config.mjs --fix .",
+    "format": "oxfmt -c oxfmt.config.mjs .",
+    "format:check": "oxfmt -c oxfmt.config.mjs --check .",
+    "prepare": "npm run build",
+    "version": "npm run sync-wda-version",
+    "test": "node --enable-source-maps --experimental-test-module-mocks --test --test-timeout=60000 \"./build/test/unit/**/*.spec.js\"",
+    "e2e-test": "node --enable-source-maps --test --test-force-exit --test-concurrency=1 --test-timeout=600000 \"./build/test/functional/**/*.spec.js\"",
+    "bundle": "npm run bundle:ios && npm run bundle:tv && npm run bundle:watch",
+    "bundle:ios": "TARGET=runner SDK=sim node ./Scripts/build-webdriveragent.mjs",
+    "bundle:tv": "TARGET=tv_runner SDK=tv_sim node ./Scripts/build-webdriveragent.mjs",
+    "bundle:watch": "TARGET=watch_runner SDK=watch_sim node ./Scripts/build-webdriveragent.mjs",
+    "fetch-prebuilt-wda": "node ./Scripts/fetch-prebuilt-wda.mjs",
+    "sync-wda-version": "node ./Scripts/update-wda-version.mjs --package-version=${npm_package_version} && git add WebDriverAgentLib/Info.plist"
+  },
+  "dependencies": {
+    "@appium/base-driver": "^10.8.0",
+    "@appium/strongbox": "^2.0.0",
+    "@appium/support": "^7.2.6",
+    "appium-ios-simulator": "^9.1.3",
+    "async-lock": "^1.0.0",
+    "asyncbox": "^6.4.3",
+    "axios": "^1.18.0",
+    "teen_process": "^4.2.0"
+  },
+  "devDependencies": {
+    "@appium/oxc-config": "^1.1.0",
+    "@appium/semantic-release-config": "^1.1.0",
+    "@appium/tsconfig": "^1.2.0",
+    "@appium/types": "^1.0.0-rc.1",
+    "@types/async-lock": "^1.4.2",
+    "@types/node": "^26.0.0",
+    "@types/sinon": "^22.0.0",
+    "appium-xcode": "^7.1.1",
+    "node-simctl": "^9.0.0",
+    "semver": "^7.3.7",
+    "sinon": "^22.0.0"
+  },
+  "engines": {
+    "node": "^20.19.0 || ^22.12.0 || >=24.0.0",
+    "npm": ">=10"
+  }
 }

package/drivers/ios/WebDriverAgent/release.config.mjs

@@ -0,0 +1,14 @@
+import releaseConfig from '@appium/semantic-release-config';
+
+export default releaseConfig({
+  githubAssets: [
+    'WebDriverAgentRunner-Runner.zip',
+    'WebDriverAgentRunner_tvOS-Runner.zip',
+    'WebDriverAgentRunner-Build-Sim-arm64.zip',
+    'WebDriverAgentRunner-Build-Sim-x86_64.zip',
+    'WebDriverAgentRunner_tvOS-Build-Sim-arm64.zip',
+    'WebDriverAgentRunner_tvOS-Build-Sim-x86_64.zip',
+    'WebDriverAgentRunner_watchOS-Build-Sim-arm64.zip',
+    'WebDriverAgentRunner_watchOS-Build-Sim-x86_64.zip',
+  ],
+});

package/drivers/ios/WebDriverAgent/test/functional/desired.ts

@@ -1,7 +1,11 @@
-import { util } from '@appium/support';
-
-export const PLATFORM_VERSION: string = process.env.PLATFORM_VERSION
-  ? process.env.PLATFORM_VERSION : '11.3';
-export const DEVICE_NAME: string = process.env.DEVICE_NAME
-  || (util.compareVersions(PLATFORM_VERSION, '>=', '13.0') ? 'iPhone X' : 'iPhone 6');
+export const PLATFORM_NAME: string = requireEnv('PLATFORM_NAME');
+export const PLATFORM_VERSION: string = requireEnv('PLATFORM_VERSION');
+export const DEVICE_NAME: string = requireEnv('DEVICE_NAME');
 
+function requireEnv(name: string): string {
+  const value = process.env[name];
+  if (!value) {
+    throw new Error(`${name} must be set via the ${name} env var`);
+  }
+  return value;
+}

package/drivers/ios/WebDriverAgent/test/functional/helpers/simulator.ts

@@ -1,34 +1,45 @@
-import _ from 'lodash';
-import { Simctl } from 'node-simctl';
-import { retryInterval } from 'asyncbox';
-import { killAllSimulators as simKill } from 'appium-ios-simulator';
-import { resetTestProcesses } from '../../../lib/utils';
-import type { AppleDevice } from '../../../lib/types';
+import {Simctl} from 'node-simctl';
 
-export async function killAllSimulators (): Promise<void> {
-  const simctl = new Simctl();
-  const allDevices = _.flatMap(_.values(await simctl.getDevices()));
-  const bootedDevices = allDevices.filter((device) => device.state === 'Booted');
+import type {AppleDevice} from '../../../lib/types.js';
+import {DEVICE_NAME} from '../desired.js';
+
+const LOCAL_SIM_BOOT_TIMEOUT_MS = 60 * 1000 * 5;
 
-  for (const {udid} of bootedDevices) {
-    // It is necessary to stop the corresponding xcodebuild process before killing
-    // the simulator, otherwise it will be automatically restarted
-    await resetTestProcesses(udid, true);
-    simctl.udid = udid;
-    await simctl.shutdownDevice();
+/**
+ * Locates the simulator these tests should run against.
+ *
+ * In CI, the workflow boots and settles a simulator ahead of time (via
+ * `futureware-tech/simulator-action` + `Scripts/ci/wait-for-simulator-idle.mjs`) and passes its
+ * UDID through `SIMULATOR_UDID` - these tests must not boot their own there, since CI applies the
+ * settle-wait stability fix once per job, not once per test file.
+ *
+ * Locally (no CI env), that setup isn't guaranteed, so this boots the existing simulator matching
+ * DEVICE_NAME if it isn't already running. It never creates a new device - if none matches, it
+ * throws and lists what's available.
+ */
+export async function getTargetDevice(): Promise<AppleDevice> {
+  if (process.env.CI) {
+    if (!process.env.SIMULATOR_UDID) {
+      throw new Error(
+        'SIMULATOR_UDID is not set. In CI, these tests expect the workflow to have already booted ' +
+          'and settled a simulator (see .github/workflows/functional-test.yml) and passed its UDID through.',
+      );
+    }
+    return {udid: process.env.SIMULATOR_UDID};
   }
-  await simKill();
-}
 
-export async function shutdownSimulator (device: AppleDevice): Promise<void> {
-  // stop XCTest processes if running to avoid unexpected side effects
-  await resetTestProcesses(device.udid, true);
-  await device.shutdown();
-}
+  const simctl = new Simctl();
+  const allDevices = Object.values(await simctl.getDevices()).flat();
+  const device = allDevices.find((d) => d.name === DEVICE_NAME);
+  if (!device) {
+    const available = [...new Set(allDevices.map((d) => d.name))].sort().join(', ');
+    throw new Error(`No simulator named '${DEVICE_NAME}' exists. Available simulators: ${available || '(none)'}`);
+  }
+
+  if (device.state !== 'Booted') {
+    simctl.udid = device.udid;
+    await simctl.startBootMonitor({shouldPreboot: true, timeout: LOCAL_SIM_BOOT_TIMEOUT_MS});
+  }
 
-export async function deleteDeviceWithRetry (udid: string): Promise<void> {
-  const simctl = new Simctl({udid});
-  try {
-    await retryInterval(10, 1000, simctl.deleteDevice.bind(simctl));
-  } catch {}
+  return {udid: device.udid};
 }

package/drivers/ios/WebDriverAgent/test/functional/webdriveragent-e2e.spec.ts

@@ -0,0 +1,100 @@
+import assert from 'node:assert/strict';
+import {randomUUID} from 'node:crypto';
+import {describe, before, afterEach, it} from 'node:test';
+
+import type {AppleDevice} from '../../lib/types.js';
+import {WebDriverAgent} from '../../lib/webdriveragent.js';
+import {PLATFORM_NAME, PLATFORM_VERSION} from './desired.js';
+import {getTargetDevice} from './helpers/simulator.js';
+
+const WDA_BASE_URL = 'http://localhost:8100';
+
+function getStartOpts(device: AppleDevice) {
+  return {
+    device,
+    platformName: PLATFORM_NAME,
+    platformVersion: PLATFORM_VERSION,
+    host: 'localhost',
+    port: 8100,
+    realDevice: false,
+    showXcodeLog: true,
+    wdaLaunchTimeout: 60 * 3 * 1000,
+  };
+}
+
+// /status and /source are both routed `.withoutSession` in WebDriverAgentLib, so they can be hit
+// directly after `launch()` without this package having to create a real WDA session first.
+async function assertWdaIsResponding(): Promise<void> {
+  const statusResponse = await fetch(`${WDA_BASE_URL}/status`);
+  assert.equal(statusResponse.status, 200);
+  const status = (await statusResponse.json()) as {value: {state: string; build: {productBundleIdentifier: string}}};
+  assert.equal(status.value.state, 'success');
+  assert.equal(typeof status.value.build.productBundleIdentifier, 'string');
+
+  const sourceResponse = await fetch(`${WDA_BASE_URL}/source`);
+  assert.equal(sourceResponse.status, 200);
+  const source = (await sourceResponse.json()) as {value: string};
+  assert.equal(typeof source.value, 'string');
+  assert.ok(source.value.length > 0, 'expected /source to return non-empty page source');
+
+  await assertSessionScopedSourceWorks();
+}
+
+// The sessionId passed to `agent.launch()` is only used for Appium-side proxy bookkeeping - it
+// never reaches WDA. Fetching source through `/session/:sessionId/source` (the form Appium
+// actually uses) needs a real WDA-issued session, created here via `POST /session`.
+async function assertSessionScopedSourceWorks(): Promise<void> {
+  const createSessionResponse = await fetch(`${WDA_BASE_URL}/session`, {
+    method: 'POST',
+    headers: {'Content-Type': 'application/json'},
+    body: JSON.stringify({capabilities: {alwaysMatch: {}, firstMatch: [{}]}}),
+  });
+  assert.equal(createSessionResponse.status, 200);
+  const session = (await createSessionResponse.json()) as {value: {sessionId: string}};
+  const wdaSessionId = session.value.sessionId;
+  assert.equal(typeof wdaSessionId, 'string');
+
+  try {
+    const sessionSourceResponse = await fetch(`${WDA_BASE_URL}/session/${wdaSessionId}/source`);
+    assert.equal(sessionSourceResponse.status, 200);
+    const sessionSource = (await sessionSourceResponse.json()) as {value: string};
+    assert.ok(sessionSource.value.length > 0, 'expected session-scoped /source to return non-empty page source');
+  } finally {
+    await fetch(`${WDA_BASE_URL}/session/${wdaSessionId}`, {method: 'DELETE'});
+  }
+}
+
+// Assumes a simulator is already booted and settled (the CI workflow, or the developer locally,
+// is responsible for that - see helpers/simulator.ts#getTargetDevice). These tests only cover
+// WDA build+startup, so they don't manage the simulator's lifecycle themselves.
+describe('WebDriverAgent', function () {
+  let device: AppleDevice;
+  let agent: WebDriverAgent | undefined;
+
+  before(async function () {
+    device = await getTargetDevice();
+  });
+
+  // Guarantees WDA gets shut down even if the test itself throws (e.g. a failed assertion),
+  // so a leftover process/port doesn't take down the next test too.
+  afterEach(async function () {
+    await agent?.quit();
+    agent = undefined;
+  });
+
+  it('should build and start WDA from sources', async function () {
+    agent = new WebDriverAgent(getStartOpts(device));
+
+    await agent.launch(randomUUID());
+    await assertWdaIsResponding();
+  });
+
+  it('should start WDA from a prebuilt binary', async function () {
+    // Relies on the build products the previous test already produced, exercising the
+    // `usePrebuiltWDA` (test-without-building) xcodebuild code path instead of a full rebuild.
+    agent = new WebDriverAgent({...getStartOpts(device), usePrebuiltWDA: true});
+
+    await agent.launch(randomUUID());
+    await assertWdaIsResponding();
+  });
+});

package/drivers/ios/WebDriverAgent/test/unit/processes.spec.ts

@@ -0,0 +1,99 @@
+import assert from 'node:assert/strict';
+import {describe, beforeEach, it, mock} from 'node:test';
+
+interface ExecCall {
+  cmd: string;
+  args: string[];
+}
+
+let pgrepStdout = '';
+let cmdlineByPid: Record<string, string> = {};
+let killedPids: string[] = [];
+const execCalls: ExecCall[] = [];
+
+async function fakeExec(cmd: string, args: string[] = []): Promise<{stdout: string}> {
+  execCalls.push({cmd, args});
+  if (cmd === 'pgrep') {
+    return {stdout: pgrepStdout};
+  }
+  if (cmd === 'ps') {
+    const pid = args[args.indexOf('-p') + 1];
+    return {stdout: cmdlineByPid[pid] ?? ''};
+  }
+  if (cmd === 'kill') {
+    if (args[0] === '-0') {
+      // Report the process as already gone, so killAppUsingPattern does not
+      // wait out the full polling window on every signal.
+      throw Object.assign(new Error('No such process'), {code: 1});
+    }
+    killedPids.push(...args.filter((a) => !a.startsWith('-')));
+    return {stdout: ''};
+  }
+  throw new Error(`Unexpected exec call: ${cmd} ${args.join(' ')}`);
+}
+
+mock.module('teen_process', {
+  namedExports: {
+    exec: (...args: [string, string[]?]) => fakeExec(...args),
+  },
+});
+
+const {killAppUsingPattern, resetTestProcesses} = await import('../../lib/utils/processes.js');
+const {XCODEBUILD_PROCESS_MARKER} = await import('../../lib/constants.js');
+
+describe('processes', function () {
+  beforeEach(function () {
+    pgrepStdout = '';
+    cmdlineByPid = {};
+    killedPids = [];
+    execCalls.length = 0;
+  });
+
+  describe('#killAppUsingPattern', function () {
+    it('kills every matched pid when no cmdline filter is given', async function () {
+      pgrepStdout = '111 222';
+      await killAppUsingPattern('xcodebuild.*some-udid');
+      assert.deepStrictEqual(killedPids.sort(), ['111', '222']);
+    });
+
+    it('only kills pids whose full command line contains the given substring', async function () {
+      pgrepStdout = '111 222';
+      cmdlineByPid = {
+        111: `xcodebuild -destination id=some-udid ${XCODEBUILD_PROCESS_MARKER}`,
+        222: 'xcodebuild -destination id=some-udid', // unrelated xcodebuild instance, no marker
+      };
+      await killAppUsingPattern('xcodebuild.*some-udid', XCODEBUILD_PROCESS_MARKER);
+      assert.deepStrictEqual(killedPids, ['111']);
+    });
+
+    it('kills nothing when no matched pid contains the required substring', async function () {
+      pgrepStdout = '222';
+      cmdlineByPid = {
+        222: 'xcodebuild -destination id=some-udid',
+      };
+      await killAppUsingPattern('xcodebuild.*some-udid', XCODEBUILD_PROCESS_MARKER);
+      assert.deepStrictEqual(killedPids, []);
+    });
+  });
+
+  describe('#resetTestProcesses', function () {
+    it('scopes the xcodebuild pattern to this package own processes on a real device', async function () {
+      pgrepStdout = '111 222';
+      cmdlineByPid = {
+        111: `xcodebuild -destination id=some-udid ${XCODEBUILD_PROCESS_MARKER}`,
+        222: 'xcodebuild -destination id=some-udid', // e.g. a separately managed WDA instance
+      };
+      await resetTestProcesses('some-udid', false);
+      assert.deepStrictEqual(killedPids, ['111']);
+    });
+
+    it('does not apply the marker filter to the simulator XCTRunner/xctest patterns', async function () {
+      pgrepStdout = '333';
+      cmdlineByPid = {
+        333: 'some-path/XCTRunner some-udid', // no marker present, unlike the xcodebuild process
+      };
+      await resetTestProcesses('some-udid', true);
+      assert.ok(killedPids.includes('333'));
+    });
+  });
+});