aingle_minimal 0.6.2

Ultra-light AIngle node for IoT devices (<1MB RAM)
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
// Copyright 2019-2026 Apilium Technologies OÜ. All rights reserved.
// SPDX-License-Identifier: Apache-2.0 OR Commercial

//! Multi-protocol peer discovery for AIngle nodes
//!
//! Supports both mDNS/DNS-SD and CoAP multicast discovery for automatic
//! peer discovery on local networks.
//!
//! # Discovery Protocols
//! - **mDNS**: Service type `_aingle._udp.local.` (feature: mdns)
//! - **CoAP Multicast**: `/.well-known/core` to 224.0.1.187:5683 (feature: coap)

use crate::error::Result;
#[cfg(feature = "mdns")]
use crate::error::Error;
use std::collections::HashMap;
use std::net::{IpAddr, SocketAddr};
use std::time::{Duration, Instant};

#[cfg(feature = "mdns")]
use std::sync::{Arc, RwLock};

#[cfg(feature = "coap")]
use crate::coap::CoapServer;

#[cfg(feature = "mdns")]
use mdns_sd::{ServiceDaemon, ServiceEvent, ServiceInfo};

/// AIngle mDNS service type
pub const SERVICE_TYPE: &str = "_aingle._udp.local.";

/// Default mDNS port
pub const DEFAULT_PORT: u16 = 5353;

/// Discovered peer information
#[derive(Debug, Clone)]
pub struct DiscoveredPeer {
    /// Node ID (public key hex)
    pub node_id: String,
    /// IP addresses
    pub addresses: Vec<IpAddr>,
    /// Service port
    pub port: u16,
    /// When discovered
    pub discovered_at: Instant,
    /// Last seen
    pub last_seen: Instant,
    /// TXT record properties
    pub properties: HashMap<String, String>,
}

impl DiscoveredPeer {
    /// Get socket addresses for this peer
    pub fn socket_addrs(&self) -> Vec<SocketAddr> {
        self.addresses
            .iter()
            .map(|ip| SocketAddr::new(*ip, self.port))
            .collect()
    }

    /// Check if peer is still alive (seen within timeout)
    pub fn is_alive(&self, timeout: Duration) -> bool {
        self.last_seen.elapsed() < timeout
    }
}

/// mDNS Discovery service for finding AIngle peers
#[cfg(feature = "mdns")]
pub struct Discovery {
    /// Service daemon
    daemon: ServiceDaemon,
    /// Our node ID
    node_id: String,
    /// Our service port
    port: u16,
    /// Discovered peers
    peers: Arc<RwLock<HashMap<String, DiscoveredPeer>>>,
    /// Whether we're registered
    registered: bool,
    /// Shutdown flag
    running: Arc<std::sync::atomic::AtomicBool>,
}

#[cfg(feature = "mdns")]
impl Discovery {
    /// Create a new discovery service
    pub fn new(node_id: String, port: u16) -> Result<Self> {
        let daemon = ServiceDaemon::new()
            .map_err(|e| Error::network(format!("Failed to create mDNS daemon: {}", e)))?;

        Ok(Self {
            daemon,
            node_id,
            port,
            peers: Arc::new(RwLock::new(HashMap::new())),
            registered: false,
            running: Arc::new(std::sync::atomic::AtomicBool::new(false)),
        })
    }

    /// Register our service for discovery by others
    pub fn register(&mut self) -> Result<()> {
        if self.registered {
            return Ok(());
        }

        // Get local IP addresses
        let addresses: Vec<IpAddr> = if_addrs::get_if_addrs()
            .map_err(|e| Error::network(format!("Failed to get local addresses: {}", e)))?
            .into_iter()
            .filter(|iface| !iface.is_loopback())
            .map(|iface| iface.ip())
            .collect();

        if addresses.is_empty() {
            return Err(Error::network("No network interfaces available"));
        }

        // Create service instance name: node_id.service_type
        let instance_name = format!("aingle-{}", &self.node_id[..8.min(self.node_id.len())]);

        // Build TXT record properties
        let mut properties = HashMap::new();
        properties.insert("node_id".to_string(), self.node_id.clone());
        properties.insert("version".to_string(), crate::VERSION.to_string());
        properties.insert("protocol".to_string(), "coap".to_string());

        // Register service
        let service_info = ServiceInfo::new(
            SERVICE_TYPE,
            &instance_name,
            &format!("{}.local.", instance_name),
            &addresses[0].to_string(),
            self.port,
            properties,
        )
        .map_err(|e| Error::network(format!("Failed to create service info: {}", e)))?;

        self.daemon
            .register(service_info)
            .map_err(|e| Error::network(format!("Failed to register mDNS service: {}", e)))?;

        self.registered = true;
        log::info!(
            "Registered mDNS service: {} on port {}",
            instance_name,
            self.port
        );

        Ok(())
    }

