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