rust-pipe 0.1.0

Lightweight typed task dispatch from Rust to polyglot workers (TypeScript, Python, Go, Java, C#, Ruby, Elixir, Swift, PHP)
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
use dashmap::DashMap;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;
use std::time::Duration;
use tokio::sync::{oneshot, RwLock};
use tokio::task::JoinHandle;
use uuid::Uuid;

use crate::schema::{Task, TaskResult};
use crate::transport::websocket::WebSocketTransport;
use crate::transport::{Message, Transport, TransportConfig, TransportError};
use crate::worker::{WorkerInfo, WorkerPool, WorkerStatus};

/// Builder for configuring a [`Dispatcher`].
#[derive(Debug, Clone)]
pub struct DispatcherBuilder {
    config: TransportConfig,
    heartbeat_timeout_ms: u64,
    dead_worker_check_interval_ms: u64,
}

impl Default for DispatcherBuilder {
    fn default() -> Self {
        Self {
            config: TransportConfig::default(),
            heartbeat_timeout_ms: 15_000,
            dead_worker_check_interval_ms: 5_000,
        }
    }
}

impl DispatcherBuilder {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn host(mut self, host: impl Into<String>) -> Self {
        self.config.host = host.into();
        self
    }

    pub fn port(mut self, port: u16) -> Self {
        self.config.port = port;
        self
    }

    pub fn max_connections(mut self, max: u32) -> Self {
        self.config.max_connections = max;
        self
    }

    pub fn heartbeat_interval(mut self, ms: u64) -> Self {
        self.config.heartbeat_interval_ms = ms;
        self
    }

    pub fn heartbeat_timeout(mut self, ms: u64) -> Self {
        self.heartbeat_timeout_ms = ms;
        self
    }

    pub fn build(self) -> Dispatcher {
        Dispatcher {
            pool: Arc::new(WorkerPool::new(self.heartbeat_timeout_ms)),
            pending: Arc::new(DashMap::new()),
            transport: Arc::new(RwLock::new(None)),
            config: self.config,
            dead_worker_check_interval_ms: self.dead_worker_check_interval_ms,
            started: AtomicBool::new(false),
            _dead_worker_task: RwLock::new(None),
        }
    }
}

/// Central task dispatcher. Manages worker connections and routes tasks.
pub struct Dispatcher {
    pool: Arc<WorkerPool>,
    pending: Arc<DashMap<Uuid, PendingTask>>,
    transport: Arc<RwLock<Option<Arc<WebSocketTransport>>>>,
    config: TransportConfig,
    dead_worker_check_interval_ms: u64,
    started: AtomicBool,
    _dead_worker_task: RwLock<Option<JoinHandle<()>>>,
}

struct PendingTask {
    sender: oneshot::Sender<TaskResult>,
    worker_id: String,
}

/// Handle to an in-flight task. Await it to get the worker's result.
#[must_use = "dropping a DispatchResult discards the task result"]
pub struct DispatchResult {
    pub task_id: Uuid,
    pub(crate) receiver: oneshot::Receiver<TaskResult>,
}

impl std::fmt::Debug for DispatchResult {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("DispatchResult")
            .field("task_id", &self.task_id)
            .finish()
    }
}

impl DispatchResult {
    pub async fn await_result(self) -> Result<TaskResult, DispatchError> {
        self.receiver
            .await
            .map_err(|_| DispatchError::WorkerDisconnected)
    }

    pub async fn await_with_timeout(self, timeout: Duration) -> Result<TaskResult, DispatchError> {
        tokio::time::timeout(timeout, self.receiver)
            .await
            .map_err(|_| DispatchError::Timeout)?
            .map_err(|_| DispatchError::WorkerDisconnected)
    }
}

impl Dispatcher {
    pub fn builder() -> DispatcherBuilder {
        DispatcherBuilder::new()
    }

