simframe 0.5.0 → 0.6.0-rc.1

package/src/refs.js

@@ -0,0 +1,141 @@
+// Element refs and selectors.
+//
+// A number in front of every element is what lets the next call name one
+// without describing it: `#3` instead of "the second Save button, the one in
+// the nav bar". The table lives on disk because the call that numbered the
+// elements and the call that acts on one are separate MCP round trips.
+//
+// Kept apart from view.js so that index.js can resolve a selector without
+// importing the renderer that in turn imports index.js.
+import fs from 'node:fs';
+import path from 'node:path';
+import { hashDistance } from './analyze.js';
+import * as store from './store.js';
+
+/**
+ * How far the pixel layout may drift before a ref is no longer trustworthy.
+ *
+ * The same number screen memory uses to decide two frames are the same screen,
+ * and for the same reason: a list that gained a row is still the screen the
+ * elements were numbered on, but a different screen is not.
+ */
+export const REF_TOLERANCE = 20;
+
+/**
+ * Does this layout hash carry enough signal to compare?
+ *
+ * A blank, dark or near-uniform screen hashes to almost all zeros, and the
+ * Hamming distance between two such hashes is tiny however different the
+ * screens are. Below this many set bits the hash is not evidence.
+ */
+const MIN_SET_BITS = 16;
+
+export function informative(hex) {
+  let bits = 0;
+  for (const ch of String(hex ?? '')) {
+    const v = parseInt(ch, 16);
+    if (Number.isNaN(v)) continue;
+    bits += (v & 1) + ((v >> 1) & 1) + ((v >> 2) & 1) + ((v >> 3) & 1);
+    if (bits >= MIN_SET_BITS) return true;
+  }
+  return false;
+}
+
+const refsFile = (udid) => path.join(store.deviceDir(udid), 'refs.json');
+
+/**
+ * Number the elements and write the table down.
+ *
+ * A ref is only meaningful while the screen it was numbered on is still
+ * showing, so the table records the screen's structural hash and resolving a
+ * ref against a different screen is an error rather than a tap somewhere
+ * unintended.
+ */
+export function writeRefs(udid, { structuralHash, layoutHash, rows }) {
+  const body = {
+    structuralHash: structuralHash ?? null,
+    layoutHash: layoutHash ?? null,
+    at: Date.now(),
+    refs: rows.map((r) => ({
+      ref: r.ref,
+      label: r.label ?? null,
+      x: r.x,
+      y: r.y,
+      type: r.type ?? null,
+      region: r.region ?? 'content',
+      source: r.source ?? null,
+    })),
+  };
+  try {
+    fs.mkdirSync(path.dirname(refsFile(udid)), { recursive: true });
+    store.writeAtomic(refsFile(udid), JSON.stringify(body));
+  } catch {
+    /* refs are a convenience; failing to cache them must not fail the call */
+  }
+  return body;
+}
+
+export function readRefs(udid) {
+  return store.readJson(refsFile(udid));
+}
+
+/**
+ * `#3` | `@120,400` | anything else.
+ *
+ * Parsing is separate from resolving so a caller can tell a selector from a
+ * label without touching the device.
+ */
+export function parseSelector(query) {
+  const raw = String(query ?? '').trim();
+  const ref = /^#(\d+)$/.exec(raw);
+  if (ref) return { kind: 'ref', ref: Number(ref[1]) };
+  const at = /^@\s*(-?\d+(?:\.\d+)?)\s*,\s*(-?\d+(?:\.\d+)?)$/.exec(raw);
+  if (at) return { kind: 'point', x: Math.round(Number(at[1])), y: Math.round(Number(at[2])) };
+  // A quoted label is an explicit "this exact text", not an intent.
+  const quoted = /^"(.*)"$/.exec(raw) || /^'(.*)'$/.exec(raw);
+  if (quoted) return { kind: 'label', label: quoted[1], exact: true };
+  return { kind: 'label', label: raw, exact: false };
+}
+
+/**
+ * Turn a `#n` back into a point.
+ *
+ * Refuses when the screen has moved on. A stale ref is the one failure mode
+ * numbering introduces that labels do not have, and a ref resolved against the
+ * wrong screen taps whatever now happens to sit at those coordinates.
+ */
+export function resolveRef(udid, n, { structuralHash, layoutHash, screenKnown, tolerance = REF_TOLERANCE } = {}) {
+  const table = readRefs(udid);
+  if (!table) throw new Error(`#${n} means nothing yet — read the screen first (sim_ui, or simframe ui)`);
+  const stale = (was, now) =>
+    `#${n} was numbered on a different screen (${was} → ${now}) — read the screen again before using refs`;
+
+  // Structural identity first, because it is the question actually being asked:
+  // is this the screen those numbers were assigned on? The caller gets it
+  // cheaply — screen memory is a file read, not a perception pass.
+  if (table.structuralHash && structuralHash && table.structuralHash !== structuralHash) {
+    throw new Error(stale(table.structuralHash.slice(0, 8), structuralHash.slice(0, 8)));
+  }
+  // Nothing recognises the screen we are on, so nothing can vouch for the
+  // numbers. Refusing costs a re-read; guessing taps whatever is at those
+  // coordinates now.
+  if (screenKnown === false) {
+    throw new Error(`#${n} cannot be trusted here — simframe does not recognise this screen. Read it again (sim_ui) to renumber.`);
+  }
+  // The pixel check stays, but only as a backstop, and only where it means
+  // something. A dark or near-uniform screen produces a layout hash of almost
+  // all zeros, and two such screens sit within any sane tolerance of each
+  // other — measured: refs numbered on the springboard resolved happily on a
+  // different screen because both hashes were degenerate. A hash with almost
+  // no bits set is not evidence of anything.
+  if (layoutHash && table.layoutHash && informative(table.layoutHash) && informative(layoutHash)
+    && hashDistance(table.layoutHash, layoutHash) > tolerance) {
+    throw new Error(stale(table.layoutHash.slice(0, 8), layoutHash.slice(0, 8)));
+  }
+  const hit = table.refs.find((r) => r.ref === n);
+  if (!hit) {
+    const available = table.refs.length ? `#1-#${table.refs.length}` : 'none';
+    throw new Error(`#${n} is not on this screen (numbered: ${available})`);
+  }
+  return hit;
+}

