limitador 0.11.0

Rate limiting library
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
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
use std::collections::{HashMap, HashSet};
use std::net::SocketAddr;
use std::ops::Add;
use std::sync::Arc;
use std::time::{Duration, SystemTime, UNIX_EPOCH};
use std::{error::Error, io::ErrorKind, pin::Pin};

use crate::counter::Counter;
use tokio::sync::mpsc::error::TrySendError;
use tokio::sync::mpsc::{Permit, Sender};
use tokio::sync::{broadcast, mpsc, Notify, RwLock};
use tokio::time::sleep;
use tokio_stream::{wrappers::ReceiverStream, Stream, StreamExt};
use tonic::{Code, Request, Response, Status, Streaming};
use tracing::debug;

use crate::storage::distributed::cr_counter_value::CrCounterValue;
use crate::storage::distributed::grpc::v1::packet::Message;
use crate::storage::distributed::grpc::v1::replication_client::ReplicationClient;
use crate::storage::distributed::grpc::v1::replication_server::{Replication, ReplicationServer};
use crate::storage::distributed::grpc::v1::{
    CounterUpdate, Empty, Hello, MembershipUpdate, Packet, Peer, Pong,
};

// clippy will barf on protobuff generated code for enum variants in
// v3::socket_option::SocketState, so allow this lint
#[allow(clippy::enum_variant_names, clippy::derive_partial_eq_without_eq)]
pub mod v1 {
    tonic::include_proto!("limitador.service.distributed.v1");
}

#[derive(Copy, Clone, Debug)]
enum ClockSkew {
    None(),
    Slow(Duration),
    Fast(Duration),
}

impl ClockSkew {
    fn new(local: SystemTime, remote: SystemTime) -> ClockSkew {
        if local == remote {
            ClockSkew::None()
        } else if local.gt(&remote) {
            ClockSkew::Slow(local.duration_since(remote).unwrap())
        } else {
            ClockSkew::Fast(remote.duration_since(local).unwrap())
        }
    }

    #[allow(dead_code)]
    fn remote(&self, time: SystemTime) -> SystemTime {
        match self {
            ClockSkew::None() => time,
            ClockSkew::Slow(duration) => time - *duration,
            ClockSkew::Fast(duration) => time + *duration,
        }
    }

    #[allow(dead_code)]
    fn remote_now(&self) -> SystemTime {
        self.remote(SystemTime::now())
    }
}

impl std::fmt::Display for ClockSkew {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        match self {
            ClockSkew::None() => write!(f, "remote time is the same"),
            ClockSkew::Slow(duration) => {
                write!(f, "remote time is slow by {}ms", duration.as_millis())
            }
            ClockSkew::Fast(duration) => {
                write!(f, "remote time is fast by {}ms", duration.as_millis())
            }
        }
    }
}

#[derive(Clone)]
struct Session {
    broker_state: BrokerState,
    replication_state: Arc<RwLock<ReplicationState>>,
    out_stream: MessageSender,
    peer_id: String,
}

impl Session {
    async fn close(&mut self) {
        let mut replication_state = self.replication_state.write().await;
        if let Some(peer) = replication_state.peer_trackers.get_mut(&self.peer_id) {
            peer.session = None;
        }
    }

    async fn send(&self, message: Message) -> Result<(), Status> {
        self.out_stream.clone().send(Ok(message)).await
    }

