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
//! Create and manage distributed applications in Rust.
//!
//! Built with the motto - *Plug the crate in, it'll be taken care of.*
//!
//! ## Usage
//! ```rust
//! # use cloud_discovery_kubernetes::KubernetesDiscoverService;
//! # use std::sync::Arc;
//! # use rust_cloud_discovery::DiscoveryClient;
//! # use cluster_mode::{start_cluster, Cluster};
//! # #[tokio::main]
//! # async fn main() {
//!     let result = KubernetesDiscoverService::init("demo".to_string(), "default".to_string())
//!         .await;
//!     if let Ok(k8s) = result {
//!         let cluster = Arc::new(Cluster::default());
//!         let client = DiscoveryClient::new(k8s);
//!         tokio::spawn(start_cluster(cluster, client));
//!     }
//! # }
//! ```
//! The `Cluster` struct provides a set of functions for example `async fn primaries(&self) -> Option<HashSet<RestClusterNode>>`
//! or `async fn is_active(&self) -> bool` to communicate with the cluster.
//!
//! Checkout [Cluster] for more details
//!

#![warn(missing_docs)]
#[macro_export]
#[doc(hidden)]
macro_rules! log_error {
    ($result:expr) => {
        if let Err(e) = $result {
            error!("{}", e.to_string());
        }
    };
}

use almost_raft::election::{raft_election, RaftElectionState};
use almost_raft::{Message, Node};

use async_trait::async_trait;
use bytes::Bytes;
use futures_util::stream::FuturesUnordered;
use http::{Error, Request};
use hyper::client::{Client, HttpConnector};
use hyper::Body;
use log::{debug, error, info, trace};

use rust_cloud_discovery::{DiscoveryClient, DiscoveryService, ServiceInstance};
use serde::{Deserialize, Serialize};

use std::collections::{HashMap, HashSet};
use std::hash::{Hash, Hasher};
use std::result::Result::Err;
use std::sync::Arc;
use std::time::{Duration, Instant};
use tokio::sync::mpsc::Sender;
use tokio::sync::{mpsc, RwLock};
use tokio_stream::StreamExt;

/// Status of a node/instance
pub enum InstanceMode {
    /// Haven't joined to any cluster yet
    Inactive,
    /// Current node is acting as a primary/leader
    Primary,
    /// It's a Secondary node
    Secondary,
}

#[allow(dead_code)]
/// Describes a cluster, including operating mode, primaries & secondaries
pub struct Cluster {
    /// Identifier of current node, UUID String
    self_id: String,
    /// Mode of the cluster
    mode: RwLock<InstanceMode>,
    /// Interval between discovery service call, in milliseconds
    update_interval: u64,
    /// [ServiceInstance] representing current cluster node
    self_: RwLock<Option<ServiceInstance>>,
    /// List of primaries
    primaries: RwLock<HashSet<RestClusterNode>>,
    /// List of Secondaries
    secondaries: RwLock<Arc<HashSet<RestClusterNode>>>,
    /// how many primaries
    n_primary: usize,
    /// MPSC channel [Sender<Message<T>>] to communicate with Raft
    raft_tx: RwLock<Option<Sender<Message<RestClusterNode>>>>,
}

impl Cluster {
    /// Initialize `Cluster`
    /// # Arguments
    /// * update_interval - milliseconds, Interval between discovery service call
    pub fn new(update_interval: u64) -> Self {
        Cluster {
            update_interval,
            ..Default::default()
        }
    }

    #[doc(hidden)]
    /// For testing purpose
    pub fn _new(mode: InstanceMode, secondaries: HashSet<RestClusterNode>) -> Self {
        Cluster {
            mode: RwLock::new(mode),
            secondaries: RwLock::new(Arc::new(secondaries)),
            ..Default::default()
        }
    }

