botcore 1.0.10

Production-grade asynchronous bot engine with enterprise observability features
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

use anyhow;
use thiserror::Error;

/// Represents all possible errors that can occur in the bot engine.
///
/// This enum provides structured error types for different components of the system:
/// - Collector errors (event source issues)
/// - Strategy errors (event processing issues)
/// - Executor errors (action execution issues)
/// - Channel errors (communication issues)
#[derive(Error, Debug)]
pub enum BotError {
    /// An error that occurred in a collector component.
    #[error("Collector error: {message}")]
    CollectorError {
        /// A description of what went wrong
        message: String,
        /// The underlying error that caused this failure, if any
        source: Option<Box<dyn std::error::Error + Send + Sync>>,
    },

    /// An error that occurred in a strategy component.
    #[error("Strategy error: {message}")]
    StrategyError {
        /// A description of what went wrong
        message: String,
        /// The underlying error that caused this failure, if any
        source: Option<Box<dyn std::error::Error + Send + Sync>>,
    },

    /// An error that occurred in an executor component.
    #[error("Executor error: {message}")]
    ExecutorError {
        /// A description of what went wrong
        message: String,
        /// The underlying error that caused this failure, if any
        source: Option<Box<dyn std::error::Error + Send + Sync>>,
    },

    /// An error that occurred in the channel communication system.
    #[error("Channel error: {message}")]
    ChannelError {
        /// A description of what went wrong
        message: String,
        /// The underlying error that caused this failure, if any
        source: Option<Box<dyn std::error::Error + Send + Sync>>,
    },

    /// A catch-all variant for errors that don't fit into other categories.
    #[error(transparent)]
    Other(#[from] anyhow::Error),
}

/// A specialized Result type for bot operations.
pub type Result<T> = std::result::Result<T, BotError>;

impl BotError {
    /// Creates a new collector error with just a message.
    ///
    /// # Arguments
    ///
    /// * `message` - A description of what went wrong
    pub fn collector_error(message: impl Into<String>) -> Self {
        Self::CollectorError {
            message: message.into(),
            source: None,
        }
    }

    /// Creates a new collector error with both a message and an underlying cause.
    ///
    /// # Arguments
    ///
    /// * `message` - A description of what went wrong
    /// * `source` - The underlying error that caused this failure
    pub fn collector_error_with_source(
        message: impl Into<String>,
        source: impl Into<Box<dyn std::error::Error + Send + Sync>>,
    ) -> Self {
        Self::CollectorError {
            message: message.into(),
            source: Some(source.into()),
        }
    }

    /// Creates a new strategy error with just a message.
    ///
    /// # Arguments
    ///
    /// * `message` - A description of what went wrong
    pub fn strategy_error(message: impl Into<String>) -> Self {
        Self::StrategyError {
            message: message.into(),
            source: None,
        }
    }

    /// Creates a new strategy error with both a message and an underlying cause.
    ///
    /// # Arguments
    ///
    /// * `message` - A description of what went wrong
    /// * `source` - The underlying error that caused this failure
    pub fn strategy_error_with_source(
        message: impl Into<String>,
        source: impl Into<Box<dyn std::error::Error + Send + Sync>>,
    ) -> Self {
        Self::StrategyError {
            message: message.into(),
            source: Some(source.into()),
        }
    }

    /// Creates a new executor error with just a message.
    ///
    /// # Arguments
    ///
    /// * `message` - A description of what went wrong
    pub fn executor_error(message: impl Into<String>) -> Self {
        Self::ExecutorError {
            message: message.into(),
            source: None,
        }
    }

    /// Creates a new executor error with both a message and an underlying cause.
    ///
    /// # Arguments
    ///
    /// * `message` - A description of what went wrong
    /// * `source` - The underlying error that caused this failure
    pub fn executor_error_with_source(
        message: impl Into<String>,
        source: impl Into<Box<dyn std::error::Error + Send + Sync>>,
    ) -> Self {
        Self::ExecutorError {
            message: message.into(),
            source: Some(source.into()),
        }
    }

    /// Creates a new channel error with just a message.
    ///
    /// # Arguments
    ///
    /// * `message` - A description of what went wrong
    pub fn channel_error(message: impl Into<String>) -> Self {
        Self::ChannelError {
            message: message.into(),
            source: None,
        }
    }

    /// Creates a new channel error with both a message and an underlying cause.
    ///
    /// # Arguments
    ///
    /// * `message` - A description of what went wrong
    /// * `source` - The underlying error that caused this failure
    pub fn channel_error_with_source(
        message: impl Into<String>,
        source: impl Into<Box<dyn std::error::Error + Send + Sync>>,
    ) -> Self {
        Self::ChannelError {
            message: message.into(),
            source: Some(source.into()),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::error::Error;
    use std::fmt;

    #[derive(Debug)]
    struct TestError(String);

    impl fmt::Display for TestError {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            write!(f, "{}", self.0)
        }
    }

    impl Error for TestError {}

    #[test]
    fn test_collector_error() {
        let error = BotError::collector_error("test error");
        assert!(
            matches!(error, BotError::CollectorError { message, source } 
            if message == "test error" && source.is_none())
        );

        let source = TestError("source error".to_string());
        let error = BotError::collector_error_with_source("test error", source);
        assert!(
            matches!(error, BotError::CollectorError { message, source: Some(_) }
            if message == "test error")
        );
    }

    #[test]
    fn test_strategy_error() {
        let error = BotError::strategy_error("test error");
        assert!(matches!(error, BotError::StrategyError { message, source }
            if message == "test error" && source.is_none()));

        let source = TestError("source error".to_string());
        let error = BotError::strategy_error_with_source("test error", source);
        assert!(
            matches!(error, BotError::StrategyError { message, source: Some(_) }
            if message == "test error")
        );
    }

    #[test]
    fn test_executor_error() {
        let error = BotError::executor_error("test error");
        assert!(matches!(error, BotError::ExecutorError { message, source }
            if message == "test error" && source.is_none()));

        let source = TestError("source error".to_string());
        let error = BotError::executor_error_with_source("test error", source);
        assert!(
            matches!(error, BotError::ExecutorError { message, source: Some(_) }
            if message == "test error")
        );
    }

    #[test]
    fn test_channel_error() {
        let error = BotError::channel_error("test error");
        assert!(matches!(error, BotError::ChannelError { message, source }
            if message == "test error" && source.is_none()));

        let source = TestError("source error".to_string());
        let error = BotError::channel_error_with_source("test error", source);
        assert!(
            matches!(error, BotError::ChannelError { message, source: Some(_) }
            if message == "test error")
        );
    }

    #[test]
    fn test_error_conversion() {
        let anyhow_error = anyhow::anyhow!("test error");
        let error: BotError = anyhow_error.into();
        assert!(matches!(error, BotError::Other(_)));
    }

    #[test]
    fn test_error_display() {
        let error = BotError::collector_error("test error");
        assert_eq!(error.to_string(), "Collector error: test error");

        let error = BotError::strategy_error("test error");
        assert_eq!(error.to_string(), "Strategy error: test error");

        let error = BotError::executor_error("test error");
        assert_eq!(error.to_string(), "Executor error: test error");

        let error = BotError::channel_error("test error");
        assert_eq!(error.to_string(), "Channel error: test error");
    }
}