    async fn process(&mut self, in_stream: &mut Streaming<Packet>) -> Result<(), Status> {
        // Send a MembershipUpdate to inform the peer about all the members
        // We should resend it again if we learn of new members.
        self.send(Message::MembershipUpdate(MembershipUpdate {
            peers: {
                let state = self.replication_state.read().await;
                state.peers().clone()
            },
        }))
        .await?;

        // start the re-sync process with the peer, start sending him all the local counter values
        let (tx, mut rx) = mpsc::channel::<Option<CounterUpdate>>(1);
        let peer_id = self.peer_id.clone();
        let out_stream = self.out_stream.clone();
        tokio::spawn(async move {
            let mut counter = 0u64;
            while let Some(rsync_message) = rx.recv().await {
                match rsync_message {
                    Some(update) => {
                        counter += 1;
                        if let Err(err) = out_stream
                            .clone()
                            .send(Ok(Message::CounterUpdate(update)))
                            .await
                        {
                            debug!("peer: '{}': ReSyncRequest: send error: {:?}", peer_id, err);
                            return;
                        }
                    }
                    None => {
                        debug!(
                            "peer: '{}': rysnc completed, sent %d updates: {:?}",
                            peer_id, counter
                        );
                        _ = out_stream
                            .clone()
                            .send(Ok(Message::ReSyncEnd(Empty::default())))
                            .await;
                    }
                }
            }
        });
        self.broker_state
            .on_re_sync
            .try_send(tx)
            .map_err(|err| match err {
                TrySendError::Full(_) => Status::resource_exhausted("re-sync channel full"),
                TrySendError::Closed(_) => Status::unavailable("re-sync channel closed"),
            })?;

        let mut udpates_to_send = self.broker_state.publisher.subscribe();
        let mut tx_updates_by_key = HashMap::new();
        let mut tx_updates_order = vec![];
        let notifier = Notify::default();

        loop {
            tokio::select! {
                update = udpates_to_send.recv() => {
                    let update = update.map_err(|_| Status::unknown("broadcast error"))?;
                    // Multiple updates collapse into a single update for the same key
                    let key = &update.key.clone();
                    if !tx_updates_by_key.contains_key(key) {
                        tx_updates_by_key.insert(key.clone(), update);
                        tx_updates_order.push(key.clone());
                        notifier.notify_one();
                    }
                }
                _ = notifier.notified() => {
                    // while we have pending updates to send...
                    while !tx_updates_order.is_empty() {
                        // and we have space on the transmission channel to send the update...
                        match self.out_stream.clone().try_reserve() {
                            Err(_) => {
                                break
                            },
                            Ok(permit) => {

                                let key = tx_updates_order.remove(0);
                                let cr_counter_value = tx_updates_by_key.remove(&key).unwrap().clone();
                                let (expiry, values) = cr_counter_value.value.clone().into_inner();

                                // only send the update if it has not expired.
                                if expiry > SystemTime::now() {
                                    permit.send(Ok(Message::CounterUpdate(CounterUpdate {
                                        key,
                                        values: values.into_iter().collect(),
                                        expires_at: expiry.duration_since(UNIX_EPOCH).unwrap().as_secs(),
                                    })))?;
                                }
                            }
                        }
                    }
                }
                result = in_stream.next() => {
                    match result {
                        None=> {
                            // signals the end of stream...
                            return Ok(())
                        },
                        Some(Ok(packet)) => {
                            self.process_packet(packet).await?;
                        },
                        Some(Err(err)) => {
                            return if is_disconnect(&err) {
                                debug!("peer: '{}': disconnected: {:?}", self.peer_id, err);
                                Ok(())
                            } else {
                                Err(err)
                            }
                        },
                    }
                }
            }
        }
    }

    async fn process_packet(&self, packet: Packet) -> Result<(), Status> {
        match packet.message {
            Some(Message::Ping(_)) => {
                debug!("peer: '{}': Ping", self.peer_id);
                self.out_stream
                    .clone()
                    .send(Ok(Message::Pong(Pong {
                        current_time: SystemTime::now()
                            .duration_since(UNIX_EPOCH)
                            .unwrap()
                            .as_millis() as u64,
                    })))
                    .await?;
            }
            Some(Message::MembershipUpdate(update)) => {
                debug!("peer: '{}': MembershipUpdate", self.peer_id);
                // add any new peers to peer_trackers
                let mut state = self.replication_state.write().await;
                for peer in update.peers {
                    let peer_id = peer.peer_id.clone();
                    match state.peer_trackers.get(&peer_id) {
                        None => {
                            // we are discovering a peer from neighbor, adding a tracker will
                            // trigger a connection attempt to it.
                            state.peer_trackers.insert(
                                peer_id.clone(),
                                PeerTracker {
                                    peer_id,
                                    url: None,
                                    discovered_urls: peer.urls.iter().cloned().collect(),
                                    latency: 0, // todo maybe set this to peer.latency + session.latency
                                    clock_skew: ClockSkew::None(),
                                    session: None,
                                },
                            );
                        }
                        Some(_peer_tracker) => {
                            // // TODO: add discovered urls to the existing tracker.
                            // peer.urls.clone().iter().for_each(|url| {
                            //     peer_tracker.discovered_urls.insert(url.clone());
                            // });
                        }
                    }
                }
            }
            Some(Message::CounterUpdate(update)) => {
                debug!("peer: '{}': CounterUpdate", self.peer_id);
                (self.broker_state.on_counter_update)(update);
            }
            _ => {
                debug!("peer: '{}': unsupported packet: {:?}", self.peer_id, packet);
                return Err(Status::invalid_argument(format!(
                    "unsupported packet {packet:?}"
                )));
            }
        }
        Ok(())
    }
}

