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 /// EXPORT this node's user key as a RECOVERY PHRASE (#85 ask 2).
470 ///
471 /// **The phrase is the private key**, in a form a person can write down. Anyone who reads it
472 /// can present this identity. Show it once, to the person who owns it, and do not persist it
473 /// anywhere you would not persist the key file. It is deliberately not logged or audited by the
474 /// daemon; this response is the only place it exists.
475 ///
476 /// `user_id` is safe to display and record — compare it after an import to confirm the right
477 /// identity came back. `api_minor >= 48`.
478 pub async fn user_key_export(
479 &mut self,
480 ) -> Result<crate::protocol::UserKeyExportResult, ClientError> {
481 self.request_typed(Request::UserKeyExport, "user_key_export result")
482 .await
483 }
484
485 /// IMPORT a user key from a recovery phrase (#85 ask 2), so a person's `b64u:` survives the
486 /// hardware.
487 ///
488 /// Refuses to overwrite an existing key unless `replace` is set: importing over a live key
489 /// discards the identity this node presents, irreversibly without that key's own phrase.
490 ///
491 /// **Check the returned `user_id` against the one you are recovering.** The phrase's checksum
492 /// catches most transcription errors, but the `user_id` is the definitive answer, and the only
493 /// thing that distinguishes "restored the wrong key" from "my peers have not seen me yet".
494 ///
495 /// It does NOT get this device admitted by anyone: peers authorize per DEVICE, and a restored
496 /// user key does not put this endpoint in anybody's allowlist. That is #85 ask 3, not shipped.
497 /// `api_minor >= 48`.
498 pub async fn user_key_import(
499 &mut self,
500 recovery_phrase: &str,
501 replace: bool,
502 ) -> Result<crate::protocol::UserKeyImportResult, ClientError> {
503 self.request_typed(
504 Request::UserKeyImport(crate::protocol::UserKeyImportParams {
505 recovery_phrase: recovery_phrase.to_string(),
506 replace,
507 }),
508 "user_key_import result",
509 )
510 .await
511 }
512
513 /// INSPECT a join code without approving it (#66): what it claims, and the fingerprint that
514 /// decides whether to believe it. Read-only — nothing is signed or installed.
515 ///
516 /// **Call this before [`org_approve`](Self::org_approve), show
517 /// `join_code_fingerprint`, and have the operator confirm it out-of-band.** Nothing in a join
518 /// code binds it to a person; a substituted one carries a different key and diverges here. The
519 /// fingerprint on the approval RESULT is the same words, but by then the member is in the
520 /// signed roster — too late to decline.
521 ///
522 /// The claims (`display_name`, `requested_user_id`, `device_label`) are chosen by the sender.
523 /// Render them; do not trust them. A forged binding is refused rather than described.
524 /// `api_minor >= 46`.
525 pub async fn org_join_code(
526 &mut self,
527 join_code: &str,
528 ) -> Result<crate::protocol::OrgJoinCodeResult, ClientError> {
529 self.request_typed(
530 Request::OrgJoinCode(crate::protocol::OrgJoinCodeParams {
531 join_code: join_code.to_string(),
532 }),
533 "org_join_code result",
534 )
535 .await
536 }
537
538 /// REVOKE from the roster (#66) — and sever the cut devices' live sessions, immediately.
539 ///
540 /// Three readings, and picking the wrong one is destructive, so the result reports which
541 /// `mode` was applied: `"<user_id>/<label>"` cuts ONE device; a bare `user_id` removes the
542 /// person and revokes ALL their devices; `user_key = true` is a key ROTATION — the person is
543 /// removed but their devices stay un-revoked so the same hardware re-enrolls under a fresh
544 /// user key. `api_minor >= 46`.
545 pub async fn org_revoke(
546 &mut self,
547 target: &str,
548 user_key: bool,
549 ) -> Result<crate::protocol::OrgRevokeResult, ClientError> {
550 self.request_typed(
551 Request::OrgRevoke(crate::protocol::OrgRevokeParams {
552 target: target.to_string(),
553 user_key,
554 }),
555 "org_revoke result",
556 )
557 .await
558 }
559
560 /// Pin the org root on a JOINER (no roster yet). `user_key` is a LOCAL path — the key never
561 /// crosses the API. Returns the pinned org id.
562 pub async fn org_join(
563 &mut self,
564 org_id: &str,
565 org_root_pk: &str,
566 user_id: &str,
567 user_key: &str,
568 ) -> Result<OrgJoinResult, ClientError> {
569 self.request_typed(
570 Request::OrgJoin(OrgJoinParams {
571 org_id: org_id.to_string(),
572 org_root_pk: org_root_pk.to_string(),
573 user_id: user_id.to_string(),
574 user_key: user_key.to_string(),
575 }),
576 "org_join result",
577 )
578 .await
579 }
580
581 /// Pin the HTTPS roster URL (`[roster].url`) in the daemon's config. The daemon acks; the
582 /// ack body is discarded.
583 pub async fn set_roster_url(&mut self, url: &str) -> Result<(), ClientError> {
584 self.request_ack(Request::SetRosterUrl(SetRosterUrlParams {
585 url: url.to_string(),
586 }))
587 .await
588 }
589
590 /// Discover which services a paired `peer` (a nickname, `eid:`, or `b64u:`) CURRENTLY grants
591 /// the caller (#52) — dials the peer and returns the service names its allow admits for the
592 /// caller's principal (only your own admitted services, never the peer's full registry).
593 pub async fn peer_services(&mut self, peer: &str) -> Result<Vec<String>, ClientError> {
594 self.request_typed::<PeerServicesResult>(
595 Request::PeerServices(PeerServicesParams {
596 peer: peer.to_string(),
597 }),
598 "peer_services",
599 )
600 .await
601 .map(|r| r.services)
602 }
603
604 /// Remove a service registration (#50) — the deregistration mirror of `register_service`.
605 /// Removes the whole entry (allow included) + any ephemeral registration of the name, then
606 /// hot-reloads. Idempotent: an unknown name is a clean no-op.
607 pub async fn unregister_service(&mut self, name: &str) -> Result<(), ClientError> {
608 self.request_ack(Request::UnregisterService(UnregisterServiceParams {
609 name: name.to_string(),
610 }))
611 .await
612 }
613
614 /// Grant a stable `principal` (`b64u:`/`eid:`) access to `service` WITHOUT (re)pairing (#44)
615 /// — the per-peer "sharing on" toggle. Idempotent; an unknown service is a clean no-op.
616 pub async fn service_allow_grant(
617 &mut self,
618 service: &str,
619 principal: &str,
620 ) -> Result<(), ClientError> {
621 self.request_ack(Request::ServiceAllowGrant(ServiceAllowParams {
622 service: service.to_string(),
623 principal: principal.to_string(),
624 }))
625 .await
626 }
627
628 /// Revoke a stable `principal` from `service`'s allow WITHOUT unpairing (#44) — the
629 /// "sharing off" toggle. The peer's identity row is untouched; it just cannot open NEW
630 /// sessions (in-flight ones run to completion). Idempotent.
631 pub async fn service_allow_revoke(
632 &mut self,
633 service: &str,
634 principal: &str,
635 ) -> Result<(), ClientError> {
636 self.request_ack(Request::ServiceAllowRevoke(ServiceAllowParams {
637 service: service.to_string(),
638 principal: principal.to_string(),
639 }))
640 .await
641 }
642
643 /// Set this node's opaque app-metadata blob (#39, roster mode): ≤256 bytes, folded
644 /// signed into each presence heartbeat so paired peers read it in `status` presence —
645 /// no per-peer session. `""` clears it; in-memory (re-set on startup).
646 pub async fn set_app_metadata(&mut self, metadata: &str) -> Result<(), ClientError> {
647 self.request_ack(Request::SetAppMetadata(SetAppMetadataParams {
648 metadata: metadata.to_string(),
649 }))
650 .await
651 }
652
653 /// Set this node's CUSTOM relay set LIVE (#53). `relay_urls` is the desired set (each must
654 /// parse as an iroh `RelayUrl`; empty is rejected). When the node is already in
655 /// `relay_mode = "custom"`, the daemon diffs against the running endpoint and applies the
656 /// delta live (iroh `insert_relay`/`remove_relay`) — no restart, no dropped sessions — then
657 /// persists `[network]`. When the node is currently `default`/`disabled`, the config is
658 /// persisted but the live mode transition isn't possible: the returned
659 /// [`SetRelaysResult::restart_required`] is `true`. Idempotent (an unchanged set → `changed:
660 /// false`, no writes).
661 pub async fn set_relays(
662 &mut self,
663 relay_urls: &[String],
664 ) -> Result<SetRelaysResult, ClientError> {
665 self.request_typed::<SetRelaysResult>(
666 Request::SetRelays(SetRelaysParams {
667 relay_urls: relay_urls.to_vec(),
668 }),
669 "set_relays",
670 )
671 .await
672 }
673
674 /// Rename this node LIVE (#37): the daemon validates + persists `[identity].nickname`
675 /// under its own config lock and updates the name future invites present — no restart.
676 /// Peers keep their stored pairing-time nickname until a re-invite (display-only).
677 pub async fn set_nickname(&mut self, nickname: &str) -> Result<(), ClientError> {
678 self.request_ack(Request::SetNickname(SetNicknameParams {
679 nickname: nickname.to_string(),
680 }))
681 .await
682 }
683
684 /// Summarize the daemon's LOCAL audit log into per-peer / per-service session counts
685 /// (local-only — nothing is transmitted).
686 pub async fn audit_summary(&mut self) -> Result<AuditSummaryResult, ClientError> {
687 self.request_typed(Request::AuditSummary, "audit_summary result")
688 .await
689 }
690
691 /// Publish a local file into `scope`; return the minted `mcpmesh/blob/1` ticket + hash.
692 pub async fn blob_publish(
693 &mut self,
694 scope: &str,
695 path: &str,
696 ) -> Result<BlobPublishResult, ClientError> {
697 self.request_typed(
698 Request::BlobPublish(BlobPublishParams {
699 scope: scope.to_string(),
700 path: path.to_string(),
701 }),
702 "blob_publish result",
703 )
704 .await
705 }
706
707 /// List the daemon's blob scopes (name → hashes + grants + withdrawn).
708 ///
709 /// A DEFAULT LIMIT applies (#84b) — check `truncated` and page with
710 /// [`blob_list_paged`](Self::blob_list_paged) rather than assuming you saw everything.
711 pub async fn blob_list(&mut self) -> Result<BlobScopeList, ClientError> {
712 self.blob_list_paged(Default::default()).await
713 }
714
715 /// List blob scopes with filters + paging (#84b, `api_minor >= 20`).
716 pub async fn blob_list_paged(
717 &mut self,
718 params: crate::BlobListParams,
719 ) -> Result<BlobScopeList, ClientError> {
720 self.request_typed(Request::BlobList(params), "blob_list result")
721 .await
722 }
723
724 /// Fetch a `mcpmesh/blob/1` ticket THROUGH the daemon (BLAKE3-verified), export to
725 /// `dest_path`; return the verified hash + byte length.
726 pub async fn blob_fetch(
727 &mut self,
728 ticket: &str,
729 dest_path: &str,
730 ) -> Result<BlobFetchResult, ClientError> {
731 self.blob_fetch_from(ticket, dest_path, Vec::new()).await
732 }
733
734 /// [`blob_fetch`](Self::blob_fetch) with ADDITIONAL sources to try when the ticket's publisher
735 /// does not answer (#83).
736 ///
737 /// Content addressing makes every recipient a potential source; a single-address ticket made
738 /// that unusable, so a file shared with a room became unfetchable the moment the sender closed
739 /// their laptop — even though others in the room already held the identical verified bytes.
740 ///
741 /// `from` takes stable principals (`eid:`, `b64u:`) or paired nicknames — the same vocabulary
742 /// `open_session` takes, and naming a PERSON offers every device of theirs. They are tried in
743 /// order, **after** the publisher, so a live publisher costs nothing and an offline one costs
744 /// one dial timeout.
745 ///
746 /// **The bytes are BLAKE3-verified against the ticket's hash whoever serves them**, so an
747 /// alternate cannot substitute content. It can refuse: an alternate serves only hashes it has
748 /// republished into a scope that grants you (see `blob_republish`), and an ungranted one
749 /// answers a permission error and the fetch moves on. Every failure mode falls through, not
750 /// only an unreachable dial — a refusal, a missing hash, a reset, and a stalled transfer all
751 /// move to the next source. `api_minor >= 47`.
752 pub async fn blob_fetch_from(
753 &mut self,
754 ticket: &str,
755 dest_path: &str,
756 from: Vec<String>,
757 ) -> Result<BlobFetchResult, ClientError> {
758 self.request_typed(
759 Request::BlobFetch(BlobFetchParams {
760 ticket: ticket.to_string(),
761 dest_path: dest_path.to_string(),
762 from,
763 }),
764 "blob_fetch result",
765 )
766 .await
767 }
768
769 /// Stop every in-flight [`blob_fetch`](Self::blob_fetch) of `hash` (#172).
770 ///
771 /// **Send this on a DIFFERENT connection than the fetch it cancels.** This client is one
772 /// request at a time — `&mut self` is borrowed until the fetch answers — so a cancel issued on
773 /// the same client can only run after the thing it would cancel is already over. The cancelled
774 /// fetch answers [`ERR_CANCELLED`](crate::ERR_CANCELLED) on its own connection.
775 ///
776 /// `cancelled: false` means nothing was fetching that blob here. That is the honest answer to a
777 /// cancel that raced a fetch to completion, not an error.
778 ///
779 /// Needs `api_minor >= 44`; below it the method is unknown.
780 pub async fn blob_fetch_cancel(
781 &mut self,
782 hash: &str,
783 ) -> Result<BlobFetchCancelResult, ClientError> {
784 self.request_typed(
785 Request::BlobFetchCancel(BlobFetchCancelParams {
786 hash: hash.to_string(),
787 }),
788 "blob_fetch_cancel result",
789 )
790 .await
791 }
792
793 /// Grant a scope to a principal — any flat-namespace entry: a group name, a user_id,
794 /// or a nickname (the shared `principal_set` expansion).
795 /// The daemon acks; the ack body is discarded (a JSON-RPC error surfaces as
796 /// `ClientError::Api`). Granting a scope to your own user_id reaches ALL of that
797 /// person's devices.
798 pub async fn blob_grant(&mut self, scope: &str, principal: &str) -> Result<(), ClientError> {
799 self.request_ack(Request::BlobGrant(BlobGrantParams {
800 scope: scope.to_string(),
801 principal: principal.to_string(),
802 }))
803 .await
804 }
805
806 /// The TYPED `subscribe` upgrade: send [`Request::Subscribe`] (after which the connection
807 /// stops being request/response — see [`open_stream`](Self::open_stream)) and return a
808 /// [`StreamSubscription`] yielding [`StreamFrame`]s. For raw frames (e.g. to tolerate frame
809 /// types newer than this crate), use `open_stream("subscribe")` instead.
810 pub async fn subscribe(self) -> Result<StreamSubscription, ClientError> {
811 let (reader, writer) = self.open_stream("subscribe").await?;
812 Ok(StreamSubscription {
813 reader,
814 _writer: writer,
815 })
816 }
817}
818
819/// A live [`Request::Subscribe`] stream yielding typed [`StreamFrame`]s (snapshot, then
820/// events/lagged notices) until the daemon side closes. Holds the connection's write half for its
821/// lifetime — a subscriber only reads, but dropping the writer would half-close the socket. Drop
822/// the subscription to disconnect (there is no request channel back).
823pub struct StreamSubscription {
824 reader: FrameReader<ControlRead>,
825 _writer: ControlWrite,
826}
827
828/// Hand-rolled like [`ControlClient`]'s: the boxed transport halves are not `Debug`.
829impl std::fmt::Debug for StreamSubscription {
830 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
831 f.debug_struct("StreamSubscription").finish_non_exhaustive()
832 }
833}
834
835impl StreamSubscription {
836 /// The next frame, or `None` when the daemon closed the stream. A frame this crate's
837 /// [`StreamFrame`] does not model (a NEWER daemon's frame type) surfaces as
838 /// [`ClientError::Malformed`] — a forward-compatible consumer reads raw frames via
839 /// [`ControlClient::open_stream`] instead.
840 pub async fn next(&mut self) -> Result<Option<StreamFrame>, ClientError> {
841 match self.reader.next().await? {
842 Some(Inbound::Frame(v)) => serde_json::from_value(v)
843 .map(Some)
844 .map_err(|_| ClientError::Malformed("stream frame")),
845 Some(Inbound::Violation(_)) => Err(ClientError::Malformed("stream frame")),
846 None => Ok(None),
847 }
848 }
849}
850
851/// Complete the mcpmesh-local/1 hello handshake over ALREADY-CONNECTED byte halves —
852/// the transport-agnostic core of [`connect_control`], and the front door for in-process
853/// embedding (`mcpmesh-node`'s `Node::control` dials a tokio duplex through here).
854pub async fn connect_control_io(
855 reader: impl tokio::io::AsyncRead + Send + Unpin + 'static,
856 writer: impl tokio::io::AsyncWrite + Send + Unpin + 'static,
857) -> Result<ControlClient, ClientError> {
858 let mut reader = FrameReader::new(Box::new(reader) as ControlRead, MAX_FRAME_BYTES);
859 let hello: Hello = match reader.next().await? {
860 Some(Inbound::Frame(v)) => {
861 serde_json::from_value(v).map_err(|_| ClientError::Malformed("hello"))?
862 }
863 Some(Inbound::Violation(_)) => return Err(ClientError::Malformed("hello")),
864 None => return Err(ClientError::Closed("hello")),
865 };
866 if hello.api != crate::protocol::API_NAME {
867 return Err(ClientError::WrongApi {
868 got: hello.api,
869 want: crate::protocol::API_NAME,
870 });
871 }
872 Ok(ControlClient {
873 hello,
874 reader,
875 writer: Box::new(writer) as ControlWrite,
876 })
877}
878
879/// Connect + complete the hello handshake, asserting the api name is `mcpmesh-local/1`.
880pub async fn connect_control(path: &Path) -> Result<ControlClient, ClientError> {
881 let stream = connect_local(path).await?;
882 let (read_half, write_half) = split_local(stream);
883 connect_control_io(read_half, write_half).await
884}
885
886/// [`connect_control`] at the platform default endpoint ([`crate::paths::default_endpoint`]):
887/// the quickstart front door — a consumer dials the running daemon without reimplementing
888/// the platform endpoint rule. Resolution failure surfaces as [`ClientError::Io`]
889/// (`NotFound`), same as a daemon that is not running.
890pub async fn connect_control_default() -> Result<ControlClient, ClientError> {
891 connect_control(&crate::paths::default_endpoint()?).await
892}
893
894// Seam-ported (Task 6): every stub daemon binds via the platform seam
895// (`transport::bind_local` + `LocalListener::accept`) rather than a raw `UnixListener`,
896// so these exercise the platform-identical `ControlClient` on BOTH unix (UDS) and windows
897// (named pipe). Gated on `feature = "service"` (bind needs it) rather than `unix`: under
898// `cargo test --workspace` feature unification turns `service` on for this crate (cli
899// depends on local-api with features=["service"]), so the module compiles and RUNS on the
900// windows CI leg. `test_endpoint` yields a platform-appropriate unique endpoint.
901#[cfg(all(test, feature = "service"))]
902mod tests {
903 use super::*;
904 use crate::protocol::{API_NAME, API_VERSION, BackendKind, ServiceInfo, StatusResult};
905 use crate::transport::{LocalListener, bind_local, split_local};
906 use tokio::io::AsyncWriteExt;
907
908 /// A unique local endpoint for a stub daemon, platform-appropriate: a tempdir socket
909 /// path on unix, a per-process-unique `\\.\pipe\…` name on windows. Returns the
910 /// endpoint plus a guard that MUST outlive the listener (the `TempDir` on unix; unit
911 /// on windows, whose pipe namespace needs no filesystem cleanup).
912 #[cfg(unix)]
913 fn test_endpoint(tag: &str) -> (std::path::PathBuf, tempfile::TempDir) {
914 let dir = tempfile::tempdir().unwrap();
915 let path = dir.path().join(format!("{tag}.sock"));
916 (path, dir)
917 }
918 #[cfg(windows)]
919 fn test_endpoint(tag: &str) -> (std::path::PathBuf, ()) {
920 use std::sync::atomic::{AtomicU64, Ordering};
921 static SEQ: AtomicU64 = AtomicU64::new(0);
922 let n = SEQ.fetch_add(1, Ordering::Relaxed);
923 let path = std::path::PathBuf::from(format!(
924 r"\\.\pipe\mcpmesh-client-test-{}-{tag}-{n}",
925 std::process::id()
926 ));
927 (path, ())
928 }
929
930 /// A stub mcpmesh daemon: send Hello, then answer one `status` with a StatusResult.
931 async fn stub_daemon(mut listener: LocalListener) {
932 let stream = listener.accept().await.unwrap();
933 let (read_half, mut writer) = split_local(stream);
934 write_frame(
935 &mut writer,
936 &serde_json::to_value(Hello {
937 api: API_NAME.into(),
938 api_version: API_VERSION.into(),
939 api_minor: 0,
940 stack_version: "0.1.0".into(),
941 })
942 .unwrap(),
943 )
944 .await
945 .unwrap();
946 let mut reader = FrameReader::new(read_half, MAX_FRAME_BYTES);
947 let req = match reader.next().await.unwrap().unwrap() {
948 Inbound::Frame(v) => v,
949 Inbound::Violation(_) => panic!("violation"),
950 };
951 assert_eq!(req["method"], "status");
952 let result = StatusResult {
953 stack_version: "0.1.0".into(),
954 services: vec![ServiceInfo {
955 name: "kb".into(),
956 allow: vec![],
957 allow_display: vec![],
958 backend: BackendKind::Socket,
959 ephemeral: false,
960 }],
961 peers: vec![],
962 roster: None,
963 presence: vec![],
964 self_user_id: None,
965 recent_pairings: vec![],
966 reachability: vec![],
967 self_nickname: String::new(),
968 storage: None,
969 self_network: None,
970 };
971 write_frame(
972 &mut writer,
973 &serde_json::json!({ "jsonrpc": "2.0", "id": 1, "result": result }),
974 )
975 .await
976 .unwrap();
977 writer.flush().await.unwrap();
978 }
979
980 /// The transport-agnostic front door: the same hello handshake over a plain in-memory
981 /// duplex — what an embedded node's `Node::control` dials through.
982 #[tokio::test]
983 async fn connect_control_io_handshakes_over_a_duplex() {
984 let (client_io, mut server_io) = tokio::io::duplex(4096);
985 tokio::spawn(async move {
986 write_frame(
987 &mut server_io,
988 &serde_json::to_value(Hello {
989 api: API_NAME.into(),
990 api_version: API_VERSION.into(),
991 api_minor: 0,
992 stack_version: "in-proc".into(),
993 })
994 .unwrap(),
995 )
996 .await
997 .unwrap();
998 });
999 let (r, w) = tokio::io::split(client_io);
1000 let client = connect_control_io(r, w).await.expect("handshake");
1001 assert_eq!(client.hello().stack_version, "in-proc");
1002 }
1003
1004 #[tokio::test]
1005 async fn connect_reads_hello_asserts_api_and_requests() {
1006 let (sock, _guard) = test_endpoint("status");
1007 let listener = bind_local(&sock).unwrap();
1008 let server = tokio::spawn(stub_daemon(listener));
1009
1010 let mut client = connect_control(&sock).await.unwrap();
1011 assert_eq!(client.hello().api, API_NAME);
1012 let result = client.request(Request::Status).await.unwrap();
1013 assert_eq!(result["services"][0]["name"], "kb");
1014 assert_eq!(result["services"][0]["backend"], "socket");
1015 server.await.unwrap();
1016 }
1017
1018 #[tokio::test]
1019 async fn wrong_api_hello_is_rejected() {
1020 let (sock, _guard) = test_endpoint("wrongapi");
1021 let listener = bind_local(&sock).unwrap();
1022 tokio::spawn(async move {
1023 let mut listener = listener;
1024 let stream = listener.accept().await.unwrap();
1025 let (_r, mut w) = split_local(stream);
1026 write_frame(
1027 &mut w,
1028 &serde_json::json!({"api":"other/1","api_version":"1.0","stack_version":"0"}),
1029 )
1030 .await
1031 .unwrap();
1032 w.flush().await.unwrap();
1033 });
1034 match connect_control(&sock).await {
1035 Err(ClientError::WrongApi { got, want }) => {
1036 assert_eq!(got, "other/1");
1037 assert_eq!(want, API_NAME);
1038 }
1039 other => panic!("expected WrongApi, got {other:?}"),
1040 }
1041 }
1042
1043 #[tokio::test]
1044 async fn blob_fetch_and_publish_deserialize_typed_results() {
1045 use crate::protocol::{BlobFetchResult, BlobPublishResult};
1046 let (sock, _guard) = test_endpoint("blob");
1047 let listener = bind_local(&sock).unwrap();
1048 let server = tokio::spawn(async move {
1049 let mut listener = listener;
1050 let stream = listener.accept().await.unwrap();
1051 let (read_half, mut writer) = split_local(stream);
1052 write_frame(
1053 &mut writer,
1054 &serde_json::to_value(Hello {
1055 api: API_NAME.into(),
1056 api_version: API_VERSION.into(),
1057 api_minor: 0,
1058 stack_version: "0.1.0".into(),
1059 })
1060 .unwrap(),
1061 )
1062 .await
1063 .unwrap();
1064 let mut reader = FrameReader::new(read_half, MAX_FRAME_BYTES);
1065 // First request: blob_publish -> a ticket + hash.
1066 let req = match reader.next().await.unwrap().unwrap() {
1067 Inbound::Frame(v) => v,
1068 Inbound::Violation(_) => panic!("violation"),
1069 };
1070 assert_eq!(req["method"], "blob_publish");
1071 assert_eq!(req["params"]["scope"], "eng");
1072 write_frame(
1073 &mut writer,
1074 &serde_json::json!({"jsonrpc":"2.0","id":1,"result":{"ticket":"blobT","hash":"ab"}}),
1075 )
1076 .await
1077 .unwrap();
1078 // Second request: blob_fetch -> a verified hash + length.
1079 let req = match reader.next().await.unwrap().unwrap() {
1080 Inbound::Frame(v) => v,
1081 Inbound::Violation(_) => panic!("violation"),
1082 };
1083 assert_eq!(req["method"], "blob_fetch");
1084 assert_eq!(req["params"]["ticket"], "blobT");
1085 assert_eq!(req["params"]["dest_path"], "/tmp/out.bin");
1086 write_frame(
1087 &mut writer,
1088 &serde_json::json!({"jsonrpc":"2.0","id":2,"result":{"hash":"cd","bytes_len":7}}),
1089 )
1090 .await
1091 .unwrap();
1092 let _ = (
1093 BlobFetchResult {
1094 hash: "cd".into(),
1095 bytes_len: 7,
1096 },
1097 BlobPublishResult {
1098 ticket: "blobT".into(),
1099 hash: "ab".into(),
1100 },
1101 );
1102 });
1103
1104 let mut client = connect_control(&sock).await.unwrap();
1105 let pub_res = client.blob_publish("eng", "/tmp/a.bin").await.unwrap();
1106 assert_eq!(pub_res.ticket, "blobT");
1107 assert_eq!(pub_res.hash, "ab");
1108 let fetch_res = client.blob_fetch("blobT", "/tmp/out.bin").await.unwrap();
1109 assert_eq!(fetch_res.hash, "cd");
1110 assert_eq!(fetch_res.bytes_len, 7);
1111 server.await.unwrap();
1112 }
1113
1114 /// Regression (lossless rebox): a frame the server PIPELINES in the same write as
1115 /// the Hello must survive `open_session` + kb's production re-box shape
1116 /// (`FrameReader::new(Box::new(reader.into_inner()), …)`, bridge/session.rs). Against
1117 /// the old `into_inner -> R` — which unwrapped the internal `BufReader` and DROPPED
1118 /// its read-ahead — the pipelined frame vanished and this test failed (EOF instead of
1119 /// the frame). `into_inner -> BufReader<R>` carries the read-ahead across the rebox.
1120 #[tokio::test]
1121 async fn frame_pipelined_behind_hello_survives_open_session_rebox() {
1122 use tokio::io::AsyncRead;
1123
1124 let (sock, _guard) = test_endpoint("pipelined");
1125 let listener = bind_local(&sock).unwrap();
1126 let server = tokio::spawn(async move {
1127 let mut listener = listener;
1128 let stream = listener.accept().await.unwrap();
1129 let (read_half, mut writer) = split_local(stream);
1130 // ONE write carrying the Hello AND a session frame → both land in the
1131 // client's first BufReader fill (the read-ahead under test).
1132 let mut bytes = serde_json::to_vec(
1133 &serde_json::to_value(Hello {
1134 api: API_NAME.into(),
1135 api_version: API_VERSION.into(),
1136 api_minor: 0,
1137 stack_version: "0.1.0".into(),
1138 })
1139 .unwrap(),
1140 )
1141 .unwrap();
1142 bytes.push(b'\n');
1143 bytes.extend_from_slice(b"{\"jsonrpc\":\"2.0\",\"id\":42,\"result\":{}}\n");
1144 writer.write_all(&bytes).await.unwrap();
1145 writer.flush().await.unwrap();
1146 // Absorb the client's open_session frame so its write never sees EPIPE.
1147 let mut reader = FrameReader::new(read_half, MAX_FRAME_BYTES);
1148 let req = match reader.next().await.unwrap().unwrap() {
1149 Inbound::Frame(v) => v,
1150 Inbound::Violation(_) => panic!("violation"),
1151 };
1152 assert_eq!(req["method"], "open_session");
1153 });
1154
1155 let client = connect_control(&sock).await.unwrap();
1156 let (reader, _writer) = client
1157 .open_session("peer".into(), "kb".into())
1158 .await
1159 .unwrap();
1160 // kb's production shape: erase the half type behind a boxed pipe, then re-frame.
1161 let boxed: Box<dyn AsyncRead + Unpin + Send> = Box::new(reader.into_inner());
1162 let mut reframed = FrameReader::new(boxed, MAX_FRAME_BYTES);
1163 match reframed.next().await.unwrap() {
1164 Some(Inbound::Frame(v)) => assert_eq!(v["id"], 42),
1165 other => panic!("pipelined frame was lost across the rebox: {other:?}"),
1166 }
1167 server.await.unwrap();
1168 }
1169
1170 #[tokio::test]
1171 async fn blob_grant_issues_request_and_acks() {
1172 let (sock, _guard) = test_endpoint("grant");
1173 let listener = bind_local(&sock).unwrap();
1174 let server = tokio::spawn(async move {
1175 let mut listener = listener;
1176 let stream = listener.accept().await.unwrap();
1177 let (read_half, mut writer) = split_local(stream);
1178 write_frame(
1179 &mut writer,
1180 &serde_json::to_value(Hello {
1181 api: API_NAME.into(),
1182 api_version: API_VERSION.into(),
1183 api_minor: 0,
1184 stack_version: "0.1.0".into(),
1185 })
1186 .unwrap(),
1187 )
1188 .await
1189 .unwrap();
1190 let mut reader = FrameReader::new(read_half, MAX_FRAME_BYTES);
1191 let req = match reader.next().await.unwrap().unwrap() {
1192 Inbound::Frame(v) => v,
1193 Inbound::Violation(_) => panic!("violation"),
1194 };
1195 assert_eq!(req["method"], "blob_grant");
1196 assert_eq!(req["params"]["scope"], "kb-sync");
1197 assert_eq!(req["params"]["principal"], "alice");
1198 write_frame(
1199 &mut writer,
1200 &serde_json::json!({"jsonrpc":"2.0","id":1,"result":{"ok":true}}),
1201 )
1202 .await
1203 .unwrap();
1204 });
1205 let mut client = connect_control(&sock).await.unwrap();
1206 client.blob_grant("kb-sync", "alice").await.unwrap();
1207 server.await.unwrap();
1208 }
1209
1210 /// The typed `status()` helper pairs `Request::Status` with `StatusResult` — the caller gets
1211 /// the struct, not a `Value` to hand-deserialize (and a malformed result surfaces as
1212 /// `ClientError::Malformed`, never a silently-wrong type).
1213 #[tokio::test]
1214 async fn typed_status_helper_deserializes_the_result() {
1215 let (sock, _guard) = test_endpoint("typedstatus");
1216 let listener = bind_local(&sock).unwrap();
1217 let server = tokio::spawn(stub_daemon(listener));
1218
1219 let mut client = connect_control(&sock).await.unwrap();
1220 let status = client.status().await.unwrap();
1221 assert_eq!(status.stack_version, "0.1.0");
1222 assert_eq!(status.services[0].name, "kb");
1223 assert_eq!(status.services[0].backend, BackendKind::Socket);
1224 assert!(status.peers.is_empty());
1225 server.await.unwrap();
1226 }
1227
1228 /// The ack-shaped typed helpers issue the right wire method and discard the `{}` ack; a
1229 /// JSON-RPC error frame surfaces as `ClientError::Api`.
1230 #[tokio::test]
1231 async fn typed_ack_helpers_issue_requests_and_surface_api_errors() {
1232 let (sock, _guard) = test_endpoint("typedack");
1233 let listener = bind_local(&sock).unwrap();
1234 let server = tokio::spawn(async move {
1235 let mut listener = listener;
1236 let stream = listener.accept().await.unwrap();
1237 let (read_half, mut writer) = split_local(stream);
1238 write_frame(
1239 &mut writer,
1240 &serde_json::to_value(Hello {
1241 api: API_NAME.into(),
1242 api_version: API_VERSION.into(),
1243 api_minor: 0,
1244 stack_version: "0.1.0".into(),
1245 })
1246 .unwrap(),
1247 )
1248 .await
1249 .unwrap();
1250 let mut reader = FrameReader::new(read_half, MAX_FRAME_BYTES);
1251 // peer_remove → ack.
1252 let req = match reader.next().await.unwrap().unwrap() {
1253 Inbound::Frame(v) => v,
1254 Inbound::Violation(_) => panic!("violation"),
1255 };
1256 assert_eq!(req["method"], "peer_remove");
1257 assert_eq!(req["params"]["nickname"], "bob");
1258 write_frame(
1259 &mut writer,
1260 &serde_json::json!({"jsonrpc":"2.0","id":1,"result":{}}),
1261 )
1262 .await
1263 .unwrap();
1264 // peer_rename → an error frame (collision refusal).
1265 let req = match reader.next().await.unwrap().unwrap() {
1266 Inbound::Frame(v) => v,
1267 Inbound::Violation(_) => panic!("violation"),
1268 };
1269 assert_eq!(req["method"], "peer_rename");
1270 assert_eq!(req["params"]["to"], "Bobby");
1271 write_frame(
1272 &mut writer,
1273 &serde_json::json!({"jsonrpc":"2.0","id":2,"error":{"code":-32000,"message":"taken"}}),
1274 )
1275 .await
1276 .unwrap();
1277 });
1278
1279 let mut client = connect_control(&sock).await.unwrap();
1280 client.peer_remove("bob").await.unwrap();
1281 match client.peer_rename(None, Some("bob".into()), "Bobby").await {
1282 Err(ClientError::Api(e)) => assert_eq!(e["message"], "taken"),
1283 other => panic!("expected Api error, got {other:?}"),
1284 }
1285 server.await.unwrap();
1286 }
1287
1288 /// The typed `subscribe()` upgrade yields `StreamFrame`s — snapshot, event, lagged — then
1289 /// `None` when the daemon side closes.
1290 #[tokio::test]
1291 async fn typed_subscribe_yields_frames_then_end() {
1292 use crate::protocol::{ActiveSession, AuditRecord, PeerReachability};
1293
1294 let (sock, _guard) = test_endpoint("subscribe");
1295 let listener = bind_local(&sock).unwrap();
1296 let server = tokio::spawn(async move {
1297 let mut listener = listener;
1298 let stream = listener.accept().await.unwrap();
1299 let (read_half, mut writer) = split_local(stream);
1300 write_frame(
1301 &mut writer,
1302 &serde_json::to_value(Hello {
1303 api: API_NAME.into(),
1304 api_version: API_VERSION.into(),
1305 api_minor: 0,
1306 stack_version: "0.1.0".into(),
1307 })
1308 .unwrap(),
1309 )
1310 .await
1311 .unwrap();
1312 let mut reader = FrameReader::new(read_half, MAX_FRAME_BYTES);
1313 let req = match reader.next().await.unwrap().unwrap() {
1314 Inbound::Frame(v) => v,
1315 Inbound::Violation(_) => panic!("violation"),
1316 };
1317 assert_eq!(req["method"], "subscribe");
1318 for frame in [
1319 StreamFrame::Snapshot {
1320 self_network: None,
1321 active_sessions: vec![ActiveSession {
1322 peer: "bob".into(),
1323 service: "notes".into(),
1324 opened_at: 7,
1325 principal: Some("eid:bob".into()),
1326 }],
1327 reachability: vec![PeerReachability {
1328 name: "bob".into(),
1329 reachable: true,
1330 rtt_ms: Some(42),
1331 age_secs: Some(3),
1332 meta: String::new(),
1333 principal: None,
1334 path: Default::default(),
1335 }],
1336 },
1337 StreamFrame::Event {
1338 record: Box::new(AuditRecord::session_open(
1339 "2026-07-03T14:02:11.480Z".into(),
1340 Some("bob".into()),
1341 "notes".into(),
1342 None,
1343 )),
1344 },
1345 StreamFrame::Lagged { dropped: 12 },
1346 ] {
1347 write_frame(&mut writer, &serde_json::to_value(&frame).unwrap())
1348 .await
1349 .unwrap();
1350 }
1351 writer.flush().await.unwrap();
1352 // Drop the connection: the client must see the stream END (Ok(None)), not an error.
1353 });
1354
1355 let client = connect_control(&sock).await.unwrap();
1356 let mut sub = client.subscribe().await.unwrap();
1357 match sub.next().await.unwrap().unwrap() {
1358 StreamFrame::Snapshot {
1359 active_sessions,
1360 reachability,
1361 ..
1362 } => {
1363 assert_eq!(active_sessions[0].peer, "bob");
1364 assert_eq!(reachability[0].rtt_ms, Some(42));
1365 }
1366 other => panic!("expected the snapshot first, got {other:?}"),
1367 }
1368 match sub.next().await.unwrap().unwrap() {
1369 StreamFrame::Event { record } => {
1370 assert_eq!(record.peer.as_deref(), Some("bob"));
1371 assert_eq!(record.service.as_deref(), Some("notes"));
1372 }
1373 other => panic!("expected the event, got {other:?}"),
1374 }
1375 assert_eq!(
1376 sub.next().await.unwrap(),
1377 Some(StreamFrame::Lagged { dropped: 12 })
1378 );
1379 assert_eq!(sub.next().await.unwrap(), None, "clean end of stream");
1380 server.await.unwrap();
1381 }
1382}