oxigdal-streaming 0.1.4

Real-time data processing and streaming pipelines for OxiGDAL
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
//! Join operations for streaming data.

use crate::core::stream::StreamElement;
use crate::error::{Result, StreamingError};
use chrono::Utc;
use serde::{Deserialize, Serialize};
use std::collections::{HashMap, VecDeque};
use std::sync::Arc;
use tokio::sync::RwLock;

/// Type of join operation.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum JoinType {
    /// Inner join
    Inner,
    /// Left outer join
    LeftOuter,
    /// Right outer join
    RightOuter,
    /// Full outer join
    FullOuter,
}

/// Configuration for join operations.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct JoinConfig {
    /// Type of join
    pub join_type: JoinType,

    /// Maximum buffer size per key
    pub max_buffer_size: usize,

    /// Time-to-live for buffered elements (in seconds)
    pub ttl_seconds: i64,

    /// Enable cleanup of expired elements
    pub enable_cleanup: bool,
}

impl Default for JoinConfig {
    fn default() -> Self {
        Self {
            join_type: JoinType::Inner,
            max_buffer_size: 1000,
            ttl_seconds: 300,
            enable_cleanup: true,
        }
    }
}

/// Join operator for two streams.
pub struct JoinOperator {
    config: JoinConfig,
    left_buffer: Arc<RwLock<HashMap<Vec<u8>, VecDeque<StreamElement>>>>,
    right_buffer: Arc<RwLock<HashMap<Vec<u8>, VecDeque<StreamElement>>>>,
}

impl JoinOperator {
    /// Create a new join operator.
    pub fn new(config: JoinConfig) -> Self {
        Self {
            config,
            left_buffer: Arc::new(RwLock::new(HashMap::new())),
            right_buffer: Arc::new(RwLock::new(HashMap::new())),
        }
    }

    /// Process a left element.
    pub async fn process_left(&self, element: StreamElement) -> Result<Vec<StreamElement>> {
        let key = element
            .key
            .clone()
            .ok_or_else(|| StreamingError::JoinError("Left element must have a key".to_string()))?;

        let mut results = Vec::new();
        let right_buffer = self.right_buffer.read().await;

        if let Some(right_elements) = right_buffer.get(&key) {
            for right_elem in right_elements {
                let joined = self.join_elements(&element, right_elem)?;
                results.push(joined);
            }
        }

        drop(right_buffer);

        if self.config.join_type == JoinType::LeftOuter && results.is_empty() {
            results.push(element.clone());
        }

        let mut left_buffer = self.left_buffer.write().await;
        let buffer = left_buffer.entry(key).or_insert_with(VecDeque::new);

        if buffer.len() >= self.config.max_buffer_size {
            buffer.pop_front();
        }

        buffer.push_back(element);

        if self.config.enable_cleanup {
            self.cleanup_expired_left(&mut left_buffer);
        }

        Ok(results)
    }

    /// Process a right element.
    pub async fn process_right(&self, element: StreamElement) -> Result<Vec<StreamElement>> {
        let key = element.key.clone().ok_or_else(|| {
            StreamingError::JoinError("Right element must have a key".to_string())
        })?;

        let mut results = Vec::new();
        let left_buffer = self.left_buffer.read().await;

        if let Some(left_elements) = left_buffer.get(&key) {
            for left_elem in left_elements {
                let joined = self.join_elements(left_elem, &element)?;
                results.push(joined);
            }
        }

        drop(left_buffer);

        if self.config.join_type == JoinType::RightOuter && results.is_empty() {
            results.push(element.clone());
        }

        let mut right_buffer = self.right_buffer.write().await;
        let buffer = right_buffer.entry(key).or_insert_with(VecDeque::new);

        if buffer.len() >= self.config.max_buffer_size {
            buffer.pop_front();
        }

        buffer.push_back(element);

        if self.config.enable_cleanup {
            self.cleanup_expired_right(&mut right_buffer);
        }

        Ok(results)
    }

    /// Join two elements.
    fn join_elements(&self, left: &StreamElement, right: &StreamElement) -> Result<StreamElement> {
        let mut joined_data = Vec::new();
        joined_data.extend_from_slice(&left.data);
        joined_data.extend_from_slice(&right.data);

        Ok(StreamElement {
            data: joined_data,
            event_time: left.event_time.max(right.event_time),
            processing_time: Utc::now(),
            key: left.key.clone(),
            metadata: left.metadata.clone(),
        })
    }

