hive-discovery 0.1.0

Hive Discovery is a lightweight service discovery library written in Rust, providing cross-platform network service discovery functionality with support for mDNS/DNS-SD protocols.
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
use std::collections::{BTreeMap, BTreeSet, HashMap, HashSet};
use std::net::SocketAddr;
use std::sync::{Arc, RwLock};
use std::thread;
use std::time::{Duration, SystemTime, UNIX_EPOCH};

use log::{debug, error, info, warn};
use mdns_sd::{ServiceDaemon, ServiceEvent, ServiceInfo};
use tokio::sync::broadcast;

use crate::error::{HiveDiscoError, Result};
use crate::types::{DiscoveryEvent, DiscoveryServiceDetails, DiscoveryServiceStatus};
use crate::{DiscoveryService, LocalServiceConfig};

/// Internal state for the mDNS service.
struct MdnsServiceState {
    /// Current operational status of the discovery service.
    status: DiscoveryServiceStatus,
    /// Set of instance names to filter out from discovery events.
    filter: HashSet<String>,
    /// Hashes of discovered services to detect changes.
    service_hashes: HashMap<String, u64>,
}

/// An mDNS/DNS-SD protocol-based service discovery implementation.
pub struct MdnsDiscoveryService {
    mdns: Arc<ServiceDaemon>,
    config: LocalServiceConfig,
    sender: broadcast::Sender<DiscoveryEvent>,
    discovered_services: Arc<RwLock<HashMap<String, DiscoveryServiceDetails>>>,
    state: Arc<RwLock<MdnsServiceState>>,
    own_instance_name: Arc<RwLock<Option<String>>>,
    discovery_started_sent: Arc<RwLock<bool>>,
}

impl MdnsDiscoveryService {
    /// Creates a new `MdnsDiscoveryService` instance.
    ///
    /// # Arguments
    /// * `config` - Configuration for the local service to be registered and for discovery parameters.
    ///
    /// # Errors
    /// Returns `HiveDiscoError::ConfigError` if the configuration is invalid.
    /// Returns `HiveDiscoError::MdnsError` if the mDNS daemon fails to initialize.
    pub fn new(config: LocalServiceConfig) -> Result<Self> {
        // Validate configuration
        if config.service_type.is_empty() {
            return Err(HiveDiscoError::ConfigError(
                "Service type cannot be empty".into(),
            ));
        }

        if config.instance_name.is_empty() {
            return Err(HiveDiscoError::ConfigError(
                "Instance name cannot be empty".into(),
            ));
        }

        // Create mDNS service daemon
        let mdns = ServiceDaemon::new().map_err(|e| {
            error!("Failed to create mDNS service daemon: {}", e);
            HiveDiscoError::MdnsError(e)
        })?;

        // Create event channel with a buffer size of 100
        let (sender, _) = broadcast::channel(100);

        let service = MdnsDiscoveryService {
            mdns: Arc::new(mdns),
            config,
            sender,
            discovered_services: Arc::new(RwLock::new(HashMap::new())),
            state: Arc::new(RwLock::new(MdnsServiceState {
                status: DiscoveryServiceStatus::Stopped,
                filter: HashSet::new(),
                service_hashes: HashMap::new(),
            })),
            own_instance_name: Arc::new(RwLock::new(None)),
            discovery_started_sent: Arc::new(RwLock::new(false)),
        };

        Ok(service)
    }

