actr-cli 0.3.1

Command line tool for Actor-RTC framework projects
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
use crate::core::{
    AvailabilityStatus, HealthStatus, ProtoFile, ServiceDetails, ServiceDiscovery, ServiceFilter,
    ServiceInfo,
};
use actr_hyper::AisClient;
use actr_protocol::{
    AIdCredential, ActrId, ActrToSignaling, ActrType, DiscoveryRequest, ErrorResponse,
    GetServiceSpecRequest, Realm, RegisterAuthMode, RegisterRequest, SignalingEnvelope,
    actr_to_signaling, discovery_response, get_service_spec_response, register_response,
    signaling_envelope, signaling_to_actr,
};
use anyhow::{Context, Result, anyhow};
use async_trait::async_trait;
use base64::Engine as _;
use futures_util::{SinkExt, StreamExt};
use prost::Message;
use std::path::PathBuf;
use std::time::SystemTime;
use tokio::{
    sync::Mutex,
    time::{Duration, sleep},
};
use tokio_tungstenite::{connect_async, tungstenite::Message as WsMessage};
use url::Url;

type SignalingSocket =
    tokio_tungstenite::WebSocketStream<tokio_tungstenite::MaybeTlsStream<tokio::net::TcpStream>>;

struct SignalingState {
    socket: SignalingSocket,
    actr_id: ActrId,
    credential: AIdCredential,
}

/// Discovery context for CLI service discovery operations
///
/// This contains the minimal information needed for CLI to perform service discovery,
/// separate from runtime configuration (actr.toml).
#[derive(Debug, Clone)]
pub struct DiscoveryContext {
    /// Package actor type (from manifest.toml)
    pub package_actr_type: ActrType,

    /// Signaling server URL
    pub signaling_url: Url,

    /// AIS endpoint URL
    pub ais_endpoint: String,

    /// Realm for temporary actor registration
    pub realm: Realm,

    /// Optional realm secret for authentication
    pub realm_secret: Option<String>,
}

pub struct NetworkServiceDiscovery {
    context: DiscoveryContext,
    state: Mutex<Option<SignalingState>>,
}

impl NetworkServiceDiscovery {
    const LOOKUP_RETRY_ATTEMPTS: usize = 45;
    const LOOKUP_RETRY_DELAY: Duration = Duration::from_secs(2);

    pub fn new(context: DiscoveryContext) -> Self {
        Self {
            context,
            state: Mutex::new(None),
        }
    }

    fn format_actr_type(actr_type: &ActrType) -> String {
        actr_type.to_string_repr()
    }

    async fn ensure_connected(&self) -> Result<()> {
        let mut state_guard = self.state.lock().await;
        if state_guard.is_some() {
            return Ok(());
        }

        let state = self.connect_and_register().await?;
        *state_guard = Some(state);
        Ok(())
    }

    // TODO: add filter support
    async fn discover_entries(
        &self,
        _filter: Option<&ServiceFilter>,
    ) -> Result<Vec<discovery_response::TypeEntry>> {
        self.ensure_connected().await?;
        let mut state_guard = self.state.lock().await;
        let state = state_guard
            .as_mut()
            .context("Signaling state not initialized")?;

        // TODO: add filter support
        let request = DiscoveryRequest {
            manufacturer: None,
            limit: None,
        };
        let payload = actr_to_signaling::Payload::DiscoveryRequest(request);
        let envelope =
            Self::build_envelope(signaling_envelope::Flow::ActrToServer(ActrToSignaling {
                source: state.actr_id.clone(),
                credential: state.credential.clone(),
                payload: Some(payload),
            }))?;

        let result = match Self::send_envelope(&mut state.socket, envelope).await {
            Ok(()) => loop {
                let envelope = Self::read_envelope(&mut state.socket).await?;
                match envelope.flow {
                    Some(signaling_envelope::Flow::ServerToActr(server)) => match server.payload {
                        Some(signaling_to_actr::Payload::DiscoveryResponse(response)) => {
                            break Self::handle_discovery_response(response);
                        }
                        Some(signaling_to_actr::Payload::Error(error)) => {
                            break Err(Self::as_error("Discovery failed", &error));
                        }
                        _ => {}
                    },
                    Some(signaling_envelope::Flow::EnvelopeError(error)) => {
                        break Err(Self::as_error("Discovery failed", &error));
                    }
                    _ => {}
                }
            },
            Err(err) => Err(err),
        };
        if result.is_err() {
            *state_guard = None;
        }
        result
    }

