riglr-core 0.3.0

Core abstractions and job execution engine for riglr - building resilient AI agents.
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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
//! Job queue abstractions and implementations.
//!
//! This module provides the queue infrastructure for distributed job processing,
//! supporting both in-memory and Redis-backed implementations for scalability.

use crate::jobs::Job;
use anyhow::Result;
use async_trait::async_trait;
use std::time::Duration;

/// Trait for job queue implementations.
///
/// Provides a common interface for different queue backends, enabling
/// both local development with in-memory queues and production deployment
/// with distributed Redis queues.
#[async_trait]
pub trait JobQueue: Send + Sync {
    /// Add a job to the queue
    async fn enqueue(&self, job: Job) -> Result<()>;

    /// Get the next job from the queue, blocks until a job is available or timeout
    async fn dequeue(&self) -> Result<Option<Job>>;

    /// Get the next job from the queue with timeout
    async fn dequeue_with_timeout(&self, timeout: Duration) -> Result<Option<Job>>;

    /// Get queue length
    async fn len(&self) -> Result<usize>;

    /// Check if queue is empty
    async fn is_empty(&self) -> Result<bool> {
        Ok(self.len().await? == 0)
    }
}

/// In-memory job queue implementation for testing and development
pub struct InMemoryJobQueue {
    queue: tokio::sync::Mutex<std::collections::VecDeque<Job>>,
    notify: tokio::sync::Notify,
}

impl InMemoryJobQueue {
    /// Create a new in-memory job queue
    pub fn new() -> Self {
        Self::default()
    }
}

impl Default for InMemoryJobQueue {
    fn default() -> Self {
        Self {
            queue: tokio::sync::Mutex::new(std::collections::VecDeque::default()),
            notify: tokio::sync::Notify::default(),
        }
    }
}

#[async_trait]
impl JobQueue for InMemoryJobQueue {
    async fn enqueue(&self, job: Job) -> Result<()> {
        let mut queue = self.queue.lock().await;
        queue.push_back(job);
        self.notify.notify_one();
        Ok(())
    }

    async fn dequeue(&self) -> Result<Option<Job>> {
        loop {
            {
                let mut queue = self.queue.lock().await;
                if let Some(job) = queue.pop_front() {
                    return Ok(Some(job));
                }
            }
            self.notify.notified().await;
        }
    }

    async fn dequeue_with_timeout(&self, timeout: Duration) -> Result<Option<Job>> {
        // First check if there are any items immediately available
        {
            let mut queue = self.queue.lock().await;
            if let Some(job) = queue.pop_front() {
                return Ok(Some(job));
            }
        }

        // If no items available, wait for notification or timeout
        tokio::select! {
            _ = tokio::time::sleep(timeout) => Ok(None),
            _ = self.notify.notified() => {
                let mut queue = self.queue.lock().await;
                Ok(queue.pop_front())
            }
        }
    }

    async fn len(&self) -> Result<usize> {
        let queue = self.queue.lock().await;
        Ok(queue.len())
    }
}

/// Redis-based job queue implementation for production use
#[cfg(feature = "redis")]
pub struct RedisJobQueue {
    client: redis::Client,
    queue_key: String,
    timeout_seconds: u64,
}

#[cfg(feature = "redis")]
impl RedisJobQueue {
    /// Create a new Redis job queue
    ///
    /// # Arguments
    /// * `redis_url` - Redis connection URL (e.g., "redis://127.0.0.1:6379")
    /// * `queue_name` - Name of the queue (will be prefixed with "riglr:queue:")
    pub fn new(redis_url: &str, queue_name: &str) -> Result<Self> {
        let client = redis::Client::open(redis_url)?;
        Ok(Self {
            client,
            queue_key: format!("riglr:queue:{}", queue_name),
            timeout_seconds: 5,
        })
    }

    /// Set the blocking timeout for dequeue operations
    pub fn with_timeout(mut self, timeout_seconds: u64) -> Self {
        self.timeout_seconds = timeout_seconds;
        self
    }
}

#[cfg(feature = "redis")]
#[async_trait]
impl JobQueue for RedisJobQueue {
    async fn enqueue(&self, job: Job) -> Result<()> {
        let mut conn = self.client.get_multiplexed_async_connection().await?;
        let serialized = serde_json::to_string(&job)?;
        let _: () = redis::cmd("LPUSH")
            .arg(&self.queue_key)
            .arg(serialized)
            .query_async(&mut conn)
            .await?;
        Ok(())
    }

