Skip to main content

plexus_core/plexus/remote_child/
mod.rs

1//! POLYGLOT-5 — the child seam opened: an activation in another process,
2//! mounted under a name.
3//!
4//! [`RemoteChild`] is the second implementation of [`ChildRouter`] (and
5//! [`Activation`]): its other end is a process on stdio or a service on a
6//! WebSocket speaking plexus-wire (spec 01–05, 07, 11 and 12, *the hop
7//! between services*). A [`DynamicHub`](super::DynamicHub) registers it like
8//! any activation — its schema and roles merged under the mount name, its
9//! methods granted, refused and listed as an in-process activation's.
10//!
11//! ```ignore
12//! let echo = RemoteChild::connect("echo=stdio:python3 -I stub_child.py".parse()?, ChildOptions::for_service("menger")).await?;
13//! let service = DynamicHub::new("menger").register(tickets).register(echo);
14//! ```
15//!
16//! # What crosses
17//!
18//! The gate decides first; a refused call never reaches the child. An
19//! admitted one is `{ns}.call {method, params, hop}` with
20//! `hop = {principal, for, limit {grant, held_on} | null, call}`: the
21//! service acting, the caller it acts for, the gate's verdict as a ceiling
22//! and a call id — built from the verified principal and
23//! [`current_reach`](super::grant_gate::current_reach) only (an error outside
24//! a call, RETURNS-47: then nothing crosses), never from the caller's
25//! credential. Items come back unchanged, in order; the child's
26//! terminal item ends the caller's stream. A caller that lets go sends
27//! `{ns}.call_unsub`. A child gone is one `child_unavailable` error — the
28//! end (spec/03: an error is terminal) — and the next call starts it again,
29//! within its [`Backoff`]. An item nobody asked for is dropped, logged and
30//! counted ([`ChildStats::unasked`]).
31//!
32//! # A child's children (NEST-4) and its dynamic children (NEST-6)
33//!
34//! The mount walks the child's static tree once and keeps it: every level's
35//! schema is answered from it and nothing crosses (spec/12 rule 7). A
36//! dynamic child's slot (`#[child] fn planet(&self, name)`, or a
37//! `#[peer]` slot) stays on its parent's kept schema with its type, so the
38//! host's gate decides `<mount>.solar.earth.info` on the slot grant
39//! `<mount>.solar.{planet}.info` (an untyped slot whole, on
40//! `<mount>.solar.{planet}`) and the mount forwards it as `{ns}.call
41//! {method: "{ns}.solar.earth.info", hop}`, `hop.limit.grant` the slot grant
42//! in the child's terms; the child checks the slot ([`serve_child_on`]) and
43//! answers an unknown name with its own not-found. A slot's list and search
44//! methods are ordinary methods, forwarded. The one schema that crosses is
45//! an instance's (`<mount>.solar.earth.schema`): once per name, kept under
46//! the name and the `plexus_hash` it came with — at most
47//! `--child-schema-cache` names, the least recently used out
48//! ([`ChildStats::name_schemas`], [`ChildStats::name_schema_hits`]); an item
49//! through the name with another `plexus_hash` drops it, and a restart drops
50//! every name.
51
52//! # A child calls its service back (NEST-11)
53//!
54//! While a call is open into the child, the child may call the service back
55//! on the same connection — `_host.call {method, params, under}`, `under`
56//! the forwarded call's `hop.call` (plexus-wire spec/14). The service routes
57//! it through its own routing and gate as that call's caller, within that
58//! call's reach, and ends it when that call ends; outside a live call it
59//! answers a schema only (`upcall.rs`). The far side in Rust calls back
60//! through [`host()`], a `Transport` a generated client takes.
61
62// RETURNS-47: the far side in Rust — an activation served as a child, each
63// call in its hop's context.
64mod host;
65mod link;
66// NEST-6: one dynamic instance's schema, kept per name.
67mod names;
68// RETURNS-36: a peer on plexus-wire's spec as main wrote it, read as 0.8.
69mod peer;
70mod spec;
71// NEST-11: a child calls its service back, under a call it serves.
72mod upcall;
73#[cfg(feature = "child-ws")]
74mod ws;
75#[cfg(feature = "clap")]
76mod args;
77// VISION-5 (LOCAL-5): dial-in peers (the accepting side) and dial-out (the
78// side with no listening port).
79mod dial_in;
80#[cfg(feature = "child-ws")]
81mod dial_out;
82
83use std::pin::Pin;
84use std::sync::atomic::Ordering;
85use std::sync::Arc;
86use std::task::{Context, Poll};
87use std::time::Instant;
88
89use async_trait::async_trait;
90use futures::Stream;
91use plexus_auth_core::grants::{GrantsGeneration, Reach};
92use serde_json::{json, Value};
93use tokio::sync::mpsc;
94
95pub use host::{host, serve_child, serve_child_on, serve_child_stdio, serve_child_with, ChildPeer, HostTransport, ServeChild};
96pub use upcall::{Consented, HOST_CALL, HOST_CALL_UNSUB};
97pub use link::MountTimings;
98pub use spec::{check_ws_url, is_insecure_ws, is_loopback_host, parse_duration, Backoff, ChildError, ChildOptions, ChildSpec, INSECURE_TRANSPORT};
99#[cfg(feature = "clap")]
100pub use args::ChildArgs;
101pub use dial_in::{PeerEvent, PeerInfo, PeerRoles, PeerSocket, Peers, PeersMethods};
102#[cfg(feature = "child-ws")]
103pub use dial_out::{key_principal, DialOut, DialState, Exposed};
104
105use link::{meta, too_many, unavailable, Conn, Counters, Shared, SubKey};
106
107use super::auth::AuthContext;
108use super::method_enum::MethodEnumSchema;
109use super::plexus::{Activation, ChildRouter, PlexusError};
110use super::schema::{MethodRole, PluginSchema};
111use super::streaming::PlexusStream;
112use super::types::PlexusStreamItem;
113
114/// DYNAUTH-8 (TM-3): who a child proved it was at its mount — what a
115/// restart is held to. Its `_info`'s `backend`, and on `wss://` the key its
116/// certificate holds (sha256 of the SubjectPublicKeyInfo, hex): a renewed
117/// certificate over the same key is the same peer; a new key is not. A
118/// peer's own Ed25519 key, proved at `_info` over a nonce, joins it
119/// (DYNAUTH-5): a restart proving another key is refused as one proving
120/// another certificate key is.
121#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
122pub struct PeerIdentity {
123    /// The backend its `_info` names.
124    pub backend: String,
125    /// On `wss://`: sha256 of its certificate's public key, hex.
126    #[serde(default, skip_serializing_if = "Option::is_none")]
127    pub tls_key: Option<String>,
128    /// DYNAUTH-5: the Ed25519 key it proved at `_info` (`key:<hex>`), if it
129    /// proved one — what a peer token is addressed and bound to.
130    #[serde(default, skip_serializing_if = "Option::is_none")]
131    pub key: Option<String>,
132}
133
134impl PeerIdentity {
135    fn of(conn: &Conn) -> Self {
136        Self { backend: conn.ns().to_string(), tls_key: conn.tls_key.get().cloned(), key: conn.peer_key.get().cloned() }
137    }
138}
139
140impl std::fmt::Display for PeerIdentity {
141    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
142        write!(f, "backend `{}`", self.backend)?;
143        match &self.tls_key {
144            Some(k) => write!(f, ", TLS key {}", &k[..k.len().min(16)]),
145            None => write!(f, ", no TLS key"),
146        }?;
147        match &self.key {
148            Some(k) => write!(f, ", key {}", &k[..k.len().min(20)]),
149            None => Ok(()),
150        }
151    }
152}
153
154/// What the seam has seen of one child.
155#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
156pub struct ChildStats {
157    /// Calls open now.
158    pub open: usize,
159    /// Items the child sent for a call it was not given (dropped).
160    pub unasked: u64,
161    /// Times the child was started (or dialed) again after it went.
162    pub restarts: u64,
163    /// Calls forwarded, in all.
164    pub calls: u64,
165    /// NEST-6: a dynamic instance's schema asked across the hop
166    /// (`<mount>.<path>.<name>.schema`, once per name while it is kept).
167    pub name_schemas: u64,
168    /// NEST-6: a dynamic instance's schema answered from what the mount kept.
169    pub name_schema_hits: u64,
170    /// NEST-6: dynamic instances whose schema is kept now
171    /// (at most `--child-schema-cache`).
172    pub names_kept: usize,
173    /// NEST-11: calls the child made back into its service, in all.
174    pub calls_back: u64,
175    /// NEST-12: whether a live connection to the child is up now.
176    pub up: bool,
177}
178
179/// A child's methods are data — its schema, asked at mount — not a Rust
180/// enum: the [`Activation::Methods`] of a [`RemoteChild`].
181#[derive(Debug, Clone, Copy)]
182pub enum ChildMethods {}
183
184impl schemars::JsonSchema for ChildMethods {
185    fn schema_name() -> std::borrow::Cow<'static, str> {
186        "ChildMethods".into()
187    }
188
189    fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
190        schemars::json_schema!({
191            "description": "A child service's methods are data: its schema, asked when it was mounted (`<mount>.schema`)."
192        })
193    }
194}
195
196impl MethodEnumSchema for ChildMethods {
197    fn method_names() -> &'static [&'static str] {
198        &[]
199    }
200
201    fn schema_with_consts() -> Value {
202        serde_json::to_value(schemars::schema_for!(ChildMethods)).unwrap_or(Value::Null)
203    }
204}
205
206struct Inner {
207    shared: Arc<Shared>,
208    schema: PluginSchema,
209    /// NEST-4: every static child below the mount, by dotted path relative
210    /// to it (`a`, `a.b`), each schema as the child published it — its own
211    /// namespace, its grants and roles relative to it, as an in-process
212    /// child's ([`Activation::static_child_schemas`]).
213    nodes: Vec<(String, PluginSchema)>,
214    timings: MountTimings,
215    /// NEST-6: each dynamic instance's schema, asked once per name.
216    names: names::Names,
217    /// NEST-16: what the child needs of its service: its own schema's
218    /// `needs` and every static child's, as one list (`None`: none declares).
219    needs: Option<Vec<crate::plexus::schema::Need>>,
220}
221
222impl Inner {
223    pub(super) fn new(shared: Arc<Shared>, schema: PluginSchema, nodes: Vec<(String, PluginSchema)>, timings: MountTimings) -> Self {
224        let names = names::Names::new(shared.opts.schema_cache);
225        let declared = schema.needs.is_some() || nodes.iter().any(|(_, n)| n.needs.is_some());
226        let mut needs: Vec<crate::plexus::schema::Need> = schema.needs.iter().chain(nodes.iter().filter_map(|(_, n)| n.needs.as_ref())).flatten().cloned().collect();
227        needs.sort();
228        needs.dedup_by(|a, b| a.method == b.method);
229        let needs = declared.then_some(needs);
230        Self { shared, schema, nodes, timings, names, needs }
231    }
232}
233
234/// An activation in another process (or behind a WebSocket), mounted under
235/// its [`ChildSpec`]'s name. Cheap to clone; the child stops when the last
236/// clone is dropped.
237#[derive(Clone)]
238pub struct RemoteChild {
239    inner: Arc<Inner>,
240}
241
242impl std::fmt::Debug for RemoteChild {
243    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
244        f.debug_struct("RemoteChild").field("spec", &self.inner.shared.spec.to_string()).field("insecure", &self.insecure()).field("stats", &self.stats()).finish()
245    }
246}
247
248/// One schema as a child published it, read into 0.8's shape.
249fn read_schema(raw: Value) -> Result<PluginSchema, String> {
250    serde_json::from_value(peer::schema(raw)?).map_err(|e| format!("its schema does not read: {e}"))
251}
252
253/// A static child's schema as the mount keeps it (NEST-4): as published,
254/// its grants relative to it — the host qualifies them by the path
255/// ([`super::children::qualified`]), as it does an in-process child's.
256pub(super) fn node_schema(path: &str, raw: Value) -> Result<PluginSchema, String> {
257    read_schema(raw).map_err(|e| format!("its child `{path}`: {e}"))
258}
259
260/// The child's schema as the service keeps it: under the mount name, its
261/// roles' grants and its methods' own grants requalified (`{ns}.m` →
262/// `<mount>.m`). Its static children are kept beside it ([`node_schema`]);
263/// a dynamic child's role (and a peer slot's) stays on it with the slot's
264/// type: the slot a call into it is forwarded through (NEST-6).
265fn mount_schema(name: &str, raw: Value) -> Result<PluginSchema, String> {
266    let mut schema = read_schema(raw)?;
267    if schema.namespace != name {
268        tracing::info!(target: "plexus::child", child = %name, declared = %schema.namespace, "mounted under its mount name, not the namespace it declares");
269    }
270    let prefix = format!("{}.", schema.namespace);
271    let requalify = |g: &String| match g.strip_prefix(&prefix) {
272        Some(m) => format!("{name}.{m}"),
273        None => format!("{name}.{g}"),
274    };
275    schema.roles = schema.roles.iter().map(|(r, gs)| (r.clone(), gs.iter().map(requalify).collect())).collect();
276    for m in schema.methods.iter_mut() {
277        if let Some(g) = m.grant.as_ref() {
278            m.grant = Some(requalify(g));
279        }
280    }
281    schema.namespace = name.to_string();
282    Ok(schema)
283}
284
285impl RemoteChild {
286    /// Start (or dial) the child, ask its `_info` and its schema within
287    /// `opts.timeout`, and keep the connection. Fails naming the child and
288    /// why: it did not start, did not answer, or published a schema the
289    /// service will not mount.
290    pub async fn connect(spec: ChildSpec, opts: ChildOptions) -> Result<Self, ChildError> {
291        let name = spec.name().to_string();
292        let start = |why: String| ChildError::Start(name.clone(), why);
293        if opts.max_calls == 0 || opts.buffer == 0 {
294            return Err(start("max_calls and buffer are at least 1".into()));
295        }
296        let principal = Self::principal_for(&spec, &opts).map_err(start)?;
297        let shared = Shared::new(spec, opts, principal);
298        let (conn, kept, mut timings) = shared.connect_once().await.map_err(start)?;
299        let t = Instant::now();
300        let hash = kept.hash();
301        let read = mount_schema(&name, kept.top).and_then(|schema| {
302            let nodes = kept.nodes.into_iter().map(|(path, raw)| node_schema(&path, raw).map(|s| (path, s))).collect::<Result<Vec<_>, _>>()?;
303            Ok((schema, nodes))
304        });
305        let (schema, nodes) = match read {
306            Ok(s) => s,
307            Err(why) => {
308                conn.shutdown.notify_one();
309                return Err(start(why));
310            }
311        };
312        let _ = shared.mounted_hash.set(hash);
313        let _ = shared.identity.set(PeerIdentity::of(&conn));
314        shared.install(conn);
315        timings.merge_ms = t.elapsed().as_secs_f64() * 1e3;
316        tracing::info!(target: "plexus::child", child = %name, spawn_ms = timings.spawn_ms, schema_ms = timings.schema_ms, merge_ms = timings.merge_ms, methods = schema.methods.len(), children = nodes.len(), "child mounted");
317        if let ChildSpec::Ws { url, .. } = &shared.spec {
318            if is_insecure_ws(url) {
319                tracing::warn!(target: "plexus::child", child = %name, %url, "insecure: mounted over plain ws:// beyond loopback (transport.insecure_ws); its hops and key proof cross in clear");
320            }
321        }
322        let inner = Inner::new(shared, schema, nodes, timings);
323        // NEST-16: the child's calls back are held to what it needs.
324        inner.shared.upcalls.set_needs(inner.needs.as_deref());
325        Ok(Self { inner: Arc::new(inner) })
326    }
327
328    #[allow(unused_variables)]
329    fn principal_for(spec: &ChildSpec, opts: &ChildOptions) -> Result<String, String> {
330        #[cfg(feature = "child-ws")]
331        if let (ChildSpec::Ws { .. }, Some(path)) = (spec, &opts.key) {
332            return Ok(ws::principal_of(&ws::read_seed(path)?));
333        }
334        Ok(opts.principal.clone())
335    }
336
337    /// What the seam has seen.
338    pub fn stats(&self) -> ChildStats {
339        let c: &Counters = &self.inner.shared.counters;
340        ChildStats {
341            open: c.open.load(Ordering::Relaxed),
342            unasked: c.unasked.load(Ordering::Relaxed),
343            restarts: c.restarts.load(Ordering::Relaxed),
344            calls: c.calls.load(Ordering::Relaxed),
345            name_schemas: self.inner.names.hops.load(Ordering::Relaxed),
346            name_schema_hits: self.inner.names.hits.load(Ordering::Relaxed),
347            names_kept: self.inner.names.len(c.restarts.load(Ordering::Relaxed)),
348            calls_back: self.inner.shared.upcalls.made.load(Ordering::Relaxed),
349            up: self.inner.shared.is_up(),
350        }
351    }
352
353    /// DYNAUTH-8 (TM-3): who the child proved it was when it was mounted —
354    /// pinned for the life of this mount: a restart (or redial) that proves
355    /// another is refused for good ([`RemoteChild::dead`]).
356    pub fn identity(&self) -> Option<&PeerIdentity> {
357        self.inner.shared.identity.get()
358    }
359
360    /// DYNAUTH-5: hold the child's calls back to the needs an admin
361    /// consented to, each on its scopes (`None`: no consent kept — every
362    /// declared need, as NEST-16 has it). A declared need not consented is
363    /// refused `forbidden` (`not_needed`), saying so.
364    pub fn set_consent(&self, consent: Option<Vec<Consented>>) {
365        self.inner.shared.upcalls.set_consent(consent);
366    }
367
368    /// DYNAUTH-5: the consent this mount holds its child's calls back to.
369    pub fn consent(&self) -> Option<Vec<Consented>> {
370        self.inner.shared.upcalls.consent().map(|c| c.to_vec())
371    }
372
373    /// DYNAUTH-7: revoke the child: from now no call is forwarded to it (so
374    /// no token is minted for it), and every call it is making back ends
375    /// with one error item saying `why`. A token already in its hand lives
376    /// out its `exp` (≤ 60 s) at a peer that verifies without asking.
377    pub fn revoke(&self, why: &str) {
378        *self.inner.shared.revoked.lock().unwrap() = Some(why.to_string());
379        self.inner.shared.upcalls.end_all(&format!("revoked: {why}"));
380        tracing::warn!(target: "plexus::audit", child = %self.name(), %why, "child revoked");
381    }
382
383    /// DYNAUTH-7: why the child is revoked, if it is.
384    pub fn revoked(&self) -> Option<String> {
385        self.inner.shared.revoked.lock().unwrap().clone()
386    }
387
388    /// DYNAUTH-5: the Ed25519 key the child proved at its mount
389    /// (`key:<hex>`), if it proved one; pinned with [`Self::identity`].
390    pub fn peer_key(&self) -> Option<&str> {
391        self.identity().and_then(|i| i.key.as_deref())
392    }
393
394    /// NEST-12: whether a live connection to the child is up now.
395    pub fn is_up(&self) -> bool {
396        self.inner.shared.is_up()
397    }
398
399    /// NEST-12: why the child will never be mounted again under this
400    /// mount, if it will not — a restart published another schema
401    /// (`"schema changed; restart the service"`): a fresh
402    /// [`RemoteChild::connect`] mounts the new one.
403    pub fn dead(&self) -> Option<String> {
404        self.inner.shared.dead()
405    }
406
407    /// NEST-12: why the child is down, when it is — its last connection's
408    /// end, the last start that failed, or why it will never be mounted
409    /// again; `None` while it is up.
410    pub fn why_down(&self) -> Option<String> {
411        self.inner.shared.why_down()
412    }
413
414    /// NEST-12: bring the child up now if it is down — start (or redial) it
415    /// within its [`Backoff`], as the next call would. `Err`: why it is not
416    /// up (and [`RemoteChild::dead`] says whether it never will be).
417    pub async fn up(&self) -> Result<(), String> {
418        match self.inner.shared.ensure().await {
419            Ok(_) => Ok(()),
420            Err(PlexusStreamItem::Error { message, error, .. }) => Err(match error {
421                plexus_client::RemoteError::ChildUnavailable { reason, .. } => reason,
422                _ => message,
423            }),
424            Err(other) => Err(format!("{other:?}")),
425        }
426    }
427
428    /// NEST-16: what the child's schema says it needs of the service it is
429    /// mounted in (`None`: it declares nothing).
430    pub fn needs(&self) -> Option<&[crate::plexus::schema::Need]> {
431        self.inner.needs.as_deref()
432    }
433
434    /// NEST-11: forwarded calls open now that the child may call back under.
435    pub fn calls_open_back(&self) -> usize {
436        self.inner.shared.upcalls.open_now()
437    }
438
439    /// The schema hash this mount took, as the child published it (its
440    /// whole tree's, NEST-4).
441    pub fn mounted_hash(&self) -> &str {
442        self.inner.shared.mounted_hash.get().map(String::as_str).unwrap_or_default()
443    }
444
445    /// The process now serving (a stdio child), if one is up.
446    pub fn pid(&self) -> Option<u32> {
447        self.inner.shared.current().and_then(|c| c.pid)
448    }
449
450    /// The mount's name.
451    pub fn name(&self) -> &str {
452        &self.inner.shared.name
453    }
454
455    /// KEEL-7: whether the mount is plain `ws://` beyond loopback — dialed
456    /// only because `transport.insecure_ws` allowed it, every hop and proof
457    /// on it in clear. Said wherever the mount is listed.
458    pub fn insecure(&self) -> bool {
459        matches!(&self.inner.shared.spec, ChildSpec::Ws { url, .. } if is_insecure_ws(url))
460    }
461
462    /// The spec it was mounted from.
463    pub fn spec(&self) -> &ChildSpec {
464        &self.inner.shared.spec
465    }
466
467    /// The hop's `principal`: the service acting, as this child is told.
468    pub fn principal(&self) -> &str {
469        &self.inner.shared.principal
470    }
471
472    /// How long the mount took.
473    pub fn mount_timings(&self) -> MountTimings {
474        self.inner.timings
475    }
476
477    /// Subscriptions routed on the live connection (0 when none is up).
478    pub fn routed(&self) -> usize {
479        self.inner.shared.current().map_or(0, |c| c.routed())
480    }
481
482    /// The hop (spec/12) for a call by `auth`, decided as `reach`: the
483    /// service acts, the caller is named `for`, the verdict is the limit.
484    /// Nothing of the caller's credential.
485    fn hop(&self, conn: &Conn, auth: Option<&AuthContext>, reach: &Reach, method: &str) -> (Value, String) {
486        let for_: Vec<String> = auth.and_then(|a| a.principal()).map(|p| p.to_string()).into_iter().collect();
487        let limit = reach.grant().map(|g| {
488            let grant = match g.as_str().strip_prefix(&format!("{}.", self.name())) {
489                Some(m) => format!("{}.{m}", conn.ns()),
490                // NEST-12: a grant decided above the mount — the mount is a
491                // peer reached through a slot of its service (`dyn.{peer}`,
492                // or a literal `dyn.peer.<name>.<method>`): the verdict
493                // covers this method, said in the child's terms.
494                None => format!("{}.{method}", conn.ns()),
495            };
496            let held_on: Vec<String> = reach.held_on().iter().map(|s| s.to_string()).collect();
497            json!({ "grant": grant, "held_on": held_on })
498        });
499        let call = uuid::Uuid::new_v4().to_string();
500        (json!({ "principal": self.inner.shared.principal, "for": for_, "limit": limit, "call": call }), call)
501    }
502
503    /// DYNAUTH-12: mint the token for one forwarded call — for a signed-in
504    /// caller, when the service issues tokens, to a child that proved a key
505    /// (bound to it) or one on the service's own pipe (`pipe:<name>`). A
506    /// WebSocket child that proved no key gets none.
507    fn mint(&self, auth: Option<&AuthContext>, reach: &Reach, hop: &Value, path: &str, call: &str) -> Result<Option<upcall::Minted>, String> {
508        use crate::plexus::peer_token::{mint_scope, onward_scope, MintRequest};
509        let Some(issuer) = self.inner.shared.opts.tokens.as_ref() else { return Ok(None) };
510        let Some(sub) = auth.and_then(|a| a.principal()).map(|p| p.to_string()) else { return Ok(None) };
511        let peer_key = self.peer_key().map(str::to_string);
512        if peer_key.is_none() && !matches!(self.spec(), ChildSpec::Stdio { .. }) {
513            return Ok(None);
514        }
515        let held: Vec<String> = if reach.is_everywhere() { vec!["*".into()] } else { reach.held_on().iter().map(|s| s.to_string()).collect() };
516        let needs = crate::plexus::service_scope::current()
517            .and_then(|w| w.upgrade())
518            .map(|svc| self.inner.shared.upcalls.need_grants(&svc))
519            .unwrap_or_default();
520        let forwarded = hop.get("limit").and_then(|l| l.get("grant")).and_then(Value::as_str);
521        let presented = upcall::presented();
522        // DYNAUTH-6: onward from a call back, never wider than its token.
523        let scope = match &presented {
524            Some(p) => onward_scope(p, reach.grant().map(|g| g.as_str()), forwarded, &held, &needs),
525            None => mint_scope(forwarded, &held, &needs),
526        };
527        let req = MintRequest { sub, peer_key, name: self.name().to_string(), scope, call: call.to_string(), method: path.to_string(), presented };
528        let (token, claims) = issuer.mint(req).map_err(|e| e.to_string())?;
529        Ok(Some(upcall::Minted { token, claims }))
530    }
531
532    /// NEST-4: the kept static child at `path` (dotted, relative to the mount).
533    fn node(&self, path: &str) -> Option<&PluginSchema> {
534        self.inner.nodes.iter().find(|(p, _)| p == path).map(|(_, s)| s)
535    }
536
537    /// NEST-6: where a path below the mount enters a slot, if it does: the
538    /// slot (`<mount>.<parent>.{<slot>}`) and the instance's path below the
539    /// mount (`<parent>.<name>`; through a peer slot, which the path names,
540    /// `<parent>.<slot>.<name>`). The deepest kept level the path starts with
541    /// is the parent: a static child, which the walk kept, wins over a slot.
542    fn slot_of(&self, path: &str) -> Option<(String, String)> {
543        let segs: Vec<&str> = path.split('.').collect();
544        let (n, schema) = (1..segs.len())
545            .rev()
546            .find_map(|n| self.node(&segs[..n].join(".")).map(|s| (n, s)))
547            .unwrap_or((0, &self.inner.schema));
548        let parent = std::iter::once(self.name()).chain(segs[..n].iter().copied()).collect::<Vec<_>>().join(".");
549        let next = segs[n];
550        // NEST-7: a peer slot is named in the path, then the peer's name.
551        if schema.methods.iter().any(|m| m.name == next && matches!(m.role, MethodRole::Peer { .. })) {
552            return Some((crate::plexus::slots::slot_path(&parent, next), segs[..(n + 2).min(segs.len())].join(".")));
553        }
554        let slot = schema.methods.iter().find(|m| matches!(m.role, MethodRole::DynamicChild { .. }))?;
555        Some((crate::plexus::slots::slot_path(&parent, &slot.name), segs[..=n].join(".")))
556    }
557
558    /// A path no kept level answers and no slot is on the way of.
559    fn unreached(&self, method: &str) -> PlexusError {
560        PlexusError::MethodNotFound { activation: self.name().to_string(), method: method.to_string() }
561    }
562
563    /// NEST-6: `<mount>.<path>.schema` where `path` is in a dynamic slot
564    /// (`instance` its name's path): from the kept names, else asked of the
565    /// child once (`{ns}.<path>.schema`, with the caller's hop), kept under
566    /// its path and the `plexus_hash` it came with, and answered from that.
567    /// What the child answers instead of a schema (an unknown name's
568    /// not-found) comes back unchanged and is not kept.
569    async fn name_schema(&self, path: &str, params: &Value, auth: Option<&AuthContext>) -> PlexusStream {
570        let epoch = self.inner.shared.counters.restarts.load(Ordering::Relaxed);
571        if let Some(s) = self.inner.names.get(path, epoch) {
572            return self.schema_stream_of(&s, &s.namespace, params);
573        }
574        self.inner.names.crossed();
575        let items: Vec<PlexusStreamItem> = futures::StreamExt::collect(self.forward(&format!("{path}.schema"), json!({}), auth, None).await).await;
576        let kept = items.iter().find_map(|i| match i {
577            PlexusStreamItem::Data { metadata, content, .. } => Some((metadata.plexus_hash.clone(), content.clone().into_value())),
578            _ => None,
579        });
580        let Some((seen, raw)) = kept else {
581            return Box::pin(futures::stream::iter(items));
582        };
583        match read_schema(raw) {
584            Ok(schema) => {
585                // A restart while it crossed: what came is the new child's.
586                let epoch = self.inner.shared.counters.restarts.load(Ordering::Relaxed);
587                self.inner.names.put(path, schema.clone(), seen, epoch);
588                self.schema_stream_of(&schema, &schema.namespace, params)
589            }
590            Err(_) => Box::pin(futures::stream::iter(items)),
591        }
592    }
593
594    fn schema_stream(&self, params: &Value) -> PlexusStream {
595        self.schema_stream_of(&self.inner.schema, self.name(), params)
596    }
597
598    /// `schema` answered from what the mount kept: nothing crosses the hop
599    /// (spec/12 rule 7). `label` is the content type's namespace.
600    fn schema_stream_of(&self, schema: &PluginSchema, label: &str, params: &Value) -> PlexusStream {
601        let ns = label.to_string();
602        let content = match params.get("method").and_then(Value::as_str) {
603            Some(m) => match schema.methods.iter().find(|x| x.name == m) {
604                Some(ms) => serde_json::to_value(ms).unwrap_or_default(),
605                None => {
606                    let error = plexus_client::RemoteError::MethodNotFound { activation: ns.clone(), method: m.to_string() };
607                    let mut e = PlexusStreamItem::error(meta(&ns), error, false);
608                    if let PlexusStreamItem::Error { message, code, .. } = &mut e {
609                        *message = format!("Method '{m}' not found");
610                        *code = Some("-32602".into());
611                    }
612                    return Box::pin(futures::stream::iter([e]));
613                }
614            },
615            None => serde_json::to_value(schema).unwrap_or_default(),
616        };
617        Box::pin(futures::stream::iter([
618            PlexusStreamItem::Data { metadata: meta(&ns).into(), content_type: format!("{ns}.schema").into(), content: content.into() },
619            PlexusStreamItem::Done { metadata: meta(&ns) },
620        ]))
621    }
622
623    /// `instance`: the path of the dynamic instance the call goes through
624    /// (NEST-6), whose kept schema an item with another `plexus_hash` drops.
625    async fn forward(&self, method: &str, params: Value, auth: Option<&AuthContext>, instance: Option<String>) -> PlexusStream {
626        let shared = &self.inner.shared;
627        let one = |item: PlexusStreamItem| -> PlexusStream { Box::pin(futures::stream::iter([item])) };
628        // DYNAUTH-7: a revoked child is forwarded nothing.
629        if let Some(why) = shared.revoked.lock().unwrap().clone() {
630            let e = PlexusError::Unauthenticated(format!("`{}` is revoked ({why}): no call is forwarded to it", self.name()));
631            return one(PlexusStreamItem::from_plexus_error(meta(self.name()), &e, false));
632        }
633        // RETURNS-47: the verdict is the call's; outside one (a forward no
634        // dispatch admitted) nothing crosses — fail closed, never everywhere.
635        let reach = match super::grant_gate::current_reach() {
636            Ok(reach) => reach,
637            Err(e) => return one(PlexusStreamItem::from_plexus_error(meta(self.name()), &e, false)),
638        };
639        let max = shared.opts.max_calls;
640        if shared.counters.open.fetch_add(1, Ordering::AcqRel) >= max {
641            shared.counters.open.fetch_sub(1, Ordering::AcqRel);
642            return one(too_many(self.name(), max));
643        }
644        let guard = OpenGuard(Arc::clone(&shared.counters));
645        let conn = match shared.ensure().await {
646            Ok(c) => c,
647            Err(item) => return one(item),
648        };
649        shared.counters.calls.fetch_add(1, Ordering::Relaxed);
650        let (mut hop, call_id) = self.hop(&conn, auth, &reach, method);
651        let path = format!("{}.{method}", conn.ns());
652        // DYNAUTH-12: the token for this one call, when the service issues.
653        let minted = match self.mint(auth, &reach, &hop, &path, &call_id) {
654            Ok(m) => m,
655            Err(why) => {
656                let e = PlexusError::Unauthenticated(format!("no token could be minted for `{}`: {why}", self.name()));
657                return one(PlexusStreamItem::from_plexus_error(meta(self.name()), &e, false));
658            }
659        };
660        if let Some(m) = &minted {
661            hop["token"] = json!(m.token);
662        }
663        // NEST-11: the child may call back under this call while it is open.
664        let under = shared.upcalls.open(&call_id, auth, &reach, minted);
665        let call = json!({ "method": path, "params": params, "hop": hop });
666        match conn.open(&format!("{}.call", conn.ns()), call, shared.opts.timeout).await {
667            Ok((sid, rx)) => {
668                let generation = reach.generation().cloned();
669                let seen = generation.as_ref().map_or(0, GrantsGeneration::current);
670                let instance = instance.map(|path| (Arc::clone(&self.inner), path));
671                Box::pin(CallStream { rx, sid, conn, over: false, _guard: guard, reach, generation, seen, name: self.name().to_string(), instance, under })
672            }
673            Err(item) => one(item),
674        }
675    }
676}
677
678/// One open call, counted until its stream ends or is dropped.
679struct OpenGuard(Arc<Counters>);
680
681impl Drop for OpenGuard {
682    fn drop(&mut self) {
683        self.0.open.fetch_sub(1, Ordering::AcqRel);
684    }
685}
686
687/// The stream the service hands its caller: the child's items, in order,
688/// until the first terminal one; dropped before it, the child is told.
689struct CallStream {
690    rx: mpsc::Receiver<PlexusStreamItem>,
691    sid: SubKey,
692    conn: Arc<Conn>,
693    over: bool,
694    _guard: OpenGuard,
695    /// The gate's verdict at the open, asked again when the grants
696    /// generation moves (BIDIR-1 `regate = generation`, BIDIR-8).
697    reach: Reach,
698    generation: Option<GrantsGeneration>,
699    seen: u64,
700    name: String,
701    /// NEST-6: the dynamic instance the call goes through, and the mount
702    /// whose kept schema of it an item with another `plexus_hash` drops.
703    instance: Option<(Arc<Inner>, String)>,
704    /// NEST-11: the child's standing to call back under this call; ended
705    /// with it.
706    under: Option<upcall::UnderGuard>,
707}
708
709impl CallStream {
710    /// The call is over: what the child made under it ends too.
711    fn finish(&mut self, why: &str) {
712        self.over = true;
713        if let Some(u) = self.under.take() {
714            u.end(why);
715        }
716    }
717
718    /// The grant revoked mid-stream: the caller's last item.
719    fn revoked(&self) -> PlexusStreamItem {
720        let grant = self.reach.grant().map(|g| g.as_str().to_string()).unwrap_or_default();
721        let error = plexus_client::RemoteError::Forbidden {
722            reason: plexus_client::DenyReason::MissingGrant {
723                grant: grant.clone(),
724                scope: "*".into(),
725                roles: Vec::new(),
726                held_on: Vec::new(),
727            },
728        };
729        let mut item = PlexusStreamItem::error(meta(&self.name), error, false);
730        if let PlexusStreamItem::Error { message, .. } = &mut item {
731            *message = format!("Forbidden: `{grant}` is no longer held — the call's grant moved while it ran");
732        }
733        item
734    }
735}
736
737impl Stream for CallStream {
738    type Item = PlexusStreamItem;
739
740    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
741        if self.over {
742            return Poll::Ready(None);
743        }
744        match self.rx.poll_recv(cx) {
745            Poll::Ready(Some(item)) => {
746                if let (Some((inner, path)), Some(m)) = (&self.instance, item.metadata()) {
747                    inner.names.observe(path, &m.plexus_hash);
748                }
749                let terminal = matches!(item, PlexusStreamItem::Done { .. } | PlexusStreamItem::Error { .. });
750                let moved = self.generation.as_ref().map(GrantsGeneration::current).filter(|g| *g != self.seen);
751                if let (false, Some(g)) = (terminal, moved) {
752                    self.seen = g;
753                    if self.reach.current().is_none() {
754                        let sid = self.sid.clone();
755                        self.conn.unsubscribe(&sid);
756                        self.finish("its grant was revoked");
757                        return Poll::Ready(Some(self.revoked()));
758                    }
759                }
760                if terminal {
761                    self.finish("it ended");
762                }
763                Poll::Ready(Some(item))
764            }
765            Poll::Ready(None) => {
766                // The channel closed with no terminal item: the link went.
767                self.finish("the connection closed");
768                Poll::Ready(Some(unavailable(&self.name, "the connection closed")))
769            }
770            Poll::Pending => Poll::Pending,
771        }
772    }
773}
774
775impl Drop for CallStream {
776    fn drop(&mut self) {
777        if !self.over {
778            self.conn.unsubscribe(&self.sid);
779        }
780    }
781}
782
783#[async_trait]
784impl Activation for RemoteChild {
785    type Methods = ChildMethods;
786
787    fn needs(&self) -> Option<Vec<crate::plexus::schema::Need>> {
788        self.inner.needs.clone()
789    }
790
791    fn namespace(&self) -> &str {
792        self.name()
793    }
794
795    fn version(&self) -> &str {
796        &self.inner.schema.version
797    }
798
799    fn description(&self) -> &str {
800        &self.inner.schema.description
801    }
802
803    fn long_description(&self) -> Option<&str> {
804        self.inner.schema.long_description.as_deref()
805    }
806
807    fn methods(&self) -> Vec<&str> {
808        self.inner.schema.methods.iter().map(|m| m.name.as_str()).collect()
809    }
810
811    fn method_help(&self, method: &str) -> Option<String> {
812        self.inner.schema.methods.iter().find(|m| m.name == method).map(|m| m.description.clone())
813    }
814
815    async fn call(&self, method: &str, params: Value, auth: Option<&AuthContext>, _raw: Option<&crate::request::RawRequestContext>) -> Result<PlexusStream, PlexusError> {
816        if method == "schema" {
817            return Ok(self.schema_stream(&params));
818        }
819        // NEST-4: a static child's schema, from the kept tree.
820        if let Some(path) = method.strip_suffix(".schema") {
821            if let Some(s) = self.node(path) {
822                return Ok(self.schema_stream_of(s, &s.namespace, &params));
823            }
824            // NEST-6: an instance in a dynamic slot: the one schema that
825            // crosses the hop, once per name (spec/12 rule 7's exception).
826            return match self.slot_of(path) {
827                Some(_) => Ok(self.name_schema(path, &params, auth).await),
828                None => Err(self.unreached(method)),
829            };
830        }
831        let found = match method.rsplit_once('.') {
832            // NEST-4: a static child's method, by its path.
833            Some((path, name)) => match self.node(path) {
834                Some(s) => s.methods.iter().find(|m| m.name == name && m.role == MethodRole::Rpc),
835                // NEST-6: a method of an instance in a dynamic slot: the
836                // host's gate decided it on the slot grant; forwarded as
837                // any call, the child deciding again and answering an
838                // unknown name with its own not-found.
839                None => match self.slot_of(path) {
840                    Some((_, instance)) => return Ok(self.forward(method, params, auth, Some(instance)).await),
841                    None => return Err(self.unreached(method)),
842                },
843            },
844            None => self.inner.schema.methods.iter().find(|m| m.name == method && m.role == MethodRole::Rpc),
845        };
846        let Some(m) = found else {
847            return Err(PlexusError::MethodNotFound { activation: self.name().to_string(), method: method.to_string() });
848        };
849        // BIDIR-6: a hop forwards no input half yet; the far side would wait
850        // for items that never come.
851        if m.input.is_some() {
852            return Err(PlexusError::ExecutionError(format!(
853                "`{}.{method}` takes an input stream, and a hop to a remote child does not forward one yet",
854                self.name()
855            )));
856        }
857        Ok(self.forward(method, params, auth, None).await)
858    }
859
860    /// Nothing of its own on the socket: a child is reached through the
861    /// service's `{service}.call`, behind its gate.
862    fn into_rpc_methods(self) -> jsonrpsee::Methods {
863        jsonrpsee::Methods::new()
864    }
865
866    fn plugin_schema(&self) -> PluginSchema {
867        self.inner.schema.clone()
868    }
869
870    /// NEST-4: the kept tree — the host gates, lists and describes a mounted
871    /// child's children by their whole path, as it does an in-process
872    /// child's (MACRO-20, [`super::children`]).
873    fn static_child_schemas(&self) -> Vec<(String, PluginSchema)> {
874        self.inner.nodes.clone()
875    }
876}
877
878#[async_trait]
879impl ChildRouter for RemoteChild {
880    fn router_namespace(&self) -> &str {
881        self.name()
882    }
883
884    async fn router_call(&self, method: &str, params: Value, auth: Option<&AuthContext>, raw: Option<&crate::request::RawRequestContext>) -> Result<PlexusStream, PlexusError> {
885        Activation::call(self, method, params, auth, raw).await
886    }
887
888    async fn get_child(&self, _name: &str) -> Option<Box<dyn ChildRouter>> {
889        None
890    }
891
892    fn router_schema(&self) -> Option<PluginSchema> {
893        Some(self.inner.schema.clone())
894    }
895
896    fn router_static_child_schemas(&self) -> Vec<(String, PluginSchema)> {
897        self.inner.nodes.clone()
898    }
899}
900
901#[cfg(test)]
902mod tests {
903    use super::*;
904
905    fn raw(methods: Value, roles: Value) -> Value {
906        json!({ "namespace": "stub", "version": "0.1.0", "description": "d", "self_hash": "h", "hash": "h", "methods": methods, "roles": roles })
907    }
908
909    fn m(name: &str) -> Value {
910        json!({ "name": name, "description": "", "hash": "x", "streaming": false, "bidirectional": false })
911    }
912
913    /// RETURNS-36 (review #6): no guessing — a method that states neither
914    /// `cardinality` (0.8) nor `streaming` (0.7.0) is refused, naming it, as
915    /// plexus-protocol's `cardinalityOf` refuses it.
916    #[test]
917    fn a_method_stating_neither_cardinality_nor_streaming_is_refused() {
918        let silent = json!({ "name": "quiet", "description": "", "hash": "x" });
919        let e = mount_schema("echo", raw(json!([m("echo"), silent]), json!({}))).unwrap_err();
920        assert!(e.contains("`quiet`") && e.contains("neither cardinality"), "{e}");
921    }
922
923    #[test]
924    fn the_mount_name_wins_and_roles_are_requalified() {
925        let s = mount_schema("echo", raw(json!([m("echo"), m("shout")]), json!({ "viewer": ["stub.echo"], "editor": ["stub.echo", "stub.shout"] }))).unwrap();
926        assert_eq!(s.namespace, "echo");
927        assert_eq!(s.roles["viewer"], vec!["echo.echo".to_string()]);
928        assert_eq!(s.roles["editor"], vec!["echo.echo".to_string(), "echo.shout".to_string()]);
929    }
930
931    /// NEST-4: a child with children mounts; its child roles stay on it.
932    #[test]
933    fn a_child_with_children_mounts_and_its_method_grants_are_requalified() {
934        let mut inner = m("inner");
935        inner["role"] = json!({ "kind": "static_child" });
936        let mut own = m("echo");
937        own["grant"] = json!("stub.echo");
938        let s = mount_schema("echo", raw(json!([own, inner]), json!({}))).unwrap();
939        assert_eq!(s.methods[0].grant.as_deref(), Some("echo.echo"));
940        assert_eq!(s.methods[1].role, MethodRole::StaticChild);
941        let mut slot = m("item");
942        slot["role"] = json!({ "kind": "dynamic_child", "list_method": "names" });
943        let nested = raw(json!([m("echo"), s_inner(), slot]), json!({}));
944        assert_eq!(link::static_children(&nested), vec!["inner".to_string()], "a dynamic child is a slot, not walked");
945        // A service's root says its activations in `children` alone.
946        let mut root = raw(json!([m("call")]), json!({}));
947        root["children"] = json!([{ "namespace": "greeter", "description": "", "hash": "g" }]);
948        assert_eq!(link::static_children(&root), vec!["greeter".to_string()]);
949    }
950
951    fn s_inner() -> Value {
952        let mut inner = m("inner");
953        inner["role"] = json!({ "kind": "static_child" });
954        inner
955    }
956
957    /// NEST-4: the tree's hash moves with a grandchild's.
958    #[test]
959    fn the_tree_hash_covers_every_level() {
960        let top = raw(json!([m("echo")]), json!({}));
961        let flat = link::Kept { top: top.clone(), nodes: vec![] };
962        assert_eq!(flat.hash(), link::schema_hash(&top), "a flat child's hash is its schema's, as before");
963        let mut c = raw(json!([m("m")]), json!({}));
964        let one = link::Kept { top: top.clone(), nodes: vec![("a.b".into(), c.clone())] }.hash();
965        c["hash"] = json!("other");
966        let two = link::Kept { top, nodes: vec![("a.b".into(), c)] }.hash();
967        assert_ne!(one, two);
968    }
969
970    #[test]
971    fn typed_error_fields_cross_whole() {
972        let item = unavailable("echo", "gone");
973        let v = serde_json::to_value(&item).unwrap();
974        assert_eq!(v["error_kind"], "child_unavailable");
975        assert_eq!(v["code"], "child_unavailable");
976        assert_eq!(v["child"], "echo");
977        let back: PlexusStreamItem = serde_json::from_value(v.clone()).unwrap();
978        assert_eq!(back.error_kind(), Some("child_unavailable"));
979        assert_eq!(serde_json::to_value(&back).unwrap(), v);
980        // An error spec/05 gives no kind carries no `error_kind`: its keys
981        // are spec/05's four and RETURNS-6's typed `error` (RETURNS-36).
982        let plain = PlexusStreamItem::error(meta("x"), plexus_client::RemoteError::Execution { message: "m".into() }, false);
983        let pv = serde_json::to_value(&plain).unwrap();
984        let keys: Vec<_> = pv.as_object().unwrap().keys().cloned().collect();
985        assert_eq!(keys, ["code", "error", "message", "metadata", "recoverable", "type"]);
986    }
987}