    fn handle_discovery_response(
        response: actr_protocol::DiscoveryResponse,
    ) -> Result<Vec<discovery_response::TypeEntry>> {
        match response.result {
            Some(discovery_response::Result::Success(success)) => Ok(success.entries),
            Some(discovery_response::Result::Error(error)) => {
                Err(Self::as_error("Discovery failed", &error))
            }
            None => Err(anyhow!("Discovery response is missing result")),
        }
    }

    async fn connect_and_register(&self) -> Result<SignalingState> {
        let realm_secret = self.required_realm_secret()?.to_string();
        let register_request = self.build_linked_register_request();

        let ais_client = AisClient::new(&self.context.ais_endpoint).with_realm_secret(realm_secret);

        let register_response = ais_client
            .register_linked(register_request)
            .await
            .map_err(|err| anyhow!("AIS HTTP registration failed: {err}"))?;

        let (actr_id, credential) = match register_response.result {
            Some(register_response::Result::Success(success)) => {
                (success.actr_id, success.credential)
            }
            Some(register_response::Result::Error(error)) => {
                return Err(Self::as_error("AIS registration failed", &error));
            }
            None => return Err(anyhow!("AIS registration response is missing result")),
        };

        let signaling_url = Self::build_signaling_url_with_identity(
            &self.context.signaling_url,
            &actr_id,
            &credential,
        );
        let (socket, _) = connect_async(signaling_url.as_str())
            .await
            .with_context(|| format!("Failed to connect to signaling: {signaling_url}"))?;

        Ok(SignalingState {
            socket,
            actr_id,
            credential,
        })
    }

    fn build_signaling_url_with_identity(
        signaling_url: &Url,
        actr_id: &ActrId,
        credential: &AIdCredential,
    ) -> Url {
        let mut url = signaling_url.clone();
        let claims_b64 = base64::engine::general_purpose::STANDARD.encode(&credential.claims);
        let signature_b64 = base64::engine::general_purpose::STANDARD.encode(&credential.signature);

        url.query_pairs_mut()
            .append_pair("actor_id", &actr_id.to_string_repr())
            .append_pair("key_id", &credential.key_id.to_string())
            .append_pair("claims", &claims_b64)
            .append_pair("signature", &signature_b64);

        url
    }

    fn as_error(context: &str, error: &ErrorResponse) -> anyhow::Error {
        anyhow!("{context}: {} ({})", error.message, error.code)
    }

    async fn retry_lookup<T, F, Fut>(&self, context: &str, mut lookup: F) -> Result<T>
    where
        F: FnMut() -> Fut,
        Fut: std::future::Future<Output = Result<Option<T>>>,
    {
        let mut last_error = None;

        for attempt in 0..Self::LOOKUP_RETRY_ATTEMPTS {
            match lookup().await {
                Ok(Some(value)) => return Ok(value),
                Ok(None) => last_error = Some(anyhow!("{context}")),
                Err(err) => last_error = Some(err),
            }

            if attempt + 1 < Self::LOOKUP_RETRY_ATTEMPTS {
                sleep(Self::LOOKUP_RETRY_DELAY).await;
            }
        }

        Err(last_error.unwrap_or_else(|| anyhow!("{context}")))
    }

    async fn send_envelope(
        socket: &mut SignalingSocket,
        envelope: SignalingEnvelope,
    ) -> Result<()> {
        let mut buf = Vec::new();
        envelope
            .encode(&mut buf)
            .context("Failed to encode signaling envelope")?;
        socket
            .send(WsMessage::Binary(buf.into()))
            .await
            .context("Failed to send signaling envelope")?;
        Ok(())
    }