    pub async fn start(&self) -> Result<(), DispatchError> {
        if self.started.swap(true, Ordering::SeqCst) {
            return Ok(());
        }

        let pool = self.pool.clone();
        let pending = self.pending.clone();

        let on_message = move |worker_id: String, message: Message| {
            let pool = pool.clone();
            let pending = pending.clone();

            tokio::spawn(async move {
                match message {
                    Message::WorkerRegister { registration: reg } => {
                        pool.register(WorkerInfo {
                            id: reg.worker_id,
                            language: reg.language,
                            supported_tasks: reg.supported_tasks,
                            max_concurrency: reg.max_concurrency,
                            status: WorkerStatus::Active,
                            active_tasks: 0,
                            registered_at: chrono::Utc::now(),
                            last_heartbeat: chrono::Utc::now(),
                        });
                    }
                    Message::TaskResult { result } => {
                        pool.mark_task_completed(&worker_id);
                        if let Some((_, pending_task)) = pending.remove(&result.task_id) {
                            let _ = pending_task.sender.send(result);
                        }
                    }
                    Message::Heartbeat { payload: hb } => {
                        pool.heartbeat(&hb.worker_id, hb.active_tasks);
                    }
                    Message::Backpressure { signal: bp } => {
                        tracing::warn!(
                            worker_id = %bp.worker_id,
                            load = bp.current_load,
                            "Worker signaled backpressure"
                        );
                    }
                    _ => {}
                }
            });
        };

        let transport = Arc::new(WebSocketTransport::new(self.config.clone(), on_message));
        transport
            .start()
            .await
            .map_err(DispatchError::TransportError)?;

        *self.transport.write().await = Some(transport);

        // Dead worker detection loop — drops pending senders for dead workers
        // so that await_result() returns WorkerDisconnected instead of hanging.
        let pool = self.pool.clone();
        let pending = self.pending.clone();
        let interval = self.dead_worker_check_interval_ms;
        let handle = tokio::spawn(async move {
            loop {
                tokio::time::sleep(Duration::from_millis(interval)).await;
                let dead = pool.detect_dead_workers();
                if !dead.is_empty() {
                    for worker_id in &dead {
                        tracing::warn!(worker_id = %worker_id, "Dead worker detected");
                    }
                    // Drop pending senders for dead workers — receiver gets RecvError
                    // which maps to DispatchError::WorkerDisconnected
                    pending
                        .retain(|_task_id, pending_task| !dead.contains(&pending_task.worker_id));
                }
            }
        });

        *self._dead_worker_task.write().await = Some(handle);

        Ok(())
    }

    /// Gracefully stops the dispatcher. Cancels background tasks and shuts down transport.
    pub async fn stop(&self) {
        self.started.store(false, Ordering::SeqCst);
        // Cancel the dead worker detection task
        if let Some(handle) = self._dead_worker_task.write().await.take() {
            handle.abort();
        }
        // Shut down transport
        if let Some(transport) = self.transport.read().await.as_ref() {
            let _ = transport.stop().await;
        }
        // Fail all pending tasks
        self.pending.clear();
    }

    pub async fn dispatch(&self, task: Task) -> Result<DispatchResult, DispatchError> {
        // select_and_reserve atomically picks a worker and increments active_tasks
        let worker_id = self.pool.select_and_reserve(&task.task_type).ok_or(
            DispatchError::NoWorkerAvailable {
                task_type: task.task_type.clone(),
            },
        )?;

        let (tx, rx) = oneshot::channel();
        let task_id = task.id;

        self.pending.insert(
            task_id,
            PendingTask {
                sender: tx,
                worker_id: worker_id.clone(),
            },
        );

        // Send task to worker via transport
        let transport_guard = self.transport.read().await;
        let transport = transport_guard.as_ref().ok_or_else(|| {
            // Rollback: remove pending and release worker capacity
            self.pending.remove(&task_id);
            self.pool.mark_task_completed(&worker_id);
            DispatchError::TransportNotStarted
        })?;

        if let Err(e) = transport
            .send(&worker_id, Message::TaskDispatch { task })
            .await
        {
            // Rollback: remove pending and release worker capacity
            self.pending.remove(&task_id);
            self.pool.mark_task_completed(&worker_id);
            return Err(DispatchError::TransportError(e));
        }

        tracing::debug!(task_id = %task_id, worker_id = %worker_id, "Task dispatched");

        Ok(DispatchResult {
            task_id,
            receiver: rx,
        })
    }

    pub fn pool_stats(&self) -> crate::worker::PoolStats {
        self.pool.stats()
    }
}

#[derive(Debug, thiserror::Error)]
pub enum DispatchError {
    #[error("No worker available for task type: {task_type}")]
    NoWorkerAvailable { task_type: String },

    #[error("Worker disconnected before returning result")]
    WorkerDisconnected,

    #[error("Task timed out")]
    Timeout,

    #[error("Transport not started — call start() first")]
    TransportNotStarted,