    /// Get the list of secondaries. Returns `None` if Cluster is inactive or in
    /// [Secondary](InstanceMode::Secondary) mode. List can be empty.
    pub async fn secondaries(&self) -> Option<Arc<HashSet<RestClusterNode>>> {
        if self.is_primary().await {
            let guard = self.secondaries.read().await;
            Some(guard.clone())
        } else {
            info!("[node: {}] not a primary node", &self.self_id);
            None
        }
    }

    /// Get the list of primaries. Returns `None` if Cluster is inactive or in
    /// [Primary](InstanceMode::Primary) mode. List can be empty.
    pub async fn primaries(&self) -> Option<HashSet<RestClusterNode>> {
        if self.is_secondary().await {
            let guard = self.primaries.read().await;
            Some(guard.clone())
        } else {
            info!("[node: {}] not a secondary node", &self.self_id);
            None
        }
    }

    /// true if Cluster mode is [Primary](InstanceMode::Primary)
    #[inline]
    pub async fn is_primary(&self) -> bool {
        let guard = self.mode.read().await;
        matches!(*guard, InstanceMode::Primary)
    }

    /// true if Cluster mode is [Secondary](InstanceMode::Secondary)
    #[inline]
    pub async fn is_secondary(&self) -> bool {
        let guard = self.mode.read().await;
        matches!(*guard, InstanceMode::Secondary)
    }

    /// true if Cluster mode is not [Inactive](InstanceMode::Inactive)
    #[inline]
    pub async fn is_active(&self) -> bool {
        let guard = self.mode.read().await;
        !matches!(*guard, InstanceMode::Inactive)
    }

    /// Forward [almost_raft::Message::RequestVote] message to Raft process
    pub async fn accept_raft_request_vote(&self, requester_node_id: String, term: usize) {
        self.send_message_to_raft(Message::RequestVote {
            term,
            node_id: requester_node_id,
        })
        .await;
    }

    /// Forward [almost_raft::Message::RequestVoteResponse] message to Raft process
    pub async fn accept_raft_request_vote_resp(&self, term: usize, vote: bool) {
        self.send_message_to_raft(Message::RequestVoteResponse { term, vote })
            .await;
    }

    /// Forward [almost_raft::Message::HeartBeat] message to Raft process
    pub async fn accept_raft_heartbeat(&self, leader_node_id: String, term: usize) {
        self.send_message_to_raft(Message::HeartBeat {
            leader_node_id,
            term,
        })
        .await;
    }

    async fn send_message_to_raft(&self, msg: Message<RestClusterNode>) {
        trace!(
            "[node: {}] sending messages to raft: {:?}",
            &self.self_id,
            &msg
        );
        let guard = self.raft_tx.read().await;
        if let Some(tx) = guard.as_ref() {
            let result = tx.send(msg).await;
            log_error!(result);
        }
    }
}

impl Default for Cluster {
    fn default() -> Self {
        Cluster {
            self_id: uuid::Uuid::new_v4().to_string(),
            mode: RwLock::from(InstanceMode::Inactive),
            update_interval: 10 * 1000,
            self_: Default::default(),
            primaries: Default::default(),
            secondaries: Default::default(),
            n_primary: 1,
            raft_tx: Default::default(),
        }
    }
}