    async fn read_envelope(socket: &mut SignalingSocket) -> Result<SignalingEnvelope> {
        while let Some(message) = socket.next().await {
            match message.context("Failed to read signaling response")? {
                WsMessage::Binary(bytes) => {
                    return SignalingEnvelope::decode(bytes)
                        .context("Failed to decode signaling envelope");
                }
                WsMessage::Close(_) => {
                    return Err(anyhow!("Signaling connection closed"));
                }
                WsMessage::Ping(_) | WsMessage::Pong(_) => {}
                WsMessage::Text(text) => {
                    return Err(anyhow!("Unexpected text message from signaling: {text}"));
                }
                WsMessage::Frame(_) => {}
            }
        }

        Err(anyhow!("Signaling connection closed"))
    }

    fn build_envelope(flow: signaling_envelope::Flow) -> Result<SignalingEnvelope> {
        Ok(SignalingEnvelope {
            envelope_version: 1,
            envelope_id: uuid::Uuid::new_v4().to_string(),
            reply_for: None,
            timestamp: prost_types::Timestamp {
                seconds: chrono::Utc::now().timestamp(),
                nanos: 0,
            },
            traceparent: None,
            tracestate: None,
            flow: Some(flow),
        })
    }

    fn select_version(entry: &discovery_response::TypeEntry) -> String {
        entry
            .tags
            .iter()
            .find(|tag| tag.as_str() == "latest")
            .cloned()
            .or_else(|| entry.tags.first().cloned())
            .unwrap_or_else(|| "unknown".to_string())
    }

    fn matches_filter(entry: &discovery_response::TypeEntry, filter: &ServiceFilter) -> bool {
        if let Some(pattern) = &filter.name_pattern {
            let full_name = Self::format_actr_type(&entry.actr_type);
            let matches = Self::matches_pattern(&entry.name, pattern)
                || Self::matches_pattern(&full_name, pattern);
            if !matches {
                return false;
            }
        }

        if let Some(version_range) = &filter.version_range
            && Self::select_version(entry) != *version_range
            && !entry.tags.iter().any(|tag| tag == version_range)
        {
            return false;
        }

        if let Some(tags) = &filter.tags {
            let has_all = tags.iter().all(|tag| entry.tags.iter().any(|t| t == tag));
            if !has_all {
                return false;
            }
        }

        true
    }

    fn matches_pattern(value: &str, pattern: &str) -> bool {
        if pattern == "*" {
            return true;
        }

        let segments: Vec<&str> = pattern.split('*').collect();
        if segments.len() == 1 {
            return value == pattern;
        }

        if !pattern.starts_with('*')
            && let Some(first) = segments.first()
            && !value.starts_with(first)
        {
            return false;
        }

        if !pattern.ends_with('*')
            && let Some(last) = segments.last()
            && !value.ends_with(last)
        {
            return false;
        }

        let mut search_start = 0;
        let end_limit = if !pattern.ends_with('*') {
            value
                .len()
                .saturating_sub(segments.last().unwrap_or(&"").len())
        } else {
            value.len()
        };

        for (index, segment) in segments.iter().enumerate() {
            if segment.is_empty() {
                continue;
            }
            if index == 0 && !pattern.starts_with('*') {
                search_start = segment.len();
                continue;
            }
            if index == segments.len() - 1 && !pattern.ends_with('*') {
                continue;
            }
            if let Some(found) = value[search_start..end_limit].find(segment) {
                search_start += found + segment.len();
            } else {
                return false;
            }
        }

        true
    }

    fn matches_lookup_name(entry: &discovery_response::TypeEntry, name: &str) -> bool {
        if entry.name == name || Self::format_actr_type(&entry.actr_type) == name {
            return true;
        }

        let Ok(lookup_type) = ActrType::from_string_repr(name) else {
            return false;
        };

        entry.actr_type == lookup_type
    }

    fn required_realm_secret(&self) -> Result<&str> {
        self.context
            .realm_secret
            .as_deref()
            .map(str::trim)
            .filter(|secret| !secret.is_empty())
            .ok_or_else(|| {
                anyhow!("network.realm_secret is required for CLI service discovery registration")
            })
    }