    #[error("Transport error: {0}")]
    TransportError(#[from] TransportError),
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::schema::{TaskResult, TaskStatus};
    use serde_json::json;

    #[test]
    fn test_builder_default_port() {
        let builder = DispatcherBuilder::new();
        assert_eq!(builder.config.port, 9876);
    }

    #[test]
    fn test_builder_default_host() {
        let builder = DispatcherBuilder::new();
        assert_eq!(builder.config.host, "0.0.0.0");
    }

    #[test]
    fn test_builder_default_heartbeat_timeout() {
        let builder = DispatcherBuilder::new();
        assert_eq!(builder.heartbeat_timeout_ms, 15_000);
    }

    #[test]
    fn test_builder_host_sets_value() {
        let builder = DispatcherBuilder::new().host("10.0.0.1");
        assert_eq!(builder.config.host, "10.0.0.1");
    }

    #[test]
    fn test_builder_port_sets_value() {
        let builder = DispatcherBuilder::new().port(8080);
        assert_eq!(builder.config.port, 8080);
    }

    #[test]
    fn test_builder_max_connections_sets_value() {
        let builder = DispatcherBuilder::new().max_connections(50);
        assert_eq!(builder.config.max_connections, 50);
    }

    #[test]
    fn test_builder_heartbeat_interval_sets_value() {
        let builder = DispatcherBuilder::new().heartbeat_interval(2000);
        assert_eq!(builder.config.heartbeat_interval_ms, 2000);
    }

    #[test]
    fn test_builder_heartbeat_timeout_sets_value() {
        let builder = DispatcherBuilder::new().heartbeat_timeout(30000);
        assert_eq!(builder.heartbeat_timeout_ms, 30000);
    }

    #[test]
    fn test_builder_chaining() {
        let builder = DispatcherBuilder::new()
            .host("1.2.3.4")
            .port(9999)
            .max_connections(200)
            .heartbeat_interval(1000)
            .heartbeat_timeout(5000);
        assert_eq!(builder.config.host, "1.2.3.4");
        assert_eq!(builder.config.port, 9999);
        assert_eq!(builder.config.max_connections, 200);
        assert_eq!(builder.config.heartbeat_interval_ms, 1000);
        assert_eq!(builder.heartbeat_timeout_ms, 5000);
    }

    #[test]
    fn test_builder_build_pool_starts_empty() {
        let dispatcher = Dispatcher::builder().build();
        let stats = dispatcher.pool_stats();
        assert_eq!(stats.total, 0);
    }

    #[test]
    fn test_dispatcher_builder_shortcut() {
        let builder = Dispatcher::builder();
        assert_eq!(builder.config.port, 9876);
    }

    #[tokio::test]
    async fn test_dispatch_result_await_result_receives_value() {
        let (tx, rx) = oneshot::channel();
        let result = DispatchResult {
            task_id: Uuid::new_v4(),
            receiver: rx,
        };
        let task_result = TaskResult {
            task_id: result.task_id,
            status: TaskStatus::Completed,
            payload: Some(json!({"ok": true})),
            error: None,
            duration_ms: 50,
            worker_id: "test".to_string(),
        };
        tx.send(task_result.clone()).unwrap();
        let received = result.await_result().await.unwrap();
        assert_eq!(received.task_id, task_result.task_id);
        assert_eq!(received.status, TaskStatus::Completed);
    }

    #[tokio::test]
    async fn test_dispatch_result_worker_disconnected() {
        let (tx, rx) = oneshot::channel::<TaskResult>();
        let result = DispatchResult {
            task_id: Uuid::new_v4(),
            receiver: rx,
        };
        drop(tx);
        let err = result.await_result().await.unwrap_err();
        assert!(matches!(err, DispatchError::WorkerDisconnected));
    }

    #[tokio::test]
    async fn test_dispatch_result_timeout() {
        let (_tx, rx) = oneshot::channel::<TaskResult>();
        let result = DispatchResult {
            task_id: Uuid::new_v4(),
            receiver: rx,
        };
        let err = result
            .await_with_timeout(Duration::from_millis(10))
            .await
            .unwrap_err();
        assert!(matches!(err, DispatchError::Timeout));
    }

    #[test]
    fn test_dispatch_result_debug_format() {
        let (_tx, rx) = oneshot::channel::<TaskResult>();
        let id = Uuid::new_v4();
        let result = DispatchResult {
            task_id: id,
            receiver: rx,
        };
        let debug = format!("{:?}", result);
        assert!(debug.contains("DispatchResult"));
        assert!(debug.contains(&id.to_string()));
    }

    #[test]
    fn test_dispatch_error_display_no_worker() {
        let err = DispatchError::NoWorkerAvailable {
            task_type: "scan".into(),
        };
        assert_eq!(err.to_string(), "No worker available for task type: scan");
    }

    #[test]
    fn test_dispatch_error_display_worker_disconnected() {
        let err = DispatchError::WorkerDisconnected;
        assert_eq!(
            err.to_string(),
            "Worker disconnected before returning result"
        );
    }

    #[test]
    fn test_dispatch_error_display_timeout() {
        let err = DispatchError::Timeout;
        assert_eq!(err.to_string(), "Task timed out");
    }

    #[test]
    fn test_dispatch_error_display_transport_not_started() {
        let err = DispatchError::TransportNotStarted;
        assert!(err.to_string().contains("Transport not started"));
    }

    #[test]
    fn test_dispatch_error_from_transport_error() {
        let transport_err = TransportError::Closed;
        let dispatch_err: DispatchError = transport_err.into();
        assert!(matches!(
            dispatch_err,
            DispatchError::TransportError(TransportError::Closed)
        ));
    }
}