/// Start the cluster. Note that, this function has infinite loop, so should always spawn a new thread.
pub async fn start_cluster<T: DiscoveryService>(
    cluster: Arc<Cluster>,
    discovery_service: DiscoveryClient<T>,
) {
    info!("[node: {}] starting cluster...", &cluster.self_id);
    let raft_tx_timeout = 15;

    let (tx, mut raft_rx) = mpsc::channel::<Message<RestClusterNode>>(20);

    let (raft, raft_tx) = RaftElectionState::init(
        cluster.self_id.clone(),
        30 * 1000,
        10 * 1000,
        500,
        vec![],
        tx.clone(),
        20,
        3,
    );

    {
        let mut write_guard = cluster.raft_tx.write().await;
        *write_guard = Some(raft_tx.clone());
    }

    info!("[node: {}] spawning raft election...", &cluster.self_id);
    tokio::spawn(raft_election(raft));

    let mut remaining_update_interval = cluster.update_interval;

    let client = Client::new();

    //todo reconfirm if map is needed or only set of node id is enough
    // map of service instance_id, RestClusterNode
    let mut discovered: HashMap<String, RestClusterNode> = HashMap::new();

    loop {
        trace!(
            "[node: {}] update timeout: {}",
            &cluster.self_id,
            &remaining_update_interval
        );
        //get message from raft or time to check discovery service
        let start_time = Instant::now();
        let raft_msg = tokio::time::timeout(
            Duration::from_millis(remaining_update_interval),
            raft_rx.recv(),
        )
        .await;

        if let Ok(msg) = raft_msg {
            //only control message is expected, other message should be handled through peer
            handle_control_message_from_raft(&cluster, &discovered, msg).await;
            remaining_update_interval = unsigned_subtract(
                remaining_update_interval,
                start_time.elapsed().as_millis() as u64,
            );
            continue;
        }
        remaining_update_interval = cluster.update_interval;

        trace!("[node: {}] calling discovery service.", &cluster.self_id);
        let instances = if let Ok(instance) = discovery_service.get_instances().await {
            instance
        } else {
            vec![]
        };

        debug!("discovered instances: {:?}", instances);

        // collect cluster info
        let mut requests = FuturesUnordered::new();
        let mut current_instances = HashSet::new();
        for instance in instances {
            let id;
            if instance.instance_id().is_some() {
                id = instance.instance_id().clone().unwrap();
            } else {
                //must have some identifier
                continue;
            }
            if discovered.contains_key(&id) //no need to get info if already discovered
                || instance.uri().is_none()
            {
                current_instances.insert(id);
                continue;
            }
            current_instances.insert(id);

            let request = Request::builder()
                .uri(format!("{}{}", instance.uri().clone().unwrap(), PATH_INFO))
                .body(Body::empty());
            // use FuturesUnordered for parallel requests
            requests.push(send_request(&client, request, instance));
        }

        let mut new_nodes = HashSet::new();
        while let Some(result) = requests.next().await {
            match result {
                Ok((resp, instance)) => {
                    let info = serde_json::from_slice::<ClusterInfo>(resp.as_ref());
                    trace!(
                        "[node: {}] cluster info {:?} from {:?}",
                        &cluster.self_id,
                        &info,
                        &instance
                    );
                    if let Ok(info) = info {
                        if info.node_id == cluster.self_id {
                            {
                                let mut guard = cluster.self_.write().await;
                                guard.replace(instance.clone());
                            }
                            //is it need to add self to raft? or only peers.
                            // Ans: Only peers, has self id to identify itself
                        }
                        let node = RestClusterNode::new(info.node_id, instance);
                        if cluster.self_id != node.node_id {
                            new_nodes.insert(node.inner.instance_id().clone().unwrap());
                            //todo handle failure
                            debug!("[node: {}] new node found: {:?}", &cluster.self_id, &node);
                            let result = raft_tx
                                .send_timeout(
                                    Message::ControlAddNode(node.clone()),
                                    Duration::from_millis(raft_tx_timeout),
                                )
                                .await;
                            log_error!(result);
                        }
                        discovered.insert(node.inner.instance_id().clone().unwrap(), node);
                    }
                }
                Err(err) => {
                    error!(
                        "[node: {}] error getting cluster info: {}",
                        &cluster.self_id,
                        err.to_string()
                    );
                }
            }
        }

        let mut removed_nodes = HashSet::new();
        // remove if not exists in newly discovered instance list
        for (key, val) in discovered.iter() {
            if !current_instances.contains(val.service_instance().instance_id().as_ref().unwrap()) {
                removed_nodes.insert(key.clone());
            }
        }

        if !new_nodes.is_empty() || !removed_nodes.is_empty() {
            //update secondaries
            let mut current = {
                let guard = cluster.secondaries.read().await;
                guard.clone().as_ref().clone()
            };
            for node in removed_nodes {
                let removed = discovered.remove(&node);
                if let Some(removed) = removed {
                    debug!("removing node: {:?}", &removed);
                    current.remove(&removed);
                    let result = raft_tx
                        .send_timeout(
                            Message::ControlRemoveNode(removed),
                            Duration::from_millis(raft_tx_timeout),
                        )
                        .await;
                    log_error!(result);
                }
            }
            for node in new_nodes {
                if let Some(node) = discovered.get(&node) {
                    current.insert(node.clone());
                }
            }
            {
                trace!(
                    "[node: {}] updating secondaries to: {:?}",
                    &cluster.self_id,
                    &current
                );
                let mut write_guard = cluster.secondaries.write().await;
                *write_guard = Arc::new(current);
            }
        }
    }
}

