lum 0.3.10

Lum Discord Bot
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

use core::fmt;
use std::{fmt::Display, sync::Arc};

use log::error;
use tokio::{signal, sync::Mutex, task};

use crate::service::{OverallStatus, Service, ServiceManager, ServiceManagerBuilder};

#[derive(Debug, Clone, Copy)]
pub enum ExitReason {
    SIGINT,
    EssentialServiceFailed,
}

impl Display for ExitReason {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::SIGINT => write!(f, "SIGINT"),
            Self::EssentialServiceFailed => write!(f, "Essential Service Failed"),
        }
    }
}

pub struct BotBuilder {
    name: String,
    service_manager: ServiceManagerBuilder,
}

impl BotBuilder {
    pub fn new(name: &str) -> Self {
        Self {
            name: name.to_string(),
            service_manager: ServiceManager::builder(),
        }
    }

    pub async fn with_service(mut self, service: Arc<Mutex<dyn Service>>) -> Self {
        self.service_manager = self.service_manager.with_service(service).await; // The ServiceManagerBuilder itself will warn when adding a service multiple times

        self
    }

    pub async fn with_services(mut self, services: Vec<Arc<Mutex<dyn Service>>>) -> Self {
        for service in services {
            self.service_manager = self.service_manager.with_service(service).await;
        }

        self
    }

    pub async fn build(self) -> Bot {
        Bot {
            name: self.name,
            service_manager: self.service_manager.build().await,
        }
    }
}

pub struct Bot {
    pub name: String,
    pub service_manager: Arc<ServiceManager>,
}

impl Bot {
    pub fn builder(name: &str) -> BotBuilder {
        BotBuilder::new(name)
    }

    pub async fn start(&mut self) {
        self.service_manager.start_services().await;
        //TODO: Potential for further initialization here, like modules
    }

    pub async fn stop(&mut self) {
        self.service_manager.stop_services().await;
        //TODO: Potential for further deinitialization here, like modules
    }

    pub async fn join(&self) -> ExitReason {
        let name_clone = self.name.clone();
        let signal_task = tokio::spawn(async move {
            let name = name_clone;

            let result = signal::ctrl_c().await;
            if let Err(error) = result {
                error!(
                    "Error receiving SIGINT: {}. {} will exit ungracefully immediately to prevent undefined behavior.",
                    error, name
                );
                panic!("Error receiving SIGINT: {}", error);
            }
        });

        let task_id = match task::try_id() {
            Some(id) => id.to_string(),
            None => "None".to_string(),
        };
        let subscriber_name = format!("Bot join on task {}", task_id);

        let service_manager_clone = self.service_manager.clone();
        let (_, mut receiver) = self
            .service_manager
            .on_status_change
            .event
            .subscribe_channel(subscriber_name, 2, true, true)
            .await;
        let status_task = tokio::spawn(async move {
            let service_manager = service_manager_clone;
            while (receiver.recv().await).is_some() {
                let overall_status = service_manager.overall_status().await;
                if overall_status == OverallStatus::Unhealthy {
                    return;
                }
            }
        });

        tokio::select! {
            _ = signal_task => ExitReason::SIGINT,
            _ = status_task => ExitReason::EssentialServiceFailed,
        }
    }
}