ableton-link-rs 0.1.1

Native Rust implementation of the Ableton Link protocol
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
use std::{
    net::SocketAddrV4,
    sync::{Arc, Mutex},
    vec,
};

use tokio::{
    select,
    sync::{
        mpsc::{Receiver, Sender},
        Notify,
    },
};
use tracing::{debug, info};

use crate::link::{
    controller::SessionPeerCounter,
    node::{NodeId, NodeState},
    sessions::SessionId,
    state::StartStopState,
    timeline::Timeline,
};

#[derive(Clone)]
pub struct PeerStateMessageType {
    pub node_state: NodeState,
    pub ttl: u8,
    pub measurement_endpoint: Option<SocketAddrV4>,
}

pub enum PeerEvent {
    SawPeer(PeerState),
    PeerLeft(NodeId),
    PeerTimedOut(NodeId),
}

pub struct GatewayObserver {
    peers: Arc<Mutex<Vec<ControllerPeer>>>,
}

impl GatewayObserver {
    pub async fn new(
        mut on_peer_event: Receiver<PeerEvent>,
        peer_state: Arc<Mutex<PeerState>>,
        session_peer_counter: Arc<Mutex<SessionPeerCounter>>,
        tx_peer_state_change: Sender<Vec<PeerStateChange>>,
        peers: Arc<Mutex<Vec<ControllerPeer>>>,
        _notifier: Arc<Notify>,
    ) -> Self {
        let gwo = GatewayObserver { peers };

        let peers = gwo.peers.clone();
        let peer_state_loop = peer_state.clone();

        tokio::spawn(async move {
            loop {
                select! {
                    peer_event = on_peer_event.recv() => {
                        match peer_event {
                            Some(PeerEvent::SawPeer(peer_state)) => {
                                saw_peer(
                                    peer_state,
                                    peers.clone(),
                                    peer_state_loop.clone(),
                                    session_peer_counter.clone(),
                                    tx_peer_state_change.clone(),
                                )
                                .await
                            }
                            Some(PeerEvent::PeerLeft(node_id)) => peer_left(node_id, peers.clone(), tx_peer_state_change.clone()).await,
                            Some(PeerEvent::PeerTimedOut(node_id)) => {
                                peer_left(node_id, peers.clone(), tx_peer_state_change.clone()).await
                            }
                            None => continue,
                        }
                    }
                    // _ = notifier.notified() => {
                    //     break;
                    // }
                }
            }
        });

        gwo
    }

    pub fn set_session_timeline(&mut self, session_id: SessionId, timeline: Timeline) {
        if let Ok(mut peers) = self.peers.try_lock() {
            peers.iter_mut().for_each(|peer| {
                if peer.peer_state.session_id() == session_id {
                    peer.peer_state.node_state.timeline = timeline;
                }
            });
        } else {
            debug!("Could not acquire peers lock in set_session_timeline");
        }
    }

    pub fn forget_session(&mut self, session_id: Arc<Mutex<SessionId>>) {
        let session_id_val = match session_id.try_lock() {
            Ok(guard) => *guard,
            Err(_) => {
                debug!("Could not acquire session_id lock in forget_session");
                return;
            }
        };

        if let Ok(mut peers) = self.peers.try_lock() {
            peers.retain(|peer| peer.peer_state.session_id() != session_id_val);
        } else {
            debug!("Could not acquire peers lock in forget_session");
        }
    }

    pub fn reset_peers(&self) {
        if let Ok(mut peers) = self.peers.try_lock() {
            peers.clear();
        } else {
            debug!("Could not acquire peers lock in reset_peers");
        }
    }
}

#[derive(Debug, Clone, PartialEq, Default)]
pub struct PeerState {
    pub node_state: NodeState,
    pub measurement_endpoint: Option<SocketAddrV4>,
}

impl PeerState {
    pub fn ident(&self) -> NodeId {
        self.node_state.ident()
    }

    pub fn session_id(&self) -> SessionId {
        self.node_state.session_id
    }

    pub fn timeline(&self) -> Timeline {
        self.node_state.timeline
    }

    pub fn start_stop_state(&self) -> StartStopState {
        self.node_state.start_stop_state
    }
}

