peat-mesh 0.8.1

Peat mesh networking library with CRDT sync, transport security, and topology management
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
use super::storage::{BeaconChangeEvent, BeaconStorage};
use super::types::GeographicBeacon;
use futures::StreamExt;
use std::collections::HashMap;
use std::sync::Arc;
use tokio::sync::RwLock;
use tracing::{debug, error, info};

/// Observes and tracks nearby geographic beacons
///
/// BeaconObserver subscribes to beacon updates from the storage backend
/// and maintains a cache of nearby beacons based on geohash proximity.
pub struct BeaconObserver {
    storage: Arc<dyn BeaconStorage>,
    my_geohash: String,
    nearby_beacons: Arc<RwLock<HashMap<String, GeographicBeacon>>>,
    running: Arc<RwLock<bool>>,
}

impl BeaconObserver {
    /// Create a new beacon observer
    ///
    /// # Arguments
    ///
    /// * `storage` - Storage backend for beacon queries and subscriptions
    /// * `my_geohash` - This node's geohash for proximity filtering
    pub fn new(storage: Arc<dyn BeaconStorage>, my_geohash: String) -> Self {
        Self {
            storage,
            my_geohash,
            nearby_beacons: Arc::new(RwLock::new(HashMap::new())),
            running: Arc::new(RwLock::new(false)),
        }
    }

    /// Start observing beacons
    ///
    /// Subscribes to beacon change events from storage and maintains
    /// a cache of nearby beacons based on geohash proximity.
    pub async fn start(&self) {
        let mut running = self.running.write().await;
        if *running {
            debug!("Beacon observer already running");
            return;
        }
        *running = true;
        drop(running);

        info!("Starting beacon observer for geohash {}", self.my_geohash);

        // Subscribe to beacon changes
        let mut stream = match self.storage.subscribe().await {
            Ok(s) => s,
            Err(e) => {
                error!("Failed to subscribe to beacon changes: {}", e);
                let mut running = self.running.write().await;
                *running = false;
                return;
            }
        };

        let running_clone = self.running.clone();
        let nearby_beacons_clone = self.nearby_beacons.clone();
        let my_geohash = self.my_geohash.clone();

        tokio::spawn(async move {
            while *running_clone.read().await {
                tokio::select! {
                    Some(event) = stream.next() => {
                        match event {
                            BeaconChangeEvent::Inserted(beacon) | BeaconChangeEvent::Updated(beacon) => {
                                // Check if beacon is nearby
                                if Self::is_nearby_geohash(&my_geohash, &beacon.geohash) {
                                    debug!("Nearby beacon detected: {}", beacon.node_id);
                                    let mut beacons = nearby_beacons_clone.write().await;
                                    beacons.insert(beacon.node_id.clone(), beacon);
                                }
                            }
                            BeaconChangeEvent::Removed { node_id } => {
                                debug!("Beacon removed: {}", node_id);
                                let mut beacons = nearby_beacons_clone.write().await;
                                beacons.remove(&node_id);
                            }
                        }
                    }
                    _ = tokio::time::sleep(tokio::time::Duration::from_millis(100)) => {
                        // Periodic check to ensure loop continues
                    }
                }
            }
            debug!("Beacon observer event loop stopped");
        });
    }

    /// Stop observing beacons
    pub async fn stop(&self) {
        let mut running = self.running.write().await;
        *running = false;
        info!("Stopped beacon observer");
    }

    /// Get all nearby beacons
    pub async fn get_nearby_beacons(&self) -> Vec<GeographicBeacon> {
        self.nearby_beacons.read().await.values().cloned().collect()
    }