    /// Start browsing for peers
    pub fn start_browsing(&mut self) -> Result<()> {
        self.running
            .store(true, std::sync::atomic::Ordering::SeqCst);

        let receiver = self
            .daemon
            .browse(SERVICE_TYPE)
            .map_err(|e| Error::network(format!("Failed to browse mDNS: {}", e)))?;

        let peers = self.peers.clone();
        let running = self.running.clone();
        let our_node_id = self.node_id.clone();

        // Spawn background task to handle discovery events
        std::thread::spawn(move || {
            loop {
                if !running.load(std::sync::atomic::Ordering::SeqCst) {
                    break;
                }

                // Try to receive with timeout, ignoring errors (timeout or disconnect)
                if let Ok(event) = receiver.recv_timeout(Duration::from_millis(100)) {
                    Self::handle_event(&peers, &our_node_id, event);
                }
            }
        });

        log::info!("Started mDNS peer discovery");
        Ok(())
    }

    /// Handle a discovery event
    fn handle_event(
        peers: &Arc<RwLock<HashMap<String, DiscoveredPeer>>>,
        our_node_id: &str,
        event: ServiceEvent,
    ) {
        match event {
            ServiceEvent::ServiceResolved(info) => {
                // Extract node_id from TXT record
                let node_id = info
                    .get_properties()
                    .get("node_id")
                    .map(|v| v.val_str().to_string())
                    .unwrap_or_else(|| info.get_fullname().to_string());

                // Skip ourselves
                if node_id == our_node_id {
                    return;
                }

                let addresses: Vec<IpAddr> = info.get_addresses().iter().map(|a| a.to_ip_addr()).collect();

                let mut props = HashMap::new();
                for prop in info.get_properties().iter() {
                    props.insert(prop.key().to_string(), prop.val_str().to_string());
                }

                let peer = DiscoveredPeer {
                    node_id: node_id.clone(),
                    addresses,
                    port: info.get_port(),
                    discovered_at: Instant::now(),
                    last_seen: Instant::now(),
                    properties: props,
                };

                log::info!(
                    "Discovered peer: {} at {:?}:{}",
                    node_id,
                    peer.addresses,
                    peer.port
                );

                if let Ok(mut peers) = peers.write() {
                    peers.insert(node_id, peer);
                }
            }
            ServiceEvent::ServiceRemoved(_service_type, fullname) => {
                // Try to find and remove the peer
                if let Ok(mut peers) = peers.write() {
                    // Remove by matching fullname prefix
                    peers.retain(|id, _| !fullname.contains(id));
                }
                log::debug!("Service removed: {}", fullname);
            }
            ServiceEvent::ServiceFound(_service_type, fullname) => {
                log::debug!("Service found: {}", fullname);
            }
            ServiceEvent::SearchStarted(_) => {
                log::debug!("mDNS search started");
            }
            ServiceEvent::SearchStopped(_) => {
                log::debug!("mDNS search stopped");
            }
            _ => {
                log::trace!("Unhandled mDNS event");
            }
        }
    }

    /// Get discovered peers
    pub fn get_peers(&self) -> Vec<DiscoveredPeer> {
        self.peers
            .read()
            .map(|peers| peers.values().cloned().collect())
            .unwrap_or_default()
    }

    /// Get alive peers (seen within timeout)
    pub fn get_alive_peers(&self, timeout: Duration) -> Vec<DiscoveredPeer> {
        self.get_peers()
            .into_iter()
            .filter(|p| p.is_alive(timeout))
            .collect()
    }

    /// Get socket addresses of all discovered peers
    pub fn get_peer_addrs(&self) -> Vec<SocketAddr> {
        self.get_peers()
            .into_iter()
            .flat_map(|p| p.socket_addrs())
            .collect()
    }

    /// Stop discovery
    pub fn stop(&mut self) -> Result<()> {
        self.running
            .store(false, std::sync::atomic::Ordering::SeqCst);

        if self.registered {
            // Unregister our service
            let instance_name = format!("aingle-{}", &self.node_id[..8.min(self.node_id.len())]);
            let _ = self
                .daemon
                .unregister(&format!("{}.{}", instance_name, SERVICE_TYPE));
            self.registered = false;
        }

        self.daemon.shutdown().ok();
        log::info!("Stopped mDNS discovery");
        Ok(())
    }