    /// Cleanup expired elements from left buffer.
    fn cleanup_expired_left(&self, buffer: &mut HashMap<Vec<u8>, VecDeque<StreamElement>>) {
        let now = Utc::now();
        let ttl_seconds = self.config.ttl_seconds;

        for queue in buffer.values_mut() {
            queue.retain(|elem| {
                let age = now.signed_duration_since(elem.event_time);
                age.num_seconds() < ttl_seconds
            });
        }
    }

    /// Cleanup expired elements from right buffer.
    fn cleanup_expired_right(&self, buffer: &mut HashMap<Vec<u8>, VecDeque<StreamElement>>) {
        let now = Utc::now();
        let ttl_seconds = self.config.ttl_seconds;

        for queue in buffer.values_mut() {
            queue.retain(|elem| {
                let age = now.signed_duration_since(elem.event_time);
                age.num_seconds() < ttl_seconds
            });
        }
    }

    /// Clear all buffers.
    pub async fn clear(&self) {
        self.left_buffer.write().await.clear();
        self.right_buffer.write().await.clear();
    }
}

/// CoGroup operator for two streams.
pub struct CoGroupOperator {
    left_buffer: Arc<RwLock<HashMap<Vec<u8>, Vec<StreamElement>>>>,
    right_buffer: Arc<RwLock<HashMap<Vec<u8>, Vec<StreamElement>>>>,
}

impl CoGroupOperator {
    /// Create a new cogroup operator.
    pub fn new() -> Self {
        Self {
            left_buffer: Arc::new(RwLock::new(HashMap::new())),
            right_buffer: Arc::new(RwLock::new(HashMap::new())),
        }
    }

    /// Add a left element.
    pub async fn add_left(&self, element: StreamElement) -> Result<()> {
        let key = element
            .key
            .clone()
            .ok_or_else(|| StreamingError::JoinError("Element must have a key".to_string()))?;

        let mut buffer = self.left_buffer.write().await;
        buffer.entry(key).or_insert_with(Vec::new).push(element);

        Ok(())
    }

    /// Add a right element.
    pub async fn add_right(&self, element: StreamElement) -> Result<()> {
        let key = element
            .key
            .clone()
            .ok_or_else(|| StreamingError::JoinError("Element must have a key".to_string()))?;

        let mut buffer = self.right_buffer.write().await;
        buffer.entry(key).or_insert_with(Vec::new).push(element);

        Ok(())
    }

    /// Get cogroup results for a key.
    pub async fn get_results(&self, key: &[u8]) -> (Vec<StreamElement>, Vec<StreamElement>) {
        let left_buffer = self.left_buffer.read().await;
        let right_buffer = self.right_buffer.read().await;

        let left = left_buffer.get(key).cloned().unwrap_or_else(Vec::new);
        let right = right_buffer.get(key).cloned().unwrap_or_else(Vec::new);

        (left, right)
    }

    /// Clear buffers.
    pub async fn clear(&self) {
        self.left_buffer.write().await.clear();
        self.right_buffer.write().await.clear();
    }
}

impl Default for CoGroupOperator {
    fn default() -> Self {
        Self::new()
    }
}

/// Interval join operator.
pub struct IntervalJoin {
    lower_bound_seconds: i64,
    upper_bound_seconds: i64,
    left_buffer: Arc<RwLock<HashMap<Vec<u8>, VecDeque<StreamElement>>>>,
    right_buffer: Arc<RwLock<HashMap<Vec<u8>, VecDeque<StreamElement>>>>,
}

impl IntervalJoin {
    /// Create a new interval join.
    pub fn new(lower_bound_seconds: i64, upper_bound_seconds: i64) -> Self {
        Self {
            lower_bound_seconds,
            upper_bound_seconds,
            left_buffer: Arc::new(RwLock::new(HashMap::new())),
            right_buffer: Arc::new(RwLock::new(HashMap::new())),
        }
    }