    /// Starts a background task to clean up expired services.
    /// This task periodically checks `discovered_services` and removes services
    /// whose `last_seen` timestamp exceeds the configured `service_ttl`.
    fn start_cleanup_task(&self) -> Result<()> {
        let services = Arc::clone(&self.discovered_services);
        let sender = self.sender.clone();
        let ttl = self.config.service_ttl;
        let state = Arc::clone(&self.state);

        thread::spawn(move || {
            debug!("Starting service cleanup task");

            // Run cleanup loop until service status is no longer Running
            loop {
                {
                    // Check service status
                    let state_guard = state.read().unwrap();
                    if state_guard.status != DiscoveryServiceStatus::Running {
                        break;
                    }
                }

                // Check every second
                thread::sleep(Duration::from_secs(1));

                let mut services_to_remove = Vec::new();
                let now = SystemTime::now()
                    .duration_since(UNIX_EPOCH)
                    .unwrap_or_default()
                    .as_secs();

                // Mark services for removal
                {
                    let services_map = services.read().unwrap();

                    for (id, service) in services_map.iter() {
                        if let Some(last_seen) = service.last_seen {
                            if now - last_seen > ttl {
                                debug!("Service {} has expired", id);
                                services_to_remove.push(id.clone());
                            }
                        }
                    }
                }

                // If there are expired services, remove them
                if !services_to_remove.is_empty() {
                    let mut services_map = services.write().unwrap();

                    for id in &services_to_remove {
                        services_map.remove(id);
                    }

                    // Send service removal event
                    for id in services_to_remove {
                        if let Err(e) = sender.send(DiscoveryEvent::ServiceLost(id.clone())) {
                            warn!(
                                "Failed to send service removal event: {}, Service ID: {}",
                                e, id
                            );
                        }
                    }
                }
            }

            debug!("Service cleanup task stopped");
        });

        Ok(())
    }

    /// Calculates a hash for `DiscoveryServiceDetails` to detect changes.
    fn calculate_service_hash(service: &DiscoveryServiceDetails) -> u64 {
        use std::collections::hash_map::DefaultHasher;
        use std::hash::{Hash, Hasher};

        let mut hasher = DefaultHasher::new();
        service.service_type.hash(&mut hasher);
        service.instance_name.hash(&mut hasher);
        service.domain_name.hash(&mut hasher);
        service.host_name.hash(&mut hasher);
        service.addresses.hash(&mut hasher);
        service.socket_addresses.hash(&mut hasher);
        service.port.hash(&mut hasher);
        service.properties.hash(&mut hasher);
        hasher.finish()
    }