    async fn dequeue(&self) -> Result<Option<Job>> {
        let mut conn = self.client.get_multiplexed_async_connection().await?;

        // BRPOP blocks until an item is available or timeout
        let result: Option<(String, String)> = redis::cmd("BRPOP")
            .arg(&self.queue_key)
            .arg(self.timeout_seconds)
            .query_async(&mut conn)
            .await?;

        match result {
            Some((_, job_str)) => {
                let job: Job = serde_json::from_str(&job_str)?;
                Ok(Some(job))
            }
            None => Ok(None),
        }
    }

    async fn dequeue_with_timeout(&self, timeout: Duration) -> Result<Option<Job>> {
        let mut conn = self.client.get_multiplexed_async_connection().await?;
        let timeout_seconds = timeout.as_secs().max(1);

        let result: Option<(String, String)> = redis::cmd("BRPOP")
            .arg(&self.queue_key)
            .arg(timeout_seconds)
            .query_async(&mut conn)
            .await?;

        match result {
            Some((_, job_str)) => {
                let job: Job = serde_json::from_str(&job_str)?;
                Ok(Some(job))
            }
            None => Ok(None),
        }
    }

    async fn len(&self) -> Result<usize> {
        let mut conn = self.client.get_multiplexed_async_connection().await?;
        let len: usize = redis::cmd("LLEN")
            .arg(&self.queue_key)
            .query_async(&mut conn)
            .await?;
        Ok(len)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::sync::Arc;
    use tokio::time::{timeout, Duration};

    // Test InMemoryJobQueue::default()
    #[tokio::test]
    async fn test_in_memory_queue_default() {
        let queue = InMemoryJobQueue::default();
        assert_eq!(queue.len().await.unwrap(), 0);
        assert!(queue.is_empty().await.unwrap());
    }

    // Test basic enqueue and dequeue operations
    #[tokio::test]
    async fn test_in_memory_queue_enqueue_dequeue() {
        let queue = InMemoryJobQueue::default();

        // Test enqueue and dequeue
        let job = Job::new("test_tool", &serde_json::json!({}), 3).unwrap();
        let job_id = job.job_id;

        queue.enqueue(job).await.unwrap();
        assert_eq!(queue.len().await.unwrap(), 1);
        assert!(!queue.is_empty().await.unwrap());

        // Use timeout to avoid blocking forever in tests
        let dequeued = queue
            .dequeue_with_timeout(Duration::from_secs(1))
            .await
            .unwrap();
        assert!(dequeued.is_some());
        assert_eq!(dequeued.unwrap().job_id, job_id);

        assert_eq!(queue.len().await.unwrap(), 0);
        assert!(queue.is_empty().await.unwrap());
    }

    // Test dequeue with timeout when queue is empty
    #[tokio::test]
    async fn test_in_memory_queue_dequeue_timeout_empty() {
        let queue = InMemoryJobQueue::default();

        // Dequeue with timeout should return None when queue is empty
        let result = queue
            .dequeue_with_timeout(Duration::from_millis(100))
            .await
            .unwrap();
        assert!(result.is_none());
    }

    // Test dequeue with timeout when job is immediately available
    #[tokio::test]
    async fn test_in_memory_queue_dequeue_timeout_immediate() {
        let queue = InMemoryJobQueue::default();
        let job = Job::new("test_tool", &serde_json::json!({}), 3).unwrap();
        let job_id = job.job_id;

        // Enqueue first
        queue.enqueue(job).await.unwrap();

        // Dequeue with timeout should return immediately
        let result = queue
            .dequeue_with_timeout(Duration::from_secs(1))
            .await
            .unwrap();
        assert!(result.is_some());
        assert_eq!(result.unwrap().job_id, job_id);
    }

    // Test dequeue with timeout when job becomes available after waiting
    #[tokio::test]
    async fn test_in_memory_queue_dequeue_timeout_wait_for_job() {
        let queue = Arc::new(InMemoryJobQueue::default());
        let queue_clone = Arc::clone(&queue);

        // Spawn a task to enqueue a job after a short delay
        let job = Job::new("delayed_tool", &serde_json::json!({}), 3).unwrap();
        let job_id = job.job_id;

        tokio::spawn(async move {
            tokio::time::sleep(Duration::from_millis(50)).await;
            queue_clone.enqueue(job).await.unwrap();
        });

        // Dequeue should wait and then receive the job
        let result = queue
            .dequeue_with_timeout(Duration::from_secs(1))
            .await
            .unwrap();
        assert!(result.is_some());
        assert_eq!(result.unwrap().job_id, job_id);
    }

    // Test blocking dequeue with concurrent enqueue
    #[tokio::test]
    async fn test_in_memory_queue_dequeue_blocking() {
        let queue = Arc::new(InMemoryJobQueue::default());
        let queue_clone = Arc::clone(&queue);

        let job = Job::new("blocking_test", &serde_json::json!({}), 3).unwrap();
        let job_id = job.job_id;

        // Spawn a task to enqueue after a delay
        tokio::spawn(async move {
            tokio::time::sleep(Duration::from_millis(50)).await;
            queue_clone.enqueue(job).await.unwrap();
        });

        // Use timeout wrapper to prevent infinite blocking in tests
        let result = timeout(Duration::from_secs(1), queue.dequeue()).await;
        assert!(result.is_ok());
        let dequeued = result.unwrap().unwrap();
        assert!(dequeued.is_some());
        assert_eq!(dequeued.unwrap().job_id, job_id);
    }

    // Test multiple enqueue and dequeue operations (FIFO order)
    #[tokio::test]
    async fn test_in_memory_queue_fifo_order() {
        let queue = InMemoryJobQueue::default();

        // Enqueue multiple jobs
        let job1 = Job::new("tool1", &serde_json::json!({}), 3).unwrap();
        let job2 = Job::new("tool2", &serde_json::json!({}), 3).unwrap();
        let job3 = Job::new("tool3", &serde_json::json!({}), 3).unwrap();

        let job1_id = job1.job_id;
        let job2_id = job2.job_id;
        let job3_id = job3.job_id;

        queue.enqueue(job1).await.unwrap();
        queue.enqueue(job2).await.unwrap();
        queue.enqueue(job3).await.unwrap();

        assert_eq!(queue.len().await.unwrap(), 3);

        // Dequeue should return jobs in FIFO order
        let dequeued1 = queue
            .dequeue_with_timeout(Duration::from_secs(1))
            .await
            .unwrap();
        assert_eq!(dequeued1.unwrap().job_id, job1_id);

        let dequeued2 = queue
            .dequeue_with_timeout(Duration::from_secs(1))
            .await
            .unwrap();
        assert_eq!(dequeued2.unwrap().job_id, job2_id);

        let dequeued3 = queue
            .dequeue_with_timeout(Duration::from_secs(1))
            .await
            .unwrap();
        assert_eq!(dequeued3.unwrap().job_id, job3_id);

        assert_eq!(queue.len().await.unwrap(), 0);
        assert!(queue.is_empty().await.unwrap());
    }

    // Test is_empty default implementation when queue has items
    #[tokio::test]
    async fn test_in_memory_queue_is_empty_with_items() {
        let queue = InMemoryJobQueue::default();
        let job = Job::new("test_tool", &serde_json::json!({}), 3).unwrap();

        queue.enqueue(job).await.unwrap();
        assert!(!queue.is_empty().await.unwrap());
        assert_eq!(queue.len().await.unwrap(), 1);
    }

    // Test len() with multiple items
    #[tokio::test]
    async fn test_in_memory_queue_len_multiple_items() {
        let queue = InMemoryJobQueue::default();

        assert_eq!(queue.len().await.unwrap(), 0);

        for i in 0..5 {
            let job = Job::new(&format!("tool_{}", i), &serde_json::json!({}), 3).unwrap();
            queue.enqueue(job).await.unwrap();
            assert_eq!(queue.len().await.unwrap(), i + 1);
        }
    }

    // Test concurrent enqueue operations
    #[tokio::test]
    async fn test_in_memory_queue_concurrent_enqueue() {
        let queue = Arc::new(InMemoryJobQueue::default());
        let mut handles = vec![];

        // Spawn multiple tasks to enqueue concurrently
        for i in 0..10 {
            let queue_clone = Arc::clone(&queue);
            let handle = tokio::spawn(async move {
                let job =
                    Job::new(&format!("concurrent_tool_{}", i), &serde_json::json!({}), 3).unwrap();
                queue_clone.enqueue(job).await.unwrap();
            });
            handles.push(handle);
        }

        // Wait for all enqueue operations to complete
        for handle in handles {
            handle.await.unwrap();
        }

        assert_eq!(queue.len().await.unwrap(), 10);
    }

    // Test edge case: very short timeout
    #[tokio::test]
    async fn test_in_memory_queue_very_short_timeout() {
        let queue = InMemoryJobQueue::default();

        let result = queue
            .dequeue_with_timeout(Duration::from_nanos(1))
            .await
            .unwrap();
        assert!(result.is_none());
    }

    // Test zero timeout
    #[tokio::test]
    async fn test_in_memory_queue_zero_timeout() {
        let queue = InMemoryJobQueue::default();

        let result = queue
            .dequeue_with_timeout(Duration::from_secs(0))
            .await
            .unwrap();
        assert!(result.is_none());
    }

    #[cfg(feature = "redis")]
    mod redis_tests {
        use super::*;

        // Test RedisJobQueue::new with valid URL
        #[test]
        fn test_redis_queue_new_valid_url() {
            let result = RedisJobQueue::new("redis://127.0.0.1:6379", "test_queue");
            assert!(result.is_ok());
            let queue = result.unwrap();
            assert_eq!(queue.queue_key, "riglr:queue:test_queue");
            assert_eq!(queue.timeout_seconds, 5);
        }

        // Test RedisJobQueue::new with invalid URL
        #[test]
        fn test_redis_queue_new_invalid_url() {
            let result = RedisJobQueue::new("invalid_url", "test_queue");
            assert!(result.is_err());
        }

        // Test RedisJobQueue::with_timeout
        #[test]
        fn test_redis_queue_with_timeout() {
            let queue = RedisJobQueue::new("redis://127.0.0.1:6379", "test_queue")
                .unwrap()
                .with_timeout(10);
            assert_eq!(queue.timeout_seconds, 10);
        }

        // Test queue key formatting with different queue names
        #[test]
        fn test_redis_queue_key_formatting() {
            let queue1 = RedisJobQueue::new("redis://127.0.0.1:6379", "simple").unwrap();
            assert_eq!(queue1.queue_key, "riglr:queue:simple");

            let queue2 = RedisJobQueue::new("redis://127.0.0.1:6379", "complex_name_123").unwrap();
            assert_eq!(queue2.queue_key, "riglr:queue:complex_name_123");

            let queue3 = RedisJobQueue::new("redis://127.0.0.1:6379", "").unwrap();
            assert_eq!(queue3.queue_key, "riglr:queue:");
        }

        // Test with_timeout chaining
        #[test]
        fn test_redis_queue_timeout_chaining() {
            let queue = RedisJobQueue::new("redis://127.0.0.1:6379", "test")
                .unwrap()
                .with_timeout(15)
                .with_timeout(20);
            assert_eq!(queue.timeout_seconds, 20);
        }

        // Integration tests would require a running Redis instance
        // These are commented out but show the structure for full integration testing
        /*
        #[tokio::test]
        async fn test_redis_queue_integration() {
            // This test would require a running Redis instance
            let queue = RedisJobQueue::new("redis://127.0.0.1:6379", "test_integration").unwrap();

            let job = Job::new("redis_test", &serde_json::json!({}), 3).unwrap();
            let job_id = job.job_id;

            // Test enqueue
            queue.enqueue(job).await.unwrap();
            assert_eq!(queue.len().await.unwrap(), 1);
            assert!(!queue.is_empty().await.unwrap());

            // Test dequeue
            let dequeued = queue.dequeue_with_timeout(Duration::from_secs(1)).await.unwrap();
            assert!(dequeued.is_some());
            assert_eq!(dequeued.unwrap().job_id, job_id);

            assert_eq!(queue.len().await.unwrap(), 0);
            assert!(queue.is_empty().await.unwrap());
        }

        #[tokio::test]
        async fn test_redis_queue_timeout_scenarios() {
            let queue = RedisJobQueue::new("redis://127.0.0.1:6379", "test_timeout").unwrap();

            // Test timeout when queue is empty
            let result = queue.dequeue_with_timeout(Duration::from_millis(100)).await.unwrap();
            assert!(result.is_none());

            // Test very long timeout handling
            let result = queue.dequeue_with_timeout(Duration::from_secs(3600)).await.unwrap();
            assert!(result.is_none());
        }
        */
    }
}