pub fn unique_session_peer_count(
    session_id: SessionId,
    peers: Arc<Mutex<Vec<ControllerPeer>>>,
    self_node_id: NodeId,
) -> usize {
    let all_peers = match peers.try_lock() {
        Ok(guard) => guard,
        Err(_) => {
            debug!("Could not acquire peers lock in unique_session_peer_count, returning 0");
            return 0;
        }
    };
    debug!(
        "unique_session_peer_count: looking for session_id={}, self_node_id={}",
        session_id, self_node_id
    );
    debug!(
        "unique_session_peer_count: total peers in list: {}",
        all_peers.len()
    );

    for (i, peer) in all_peers.iter().enumerate() {
        debug!(
            "  peer[{}]: node_id={}, session_id={}",
            i,
            peer.peer_state.ident(),
            peer.peer_state.session_id()
        );
    }

    let mut peers = all_peers
        .iter()
        .filter(|p| {
            let matches_session = p.peer_state.session_id() == session_id;
            let is_not_self = p.peer_state.ident() != self_node_id;
            debug!(
                "  filtering peer {}: matches_session={}, is_not_self={}",
                p.peer_state.ident(),
                matches_session,
                is_not_self
            );
            matches_session && is_not_self
        })
        .cloned()
        .collect::<Vec<_>>();

    debug!(
        "unique_session_peer_count: before dedup, filtered peers count: {}",
        peers.len()
    );
    peers.dedup_by(|a, b| {
        let is_duplicate = a.peer_state.ident() == b.peer_state.ident();
        if is_duplicate {
            debug!("  removing duplicate peer: {}", a.peer_state.ident());
        }
        is_duplicate
    });

    debug!(
        "unique_session_peer_count: after dedup, final peers count: {}",
        peers.len()
    );
    peers.len()
}

#[derive(Clone)]
pub enum PeerStateChange {
    SessionMembership,
    SessionTimeline(SessionId, Timeline),
    SessionStartStopState(SessionId, StartStopState),
    PeerLeft,
}

async fn saw_peer(
    peer_seen_peer_state: PeerState,
    peers: Arc<Mutex<Vec<ControllerPeer>>>,
    self_peer_state: Arc<Mutex<PeerState>>,
    _session_peer_counter: Arc<Mutex<SessionPeerCounter>>,
    tx_peer_state_change: Sender<Vec<PeerStateChange>>,
) {
    // Additional safety check: Don't add ourselves to our own peer list
    let self_ident = match self_peer_state.try_lock() {
        Ok(guard) => guard.ident(),
        Err(_) => {
            debug!("Could not acquire self_peer_state lock in saw_peer, skipping self-check");
            // If we can't get the lock, continue anyway - the duplicate check later will catch self-peers
            peer_seen_peer_state.ident() // This will not match unless it's actually self, which is unlikely
        }
    };

    if peer_seen_peer_state.ident() == self_ident {
        debug!(
            "ignoring peer state from self (node {})",
            peer_seen_peer_state.ident()
        );
        return;
    }

    let ps = PeerState {
        node_state: peer_seen_peer_state.node_state,
        measurement_endpoint: peer_seen_peer_state.measurement_endpoint,
    };

    let peer_session = ps.session_id();
    let peer_timeline = ps.timeline();
    let peer_start_stop_state = ps.start_stop_state();

    let is_new_session_timeline = match peers.try_lock() {
        Ok(guard) => !guard.iter().any(|p| {
            p.peer_state.session_id() == peer_session && p.peer_state.timeline() == peer_timeline
        }),
        Err(_) => {
            debug!("Could not acquire peers lock to check session timeline, assuming new");
            true // Assume it's new if we can't check
        }
    };

    let is_new_session_start_stop_state = match peers.try_lock() {
        Ok(guard) => !guard
            .iter()
            .any(|p| p.peer_state.start_stop_state() == peer_start_stop_state),
        Err(_) => {
            debug!("Could not acquire peers lock to check start/stop state, assuming new");
            true // Assume it's new if we can't check
        }
    };

    let peer = ControllerPeer { peer_state: ps };

    let existing_peer_index = match peers.try_lock() {
        Ok(guard) => guard
            .iter()
            .position(|p| p.peer_state.ident() == peer.peer_state.ident()),
        Err(_) => {
            debug!("Could not acquire peers lock to find existing peer, assuming new");
            None // Assume it's new if we can't check
        }
    };

    let did_session_membership_change = if let Some(index) = existing_peer_index {
        // Update existing peer with new state
        match peers.try_lock() {
            Ok(mut guard) => {
                let old_session_id = guard[index].peer_state.session_id();
                guard[index] = peer.clone();
                // Session membership changed if the session ID changed
                old_session_id != peer_session
            }
            Err(_) => {
                debug!("Could not acquire peers lock to update existing peer");
                false // No change if we can't update
            }
        }
    } else {
        // Add new peer
        match peers.try_lock() {
            Ok(mut guard) => {
                guard.push(peer.clone());
                true
            }
            Err(_) => {
                debug!("Could not acquire peers lock to add new peer");
                false // No change if we can't add
            }
        }
    };

    let mut peer_state_changes = vec![];

    if is_new_session_timeline {
        debug!("session timeline changed");
        peer_state_changes.push(PeerStateChange::SessionTimeline(
            peer_session,
            peer_timeline,
        ));
    }

    if is_new_session_start_stop_state {
        debug!("session start stop changed");
        peer_state_changes.push(PeerStateChange::SessionStartStopState(
            peer_session,
            peer_start_stop_state,
        ));
    }

    if did_session_membership_change {
        debug!("session membership changed");
        peer_state_changes.push(PeerStateChange::SessionMembership);
    }

    if !peer_state_changes.is_empty() {
        debug!("sending peer state changes to controller");
        if let Err(e) = tx_peer_state_change.send(peer_state_changes).await {
            debug!("Failed to send peer state changes: {}", e);
        }
    }
}