package/src/regions.js

@@ -1,10 +1,21 @@
 // Where on the screen something is, in the terms iOS itself uses.
 //
 // A label alone is ambiguous — "Assets" is both a screen title and a tab — but
-// a label plus a region rarely is. These are geometric priors from the Human
-// Interface Guidelines rather than anything read from the app, so they are
-// cheap, always available, and occasionally wrong in the same ways the
-// guidelines are.
+// a label plus a region rarely is. And the region matters more than it looks:
+// chrome labels are the only text that enters a screen's structural
+// fingerprint, so anything misfiled as chrome lands directly in that screen's
+// identity.
+//
+// This used to be fractions of screen height, and it cost three bugs in three
+// phases: a nav button read as a title, an identity containing "sep 08, 2026"
+// that would have expired at midnight, and a springboard whose identity was the
+// name of the city in its weather widget. Each was patched with another rule.
+//
+// The bands are now derived from where the elements themselves sit, because the
+// thing that actually distinguishes chrome from content is not height on the
+// screen — it is separation. A nav bar sits above a gap; a tab bar sits below
+// one; and a springboard, whose icon rows are evenly spaced from top to bottom,
+// has neither and should be told it has neither.
 export const REGIONS = [
   'status-bar',
   'nav-bar',
@@ -14,34 +25,199 @@ export const REGIONS = [
 ];
 
 /**
- * Fractions of screen height. Deliberately conservative: a band that is too
- * greedy mislabels content as chrome, and content is the common case.
+ * The status bar stays positional, and deliberately.
+ *
+ * It is a device inset — the notch or dynamic island — not app layout, so its
+ * position is a property of the hardware rather than of the screen. It has
+ * never been the source of a misclassification, and clustering it would mean
+ * inferring a constant from noise.
  */
-const BANDS = {
-  statusBar: 0.065,   // through the notch / dynamic island
-  navBar: 0.14,       // title and its leading/trailing controls
-  tabBar: 0.92,       // home indicator sits below this
-};
+const STATUS_BAR_FRACTION = 0.065;
 
 /** Keyboards occupy the bottom of the screen and are unusually tall. */
 const KEYBOARD_MIN_FRACTION = 0.28;
 
+/** Chrome is short. A 90pt list cell is not a tab item however low it sits. */
+const CHROME_MAX_HEIGHT_FRACTION = 0.075;
+
+/**
+ * How far into the screen chrome may reach.
+ *
+ * Not the decision — the gap is the decision — but a precondition, because a
+ * gap in the middle of a screen separates two pieces of content and nothing
+ * else. Generous on both ends so that a tall nav bar with a search field in it,
+ * or a tab bar above a home indicator, still qualifies.
+ */
+const TOP_CHROME_LIMIT = 0.28;
+const BOTTOM_CHROME_LIMIT = 0.82;
+
 /**
- * Chrome is short. Position alone is not enough: the last row of a long list
- * reaches into the tab-bar band, and calling a 90pt cell a tab item makes a
- * seven-row list a different screen from a three-row one.
+ * What makes a gap a boundary rather than spacing.
+ *
+ * Both conditions, because either alone is wrong. An absolute floor, since two
+ * rows 4pt apart are one visual group whatever the rest of the screen does; and
+ * a multiple of the screen's own median row gap, since 16pt is a boundary on a
+ * dense list and ordinary spacing on a sparse one. This is the whole idea: the
+ * screen sets its own scale.
  */
-const CHROME_MAX_HEIGHT_FRACTION = 0.075;
+const MIN_BOUNDARY_GAP_PT = 10;
+const BOUNDARY_GAP_FACTOR = 1.9;
+
+/** A tab bar is several things spread across the width, not one thing at the bottom. */
+const TAB_BAR_MIN_ITEMS = 2;
+const TAB_BAR_MIN_SPREAD = 0.4;
+
+/** Below this many elements there is no distribution to cluster; fall back. */
+const MIN_ELEMENTS_TO_CLUSTER = 6;
+
+/**
+ * Fractions of screen height, used only when clustering has nothing to work
+ * with. These are the old rules, kept because a screen with four elements on it
+ * still needs an answer and the HIG is a better guess than none.
+ */
+const FALLBACK = { navBar: 0.14, tabBar: 0.86 };
+
+const heightOf = (frame) => frame?.height ?? 0;
+const midY = (frame) => frame.y + heightOf(frame) / 2;
+
+/** Group elements into horizontal rows: a sweep down the screen, joining anything that overlaps. */
+export function rowsOf(elements) {
+  const items = elements
+    .filter((e) => e.frame && Number.isFinite(e.frame.y))
+    .map((e) => ({ e, top: e.frame.y, bottom: e.frame.y + heightOf(e.frame) }))
+    .sort((a, b) => midY(a.e.frame) - midY(b.e.frame));
+  const rows = [];
+  for (const it of items) {
+    const row = rows[rows.length - 1];
+    // Overlapping vertically means side by side, which means one row.
+    if (row && it.top < row.bottom) {
+      row.items.push(it.e);
+      row.top = Math.min(row.top, it.top);
+      row.bottom = Math.max(row.bottom, it.bottom);
+    } else {
+      rows.push({ items: [it.e], top: it.top, bottom: it.bottom });
+    }
+  }
+  return rows;
+}
+
+function medianOf(values) {
+  if (!values.length) return 0;
+  const v = [...values].sort((a, b) => a - b);
+  return v[v.length >> 1];
+}
+
+/**
+ * The horizontal reach of a row, as a fraction of screen width.
+ *
+ * A tab bar spans the screen; a single centred label does not. Measured between
+ * the outermost centres rather than the outermost edges, so one wide element
+ * cannot fake a spread on its own.
+ */
+function spreadOf(row, screen) {
+  if (!screen?.width || row.items.length < 2) return 0;
+  const centres = row.items.map((e) => e.frame.x + (e.frame.width ?? 0) / 2);
+  return (Math.max(...centres) - Math.min(...centres)) / screen.width;
+}
+
+const allShort = (row, screen) =>
+  row.items.every((e) => heightOf(e.frame) <= screen.height * CHROME_MAX_HEIGHT_FRACTION);
+
+/**
+ * Where this screen's bands actually are.
+ *
+ * Returns boundaries in points, so `regionFor` stays a cheap comparison and the
+ * clustering is paid for once per screen rather than once per element.
+ */
+export function bands(elements, screen) {
+  const keyboardTop = detectKeyboardTop(elements, screen);
+  const statusBarBottom = screen?.height ? screen.height * STATUS_BAR_FRACTION : 0;
+  if (!screen?.width || !screen?.height) {
+    return { statusBarBottom: 0, navBarBottom: 0, tabBarTop: Infinity, keyboardTop, clustered: false };
+  }
+
+  // Everything the bands are inferred from: on-screen, below the status bar,
+  // and above the keyboard if one is up. The status bar is a clock and a battery
+  // icon, and letting them vote on where the nav bar ends is how a nav bar came
+  // to include the clock.
+  const considered = elements.filter((e) => {
+    if (!e.frame || !Number.isFinite(e.frame.y)) return false;
+    if (e.frame.y + heightOf(e.frame) <= statusBarBottom) return false;
+    if (keyboardTop != null && e.frame.y >= keyboardTop) return false;
+    return e.frame.y < screen.height && e.frame.y + heightOf(e.frame) > 0;
+  });
+
+  const rows = rowsOf(considered);
+  if (rows.length < 3 || considered.length < MIN_ELEMENTS_TO_CLUSTER) {
+    return {
+      statusBarBottom,
+      navBarBottom: screen.height * FALLBACK.navBar,
+      tabBarTop: screen.height * FALLBACK.tabBar,
+      keyboardTop,
+      clustered: false,
+    };
+  }
 
-export function regionFor(frame, screen, { keyboardTop } = {}) {
+  const gaps = rows.slice(1).map((row, i) => row.top - rows[i].bottom);
+  const typical = medianOf(gaps.filter((g) => g > 0));
+  const isBoundary = (gap) => gap >= Math.max(MIN_BOUNDARY_GAP_PT, typical * BOUNDARY_GAP_FACTOR);
+
+  // --- top chrome. Up to two rows, because a nav bar can be a title above a
+  // search field, and no more, because three rows of anything is content.
+  let navBarBottom = 0;
+  for (let i = 0; i < Math.min(2, rows.length - 1); i += 1) {
+    const gap = rows[i + 1].top - rows[i].bottom;
+    const withinReach = rows[i].bottom <= screen.height * TOP_CHROME_LIMIT;
+    if (!withinReach) break;
+    if (isBoundary(gap) && rows.slice(0, i + 1).every((r) => allShort(r, screen))) {
+      navBarBottom = rows[i].bottom;
+      break;
+    }
+  }
+
+  // --- bottom chrome. One row: a tab bar is one row by construction, and the
+  // gap above it is what separates it from the list it floats over.
+  let tabBarTop = Infinity;
+  const last = rows[rows.length - 1];
+  const gapAbove = last.top - rows[rows.length - 2].bottom;
+  if (
+    last.top >= screen.height * BOTTOM_CHROME_LIMIT
+    && allShort(last, screen)
+    && last.items.length >= TAB_BAR_MIN_ITEMS
+    && spreadOf(last, screen) >= TAB_BAR_MIN_SPREAD
+    && isBoundary(gapAbove)
+  ) {
+    tabBarTop = last.top;
+  }
+
+  return { statusBarBottom, navBarBottom, tabBarTop, keyboardTop, clustered: true, typicalGap: typical };
+}
+
+/**
+ * Which band this frame falls in.
+ *
+ * `band` comes from `bands()`. Passing only `{keyboardTop}` still works and
+ * falls back to the HIG fractions, which is what callers that have one element
+ * and no screen context get.
+ */
+export function regionFor(frame, screen, band = {}) {
   if (!frame || !screen?.height) return 'content';
-  const top = frame.y / screen.height;
-  const bottom = (frame.y + (frame.height ?? 0)) / screen.height;
+  const { keyboardTop } = band;
   if (keyboardTop != null && frame.y >= keyboardTop) return 'keyboard';
-  const short = (frame.height ?? 0) <= screen.height * CHROME_MAX_HEIGHT_FRACTION;
-  if (bottom <= BANDS.statusBar) return 'status-bar';
-  if (short && top < BANDS.navBar && bottom < BANDS.navBar * 1.6) return 'nav-bar';
-  if (short && top >= BANDS.tabBar - 0.06) return 'tab-bar';
+
+  const top = frame.y;
+  const bottom = frame.y + heightOf(frame);
+  const statusBarBottom = band.statusBarBottom ?? screen.height * STATUS_BAR_FRACTION;
+  if (bottom <= statusBarBottom) return 'status-bar';
+
+  const short = heightOf(frame) <= screen.height * CHROME_MAX_HEIGHT_FRACTION;
+  const navBarBottom = band.navBarBottom ?? screen.height * FALLBACK.navBar;
+  const tabBarTop = band.tabBarTop ?? screen.height * FALLBACK.tabBar;
+  // A screen with no top chrome has navBarBottom 0, so nothing is a nav bar —
+  // which is the correct answer for a springboard, and the answer the old
+  // positional rule could not give.
+  if (short && navBarBottom > 0 && bottom <= navBarBottom + 1) return 'nav-bar';
+  if (short && top >= tabBarTop - 1) return 'tab-bar';
   return 'content';
 }
 
@@ -64,14 +240,15 @@ export function navSlot(frame, screen) {
  *
  * Inferred from a dense band of similar-height elements filling the bottom of
  * the screen — keys. Returns null when nothing looks like one, which is the
- * common case and must stay cheap.
+ * common case and must stay cheap. This was the first band derived from the
+ * elements rather than from a fraction, and it is the model the rest now follow.
  */
 export function detectKeyboardTop(elements, screen) {
   if (!screen?.height || elements.length < 12) return null;
   const threshold = screen.height * (1 - KEYBOARD_MIN_FRACTION);
   const low = elements.filter((e) => e.frame && e.frame.y > threshold);
   if (low.length < 12) return null;
-  const heights = low.map((e) => e.frame.height ?? 0).sort((a, b) => a - b);
+  const heights = low.map((e) => heightOf(e.frame)).sort((a, b) => a - b);
   const median = heights[heights.length >> 1];
   // Keys are small and uniform; a list of cells down there is not.
   const uniform = heights.filter((h) => Math.abs(h - median) <= Math.max(3, median * 0.4)).length;
@@ -81,9 +258,9 @@ export function detectKeyboardTop(elements, screen) {
 
 /** Annotate a target list with region and nav slot. Mutates and returns it. */
 export function annotate(targets, screen) {
-  const keyboardTop = detectKeyboardTop(targets, screen);
+  const band = bands(targets, screen);
   for (const t of targets) {
-    t.region = regionFor(t.frame, screen, { keyboardTop });
+    t.region = regionFor(t.frame, screen, band);
     if (t.region === 'nav-bar') t.navSlot = navSlot(t.frame, screen);
   }
   return targets;

package/src/screenmap.js

@@ -15,7 +15,7 @@ import * as ocr from './ocr.js';
 import * as regions from './regions.js';
 import * as store from './store.js';
 
-const MAP_VERSION = 5; // tab-band content no longer contributes labels
+const MAP_VERSION = 6; // dates, prices and phone numbers no longer contribute labels
 
 function mapDir(udid) {
   return path.join(store.deviceDir(udid), 'screens');
@@ -119,20 +119,42 @@ export async function build(udid, {
 } = {}) {
   const targets = [];
   const sources = [];
-  // OCR starts before the tree read: they are independent, and running them in
-  // series costs the whole recognition pass.
+  // Why a layer is missing, kept rather than swallowed.
+  //
+  // A partial map used to be indistinguishable from a whole one: `sources` said
+  // ["ax"] and nothing said why OCR was not there. On CI this produced a map
+  // with zero elements reported as a successful read, and the only way to find
+  // out what had happened was to guess. Before the tree came in-process the
+  // same failure was loud, because with no idb the ax layer failed too and an
+  // empty `sources` rethrew — so making a layer work turned a loud failure into
+  // a quiet one.
+  const degraded = [];
+  // One round trip for both, because the daemon runs the tree read and the
+  // recognition pass concurrently against the same instant of the screen. Asked
+  // separately they would queue: the control socket serves one request at a
+  // time, so a second call pays the first one's latency before it starts.
   //
   // The daemon reads text straight off the framebuffer. The fallback encodes a
   // PNG, writes it, spawns a helper and decodes it again — measured at 555ms
   // against 174ms — so it is only used when no daemon is listening.
-  const viaDaemon = useOcr && control.available(udid);
-  const ocrPromise = !useOcr
+  const viaDaemon = (useOcr || useAx) && control.available(udid);
+  const axViaDaemon = useAx && process.env.SIMFRAME_AX_DRIVER !== 'idb';
+  const daemonPromise = viaDaemon
+    ? control.request(udid, { action: 'ui', ax: axViaDaemon, ocr: useOcr }).catch((err) => err)
+    : null;
+  const ocrPromise = !useOcr || viaDaemon
     ? null
-    : viaDaemon
-      ? control.request(udid, { action: 'ui' }).catch((err) => err)
-      : fullFrame && fs.existsSync(fullFrame)
-        ? ocr.readText(fullFrame, { density }).catch((err) => err)
-        : null;
+    : fullFrame && fs.existsSync(fullFrame)
+      ? ocr.readText(fullFrame, { density }).catch((err) => err)
+      : null;
+  const daemonAnswer = daemonPromise ? await daemonPromise : null;
+  // Keep the failure rather than flattening it to null. A daemon that was
+  // listening and then did not answer is a loud failure, and the version of
+  // this that dropped it returned an empty map with no error — which `persist`
+  // then wrote into screen memory, so a later warm visit read the emptiness
+  // back instead of perceiving the screen again.
+  const daemonError = daemonAnswer instanceof Error ? daemonAnswer : null;
+  const daemonScreen = daemonError ? null : daemonAnswer?.screen ?? null;
   // With no geometry, treat every element as a potential control rather than
   // guessing a screen size and mis-classifying containers.
   const screenArea = screen?.width && screen?.height ? screen.width * screen.height : Infinity;
@@ -144,7 +166,12 @@ export async function build(udid, {
 
   if (useAx) {
     try {
-      const nodes = await input.describeAll(udid);
+      // The tree is already in hand when the daemon answered; describeAll would
+      // only ask for it a second time.
+      const nodes = daemonScreen?.sources?.includes('ax')
+        ? daemonScreen.elements.filter((e) => e.source?.includes('ax')).map(input.elementToNode)
+        : await input.describeAll(udid);
+
       sources.push('ax');
       for (const n of nodes) {
         if (!n.frame || !n.label || isContainer(n)) continue;
@@ -158,20 +185,29 @@ export async function build(udid, {
           source: 'ax',
         });
       }
-    } catch {
+    } catch (err) {
       /* no idb, or the tree read failed; OCR alone is still useful */
+      degraded.push(`accessibility: ${err.message}`);
     }
   }
 
-  if (ocrPromise) {
+  // Neither layer was even attempted: nothing below can report the failure, so
+  // it has to be reported here rather than returned as an empty screen.
+  if (daemonError && !useOcr) throw daemonError;
+
+  if (ocrPromise || (useOcr && viaDaemon)) {
     try {
-      const result = await ocrPromise;
+      const result = ocrPromise ? await ocrPromise : (daemonError ?? daemonScreen);
       if (result instanceof Error) throw result;
+      if (!result) throw new Error('the daemon did not answer');
+      // A daemon that answered without reading text is not an OCR source, and
+      // saying it was would claim the screen had been read when it had not.
+      if (viaDaemon && !result.sources?.includes('ocr')) throw new Error(result.ocrError ?? 'no text was read');
       // The daemon answers in points; readText answers in points too, having
       // divided by density. Normalise the daemon's element shape to match.
       const words = viaDaemon
-        ? (result.screen?.elements ?? [])
-            .filter((e) => e.label?.trim())
+        ? (result.elements ?? [])
+            .filter((e) => e.source?.includes('ocr') && e.label?.trim())
             .map((e) => ({
               text: e.label,
               confidence: e.confidence,
@@ -218,6 +254,7 @@ export async function build(udid, {
         });
       }
     } catch (err) {
+      degraded.push(`text recognition: ${err.message}`);
       if (!sources.length) throw err;
     }
   }
@@ -247,6 +284,10 @@ export async function build(udid, {
       sources,
       targets,
     };
+    // A truncated tree is nodes without authority; the daemon says so and the
+    // map has to carry it, because this is what gets written into memory.
+    if (daemonScreen?.axTruncated) degraded.push(`accessibility tree cut short: ${daemonScreen.axTruncated}`);
+    if (degraded.length) entry.degraded = degraded;
     // Only a map of a settled screen is worth keeping; remembering a transition
     // fills the store with layouts that will never be seen again.
     return persist ? remember(udid, entry) : entry;

package/src/simctl.js

@@ -114,9 +114,31 @@ export async function resize(inFile, outFile, maxDim) {
   await run('sips', ['-Z', String(maxDim), inFile, '--out', outFile], { timeout: 10_000 });
 }
 
-export async function launchApp(udid, bundleId) {
+/**
+ * Launch, optionally with arguments and environment.
+ *
+ * simctl passes launch arguments after the bundle id and environment through
+ * `SIMCTL_CHILD_`-prefixed variables of its own process — which is why env has
+ * to be set on the child rather than passed as flags.
+ */
+export async function launchApp(udid, bundleId, { args = [], env = {}, terminateFirst = false } = {}) {
+  if (terminateFirst) {
+    // A launch against an already-running app is a no-op that reports success,
+    // which is how a flow "relaunched" an app and tested the screen it was
+    // already on.
+    try {
+      await terminateApp(udid, bundleId);
+    } catch {
+      /* not running; that is the state we wanted */
+    }
+  }
+  const childEnv = { ...process.env };
+  for (const [k, v] of Object.entries(env)) childEnv[`SIMCTL_CHILD_${k}`] = String(v);
   try {
-    await run('xcrun', ['simctl', 'launch', udid, bundleId], { timeout: 20_000 });
+    await run('xcrun', ['simctl', 'launch', udid, bundleId, ...args.map(String)], {
+      timeout: 20_000,
+      env: childEnv,
+    });
   } catch (err) {
     // execFile's message is just "Command failed: ..." with simctl's actual
     // complaint left in stderr. A CI run failed here and said nothing about
@@ -134,6 +156,37 @@ export async function openUrl(udid, url) {
   await run('xcrun', ['simctl', 'openurl', udid, url], { timeout: 20_000 });
 }
 
+export const PERMISSION_SERVICES = [
+  'all', 'calendar', 'contacts-limited', 'contacts', 'location', 'location-always',
+  'photos-add', 'photos', 'media-library', 'microphone', 'motion', 'reminders', 'siri',
+];
+
+/**
+ * Grant, revoke or reset a privacy permission.
+ *
+ * The point of doing this from a test harness is that the alternative is
+ * tapping a system alert, and a system alert is not part of the app under test:
+ * its buttons move between iOS versions and its appearance is a race.
+ */
+export async function setPermission(udid, action, service, bundleId) {
+  const verb = String(action).toLowerCase();
+  if (!['grant', 'revoke', 'reset'].includes(verb)) {
+    throw new Error(`permission action must be grant, revoke or reset (got "${action}")`);
+  }
+  if (!PERMISSION_SERVICES.includes(service)) {
+    throw new Error(`unknown permission "${service}" — one of: ${PERMISSION_SERVICES.join(', ')}`);
+  }
+  const args = ['simctl', 'privacy', udid, verb, service];
+  if (bundleId) args.push(bundleId);
+  try {
+    await run('xcrun', args, { timeout: 20_000 });
+  } catch (err) {
+    const detail = (err.stderr || '').trim().split('\n').filter(Boolean).pop();
+    throw new Error(`could not ${verb} ${service}: ${detail || err.message}`);
+  }
+  return `${verb === 'reset' ? 'reset' : verb + 'ed'} ${service}${bundleId ? ` for ${bundleId}` : ''}`;
+}
+
 /** Put text on the device pasteboard — far faster than typing a long string. */
 export async function setPasteboard(udid, value) {
   const child = execFile('xcrun', ['simctl', 'pbcopy', udid], { timeout: 10_000 });