async fn send_request(
    client: &Client<HttpConnector>,
    request: Result<Request<Body>, Error>,
    instance: ServiceInstance,
) -> anyhow::Result<(Bytes, ServiceInstance)> {
    let request = request?;
    let resp = client.request(request).await?;
    let resp = hyper::body::to_bytes(resp).await?;
    Ok((resp, instance))
}

#[inline]
async fn handle_control_message_from_raft(
    cluster: &Arc<Cluster>,
    discovered: &HashMap<String, RestClusterNode>,
    msg: Option<Message<RestClusterNode>>,
) {
    info!(
        "[node: {}] control message from raft: {:?}",
        cluster.self_id, &msg
    );
    if let Some(Message::ControlLeaderChanged(node_id)) = msg {
        let mut node = None;
        for discovered_node in discovered.values() {
            if discovered_node.node_id == node_id {
                node = Some(discovered_node);
            }
        }
        if let Some(node) = node {
            info!("new primary: {:?}", node);
            let mode = if cluster.self_id == node_id {
                InstanceMode::Primary
            } else {
                InstanceMode::Secondary
            };
            {
                let mut write_guard = cluster.mode.write().await;
                *write_guard = mode;
            }
            let node = node.clone();
            let mut write_guard = cluster.primaries.write().await;
            write_guard.insert(node);
        } else {
            error!("Node not found in discovered list");
        }
    }
}

/// Returns selective information on current cluster
pub async fn get_cluster_info(cluster: Arc<Cluster>) -> ClusterInfo {
    let node = {
        let guard = cluster.self_.read().await;
        guard.as_ref().map(|x| x.to_owned())
    };
    ClusterInfo {
        instance: node,
        node_id: cluster.self_id.clone(),
        update_interval: cluster.update_interval,
    }
}

/// Describe cluster
#[derive(Debug, Serialize, Deserialize)]
pub struct ClusterInfo {
    /// Cluster node id, UUID
    pub node_id: String,
    /// [ServiceInstance] representing current node
    pub instance: Option<ServiceInstance>,
    /// Interval between discovery service call, in milliseconds
    pub update_interval: u64,
}

/// An implementation of [almost_raft::Node]
///
/// `RestClusterNode` uses REST API to communicate with other cluster nodes. User of the crate
/// *must* provide the following endpoints
/// * /cluster/raft/request-vote/{requester_node_id:string}/{term:uint32}
/// * /cluster/raft/vote/{term:uint32}/{true|false}
/// * /cluster/raft/beat/{leader_node_id:string}/{term:uint32}
#[derive(Debug, Clone)]
pub struct RestClusterNode {
    pub(crate) node_id: String,
    pub(crate) inner: ServiceInstance,
}

impl RestClusterNode {
    /// Create new instance
    /// # Arguments
    /// * node_id - Unique identifier, better be UUID
    /// * instance - [ServiceInstance](rust_cloud_discovery::ServiceInstance) of the node
    pub fn new(node_id: String, instance: ServiceInstance) -> Self {
        Self {
            node_id,
            inner: instance,
        }
    }

    /// Get the instance represented by discovery service
    pub fn service_instance(&self) -> &ServiceInstance {
        &self.inner
    }