async fn peer_left(
    node_id: NodeId,
    peers: Arc<Mutex<Vec<ControllerPeer>>>,
    tx_peer_state_change: Sender<Vec<PeerStateChange>>,
) {
    info!("Processing peer_left for node {}", node_id);

    let mut did_session_membership_change = false;
    if let Ok(mut peers_guard) = peers.try_lock() {
        let initial_count = peers_guard.len();
        peers_guard.retain(|peer| {
            if peer.peer_state.ident() == node_id {
                info!("Removing peer {} from peers list", node_id);
                did_session_membership_change = true;
                false
            } else {
                true
            }
        });
        let final_count = peers_guard.len();
        info!(
            "Peer count changed from {} to {} after removing peer {}",
            initial_count, final_count, node_id
        );
    } else {
        debug!(
            "Could not acquire peers lock in peer_left for node {}",
            node_id
        );
        return;
    }

    if did_session_membership_change {
        info!(
            "Session membership changed due to peer {} leaving, sending PeerLeft event",
            node_id
        );
        if let Err(e) = tx_peer_state_change
            .send(vec![PeerStateChange::PeerLeft])
            .await
        {
            debug!("Failed to send peer left event: {}", e);
        } else {
            info!("Successfully sent PeerLeft event for peer {}", node_id);
        }
    } else {
        info!(
            "No session membership change for peer {} (peer not found in list)",
            node_id
        );
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct ControllerPeer {
    pub peer_state: PeerState,
}

#[cfg(test)]
mod tests {
    use std::net::IpAddr;

    use chrono::Duration;
    use local_ip_address::list_afinet_netifas;
    use tokio::sync::mpsc;

    use crate::{
        discovery::{
            gateway::{OnEvent, PeerGateway},
            messenger::new_udp_reuseport,
        },
        link::{
            beats::Beats, clock::Clock, measurement::MeasurePeerEvent, sessions::session_peers,
            state::SessionState, tempo::Tempo,
        },
    };

    use super::*;

    // fn init_tracing() {
    //     let subscriber = tracing_subscriber::FmtSubscriber::new();
    //     tracing::subscriber::set_global_default(subscriber).unwrap();
    // }

    fn init_peers() -> (PeerState, PeerState, PeerState) {
        (
            PeerState {
                node_state: NodeState {
                    node_id: NodeId::new(),
                    session_id: SessionId(NodeId::new()),
                    timeline: Timeline {
                        tempo: Tempo::new(60.0),
                        beat_origin: Beats::new(1.0),
                        time_origin: Duration::microseconds(1234),
                    },
                    start_stop_state: StartStopState {
                        is_playing: false,
                        beats: Beats::new(0.0),
                        timestamp: Duration::microseconds(2345),
                    },
                },
                measurement_endpoint: None,
            },
            PeerState {
                node_state: NodeState {
                    node_id: NodeId::new(),
                    session_id: SessionId(NodeId::new()),
                    timeline: Timeline {
                        tempo: Tempo::new(120.0),
                        beat_origin: Beats::new(10.0),
                        time_origin: Duration::microseconds(500),
                    },
                    start_stop_state: StartStopState::default(),
                },
                measurement_endpoint: None,
            },
            PeerState {
                node_state: NodeState {
                    node_id: NodeId::new(),
                    session_id: SessionId(NodeId::new()),
                    timeline: Timeline {
                        tempo: Tempo::new(100.0),
                        beat_origin: Beats::new(4.0),
                        time_origin: Duration::microseconds(100),
                    },
                    start_stop_state: StartStopState::default(),
                },
                measurement_endpoint: None,
            },
        )
    }

    async fn init_gateway() -> (
        PeerGateway,
        mpsc::Sender<Vec<PeerStateChange>>,
        Arc<Mutex<u8>>,
    ) {
        let session_id = SessionId::default();
        let node_1 = NodeState::new(session_id);
        let (tx_measure_peer_result, _) = mpsc::channel::<MeasurePeerEvent>(1);
        let (_, rx_measure_peer_state) = mpsc::channel::<MeasurePeerEvent>(1);
        let (tx_event, _) = mpsc::channel::<OnEvent>(1);
        let (tx_peer_state_change, mut rx_peer_state_change) =
            mpsc::channel::<Vec<PeerStateChange>>(1);

        let notifier = Arc::new(Notify::new());

        let calls = Arc::new(Mutex::new(0));
        let c = calls.clone();

        tokio::spawn(async move {
            while (rx_peer_state_change.recv().await).is_some() {
                *c.try_lock().unwrap() += 1;
            }
        });

        let ip = list_afinet_netifas()
            .unwrap()
            .iter()
            .find_map(|(_, ip)| match ip {
                IpAddr::V4(ipv4) if !ip.is_loopback() => Some(*ipv4),
                _ => None,
            })
            .unwrap();

        let ping_responder_unicast_socket = Arc::new(new_udp_reuseport(SocketAddrV4::new(ip, 0).into()).unwrap());

        (
            PeerGateway::new(
                Arc::new(Mutex::new(PeerState {
                    node_state: node_1,
                    measurement_endpoint: None,
                })),
                Arc::new(Mutex::new(SessionState::default())),
                Clock::default(),
                Arc::new(Mutex::new(SessionPeerCounter::default())),
                tx_peer_state_change.clone(),
                tx_event,
                tx_measure_peer_result,
                Arc::new(Mutex::new(vec![])),
                notifier.clone(),
                rx_measure_peer_state,
                ping_responder_unicast_socket,
                Arc::new(Mutex::new(true)), // enabled for test
            )
            .await,
            tx_peer_state_change,
            calls,
        )
    }

    #[tokio::test]
    async fn add_find_peer() {
        // init_tracing();

        let (foo_peer, _, _) = init_peers();

        let (gw, tx_peer_state_change, calls) = init_gateway().await;

        saw_peer(
            foo_peer.clone(),
            gw.observer.peers.clone(),
            gw.peer_state.clone(),
            gw.session_peer_counter.clone(),
            tx_peer_state_change.clone(),
        )
        .await;

        tokio::time::sleep(Duration::milliseconds(50).to_std().unwrap()).await;

        assert_eq!(
            session_peers(gw.observer.peers.clone(), foo_peer.session_id()),
            vec![ControllerPeer {
                peer_state: foo_peer
            }]
        );
        assert!(*calls.try_lock().unwrap() == 1);
    }

    #[tokio::test]
    async fn add_remove_peer() {
        // init_tracing();

        let (foo_peer, _, _) = init_peers();

        let (gw, tx_peer_state_change, calls) = init_gateway().await;

        saw_peer(
            foo_peer.clone(),
            gw.observer.peers.clone(),
            gw.peer_state.clone(),
            gw.session_peer_counter.clone(),
            tx_peer_state_change.clone(),
        )
        .await;

        peer_left(
            foo_peer.ident(),
            gw.observer.peers.clone(),
            tx_peer_state_change.clone(),
        )
        .await;

        tokio::time::sleep(Duration::milliseconds(50).to_std().unwrap()).await;

        assert!(gw.observer.peers.try_lock().unwrap().is_empty());
        assert!(*calls.try_lock().unwrap() == 2);
    }

    #[tokio::test]
    async fn add_two_peers_remove_one_peer() {
        // init_tracing();

        let (foo_peer, bar_peer, _) = init_peers();

        let (gw, tx_peer_state_change, _) = init_gateway().await;

        for peer in [foo_peer.clone(), bar_peer.clone()].iter() {
            saw_peer(
                peer.clone(),
                gw.observer.peers.clone(),
                gw.peer_state.clone(),
                gw.session_peer_counter.clone(),
                tx_peer_state_change.clone(),
            )
            .await;
        }

        peer_left(
            foo_peer.ident(),
            gw.observer.peers.clone(),
            tx_peer_state_change.clone(),
        )
        .await;

        tokio::time::sleep(Duration::milliseconds(50).to_std().unwrap()).await;

        assert!(session_peers(gw.observer.peers.clone(), foo_peer.session_id()).is_empty());

        assert_eq!(
            session_peers(gw.observer.peers.clone(), bar_peer.clone().session_id()),
            vec![ControllerPeer {
                peer_state: bar_peer,
            }]
        );
    }
}