#[derive(Clone)]
struct PeerTracker {
    peer_id: String,
    url: Option<String>,
    discovered_urls: HashSet<String>,
    latency: u32,
    // Keep track of the clock skew between us and the peer
    clock_skew: ClockSkew,
    // The communication session we have with the peer, may be None if not connected
    session: Option<Session>,
}

// Track the replication session with all peers.
struct ReplicationState {
    // URLs our peers have used to connect to us.
    discovered_urls: HashSet<String>,
    peer_trackers: HashMap<String, PeerTracker>,
}

impl ReplicationState {
    fn peers(&self) -> Vec<Peer> {
        let mut peers = Vec::new();
        self.peer_trackers.iter().for_each(|(_, peer_tracker)| {
            peers.push(Peer {
                peer_id: peer_tracker.peer_id.clone(),
                latency: peer_tracker.latency,
                urls: peer_tracker
                    .discovered_urls
                    .iter()
                    .map(String::to_owned)
                    .collect(), // peer_tracker.urls.clone().into_iter().collect()
            });
        });
        peers.sort_by(|a, b| a.peer_id.cmp(&b.peer_id));
        peers
    }
}

fn match_for_io_error(err_status: &Status) -> Option<&std::io::Error> {
    let err: &(dyn Error + 'static) = err_status;

    loop {
        if let Some(io_err) = err.downcast_ref::<std::io::Error>() {
            return Some(io_err);
        }

        // h2::Error do not expose std::io::Error with `source()`
        // https://github.com/hyperium/h2/pull/462
        if let Some(h2_err) = err.downcast_ref::<h2::Error>() {
            if let Some(io_err) = h2_err.get_io() {
                return Some(io_err);
            }
        }

        err.source()?;
    }
}

async fn read_hello(in_stream: &mut Streaming<Packet>) -> Result<Hello, Status> {
    match in_stream.next().await {
        Some(Ok(packet)) => match packet.message {
            Some(Message::Hello(value)) => Ok(value),
            _ => Err(Status::invalid_argument("expected Hello")),
        },
        _ => Err(Status::invalid_argument("expected Hello")),
    }
}

async fn read_pong(in_stream: &mut Streaming<Packet>) -> Result<Pong, Status> {
    match in_stream.next().await {
        Some(Ok(packet)) => match packet.message {
            Some(Message::Pong(value)) => Ok(value),
            _ => Err(Status::invalid_argument("expected Pong")),
        },
        _ => Err(Status::invalid_argument("expected Pong")),
    }
}

fn is_disconnect(err: &Status) -> bool {
    if let Some(io_err) = match_for_io_error(err) {
        if io_err.kind() == ErrorKind::BrokenPipe {
            return true;
        }
    }
    false
}

// MessageSender is used to abstract the difference between the server and client sender streams...
#[derive(Clone)]
pub enum MessageSender {
    Server(Sender<Result<Packet, Status>>),
    Client(Sender<Packet>),
}

impl MessageSender {
    pub async fn send(self, message: Result<Message, Status>) -> Result<(), Status> {
        match self {
            MessageSender::Server(sender) => {
                let value = message.map(|x| Packet { message: Some(x) });
                let result = sender.send(value).await;
                result.map_err(|_| Status::unknown("send error"))
            }
            MessageSender::Client(sender) => match message {
                Ok(message) => {
                    let result = sender
                        .send(Packet {
                            message: Some(message),
                        })
                        .await;
                    result.map_err(|_| Status::unknown("send error"))
                }
                Err(err) => Err(err),
            },
        }
    }

    fn try_reserve(&self) -> Result<MessagePermit<'_>, Status> {
        match self {
            MessageSender::Client(sender) => {
                let permit = sender
                    .try_reserve()
                    .map_err(|_| Status::unknown("send error"))?;
                Ok(MessagePermit::Client(permit))
            }
            MessageSender::Server(sender) => {
                let permit = sender
                    .try_reserve()
                    .map_err(|_| Status::unknown("send error"))?;
                Ok(MessagePermit::Server(permit))
            }
        }
    }
}