    /// Process a left element.
    pub async fn process_left(&self, element: StreamElement) -> Result<Vec<StreamElement>> {
        let key = element
            .key
            .clone()
            .ok_or_else(|| StreamingError::JoinError("Element must have a key".to_string()))?;

        let mut results = Vec::new();
        let right_buffer = self.right_buffer.read().await;

        if let Some(right_elements) = right_buffer.get(&key) {
            for right_elem in right_elements {
                if self.in_interval(&element, right_elem) {
                    let mut joined_data = Vec::new();
                    joined_data.extend_from_slice(&element.data);
                    joined_data.extend_from_slice(&right_elem.data);

                    results.push(StreamElement {
                        data: joined_data,
                        event_time: element.event_time.max(right_elem.event_time),
                        processing_time: Utc::now(),
                        key: Some(key.clone()),
                        metadata: element.metadata.clone(),
                    });
                }
            }
        }

        drop(right_buffer);

        let mut left_buffer = self.left_buffer.write().await;
        left_buffer
            .entry(key)
            .or_insert_with(VecDeque::new)
            .push_back(element);

        Ok(results)
    }

    /// Process a right element.
    pub async fn process_right(&self, element: StreamElement) -> Result<Vec<StreamElement>> {
        let key = element
            .key
            .clone()
            .ok_or_else(|| StreamingError::JoinError("Element must have a key".to_string()))?;

        let mut results = Vec::new();
        let left_buffer = self.left_buffer.read().await;

        if let Some(left_elements) = left_buffer.get(&key) {
            for left_elem in left_elements {
                if self.in_interval(left_elem, &element) {
                    let mut joined_data = Vec::new();
                    joined_data.extend_from_slice(&left_elem.data);
                    joined_data.extend_from_slice(&element.data);

                    results.push(StreamElement {
                        data: joined_data,
                        event_time: left_elem.event_time.max(element.event_time),
                        processing_time: Utc::now(),
                        key: Some(key.clone()),
                        metadata: left_elem.metadata.clone(),
                    });
                }
            }
        }

        drop(left_buffer);

        let mut right_buffer = self.right_buffer.write().await;
        right_buffer
            .entry(key)
            .or_insert_with(VecDeque::new)
            .push_back(element);

        Ok(results)
    }

    /// Check if two elements are within the join interval.
    fn in_interval(&self, left: &StreamElement, right: &StreamElement) -> bool {
        let time_diff = right.event_time.signed_duration_since(left.event_time);
        let time_diff_seconds = time_diff.num_seconds();
        time_diff_seconds >= self.lower_bound_seconds
            && time_diff_seconds <= self.upper_bound_seconds
    }

    /// Clear buffers.
    pub async fn clear(&self) {
        self.left_buffer.write().await.clear();
        self.right_buffer.write().await.clear();
    }
}

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

    #[tokio::test]
    async fn test_join_operator() {
        let config = JoinConfig::default();
        let join = JoinOperator::new(config);

        let left = StreamElement::new(vec![1, 2], Utc::now()).with_key(vec![1]);
        let right = StreamElement::new(vec![3, 4], Utc::now()).with_key(vec![1]);

        join.process_left(left)
            .await
            .expect("process_left should succeed in test");
        let results = join
            .process_right(right)
            .await
            .expect("process_right should succeed in test");

        assert_eq!(results.len(), 1);
        assert_eq!(results[0].data, vec![1, 2, 3, 4]);
    }

    #[tokio::test]
    async fn test_cogroup_operator() {
        let cogroup = CoGroupOperator::new();

        let left = StreamElement::new(vec![1, 2], Utc::now()).with_key(vec![1]);
        let right = StreamElement::new(vec![3, 4], Utc::now()).with_key(vec![1]);

        cogroup
            .add_left(left)
            .await
            .expect("add_left should succeed in test");
        cogroup
            .add_right(right)
            .await
            .expect("add_right should succeed in test");

        let (left_elems, right_elems) = cogroup.get_results(&[1]).await;
        assert_eq!(left_elems.len(), 1);
        assert_eq!(right_elems.len(), 1);
    }

    #[tokio::test]
    async fn test_interval_join() {
        let join = IntervalJoin::new(0, 10);

        let left = StreamElement::new(vec![1, 2], Utc::now()).with_key(vec![1]);
        let right_time = Utc::now() + chrono::Duration::seconds(5);
        let right = StreamElement::new(vec![3, 4], right_time).with_key(vec![1]);

        join.process_left(left)
            .await
            .expect("process_left should succeed in test");
        let results = join
            .process_right(right)
            .await
            .expect("process_right should succeed in test");

        assert!(!results.is_empty());
    }
}