summaryrefslogtreecommitdiffstats
path: root/crates/common/batcher/src/config.rs
blob: 3041d772ba2d5c94161c056270bd7337e757698e (plain)
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
use chrono::Duration;

/// The parameters for the batching process.
#[derive(Debug, Clone)]
pub struct BatchConfig {
    event_jitter: Duration,
    delivery_jitter: Duration,
    message_leap_limit: Duration,
}

impl BatchConfig {
    /// Get the largest expected variation in event times.
    pub fn event_jitter(&self) -> Duration {
        self.event_jitter
    }

    /// Get the largest expected variation in delivery times.
    pub fn delivery_jitter(&self) -> Duration {
        self.delivery_jitter
    }

    /// Get the largest expected time discontinuity.
    pub fn message_leap_limit(&self) -> Duration {
        self.message_leap_limit
    }
}

/// Used to configure the parameters for batching. Start here.
#[derive(Debug, Default)]
pub struct BatchConfigBuilder {}

impl BatchConfigBuilder {
    /// Start configuring the batching parameters.
    pub fn new() -> BatchConfigBuilder {
        BatchConfigBuilder {}
    }

    /// Set the largest expected variation in event times, in milliseconds.
    pub fn event_jitter(self, event_jitter: u32) -> EventBatchConfigBuilder {
        EventBatchConfigBuilder { event_jitter }
    }
}

/// Used to configure the parameters for batching.
#[derive(Debug)]
pub struct EventBatchConfigBuilder {
    event_jitter: u32,
}

impl EventBatchConfigBuilder {
    /// Set the largest expected variation in delivery times, in milliseconds.
    pub fn delivery_jitter(self, delivery_jitter: u32) -> DeliveryBatchConfigBuilder {
        DeliveryBatchConfigBuilder {
            event_jitter: self.event_jitter,
            delivery_jitter,
        }
    }
}

/// Used to configure the parameters for batching.
#[derive(Debug)]
pub struct DeliveryBatchConfigBuilder {
    event_jitter: u32,
    delivery_jitter: u32,
}

impl DeliveryBatchConfigBuilder {
    /// Set the largest expected time discontinuity, in milliseconds.
    pub fn message_leap_limit(self, message_leap_limit: u32) -> BuildableBatchConfigBuilder {
        BuildableBatchConfigBuilder {
            event_jitter: self.event_jitter,
            delivery_jitter: self.delivery_jitter,
            message_leap_limit,
        }
    }
}

/// Used to configure the parameters for batching.
#[derive(Debug)]
pub struct BuildableBatchConfigBuilder {
    event_jitter: u32,
    delivery_jitter: u32,
    message_leap_limit: u32,
}

impl BuildableBatchConfigBuilder {
    /// Finalise the batching parameters.
    pub fn build(self) -> BatchConfig {
        let event_jitter = Duration::milliseconds(self.event_jitter as i64);
        let delivery_jitter = Duration::milliseconds(self.delivery_jitter as i64);
        let message_leap_limit = Duration::milliseconds(self.message_leap_limit as i64);

        BatchConfig {
            event_jitter,
            delivery_jitter,
            message_leap_limit,
        }
    }
}

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

    #[test]
    fn build_config() {
        let config = BatchConfigBuilder::new()
            .event_jitter(1)
            .delivery_jitter(2)
            .message_leap_limit(3)
            .build();

        assert_eq!(config.event_jitter(), Duration::milliseconds(1));
        assert_eq!(config.delivery_jitter(), Duration::milliseconds(2));
        assert_eq!(config.message_leap_limit(), Duration::milliseconds(3));
    }
}