    fn build_linked_register_request(&self) -> RegisterRequest {
        RegisterRequest {
            actr_type: self.context.package_actr_type.clone(),
            realm: self.context.realm,
            service_spec: None,
            service: None,
            acl: None,
            ws_address: None,
            manifest_raw: None,
            mfr_signature: None,
            psk_token: None,
            target: None,
            auth_mode: Some(RegisterAuthMode::Linked as i32),
        }
    }
}

#[async_trait]
impl ServiceDiscovery for NetworkServiceDiscovery {
    async fn discover_services(&self, filter: Option<&ServiceFilter>) -> Result<Vec<ServiceInfo>> {
        let entries = self.discover_entries(filter).await?;
        let services = entries
            .into_iter()
            .filter(|entry| match filter {
                Some(filter) => Self::matches_filter(entry, filter),
                None => true,
            })
            .map(ServiceInfo::from)
            .collect();
        Ok(services)
    }

    async fn get_service_details(&self, name: &str) -> Result<ServiceDetails> {
        let entry = self
            .retry_lookup(&format!("Service not found: {name}"), || async {
                let entries = self.discover_entries(None).await?;
                Ok(entries
                    .into_iter()
                    .find(|entry| Self::matches_lookup_name(entry, name)))
            })
            .await?;
        let info = ServiceInfo::from(entry.clone());

        // Try to get ServiceSpec with proto files
        // Use actr_type.name (e.g., "EchoService") as the lookup key,
        // matching package ServiceSpec.name = package.name
        let spec_lookup_name = &entry.actr_type.name;
        let proto_files = match self.get_service_proto(spec_lookup_name).await {
            Ok(proto_files) => proto_files,
            Err(e) => {
                tracing::warn!("Failed to get ServiceSpec for {name}: {e}");
                Vec::new()
            }
        };

        Ok(ServiceDetails {
            info,
            proto_files,
            dependencies: Vec::new(),
        })
    }

    // TODO: improve the performance of this method
    async fn check_service_availability(&self, name: &str) -> Result<AvailabilityStatus> {
        let available = self
            .retry_lookup(&format!("Service not found: {name}"), || async {
                let entries = self.discover_entries(None).await?;
                Ok(entries
                    .into_iter()
                    .any(|entry| Self::matches_lookup_name(&entry, name))
                    .then_some(true))
            })
            .await
            .unwrap_or(false);

        Ok(AvailabilityStatus {
            is_available: available,
            last_seen: available.then(SystemTime::now),
            health: if available {
                HealthStatus::Healthy
            } else {
                HealthStatus::Unknown
            },
        })
    }

    async fn get_service_proto(&self, name: &str) -> Result<Vec<ProtoFile>> {
        self.retry_lookup(&format!("Get service spec failed: {name}"), || async {
            self.ensure_connected().await?;
            let mut state_guard = self.state.lock().await;
            let state = state_guard
                .as_mut()
                .context("Signaling state not initialized")?;

            let request = GetServiceSpecRequest {
                name: name.to_string(),
            };
            let payload = actr_to_signaling::Payload::GetServiceSpecRequest(request);
            let envelope =
                Self::build_envelope(signaling_envelope::Flow::ActrToServer(ActrToSignaling {
                    source: state.actr_id.clone(),
                    credential: state.credential.clone(),
                    payload: Some(payload),
                }))?;

            let result = match Self::send_envelope(&mut state.socket, envelope).await {
                Ok(()) => loop {
                    let envelope = Self::read_envelope(&mut state.socket).await?;
                    match envelope.flow {
                        Some(signaling_envelope::Flow::ServerToActr(server)) => {
                            match server.payload {
                                Some(signaling_to_actr::Payload::GetServiceSpecResponse(
                                    response,
                                )) => {
                                    let proto_files = match response.result {
                                        Some(get_service_spec_response::Result::Success(
                                            success,
                                        )) => success
                                            .protobufs
                                            .into_iter()
                                            .map(|p| ProtoFile {
                                                name: format!("{}.proto", p.package),
                                                path: PathBuf::new(),
                                                content: p.content,
                                                services: Vec::new(),
                                            })
                                            .collect::<Vec<_>>(),
                                        Some(get_service_spec_response::Result::Error(error)) => {
                                            break Err(Self::as_error(
                                                "Get service spec failed",
                                                &error,
                                            ));
                                        }
                                        None => {
                                            break Err(anyhow!(
                                                "Get service spec response is missing result"
                                            ));
                                        }
                                    };
                                    break Ok(Some(proto_files));
                                }
                                Some(signaling_to_actr::Payload::Error(error)) => {
                                    break Err(Self::as_error("Get service spec failed", &error));
                                }
                                _ => {}
                            }
                        }
                        Some(signaling_envelope::Flow::EnvelopeError(error)) => {
                            break Err(Self::as_error("Get service spec failed", &error));
                        }
                        _ => {}
                    }
                },
                Err(err) => Err(err),
            };

            if result.is_err() {
                *state_guard = None;
            }

            result
        })
        .await
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use actr_protocol::Realm;

    fn sample_context(realm_secret: Option<&str>) -> DiscoveryContext {
        DiscoveryContext {
            package_actr_type: ActrType {
                manufacturer: "acme".to_string(),
                name: "cli-client".to_string(),
                version: "1.0.0".to_string(),
            },
            signaling_url: Url::parse("ws://localhost:8081/signaling/ws").unwrap(),
            ais_endpoint: "http://localhost:8081/ais".to_string(),
            realm: Realm { realm_id: 1001 },
            realm_secret: realm_secret.map(str::to_string),
        }
    }

    fn sample_actor_id() -> ActrId {
        ActrId {
            serial_number: 42,
            r#type: ActrType {
                manufacturer: "acme".to_string(),
                name: "echo".to_string(),
                version: "1.0.0".to_string(),
            },
            realm: Realm { realm_id: 1001 },
        }
    }