enum MessagePermit<'a> {
    Server(Permit<'a, Result<Packet, Status>>),
    Client(Permit<'a, Packet>),
}
impl MessagePermit<'_> {
    fn send(self, message: Result<Message, Status>) -> Result<(), Status> {
        match self {
            MessagePermit::Server(sender) => {
                let value = message.map(|x| Packet { message: Some(x) });
                sender.send(value);
                Ok(())
            }
            MessagePermit::Client(sender) => match message {
                Ok(message) => {
                    sender.send(Packet {
                        message: Some(message),
                    });
                    Ok(())
                }
                Err(err) => Err(err),
            },
        }
    }
}

type CounterUpdateFn = Pin<Box<dyn Fn(CounterUpdate) + Sync + Send>>;
#[derive(Clone, Debug)]
pub struct CounterEntry {
    pub key: Vec<u8>,
    pub counter: Counter,
    pub value: CrCounterValue<String>,
}

impl CounterEntry {
    pub fn new(key: Vec<u8>, counter: Counter, value: CrCounterValue<String>) -> Self {
        Self {
            key,
            counter,
            value,
        }
    }
}

#[derive(Clone)]
struct BrokerState {
    id: String,
    publisher: broadcast::Sender<Arc<CounterEntry>>,
    on_counter_update: Arc<CounterUpdateFn>,
    on_re_sync: Arc<Sender<Sender<Option<CounterUpdate>>>>,
}

#[derive(Clone)]
pub struct Broker {
    listen_address: SocketAddr,
    peer_urls: Vec<String>,
    broker_state: BrokerState,
    replication_state: Arc<RwLock<ReplicationState>>,
}

impl Broker {
    pub fn new(
        id: String,
        listen_address: SocketAddr,
        peer_urls: Vec<String>,
        on_counter_update: CounterUpdateFn,
        on_re_sync: Sender<Sender<Option<CounterUpdate>>>,
    ) -> Broker {
        let (tx, _) = broadcast::channel(16);
        let publisher: broadcast::Sender<Arc<CounterEntry>> = tx;

        Broker {
            listen_address,
            peer_urls,
            broker_state: BrokerState {
                id,
                publisher,
                on_counter_update: Arc::new(on_counter_update),
                on_re_sync: Arc::new(on_re_sync),
            },
            replication_state: Arc::new(RwLock::new(ReplicationState {
                discovered_urls: HashSet::new(),
                peer_trackers: HashMap::new(),
            })),
        }
    }

    pub fn publish(&self, counter_update: Arc<CounterEntry>) {
        // ignore the send error, it just means there are no active subscribers
        _ = self.broker_state.publisher.send(counter_update);
    }

    pub async fn start(&self) {
        self.clone().peer_urls.into_iter().for_each(|peer_url| {
            let broker = self.clone();
            let peer_url = peer_url.clone();
            tokio::spawn(async move {
                // Keep trying until we get once successful connection handshake.  Once that
                // happens, we will know the peer_id and can recover by reconnecting to the peer
                loop {
                    match broker.connect_to_peer(peer_url.clone()).await {
                        Ok(_) => return,
                        Err(err) => {
                            debug!("failed to connect with peer '{}': {:?}", peer_url, err);
                            sleep(Duration::from_secs(1)).await
                        }
                    }
                }
            });
        });

        // Periodically reconnect to failed peers
        {
            let broker = self.clone();
            tokio::spawn(async move {
                loop {
                    sleep(Duration::from_secs(1)).await;
                    broker.reconnect_to_failed_peers().await;
                }
            });
        }

        debug!(
            "peer '{}' listening on: id={}",
            self.broker_state.id, self.listen_address
        );

        tonic::transport::Server::builder()
            .add_service(ReplicationServer::new(self.clone()))
            .serve(self.listen_address)
            .await
            .unwrap();
    }

