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
//! # Task Management Module
//!
//! This module defines the task management framework used to manage and execute
//! tasks in a web server application.
use std::collections::BTreeMap;
use async_trait::async_trait;
use crate::{app::AppContext, errors::Error, Result};
/// Struct representing a collection of task arguments.
#[derive(Default, Debug)]
pub struct Vars {
/// A list of cli arguments.
pub cli: BTreeMap<String, String>,
}
impl Vars {
/// Create [`Vars`] instance from cli arguments.
///
/// # Arguments
///
/// * `key` - A string representing the key.
/// * `value` - A string representing the value.
///
/// # Example
///
/// ```
/// use loco_rs::task::Vars;
///
/// let args = vec![("key1".to_string(), "value".to_string())];
/// let vars = Vars::from_cli_args(args);
/// ```
#[must_use]
pub fn from_cli_args(args: Vec<(String, String)>) -> Self {
Self {
cli: args.into_iter().collect(),
}
}
/// Retrieves the value associated with the given key from the `cli` list.
///
/// # Errors
///
/// Returns an error if the key does not exist.
///
/// # Example
///
/// ```
/// use loco_rs::task::Vars;
///
/// let args = vec![("key1".to_string(), "value".to_string())];
/// let vars = Vars::from_cli_args(args);
///
/// assert!(vars.cli_arg("key1").is_ok());
/// assert!(vars.cli_arg("not-exists").is_err());
/// ```
pub fn cli_arg(&self, key: &str) -> Result<&String> {
self.cli
.get(key)
.ok_or(Error::Message(format!("the argument {key} does not exist")))
}
}
/// Information about a task, including its name and details.
#[allow(clippy::module_name_repetitions)]
pub struct TaskInfo {
pub name: String,
pub detail: String,
}
/// A trait defining the behavior of a task.
#[async_trait]
pub trait Task: Send + Sync {
/// Get information about the task.
fn task(&self) -> TaskInfo;
/// Execute the task with the provided application context and variables.
async fn run(&self, app_context: &AppContext, vars: &Vars) -> Result<()>;
}
/// Managing and running tasks.
#[derive(Default)]
pub struct Tasks {
registry: BTreeMap<String, Box<dyn Task>>,
}
impl Tasks {
/// List all registered tasks with their information.
#[must_use]
pub fn list(&self) -> Vec<TaskInfo> {
self.registry.values().map(|t| t.task()).collect::<Vec<_>>()
}
/// Run a registered task by name with provided variables.
///
/// # Errors
///
/// Returns a [`Result`] if an task finished with error. mostly if the given
/// task is not found or an error to run the task.s
pub async fn run(&self, app_context: &AppContext, task: &str, vars: &Vars) -> Result<()> {
let task = self
.registry
.get(task)
.ok_or_else(|| Error::TaskNotFound(task.to_string()))?;
task.run(app_context, vars).await?;
Ok(())
}
/// Register a new task to the registry.
pub fn register(&mut self, task: impl Task + 'static) {
let name = task.task().name;
self.registry.insert(name, Box::new(task));
}
}