Repository navigation
Commit f47e9c9
authored
docs(ios-runner): point RUNNER_PROTOCOL.md at the current declarations and document recovery and busy codes (#2876)
* docs(ios-runner): repoint RUNNER_PROTOCOL.md and document recovery/busy codes
The command-names pointer named runner-client.ts, which now only sends
commands; the RunnerCommand union moved to runner-contract.ts a while back.
Add sections for commandId + the command journal + status recovery,
runnerFatal/runnerMainThreadBusy response fields, and the typed runner error
codes now on the wire (RUNNER_BUSY, RUNNER_WEDGED, MAIN_THREAD_TIMEOUT,
APP_NOT_RUNNING, ALERT_NOT_FOUND, SCROLL_KEYBOARD_OCCLUDES_SURFACE, and the
APP_SCREEN_* capture-refusal codes), each linked to its declaration site
instead of copied tables.
* docs(ios-runner): fix RUNNER_PROTOCOL error-code and busy-stamp claims
Round 2 of adversarial review on #2797 found the round-1 doc still
diverged from the code it describes: it claimed RUNNER_ERROR_RULES has
a row for MAIN_THREAD_TIMEOUT (it does not - only RUNNER_BUSY and
RUNNER_WEDGED have rows; MAIN_THREAD_TIMEOUT is read directly by
isRunnerMainThreadOccupiedError), it still re-listed the diagnostic-only
codes' owning files in prose instead of linking to the registries, it
described the runnerMainThreadBusy unchanged-flag cases loosely enough
to read as "any code without an occupancy match" rather than the actual
two cases (an ok response with no stamp, or a non-structured
transport-shaped failure), and it named runMainThreadWork/
runMainThreadWorkIfIdle plus RunnerTests+Transport.swift as the busy
stamp's read/definition when the state read is actually
currentMainThreadBusyState().reportsMainThreadBusy and the stamp itself
is defined in RunnerTests+Models.swift (Transport.swift only calls it).
Every changed sentence is re-checked against the implementation with
file:line, and every code path other than RUNNER_BUSY/RUNNER_WEDGED/
MAIN_THREAD_TIMEOUT now points at DIAGNOSTIC_ONLY_RUNNER_ERROR_CODES
and RUNNER_ERROR_RULES instead of restating what those registries own.
* docs(ios-runner): reduce RUNNER_PROTOCOL recovery and error sections to declaration pointers
* docs(ios-runner): link where the runner produces its busy stamp, runnerFatal and error codes1 parent 57886b3 commit f47e9c9
1 file changed
Lines changed: 35 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
62 | 62 | | |
63 | 63 | | |
64 | 64 | | |
65 | | - | |
| 65 | + | |
66 | 66 | | |
67 | | - | |
68 | | - | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
69 | 70 | | |
70 | 71 | | |
71 | 72 | | |
| |||
97 | 98 | | |
98 | 99 | | |
99 | 100 | | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
0 commit comments