    // Connect to a peer and start a replication session.  This returns once the session handshake
    // completes.
    async fn connect_to_peer(&self, peer_url: String) -> Result<(), Status> {
        let mut client = match ReplicationClient::connect(peer_url.clone()).await {
            Ok(client) => client,
            Err(err) => {
                return Err(Status::new(Code::Unknown, err.to_string()));
            }
        };

        let (tx, rx) = mpsc::channel(1);

        let mut in_stream = client.stream(ReceiverStream::new(rx)).await?.into_inner();
        let mut sender = MessageSender::Client(tx);
        let session = self
            .handshake(&mut in_stream, &mut sender, Some(peer_url))
            .await?;

        // this means we already have a session with this peer...
        let mut session = match session {
            None => return Ok(()), // this just means we already have a session with this peer
            Some(session) => session,
        };

        // Session is now established, process the session async...
        tokio::spawn(async move {
            match session.process(&mut in_stream).await {
                Ok(_) => {
                    debug!("client initiated stream ended");
                }
                Err(err) => {
                    debug!("client initiated stream processing failed {:?}", err);
                }
            }
            session.close().await;
        });

        Ok(())
    }

    // Reconnect failed peers periodically
    async fn reconnect_to_failed_peers(&self) {
        let failed_peers: Vec<_> = {
            let state = self.replication_state.read().await;
            state
                .peer_trackers
                .iter()
                .filter_map(|(_, peer_tracker)| {
                    if peer_tracker.session.is_none() {
                        // first try to connect to the configured URL
                        let mut urls: Vec<_> = peer_tracker.url.iter().cloned().collect();
                        // Then try to connect to discovered urls.
                        let mut discovered_urls =
                            peer_tracker.discovered_urls.iter().cloned().collect();
                        urls.append(&mut discovered_urls);
                        Some((peer_tracker.peer_id.clone(), urls))
                    } else {
                        None
                    }
                })
                .collect()
        };

        for (peer_id, urls) in failed_peers {
            for url in urls {
                debug!(
                    "attempting to reconnect to failed peer '{}' over {:?}",
                    peer_id, url
                );
                match self.connect_to_peer(url.clone()).await {
                    Ok(_) => break,
                    Err(err) => {
                        debug!("failed to connect with peer '{}': {:?}", url, err);
                    }
                }
            }
        }
    }

