Skip to main content

Crate smix_runner_client

Crate smix_runner_client 

Source
Expand description

smix-runner-client — HTTP IPC client to swift-bridge/SmixRunnerCore. Allows reqwest + tokio + thiserror + tracing deps.

Wire-level 1:1 compatibility with the Swift side — any route shape / query param / response body shape change must be done in lockstep with swift-bridge/Sources/SmixRunnerCore.

§Routes

  • GET /health — connectivity probe (memoized via HttpRunnerClient::ensure_reachable)
  • GET /tree?include= — full a11y tree dump (returns A11yNode)
  • GET /system-popups?include= — list of SystemPopup
  • POST /tap {selector, mode, include?} — selector → element tap
  • POST /tap-at-norm-coord {nx, ny} — Apple native event chain coord tap
  • POST /find {selector, include?} — boolean existence check
  • POST /fill {selector, text, include?} — fill text into input
  • POST /clear {selector, include?} — clear input
  • POST /press-key {key} — press named key (Return/Tab/etc.)
  • POST /scroll {selector, direction, include?} — scroll-until-visible
  • POST /swipe-once {direction} — single swipe gesture (no probe loop)
  • POST /foreground {bundleId} — bring app to foreground
  • POST /hide-keyboard — swipe-down to dismiss keyboard
  • POST /back — back gesture
  • POST /record/start — begin recording AX notifications
  • GET /record/poll — drain recorded events
  • POST /record/stop — stop recording, drain final events

Design invariant: no raw URL / sleep / xpath surface is ever exposed. All operations go through the typed methods below.

Structs§

DiagnosticDumpResponse
POST /diagnostic/dump response body.
FindRequest
POST /find request body.
FindResponse
POST /find response body.
HealthProcessInfo
Pid + alive flag for a watched process. Additive to HealthResponse.
HealthResponse
Consumers that ignore the body get identical behavior; consumers that parse the JSON gain liveness observability.
HealthTestHostInfo
xcodebuild test-host health with restart accounting.
HttpRunnerClient
KeyboardStages
Per-stage timing returned by /fill / /clear / /press-key.
OcrFrame
Normalized OCR bounding box returned by HttpRunnerClient::find_text_by_ocr. Coordinates are normalized to [0, 1] in UIKit coord space (top-left origin, y-down). Apple Vision’s native bbox is bottom-left origin + y-up — the swift handler converts before returning so all consumers see UIKit coords.
PressResult
POST /long-press response body.
RecordEventsResponse
GET /record/poll / POST /record/stop response body.
RecordedEvent
One recorder event captured by /record/start → /record/poll flow.
RequestContext
Per-request context carried across the wire via the App-Bundle-Id and App-Activate HTTP headers. Client sets these via HttpRunnerClient::with_target_bundle_id / with_auto_activate, or per-call by cloning the client with a modified context. The runner side reads them into SmixRunnerServer.currentContext (task-local) and passes to resolveApp() in every app-touching handler.
RunnerIncludeOpts
include scope query param shared by /tree / /tap / /fill / /clear / /find / /scroll / /system-popups. URL-only.
RunnerKeyboardResult
POST /fill / POST /clear / POST /press-key response body.
RunnerScrollNotMatched
POST /scroll returned 200 / matched:false / swipes:N — scroll exhausted N swipes without surfacing the target. Mirrors TS RunnerScrollNotMatched.
RunnerSwipeOnceFailure
POST /swipe-once returned 200 / ok:false / vanished_during_swipe. Mirrors TS RunnerSwipeOnceFailure.
ScrollResponse
POST /scroll response body.
SessionAppLifecycleRequest
Request body shared by POST /session/terminate-app and POST /session/launch-app.
SessionAppLifecycleResponse
Response for POST /session/terminate-app and POST /session/launch-app.
SessionCloseAllResponse
POST /session/close-all — backs smix runner cycle. Runner-side clears every open session and returns the count that was cleared.
SessionCloseRequest
POST /session/close request body.
SessionCloseResponse
POST /session/close response body.
SessionListResponse
POST /session/list response body.
SessionOpenRequest
POST /session/open request body.
SessionOpenResponse
POST /session/open response body.
SessionRelaunchAppRequest
POST /session/relaunch-app request body.
SessionRelaunchAppResponse
POST /session/relaunch-app response body.
SessionRenewActivationRequest
POST /session/renew-activation request body.
SessionRenewActivationResponse
POST /session/renew-activation response body.
SessionSummary
One entry in POST /session/list response.
SystemPopup
One system-popup discovered on the screen (alert / sheet / banner).
SystemPopupActionRequest
POST /system-popup-action request body.
SystemPopupActionResponse
POST /system-popup-action response body.
SystemPopupButton
One button on a SystemPopup.
SystemPopupsResponse
GET /system-popups response body.
TapAtCoordResult
POST /tap-at-norm-coord response.
TapAtNormCoordRequest
POST /tap-at-norm-coord request body.
TapNotFoundError
POST /tap returned 404 / not_found — element matched no node. Mirrors TS TapNotFoundError.
TapRequest
POST /tap request body.
TapResult
POST /tap response body.
TapStages
POST /tap per-stage timing in milliseconds.
WireSubprocessRecord
One entry in the subprocess ring buffer.

Enums§

CyclePlan
The action smix runner cycle takes given a SoftCycleProbe.
IncludeScope
include scope literal — currently only all-windows (system popups pierce the app frame).
InputDispatchMode
Input dispatch mode for the Input-Dispatch-Mode header. Runner-side interpretation lives in SmixRunnerCore/FillRoute.swift.
RunnerScrollSelector
Reduced selector shape used by /scroll (text-or-id only; complex selectors are host-side-resolved before reaching the runner).
RunnerTransportError
Transport-level failure (network, non-2xx, malformed body). Mirrors TS RunnerTransportError 1:1.
SimHealthWireState
Session state exposed to SDK consumers via the X-Sim-Health response header on every runner response.
SoftCycleProbe
Outcome of probing a live runner for the in-process soft-cycle (POST /soft-cycle + a GET /health re-confirmation after the FlyingFox bounce).
TapMode
POST /tap mode discriminator.

Constants§

DEFAULT_WEBVIEW_BRIDGE_PORT
Port the iOS in-app webview bridge listens on when nothing says otherwise.

Functions§

soft_cycle_plan
Map a soft-cycle probe to the cycle action. Pure — the network work happens in the probe; this only chooses the branch, so the recoverable / unrecoverable split is checkable device-free.
webview_bridge_port_from
Resolve the bridge port from a raw string, falling back to the default when absent or unparseable.
webview_bridge_url
The bridge endpoint for a given port.