Merge pull request #24 from kindredgroup/feat/allow-attaching-additional-metrics-on-task-completion

feat: allow attaching additional metrics on task completion

Author: hamisor

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "scylla_models"
-version = "0.1.33"
+version = "0.1.35"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

scylla_models/Cargo.toml

@@ -12,7 +12,7 @@ pub struct AddTaskModel {
     pub queue: String,
 }
 
-#[derive(Debug)]
+#[derive(Debug, Default)]
 pub struct UpdateTaskModel {
     pub rn: String,
     pub operation: UpdateOperation,
@@ -21,6 +21,7 @@ pub struct UpdateTaskModel {
     pub worker: Option<String>,
     pub progress: Option<f32>,
     pub task_timeout_in_secs: Option<i64>,
+    pub metrics: Option<Value>,
 }
 
 #[derive(Debug)]
@@ -41,11 +42,12 @@ impl Default for GetTaskModel {
     }
 }
 
-#[derive(Debug, Serialize, Deserialize, Clone, Eq, PartialEq)]
+#[derive(Debug, Serialize, Deserialize, Clone, Eq, PartialEq, Default)]
 #[serde(rename_all = "camelCase")]
 pub enum UpdateOperation {
     Yield,
     HeartBeat,
+    #[default]
     Status,
     Lease,
     Reset,
@@ -129,6 +131,7 @@ pub struct Task {
     pub owner: Option<String>,
     pub errors: Vec<TaskError>,
     pub history: Vec<TaskHistory>,
+    pub metrics: Option<Value>,
 }
 impl Default for Task {
     fn default() -> Self {
@@ -145,6 +148,7 @@ impl Default for Task {
             owner: None,
             errors: Vec::default(),
             history: Vec::default(),
+            metrics: None,
         }
     }
 }
@@ -177,10 +181,11 @@ mod tests {
             status: None,
             worker: None,
             task_timeout_in_secs: None,
+            metrics: None,
         };
         assert_eq!(
             format!("{:?}", utm),
-            "UpdateTaskModel { rn: \"1.2.3\", operation: HeartBeat, status: None, error: None, worker: None, progress: None, task_timeout_in_secs: None }"
+            "UpdateTaskModel { rn: \"1.2.3\", operation: HeartBeat, status: None, error: None, worker: None, progress: None, task_timeout_in_secs: None, metrics: None }"
         );
     }
     #[test]
@@ -268,7 +273,7 @@ mod tests {
             ..Task::default()
         };
         // debug trait
-        assert_eq!(format!("{:?}", t), format!("Task {{ rn: \"\", spec: Null, status: Ready, queue: \"\", progress: 0.0, priority: 0, created: {0:?}, updated: {0:?}, deadline: None, owner: None, errors: [], history: [] }}", t_now));
+        assert_eq!(format!("{:?}", t), format!("Task {{ rn: \"\", spec: Null, status: Ready, queue: \"\", progress: 0.0, priority: 0, created: {0:?}, updated: {0:?}, deadline: None, owner: None, errors: [], history: [], metrics: None }}", t_now));
         // default()
         let t = Task {
             created: t_now,
@@ -290,6 +295,7 @@ mod tests {
                 owner: None,
                 errors: Vec::default(),
                 history: Vec::default(),
+                metrics: None,
             }
         )
     }

scylla_models/src/lib.rs

@@ -1,6 +1,6 @@
 [package]
 name = "scylla_operations"
-version = "0.1.33"
+version = "0.1.35"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

scylla_operations/Cargo.toml

@@ -31,9 +31,7 @@ fn update_task_calls_get_and_update() {
         operation: UpdateOperation::Lease,
         status: Some(TaskStatus::Running),
         worker: Some("worker1".to_string()),
-        error: None,
-        progress: None,
-        task_timeout_in_secs: None,
+        ..UpdateTaskModel::default()
     };
     let task_to_update = Task {
         rn: "unique_id".to_string(),
@@ -58,10 +56,7 @@ fn update_task_returns_scylla_op_error() {
         rn: "unique_id".to_string(),
         operation: UpdateOperation::Status,
         status: Some(TaskStatus::Completed),
-        worker: None,
-        error: None,
-        progress: None,
-        task_timeout_in_secs: None,
+        ..UpdateTaskModel::default()
     };
 
     assert_eq!(

scylla_operations/src/task/tests.rs

@@ -34,6 +34,9 @@ pub fn validate_status_operation(task: &Task, update_task_model: &UpdateTaskMode
 fn prepare_status_task(mut task: Task, update_task_model: &UpdateTaskModel) -> Task {
     task.status = update_task_model.status.clone().unwrap();
     task.updated = Utc::now();
+    if let Some(metrics) = &update_task_model.metrics {
+        task.metrics = Some(metrics.clone());
+    }
     if let Some(error) = update_task_model.error.clone() {
         if task.status == TaskStatus::Aborted {
             task.errors.push(error);