    /// Check if a geohash is nearby (same or adjacent cell)
    fn is_nearby_geohash(my_geohash: &str, other_geohash: &str) -> bool {
        use crate::geohash::Direction;

        if my_geohash == other_geohash {
            return true;
        }

        // Check all 8 adjacent cells
        let directions = [
            Direction::N,
            Direction::NE,
            Direction::E,
            Direction::SE,
            Direction::S,
            Direction::SW,
            Direction::W,
            Direction::NW,
        ];

        for dir in &directions {
            if let Ok(neighbor) = crate::geohash::neighbor(my_geohash, *dir) {
                if neighbor == other_geohash {
                    return true;
                }
            }
        }

        false
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::beacon::storage::{BeaconChangeStream, Result};
    use async_trait::async_trait;
    use futures::stream;
    use std::sync::Arc;
    use tokio::sync::Mutex;

    /// Mock storage for testing
    struct MockBeaconStorage {
        beacons: Arc<Mutex<Vec<GeographicBeacon>>>,
    }

    impl MockBeaconStorage {
        fn new() -> Self {
            Self {
                beacons: Arc::new(Mutex::new(Vec::new())),
            }
        }
    }

    #[async_trait]
    impl BeaconStorage for MockBeaconStorage {
        async fn save_beacon(&self, beacon: &GeographicBeacon) -> Result<()> {
            let mut beacons = self.beacons.lock().await;
            if let Some(existing) = beacons.iter_mut().find(|b| b.node_id == beacon.node_id) {
                *existing = beacon.clone();
            } else {
                beacons.push(beacon.clone());
            }
            Ok(())
        }

        async fn query_by_geohash(&self, geohash_prefix: &str) -> Result<Vec<GeographicBeacon>> {
            let beacons = self.beacons.lock().await;
            Ok(beacons
                .iter()
                .filter(|b| b.geohash.starts_with(geohash_prefix))
                .cloned()
                .collect())
        }

        async fn query_all(&self) -> Result<Vec<GeographicBeacon>> {
            let beacons = self.beacons.lock().await;
            Ok(beacons.clone())
        }

        async fn subscribe(&self) -> Result<BeaconChangeStream> {
            // For testing, return empty stream
            // In real tests with events, we'd use the event_tx channel
            Ok(Box::new(stream::empty()))
        }
    }

    #[tokio::test]
    async fn test_observer_lifecycle() {
        let storage = MockBeaconStorage::new();
        let observer = BeaconObserver::new(Arc::new(storage), "9q8yy9m".to_string());

        observer.start().await;
        assert!(*observer.running.read().await);

        observer.stop().await;
        assert!(!*observer.running.read().await);
    }

    #[test]
    fn test_is_nearby_geohash() {
        // Same geohash should be nearby
        assert!(BeaconObserver::is_nearby_geohash("9q8yy9m", "9q8yy9m"));

        // Adjacent geohashes should be nearby
        let north = crate::geohash::neighbor("9q8yy9m", crate::geohash::Direction::N).unwrap();
        assert!(BeaconObserver::is_nearby_geohash("9q8yy9m", &north));

        // Distant geohash should not be nearby
        assert!(!BeaconObserver::is_nearby_geohash("9q8yy9m", "u4pruyd")); // Sydney, Australia
    }

    #[tokio::test]
    async fn test_observer_filters_nearby_beacons() {
        let storage = MockBeaconStorage::new();
        let my_geohash = "9q8yy9m"; // San Francisco area

        let observer = BeaconObserver::new(Arc::new(storage), my_geohash.to_string());

        // Verify empty initially
        let nearby = observer.get_nearby_beacons().await;
        assert_eq!(nearby.len(), 0);
    }

    #[tokio::test]
    async fn test_get_nearby_beacons() {
        let storage = MockBeaconStorage::new();
        let observer = BeaconObserver::new(Arc::new(storage), "9q8yy9m".to_string());

        observer.start().await;

        // Initially empty
        let nearby = observer.get_nearby_beacons().await;
        assert_eq!(nearby.len(), 0);

        observer.stop().await;
    }

    #[tokio::test]
    async fn test_observer_start_twice() {
        let storage = MockBeaconStorage::new();
        let observer = BeaconObserver::new(Arc::new(storage), "9q8yy9m".to_string());

        observer.start().await;
        assert!(*observer.running.read().await);

        // Starting again should be a no-op (already running)
        observer.start().await;
        assert!(*observer.running.read().await);

        observer.stop().await;
    }

    #[test]
    fn test_is_nearby_geohash_all_directions() {
        let my = "9q8yy9m";

        // Check all 8 neighbors
        let directions = [
            crate::geohash::Direction::N,
            crate::geohash::Direction::NE,
            crate::geohash::Direction::E,
            crate::geohash::Direction::SE,
            crate::geohash::Direction::S,
            crate::geohash::Direction::SW,
            crate::geohash::Direction::W,
            crate::geohash::Direction::NW,
        ];

        for dir in &directions {
            let neighbor = crate::geohash::neighbor(my, *dir).unwrap();
            assert!(
                BeaconObserver::is_nearby_geohash(my, &neighbor),
                "Neighbor in direction {:?} should be nearby",
                dir
            );
        }
    }

    #[test]
    fn test_is_nearby_geohash_same_hash() {
        assert!(BeaconObserver::is_nearby_geohash("9q8yy9m", "9q8yy9m"));
    }

    #[test]
    fn test_is_nearby_geohash_distant() {
        // Two very different geohashes should not be nearby
        assert!(!BeaconObserver::is_nearby_geohash("9q8yy9m", "u4pruyd"));
        assert!(!BeaconObserver::is_nearby_geohash("9q8yy9m", "s00000"));
    }

    #[tokio::test]
    async fn test_observer_with_failing_subscribe() {
        use crate::beacon::storage::StorageError;

        struct FailingStorage;

        #[async_trait]
        impl BeaconStorage for FailingStorage {
            async fn save_beacon(
                &self,
                _beacon: &crate::beacon::types::GeographicBeacon,
            ) -> Result<()> {
                Ok(())
            }

            async fn query_by_geohash(
                &self,
                _geohash_prefix: &str,
            ) -> Result<Vec<crate::beacon::types::GeographicBeacon>> {
                Ok(vec![])
            }

            async fn query_all(&self) -> Result<Vec<crate::beacon::types::GeographicBeacon>> {
                Ok(vec![])
            }

            async fn subscribe(&self) -> Result<BeaconChangeStream> {
                Err(StorageError::SubscribeFailed("test failure".to_string()))
            }
        }

        let observer = BeaconObserver::new(Arc::new(FailingStorage), "9q8yy9m".to_string());

        // Start should handle the subscribe failure gracefully
        observer.start().await;
        // After failed subscribe, running should be set back to false
        assert!(!*observer.running.read().await);
    }

    #[tokio::test]
    async fn test_observer_processes_events() {
        use crate::beacon::types::{GeoPosition, HierarchyLevel};

        struct EventStorage {
            events: Vec<BeaconChangeEvent>,
        }

        #[async_trait]
        impl BeaconStorage for EventStorage {
            async fn save_beacon(
                &self,
                _beacon: &crate::beacon::types::GeographicBeacon,
            ) -> Result<()> {
                Ok(())
            }

            async fn query_by_geohash(
                &self,
                _geohash_prefix: &str,
            ) -> Result<Vec<crate::beacon::types::GeographicBeacon>> {
                Ok(vec![])
            }

            async fn query_all(&self) -> Result<Vec<crate::beacon::types::GeographicBeacon>> {
                Ok(vec![])
            }

            async fn subscribe(&self) -> Result<BeaconChangeStream> {
                let events = self.events.clone();
                Ok(Box::new(stream::iter(events)))
            }
        }

        // Create a beacon that is nearby (same geohash)
        let my_geohash = "9q8yy9m";
        let beacon = crate::beacon::types::GeographicBeacon::new(
            "nearby-node".to_string(),
            GeoPosition::new(37.7749, -122.4194),
            HierarchyLevel::Squad,
        );

        // The beacon's geohash needs to match or be adjacent to my_geohash
        // We'll use a beacon with the same geohash
        let mut nearby_beacon = beacon.clone();
        nearby_beacon.geohash = my_geohash.to_string();

        let storage = EventStorage {
            events: vec![BeaconChangeEvent::Inserted(nearby_beacon.clone())],
        };

        let observer = BeaconObserver::new(Arc::new(storage), my_geohash.to_string());
        observer.start().await;

        // Give the spawned task time to process
        tokio::time::sleep(tokio::time::Duration::from_millis(200)).await;

        let nearby = observer.get_nearby_beacons().await;
        assert_eq!(nearby.len(), 1);
        assert_eq!(nearby[0].node_id, "nearby-node");

        observer.stop().await;
    }

    /// Reusable event-based storage mock for observer tests
    struct EventStorage {
        events: Vec<BeaconChangeEvent>,
    }

    impl EventStorage {
        fn new(events: Vec<BeaconChangeEvent>) -> Self {
            Self { events }
        }
    }

    #[async_trait]
    impl BeaconStorage for EventStorage {
        async fn save_beacon(
            &self,
            _beacon: &crate::beacon::types::GeographicBeacon,
        ) -> Result<()> {
            Ok(())
        }
        async fn query_by_geohash(
            &self,
            _geohash_prefix: &str,
        ) -> Result<Vec<crate::beacon::types::GeographicBeacon>> {
            Ok(vec![])
        }
        async fn query_all(&self) -> Result<Vec<crate::beacon::types::GeographicBeacon>> {
            Ok(vec![])
        }
        async fn subscribe(&self) -> Result<BeaconChangeStream> {
            let events = self.events.clone();
            Ok(Box::new(stream::iter(events)))
        }
    }

    fn make_nearby_beacon(node_id: &str, geohash: &str) -> crate::beacon::types::GeographicBeacon {
        use crate::beacon::types::{GeoPosition, HierarchyLevel};
        let mut beacon = crate::beacon::types::GeographicBeacon::new(
            node_id.to_string(),
            GeoPosition::new(37.7749, -122.4194),
            HierarchyLevel::Squad,
        );
        beacon.geohash = geohash.to_string();
        beacon
    }

    #[tokio::test]
    async fn test_observer_processes_removed_event() {
        let my_geohash = "9q8yy9m";
        let beacon = make_nearby_beacon("remove-me", my_geohash);

        let storage = EventStorage::new(vec![
            BeaconChangeEvent::Inserted(beacon),
            BeaconChangeEvent::Removed {
                node_id: "remove-me".to_string(),
            },
        ]);

        let observer = BeaconObserver::new(Arc::new(storage), my_geohash.to_string());
        observer.start().await;
        tokio::time::sleep(tokio::time::Duration::from_millis(200)).await;

        let nearby = observer.get_nearby_beacons().await;
        assert_eq!(nearby.len(), 0);

        observer.stop().await;
    }

    #[tokio::test]
    async fn test_observer_processes_updated_event() {
        let my_geohash = "9q8yy9m";
        let beacon = make_nearby_beacon("update-me", my_geohash);
        let updated = make_nearby_beacon("update-me", my_geohash);

        let storage = EventStorage::new(vec![
            BeaconChangeEvent::Inserted(beacon),
            BeaconChangeEvent::Updated(updated),
        ]);

        let observer = BeaconObserver::new(Arc::new(storage), my_geohash.to_string());
        observer.start().await;
        tokio::time::sleep(tokio::time::Duration::from_millis(200)).await;

        let nearby = observer.get_nearby_beacons().await;
        assert_eq!(nearby.len(), 1);
        assert_eq!(nearby[0].node_id, "update-me");

        observer.stop().await;
    }

    #[tokio::test]
    async fn test_observer_ignores_distant_beacons() {
        let my_geohash = "9q8yy9m";
        let distant = make_nearby_beacon("far-away", "u4pruyd");

        let storage = EventStorage::new(vec![BeaconChangeEvent::Inserted(distant)]);

        let observer = BeaconObserver::new(Arc::new(storage), my_geohash.to_string());
        observer.start().await;
        tokio::time::sleep(tokio::time::Duration::from_millis(200)).await;

        let nearby = observer.get_nearby_beacons().await;
        assert_eq!(nearby.len(), 0);

        observer.stop().await;
    }

    #[tokio::test]
    async fn test_event_storage_methods() {
        // Ensure mock storage methods are exercised for coverage
        use crate::beacon::types::{GeoPosition, HierarchyLevel};
        let storage = EventStorage::new(vec![]);
        let beacon = crate::beacon::types::GeographicBeacon::new(
            "test".to_string(),
            GeoPosition::new(37.7749, -122.4194),
            HierarchyLevel::Squad,
        );
        storage.save_beacon(&beacon).await.unwrap();
        let results = storage.query_by_geohash("9q8").await.unwrap();
        assert!(results.is_empty());
        let all = storage.query_all().await.unwrap();
        assert!(all.is_empty());
    }

    #[tokio::test]
    async fn test_mock_storage_methods() {
        use crate::beacon::types::{GeoPosition, HierarchyLevel};
        let storage = MockBeaconStorage::new();
        let beacon = crate::beacon::types::GeographicBeacon::new(
            "test".to_string(),
            GeoPosition::new(37.7749, -122.4194),
            HierarchyLevel::Squad,
        );
        storage.save_beacon(&beacon).await.unwrap();
        let results = storage.query_by_geohash("9q8").await.unwrap();
        assert_eq!(results.len(), 1);
        let all = storage.query_all().await.unwrap();
        assert_eq!(all.len(), 1);
        // Save again (update path)
        storage.save_beacon(&beacon).await.unwrap();
        let all = storage.query_all().await.unwrap();
        assert_eq!(all.len(), 1);
    }
}