    fn sample_credential() -> AIdCredential {
        AIdCredential {
            key_id: 7,
            claims: vec![1, 2, 3, 4].into(),
            signature: vec![5, 6, 7, 8].into(),
        }
    }

    #[test]
    fn build_signaling_url_with_identity_appends_auth_query() {
        let signaling_url = Url::parse("ws://localhost:8081/signaling/ws?existing=1").unwrap();
        let actor_id = sample_actor_id();
        let credential = sample_credential();

        let authenticated_url = NetworkServiceDiscovery::build_signaling_url_with_identity(
            &signaling_url,
            &actor_id,
            &credential,
        );
        let query_pairs: std::collections::HashMap<_, _> =
            authenticated_url.query_pairs().into_owned().collect();

        assert_eq!(query_pairs.get("existing"), Some(&"1".to_string()));
        assert_eq!(
            query_pairs.get("actor_id"),
            Some(&actor_id.to_string_repr())
        );
        assert_eq!(query_pairs.get("key_id"), Some(&"7".to_string()));
        assert_eq!(
            query_pairs.get("claims"),
            Some(&base64::engine::general_purpose::STANDARD.encode([1, 2, 3, 4]))
        );
        assert_eq!(
            query_pairs.get("signature"),
            Some(&base64::engine::general_purpose::STANDARD.encode([5, 6, 7, 8]))
        );
    }

    #[test]
    fn cli_discovery_register_request_uses_linked_auth_mode() {
        let discovery = NetworkServiceDiscovery::new(sample_context(Some("rs_test_secret")));
        let request = discovery.build_linked_register_request();

        assert_eq!(request.auth_mode, Some(RegisterAuthMode::Linked as i32));
        assert_eq!(request.manifest_raw, None);
        assert_eq!(request.mfr_signature, None);
        assert_eq!(request.psk_token, None);
        assert_eq!(request.target, None);
        assert_eq!(request.actr_type.name, "cli-client");
        assert_eq!(request.realm.realm_id, 1001);
    }

    #[test]
    fn cli_discovery_requires_realm_secret() {
        let missing = NetworkServiceDiscovery::new(sample_context(None));
        let err = missing.required_realm_secret().unwrap_err();
        assert!(err.to_string().contains("network.realm_secret is required"));

        let blank = NetworkServiceDiscovery::new(sample_context(Some("   ")));
        let err = blank.required_realm_secret().unwrap_err();
        assert!(err.to_string().contains("network.realm_secret is required"));
    }
}