kojin-core 0.4.0

Core traits, types, and worker runtime for the kojin task queue
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

use async_trait::async_trait;

use super::Middleware;
use crate::error::KojinError;
use crate::message::TaskMessage;

/// Middleware that emits tracing spans for task execution.
#[derive(Debug, Default)]
pub struct TracingMiddleware;

#[async_trait]
impl Middleware for TracingMiddleware {
    async fn before(&self, message: &TaskMessage) -> Result<(), KojinError> {
        tracing::info!(
            task_id = %message.id,
            task_name = %message.task_name,
            queue = %message.queue,
            retries = message.retries,
            "Task starting"
        );
        Ok(())
    }

    async fn after(
        &self,
        message: &TaskMessage,
        _result: &serde_json::Value,
    ) -> Result<(), KojinError> {
        tracing::info!(
            task_id = %message.id,
            task_name = %message.task_name,
            "Task completed"
        );
        Ok(())
    }

    async fn on_error(&self, message: &TaskMessage, error: &KojinError) -> Result<(), KojinError> {
        tracing::error!(
            task_id = %message.id,
            task_name = %message.task_name,
            error = %error,
            retries = message.retries,
            max_retries = message.max_retries,
            "Task failed"
        );
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[tokio::test]
    async fn tracing_middleware_does_not_error() {
        let mw = TracingMiddleware;
        let msg = TaskMessage::new("test_task", "default", serde_json::json!({}));

        assert!(mw.before(&msg).await.is_ok());
        assert!(mw.after(&msg, &serde_json::json!("ok")).await.is_ok());
        assert!(
            mw.on_error(&msg, &KojinError::TaskFailed("err".into()))
                .await
                .is_ok()
        );
    }
}