shepherd-rs 0.2.0

Shepherd is a resilient, non-blocking orchestrator that persistently transforms and delivers data—built for remote, compute-heavy workloads.
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

//! # Dummy Instrumentation
//!
//! This module provides a dummy implementation of the `Instrumentation` trait.
//!
//! ## Overview
//! - **DummyInstrumentation**: A placeholder implementation for testing and
//!   debugging.
//! - **Event Handling**: Tracks transformation and consumption events.
//!
//! ## Example
//! ```rust
//! let instrumentation = DummyInstrumentation::new();
//! instrumentation.request_added(...);
//! ```

use std::sync::Arc;

use async_trait::async_trait;
use tokio::sync::Mutex;

use crate::config::Config;
use crate::instrumentation::instrumentation::Instrumentation;

pub struct DummyInstrumentation<TRI, TAI, CAI, C>
where
    TRI: Send + Sync,
    TAI: Send + Sync,
    CAI: Send + Sync,
    C: Config,
{
    _marker: std::marker::PhantomData<(TRI, TAI, CAI, C)>,
}

#[async_trait]
impl<TRI, TAI, CAI, C> Instrumentation for DummyInstrumentation<TRI, TAI, CAI, C>
where
    TRI: Send + Sync,
    TAI: Send + Sync,
    CAI: Send + Sync,
    C: Config,
{
    type Config = C;
    type ConsumeAttemptIdentifier = CAI;
    type TransformAttemptIdentifier = TAI;
    type TransformRequestIdentifier = TRI;

    /// Creates a new instance of `DummyInstrumentation`.
    ///
    /// # Arguments
    /// * `config` - A shared, mutable reference to the configuration.
    ///
    /// # Returns
    /// * `Ok(Self)` - A new instance of `DummyInstrumentation`.
    /// * `Err(String)` - An error message if the creation fails.
    async fn new(_config: Arc<Mutex<Self::Config>>) -> Result<Self, String>
    where
        Self: Sized,
    {
        Ok(DummyInstrumentation {
            _marker: std::marker::PhantomData,
        })
    }

    /// A dummy implementation of the instrumentation loop.
    ///
    /// # Returns
    /// * `Ok(())` - Indicates the loop has completed successfully.
    /// * `Err(String)` - An error message if the loop encounters an issue.
    async fn instrumentation_loop(&mut self) -> Result<(), String> { Ok(()) }

    /// Records the addition of a request.
    ///
    /// # Arguments
    /// * `request_id` - The identifier of the request that was added.
    fn request_added(&mut self, _request_id: Self::TransformRequestIdentifier) {}

    /// Records the completion of a request.
    ///
    /// # Arguments
    /// * `request_id` - The identifier of the request that was completed.
    fn request_completed(&mut self, _request_id: Self::TransformRequestIdentifier) {}

    /// Records the start of a transform attempt.
    ///
    /// # Arguments
    /// * `request_id` - The identifier of the request for which the transform
    ///   attempt started.
    fn transform_attempt_started(&mut self, _request_id: Self::TransformAttemptIdentifier) {}

    /// Records the completion of a transform attempt.
    ///
    /// # Arguments
    /// * `request_id` - The identifier of the request for which the transform
    ///   attempt completed.
    fn transform_attempt_completed(&mut self, _request_id: Self::TransformAttemptIdentifier) {}

    /// Records a failed transform attempt.
    ///
    /// # Arguments
    /// * `request_id` - The identifier of the request for which the transform
    ///   attempt failed.
    fn transform_attempt_failed(&mut self, _request_id: Self::TransformAttemptIdentifier) {}

    /// Records the start of a consume attempt.
    ///
    /// # Arguments
    /// * `request_id` - The identifier of the request for which the consume
    ///   attempt started.
    fn consume_attempt_started(&mut self, _request_id: Self::ConsumeAttemptIdentifier) {}

    /// Records the completion of a consume attempt.
    ///
    /// # Arguments
    /// * `request_id` - The identifier of the request for which the consume
    ///   attempt completed.
    fn consume_attempt_completed(&mut self, _request_id: Self::ConsumeAttemptIdentifier) {}

    /// Records a failed consume attempt.
    ///
    /// # Arguments
    /// * `request_id` - The identifier of the request for which the consume
    ///   attempt failed.
    fn consume_attempt_failed(&mut self, _request_id: Self::ConsumeAttemptIdentifier) {}
}