    /// Handles incoming mDNS service events from the `ServiceDaemon`.
    fn handle_service_event(
        event: ServiceEvent,
        services: &Arc<RwLock<HashMap<String, DiscoveryServiceDetails>>>,
        sender: &broadcast::Sender<DiscoveryEvent>,
        state: &Arc<RwLock<MdnsServiceState>>,
        service_type: &str,
    ) {
        match event {
            ServiceEvent::ServiceFound(type_domain, fullname) => {
                // Check if the service type matches the one we are browsing for.
                if type_domain != service_type {
                    debug!(
                        "Ignoring mismatched service type: {} (expected: {})",
                        type_domain, service_type
                    );
                    return;
                }

                // Early filter check based on instance name (if configured)
                {
                    let state_guard = state.read().unwrap();
                    if state_guard.filter.contains(&fullname) {
                        debug!(
                            "Service {} (unresolved) is filtered by instance name, ignoring.",
                            fullname
                        );
                        return;
                    }
                }
                debug!("Service found (unresolved): {} ({})", fullname, type_domain);
            }

            ServiceEvent::ServiceResolved(info) => {
                // Check if the resolved service type matches.
                if info.get_type() != service_type {
                    debug!(
                        "Ignoring mismatched resolved service type: {} (expected: {})",
                        info.get_type(),
                        service_type
                    );
                    return;
                }

                let id = info.get_fullname().to_string();

                // Extract properties from TXT records.
                let properties = info
                    .get_properties()
                    .iter()
                    .map(|prop| (prop.key().to_string(), prop.val_str().to_string()))
                    .collect::<BTreeMap<_, _>>();

                // Check if this service instance name is in the general filter list.
                let should_filter = {
                    let state_guard = state.read().unwrap();
                    state_guard.filter.contains(&id)
                };

                if should_filter {
                    debug!("Service {} is filtered by instance name, ignoring.", id);
                    return;
                }

                // Get current timestamp.
                let now = SystemTime::now()
                    .duration_since(UNIX_EPOCH)
                    .unwrap_or_default()
                    .as_secs();

                let service_details = DiscoveryServiceDetails {
                    service_type: info.get_type().to_string(),
                    instance_name: id.clone(),
                    domain_name: ".local.".to_string(),
                    host_name: Some(info.get_hostname().to_string()),
                    addresses: info
                        .get_addresses()
                        .iter()
                        .cloned()
                        .collect::<BTreeSet<_>>(),
                    socket_addresses: info
                        .get_addresses()
                        .iter()
                        .map(|&addr| SocketAddr::new(addr, info.get_port()))
                        .collect::<BTreeSet<_>>(),
                    port: info.get_port(),
                    properties,
                    last_seen: Some(now),
                };

                // Calculate the hash of the current service details.
                let current_hash = Self::calculate_service_hash(&service_details);

                let mut services_map_guard = services.write().unwrap();
                let mut state_guard = state.write().unwrap();

                let previous_hash = state_guard.service_hashes.get(&id).cloned();
                let mut send_event = false;

                if let Some(existing_service) = services_map_guard.get_mut(&id) {
                    existing_service.last_seen = Some(now);

                    if previous_hash.map_or(true, |hash| hash != current_hash) {
                        *existing_service = service_details.clone();
                        state_guard.service_hashes.insert(id.clone(), current_hash);
                        send_event = true;
                        debug!("Service {} updated, sending ServiceFound event.", id);
                    } else {
                        debug!(
                            "Service {} re-confirmed (unchanged), last_seen updated.",
                            id
                        );
                    }
                } else {
                    services_map_guard.insert(id.clone(), service_details.clone());
                    state_guard.service_hashes.insert(id.clone(), current_hash);
                    send_event = true;
                    debug!(
                        "Service {} newly discovered, sending ServiceFound event.",
                        id
                    );
                }

                drop(services_map_guard);
                drop(state_guard);

                if send_event {
                    if let Err(e) = sender.send(DiscoveryEvent::ServiceFound(service_details)) {
                        warn!("Failed to send ServiceFound event: {}", e);
                    }
                }
            }

            ServiceEvent::ServiceRemoved(type_domain, fullname) => {
                // Check if the service type matches.
                if type_domain != service_type {
                    debug!(
                        "Ignoring mismatched removed service type: {} (expected: {})",
                        type_domain, service_type
                    );
                    return;
                }

                debug!("Service removed: {} ({})", fullname, type_domain);

                {
                    let mut services_map = services.write().unwrap();
                    services_map.remove(&fullname);
                }

                {
                    let mut state_guard = state.write().unwrap();
                    state_guard.service_hashes.remove(&fullname);
                }

                if let Err(e) = sender.send(DiscoveryEvent::ServiceLost(fullname)) {
                    warn!("Failed to send ServiceLost event: {}", e);
                }
            }

            _ => {}
        }
    }
}

impl DiscoveryService for MdnsDiscoveryService {
    fn register_service(&self) -> Result<()> {
        let instance_name_from_config = self.config.instance_name.clone();
        let service_type_from_config = self.config.service_type.clone();

        let final_instance_name = instance_name_from_config.trim_end_matches('.').to_string();
        let final_service_type = service_type_from_config;

        info!(
            "Registering service: instance='{}', type='{}'",
            final_instance_name, final_service_type
        );

        // 保存本机实例名并添加到过滤列表
        {
            let mut own_name_guard = self.own_instance_name.write().unwrap();
            *own_name_guard = Some(final_instance_name.clone());

            let mut state_guard = self.state.write().unwrap();
            state_guard.filter.insert(final_instance_name.clone());

            // 添加带有服务类型的完整名称(可能在事件中使用)
            let fullname = format!("{}.{}", final_instance_name, final_service_type);
            state_guard.filter.insert(fullname.clone());

            debug!(
                "Added own instance name '{}' to filter list",
                final_instance_name
            );
        }

        // Properties are now expected to contain device_name, version directly
        let service_properties = self.config.properties.clone().unwrap_or_default();

        let service_info = ServiceInfo::new(
            &final_service_type,
            &final_instance_name,
            "localhost.local.", // Hostname will be auto-detected by mdns-sd if set to "localhost.local." or empty
            (),                 // No specific IP addresses, let mdns-sd handle it
            self.config.port,
            service_properties, // Use properties directly from config
        )
        .map_err(|e| {
            error!("Failed to create service info: {}", e);
            HiveDiscoError::MdnsError(e)
        })?
        .enable_addr_auto();

        self.mdns.register(service_info).map_err(|e| {
            error!("Failed to register mDNS service: {}", e);
            HiveDiscoError::MdnsError(e)
        })?;

        info!("Service registered successfully: {}", final_instance_name);
        Ok(())
    }