    /// Get peer count
    pub fn peer_count(&self) -> usize {
        self.peers.read().map(|p| p.len()).unwrap_or(0)
    }

    /// Discover peers using CoAP multicast (if coap feature enabled)
    #[cfg(feature = "coap")]
    pub async fn discover_coap_multicast(&self, coap_server: &mut CoapServer) -> Result<()> {
        coap_server.send_discovery().await?;
        log::info!("Sent CoAP multicast discovery request");
        Ok(())
    }

    /// Register discovered peer from CoAP discovery response
    pub fn register_coap_peer(&self, node_id: String, addr: SocketAddr) {
        if let Ok(mut peers) = self.peers.write() {
            let peer = DiscoveredPeer {
                node_id: node_id.clone(),
                addresses: vec![addr.ip()],
                port: addr.port(),
                discovered_at: Instant::now(),
                last_seen: Instant::now(),
                properties: {
                    let mut props = HashMap::new();
                    props.insert("protocol".to_string(), "coap".to_string());
                    props
                },
            };
            peers.insert(node_id.clone(), peer);
            log::info!("Registered CoAP peer: {} at {}", node_id, addr);
        }
    }
}

#[cfg(feature = "mdns")]
impl Drop for Discovery {
    fn drop(&mut self) {
        let _ = self.stop();
    }
}

/// Stub Discovery for when mdns feature is disabled
#[cfg(not(feature = "mdns"))]
#[allow(dead_code)]
pub struct Discovery {
    node_id: String,
    port: u16,
}

#[cfg(not(feature = "mdns"))]
impl Discovery {
    pub fn new(node_id: String, port: u16) -> Result<Self> {
        Ok(Self { node_id, port })
    }

    pub fn register(&mut self) -> Result<()> {
        log::warn!("mDNS not available (compile with --features mdns)");
        Ok(())
    }

    pub fn start_browsing(&mut self) -> Result<()> {
        log::warn!("mDNS browsing not available (compile with --features mdns)");
        Ok(())
    }

    pub fn get_peers(&self) -> Vec<DiscoveredPeer> {
        Vec::new()
    }

    pub fn get_alive_peers(&self, _timeout: Duration) -> Vec<DiscoveredPeer> {
        Vec::new()
    }

    pub fn get_peer_addrs(&self) -> Vec<SocketAddr> {
        Vec::new()
    }

    pub fn stop(&mut self) -> Result<()> {
        Ok(())
    }

    pub fn peer_count(&self) -> usize {
        0
    }

    /// Discover peers using CoAP multicast (stub)
    #[cfg(feature = "coap")]
    pub async fn discover_coap_multicast(&self, _coap_server: &mut CoapServer) -> Result<()> {
        log::warn!("mDNS not available, using CoAP multicast only");
        Ok(())
    }

    /// Register discovered peer from CoAP discovery response (stub)
    pub fn register_coap_peer(&self, _node_id: String, _addr: SocketAddr) {
        // No-op in stub
    }
}

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

    #[test]
    fn test_discovered_peer_socket_addrs() {
        let peer = DiscoveredPeer {
            node_id: "test123".to_string(),
            addresses: vec![
                "192.168.1.100".parse().unwrap(),
                "192.168.1.101".parse().unwrap(),
            ],
            port: 5683,
            discovered_at: Instant::now(),
            last_seen: Instant::now(),
            properties: HashMap::new(),
        };

        let addrs = peer.socket_addrs();
        assert_eq!(addrs.len(), 2);
        assert_eq!(addrs[0].port(), 5683);
    }

    #[test]
    fn test_discovered_peer_is_alive() {
        let peer = DiscoveredPeer {
            node_id: "test123".to_string(),
            addresses: vec!["192.168.1.100".parse().unwrap()],
            port: 5683,
            discovered_at: Instant::now(),
            last_seen: Instant::now(),
            properties: HashMap::new(),
        };

        assert!(peer.is_alive(Duration::from_secs(60)));
        assert!(peer.is_alive(Duration::from_millis(100)));
    }

    #[test]
    #[cfg(not(feature = "mdns"))]
    fn test_discovery_stub() {
        let mut discovery = Discovery::new("test-node".to_string(), 5683).unwrap();
        assert!(discovery.register().is_ok());
        assert!(discovery.start_browsing().is_ok());
        assert_eq!(discovery.get_peers().len(), 0);
        assert!(discovery.stop().is_ok());
    }
}