@keepsnappy/agent 0.1.0-alpha.24 → 0.1.0-alpha.25

package/README.md

@@ -37,7 +37,7 @@ keepsnappy run -- maestro test --include-tags perf e2e/flows/   # wrap your own
 keepsnappy run --upload --wait                   # send the results; the server judges them and the CLI prints its verdict
 ```
 
-Flags: `--config` (default `keepsnappy.yml`), `--repeat N`, `--out DIR`, `--upload [--ingest-url URL]`, `--wait`, `--fail-on-worse`, `--commit SHA` / `--branch NAME` (default `GITHUB_SHA` / `GITHUB_HEAD_REF` on a pull request, else `GITHUB_REF_NAME`), `--base-commit SHA`, `--device-model` / `--device-os` (default: read from the booted simulator), `--scenario NAME` (flow name for a command given after `--`), `--replay <out dir>[:ARM]` (repeatable: take recorded runs instead of running anything), `--no-markers`, `--clock-offset-ms`.
+Flags: `--config` (default `keepsnappy.yml`), `--repeat N`, `--out DIR`, `--upload [--ingest-url URL]`, `--wait`, `--fail-on-worse`, `--commit SHA` / `--branch NAME` (default `GITHUB_SHA` / `GITHUB_HEAD_REF` on a pull request, else `GITHUB_REF_NAME`), `--base-commit SHA`, `--device UDID` (the simulator or iPhone to run on; default `device:` in keepsnappy.yml, else the only booted simulator; with several booted and none named the run refuses and lists them; every Maestro command gets it as `maestro --device UDID`), `--device-model` / `--device-os` (default: read from that simulator), `--scenario NAME` (flow name for a command given after `--`), `--replay <out dir>[:ARM]` (repeatable: take recorded runs instead of running anything), `--no-markers`, `--clock-offset-ms`.
 
 Commit details: when a run set opens (`keepsnappy run --upload`, `keepsnappy farm open`), the CLI reads the subject, author
 name and committer date of `--commit` and `--base-commit` with `git log` in the checkout (argv only, 5 s timeout) and
@@ -60,7 +60,7 @@ Annotated example: `examples/keepsnappy.yml`. Every setting:
 | `project.key_env` | Name of the env var with the project key (default `KEEPSNAPPY_KEY`). Only read with `--upload`. |
 | `project.ingest_url` | KeepSnappy API base URL for `--upload` (or `--ingest-url`, or env `KEEPSNAPPY_API`). Defaults to the hosted KeepSnappy API. |
 | `app.bundle_id` | Required. App whose keepsnappy log is read after each run. |
-| `platform`, `device` | `ios-sim` (default; `device` = UDID or `booted`) or `ios-device` (UDID required). One device per invocation in v1. |
+| `platform`, `device` | `ios-sim` (default; `device` = UDID, or `booted` for the only booted simulator: with several booted, name one) or `ios-device` (UDID required). One device per invocation in v1. |
 | `repetitions` | Runs of the whole flow set (default 5). |
 | `flows.runner` | `maestro` (build `maestro test ...`) or `command` (run `flows.command`). |
 | `flows.tags`, `flows.exclude_tags` | `--include-tags=` / `--exclude-tags=`. |

package/dist/appium-driver.js

@@ -546,7 +546,6 @@ class Driver {
         }
       ]
     });
-    await this.cmd("DELETE", "/actions").catch(() => null);
   }
   async stroke(from, points, note) {
     const safe = await this.safeBottomY();
@@ -662,7 +661,7 @@ async function iosCommand(driver, link, cmd, n, state, waitMs) {
 }
 var ANDROID = {
   name: "android",
-  defaultDevice: "Google Pixel 7-13.0",
+  defaultDevice: "Google Pixel 9 Pro-15.0",
   caps: (device) => ({
     platformName: "Android",
     "appium:automationName": "UiAutomator2",
@@ -937,7 +936,7 @@ async function rowsInList(t, spec, c) {
   const android = t.driver.platform.name === "android";
   const call = spec.field === "description" ? /descriptionMatches/ : /textMatches/;
   const own = android && spec.field ? all.filter((l) => call.test(l.value)) : all;
-  const attr = sel.text !== undefined ? android ? spec.field === "description" ? "content-desc" : "text" : "label" : android ? "resource-id" : "name";
+  const attr = rowAttr(t, sel, spec.field);
   const frames = [];
   const inside = [];
   const parent = spec.scoped ?? true ? c.at.el : undefined;
@@ -963,6 +962,10 @@ async function rowsInList(t, spec, c) {
     ids.push(String(await t.driver.attribute(el, attr).catch(() => null) ?? ""));
   return { ids, frames, list };
 }
+var rowAttr = (t, sel, field) => {
+  const android = t.driver.platform.name === "android";
+  return sel.text !== undefined ? android ? field === "description" ? "content-desc" : "text" : "label" : android ? "resource-id" : "name";
+};
 function room(t, { frames, list }, toward) {
   if (frames.length === 0)
     return false;
@@ -1140,7 +1143,7 @@ import { dirname, join, relative, resolve } from "node:path";
 import { fileURLToPath } from "node:url";
 var DRIVER_NAME = "appium";
 function driverVersion() {
-  const built = "0.1.0-alpha.24";
+  const built = "0.1.0-alpha.25";
   if (built)
     return built;
   let dir = dirname(fileURLToPath(import.meta.url));
@@ -1334,6 +1337,7 @@ class Session {
   capture;
   gcN = 0;
   stepDepth = 0;
+  beforeLaunchOpen = false;
   stepLog = [];
   defects = { gestureRetry: 0, navStuck: 0, navCatchUp: 0, items: [] };
   navigating = false;
@@ -1352,6 +1356,7 @@ class Session {
     this.capture = o.capture;
   }
   async gc(atEnd = false) {
+    this.notInBeforeLaunch("GC command");
     if (this.actionGc !== "step" && !(atEnd && this.endGc && this.actionGc === "off"))
       return null;
     if (this.linkState.linkMode === "safari") {
@@ -1369,6 +1374,7 @@ class Session {
   }
   memReadOff = false;
   async memRead(n) {
+    this.notInBeforeLaunch("memory read");
     if (n === null || this.memReadOff || this.linkState.linkMode === "safari")
       return false;
     const start = this.now();
@@ -1398,6 +1404,7 @@ class Session {
     return took;
   }
   async navigation(fn) {
+    this.notInBeforeLaunch("navigation pass");
     if (this.stepDepth > 0)
       throw new Error("a navigation pass cannot run inside a measured step");
     if (this.navigating)
@@ -1419,10 +1426,16 @@ class Session {
   declaresSteps() {
     return this.markers.some((m) => m.phase === "start" && m.step !== NAV_STEP);
   }
+  notInBeforeLaunch(what) {
+    if (this.beforeLaunchOpen)
+      throw new Error(`no step or marker in beforeLaunch (${what}): it runs before the measured launch`);
+  }
   marker(step, phase, gcN = null) {
+    this.notInBeforeLaunch(`marker ${step}:${phase}`);
     this.markers.push({ token: this.token, step, phase, t_host: this.now(), ...gcN !== null ? { gc_n: gcN } : {} });
   }
   async step(name, action, checks = noop, once = noop) {
+    this.notInBeforeLaunch(`step ${name}`);
     if (this.navigating)
       throw new Error("a measured step cannot start inside a navigation pass");
     await this.ready();
@@ -1743,7 +1756,7 @@ class Session {
   activate() {
     return this.driver.activate();
   }
-  async beginRun({ token, args = "", home }) {
+  async beginRun({ token, args = "", home, beforeLaunch }) {
     this.token = token;
     if (token)
       this.opened.add(token);
@@ -1753,6 +1766,14 @@ class Session {
     await this.waitVisible(home, HOME_READY_MS);
     const alert = await this.openLink(activationLink(this.scheme, token, args));
     await this.driver.sleep(ACTIVATION_SETTLE_MS);
+    if (beforeLaunch) {
+      this.beforeLaunchOpen = true;
+      try {
+        await beforeLaunch();
+      } finally {
+        this.beforeLaunchOpen = false;
+      }
+    }
     await this.relaunch();
     await this.waitVisible(home, HOME_READY_MS);
     if (token && this.linkState.linkMode !== "safari")
@@ -2160,11 +2181,22 @@ async function runIterations(t, module, ctx, iterations, progress) {
     progress();
     driver.context = { journey: it.journey, iteration: it.iteration, phase: "begin" };
     const t0 = t.now();
-    rec.alert = await t.beginRun({ token: it.token, home: module.home, ...module.sdkArgs ? { args: module.sdkArgs } : {} });
+    const itCtx = { ...ctx, journey: it.journey, iteration: it.iteration };
+    const hook = module.beforeLaunch;
+    const beforeLaunch = hook && (async () => {
+      driver.context = { ...driver.context, phase: "before-launch" };
+      try {
+        await hook(t, itCtx);
+      } catch (e) {
+        throw new Error(`beforeLaunch failed (${it.journey} #${it.iteration}): ${e instanceof Error ? e.message : String(e)}`, { cause: e });
+      }
+      driver.context = { ...driver.context, phase: "begin" };
+    });
+    rec.alert = await t.beginRun({ token: it.token, home: module.home, ...module.sdkArgs ? { args: module.sdkArgs } : {}, ...beforeLaunch ? { beforeLaunch } : {} });
     const t1 = t.now();
     driver.context = { ...driver.context, phase: "journey" };
     const waitsBefore = t.readyWaits.length;
-    await module.journeys[it.journey](t, { ...ctx, journey: it.journey, iteration: it.iteration });
+    await module.journeys[it.journey](t, itCtx);
     await t.ready();
     const t2 = t.now();
     t.marker("run:complete", "end");