    fn start_discovery(&self) -> Result<()> {
        {
            let mut state_guard = self.state.write().unwrap();

            match state_guard.status {
                DiscoveryServiceStatus::Running => {
                    if self.sender.receiver_count() > 0 {
                        let mut started_sent = self.discovery_started_sent.write().unwrap();
                        if !*started_sent {
                            if let Err(e) = self.sender.send(DiscoveryEvent::DiscoveryStarted) {
                                warn!("Failed to resend DiscoveryStarted event: {}", e);
                            } else {
                                *started_sent = true;
                            }
                        }
                    }
                    return Ok(());
                }
                DiscoveryServiceStatus::Stopping => {
                    return Err(HiveDiscoError::StateError(
                        "Service is currently stopping, cannot start discovery.".into(),
                    ));
                }
                DiscoveryServiceStatus::Stopped => {
                    state_guard.status = DiscoveryServiceStatus::Running;
                    let mut started_sent = self.discovery_started_sent.write().unwrap();
                    *started_sent = false;
                }
            }
        }

        let service_type = self.config.service_type.clone();

        info!("Starting service discovery for type: {}", service_type);

        self.start_cleanup_task()?;

        let receiver = self.mdns.browse(&service_type).map_err(|e| {
            error!("Failed to create mDNS browser: {}", e);
            HiveDiscoError::MdnsError(e)
        })?;

        let services = Arc::clone(&self.discovered_services);
        let sender = self.sender.clone();
        let state = Arc::clone(&self.state);
        let discovery_started_sent = Arc::clone(&self.discovery_started_sent);

        if self.sender.receiver_count() > 0 {
            let mut started_sent_guard = discovery_started_sent.write().unwrap();
            if !*started_sent_guard {
                if let Err(e) = sender.send(DiscoveryEvent::DiscoveryStarted) {
                    warn!("Failed to send DiscoveryStarted event: {}", e);
                } else {
                    *started_sent_guard = true;
                }
            }
        }

        thread::spawn(move || {
            debug!(
                "Service discovery event processing thread started for type: {}",
                service_type
            );

            while let Ok(event) = receiver.recv() {
                {
                    let state_guard = state.read().unwrap();
                    if state_guard.status != DiscoveryServiceStatus::Running {
                        break;
                    }
                }
                MdnsDiscoveryService::handle_service_event(
                    event,
                    &services,
                    &sender,
                    &state,
                    &service_type,
                );
            }

            debug!(
                "Service discovery event processing thread finished for type: {}",
                service_type
            );

            if let Err(e) = sender.send(DiscoveryEvent::DiscoveryStopped) {
                warn!("Failed to send DiscoveryStopped event: {}", e);
            }

            let mut state_guard = state.write().unwrap();
            if state_guard.status == DiscoveryServiceStatus::Stopping {
                state_guard.status = DiscoveryServiceStatus::Stopped;
            }
        });

        Ok(())
    }

    fn subscribe(&self) -> broadcast::Receiver<DiscoveryEvent> {
        let receiver = self.sender.subscribe();
        let state_guard = self.state.read().unwrap();
        if state_guard.status == DiscoveryServiceStatus::Running {
            let mut started_sent = self.discovery_started_sent.write().unwrap();
            if !*started_sent || self.sender.receiver_count() == 1 {
                if self.sender.send(DiscoveryEvent::DiscoveryStarted).is_ok() {
                    *started_sent = true;
                }
            }
        }
        receiver
    }

