Skip to content

Commit ddd6a1f

Browse files
committed
docs: fix stale platforms/ios paths after the Apple consolidation (#968)
Post-#968 follow-up: the OS-agnostic Apple runner engine moved from src/platforms/ios/ to src/platforms/apple/core/, but several docs/config still pointed at the old locations, misleading agents that grep those paths. - AGENTS.md: repoint the runner-seam map, the Apple-family sync rule, the record/trace seam, the search-roots hint, and the platform-backends list at src/platforms/apple/core/...; rename "iOS Runner Seams" -> "Apple Runner Seams". - .fallowrc.json: drop the two stale ignoreExports entries for the removed src/platforms/ios/apps.ts and src/platforms/ios/index.ts (the live src/platforms/apple/core/apps.ts entry already covers those test-only exports). - ios-runner/{README,RUNNER_PROTOCOL}.md: point the TypeScript-client links at src/platforms/apple/core/runner/runner-client.ts. Docs/config only; no behavior change. fallow audit + build/lint stay green, and a live iOS simulator replay suite (6/6) confirms the consolidated runner works.
1 parent 26ac865 commit ddd6a1f

4 files changed

Lines changed: 10 additions & 18 deletions

File tree

‎.fallowrc.json‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,6 @@
6161
"file": "src/platforms/android/index.ts",
6262
"exports": ["installAndroidInstallablePath"]
6363
},
64-
{
65-
"file": "src/platforms/ios/apps.ts",
66-
"exports": ["listSimulatorApps", "uninstallIosApp"]
67-
},
68-
{
69-
"file": "src/platforms/ios/index.ts",
70-
"exports": ["listSimulatorApps", "uninstallIosApp"]
71-
},
7264
{
7365
"file": "src/platforms/apple/core/apps.ts",
7466
"exports": ["listSimulatorApps", "uninstallIosApp"]

‎AGENTS.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Single-context repo. Read `CONTEXT.md` for domain language and testing/architect
9191
## Exploration & Token Use
9292
- Prefer these first-pass commands over broad reads:
9393
- `rg -n "<symbol|command|flag>" src test`
94-
- `rg --files src/daemon/handlers src/platforms/ios src/platforms/android`
94+
- `rg --files src/daemon/handlers src/platforms/apple src/platforms/ios src/platforms/android`
9595
- `git diff -- <path>` for active-branch context
9696
- read `.oxlintrc.json` before treating lint output as source-level bugs
9797
- For files over 500 LOC, search for the relevant type/function/section first, then read a bounded range.
@@ -105,17 +105,17 @@ Single-context repo. Read `CONTEXT.md` for domain language and testing/architect
105105
- `open/close/replay/apps/appstate`: `src/daemon/handlers/session.ts` -> `src/daemon/session-store.ts` -> `src/daemon/handlers/__tests__/session.test.ts`
106106
- `click/fill/get/is`: `src/daemon/handlers/interaction.ts` -> `src/daemon/selectors.ts` -> `src/daemon/handlers/__tests__/interaction.test.ts`
107107
- `snapshot/wait/settings/alert`: `src/daemon/handlers/snapshot.ts` -> `src/daemon/snapshot-processing.ts` -> `src/daemon/handlers/__tests__/snapshot-handler.test.ts`
108-
- `record/trace`: `src/daemon/handlers/record-trace.ts` -> `src/platforms/ios/runner-client.ts` -> `src/daemon/handlers/__tests__/record-trace.test.ts`
108+
- `record/trace`: `src/daemon/handlers/record-trace.ts` -> `src/platforms/apple/core/runner/runner-client.ts` -> `src/daemon/handlers/__tests__/record-trace.test.ts`
109109

110-
## iOS Runner Seams
111-
- Keep dependency direction clean:
110+
## Apple Runner Seams
111+
- The OS-agnostic Apple XCTest runner lives under `src/platforms/apple/core/runner/`. Keep dependency direction clean:
112112
- `runner-client.ts`: command execution + retry behavior
113113
- `runner-transport.ts`: connection/probing/HTTP transport
114114
- `runner-contract.ts`: shared `RunnerCommand` type and runner connect/error helpers
115115
- `runner-session.ts`: session lifecycle and request/response execution
116116
- `runner-xctestrun.ts`: xctestrun preparation/build/cache logic
117117
- `runner-transport.ts` must not import back from `runner-client.ts`.
118-
- If changing runner connect errors, retry policy, or command typing, start in `src/platforms/ios/runner-contract.ts` before touching client/transport files.
118+
- If changing runner connect errors, retry policy, or command typing, start in `src/platforms/apple/core/runner/runner-contract.ts` before touching client/transport files.
119119

120120
## Adding a New CLI Flag
121121

@@ -139,7 +139,7 @@ Command-only flags (like `find --first`) that do not flow to the platform layer
139139
- Use `keyboard dismiss` for iOS keyboard dismissal; it may tap safe native controls such as `Done` but must not fall back to system back navigation.
140140
- Do not remove shared snapshot/session model behavior without full migration.
141141
- Command/device support must come from `src/core/capabilities.ts`.
142-
- Apple-family target changes must keep `src/kernel/device.ts`, `src/core/capabilities.ts`, `src/core/dispatch-resolve.ts`, `src/platforms/ios/devices.ts`, and `src/platforms/ios/runner-xctestrun.ts` in sync.
142+
- Apple-family target changes must keep `src/kernel/device.ts`, `src/core/capabilities.ts`, `src/core/dispatch-resolve.ts`, `src/platforms/apple/core/devices.ts`, and `src/platforms/apple/core/runner/runner-xctestrun.ts` in sync.
143143
- iOS simulator-set scoping is iOS-specific: do not let `iosSimulatorDeviceSet` hide the host macOS desktop target when `--platform macos` or `--target desktop` is requested.
144144
- If Swift runner code changes, run `pnpm build:xcuitest`.
145145
- Use `inferFillText` and `uniqueStrings` from `src/daemon/action-utils.ts`.
@@ -243,7 +243,7 @@ Command-only flags (like `find --first`) that do not flow to the platform layer
243243
- Inlining `is` predicate logic in handlers.
244244
- Returning non-normalized user-facing errors.
245245
- Duplicating logs backend logic in handlers instead of `src/daemon/app-log.ts`.
246-
- Growing `src/daemon/handlers/session.ts` or `src/platforms/ios/apps.ts` further without extracting Apple-family/macOS-specific helpers first.
246+
- Growing `src/daemon/handlers/session.ts` or `src/platforms/apple/core/apps.ts` further without extracting Apple-family/macOS-specific helpers first.
247247
- Reintroducing an npm lockfile or assuming ESLint/Prettier still exist in this repo.
248248
- Changing `tsconfig.lib.json`/build tooling without running `pnpm check:tooling`; declaration generation is stricter than `tsc --noEmit`.
249249

@@ -280,7 +280,7 @@ Command-only flags (like `find --first`) that do not flow to the platform layer
280280
- Command identity + command surface: `src/command-catalog.ts`, `src/commands/command-surface.ts`, `src/commands/command-contract.ts`, `src/commands/client-command-contracts.ts`
281281
- CLI grammar: `src/commands/cli-grammar.ts`, `src/commands/cli-grammar/*`
282282
- Daemon request projection: `src/commands/command-projection.ts`
283-
- Platform backends: `src/platforms/ios/*`, `ios-runner/*`, `src/platforms/android/*`
283+
- Platform backends: `src/platforms/apple/*`, `src/platforms/ios/*`, `ios-runner/*`, `src/platforms/android/*`
284284

285285
## Pull Requests
286286
- Before opening PR: ensure no conflict markers/unmerged paths.

‎ios-runner/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Current internal runner for iOS, tvOS, and macOS desktop automation.
1515
Protocol and maintenance references:
1616

1717
- Protocol overview: [`RUNNER_PROTOCOL.md`](RUNNER_PROTOCOL.md)
18-
- TypeScript client: [`../src/platforms/ios/runner-client.ts`](../src/platforms/ios/runner-client.ts)
18+
- TypeScript client: [`../src/platforms/apple/core/runner/runner-client.ts`](../src/platforms/apple/core/runner/runner-client.ts)
1919
- Swift wire models: [`AgentDeviceRunner/AgentDeviceRunnerUITests/RunnerTests+Models.swift`](AgentDeviceRunner/AgentDeviceRunnerUITests/RunnerTests+Models.swift)
2020

2121
## UITest Runner File Map

‎ios-runner/RUNNER_PROTOCOL.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Examples:
4141

4242
The current command names are defined in:
4343

44-
- [`../src/platforms/ios/runner-client.ts`](../src/platforms/ios/runner-client.ts)
44+
- [`../src/platforms/apple/core/runner/runner-client.ts`](../src/platforms/apple/core/runner/runner-client.ts)
4545
- [`AgentDeviceRunner/AgentDeviceRunnerUITests/RunnerTests+Models.swift`](AgentDeviceRunner/AgentDeviceRunnerUITests/RunnerTests+Models.swift)
4646

4747
## Response Shape

0 commit comments

Comments
 (0)