Skip to main content

mcpmesh_local_api/
client.rs

1//! A no-iroh mcpmesh-local/1 client: connect the UDS, read the server's `Hello`
2//! first frame, assert the api name, then issue typed request/response frames. Distinct
3//! from the CLI crate (`cli/`)'s ControlClient (which uses mcpmesh_net::framing) — this one links no
4//! iroh, so kb and the host shell can use it. kb calls this to self-register
5//! its `[services.kb]` socket backend with the running mcpmesh daemon.
6use std::path::Path;
7
8use serde_json::Value;
9
10use crate::codec::{FrameReader, Inbound, MAX_FRAME_BYTES, write_frame};
11use crate::protocol::{
12    AuditSummaryResult, BackendSpec, BlobFetchCancelParams, BlobFetchCancelResult, BlobFetchParams,
13    BlobFetchResult, BlobGrantParams, BlobPublishParams, BlobPublishResult, BlobScopeList, Hello,
14    InviteParams, InviteResult, OpenSessionParams, OrgJoinParams, OrgJoinResult, PairParams,
15    PairResult, PeerEndorseParams, PeerEndorseResult, PeerIntroduceParams, PeerRemoveParams,
16    PeerRenameParams, PeerServicesParams, PeerServicesResult, RegisterServiceParams, Request,
17    RosterInstallParams, RosterInstallResult, ServiceAllowParams, SetAppMetadataParams,
18    SetNicknameParams, SetRelaysParams, SetRelaysResult, SetRosterUrlParams, StatusResult,
19    StreamFrame, UnregisterServiceParams,
20};
21use crate::transport::{connect_local, split_local};
22
23/// The client's read half — boxed so ONE `ControlClient` serves every transport (the
24/// platform socket/pipe via [`connect_control`], or an embedder's in-memory duplex via
25/// [`connect_control_io`]).
26pub type ControlRead = Box<dyn tokio::io::AsyncRead + Send + Unpin>;
27/// The client's write half — see [`ControlRead`].
28pub type ControlWrite = Box<dyn tokio::io::AsyncWrite + Send + Unpin>;
29
30/// A connected mcpmesh-local/1 client: the framed stream + the server's `Hello`.
31pub struct ControlClient {
32    hello: Hello,
33    reader: FrameReader<ControlRead>,
34    writer: ControlWrite,
35}
36
37/// Hand-rolled (the boxed transport halves are not `Debug`): the `Hello` is the one
38/// diagnostic a `{:?}` needs — tests format `Result<ControlClient, _>` this way.
39impl std::fmt::Debug for ControlClient {
40    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
41        f.debug_struct("ControlClient")
42            .field("hello", &self.hello)
43            .finish_non_exhaustive()
44    }
45}
46
47/// The error surface of the client — thin, so callers can `anyhow`-wrap it.
48///
49/// The `Display`/`Error`/`From` impls below are hand-rolled rather than derived: the
50/// `client` feature deliberately pulls ONLY tokio (no `thiserror`), and the hand-rolled
51/// impls are behavior-identical (same messages, same `?`-conversion from `io::Error`)
52/// with zero extra dependencies.
53#[derive(Debug)]
54pub enum ClientError {
55    Io(std::io::Error),
56    Closed(&'static str),
57    Malformed(&'static str),
58    WrongApi { got: String, want: &'static str },
59    Api(Value),
60}
61
62impl std::fmt::Display for ClientError {
63    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
64        match self {
65            ClientError::Io(err) => write!(f, "io: {err}"),
66            ClientError::Closed(what) => write!(f, "connection closed before {what}"),
67            ClientError::Malformed(what) => write!(f, "malformed {what} frame"),
68            ClientError::WrongApi { got, want } => {
69                write!(f, "unexpected api: got {got:?}, want {want:?}")
70            }
71            ClientError::Api(err) => write!(f, "control API error: {err}"),
72        }
73    }
74}
75
76impl std::error::Error for ClientError {}
77
78impl From<std::io::Error> for ClientError {
79    fn from(err: std::io::Error) -> Self {
80        ClientError::Io(err)
81    }
82}
83
84impl ControlClient {
85    pub fn hello(&self) -> &Hello {
86        &self.hello
87    }
88
89    /// Issue a typed request; return the JSON-RPC `result` (or `ClientError::Api` on a
90    /// JSON-RPC `error`).
91    pub async fn request(&mut self, request: Request) -> Result<Value, ClientError> {
92        let frame = serde_json::to_value(&request).expect("Request serializes");
93        self.request_value(&frame).await
94    }
95
96    /// Issue a RAW request frame — the escape hatch for methods outside the typed
97    /// [`Request`] surface (the daemon-internal `shutdown`, third-party
98    /// `{"method":..,"params":{}}` shapes the dispatcher tolerates). Returns the JSON-RPC
99    /// `result` value (or `ClientError::Api` on a JSON-RPC `error`).
100    pub async fn request_value(&mut self, request: &Value) -> Result<Value, ClientError> {
101        write_frame(&mut self.writer, request).await?;
102        match self.reader.next().await? {
103            Some(Inbound::Frame(resp)) => {
104                if let Some(err) = resp.get("error") {
105                    return Err(ClientError::Api(err.clone()));
106                }
107                Ok(resp.get("result").cloned().unwrap_or(Value::Null))
108            }
109            Some(Inbound::Violation(_)) => Err(ClientError::Malformed("response")),
110            None => Err(ClientError::Closed("response")),
111        }
112    }
113
114    /// Send a request WITHOUT reading a response — for `OpenSession`, after which the
115    /// socket stops being JSON-RPC and becomes a raw MCP byte pipe (protocol.rs). Returns
116    /// the framed halves so the caller can pump the session — the SAME `FrameReader` that
117    /// read the Hello, so bytes the daemon pipelined behind it are never lost. A caller
118    /// that must re-box the read half calls `FrameReader::into_inner`, which returns the
119    /// BUFFERED reader (its read-ahead travels with it — see the pipelining test below).
120    pub async fn open_session(
121        mut self,
122        peer: String,
123        service: String,
124    ) -> Result<(FrameReader<ControlRead>, ControlWrite), ClientError> {
125        let frame = serde_json::to_value(Request::OpenSession(OpenSessionParams { peer, service }))
126            .expect("Request serializes");
127        write_frame(&mut self.writer, &frame).await?;
128        Ok((self.reader, self.writer))
129    }
130
131    /// Send a parameterless stream-upgrade request WITHOUT reading a response — like
132    /// [`open_session`](Self::open_session), but generic on the `method`: after this call the
133    /// socket stops being request/response and becomes a one-way push stream of frames the caller
134    /// READS (the `subscribe` telemetry surface). Returns the framed halves — the SAME
135    /// `FrameReader` that read the Hello, so any frame the daemon pipelined behind it is never
136    /// lost. The write half is handed back so the caller can hold the connection open (a watcher
137    /// only reads, but dropping the writer would half-close the socket).
138    pub async fn open_stream(
139        mut self,
140        method: &str,
141    ) -> Result<(FrameReader<ControlRead>, ControlWrite), ClientError> {
142        let frame = serde_json::json!({ "method": method });
143        write_frame(&mut self.writer, &frame).await?;
144        Ok((self.reader, self.writer))
145    }
146
147    /// Issue `request` and deserialize the JSON-RPC `result` into `T` — the shared core of every
148    /// typed helper below. `what` names the result in the [`ClientError::Malformed`] surface. The
149    /// wrong-type hazard the raw [`request`](Self::request) leaves to the caller is closed here:
150    /// each helper pairs its Request variant with its result type once, in this crate.
151    async fn request_typed<T: serde::de::DeserializeOwned>(
152        &mut self,
153        request: Request,
154        what: &'static str,
155    ) -> Result<T, ClientError> {
156        let v = self.request(request).await?;
157        serde_json::from_value(v).map_err(|_| ClientError::Malformed(what))
158    }
159
160    /// Issue `request` and discard the ack body (the daemon answers `{}` for verbs with no result
161    /// vocabulary). A JSON-RPC error still surfaces as [`ClientError::Api`].
162    async fn request_ack(&mut self, request: Request) -> Result<(), ClientError> {
163        self.request(request).await.map(|_| ())
164    }
165
166    /// The daemon's `status` picture: services served, known peers, roster/presence state,
167    /// self identity, recent pairings, and advisory reachability.
168    pub async fn status(&mut self) -> Result<StatusResult, ClientError> {
169        self.request_typed(Request::Status, "status result").await
170    }
171
172    /// Register/update a `[services.*]` entry idempotently (the daemon persists it and hot-reloads
173    /// serving). The daemon acks; the ack body is discarded.
174    pub async fn register_service(
175        &mut self,
176        name: &str,
177        backend: BackendSpec,
178        allow: Vec<String>,
179    ) -> Result<(), ClientError> {
180        self.register_service_with(name, backend, allow, false)
181            .await
182    }
183
184    /// [`register_service`](Self::register_service) with an explicit `ephemeral` flag (#36). When
185    /// `ephemeral` is true the registration lives only in daemon memory and is unregistered
186    /// automatically when THIS control connection closes — no config write, nothing to clean up.
187    /// Ideal for an embedder serving a `socket` backend from a fresh path each run.
188    pub async fn register_service_with(
189        &mut self,
190        name: &str,
191        backend: BackendSpec,
192        allow: Vec<String>,
193        ephemeral: bool,
194    ) -> Result<(), ClientError> {
195        self.request_ack(Request::RegisterService(RegisterServiceParams {
196            name: name.to_string(),
197            backend,
198            allow,
199            ephemeral,
200            rate_limit_per_min: None,
201        }))
202        .await
203    }
204
205    /// Mint a single-use pairing invite granting `services` (see `invite_multi` for more than
206    /// one); return the copyable
207    /// `mcpmesh-invite:` line + its expiry.
208    pub async fn invite(&mut self, services: Vec<String>) -> Result<InviteResult, ClientError> {
209        self.invite_with(services, None).await
210    }
211
212    /// [`invite`](Self::invite) with an opaque `app_label` (#31) carried through to the redeemer's
213    /// `pair` result. mcpmesh never interprets the label; the embedder does (e.g. its own URN).
214    pub async fn invite_with(
215        &mut self,
216        services: Vec<String>,
217        app_label: Option<String>,
218    ) -> Result<InviteResult, ClientError> {
219        self.invite_multi(services, app_label, None).await
220    }
221
222    /// `invite_with`, plus `max_uses` (#87): an invite redeemable up to that many times, each
223    /// redemption running its own SAS ceremony and writing its own peer rows.
224    ///
225    /// `None` = 1, the single-use default. The value is clamped daemon-side to
226    /// [`MAX_INVITE_USES`](crate::MAX_INVITE_USES) — read
227    /// [`InviteResult::uses_remaining`](crate::InviteResult::uses_remaining) for what you actually
228    /// got rather than assuming the request was honoured verbatim.
229    pub async fn invite_multi(
230        &mut self,
231        services: Vec<String>,
232        app_label: Option<String>,
233        max_uses: Option<u32>,
234    ) -> Result<InviteResult, ClientError> {
235        self.invite_named(services, app_label, max_uses, None).await
236    }
237
238    /// Mint an invite, optionally under YOUR OWN local name for whoever redeems it (#87).
239    ///
240    /// `peer_nickname` overrides the name they claim for themselves — the fix for two same-model
241    /// machines that does not require the other person to rename theirs. Never sent to them, and
242    /// rejected alongside `max_uses > 1` (one name for every redeemer collides on the second).
243    pub async fn invite_named(
244        &mut self,
245        services: Vec<String>,
246        app_label: Option<String>,
247        max_uses: Option<u32>,
248        peer_nickname: Option<String>,
249    ) -> Result<InviteResult, ClientError> {
250        self.invite_full(services, app_label, max_uses, peer_nickname, false)
251            .await
252    }
253
254    /// Mint an invite, optionally as a SELF-ENROLLMENT (#86): the redeemer becomes another device
255    /// of YOU rather than a peer, so both present one identity.
256    ///
257    /// `as_self` requires an empty `services` and `max_uses` of 1 — it grants nothing, and a
258    /// multi-use identity invite is a standing offer to become you.
259    pub async fn invite_full(
260        &mut self,
261        services: Vec<String>,
262        app_label: Option<String>,
263        max_uses: Option<u32>,
264        peer_nickname: Option<String>,
265        as_self: bool,
266    ) -> Result<InviteResult, ClientError> {
267        self.request_typed(
268            Request::Invite(InviteParams {
269                services,
270                app_label,
271                max_uses,
272                peer_nickname,
273                as_self,
274            }),
275            "invite result",
276        )
277        .await
278    }
279
280    /// Produce an endorsement of `subject` for someone else to redeem (#65).
281    ///
282    /// Signs with THIS node's user key. It is a statement for the recipient — it changes nothing
283    /// about your own trust in the subject, and only resolves for someone paired with you.
284    pub async fn endorse_peer(
285        &mut self,
286        subject: &str,
287        subject_user_id: Option<String>,
288    ) -> Result<PeerEndorseResult, ClientError> {
289        self.request_typed(
290            Request::PeerEndorse(PeerEndorseParams {
291                subject: subject.to_string(),
292                subject_user_id,
293            }),
294            "peer endorse result",
295        )
296        .await
297    }
298
299    /// Install a peer from an endorsement by someone you are already paired with (#65).
300    ///
301    /// Installs IDENTITY, not authorization — the peer becomes resolvable and is granted nothing.
302    /// `subject_user_id` requires `subject_binding`, the subject's OWN device→user binding: a
303    /// `user_id` is authorization-bearing and public, so an endorser alone must not attach one.
304    pub async fn introduce_peer(&mut self, params: PeerIntroduceParams) -> Result<(), ClientError> {
305        self.request_ack(Request::PeerIntroduce(params)).await
306    }
307
308    /// Redeem a pairing invite; return the inviter's suggested nickname, the display-only SAS
309    /// code, and the granted services.
310    pub async fn pair(&mut self, invite_line: &str) -> Result<PairResult, ClientError> {
311        self.pair_as(invite_line, None).await
312    }
313
314    /// Redeem an invite, optionally under YOUR OWN local name for the inviter (#87).
315    ///
316    /// `as_nickname` overrides the name the invite suggests. Use it when that name is already
317    /// taken locally — otherwise the pairing is refused and the only other fixes are asking the
318    /// inviter to re-mint or renaming your existing peer. It does not bypass the collision check:
319    /// an alias that itself collides is refused the same way.
320    pub async fn pair_as(
321        &mut self,
322        invite_line: &str,
323        as_nickname: Option<String>,
324    ) -> Result<PairResult, ClientError> {
325        self.pair_opts(invite_line, as_nickname, false).await
326    }
327
328    /// Redeem an invite, stating whether a SELF-ENROLLMENT is a ceremony you offered (#178).
329    ///
330    /// [`pair`](Self::pair) and [`pair_as`](Self::pair_as) pass `false`, so a `mcpmesh-enroll:` line
331    /// pasted into an ordinary "join" field is refused with
332    /// [`ERR_SELF_ENROLL_NOT_OFFERED`](crate::ERR_SELF_ENROLL_NOT_OFFERED) before anything is
333    /// dialled — the invite survives, so the same line still works once the person is offered the
334    /// real choice. Pass `true` only from a path that actually means "add another of my own
335    /// devices": the ceremony writes a device→user binding that is irrevocable short of rotating
336    /// the user key.
337    ///
338    /// `mcpmesh_node::pairing::is_enrollment_line` answers which kind of line you are holding without
339    /// dialling, for a UI that wants to PROMPT rather than recover from a refusal.
340    pub async fn pair_opts(
341        &mut self,
342        invite_line: &str,
343        as_nickname: Option<String>,
344        allow_self_enroll: bool,
345    ) -> Result<PairResult, ClientError> {
346        self.request_typed(
347            Request::Pair(PairParams {
348                invite_line: invite_line.to_string(),
349                as_nickname,
350                allow_self_enroll,
351            }),
352            "pair result",
353        )
354        .await
355    }
356
357    /// Unpair a peer by nickname: drops its identity row AND its every-`allow` membership
358    /// (idempotent; live sessions are not severed). The daemon acks; the ack body is discarded.
359    pub async fn peer_remove(&mut self, nickname: &str) -> Result<(), ClientError> {
360        self.request_ack(Request::PeerRemove(PeerRemoveParams {
361            nickname: nickname.to_string(),
362        }))
363        .await
364    }
365
366    /// Rename a contact's nickname to `to` — every device sharing `user_id` when given, else the
367    /// single provisional `nickname` entry — carrying its grants along. The daemon refuses (a
368    /// [`ClientError::Api`]) when `to` is empty or already names a different identity. The daemon
369    /// acks; the ack body is discarded.
370    pub async fn peer_rename(
371        &mut self,
372        user_id: Option<String>,
373        nickname: Option<String>,
374        to: &str,
375    ) -> Result<(), ClientError> {
376        self.request_ack(Request::PeerRename(PeerRenameParams {
377            user_id,
378            nickname,
379            to: to.to_string(),
380        }))
381        .await
382    }
383
384    /// Install a signed roster from the LOCAL file at `path` (`org_root_pk` pins the org root on
385    /// FIRST install); return the installed org id + serial + severed-session count.
386    pub async fn roster_install(
387        &mut self,
388        path: &str,
389        org_root_pk: Option<String>,
390    ) -> Result<RosterInstallResult, ClientError> {
391        self.request_typed(
392            Request::RosterInstall(RosterInstallParams {
393                path: path.to_string(),
394                org_root_pk,
395            }),
396            "roster_install result",
397        )
398        .await
399    }
400
401    /// Read the installed roster's MEMBERSHIP (#93): the declared groups, and every person with
402    /// their display name, groups, and devices.
403    ///
404    /// Distinct from [`status`](Self::status)'s `presence`, which enumerates reachable DEVICES and
405    /// omits a person entirely when none of theirs is up. This is the member list — everyone the
406    /// roster carries, with `online` per device, so one read serves both questions.
407    ///
408    /// Advisory: display and authoring input, never an authorization answer. Empty in a
409    /// pure-pairing daemon and before the first roster is installed. `api_minor >= 46`.
410    pub async fn roster_members(
411        &mut self,
412    ) -> Result<crate::protocol::RosterMembersResult, ClientError> {
413        self.request_typed(Request::RosterMembers, "roster_members result")
414            .await
415    }
416
417    /// AUTHOR an org (#66): mint this node's org root key, sign an empty roster, install it (which
418    /// pins the root), and return the copyable invite plus the root's fingerprint.
419    ///
420    /// **One-time per node** — a second call is refused rather than replacing the key, which would
421    /// orphan every roster already signed with it.
422    ///
423    /// Show `org_root_fingerprint` to the operator: it is what every joiner reads back
424    /// out-of-band, and it is the only thing anchoring their trust in the org. `api_minor >= 46`.
425    pub async fn org_create(
426        &mut self,
427        name: &str,
428        expires_secs: Option<i64>,
429        roster_url: Option<String>,
430    ) -> Result<crate::protocol::OrgCreateResult, ClientError> {
431        self.request_typed(
432            Request::OrgCreate(crate::protocol::OrgCreateParams {
433                name: name.to_string(),
434                expires_secs,
435                roster_url,
436            }),
437            "org_create result",
438        )
439        .await
440    }
441
442    /// APPROVE a join code into the roster (#66): verify its device→user-key binding, add the
443    /// member with `groups`, re-sign, install.
444    ///
445    /// **The result's `join_code_fingerprint` is not decoration.** Nothing in a join code binds it
446    /// to a human, so a substituted code is caught by the two people comparing that fingerprint
447    /// out-of-band, or it is not caught at all. Show it and have the operator confirm it.
448    ///
449    /// Each group must already be declared in the roster; an undeclared one is refused. `user_id`
450    /// overrides the id the joiner requested — worth using, since that id is chosen by the person
451    /// being approved and is what every `allow` entry will name. `api_minor >= 46`.
452    pub async fn org_approve(
453        &mut self,
454        join_code: &str,
455        groups: Vec<String>,
456        user_id: Option<String>,
457    ) -> Result<crate::protocol::OrgApproveResult, ClientError> {
458        self.request_typed(
459            Request::OrgApprove(crate::protocol::OrgApproveParams {
460                join_code: join_code.to_string(),
461                groups,
462                user_id,
463            }),
464            "org_approve result",
465        )
466        .await
467    }
468
469    /// INSPECT a join code without approving it (#66): what it claims, and the fingerprint that
470    /// decides whether to believe it. Read-only — nothing is signed or installed.
471    ///
472    /// **Call this before [`org_approve`](Self::org_approve), show
473    /// `join_code_fingerprint`, and have the operator confirm it out-of-band.** Nothing in a join
474    /// code binds it to a person; a substituted one carries a different key and diverges here. The
475    /// fingerprint on the approval RESULT is the same words, but by then the member is in the
476    /// signed roster — too late to decline.
477    ///
478    /// The claims (`display_name`, `requested_user_id`, `device_label`) are chosen by the sender.
479    /// Render them; do not trust them. A forged binding is refused rather than described.
480    /// `api_minor >= 46`.
481    pub async fn org_join_code(
482        &mut self,
483        join_code: &str,
484    ) -> Result<crate::protocol::OrgJoinCodeResult, ClientError> {
485        self.request_typed(
486            Request::OrgJoinCode(crate::protocol::OrgJoinCodeParams {
487                join_code: join_code.to_string(),
488            }),
489            "org_join_code result",
490        )
491        .await
492    }
493
494    /// REVOKE from the roster (#66) — and sever the cut devices' live sessions, immediately.
495    ///
496    /// Three readings, and picking the wrong one is destructive, so the result reports which
497    /// `mode` was applied: `"<user_id>/<label>"` cuts ONE device; a bare `user_id` removes the
498    /// person and revokes ALL their devices; `user_key = true` is a key ROTATION — the person is
499    /// removed but their devices stay un-revoked so the same hardware re-enrolls under a fresh
500    /// user key. `api_minor >= 46`.
501    pub async fn org_revoke(
502        &mut self,
503        target: &str,
504        user_key: bool,
505    ) -> Result<crate::protocol::OrgRevokeResult, ClientError> {
506        self.request_typed(
507            Request::OrgRevoke(crate::protocol::OrgRevokeParams {
508                target: target.to_string(),
509                user_key,
510            }),
511            "org_revoke result",
512        )
513        .await
514    }
515
516    /// Pin the org root on a JOINER (no roster yet). `user_key` is a LOCAL path — the key never
517    /// crosses the API. Returns the pinned org id.
518    pub async fn org_join(
519        &mut self,
520        org_id: &str,
521        org_root_pk: &str,
522        user_id: &str,
523        user_key: &str,
524    ) -> Result<OrgJoinResult, ClientError> {
525        self.request_typed(
526            Request::OrgJoin(OrgJoinParams {
527                org_id: org_id.to_string(),
528                org_root_pk: org_root_pk.to_string(),
529                user_id: user_id.to_string(),
530                user_key: user_key.to_string(),
531            }),
532            "org_join result",
533        )
534        .await
535    }
536
537    /// Pin the HTTPS roster URL (`[roster].url`) in the daemon's config. The daemon acks; the
538    /// ack body is discarded.
539    pub async fn set_roster_url(&mut self, url: &str) -> Result<(), ClientError> {
540        self.request_ack(Request::SetRosterUrl(SetRosterUrlParams {
541            url: url.to_string(),
542        }))
543        .await
544    }
545
546    /// Discover which services a paired `peer` (a nickname, `eid:`, or `b64u:`) CURRENTLY grants
547    /// the caller (#52) — dials the peer and returns the service names its allow admits for the
548    /// caller's principal (only your own admitted services, never the peer's full registry).
549    pub async fn peer_services(&mut self, peer: &str) -> Result<Vec<String>, ClientError> {
550        self.request_typed::<PeerServicesResult>(
551            Request::PeerServices(PeerServicesParams {
552                peer: peer.to_string(),
553            }),
554            "peer_services",
555        )
556        .await
557        .map(|r| r.services)
558    }
559
560    /// Remove a service registration (#50) — the deregistration mirror of `register_service`.
561    /// Removes the whole entry (allow included) + any ephemeral registration of the name, then
562    /// hot-reloads. Idempotent: an unknown name is a clean no-op.
563    pub async fn unregister_service(&mut self, name: &str) -> Result<(), ClientError> {
564        self.request_ack(Request::UnregisterService(UnregisterServiceParams {
565            name: name.to_string(),
566        }))
567        .await
568    }
569
570    /// Grant a stable `principal` (`b64u:`/`eid:`) access to `service` WITHOUT (re)pairing (#44)
571    /// — the per-peer "sharing on" toggle. Idempotent; an unknown service is a clean no-op.
572    pub async fn service_allow_grant(
573        &mut self,
574        service: &str,
575        principal: &str,
576    ) -> Result<(), ClientError> {
577        self.request_ack(Request::ServiceAllowGrant(ServiceAllowParams {
578            service: service.to_string(),
579            principal: principal.to_string(),
580        }))
581        .await
582    }
583
584    /// Revoke a stable `principal` from `service`'s allow WITHOUT unpairing (#44) — the
585    /// "sharing off" toggle. The peer's identity row is untouched; it just cannot open NEW
586    /// sessions (in-flight ones run to completion). Idempotent.
587    pub async fn service_allow_revoke(
588        &mut self,
589        service: &str,
590        principal: &str,
591    ) -> Result<(), ClientError> {
592        self.request_ack(Request::ServiceAllowRevoke(ServiceAllowParams {
593            service: service.to_string(),
594            principal: principal.to_string(),
595        }))
596        .await
597    }
598
599    /// Set this node's opaque app-metadata blob (#39, roster mode): ≤256 bytes, folded
600    /// signed into each presence heartbeat so paired peers read it in `status` presence —
601    /// no per-peer session. `""` clears it; in-memory (re-set on startup).
602    pub async fn set_app_metadata(&mut self, metadata: &str) -> Result<(), ClientError> {
603        self.request_ack(Request::SetAppMetadata(SetAppMetadataParams {
604            metadata: metadata.to_string(),
605        }))
606        .await
607    }
608
609    /// Set this node's CUSTOM relay set LIVE (#53). `relay_urls` is the desired set (each must
610    /// parse as an iroh `RelayUrl`; empty is rejected). When the node is already in
611    /// `relay_mode = "custom"`, the daemon diffs against the running endpoint and applies the
612    /// delta live (iroh `insert_relay`/`remove_relay`) — no restart, no dropped sessions — then
613    /// persists `[network]`. When the node is currently `default`/`disabled`, the config is
614    /// persisted but the live mode transition isn't possible: the returned
615    /// [`SetRelaysResult::restart_required`] is `true`. Idempotent (an unchanged set → `changed:
616    /// false`, no writes).
617    pub async fn set_relays(
618        &mut self,
619        relay_urls: &[String],
620    ) -> Result<SetRelaysResult, ClientError> {
621        self.request_typed::<SetRelaysResult>(
622            Request::SetRelays(SetRelaysParams {
623                relay_urls: relay_urls.to_vec(),
624            }),
625            "set_relays",
626        )
627        .await
628    }
629
630    /// Rename this node LIVE (#37): the daemon validates + persists `[identity].nickname`
631    /// under its own config lock and updates the name future invites present — no restart.
632    /// Peers keep their stored pairing-time nickname until a re-invite (display-only).
633    pub async fn set_nickname(&mut self, nickname: &str) -> Result<(), ClientError> {
634        self.request_ack(Request::SetNickname(SetNicknameParams {
635            nickname: nickname.to_string(),
636        }))
637        .await
638    }
639
640    /// Summarize the daemon's LOCAL audit log into per-peer / per-service session counts
641    /// (local-only — nothing is transmitted).
642    pub async fn audit_summary(&mut self) -> Result<AuditSummaryResult, ClientError> {
643        self.request_typed(Request::AuditSummary, "audit_summary result")
644            .await
645    }
646
647    /// Publish a local file into `scope`; return the minted `mcpmesh/blob/1` ticket + hash.
648    pub async fn blob_publish(
649        &mut self,
650        scope: &str,
651        path: &str,
652    ) -> Result<BlobPublishResult, ClientError> {
653        self.request_typed(
654            Request::BlobPublish(BlobPublishParams {
655                scope: scope.to_string(),
656                path: path.to_string(),
657            }),
658            "blob_publish result",
659        )
660        .await
661    }
662
663    /// List the daemon's blob scopes (name → hashes + grants + withdrawn).
664    ///
665    /// A DEFAULT LIMIT applies (#84b) — check `truncated` and page with
666    /// [`blob_list_paged`](Self::blob_list_paged) rather than assuming you saw everything.
667    pub async fn blob_list(&mut self) -> Result<BlobScopeList, ClientError> {
668        self.blob_list_paged(Default::default()).await
669    }
670
671    /// List blob scopes with filters + paging (#84b, `api_minor >= 20`).
672    pub async fn blob_list_paged(
673        &mut self,
674        params: crate::BlobListParams,
675    ) -> Result<BlobScopeList, ClientError> {
676        self.request_typed(Request::BlobList(params), "blob_list result")
677            .await
678    }
679
680    /// Fetch a `mcpmesh/blob/1` ticket THROUGH the daemon (BLAKE3-verified), export to
681    /// `dest_path`; return the verified hash + byte length.
682    pub async fn blob_fetch(
683        &mut self,
684        ticket: &str,
685        dest_path: &str,
686    ) -> Result<BlobFetchResult, ClientError> {
687        self.request_typed(
688            Request::BlobFetch(BlobFetchParams {
689                ticket: ticket.to_string(),
690                dest_path: dest_path.to_string(),
691            }),
692            "blob_fetch result",
693        )
694        .await
695    }
696
697    /// Stop every in-flight [`blob_fetch`](Self::blob_fetch) of `hash` (#172).
698    ///
699    /// **Send this on a DIFFERENT connection than the fetch it cancels.** This client is one
700    /// request at a time — `&mut self` is borrowed until the fetch answers — so a cancel issued on
701    /// the same client can only run after the thing it would cancel is already over. The cancelled
702    /// fetch answers [`ERR_CANCELLED`](crate::ERR_CANCELLED) on its own connection.
703    ///
704    /// `cancelled: false` means nothing was fetching that blob here. That is the honest answer to a
705    /// cancel that raced a fetch to completion, not an error.
706    ///
707    /// Needs `api_minor >= 44`; below it the method is unknown.
708    pub async fn blob_fetch_cancel(
709        &mut self,
710        hash: &str,
711    ) -> Result<BlobFetchCancelResult, ClientError> {
712        self.request_typed(
713            Request::BlobFetchCancel(BlobFetchCancelParams {
714                hash: hash.to_string(),
715            }),
716            "blob_fetch_cancel result",
717        )
718        .await
719    }
720
721    /// Grant a scope to a principal — any flat-namespace entry: a group name, a user_id,
722    /// or a nickname (the shared `principal_set` expansion).
723    /// The daemon acks; the ack body is discarded (a JSON-RPC error surfaces as
724    /// `ClientError::Api`). Granting a scope to your own user_id reaches ALL of that
725    /// person's devices.
726    pub async fn blob_grant(&mut self, scope: &str, principal: &str) -> Result<(), ClientError> {
727        self.request_ack(Request::BlobGrant(BlobGrantParams {
728            scope: scope.to_string(),
729            principal: principal.to_string(),
730        }))
731        .await
732    }
733
734    /// The TYPED `subscribe` upgrade: send [`Request::Subscribe`] (after which the connection
735    /// stops being request/response — see [`open_stream`](Self::open_stream)) and return a
736    /// [`StreamSubscription`] yielding [`StreamFrame`]s. For raw frames (e.g. to tolerate frame
737    /// types newer than this crate), use `open_stream("subscribe")` instead.
738    pub async fn subscribe(self) -> Result<StreamSubscription, ClientError> {
739        let (reader, writer) = self.open_stream("subscribe").await?;
740        Ok(StreamSubscription {
741            reader,
742            _writer: writer,
743        })
744    }
745}
746
747/// A live [`Request::Subscribe`] stream yielding typed [`StreamFrame`]s (snapshot, then
748/// events/lagged notices) until the daemon side closes. Holds the connection's write half for its
749/// lifetime — a subscriber only reads, but dropping the writer would half-close the socket. Drop
750/// the subscription to disconnect (there is no request channel back).
751pub struct StreamSubscription {
752    reader: FrameReader<ControlRead>,
753    _writer: ControlWrite,
754}
755
756/// Hand-rolled like [`ControlClient`]'s: the boxed transport halves are not `Debug`.
757impl std::fmt::Debug for StreamSubscription {
758    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
759        f.debug_struct("StreamSubscription").finish_non_exhaustive()
760    }
761}
762
763impl StreamSubscription {
764    /// The next frame, or `None` when the daemon closed the stream. A frame this crate's
765    /// [`StreamFrame`] does not model (a NEWER daemon's frame type) surfaces as
766    /// [`ClientError::Malformed`] — a forward-compatible consumer reads raw frames via
767    /// [`ControlClient::open_stream`] instead.
768    pub async fn next(&mut self) -> Result<Option<StreamFrame>, ClientError> {
769        match self.reader.next().await? {
770            Some(Inbound::Frame(v)) => serde_json::from_value(v)
771                .map(Some)
772                .map_err(|_| ClientError::Malformed("stream frame")),
773            Some(Inbound::Violation(_)) => Err(ClientError::Malformed("stream frame")),
774            None => Ok(None),
775        }
776    }
777}
778
779/// Complete the mcpmesh-local/1 hello handshake over ALREADY-CONNECTED byte halves —
780/// the transport-agnostic core of [`connect_control`], and the front door for in-process
781/// embedding (`mcpmesh-node`'s `Node::control` dials a tokio duplex through here).
782pub async fn connect_control_io(
783    reader: impl tokio::io::AsyncRead + Send + Unpin + 'static,
784    writer: impl tokio::io::AsyncWrite + Send + Unpin + 'static,
785) -> Result<ControlClient, ClientError> {
786    let mut reader = FrameReader::new(Box::new(reader) as ControlRead, MAX_FRAME_BYTES);
787    let hello: Hello = match reader.next().await? {
788        Some(Inbound::Frame(v)) => {
789            serde_json::from_value(v).map_err(|_| ClientError::Malformed("hello"))?
790        }
791        Some(Inbound::Violation(_)) => return Err(ClientError::Malformed("hello")),
792        None => return Err(ClientError::Closed("hello")),
793    };
794    if hello.api != crate::protocol::API_NAME {
795        return Err(ClientError::WrongApi {
796            got: hello.api,
797            want: crate::protocol::API_NAME,
798        });
799    }
800    Ok(ControlClient {
801        hello,
802        reader,
803        writer: Box::new(writer) as ControlWrite,
804    })
805}
806
807/// Connect + complete the hello handshake, asserting the api name is `mcpmesh-local/1`.
808pub async fn connect_control(path: &Path) -> Result<ControlClient, ClientError> {
809    let stream = connect_local(path).await?;
810    let (read_half, write_half) = split_local(stream);
811    connect_control_io(read_half, write_half).await
812}
813
814/// [`connect_control`] at the platform default endpoint ([`crate::paths::default_endpoint`]):
815/// the quickstart front door — a consumer dials the running daemon without reimplementing
816/// the platform endpoint rule. Resolution failure surfaces as [`ClientError::Io`]
817/// (`NotFound`), same as a daemon that is not running.
818pub async fn connect_control_default() -> Result<ControlClient, ClientError> {
819    connect_control(&crate::paths::default_endpoint()?).await
820}
821
822// Seam-ported (Task 6): every stub daemon binds via the platform seam
823// (`transport::bind_local` + `LocalListener::accept`) rather than a raw `UnixListener`,
824// so these exercise the platform-identical `ControlClient` on BOTH unix (UDS) and windows
825// (named pipe). Gated on `feature = "service"` (bind needs it) rather than `unix`: under
826// `cargo test --workspace` feature unification turns `service` on for this crate (cli
827// depends on local-api with features=["service"]), so the module compiles and RUNS on the
828// windows CI leg. `test_endpoint` yields a platform-appropriate unique endpoint.
829#[cfg(all(test, feature = "service"))]
830mod tests {
831    use super::*;
832    use crate::protocol::{API_NAME, API_VERSION, BackendKind, ServiceInfo, StatusResult};
833    use crate::transport::{LocalListener, bind_local, split_local};
834    use tokio::io::AsyncWriteExt;
835
836    /// A unique local endpoint for a stub daemon, platform-appropriate: a tempdir socket
837    /// path on unix, a per-process-unique `\\.\pipe\…` name on windows. Returns the
838    /// endpoint plus a guard that MUST outlive the listener (the `TempDir` on unix; unit
839    /// on windows, whose pipe namespace needs no filesystem cleanup).
840    #[cfg(unix)]
841    fn test_endpoint(tag: &str) -> (std::path::PathBuf, tempfile::TempDir) {
842        let dir = tempfile::tempdir().unwrap();
843        let path = dir.path().join(format!("{tag}.sock"));
844        (path, dir)
845    }
846    #[cfg(windows)]
847    fn test_endpoint(tag: &str) -> (std::path::PathBuf, ()) {
848        use std::sync::atomic::{AtomicU64, Ordering};
849        static SEQ: AtomicU64 = AtomicU64::new(0);
850        let n = SEQ.fetch_add(1, Ordering::Relaxed);
851        let path = std::path::PathBuf::from(format!(
852            r"\\.\pipe\mcpmesh-client-test-{}-{tag}-{n}",
853            std::process::id()
854        ));
855        (path, ())
856    }
857
858    /// A stub mcpmesh daemon: send Hello, then answer one `status` with a StatusResult.
859    async fn stub_daemon(mut listener: LocalListener) {
860        let stream = listener.accept().await.unwrap();
861        let (read_half, mut writer) = split_local(stream);
862        write_frame(
863            &mut writer,
864            &serde_json::to_value(Hello {
865                api: API_NAME.into(),
866                api_version: API_VERSION.into(),
867                api_minor: 0,
868                stack_version: "0.1.0".into(),
869            })
870            .unwrap(),
871        )
872        .await
873        .unwrap();
874        let mut reader = FrameReader::new(read_half, MAX_FRAME_BYTES);
875        let req = match reader.next().await.unwrap().unwrap() {
876            Inbound::Frame(v) => v,
877            Inbound::Violation(_) => panic!("violation"),
878        };
879        assert_eq!(req["method"], "status");
880        let result = StatusResult {
881            stack_version: "0.1.0".into(),
882            services: vec![ServiceInfo {
883                name: "kb".into(),
884                allow: vec![],
885                allow_display: vec![],
886                backend: BackendKind::Socket,
887                ephemeral: false,
888            }],
889            peers: vec![],
890            roster: None,
891            presence: vec![],
892            self_user_id: None,
893            recent_pairings: vec![],
894            reachability: vec![],
895            self_nickname: String::new(),
896            storage: None,
897            self_network: None,
898        };
899        write_frame(
900            &mut writer,
901            &serde_json::json!({ "jsonrpc": "2.0", "id": 1, "result": result }),
902        )
903        .await
904        .unwrap();
905        writer.flush().await.unwrap();
906    }
907
908    /// The transport-agnostic front door: the same hello handshake over a plain in-memory
909    /// duplex — what an embedded node's `Node::control` dials through.
910    #[tokio::test]
911    async fn connect_control_io_handshakes_over_a_duplex() {
912        let (client_io, mut server_io) = tokio::io::duplex(4096);
913        tokio::spawn(async move {
914            write_frame(
915                &mut server_io,
916                &serde_json::to_value(Hello {
917                    api: API_NAME.into(),
918                    api_version: API_VERSION.into(),
919                    api_minor: 0,
920                    stack_version: "in-proc".into(),
921                })
922                .unwrap(),
923            )
924            .await
925            .unwrap();
926        });
927        let (r, w) = tokio::io::split(client_io);
928        let client = connect_control_io(r, w).await.expect("handshake");
929        assert_eq!(client.hello().stack_version, "in-proc");
930    }
931
932    #[tokio::test]
933    async fn connect_reads_hello_asserts_api_and_requests() {
934        let (sock, _guard) = test_endpoint("status");
935        let listener = bind_local(&sock).unwrap();
936        let server = tokio::spawn(stub_daemon(listener));
937
938        let mut client = connect_control(&sock).await.unwrap();
939        assert_eq!(client.hello().api, API_NAME);
940        let result = client.request(Request::Status).await.unwrap();
941        assert_eq!(result["services"][0]["name"], "kb");
942        assert_eq!(result["services"][0]["backend"], "socket");
943        server.await.unwrap();
944    }
945
946    #[tokio::test]
947    async fn wrong_api_hello_is_rejected() {
948        let (sock, _guard) = test_endpoint("wrongapi");
949        let listener = bind_local(&sock).unwrap();
950        tokio::spawn(async move {
951            let mut listener = listener;
952            let stream = listener.accept().await.unwrap();
953            let (_r, mut w) = split_local(stream);
954            write_frame(
955                &mut w,
956                &serde_json::json!({"api":"other/1","api_version":"1.0","stack_version":"0"}),
957            )
958            .await
959            .unwrap();
960            w.flush().await.unwrap();
961        });
962        match connect_control(&sock).await {
963            Err(ClientError::WrongApi { got, want }) => {
964                assert_eq!(got, "other/1");
965                assert_eq!(want, API_NAME);
966            }
967            other => panic!("expected WrongApi, got {other:?}"),
968        }
969    }
970
971    #[tokio::test]
972    async fn blob_fetch_and_publish_deserialize_typed_results() {
973        use crate::protocol::{BlobFetchResult, BlobPublishResult};
974        let (sock, _guard) = test_endpoint("blob");
975        let listener = bind_local(&sock).unwrap();
976        let server = tokio::spawn(async move {
977            let mut listener = listener;
978            let stream = listener.accept().await.unwrap();
979            let (read_half, mut writer) = split_local(stream);
980            write_frame(
981                &mut writer,
982                &serde_json::to_value(Hello {
983                    api: API_NAME.into(),
984                    api_version: API_VERSION.into(),
985                    api_minor: 0,
986                    stack_version: "0.1.0".into(),
987                })
988                .unwrap(),
989            )
990            .await
991            .unwrap();
992            let mut reader = FrameReader::new(read_half, MAX_FRAME_BYTES);
993            // First request: blob_publish -> a ticket + hash.
994            let req = match reader.next().await.unwrap().unwrap() {
995                Inbound::Frame(v) => v,
996                Inbound::Violation(_) => panic!("violation"),
997            };
998            assert_eq!(req["method"], "blob_publish");
999            assert_eq!(req["params"]["scope"], "eng");
1000            write_frame(
1001                &mut writer,
1002                &serde_json::json!({"jsonrpc":"2.0","id":1,"result":{"ticket":"blobT","hash":"ab"}}),
1003            )
1004            .await
1005            .unwrap();
1006            // Second request: blob_fetch -> a verified hash + length.
1007            let req = match reader.next().await.unwrap().unwrap() {
1008                Inbound::Frame(v) => v,
1009                Inbound::Violation(_) => panic!("violation"),
1010            };
1011            assert_eq!(req["method"], "blob_fetch");
1012            assert_eq!(req["params"]["ticket"], "blobT");
1013            assert_eq!(req["params"]["dest_path"], "/tmp/out.bin");
1014            write_frame(
1015                &mut writer,
1016                &serde_json::json!({"jsonrpc":"2.0","id":2,"result":{"hash":"cd","bytes_len":7}}),
1017            )
1018            .await
1019            .unwrap();
1020            let _ = (
1021                BlobFetchResult {
1022                    hash: "cd".into(),
1023                    bytes_len: 7,
1024                },
1025                BlobPublishResult {
1026                    ticket: "blobT".into(),
1027                    hash: "ab".into(),
1028                },
1029            );
1030        });
1031
1032        let mut client = connect_control(&sock).await.unwrap();
1033        let pub_res = client.blob_publish("eng", "/tmp/a.bin").await.unwrap();
1034        assert_eq!(pub_res.ticket, "blobT");
1035        assert_eq!(pub_res.hash, "ab");
1036        let fetch_res = client.blob_fetch("blobT", "/tmp/out.bin").await.unwrap();
1037        assert_eq!(fetch_res.hash, "cd");
1038        assert_eq!(fetch_res.bytes_len, 7);
1039        server.await.unwrap();
1040    }
1041
1042    /// Regression (lossless rebox): a frame the server PIPELINES in the same write as
1043    /// the Hello must survive `open_session` + kb's production re-box shape
1044    /// (`FrameReader::new(Box::new(reader.into_inner()), …)`, bridge/session.rs). Against
1045    /// the old `into_inner -> R` — which unwrapped the internal `BufReader` and DROPPED
1046    /// its read-ahead — the pipelined frame vanished and this test failed (EOF instead of
1047    /// the frame). `into_inner -> BufReader<R>` carries the read-ahead across the rebox.
1048    #[tokio::test]
1049    async fn frame_pipelined_behind_hello_survives_open_session_rebox() {
1050        use tokio::io::AsyncRead;
1051
1052        let (sock, _guard) = test_endpoint("pipelined");
1053        let listener = bind_local(&sock).unwrap();
1054        let server = tokio::spawn(async move {
1055            let mut listener = listener;
1056            let stream = listener.accept().await.unwrap();
1057            let (read_half, mut writer) = split_local(stream);
1058            // ONE write carrying the Hello AND a session frame → both land in the
1059            // client's first BufReader fill (the read-ahead under test).
1060            let mut bytes = serde_json::to_vec(
1061                &serde_json::to_value(Hello {
1062                    api: API_NAME.into(),
1063                    api_version: API_VERSION.into(),
1064                    api_minor: 0,
1065                    stack_version: "0.1.0".into(),
1066                })
1067                .unwrap(),
1068            )
1069            .unwrap();
1070            bytes.push(b'\n');
1071            bytes.extend_from_slice(b"{\"jsonrpc\":\"2.0\",\"id\":42,\"result\":{}}\n");
1072            writer.write_all(&bytes).await.unwrap();
1073            writer.flush().await.unwrap();
1074            // Absorb the client's open_session frame so its write never sees EPIPE.
1075            let mut reader = FrameReader::new(read_half, MAX_FRAME_BYTES);
1076            let req = match reader.next().await.unwrap().unwrap() {
1077                Inbound::Frame(v) => v,
1078                Inbound::Violation(_) => panic!("violation"),
1079            };
1080            assert_eq!(req["method"], "open_session");
1081        });
1082
1083        let client = connect_control(&sock).await.unwrap();
1084        let (reader, _writer) = client
1085            .open_session("peer".into(), "kb".into())
1086            .await
1087            .unwrap();
1088        // kb's production shape: erase the half type behind a boxed pipe, then re-frame.
1089        let boxed: Box<dyn AsyncRead + Unpin + Send> = Box::new(reader.into_inner());
1090        let mut reframed = FrameReader::new(boxed, MAX_FRAME_BYTES);
1091        match reframed.next().await.unwrap() {
1092            Some(Inbound::Frame(v)) => assert_eq!(v["id"], 42),
1093            other => panic!("pipelined frame was lost across the rebox: {other:?}"),
1094        }
1095        server.await.unwrap();
1096    }
1097
1098    #[tokio::test]
1099    async fn blob_grant_issues_request_and_acks() {
1100        let (sock, _guard) = test_endpoint("grant");
1101        let listener = bind_local(&sock).unwrap();
1102        let server = tokio::spawn(async move {
1103            let mut listener = listener;
1104            let stream = listener.accept().await.unwrap();
1105            let (read_half, mut writer) = split_local(stream);
1106            write_frame(
1107                &mut writer,
1108                &serde_json::to_value(Hello {
1109                    api: API_NAME.into(),
1110                    api_version: API_VERSION.into(),
1111                    api_minor: 0,
1112                    stack_version: "0.1.0".into(),
1113                })
1114                .unwrap(),
1115            )
1116            .await
1117            .unwrap();
1118            let mut reader = FrameReader::new(read_half, MAX_FRAME_BYTES);
1119            let req = match reader.next().await.unwrap().unwrap() {
1120                Inbound::Frame(v) => v,
1121                Inbound::Violation(_) => panic!("violation"),
1122            };
1123            assert_eq!(req["method"], "blob_grant");
1124            assert_eq!(req["params"]["scope"], "kb-sync");
1125            assert_eq!(req["params"]["principal"], "alice");
1126            write_frame(
1127                &mut writer,
1128                &serde_json::json!({"jsonrpc":"2.0","id":1,"result":{"ok":true}}),
1129            )
1130            .await
1131            .unwrap();
1132        });
1133        let mut client = connect_control(&sock).await.unwrap();
1134        client.blob_grant("kb-sync", "alice").await.unwrap();
1135        server.await.unwrap();
1136    }
1137
1138    /// The typed `status()` helper pairs `Request::Status` with `StatusResult` — the caller gets
1139    /// the struct, not a `Value` to hand-deserialize (and a malformed result surfaces as
1140    /// `ClientError::Malformed`, never a silently-wrong type).
1141    #[tokio::test]
1142    async fn typed_status_helper_deserializes_the_result() {
1143        let (sock, _guard) = test_endpoint("typedstatus");
1144        let listener = bind_local(&sock).unwrap();
1145        let server = tokio::spawn(stub_daemon(listener));
1146
1147        let mut client = connect_control(&sock).await.unwrap();
1148        let status = client.status().await.unwrap();
1149        assert_eq!(status.stack_version, "0.1.0");
1150        assert_eq!(status.services[0].name, "kb");
1151        assert_eq!(status.services[0].backend, BackendKind::Socket);
1152        assert!(status.peers.is_empty());
1153        server.await.unwrap();
1154    }
1155
1156    /// The ack-shaped typed helpers issue the right wire method and discard the `{}` ack; a
1157    /// JSON-RPC error frame surfaces as `ClientError::Api`.
1158    #[tokio::test]
1159    async fn typed_ack_helpers_issue_requests_and_surface_api_errors() {
1160        let (sock, _guard) = test_endpoint("typedack");
1161        let listener = bind_local(&sock).unwrap();
1162        let server = tokio::spawn(async move {
1163            let mut listener = listener;
1164            let stream = listener.accept().await.unwrap();
1165            let (read_half, mut writer) = split_local(stream);
1166            write_frame(
1167                &mut writer,
1168                &serde_json::to_value(Hello {
1169                    api: API_NAME.into(),
1170                    api_version: API_VERSION.into(),
1171                    api_minor: 0,
1172                    stack_version: "0.1.0".into(),
1173                })
1174                .unwrap(),
1175            )
1176            .await
1177            .unwrap();
1178            let mut reader = FrameReader::new(read_half, MAX_FRAME_BYTES);
1179            // peer_remove → ack.
1180            let req = match reader.next().await.unwrap().unwrap() {
1181                Inbound::Frame(v) => v,
1182                Inbound::Violation(_) => panic!("violation"),
1183            };
1184            assert_eq!(req["method"], "peer_remove");
1185            assert_eq!(req["params"]["nickname"], "bob");
1186            write_frame(
1187                &mut writer,
1188                &serde_json::json!({"jsonrpc":"2.0","id":1,"result":{}}),
1189            )
1190            .await
1191            .unwrap();
1192            // peer_rename → an error frame (collision refusal).
1193            let req = match reader.next().await.unwrap().unwrap() {
1194                Inbound::Frame(v) => v,
1195                Inbound::Violation(_) => panic!("violation"),
1196            };
1197            assert_eq!(req["method"], "peer_rename");
1198            assert_eq!(req["params"]["to"], "Bobby");
1199            write_frame(
1200                &mut writer,
1201                &serde_json::json!({"jsonrpc":"2.0","id":2,"error":{"code":-32000,"message":"taken"}}),
1202            )
1203            .await
1204            .unwrap();
1205        });
1206
1207        let mut client = connect_control(&sock).await.unwrap();
1208        client.peer_remove("bob").await.unwrap();
1209        match client.peer_rename(None, Some("bob".into()), "Bobby").await {
1210            Err(ClientError::Api(e)) => assert_eq!(e["message"], "taken"),
1211            other => panic!("expected Api error, got {other:?}"),
1212        }
1213        server.await.unwrap();
1214    }
1215
1216    /// The typed `subscribe()` upgrade yields `StreamFrame`s — snapshot, event, lagged — then
1217    /// `None` when the daemon side closes.
1218    #[tokio::test]
1219    async fn typed_subscribe_yields_frames_then_end() {
1220        use crate::protocol::{ActiveSession, AuditRecord, PeerReachability};
1221
1222        let (sock, _guard) = test_endpoint("subscribe");
1223        let listener = bind_local(&sock).unwrap();
1224        let server = tokio::spawn(async move {
1225            let mut listener = listener;
1226            let stream = listener.accept().await.unwrap();
1227            let (read_half, mut writer) = split_local(stream);
1228            write_frame(
1229                &mut writer,
1230                &serde_json::to_value(Hello {
1231                    api: API_NAME.into(),
1232                    api_version: API_VERSION.into(),
1233                    api_minor: 0,
1234                    stack_version: "0.1.0".into(),
1235                })
1236                .unwrap(),
1237            )
1238            .await
1239            .unwrap();
1240            let mut reader = FrameReader::new(read_half, MAX_FRAME_BYTES);
1241            let req = match reader.next().await.unwrap().unwrap() {
1242                Inbound::Frame(v) => v,
1243                Inbound::Violation(_) => panic!("violation"),
1244            };
1245            assert_eq!(req["method"], "subscribe");
1246            for frame in [
1247                StreamFrame::Snapshot {
1248                    self_network: None,
1249                    active_sessions: vec![ActiveSession {
1250                        peer: "bob".into(),
1251                        service: "notes".into(),
1252                        opened_at: 7,
1253                        principal: Some("eid:bob".into()),
1254                    }],
1255                    reachability: vec![PeerReachability {
1256                        name: "bob".into(),
1257                        reachable: true,
1258                        rtt_ms: Some(42),
1259                        age_secs: Some(3),
1260                        meta: String::new(),
1261                        principal: None,
1262                        path: Default::default(),
1263                    }],
1264                },
1265                StreamFrame::Event {
1266                    record: Box::new(AuditRecord::session_open(
1267                        "2026-07-03T14:02:11.480Z".into(),
1268                        Some("bob".into()),
1269                        "notes".into(),
1270                        None,
1271                    )),
1272                },
1273                StreamFrame::Lagged { dropped: 12 },
1274            ] {
1275                write_frame(&mut writer, &serde_json::to_value(&frame).unwrap())
1276                    .await
1277                    .unwrap();
1278            }
1279            writer.flush().await.unwrap();
1280            // Drop the connection: the client must see the stream END (Ok(None)), not an error.
1281        });
1282
1283        let client = connect_control(&sock).await.unwrap();
1284        let mut sub = client.subscribe().await.unwrap();
1285        match sub.next().await.unwrap().unwrap() {
1286            StreamFrame::Snapshot {
1287                active_sessions,
1288                reachability,
1289                ..
1290            } => {
1291                assert_eq!(active_sessions[0].peer, "bob");
1292                assert_eq!(reachability[0].rtt_ms, Some(42));
1293            }
1294            other => panic!("expected the snapshot first, got {other:?}"),
1295        }
1296        match sub.next().await.unwrap().unwrap() {
1297            StreamFrame::Event { record } => {
1298                assert_eq!(record.peer.as_deref(), Some("bob"));
1299                assert_eq!(record.service.as_deref(), Some("notes"));
1300            }
1301            other => panic!("expected the event, got {other:?}"),
1302        }
1303        assert_eq!(
1304            sub.next().await.unwrap(),
1305            Some(StreamFrame::Lagged { dropped: 12 })
1306        );
1307        assert_eq!(sub.next().await.unwrap(), None, "clean end of stream");
1308        server.await.unwrap();
1309    }
1310}