plexus_core/plexus/remote_child/
spec.rs1use std::fmt;
5use std::path::PathBuf;
6use std::str::FromStr;
7use std::time::Duration;
8
9#[derive(Debug, Clone, PartialEq, Eq)]
16pub enum ChildSpec {
17 Stdio { name: String, argv: Vec<String> },
19 Ws { name: String, url: String },
21}
22
23impl ChildSpec {
24 pub fn name(&self) -> &str {
26 match self {
27 Self::Stdio { name, .. } | Self::Ws { name, .. } => name,
28 }
29 }
30}
31
32impl fmt::Display for ChildSpec {
33 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
34 match self {
35 Self::Stdio { name, argv } => write!(f, "{name}=stdio:{}", shell_words::join(argv)),
36 Self::Ws { name, url } => write!(f, "{name}={url}"),
37 }
38 }
39}
40
41fn spec_err(s: &str, why: impl fmt::Display) -> ChildError {
42 ChildError::Spec(format!("`{s}`: {why}"))
43}
44
45impl FromStr for ChildSpec {
46 type Err = ChildError;
47
48 fn from_str(s: &str) -> Result<Self, ChildError> {
49 let (name, rest) = s.split_once('=').ok_or_else(|| spec_err(s, "no `=`: a child is NAME=stdio:CMD or NAME=ws://HOST:PORT"))?;
50 let name = name.trim();
51 if name.is_empty() {
52 return Err(spec_err(s, "an empty mount name"));
53 }
54 if name.contains('.') {
55 return Err(spec_err(s, format!("the mount name `{name}` is dotted: it is one segment (a method's path is `{name}.<method>`)")));
56 }
57 if let Some(bad) = name.chars().find(|c| !(c.is_ascii_alphanumeric() || *c == '_' || *c == '-')) {
58 return Err(spec_err(s, format!("the mount name `{name}` holds `{bad}`: only letters, digits, `_` and `-`")));
59 }
60 let name = name.to_string();
61 if let Some(cmd) = rest.strip_prefix("stdio:") {
62 let mut argv = shell_words::split(cmd).map_err(|e| spec_err(s, format!("its command does not split: {e}")))?;
63 if argv.len() == 1 && argv[0].contains(char::is_whitespace) {
66 argv = shell_words::split(&argv[0]).map_err(|e| spec_err(s, format!("its command does not split: {e}")))?;
67 }
68 if argv.is_empty() {
69 return Err(spec_err(s, "no command after `stdio:`"));
70 }
71 return Ok(Self::Stdio { name, argv });
72 }
73 if rest.starts_with("ws://") || rest.starts_with("wss://") {
74 let host = rest.split_once("://").map(|(_, h)| h).unwrap_or("");
75 let host = host.split(['/', '?', '#']).next().unwrap_or("");
76 if host.is_empty() || host.starts_with(':') {
77 return Err(spec_err(s, "a WebSocket child names its host: ws://HOST:PORT"));
78 }
79 return Ok(Self::Ws { name, url: rest.to_string() });
80 }
81 let scheme = rest.split_once(':').map(|(a, _)| a).unwrap_or(rest);
82 Err(spec_err(s, format!("unknown scheme `{scheme}`: a child is reached by `stdio:CMD`, `ws://…` or `wss://…`")))
83 }
84}
85
86#[derive(Debug, Clone, Copy, PartialEq, Eq)]
91pub struct Backoff {
92 pub initial: Duration,
93 pub max: Duration,
94 pub per_minute: usize,
95}
96
97impl Default for Backoff {
98 fn default() -> Self {
100 Self { initial: Duration::from_millis(500), max: Duration::from_secs(30), per_minute: 5 }
101 }
102}
103
104impl Backoff {
105 pub fn delay(&self, n: usize) -> Duration {
107 let factor = 1u32.checked_shl(n.min(31) as u32).unwrap_or(u32::MAX);
108 self.initial.saturating_mul(factor).min(self.max)
109 }
110}
111
112#[derive(Debug, Clone)]
114pub struct ChildOptions {
115 pub principal: String,
119 pub key: Option<PathBuf>,
123 pub agent: String,
125 pub timeout: Duration,
127 pub max_calls: usize,
129 pub buffer: usize,
132 pub env: Vec<String>,
135 pub backoff: Backoff,
137 pub max_depth: usize,
140 pub schema_cache: usize,
144 pub host: Option<crate::plexus::service_scope::WeakService>,
149 pub ping: Option<Duration>,
153}
154
155impl Default for ChildOptions {
156 fn default() -> Self {
157 Self {
158 principal: "service:service".into(),
159 key: None,
160 agent: "service".into(),
161 timeout: Duration::from_secs(5),
162 max_calls: 1024,
163 buffer: 1024,
164 env: Vec::new(),
165 backoff: Backoff::default(),
166 max_depth: 8,
167 schema_cache: 1024,
168 host: None,
169 ping: None,
170 }
171 }
172}
173
174impl ChildOptions {
175 pub fn for_service(service: &str) -> Self {
178 Self { principal: format!("service:{service}"), agent: service.to_string(), ..Self::default() }
179 }
180
181 pub fn with_host(mut self, service: &crate::plexus::DynamicHub) -> Self {
184 self.host = Some(service.downgrade());
185 self
186 }
187}
188
189#[derive(Debug, Clone, thiserror::Error, PartialEq, Eq)]
191pub enum ChildError {
192 #[error("child spec {0}")]
194 Spec(String),
195 #[error("child {0}: {1}")]
198 Start(String, String),
199}
200
201pub fn parse_duration(s: &str) -> Result<Duration, String> {
203 let s = s.trim();
204 let (num, unit) = match s.find(|c: char| !(c.is_ascii_digit() || c == '.')) {
205 Some(i) => (&s[..i], s[i..].trim()),
206 None => (s, "s"),
207 };
208 let n: f64 = num.parse().map_err(|_| format!("`{s}` is not a duration (5s, 500ms, 2m)"))?;
209 let secs = match unit {
210 "ms" => n / 1e3,
211 "s" | "" => n,
212 "m" => n * 60.0,
213 _ => return Err(format!("`{s}`: the unit is ms, s or m")),
214 };
215 if !secs.is_finite() || secs <= 0.0 {
216 return Err(format!("`{s}` is not a positive duration"));
217 }
218 Ok(Duration::from_secs_f64(secs))
219}
220
221#[cfg(test)]
222mod tests {
223 use super::*;
224
225 #[test]
226 fn child_spec_parses() {
227 let s: ChildSpec = r#"echo=stdio:python -I -m echo --x "a b""#.parse().unwrap();
228 assert_eq!(s, ChildSpec::Stdio { name: "echo".into(), argv: vec!["python".into(), "-I".into(), "-m".into(), "echo".into(), "--x".into(), "a b".into()] });
229 let s: ChildSpec = r#"echo=stdio:"python3 -I stub.py --stdio""#.parse().unwrap();
230 assert_eq!(s, ChildSpec::Stdio { name: "echo".into(), argv: vec!["python3".into(), "-I".into(), "stub.py".into(), "--stdio".into()] });
231 assert_eq!("echo=ws://h:1".parse::<ChildSpec>().unwrap(), ChildSpec::Ws { name: "echo".into(), url: "ws://h:1".into() });
232 assert_eq!("e-2=wss://h/ws".parse::<ChildSpec>().unwrap(), ChildSpec::Ws { name: "e-2".into(), url: "wss://h/ws".into() });
233 let refused = |s: &str, why: &str| {
234 let e = s.parse::<ChildSpec>().unwrap_err().to_string();
235 assert!(e.contains(why), "{s}: {e}");
236 };
237 refused("echo", "no `=`");
238 refused("=stdio:x", "empty mount name");
239 refused("a.b=stdio:x", "dotted");
240 refused("a b=stdio:x", "holds ` `");
241 refused("echo=tcp://h:1", "unknown scheme `tcp`");
242 refused("echo=stdio:", "no command");
243 refused(r#"echo=stdio:python "unclosed"#, "does not split");
244 refused("echo=ws://:1", "names its host");
245 }
246
247 #[test]
248 fn child_spec_round_trips() {
249 for s in [r#"echo=stdio:python -I "a b""#, "echo=ws://127.0.0.1:4480"] {
250 let spec: ChildSpec = s.parse().unwrap();
251 assert_eq!(spec.to_string().parse::<ChildSpec>().unwrap(), spec);
252 }
253 }
254
255 #[test]
256 fn backoff_doubles_to_its_cap() {
257 let b = Backoff::default();
258 let ms: Vec<u128> = (0..8).map(|n| b.delay(n).as_millis()).collect();
259 assert_eq!(ms, [500, 1000, 2000, 4000, 8000, 16000, 30000, 30000]);
260 }
261
262 #[test]
263 fn durations_read() {
264 assert_eq!(parse_duration("5s").unwrap(), Duration::from_secs(5));
265 assert_eq!(parse_duration("250ms").unwrap(), Duration::from_millis(250));
266 assert_eq!(parse_duration("2").unwrap(), Duration::from_secs(2));
267 assert_eq!(parse_duration("1m").unwrap(), Duration::from_secs(60));
268 assert!(parse_duration("0s").is_err() && parse_duration("x").is_err() && parse_duration("3h").is_err());
269 }
270}