    async fn send_request_vote(&self, node_id: String, term: usize) -> anyhow::Result<()> {
        self.send_raft_request(format!(
            "{}{}/{}/{}",
            self.inner.uri().clone().unwrap(),
            PATH_RAFT_REQUEST_VOTE,
            node_id,
            term
        ))
        .await
    }

    async fn send_request_vote_response(&self, vote: bool, term: usize) -> anyhow::Result<()> {
        self.send_raft_request(format!(
            "{}{}/{}/{}",
            self.inner.uri().clone().unwrap(),
            PATH_RAFT_VOTE,
            term,
            vote
        ))
        .await
    }

    async fn send_heartbeat(&self, leader_node_id: String, term: usize) -> anyhow::Result<()> {
        self.send_raft_request(format!(
            "{}{}/{}/{}",
            self.inner.uri().clone().unwrap(),
            PATH_RAFT_HEARTBEAT,
            leader_node_id,
            term
        ))
        .await
    }

    async fn send_raft_request(&self, uri: String) -> anyhow::Result<()> {
        trace!(
            "sending raft request to node: {}, path: {}",
            &self.node_id,
            &uri
        );
        let request = Request::builder().uri(uri).body(Body::empty())?;
        //todo use pooled connection
        let client = Client::new();
        let resp = client.request(request).await?;
        let resp = hyper::body::to_bytes(resp).await?;
        trace!(
            "raft request response: {:?}",
            std::str::from_utf8(resp.as_ref())
        );
        Ok(())
    }
}

#[async_trait]
impl Node for RestClusterNode {
    type NodeType = RestClusterNode;

    async fn send_message(&self, msg: Message<Self::NodeType>) {
        debug!(
            "[RestClusterNode: {}] message from raft: {:?}",
            &self.node_id, &msg
        );
        match msg {
            Message::RequestVote { node_id, term } => {
                let result = self.send_request_vote(node_id, term).await;
                log_error!(result);
            }
            Message::RequestVoteResponse { vote, term } => {
                let result = self.send_request_vote_response(vote, term).await;
                log_error!(result);
            }
            Message::HeartBeat {
                leader_node_id,
                term,
            } => {
                let result = self.send_heartbeat(leader_node_id, term).await;
                log_error!(result);
            }
            _ => {}
        }
    }

    fn node_id(&self) -> &String {
        &self.node_id
    }
}

impl PartialEq for RestClusterNode {
    fn eq(&self, other: &Self) -> bool {
        self.node_id.eq(&other.node_id)
    }
}

impl Eq for RestClusterNode {}

impl Hash for RestClusterNode {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.node_id.hash(state);
    }
}

const PATH_INFO: &str = "/cluster/info";
/// /cluster/raft/request-vote/{requester_node_id}/{term}
const PATH_RAFT_REQUEST_VOTE: &str = "/cluster/raft/request-vote";
/// /cluster/raft/vote/{term}/{true|false}
const PATH_RAFT_VOTE: &str = "/cluster/raft/vote";
/// /cluster/raft/beat/{leader_node_id}/{term}
const PATH_RAFT_HEARTBEAT: &str = "/cluster/raft/beat";

/// subtract unsigned number, if negative, return 0.
#[inline(always)]
fn unsigned_subtract<T>(lhs: T, rhs: T) -> T
where
    T: PartialEq + PartialOrd + std::ops::Sub<Output = T> + From<u64>,
{
    if lhs < rhs {
        0.into()
    } else {
        lhs - rhs
    }
}

#[cfg(test)]
mod test {
    use crate::{start_cluster, Cluster};
    use cloud_discovery_kubernetes::KubernetesDiscoverService;
    use rust_cloud_discovery::DiscoveryClient;
    use std::sync::Arc;

    #[tokio::test]
    async fn test_cluster_impl() {
        let result =
            KubernetesDiscoverService::init("overload".to_string(), "default".to_string()).await;
        if let Ok(k8s) = result {
            let cluster = Arc::new(Cluster::default());
            let client = DiscoveryClient::new(k8s);
            tokio::spawn(start_cluster(cluster, client));
        }
    }
    #[test]
    fn misc() {}
}