    fn add_filter(&self, instance_name: String) {
        let trimmed_name = instance_name.trim_end_matches('.').to_string();
        debug!("Adding filter for instance name: {}", trimmed_name);
        let mut state = self.state.write().unwrap();
        state.filter.insert(trimmed_name);
    }

    fn remove_filter(&self, instance_name: &str) {
        let trimmed_instance_name = instance_name.trim_end_matches('.');
        let own_name_guard = self.own_instance_name.read().unwrap();
        if let Some(own_name) = own_name_guard.as_ref() {
            if own_name == trimmed_instance_name {
                debug!(
                    "Attempted to remove own instance name filter ('{}'), which is protected. Ignored.",
                    trimmed_instance_name
                );
                return;
            }
        }

        debug!(
            "Removing filter for instance name: {}",
            trimmed_instance_name
        );
        let mut state = self.state.write().unwrap();
        state.filter.remove(trimmed_instance_name);
    }

    fn stop_discovery(&self) -> Result<()> {
        {
            let mut state = self.state.write().unwrap();

            match state.status {
                DiscoveryServiceStatus::Stopped | DiscoveryServiceStatus::Stopping => {
                    return Ok(());
                }
                DiscoveryServiceStatus::Running => {
                    state.status = DiscoveryServiceStatus::Stopping;
                    let mut started_sent = self.discovery_started_sent.write().unwrap();
                    *started_sent = false;
                }
            }
        }

        let service_type = self.config.service_type.clone();
        info!("Stopping service discovery for type: {}", service_type);

        self.mdns.stop_browse(&service_type).map_err(|e| {
            error!(
                "Failed to stop mDNS browser for type '{}': {}",
                service_type, e
            );
            HiveDiscoError::MdnsError(e)
        })?;

        Ok(())
    }

    fn refresh_services(&self) -> Result<()> {
        debug!("Refreshing discovered services");

        let services_snapshot = {
            let services_map = self.discovered_services.read().unwrap();
            services_map.values().cloned().collect::<Vec<_>>()
        };

        {
            let mut state = self.state.write().unwrap();
            state.service_hashes.clear();
        }

        for service in services_snapshot {
            if let Err(e) = self
                .sender
                .send(DiscoveryEvent::ServiceFound(service.clone()))
            {
                warn!(
                    "Failed to send refreshed ServiceFound event for '{}': {}",
                    service.instance_name, e
                );
            }
        }

        Ok(())
    }

    fn shutdown(&self) -> Result<()> {
        info!("Shutting down mDNS service discovery component");

        if let Err(e) = self.stop_discovery() {
            warn!(
                "Error occurred while stopping service discovery during shutdown: {}",
                e
            );
        }

        // 清除本机实例名记录
        {
            let mut own_name_guard = self.own_instance_name.write().unwrap();
            *own_name_guard = None;
        }

        {
            let mut state = self.state.write().unwrap();
            state.status = DiscoveryServiceStatus::Stopped;
        }

        let status_receiver = self.mdns.shutdown().map_err(|e| {
            error!("Failed to initiate mDNS daemon shutdown: {}", e);
            HiveDiscoError::ShutdownError(format!("Failed to initiate mDNS daemon shutdown: {}", e))
        })?;

        match status_receiver.recv_timeout(Duration::from_secs(5)) {
            Ok(_) => {
                info!("mDNS daemon shut down successfully.");
                Ok(())
            }
            Err(e) => {
                let error_msg = format!("Waiting for mDNS daemon shutdown failed: {}", e);
                error!("{}", error_msg);
                Err(HiveDiscoError::ShutdownError(error_msg))
            }
        }
    }

    fn status(&self) -> DiscoveryServiceStatus {
        let state = self.state.read().unwrap();
        state.status
    }
}

impl Drop for MdnsDiscoveryService {
    fn drop(&mut self) {
        info!("MdnsDiscoveryService instance is being dropped. Performing automatic shutdown.");
        if let Err(e) = self.shutdown() {
            error!("Error during automatic shutdown in drop: {}", e);
        }
    }
}