    // handshake is called when a new stream is created, it will handle the initial handshake
    // and updating the session state in the state.peer_trackers map.  Result is None if an
    // existing session is already established with the peer.
    async fn handshake(
        &self,
        in_stream: &mut Streaming<Packet>,
        out_stream: &mut MessageSender,
        peer_url: Option<String>,
    ) -> Result<Option<Session>, Status> {
        // Let the peer know who we are...
        let start = SystemTime::now(); // .duration_since(UNIX_EPOCH).unwrap().as_millis() as u64
        {
            let state = self.replication_state.read().await;
            out_stream
                .clone()
                .send(Ok(Message::Hello(Hello {
                    sender_peer_id: self.broker_state.id.clone(),
                    sender_urls: state.discovered_urls.clone().into_iter().collect(),
                    receiver_url: peer_url.clone(),
                })))
                .await?;
        }

        // Wait for the peer to tell us who he is...
        let peer_hello = read_hello(in_stream).await?;

        // respond with a Pong so the peer can calculate the round trip latency
        out_stream
            .clone()
            .send(Ok(Message::Pong(Pong {
                current_time: start.duration_since(UNIX_EPOCH).unwrap().as_millis() as u64,
            })))
            .await?;

        // Get the pong back from the peer...
        let peer_pong = read_pong(in_stream).await?;
        let end = SystemTime::now();

        let peer_id = peer_hello.sender_peer_id.clone();

        // When a peer initiates a connection, we discover a URL that can be used
        // to connect to us.
        if let Some(url) = peer_hello.receiver_url {
            let mut state = self.replication_state.write().await;
            state.discovered_urls.insert(url);
        }

        let session = Session {
            peer_id: peer_id.clone(),
            replication_state: self.replication_state.clone(),
            broker_state: self.broker_state.clone(),
            out_stream: out_stream.clone(),
        };

        // We now know who the peer is and our latency to him.
        let mut state = self.replication_state.write().await;
        let (tracker, option) = match state.peer_trackers.get_mut(&peer_id) {
            Some(tracker) => {
                match tracker.clone().session {
                    Some(prev_session) => {
                        // we already have a session with this peer, this is common since
                        // both peers are racing to connect to each other at the same time
                        // But we only need to keep one session.  Use the order of the
                        // peer ids to agree on which session keep.

                        if peer_id < self.broker_state.id {
                            // close the previous session, use the new one...
                            _ = prev_session
                                .out_stream
                                .send(Err(Status::already_exists("session")))
                                .await;
                            tracker.session = Some(session.clone());

                            (tracker, Some(session))
                        } else {
                            // use the previous session, close the new one...
                            _ = session
                                .out_stream
                                .send(Err(Status::already_exists("session")))
                                .await;
                            (tracker, None)
                        }
                    }
                    None => {
                        tracker.session = Some(session.clone());
                        (tracker, Some(session))
                    }
                }
            }
            None => {
                let latency = end.duration_since(start).unwrap();
                let peer_time = UNIX_EPOCH.add(Duration::from_millis(peer_pong.current_time));
                let peer_time_adj = peer_time.add(latency.div_f32(2.0)); // adjust for round trip latency
                let discovered_urls = peer_hello
                    .sender_urls
                    .iter()
                    .map(String::to_owned)
                    .collect();
                let tracker = PeerTracker {
                    peer_id: peer_id.clone(),
                    url: None,
                    discovered_urls,
                    latency: latency.as_millis() as u32,
                    clock_skew: ClockSkew::new(end, peer_time_adj),
                    session: Some(session.clone()),
                };

                debug!(
                    "peer {} clock skew: {}",
                    peer_id.clone(),
                    &tracker.clock_skew
                );
                state.peer_trackers.insert(peer_id.clone(), tracker);
                let tracker = state.peer_trackers.get_mut(&peer_id).unwrap();
                (tracker, Some(session))
            }
        };

        // keep track of the URL we used to connect to the peer.
        if peer_url.is_some() {
            tracker.url.clone_from(&peer_url)
        }

        Ok(option)
    }
}

#[tonic::async_trait]
impl Replication for Broker {
    type StreamStream = Pin<Box<dyn Stream<Item = Result<Packet, Status>> + Send>>;

    // Accepts a connection from a peer and starts a replication session
    async fn stream(
        &self,
        req: Request<Streaming<Packet>>,
    ) -> Result<Response<Self::StreamStream>, Status> {
        debug!("ReplicationServer::stream");

        let mut in_stream = req.into_inner();
        let (tx, rx) = mpsc::channel(1);

        let broker = self.clone();
        tokio::spawn(async move {
            let mut sender = MessageSender::Server(tx);
            match broker.handshake(&mut in_stream, &mut sender, None).await {
                Ok(Some(mut session)) => {
                    match session.process(&mut in_stream).await {
                        Ok(_) => {
                            debug!("server accepted stream ended");
                        }
                        Err(err) => {
                            debug!("server accepted stream processing failed {:?}", err);
                        }
                    }
                    session.close().await;
                }
                Ok(None) => {
                    // dup session..
                }
                Err(err) => {
                    debug!("stream handshake failed {:?}", err);
                }
            }
        });

        Ok(Response::new(
            Box::pin(ReceiverStream::new(rx)) as Self::StreamStream
        ))
    }
}