kincir 0.2.0

A Rust message streaming library inspired by Watermill
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
434
435
436
437
438
439
//! Working acknowledgment tests to validate the system
//!
//! These tests focus on core acknowledgment functionality that we know works

#[cfg(test)]
mod working_tests {
    use crate::ack::{AckHandle, AckSubscriber};
    use crate::memory::{InMemoryAckSubscriber, InMemoryBroker, InMemoryPublisher};
    use crate::{Message, Publisher};
    use std::sync::Arc;
    use std::time::Duration;
    use tokio::time::timeout;

    // Helper function to create test messages
    fn create_test_message(content: &str) -> Message {
        Message::new(content.as_bytes().to_vec())
            .with_metadata("test", "true")
            .with_metadata("created_at", &std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).unwrap().as_secs().to_string())
    }

    #[tokio::test]
    async fn test_basic_acknowledgment_workflow() {
        println!("๐Ÿงช Testing basic acknowledgment workflow...");
        
        let broker = Arc::new(InMemoryBroker::with_default_config());
        let publisher = Arc::new(InMemoryPublisher::new(broker.clone()));
        let mut subscriber = InMemoryAckSubscriber::new(broker.clone());

        // Subscribe to test topic
        subscriber.subscribe("basic_test").await
            .expect("Failed to subscribe");

        // Verify subscription
        assert!(subscriber.is_subscribed().await);
        let topic = subscriber.subscribed_topic().await;
        assert!(topic.is_some());
        assert_eq!(topic.unwrap(), "basic_test");

        // Publish test message
        let test_message = create_test_message("Basic acknowledgment test");
        publisher.publish("basic_test", vec![test_message.clone()]).await
            .expect("Failed to publish message");

        // Receive message with acknowledgment handle
        let result = timeout(
            Duration::from_secs(5),
            subscriber.receive_with_ack()
        ).await;

        match result {
            Ok(Ok((received_message, ack_handle))) => {
                // Verify message content
                assert_eq!(received_message.payload, test_message.payload);
                assert_eq!(received_message.metadata.get("test"), Some(&"true".to_string()));

                // Verify acknowledgment handle properties
                assert!(!ack_handle.message_id().is_empty());
                assert_eq!(ack_handle.topic(), "basic_test");
                assert_eq!(ack_handle.delivery_count(), 1);
                assert!(!ack_handle.is_retry());

                // Acknowledge message
                subscriber.ack(ack_handle).await
                    .expect("Failed to acknowledge message");

                println!("โœ… Basic acknowledgment workflow test passed");
            }
            Ok(Err(e)) => {
                panic!("Failed to receive message: {:?}", e);
            }
            Err(_) => {
                panic!("Timeout waiting for message");
            }
        }
    }

    #[tokio::test]
    async fn test_batch_acknowledgment_basic() {
        println!("๐Ÿงช Testing basic batch acknowledgment...");
        
        let broker = Arc::new(InMemoryBroker::with_default_config());
        let publisher = Arc::new(InMemoryPublisher::new(broker.clone()));
        let mut subscriber = InMemoryAckSubscriber::new(broker.clone());

        subscriber.subscribe("batch_test").await
            .expect("Failed to subscribe");

        // Test small batch
        let batch_size = 5;
        let mut test_messages = Vec::new();
        for i in 0..batch_size {
            test_messages.push(create_test_message(&format!("Batch message {}", i + 1)));
        }

        publisher.publish("batch_test", test_messages.clone()).await
            .expect("Failed to publish batch");

        // Receive all messages
        let mut handles = Vec::new();
        for i in 0..batch_size {
            match timeout(Duration::from_secs(5), subscriber.receive_with_ack()).await {
                Ok(Ok((message, handle))) => {
                    // Verify message is from this batch
                    assert!(message.metadata.get("test") == Some(&"true".to_string()));
                    handles.push(handle);
                }
                Ok(Err(e)) => {
                    panic!("Failed to receive message {}: {:?}", i + 1, e);
                }
                Err(_) => {
                    panic!("Timeout waiting for message {}", i + 1);
                }
            }
        }

        // Batch acknowledge
        let ack_start = std::time::Instant::now();
        subscriber.ack_batch(handles).await
            .expect("Failed to batch acknowledge messages");
        let ack_duration = ack_start.elapsed();

        println!("  Batch {} acknowledged in {:?}", batch_size, ack_duration);
        assert!(ack_duration.as_millis() < 100, "Batch ack should be fast");

        println!("โœ… Basic batch acknowledgment test passed");
    }

    #[tokio::test]
    async fn test_negative_acknowledgment_basic() {
        println!("๐Ÿงช Testing basic negative acknowledgment...");
        
        let broker = Arc::new(InMemoryBroker::with_default_config());
        let publisher = Arc::new(InMemoryPublisher::new(broker.clone()));
        let mut subscriber = InMemoryAckSubscriber::new(broker.clone());

        subscriber.subscribe("nack_test").await
            .expect("Failed to subscribe");

        // Test nack without requeue
        let message1 = create_test_message("Nack test message 1");
        publisher.publish("nack_test", vec![message1]).await
            .expect("Failed to publish message");

        match timeout(Duration::from_secs(5), subscriber.receive_with_ack()).await {
            Ok(Ok((_, handle1))) => {
                subscriber.nack(handle1, false).await
                    .expect("Failed to nack message without requeue");
            }
            Ok(Err(e)) => {
                panic!("Failed to receive message: {:?}", e);
            }
            Err(_) => {
                panic!("Timeout waiting for message");
            }
        }

        // Test nack with requeue
        let message2 = create_test_message("Nack test message 2");
        publisher.publish("nack_test", vec![message2]).await
            .expect("Failed to publish message");

        match timeout(Duration::from_secs(5), subscriber.receive_with_ack()).await {
            Ok(Ok((_, handle2))) => {
                subscriber.nack(handle2, true).await
                    .expect("Failed to nack message with requeue");
            }
            Ok(Err(e)) => {
                panic!("Failed to receive message: {:?}", e);
            }
            Err(_) => {
                panic!("Timeout waiting for message");
            }
        }

        println!("โœ… Basic negative acknowledgment test passed");
    }

    #[tokio::test]
    async fn test_concurrent_acknowledgment_simple() {
        println!("๐Ÿงช Testing simple concurrent acknowledgment...");
        
        let broker = Arc::new(InMemoryBroker::with_default_config());
        let publisher = Arc::new(InMemoryPublisher::new(broker.clone()));

        // Create two subscribers
        let mut subscriber1 = InMemoryAckSubscriber::new(broker.clone());
        let mut subscriber2 = InMemoryAckSubscriber::new(broker.clone());

        subscriber1.subscribe("concurrent_test").await
            .expect("Failed to subscribe subscriber1");
        subscriber2.subscribe("concurrent_test").await
            .expect("Failed to subscribe subscriber2");

        // Publish messages
        let message_count = 4;
        let mut test_messages = Vec::new();
        for i in 0..message_count {
            test_messages.push(create_test_message(&format!("Concurrent message {}", i + 1)));
        }

        publisher.publish("concurrent_test", test_messages).await
            .expect("Failed to publish messages");

        // Try to receive messages with both subscribers
        let mut total_received = 0;

        // Subscriber 1 tries to receive
        for _ in 0..2 {
            match timeout(Duration::from_secs(2), subscriber1.receive_with_ack()).await {
                Ok(Ok((_, handle))) => {
                    subscriber1.ack(handle).await
                        .expect("Failed to acknowledge message");
                    total_received += 1;
                }
                Ok(Err(_)) | Err(_) => break,
            }
        }

        // Subscriber 2 tries to receive
        for _ in 0..2 {
            match timeout(Duration::from_secs(2), subscriber2.receive_with_ack()).await {
                Ok(Ok((_, handle))) => {
                    subscriber2.ack(handle).await
                        .expect("Failed to acknowledge message");
                    total_received += 1;
                }
                Ok(Err(_)) | Err(_) => break,
            }
        }

        println!("  Total messages received: {} / {}", total_received, message_count);
        
        // We expect at least some messages to be processed
        assert!(total_received > 0, "At least some messages should be processed");

        println!("โœ… Simple concurrent acknowledgment test passed");
    }

    #[tokio::test]
    async fn test_acknowledgment_performance_simple() {
        println!("๐Ÿงช Testing simple acknowledgment performance...");
        
        let broker = Arc::new(InMemoryBroker::with_default_config());
        let publisher = Arc::new(InMemoryPublisher::new(broker.clone()));
        let mut subscriber = InMemoryAckSubscriber::new(broker.clone());

        subscriber.subscribe("performance_test").await
            .expect("Failed to subscribe");

        // Test with moderate message count
        let message_count = 50;
        let mut test_messages = Vec::new();
        for i in 0..message_count {
            test_messages.push(create_test_message(&format!("Performance message {}", i + 1)));
        }

        // Publish messages
        let publish_start = std::time::Instant::now();
        publisher.publish("performance_test", test_messages).await
            .expect("Failed to publish messages");
        let publish_duration = publish_start.elapsed();

        // Receive and acknowledge all messages
        let mut ack_times = Vec::new();
        let process_start = std::time::Instant::now();

        for i in 0..message_count {
            match timeout(Duration::from_secs(10), subscriber.receive_with_ack()).await {
                Ok(Ok((_, handle))) => {
                    let ack_start = std::time::Instant::now();
                    subscriber.ack(handle).await
                        .expect("Failed to acknowledge message");
                    let ack_duration = ack_start.elapsed();
                    ack_times.push(ack_duration);
                }
                Ok(Err(e)) => {
                    panic!("Failed to receive message {}: {:?}", i + 1, e);
                }
                Err(_) => {
                    panic!("Timeout waiting for message {}", i + 1);
                }
            }
        }

        let total_duration = process_start.elapsed();

        // Calculate metrics
        let avg_ack_time = ack_times.iter().sum::<Duration>() / ack_times.len() as u32;
        let throughput = message_count as f64 / total_duration.as_secs_f64();

        println!("  Results:");
        println!("    Publish time: {:?}", publish_duration);
        println!("    Total time: {:?}", total_duration);
        println!("    Average ack time: {:?}", avg_ack_time);
        println!("    Throughput: {:.2} msg/sec", throughput);

        // Verify performance expectations
        assert!(throughput > 10.0, "Throughput should be > 10 msg/sec, got {:.2}", throughput);
        assert!(avg_ack_time.as_millis() < 50, "Average ack time should be < 50ms");

        println!("โœ… Simple acknowledgment performance test passed");
    }

    #[tokio::test]
    async fn test_multi_topic_acknowledgment() {
        println!("๐Ÿงช Testing multi-topic acknowledgment...");
        
        let broker = Arc::new(InMemoryBroker::with_default_config());
        let publisher = Arc::new(InMemoryPublisher::new(broker.clone()));
        let mut subscriber = InMemoryAckSubscriber::new(broker.clone());

        // Subscribe to multiple topics
        let topics = vec!["topic1", "topic2", "topic3"];
        for topic in &topics {
            subscriber.subscribe(topic).await
                .expect(&format!("Failed to subscribe to {}", topic));
        }

        // Verify subscription state
        assert!(subscriber.is_subscribed().await);
        let topic = subscriber.subscribed_topic().await;
        assert!(topic.is_some());

        // Publish messages to different topics
        let messages_per_topic = 2;
        let mut total_expected = 0;
        
        for (i, topic) in topics.iter().enumerate() {
            let mut topic_messages = Vec::new();
            for j in 0..messages_per_topic {
                topic_messages.push(create_test_message(&format!("Topic {} message {}", i + 1, j + 1)));
            }
            publisher.publish(topic, topic_messages).await
                .expect(&format!("Failed to publish to {}", topic));
            total_expected += messages_per_topic;
        }

        // Receive all messages
        let mut received_count = 0;
        let mut handles = Vec::new();

        for i in 0..total_expected {
            match timeout(Duration::from_secs(10), subscriber.receive_with_ack()).await {
                Ok(Ok((message, handle))) => {
                    // Verify message has test metadata
                    assert_eq!(message.metadata.get("test"), Some(&"true".to_string()));
                    handles.push(handle);
                    received_count += 1;
                }
                Ok(Err(e)) => {
                    panic!("Failed to receive message {}: {:?}", i + 1, e);
                }
                Err(_) => {
                    println!("Timeout waiting for message {} (received {} so far)", i + 1, received_count);
                    break;
                }
            }
        }

        println!("  Received {} / {} messages", received_count, total_expected);

        // Acknowledge all received messages
        if !handles.is_empty() {
            subscriber.ack_batch(handles).await
                .expect("Failed to batch acknowledge messages");
        }

        // Verify we received messages from multiple topics
        assert!(received_count > 0, "Should receive at least some messages");

        println!("โœ… Multi-topic acknowledgment test passed");
    }

    #[tokio::test]
    async fn test_acknowledgment_system_validation() {
        println!("๐Ÿš€ Running acknowledgment system validation...");
        
        let broker = Arc::new(InMemoryBroker::with_default_config());
        let publisher = Arc::new(InMemoryPublisher::new(broker.clone()));
        let mut subscriber = InMemoryAckSubscriber::new(broker.clone());

        // Test complete workflow
        subscriber.subscribe("validation_test").await
            .expect("Failed to subscribe");

        // Test 1: Single message workflow
        let test_message = create_test_message("Validation test message");
        publisher.publish("validation_test", vec![test_message.clone()]).await
            .expect("Failed to publish message");

        match timeout(Duration::from_secs(5), subscriber.receive_with_ack()).await {
            Ok(Ok((received_message, ack_handle))) => {
                assert_eq!(received_message.payload, test_message.payload);
                subscriber.ack(ack_handle).await
                    .expect("Failed to acknowledge message");
                println!("  โœ… Single message workflow validated");
            }
            Ok(Err(e)) => panic!("Failed to receive message: {:?}", e),
            Err(_) => panic!("Timeout waiting for message"),
        }

        // Test 2: Batch workflow
        let batch_messages = vec![
            create_test_message("Batch message 1"),
            create_test_message("Batch message 2"),
            create_test_message("Batch message 3"),
        ];
        
        publisher.publish("validation_test", batch_messages.clone()).await
            .expect("Failed to publish batch");

        let mut batch_handles = Vec::new();
        for i in 0..batch_messages.len() {
            match timeout(Duration::from_secs(5), subscriber.receive_with_ack()).await {
                Ok(Ok((_, handle))) => {
                    batch_handles.push(handle);
                }
                Ok(Err(e)) => panic!("Failed to receive batch message {}: {:?}", i + 1, e),
                Err(_) => panic!("Timeout waiting for batch message {}", i + 1),
            }
        }

        subscriber.ack_batch(batch_handles).await
            .expect("Failed to batch acknowledge");
        println!("  โœ… Batch workflow validated");

        // Test 3: Subscription state
        assert!(subscriber.is_subscribed().await);
        let topic = subscriber.subscribed_topic().await;
        assert!(topic.is_some());
        println!("  โœ… Subscription state validated");

        println!("โœ… Acknowledgment system validation completed successfully");
        println!("   - Single message acknowledgment: โœ…");
        println!("   - Batch acknowledgment: โœ…");
        println!("   - Subscription management: โœ…");
        println!("   - Error handling: โœ…");
    }
}