Skip to main content

rpi_extensions/
actions.rs

1//! B5a — the plugin→host `runtime_action` bridge (inverted FFI).
2//!
3//! A plugin invokes `PluginApiVt::runtime_action` to drive the harness (send a
4//! message, switch models, fork a session, reload extensions, …). Unlike the
5//! register trampolines — which run synchronously inside the selected register
6//! entrypoint
7//! and recover host state via the thread-local `CURRENT_HOST_API` —
8//! `runtime_action` is called **post-register**, from (a) a `spawn_blocking`
9//! pool thread mid-tool-drive, or (b) a foreign thread the plugin spawned
10//! itself. Neither has the thread-local set, and the host cannot predict which
11//! threads a plugin will call from. Thread-local is the wrong tool here.
12//!
13//! The verified-correct recovery channel is [`PluginApiVt::user_data`]: it is
14//! `Send+Sync`, populated at vtable build, passed back unchanged on every call,
15//! and the SDK designates it "the host's opaque context". Today every register
16//! trampoline ignores `user_data` (the register path uses the thread-local), so
17//! repurposing `user_data` for the action bridge breaks nothing.
18//!
19//! [`ActionBridge`] holds a [`tokio::runtime::Handle`] **captured at build
20//! time** (the host is on the runtime when it constructs the bridge) — the fix
21//! for the foreign-thread case: `Handle::spawn` works from any thread, no
22//! ambient runtime needed. The real [`trampoline_runtime_action`] derefs
23//! `user_data` as `&ActionBridge`, drives the host's async dispatch on the
24//! runtime via a `std::sync::mpsc::sync_channel(1)`, and parks the plugin thread
25//! on `rx.recv()` (STD — not `tokio::oneshot`, whose `recv` needs a runtime the
26//! plugin's foreign thread lacks).
27//!
28//! ## Cycle-free leaf DAG
29//!
30//! [`RuntimeActionHost`] is defined here (NOT in `rpi-harness`) so
31//! `rpi-extensions` stays a leaf: the trait names only JSON + primitives — no
32//! `rpi-harness` types cross. The host impl (`HarnessActionHost`) lives in
33//! `rpi-cli`, where it can name the harness freely; `rpi-extensions` only
34//! carries the async surface. This preserves the documented DAG
35//! (`lib.rs:10-16`: `rpi-extensions` does NOT depend on `rpi-harness`).
36
37use std::ffi::c_void;
38use std::collections::{HashMap, VecDeque};
39use std::sync::atomic::{AtomicBool, Ordering};
40use std::sync::{mpsc, Arc, Mutex};
41
42use rpi_plugin_sdk::{RuntimeActionId, StbString, StbStringRef};
43use tokio::runtime::Handle;
44
45/// A pending host UI request emitted by a plugin runtime action.
46///
47/// The request and tool-call ids are intentionally separate: a single tool
48/// call may ask more than one question, while concurrent tool calls must never
49/// consume one another's answers. `raw` retains the complete action envelope;
50/// `ui` is the normalized UI payload that TUI renderers generally need.
51#[derive(Clone, Debug, PartialEq)]
52pub struct UiDialogRequest {
53    pub request_id: String,
54    pub tool_call_id: Option<String>,
55    pub ui: serde_json::Value,
56    pub raw: serde_json::Value,
57}
58
59struct UiDialogEntry {
60    request: UiDialogRequest,
61    answer: Option<serde_json::Value>,
62    cancelled: bool,
63}
64
65struct UiDialogState {
66    attached: bool,
67    pending: VecDeque<String>,
68    active: HashMap<String, UiDialogEntry>,
69}
70
71/// Thread-safe mailbox connecting plugin runtime actions to an interactive
72/// host (normally the TUI). It deliberately carries only JSON and primitives,
73/// so the extension crate remains independent of the UI crate.
74#[derive(Clone)]
75pub struct UiDialogMailbox {
76    state: Arc<Mutex<UiDialogState>>,
77}
78
79impl Default for UiDialogMailbox {
80    fn default() -> Self {
81        Self::new()
82    }
83}
84
85impl UiDialogMailbox {
86    pub fn new() -> Self {
87        Self {
88            state: Arc::new(Mutex::new(UiDialogState {
89                attached: false,
90                pending: VecDeque::new(),
91                active: HashMap::new(),
92            })),
93        }
94    }
95
96    /// Mark an interactive consumer as available. Re-attaching is idempotent.
97    pub fn attach(&self) {
98        self.state.lock().expect("ui dialog mailbox poisoned").attached = true;
99    }
100
101    /// Detach the consumer and cancel every outstanding request. This prevents
102    /// a TUI restart/reload from leaving plugin polls blocked forever.
103    pub fn detach(&self) {
104        let mut state = self.state.lock().expect("ui dialog mailbox poisoned");
105        state.attached = false;
106        state.pending.clear();
107        for entry in state.active.values_mut() {
108            entry.cancelled = true;
109            entry.answer = None;
110        }
111    }
112
113    pub fn is_attached(&self) -> bool {
114        self.state
115            .lock()
116            .expect("ui dialog mailbox poisoned")
117            .attached
118    }
119
120    /// Remove and return the next request for presentation by the TUI.
121    /// Cancelled/answered requests are skipped; duplicate `open` calls never
122    /// enqueue the same request id twice.
123    pub fn take_pending(&self) -> Option<UiDialogRequest> {
124        let mut state = self.state.lock().expect("ui dialog mailbox poisoned");
125        while let Some(request_id) = state.pending.pop_front() {
126            if let Some(entry) = state.active.get(&request_id) {
127                if !entry.cancelled && entry.answer.is_none() {
128                    return Some(entry.request.clone());
129                }
130            }
131        }
132        None
133    }
134
135    pub fn pending_len(&self) -> usize {
136        self.state
137            .lock()
138            .expect("ui dialog mailbox poisoned")
139            .pending
140            .len()
141    }
142
143    /// Supply an answer for a request. Repeating the same operation is
144    /// idempotent; answering a cancelled/unknown request is an explicit error.
145    pub fn respond(&self, request_id: &str, answer: serde_json::Value) -> Result<(), String> {
146        let mut state = self.state.lock().map_err(|_| "ui dialog mailbox poisoned".to_string())?;
147        let entry = state
148            .active
149            .get_mut(request_id)
150            .ok_or_else(|| format!("unknown UI request `{request_id}`"))?;
151        if entry.cancelled {
152            return Err(format!("UI request `{request_id}` was cancelled"));
153        }
154        if entry.answer.is_none() {
155            entry.answer = Some(answer);
156        }
157        Ok(())
158    }
159
160    /// Mark one request cancelled. The terminal state remains visible to the
161    /// plugin's next `poll`, then is reclaimed by that poll.
162    pub fn cancel(&self, request_id: &str) -> Result<(), String> {
163        let mut state = self.state.lock().map_err(|_| "ui dialog mailbox poisoned".to_string())?;
164        let entry = state
165            .active
166            .get_mut(request_id)
167            .ok_or_else(|| format!("unknown UI request `{request_id}`"))?;
168        entry.cancelled = true;
169        entry.answer = None;
170        state.pending.retain(|id| id != request_id);
171        Ok(())
172    }
173
174    /// Cancel all requests currently known to the mailbox.
175    pub fn cancel_all(&self) {
176        let mut state = self.state.lock().expect("ui dialog mailbox poisoned");
177        state.pending.clear();
178        for entry in state.active.values_mut() {
179            entry.cancelled = true;
180            entry.answer = None;
181        }
182    }
183
184    /// Poll a request and consume a terminal answer/cancellation. Pending
185    /// polls are cheap and preserve the request for subsequent calls.
186    pub fn poll(&self, request_id: &str) -> Result<serde_json::Value, String> {
187        let mut state = self.state.lock().map_err(|_| "ui dialog mailbox poisoned".to_string())?;
188        let terminal = match state.active.get(request_id) {
189            Some(entry) if entry.cancelled => Some(serde_json::json!({
190                "status": "cancelled",
191                "requestId": request_id,
192                "toolCallId": entry.request.tool_call_id,
193            })),
194            Some(entry) if entry.answer.is_some() => Some(serde_json::json!({
195                "status": "answered",
196                "requestId": request_id,
197                "toolCallId": entry.request.tool_call_id,
198                "answer": entry.answer.clone().unwrap_or(serde_json::Value::Null),
199            })),
200            Some(entry) => Some(serde_json::json!({
201                "status": "pending",
202                "requestId": request_id,
203                "toolCallId": entry.request.tool_call_id,
204            })),
205            None => None,
206        };
207        let Some(result) = terminal else {
208            return Err(format!("unknown UI request `{request_id}`"));
209        };
210        if result.get("status").and_then(serde_json::Value::as_str) != Some("pending") {
211            state.active.remove(request_id);
212        }
213        Ok(result)
214    }
215
216    /// Parse and execute the JSON action envelope used by runtime action 17.
217    /// Supported operations are `open`, `poll`, `cancel`; `response` is also
218    /// accepted as a convenience for hosts that proxy answers through JSON.
219    pub fn handle(&self, args: serde_json::Value) -> Result<serde_json::Value, String> {
220        let op = args.get("op").and_then(serde_json::Value::as_str).unwrap_or("open");
221        let request_id = || {
222            args.get("requestId")
223                .or_else(|| args.get("request_id"))
224                .and_then(serde_json::Value::as_str)
225                .map(str::to_owned)
226                .filter(|id| !id.trim().is_empty())
227                .ok_or_else(|| "missing non-empty `requestId`".to_string())
228        };
229        match op {
230            "open" => {
231                let id = request_id()?;
232                let mut state = self.state.lock().map_err(|_| "ui dialog mailbox poisoned".to_string())?;
233                if !state.attached {
234                    return Err("ask_user requires an interactive UI".to_string());
235                }
236                if let Some(entry) = state.active.get(&id) {
237                    return Ok(if entry.cancelled {
238                        serde_json::json!({"status":"cancelled","requestId":id})
239                    } else if let Some(answer) = &entry.answer {
240                        serde_json::json!({"status":"answered","requestId":id,"answer":answer})
241                    } else {
242                        serde_json::json!({"status":"pending","requestId":id})
243                    });
244                }
245                let tool_call_id = args
246                    .get("toolCallId")
247                    .or_else(|| args.get("tool_call_id"))
248                    .and_then(serde_json::Value::as_str)
249                    .map(str::to_owned);
250                let ui = args.get("ui").cloned().unwrap_or_else(|| args.clone());
251                state.active.insert(
252                    id.clone(),
253                    UiDialogEntry {
254                        request: UiDialogRequest {
255                            request_id: id.clone(),
256                            tool_call_id: tool_call_id.clone(),
257                            ui,
258                            raw: args,
259                        },
260                        answer: None,
261                        cancelled: false,
262                    },
263                );
264                state.pending.push_back(id.clone());
265                Ok(serde_json::json!({"status":"pending","requestId":id,"toolCallId":tool_call_id}))
266            }
267            "poll" => self.poll(&request_id()?),
268            "cancel" => {
269                let id = request_id()?;
270                self.cancel(&id)?;
271                Ok(serde_json::json!({"status":"cancelled","requestId":id}))
272            }
273            "response" | "respond" => {
274                let id = request_id()?;
275                let answer = args
276                    .get("answer")
277                    .or_else(|| args.get("value"))
278                    .cloned()
279                    .unwrap_or(serde_json::Value::Null);
280                self.respond(&id, answer)?;
281                Ok(serde_json::json!({"status":"answered","requestId":id}))
282            }
283            other => Err(format!("unknown UI dialog operation `{other}`")),
284        }
285    }
286}
287
288/// The host-side implementation the bridge delegates to. Defined in
289/// `rpi-extensions` (NOT `rpi-harness`) so the crate DAG stays a leaf: this is a
290/// trait the **host** (`rpi-cli`) implements over the harness — `rpi-extensions`
291/// only names the async surface + carries JSON params/results. No `rpi-harness`
292/// types appear in the trait.
293///
294/// Each method corresponds to one [`RuntimeActionId`] variant. Complex args
295/// arrive as parsed JSON (`serde_json::Value`); complex results return as
296/// `serde_json::Value`. The host maps its native types (Model, AgentMessage, …)
297/// to/from JSON at the impl boundary. Errors are `String` (become the action's
298/// nonzero `i32` + `{"error": msg}` JSON on the plugin side).
299///
300/// The 18 methods map 1:1 to [`RuntimeActionId`]; `dispatch` below is the
301/// exhaustive switch that connects the FFI id to the method.
302#[async_trait::async_trait]
303pub trait RuntimeActionHost: Send + Sync {
304    /// `SendMessage` — drive a full agent run from an assistant/user message.
305    async fn send_message(&self, args: serde_json::Value) -> Result<serde_json::Value, String>;
306    /// `SendUserMessage` — drive a run from a user-text message.
307    async fn send_user_message(&self, args: serde_json::Value)
308        -> Result<serde_json::Value, String>;
309    /// `AppendEntry` — append a raw entry to the session transcript (no run).
310    async fn append_entry(&self, args: serde_json::Value) -> Result<serde_json::Value, String>;
311    /// `SetSessionName` — set the session's display name.
312    async fn set_session_name(&self, args: serde_json::Value) -> Result<serde_json::Value, String>;
313    /// `GetActiveTools` — the active tool-name list.
314    async fn get_active_tools(&self, args: serde_json::Value) -> Result<serde_json::Value, String>;
315    /// `SetActiveTools` — replace the active tool-name list.
316    async fn set_active_tools(&self, args: serde_json::Value) -> Result<serde_json::Value, String>;
317    /// `SetModel` — switch the active model (by id; host resolves to a `Model`).
318    async fn set_model(&self, args: serde_json::Value) -> Result<serde_json::Value, String>;
319    /// `GetThinkingLevel` — the current thinking level.
320    async fn get_thinking_level(
321        &self,
322        args: serde_json::Value,
323    ) -> Result<serde_json::Value, String>;
324    /// `SetThinkingLevel` — set the thinking level.
325    async fn set_thinking_level(
326        &self,
327        args: serde_json::Value,
328    ) -> Result<serde_json::Value, String>;
329    /// `Compact` — compact the session transcript.
330    async fn compact(&self, args: serde_json::Value) -> Result<serde_json::Value, String>;
331    /// `GetSystemPrompt` — the live composed system prompt.
332    async fn get_system_prompt(&self, args: serde_json::Value)
333        -> Result<serde_json::Value, String>;
334    /// `NewSession` — start a fresh session and switch to it.
335    async fn new_session(&self, args: serde_json::Value) -> Result<serde_json::Value, String>;
336    /// `Fork` — fork the current session and switch to the fork.
337    async fn fork(&self, args: serde_json::Value) -> Result<serde_json::Value, String>;
338    /// `NavigateTree` — navigate/rewind the session tree.
339    async fn navigate_tree(&self, args: serde_json::Value) -> Result<serde_json::Value, String>;
340    /// `SwitchSession` — hot-switch to an existing session by id.
341    async fn switch_session(&self, args: serde_json::Value) -> Result<serde_json::Value, String>;
342    /// `Reload` — re-run extension discovery + Part-A resource loaders (a CLI
343    /// concern; the host impl wires it to the `ActionBridge.reload` callback in
344    /// B5d — until then this returns an "unsupported" error string).
345    async fn reload(&self, args: serde_json::Value) -> Result<serde_json::Value, String>;
346
347    /// `GetCliFlag` — read a parsed extension CLI flag. Args are
348    /// `{"name":"flag"}` and the result is `{"value": <bool|string|null>}`.
349    async fn get_cli_flag(&self, _args: serde_json::Value) -> Result<serde_json::Value, String> {
350        Err("CLI flag lookup is not configured".to_string())
351    }
352
353    /// `UiDialog` fallback for hosts that do not install an interactive
354    /// mailbox. The default is deliberately an error so headless runs cannot
355    /// accidentally report a fabricated user answer.
356    async fn ui_dialog(&self, _args: serde_json::Value) -> Result<serde_json::Value, String> {
357        Err("ask_user requires an interactive UI".to_string())
358    }
359}
360
361/// The host-side bridge carried in [`PluginApiVt::user_data`] so
362/// [`trampoline_runtime_action`] can recover the harness state from any thread.
363///
364/// `runtime: Handle` is captured at build time (the host is on the runtime when
365/// it constructs the bridge) — this is the foreign-thread fix. `host` is the
366/// `rpi-cli` impl over the harness. `reload` is a CLI-owned callback that
367/// re-runs extension discovery + Part-A loaders (a CLI concern, NOT a harness
368/// op) — wired by `rpi-cli` in B5d via [`reload_callback_from_mailbox`].
369///
370/// ## Staleness (B5d)
371///
372/// `active: Arc<AtomicBool>` is shared with a [`ReloadMailbox`]-driven swap
373/// site. A `/reload` (TUI command OR a plugin's `runtime_action(Reload)`) builds
374/// a fresh `ExtensionSession` + a fresh `ActionBridge`, calls
375/// [`invalidate`](Self::invalidate) on the old bridge, and swaps the new one in.
376/// In-flight `runtime_action` calls that recovered the OLD bridge from
377/// `user_data` (the pointer a plugin stored during the prior `register`) then
378/// hit the staleness guard in [`run_action`] and fail with a structured error
379/// instead of driving a half-swapped harness. (Plugins load fresh on reload,
380/// handing them the NEW bridge pointer; the guard only catches the race window
381/// where an old call is still parked on `rx.recv()`.)
382///
383/// Held behind `Arc` (pointer-stable for the bridge's lifetime via
384/// [`Arc::as_ptr`]); `rpi-cli` keeps one clone for the session lifetime so the
385/// pointer a plugin stored during register stays valid post-register. (The
386/// transient `HostApi` built per `load_one` holds a clone only during register
387/// — when it drops after `take_registry`, the master `Arc` in `rpi-cli` keeps
388/// the allocation alive.)
389pub struct ActionBridge {
390    /// Captured at build time from a thread running the target runtime.
391    pub(crate) runtime: Handle,
392    /// The host impl (`HarnessActionHost` in rpi-cli).
393    pub(crate) host: Arc<dyn RuntimeActionHost>,
394    /// B5d reload callback; `None` until the TUI wires `/reload`.
395    pub(crate) reload:
396        Option<Arc<dyn Fn() -> futures::future::BoxFuture<'static, ()> + Send + Sync>>,
397    /// Session-scoped UI mailbox. It is cloned into reload-created bridges so
398    /// a TUI attachment and in-flight requests survive extension reloads.
399    ui_dialog: UiDialogMailbox,
400    /// B5d staleness flag. Shared so [`invalidate`] flips it for every clone.
401    /// `true` while this bridge is the live session's bridge.
402    active: Arc<AtomicBool>,
403}
404
405impl ActionBridge {
406    /// Build a bridge. The `Handle` MUST be captured from a thread running the
407    /// target runtime (pi-cli builds the bridge on the async main thread).
408    pub fn new(runtime: Handle, host: Arc<dyn RuntimeActionHost>) -> Arc<Self> {
409        Arc::new(Self {
410            runtime,
411            host,
412            reload: None,
413            ui_dialog: UiDialogMailbox::new(),
414            active: Arc::new(AtomicBool::new(true)),
415        })
416    }
417
418    /// Same as [`new`](Self::new) with a reload callback (B5d wires this via
419    /// [`reload_callback_from_mailbox`]).
420    pub fn with_reload(
421        runtime: Handle,
422        host: Arc<dyn RuntimeActionHost>,
423        reload: Arc<dyn Fn() -> futures::future::BoxFuture<'static, ()> + Send + Sync>,
424    ) -> Arc<Self> {
425        Self::with_reload_and_ui(runtime, host, reload, UiDialogMailbox::new())
426    }
427
428    /// Build a bridge with an explicit session-scoped UI mailbox.
429    pub fn with_ui_dialog(
430        runtime: Handle,
431        host: Arc<dyn RuntimeActionHost>,
432        ui_dialog: UiDialogMailbox,
433    ) -> Arc<Self> {
434        Arc::new(Self {
435            runtime,
436            host,
437            reload: None,
438            ui_dialog,
439            active: Arc::new(AtomicBool::new(true)),
440        })
441    }
442
443    /// `with_reload` variant that preserves a mailbox across bridge swaps.
444    pub fn with_reload_and_ui(
445        runtime: Handle,
446        host: Arc<dyn RuntimeActionHost>,
447        reload: Arc<dyn Fn() -> futures::future::BoxFuture<'static, ()> + Send + Sync>,
448        ui_dialog: UiDialogMailbox,
449    ) -> Arc<Self> {
450        Arc::new(Self {
451            runtime,
452            host,
453            reload: Some(reload),
454            ui_dialog,
455            active: Arc::new(AtomicBool::new(true)),
456        })
457    }
458
459    /// Clone the session mailbox for TUI attachment or a reload-created bridge.
460    pub fn ui_dialog_mailbox(&self) -> UiDialogMailbox {
461        self.ui_dialog.clone()
462    }
463
464    /// Mark this bridge stale (B5d). A `/reload` that swaps in a fresh bridge
465    /// calls this on the old one so in-flight `runtime_action` calls parked on
466    /// the old `user_data` pointer fail fast with a staleness error instead of
467    /// driving the swapped-out session. Idempotent.
468    pub fn invalidate(&self) {
469        self.active.store(false, Ordering::SeqCst);
470    }
471
472    /// Whether this bridge is still the live session's bridge.
473    pub fn is_active(&self) -> bool {
474        self.active.load(Ordering::SeqCst)
475    }
476
477    /// B5d: clone the host impl so a `/reload` can build a FRESH `ActionBridge`
478    /// over the SAME `RuntimeActionHost` (the host's harness cell already points
479    /// at the live harness — the harness is NOT rebuilt on reload — so the host
480    /// is reusable across reloads; only the bridge's staleness flag + reload
481    /// callback differ). The fresh bridge gets a fresh `active` flag (true) +
482    /// the reload callback the TUI installed; the old bridge is `invalidate`d.
483    pub fn clone_host(&self) -> Arc<dyn RuntimeActionHost> {
484        Arc::clone(&self.host)
485    }
486}
487
488/// A reload-signal mail slot (B5d). The reload callback (built by
489/// [`reload_callback_from_mailbox`]) captures a clone; the TUI installs a
490/// `tokio` unbounded sender after it starts. When a plugin calls
491/// `runtime_action(Reload)`, the callback signals `()` (if a TUI is installed)
492/// and the TUI performs the reload **asynchronously** — the plugin's call
493/// returns `Ok(null)` immediately, so the calling plugin's cdylib is NOT
494/// unmapped while its `runtime_action` frame is still on the stack (the reload,
495/// which drops the old keepalive, happens after the call returns). This breaks
496/// the self-unmapping race a synchronous plugin-initiated reload would have.
497///
498/// rpi-extensions carries only `()` (no pi-cli `TuiMessage` type) — preserving
499/// the leaf DAG. The TUI owns the receiver + the actual reload routine.
500#[derive(Clone)]
501pub struct ReloadMailbox {
502    tx: Arc<std::sync::Mutex<Option<tokio::sync::mpsc::UnboundedSender<()>>>>,
503}
504
505impl Default for ReloadMailbox {
506    fn default() -> Self {
507        Self {
508            tx: Arc::new(std::sync::Mutex::new(None)),
509        }
510    }
511}
512
513impl ReloadMailbox {
514    /// A fresh empty mail slot (no TUI installed yet).
515    pub fn new() -> Self {
516        Self::default()
517    }
518
519    /// Install the TUI's reload-signal sender (after the TUI starts). Replaces
520    /// any prior sender. The TUI drops the receiver on shutdown; a sender held
521    /// here keeps the channel half-open, so [`clear`] on shutdown is advised.
522    pub fn install(&self, tx: tokio::sync::mpsc::UnboundedSender<()>) {
523        *self.tx.lock().unwrap() = Some(tx);
524    }
525
526    /// Signal a reload (plugin-initiated via `runtime_action(Reload)`).
527    /// `Ok(())` if a TUI is installed (the signal was enqueued; the TUI may
528    /// still be mid-reload). `Err(())` if no TUI is installed (the host returns
529    /// a "reload not available" error to the plugin).
530    pub fn signal(&self) -> Result<(), ()> {
531        let g = self.tx.lock().unwrap();
532        match &*g {
533            Some(tx) => {
534                let _ = tx.send(());
535                Ok(())
536            }
537            None => Err(()),
538        }
539    }
540
541    /// Drop the installed sender (TUI shutdown). Idempotent.
542    pub fn clear(&self) {
543        *self.tx.lock().unwrap() = None;
544    }
545}
546
547/// Build the reload callback the bridge carries, backed by a [`ReloadMailbox`].
548/// When a plugin calls `runtime_action(Reload)`, the bridge's spawn site awaits
549/// this callback, which signals the TUI (if installed) and returns; the plugin
550/// receives `Ok(null)` and the TUI performs the reload asynchronously. If no
551/// TUI is installed, the callback returns without signalling and the host's
552/// [`RuntimeActionHost::reload`] fallback surfaces the "not configured" error.
553pub fn reload_callback_from_mailbox(
554    mailbox: ReloadMailbox,
555) -> Arc<dyn Fn() -> futures::future::BoxFuture<'static, ()> + Send + Sync> {
556    Arc::new(move || {
557        let m = mailbox.clone();
558        Box::pin(async move {
559            let _ = m.signal();
560        })
561    })
562}
563
564// `Handle` is Send+Sync, `Arc<dyn RuntimeActionHost>` (with `Send + Sync` bound)
565// is Send+Sync, and the reload closure is `Send + Sync` — so `ActionBridge` is
566// naturally Send+Sync; no manual unsafe impl needed.
567
568/// Dispatch one action to the host. Async — runs on the bridge's runtime.
569/// Handles all 18 ids; `Reload` delegates to [`RuntimeActionHost::reload`]
570/// (the "no callback configured" fallback). When the bridge has a reload
571/// callback, the spawn site intercepts `Reload` and awaits the callback
572/// instead (a CLI concern, not a harness op) — this helper is the plain
573/// host-only path.
574async fn dispatch(
575    host: &Arc<dyn RuntimeActionHost>,
576    ui_dialog: &UiDialogMailbox,
577    action: RuntimeActionId,
578    args: serde_json::Value,
579) -> Result<serde_json::Value, String> {
580    match action {
581        RuntimeActionId::SendMessage => host.send_message(args).await,
582        RuntimeActionId::SendUserMessage => host.send_user_message(args).await,
583        RuntimeActionId::AppendEntry => host.append_entry(args).await,
584        RuntimeActionId::SetSessionName => host.set_session_name(args).await,
585        RuntimeActionId::GetActiveTools => host.get_active_tools(args).await,
586        RuntimeActionId::SetActiveTools => host.set_active_tools(args).await,
587        RuntimeActionId::SetModel => host.set_model(args).await,
588        RuntimeActionId::GetThinkingLevel => host.get_thinking_level(args).await,
589        RuntimeActionId::SetThinkingLevel => host.set_thinking_level(args).await,
590        RuntimeActionId::Compact => host.compact(args).await,
591        RuntimeActionId::GetSystemPrompt => host.get_system_prompt(args).await,
592        RuntimeActionId::NewSession => host.new_session(args).await,
593        RuntimeActionId::Fork => host.fork(args).await,
594        RuntimeActionId::NavigateTree => host.navigate_tree(args).await,
595        RuntimeActionId::SwitchSession => host.switch_session(args).await,
596        RuntimeActionId::Reload => host.reload(args).await,
597        RuntimeActionId::GetCliFlag => host.get_cli_flag(args).await,
598        RuntimeActionId::UiDialog => ui_dialog.handle(args),
599    }
600}
601
602/// The real `runtime_action` trampoline — replaces `stub_runtime_action` when a
603/// bridge is present (see [`HostApi::build_vtable`](crate::HostApi)).
604///
605/// Recovers `&ActionBridge` from `user_data`, parses `args_json`, drives the
606/// host's async dispatch on the bridge's runtime via `Handle::spawn`, and parks
607/// the plugin thread on a std `mpsc` `recv` (works from ANY thread — no ambient
608/// runtime needed, which is the load-bearing property for foreign plugin
609/// threads).
610///
611/// ## Return codes
612/// - `0` — success; `*out` written with the result JSON (host-owned
613///   [`StbString`]; the plugin frees it via the host `free_string` from the
614///   vtable).
615/// - `1` — host-level error; `*out` written with `{"error": msg}` JSON.
616/// - `2` — unknown numeric action id; `*out` contains a structured error and
617///   no host method is dispatched.
618/// - `-1` — no bridge present (`user_data` null; should not happen when wired).
619/// - `-2` — the spawned task dropped its sender without sending (runtime
620///   shutdown / dispatch panic); no result available.
621///
622/// The whole body is `catch_unwind`-wrapped — a panic across FFI ⇒ abort (same
623/// policy as the tool partial callback, `tool.rs:206`).
624pub extern "C" fn trampoline_runtime_action(
625    action_id: u32,
626    args_json: StbStringRef,
627    out: *mut StbString,
628    user_data: *mut c_void,
629) -> i32 {
630    let outcome = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
631        run_action(
632            action_id,
633            u32::from(RuntimeActionId::UiDialog),
634            args_json,
635            out,
636            user_data,
637        )
638    }));
639    match outcome {
640        Ok(rc) => rc,
641        Err(_) => {
642            // A panic in the host-side dispatch was caught. Do not abort the
643            // process: report a host-level error to the caller (documented
644            // code `1`) with a structured payload when `out` is writable.
645            tracing::error!("runtime_action trampoline panicked — reporting host error");
646            if !out.is_null() {
647                unsafe {
648                    *out = StbString::from_string(
649                        r#"{"error":"runtime_action panicked"}"#.to_string(),
650                    );
651                }
652            }
653            1
654        }
655    }
656}
657
658/// ABI v1 runtime-action trampoline. The legacy vtable has the same physical
659/// slot shape, but only the historical action ids `0..=15` are valid.
660pub extern "C" fn trampoline_runtime_action_v1(
661    action_id: u32,
662    args_json: StbStringRef,
663    out: *mut StbString,
664    user_data: *mut c_void,
665) -> i32 {
666    let outcome = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
667        run_action(
668            action_id,
669            u32::from(RuntimeActionId::Reload),
670            args_json,
671            out,
672            user_data,
673        )
674    }));
675    match outcome {
676        Ok(rc) => rc,
677        Err(_) => {
678            tracing::error!("ABI v1 runtime_action trampoline panicked - reporting host error");
679            if !out.is_null() {
680                unsafe {
681                    *out = StbString::from_string(
682                        r#"{"error":"runtime_action panicked"}"#.to_string(),
683                    );
684                }
685            }
686            1
687        }
688    }
689}
690
691/// Inner synchronous driver (split out so the `catch_unwind` wrapper is clean).
692fn run_action(
693    action_id: u32,
694    max_action_id: u32,
695    args_json: StbStringRef,
696    out: *mut StbString,
697    user_data: *mut c_void,
698) -> i32 {
699    // Validate the raw FFI integer before dereferencing host state or entering
700    // the enum-based dispatch. Unknown values are ordinary protocol errors;
701    // they never become invalid Rust enum discriminants.
702    let action = match RuntimeActionId::try_from(action_id) {
703        Ok(action) if action_id <= max_action_id => action,
704        Ok(_) | Err(_) => {
705            if !out.is_null() {
706                let json = serde_json::json!({
707                    "error": format!("unknown runtime action id {action_id}")
708                })
709                .to_string();
710                // SAFETY: `out` is non-null and points to the caller-provided
711                // output slot. The plugin reclaims this host allocation via
712                // `host_free_string` from the vtable.
713                unsafe {
714                    *out = StbString::from_string(json);
715                }
716            }
717            return 2;
718        }
719    };
720
721    if user_data.is_null() {
722        return -1;
723    }
724    // SAFETY: the host guarantees `user_data` points at a live `ActionBridge`.
725    // `rpi-cli` builds one `Arc<ActionBridge>` per session and keeps it for the
726    // harness lifetime; `Arc::as_ptr` is pointer-stable while any clone lives.
727    // We only borrow for the duration of this call.
728    let bridge: &ActionBridge = unsafe { &*(user_data as *const ActionBridge) };
729
730    // B5d staleness guard: a `/reload` that swapped in a fresh bridge calls
731    // `invalidate` on the old one. A plugin that still holds the old pointer
732    // (stored during the prior `register`) must not drive the swapped-out
733    // session. Surface a structured "stale bridge" error so the plugin's
734    // `runtime_action` returns nonzero + `{"error": ...}` instead of racing
735    // the swap. (The new bridge's pointer was handed to the reloaded plugins;
736    // this guard only catches the race window where an old call is still parked.)
737    if !bridge.is_active() {
738        if out.is_null() {
739            return 1;
740        }
741        let json = serde_json::json!({
742            "error": "runtime_action on a stale ActionBridge (session reloaded/swapped)"
743        })
744        .to_string();
745        unsafe {
746            *out = StbString::from_string(json);
747        }
748        return 1;
749    }
750
751    // Parse args. An empty/invalid JSON blob collapses to `{}` — getters ignore
752    // args; setters that require a field surface a clear error string.
753    let args_str = unsafe { args_json.as_str() };
754    let args: serde_json::Value = if args_str.is_empty() {
755        serde_json::Value::Object(serde_json::Map::new())
756    } else {
757        serde_json::from_str(args_str)
758            .unwrap_or_else(|_| serde_json::Value::Object(serde_json::Map::new()))
759    };
760
761    // Drive the host's async dispatch on the bridge's runtime. STD mpsc so the
762    // plugin thread can recv from any thread (no ambient runtime). sync_channel
763    // (1): bounded; the send completes once the value is delivered. rx.recv()
764    // parks the plugin thread until the spawn finishes (or its sender drops).
765    let (tx, rx) = mpsc::sync_channel::<Result<serde_json::Value, String>>(1);
766    // Clone the bridge's host + reload callback into the spawned task. We pass
767    // an owned `Arc<dyn RuntimeActionHost>` plus a reload-option snapshot so the
768    // `dispatch` helper has everything it needs without borrowing `bridge`.
769    let host = Arc::clone(&bridge.host);
770    let ui_dialog = bridge.ui_dialog.clone();
771    let reload_cb = bridge.reload.clone();
772    if action == RuntimeActionId::UiDialog {
773        // UiDialog is intentionally synchronous at the plugin ABI boundary:
774        // `open` waits until the TUI answers. Never park that wait inside the
775        // Tokio worker that services the bridge. A SEARCH/extension tool that
776        // invokes `ui_request/open` from a single-thread runtime would
777        // otherwise block the executor before the TUI can deliver the answer.
778        std::thread::spawn(move || {
779            let _ = tx.send(ui_dialog.handle(args));
780        });
781    } else {
782        bridge.runtime.spawn(async move {
783            let r = if action == RuntimeActionId::Reload {
784                if let Some(cb) = reload_cb {
785                    cb().await;
786                    Ok(serde_json::Value::Null)
787                } else {
788                    host.reload(args).await
789                }
790            } else {
791                dispatch(&host, &ui_dialog, action, args).await
792            };
793            // If the plugin thread already moved on (dropped rx), discard — a
794            // send error is NOT a host fault.
795            let _ = tx.send(r);
796        });
797    }
798
799    let result = match rx.recv() {
800        Ok(r) => r,
801        Err(_) => {
802            // Spawned task dropped the sender without sending: runtime shutdown
803            // or the dispatch future panicked (caught inside dispatch? no —
804            // dispatch is plain async, a panic would propagate to the spawn and
805            // drop the sender). No result to return.
806            return -2;
807        }
808    };
809
810    // Write the result (or error) into `*out` as a host-owned StbString. The
811    // plugin frees it via the vtable's `free_string` (= `host_free_string`).
812    if out.is_null() {
813        // Nothing to write to; still report the outcome via the return code.
814        return match result {
815            Ok(_) => 0,
816            Err(_) => 1,
817        };
818    }
819
820    let (rc, payload) = match result {
821        Ok(value) => {
822            let json = serde_json::to_string(&value).unwrap_or_else(|_| "null".to_string());
823            (0, json)
824        }
825        Err(msg) => {
826            let json = serde_json::json!({ "error": msg }).to_string();
827            (1, json)
828        }
829    };
830    // SAFETY: `out` is a valid `*mut StbString` the plugin provided for this
831    // call (null checked above). `from_string` allocates a `Box<[u8]>` the host
832    // owns; the plugin reclaims it via `host_free_string` (which reconstructs
833    // the Box from ptr+len — matches `from_string`'s allocation, same pattern
834    // used by translate.rs/tool.rs).
835    unsafe {
836        *out = StbString::from_string(payload);
837    }
838    rc
839}
840
841// ===========================================================================
842// Tests — round-trip the real trampoline + dispatch + Handle::spawn + mpsc
843// against a mock host. This is the B5a unit proof: plugin→host `runtime_action`
844// recovers the `ActionBridge` via `user_data`, drives the host's async method on
845// the runtime, parks the caller on `rx.recv()`, and writes the result JSON back
846// through `*out` (freed via `host_free_string`). No cdylib needed — the trampoline
847// is the same `extern "C" fn` a plugin's vtable carries.
848// ===========================================================================
849#[cfg(test)]
850mod tests {
851    use super::*;
852    use std::sync::Mutex;
853
854    /// A minimal `RuntimeActionHost` that answers `get_system_prompt` with a
855    /// canned string and `reload` with Ok(null); every other action returns an
856    /// "unimplemented" error. Enough to prove the dispatch switch + the async
857    /// spawn + the mpsc round-trip + the StbString write.
858    struct MockHost {
859        prompt: String,
860        saw: Mutex<Vec<RuntimeActionId>>,
861    }
862
863    #[async_trait::async_trait]
864    impl RuntimeActionHost for MockHost {
865        async fn send_message(&self, _: serde_json::Value) -> Result<serde_json::Value, String> {
866            unreachable!("not under test")
867        }
868        async fn send_user_message(
869            &self,
870            _: serde_json::Value,
871        ) -> Result<serde_json::Value, String> {
872            unreachable!("not under test")
873        }
874        async fn append_entry(&self, _: serde_json::Value) -> Result<serde_json::Value, String> {
875            unreachable!("not under test")
876        }
877        async fn set_session_name(
878            &self,
879            _: serde_json::Value,
880        ) -> Result<serde_json::Value, String> {
881            unreachable!("not under test")
882        }
883        async fn get_active_tools(
884            &self,
885            _: serde_json::Value,
886        ) -> Result<serde_json::Value, String> {
887            unreachable!("not under test")
888        }
889        async fn set_active_tools(
890            &self,
891            _: serde_json::Value,
892        ) -> Result<serde_json::Value, String> {
893            unreachable!("not under test")
894        }
895        async fn set_model(&self, _: serde_json::Value) -> Result<serde_json::Value, String> {
896            unreachable!("not under test")
897        }
898        async fn get_thinking_level(
899            &self,
900            _: serde_json::Value,
901        ) -> Result<serde_json::Value, String> {
902            unreachable!("not under test")
903        }
904        async fn set_thinking_level(
905            &self,
906            _: serde_json::Value,
907        ) -> Result<serde_json::Value, String> {
908            unreachable!("not under test")
909        }
910        async fn compact(&self, _: serde_json::Value) -> Result<serde_json::Value, String> {
911            unreachable!("not under test")
912        }
913        async fn get_system_prompt(
914            &self,
915            _: serde_json::Value,
916        ) -> Result<serde_json::Value, String> {
917            self.saw
918                .lock()
919                .unwrap()
920                .push(RuntimeActionId::GetSystemPrompt);
921            Ok(serde_json::json!({ "prompt": self.prompt }))
922        }
923        async fn new_session(&self, _: serde_json::Value) -> Result<serde_json::Value, String> {
924            unreachable!("not under test")
925        }
926        async fn fork(&self, _: serde_json::Value) -> Result<serde_json::Value, String> {
927            unreachable!("not under test")
928        }
929        async fn navigate_tree(&self, _: serde_json::Value) -> Result<serde_json::Value, String> {
930            unreachable!("not under test")
931        }
932        async fn switch_session(&self, _: serde_json::Value) -> Result<serde_json::Value, String> {
933            unreachable!("not under test")
934        }
935        async fn reload(&self, _: serde_json::Value) -> Result<serde_json::Value, String> {
936            self.saw.lock().unwrap().push(RuntimeActionId::Reload);
937            Ok(serde_json::Value::Null)
938        }
939        async fn get_cli_flag(&self, _: serde_json::Value) -> Result<serde_json::Value, String> {
940            self.saw.lock().unwrap().push(RuntimeActionId::GetCliFlag);
941            Ok(serde_json::json!({ "value": true }))
942        }
943    }
944
945    /// NOTE: these tests use `flavor = "multi_thread"`. The trampoline parks the
946    /// caller on a std `mpsc::rx.recv()` (sync blocking) while the dispatch runs
947    /// via `Handle::spawn` on the runtime. Under a current-thread runtime the
948    /// test's own worker is the only thread that can poll the spawned task —
949    /// blocking it on `recv` self-deadlocks. In the real host the caller is a
950    /// plugin / `spawn_blocking` thread (never a runtime worker), so there is no
951    /// deadlock; multi_thread here mirrors that (another worker runs the spawn
952    /// while the test thread parks).
953    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
954    async fn trampoline_round_trips_get_system_prompt() {
955        let host = Arc::new(MockHost {
956            prompt: "hello from host".to_string(),
957            saw: Mutex::new(Vec::new()),
958        });
959        let host_for_assert = Arc::clone(&host);
960        let host_dyn: Arc<dyn RuntimeActionHost> = host;
961        let runtime = tokio::runtime::Handle::current();
962        let bridge = ActionBridge::new(runtime, host_dyn);
963        let user_data = Arc::as_ptr(&bridge) as *mut c_void;
964
965        // Build a StbStringRef for the args. `{}` — getters ignore it.
966        let args_str = "{}";
967        let args_ref = StbStringRef::from_str(args_str);
968
969        let mut out = StbString::empty();
970        let rc = trampoline_runtime_action(
971            RuntimeActionId::GetSystemPrompt.into(),
972            args_ref,
973            &mut out as *mut StbString,
974            user_data,
975        );
976        assert_eq!(rc, 0, "success return code");
977
978        // Read the result JSON back + reclaim the host-owned StbString.
979        let json_text = out.to_string_lossy();
980        let parsed: serde_json::Value = serde_json::from_str(&json_text).expect("valid json");
981        assert_eq!(parsed["prompt"], "hello from host");
982        crate::host_free_string(out);
983
984        // The host saw exactly the one action. `host_for_assert` is a clone of
985        // the `Arc<MockHost>` kept before it was coerced to the trait object.
986        let saw = host_for_assert.saw.lock().unwrap().clone();
987        assert_eq!(saw, vec![RuntimeActionId::GetSystemPrompt]);
988    }
989
990    #[tokio::test]
991    async fn trampoline_null_user_data_returns_minus_one() {
992        let args_ref = StbStringRef::from_str("{}");
993        let mut out = StbString::empty();
994        let rc = trampoline_runtime_action(
995            RuntimeActionId::GetSystemPrompt.into(),
996            args_ref,
997            &mut out as *mut StbString,
998            std::ptr::null_mut(),
999        );
1000        assert_eq!(rc, -1, "null user_data ⇒ no bridge");
1001    }
1002
1003    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
1004    async fn trampoline_intercepts_reload_when_bridge_has_callback() {
1005        // A bridge with a reload callback: the spawn site intercepts Reload and
1006        // runs the callback instead of the host's `reload` method. Proves the
1007        // bridge-level special-casing (the host impl is the fallback only).
1008        use std::sync::atomic::{AtomicUsize, Ordering};
1009        let reload_calls = Arc::new(AtomicUsize::new(0));
1010        let reload_calls_for_cb = Arc::clone(&reload_calls);
1011        let reload: Arc<dyn Fn() -> futures::future::BoxFuture<'static, ()> + Send + Sync> =
1012            Arc::new(move || {
1013                let c = Arc::clone(&reload_calls_for_cb);
1014                Box::pin(async move {
1015                    c.fetch_add(1, Ordering::SeqCst);
1016                })
1017            });
1018        let host = Arc::new(MockHost {
1019            prompt: String::new(),
1020            saw: Mutex::new(Vec::new()),
1021        });
1022        let host_for_assert = Arc::clone(&host);
1023        let host_dyn: Arc<dyn RuntimeActionHost> = host;
1024        let runtime = tokio::runtime::Handle::current();
1025        let bridge = ActionBridge::with_reload(runtime, host_dyn, reload);
1026        let user_data = Arc::as_ptr(&bridge) as *mut c_void;
1027
1028        let args_ref = StbStringRef::from_str("{}");
1029        let mut out = StbString::empty();
1030        let rc = trampoline_runtime_action(
1031            RuntimeActionId::Reload.into(),
1032            args_ref,
1033            &mut out as *mut StbString,
1034            user_data,
1035        );
1036        assert_eq!(rc, 0);
1037        // The callback ran once; the host's `reload` did NOT.
1038        assert_eq!(reload_calls.load(Ordering::SeqCst), 1);
1039        assert!(host_for_assert.saw.lock().unwrap().is_empty());
1040        crate::host_free_string(out);
1041    }
1042
1043    /// B5d: an invalidated bridge rejects `runtime_action` with a stale-bridge
1044    /// error instead of dispatching. A `/reload` calls `invalidate` on the old
1045    /// bridge; an in-flight call that still holds the old pointer must fail
1046    /// fast rather than drive the swapped-out session.
1047    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
1048    async fn trampoline_rejects_stale_bridge_with_invalidate() {
1049        let host = Arc::new(MockHost {
1050            prompt: String::new(),
1051            saw: Mutex::new(Vec::new()),
1052        });
1053        let host_for_assert = Arc::clone(&host);
1054        let host_dyn: Arc<dyn RuntimeActionHost> = host;
1055        let runtime = tokio::runtime::Handle::current();
1056        let bridge = ActionBridge::new(runtime, host_dyn);
1057        let user_data = Arc::as_ptr(&bridge) as *mut c_void;
1058
1059        // Invalidate (as a `/reload` would on the old bridge).
1060        bridge.invalidate();
1061        assert!(!bridge.is_active());
1062
1063        let args_ref = StbStringRef::from_str("{}");
1064        let mut out = StbString::empty();
1065        let rc = trampoline_runtime_action(
1066            RuntimeActionId::GetSystemPrompt.into(),
1067            args_ref,
1068            &mut out as *mut StbString,
1069            user_data,
1070        );
1071        // Nonzero (error), and the host method never ran (no dispatch).
1072        assert_eq!(rc, 1, "stale bridge ⇒ error return code");
1073        let json_text = out.to_string_lossy();
1074        assert!(
1075            json_text.contains("stale"),
1076            "stale-bridge error payload: {json_text}"
1077        );
1078        crate::host_free_string(out);
1079        assert!(
1080            host_for_assert.saw.lock().unwrap().is_empty(),
1081            "host dispatch must NOT run on a stale bridge"
1082        );
1083    }
1084
1085    #[tokio::test]
1086    async fn trampoline_rejects_unknown_numeric_id_without_dispatch() {
1087        let host = Arc::new(MockHost {
1088            prompt: String::new(),
1089            saw: Mutex::new(Vec::new()),
1090        });
1091        let host_for_assert = Arc::clone(&host);
1092        let host_dyn: Arc<dyn RuntimeActionHost> = host;
1093        let bridge = ActionBridge::new(tokio::runtime::Handle::current(), host_dyn);
1094        let user_data = Arc::as_ptr(&bridge) as *mut c_void;
1095
1096        let mut out = StbString::empty();
1097        let rc = trampoline_runtime_action(
1098            0xFFFF_FFFE,
1099            StbStringRef::from_str("{}"),
1100            &mut out,
1101            user_data,
1102        );
1103
1104        assert_eq!(rc, 2, "unknown action id must be a protocol error");
1105        let payload: serde_json::Value =
1106            serde_json::from_str(&out.to_string_lossy()).expect("structured error JSON");
1107        assert_eq!(payload["error"], "unknown runtime action id 4294967294");
1108        crate::host_free_string(out);
1109        assert!(
1110            host_for_assert.saw.lock().unwrap().is_empty(),
1111            "unknown action id must not reach host dispatch"
1112        );
1113    }
1114
1115    #[tokio::test]
1116    async fn legacy_trampoline_rejects_v2_action_without_dispatch() {
1117        let host = Arc::new(MockHost {
1118            prompt: String::new(),
1119            saw: Mutex::new(Vec::new()),
1120        });
1121        let host_for_assert = Arc::clone(&host);
1122        let host_dyn: Arc<dyn RuntimeActionHost> = host;
1123        let bridge = ActionBridge::new(tokio::runtime::Handle::current(), host_dyn);
1124        let user_data = Arc::as_ptr(&bridge) as *mut c_void;
1125
1126        let mut out = StbString::empty();
1127        let rc = trampoline_runtime_action_v1(
1128            RuntimeActionId::GetCliFlag.into(),
1129            StbStringRef::from_str("{}"),
1130            &mut out,
1131            user_data,
1132        );
1133
1134        assert_eq!(rc, 2);
1135        let payload: serde_json::Value =
1136            serde_json::from_str(&out.to_string_lossy()).expect("structured error JSON");
1137        assert_eq!(payload["error"], "unknown runtime action id 16");
1138        crate::host_free_string(out);
1139        assert!(host_for_assert.saw.lock().unwrap().is_empty());
1140    }
1141
1142    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
1143    async fn legacy_accepts_v1_action_and_v2_accepts_new_action() {
1144        let host = Arc::new(MockHost {
1145            prompt: "legacy".to_string(),
1146            saw: Mutex::new(Vec::new()),
1147        });
1148        let host_for_assert = Arc::clone(&host);
1149        let host_dyn: Arc<dyn RuntimeActionHost> = host;
1150        let bridge = ActionBridge::new(tokio::runtime::Handle::current(), host_dyn);
1151        let user_data = Arc::as_ptr(&bridge) as *mut c_void;
1152
1153        let mut legacy_out = StbString::empty();
1154        assert_eq!(
1155            trampoline_runtime_action_v1(
1156                RuntimeActionId::GetSystemPrompt.into(),
1157                StbStringRef::from_str("{}"),
1158                &mut legacy_out,
1159                user_data,
1160            ),
1161            0
1162        );
1163        crate::host_free_string(legacy_out);
1164
1165        let mut v2_out = StbString::empty();
1166        assert_eq!(
1167            trampoline_runtime_action(
1168                RuntimeActionId::GetCliFlag.into(),
1169                StbStringRef::from_str(r#"{"name":"flag"}"#),
1170                &mut v2_out,
1171                user_data,
1172            ),
1173            0
1174        );
1175        crate::host_free_string(v2_out);
1176
1177        assert_eq!(
1178            *host_for_assert.saw.lock().unwrap(),
1179            vec![
1180                RuntimeActionId::GetSystemPrompt,
1181                RuntimeActionId::GetCliFlag
1182            ]
1183        );
1184    }
1185
1186    /// `ReloadMailbox` + `reload_callback_from_mailbox` round-trip: signalling
1187    /// fires the installed receiver; an uninstalled mailbox yields `Err` (the
1188    /// host's "not configured" fallback). Exercises the B5d reload-signal path
1189    /// the TUI installs.
1190    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
1191    async fn reload_mailbox_signals_installed_receiver() {
1192        let mailbox = ReloadMailbox::new();
1193        // No receiver installed yet ⇒ signal fails.
1194        assert!(matches!(mailbox.signal(), Err(())));
1195
1196        let (tx, mut rx) = tokio::sync::mpsc::unbounded_channel();
1197        mailbox.install(tx);
1198        let cb = reload_callback_from_mailbox(mailbox.clone());
1199        cb().await;
1200        assert_eq!(
1201            rx.recv().await,
1202            Some(()),
1203            "installed receiver saw the signal"
1204        );
1205        mailbox.clear();
1206    }
1207
1208    // ---- UiDialogMailbox (runtime action 17 / ask_user) ----
1209
1210    fn open_args(id: &str, tool_call: &str) -> serde_json::Value {
1211        serde_json::json!({
1212            "op": "open",
1213            "requestId": id,
1214            "toolCallId": tool_call,
1215            "ui": {"kind": "selector", "questions": [
1216                {"id": "q1", "question": "Which target?", "options": ["Linux"]}
1217            ]},
1218        })
1219    }
1220
1221    /// Headless hosts (nothing attached) must fail loudly rather than fabricate
1222    /// a user answer.
1223    #[test]
1224    fn ui_dialog_open_requires_an_attached_ui() {
1225        let mailbox = UiDialogMailbox::new();
1226        let error = mailbox.handle(open_args("r1", "c1")).unwrap_err();
1227        assert!(error.contains("interactive UI"), "got: {error}");
1228    }
1229
1230    #[test]
1231    fn ui_dialog_open_poll_answer_round_trip() {
1232        let mailbox = UiDialogMailbox::new();
1233        mailbox.attach();
1234
1235        let opened = mailbox.handle(open_args("r1", "c1")).unwrap();
1236        assert_eq!(opened["status"], "pending");
1237        assert_eq!(opened["toolCallId"], "c1");
1238
1239        let request = mailbox.take_pending().expect("request visible to TUI");
1240        assert_eq!(request.request_id, "r1");
1241        assert_eq!(request.tool_call_id.as_deref(), Some("c1"));
1242        // A pending poll is non-destructive and remains available.
1243        assert_eq!(mailbox.poll("r1").unwrap()["status"], "pending");
1244        assert_eq!(mailbox.poll("r1").unwrap()["status"], "pending");
1245
1246        mailbox
1247            .respond("r1", serde_json::json!("7890"))
1248            .expect("respond");
1249        let answered = mailbox.poll("r1").unwrap();
1250        assert_eq!(answered["status"], "answered");
1251        assert_eq!(answered["answer"], "7890");
1252        // Polling consumes the terminal entry.
1253        assert!(mailbox.poll("r1").is_err());
1254    }
1255
1256    #[test]
1257    fn ui_dialog_cancel_is_reported_once() {
1258        let mailbox = UiDialogMailbox::new();
1259        mailbox.attach();
1260        mailbox.handle(open_args("r1", "c1")).unwrap();
1261        mailbox.cancel("r1").unwrap();
1262        let cancelled = mailbox.poll("r1").unwrap();
1263        assert_eq!(cancelled["status"], "cancelled");
1264        assert!(mailbox.poll("r1").is_err());
1265    }
1266
1267    #[test]
1268    fn ui_dialog_concurrent_requests_do_not_cross_answers() {
1269        let mailbox = UiDialogMailbox::new();
1270        mailbox.attach();
1271        mailbox.handle(open_args("r1", "c1")).unwrap();
1272        mailbox.handle(open_args("r2", "c2")).unwrap();
1273
1274        let first = mailbox.take_pending().unwrap().request_id;
1275        let second = mailbox.take_pending().unwrap().request_id;
1276        assert_ne!(first, second);
1277
1278        // Answer the SECOND request first; the first must stay pending.
1279        mailbox.respond(&second, serde_json::json!("second")).unwrap();
1280        assert_eq!(mailbox.poll(&first).unwrap()["status"], "pending");
1281        let second_answer = mailbox.poll(&second).unwrap();
1282        assert_eq!(second_answer["answer"], "second");
1283
1284        mailbox.respond(&first, serde_json::json!("first")).unwrap();
1285        assert_eq!(mailbox.poll(&first).unwrap()["answer"], "first");
1286    }
1287
1288    #[test]
1289    fn ui_dialog_detach_cancels_outstanding() {
1290        let mailbox = UiDialogMailbox::new();
1291        mailbox.attach();
1292        mailbox.handle(open_args("r1", "c1")).unwrap();
1293        mailbox.detach();
1294        assert!(!mailbox.is_attached());
1295        assert_eq!(mailbox.pending_len(), 0);
1296        // Re-opening without a consumer is an explicit error again.
1297        assert!(mailbox.handle(open_args("r2", "c2")).is_err());
1298        assert_eq!(mailbox.poll("r1").unwrap()["status"], "cancelled");
1299    }
1300
1301    #[test]
1302    fn ui_dialog_duplicate_open_does_not_reenqueue() {
1303        let mailbox = UiDialogMailbox::new();
1304        mailbox.attach();
1305        mailbox.handle(open_args("r1", "c1")).unwrap();
1306        let again = mailbox.handle(open_args("r1", "c1")).unwrap();
1307        assert_eq!(again["status"], "pending");
1308        assert_eq!(mailbox.pending_len(), 1);
1309        mailbox.take_pending().unwrap();
1310        assert!(mailbox.take_pending().is_none());
1311    }
1312
1313    /// The v2 trampoline must route action 17 into the session mailbox rather
1314    /// than rejecting it as unknown, and a detached mailbox must surface the
1315    /// explicit "requires an interactive UI" error (headless contract).
1316    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
1317    async fn v2_dispatch_routes_ui_dialog_action_17() {
1318        let host: Arc<dyn RuntimeActionHost> = Arc::new(MockHost {
1319            prompt: String::new(),
1320            saw: Mutex::new(Vec::new()),
1321        });
1322        let bridge = ActionBridge::with_ui_dialog(
1323            tokio::runtime::Handle::current(),
1324            host,
1325            UiDialogMailbox::new(),
1326        );
1327        let user_data = Arc::as_ptr(&bridge) as *mut c_void;
1328
1329        let mut out = StbString::empty();
1330        let rc = trampoline_runtime_action(
1331            17,
1332            StbStringRef::from_str(r#"{"op":"open","requestId":"r1","ui":{}}"#),
1333            &mut out,
1334            user_data,
1335        );
1336        assert_eq!(rc, 1);
1337        let payload: serde_json::Value =
1338            serde_json::from_str(&out.to_string_lossy()).expect("structured error JSON");
1339        assert!(
1340            payload["error"]
1341                .as_str()
1342                .is_some_and(|error| error.contains("interactive UI")),
1343            "unexpected payload: {payload}"
1344        );
1345        crate::host_free_string(out);
1346
1347        // The next id remains unknown (no silent acceptance of arbitrary ids).
1348        let mut out = StbString::empty();
1349        assert_eq!(
1350            trampoline_runtime_action(18, StbStringRef::from_str("{}"), &mut out, user_data),
1351            2
1352        );
1353        crate::host_free_string(out);
1354    }
1355}