ralph-workflow 0.7.18

PROMPT-driven multi-agent orchestrator for git repos
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
// pipeline/prompt/io_process_wait/io.rs — boundary module for process wait operations.
// File stem is `io` — recognized as boundary module by forbid_io_effects lint.

// Process wait functions for agent execution.

use crate::pipeline::idle_timeout::MonitorResult;
use crate::pipeline::prompt::PipelineRuntime;
use std::sync::Arc;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum WaitOutcome {
    Completed(std::process::ExitStatus),
    TimedOut(MonitorResult),
    UserInterrupted,
}

fn downcast_panic_message(panic_payload: Box<dyn std::any::Any + Send>) -> String {
    panic_payload.downcast_ref::<String>().map_or_else(
        || {
            panic_payload.downcast_ref::<&str>().map_or_else(
                || "<unknown panic>".to_string(),
                std::string::ToString::to_string,
            )
        },
        std::clone::Clone::clone,
    )
}

fn try_take_monitor_result(
    monitor_handle: &mut Option<std::thread::JoinHandle<MonitorResult>>,
) -> Result<Option<MonitorResult>, String> {
    let finished = monitor_handle
        .as_ref()
        .is_some_and(std::thread::JoinHandle::is_finished);
    if !finished {
        return Ok(None);
    }
    let handle = monitor_handle
        .take()
        .ok_or_else(|| "monitor handle missing after finished check".to_string())?;
    match handle.join() {
        Ok(result) => Ok(Some(result)),
        Err(payload) => Err(downcast_panic_message(payload)),
    }
}

fn try_take_stderr_output(
    stderr_join_handle: &mut Option<std::thread::JoinHandle<std::io::Result<String>>>,
    runtime: &PipelineRuntime<'_>,
) -> String {
    let finished = stderr_join_handle
        .as_ref()
        .is_some_and(std::thread::JoinHandle::is_finished);
    if !finished {
        return String::new();
    }
    stderr_join_handle.take().map_or(String::new(), |handle| {
        handle.join().map_or(String::new(), |result| {
            result.unwrap_or_else(|e| {
                runtime
                    .logger
                    .warn(&format!("Stderr collection failed after timeout: {e}"));
                String::new()
            })
        })
    })
}

fn join_stderr_handle(
    handle: std::thread::JoinHandle<std::io::Result<String>>,
    runtime: &PipelineRuntime<'_>,
) -> std::io::Result<String> {
    match handle.join() {
        Ok(result) => result,
        Err(payload) => {
            let msg = downcast_panic_message(payload);
            runtime.logger.warn(&format!(
                "Stderr collection thread panicked: {msg}. This may indicate a bug."
            ));
            Ok(String::new())
        }
    }
}

fn collect_stderr_from_handle(
    stderr_join_handle: &mut Option<std::thread::JoinHandle<std::io::Result<String>>>,
    runtime: &PipelineRuntime<'_>,
) -> std::io::Result<String> {
    match stderr_join_handle.take() {
        Some(handle) => join_stderr_handle(handle, runtime),
        None => Ok(String::new()),
    }
}

fn log_stderr_preview_lines(stderr_output: &str, runtime: &PipelineRuntime<'_>) {
    for (i, line) in stderr_output.lines().take(5).enumerate() {
        runtime.logger.info(&format!("  stderr[{i}]: {line}"));
    }
    let total = stderr_output.lines().count();
    if total > 5 {
        runtime.logger.info(&format!(
            "  ... ({} more lines, see log file for full output)",
            total - 5
        ));
    }
}

fn log_stderr_if_debug(stderr_output: &str, runtime: &PipelineRuntime<'_>) {
    if stderr_output.is_empty() || !runtime.config.verbosity.is_debug() {
        return;
    }
    runtime.logger.warn(&format!(
        "Agent stderr output detected ({} bytes):",
        stderr_output.len()
    ));
    log_stderr_preview_lines(stderr_output, runtime);
}

fn monitor_panic_timeout_outcome(panic_msg: &str, runtime: &PipelineRuntime<'_>) -> WaitOutcome {
    runtime.logger.warn(&format!(
        "Idle-timeout monitor thread panicked: {panic_msg}. Treating as timeout and forcing termination."
    ));
    WaitOutcome::TimedOut(MonitorResult::TimedOut {
        escalated: true,
        child_status_at_timeout: None,
    })
}

/// Pure classification of monitor take result.
fn classify_take_result(r: &Option<MonitorResult>) -> ClassifiedTakeResult {
    match r {
        Some(MonitorResult::TimedOut { .. } | MonitorResult::CompleteButWaiting) => {
            ClassifiedTakeResult::TimeoutRelevant
        }
        Some(_) | None => ClassifiedTakeResult::NotTimeoutRelevant,
    }
}

enum ClassifiedTakeResult {
    TimeoutRelevant,
    NotTimeoutRelevant,
}

/// Domain helper: decide the wait outcome based on monitor result (pure).
fn decide_wait_outcome(r: &Option<MonitorResult>) -> Option<WaitOutcome> {
    match classify_take_result(r) {
        ClassifiedTakeResult::TimeoutRelevant => {
            r.as_ref().map(|result| WaitOutcome::TimedOut(*result))
        }
        ClassifiedTakeResult::NotTimeoutRelevant => None,
    }
}

fn interpret_monitor_take_result(
    take_result: Result<Option<MonitorResult>, String>,
    runtime: &PipelineRuntime<'_>,
) -> Option<WaitOutcome> {
    // Boundary: gather input, execute effects, translate result, return
    match take_result {
        // Effect: handle panic case with logging
        Err(panic_msg) => Some(monitor_panic_timeout_outcome(&panic_msg, runtime)),
        // Pure: use domain helper to decide
        Ok(r) => decide_wait_outcome(&r),
    }
}

fn check_monitor_for_timeout(
    monitor_handle: &mut Option<std::thread::JoinHandle<MonitorResult>>,
    runtime: &PipelineRuntime<'_>,
) -> Option<WaitOutcome> {
    interpret_monitor_take_result(try_take_monitor_result(monitor_handle), runtime)
}

fn try_poll_child(
    child_arc: &Arc<std::sync::Mutex<Box<dyn crate::executor::AgentChild>>>,
    executor: &dyn crate::executor::ProcessExecutor,
) -> std::io::Result<Option<WaitOutcome>> {
    let mut child = child_arc
        .lock()
        .expect("child process mutex poisoned - indicates panic in another thread");
    let result = child.try_wait().map(|opt| opt.map(WaitOutcome::Completed));
    // If the child has exited, kill its process group to clean up any zombies.
    // This is best-effort: we ignore the result because the parent has already
    // exited successfully and the kill is just cleanup.
    if result.as_ref().is_ok_and(|opt| opt.is_some()) {
        let child_id = child.id();
        let _ = executor.kill_process_group(child_id);
    }
    result
}

/// One poll iteration: check monitor, interrupt, child. Returns `Some` if done.
fn poll_wait_step(
    child_arc: &Arc<std::sync::Mutex<Box<dyn crate::executor::AgentChild>>>,
    monitor_handle: &mut Option<std::thread::JoinHandle<MonitorResult>>,
    runtime: &PipelineRuntime<'_>,
) -> std::io::Result<Option<WaitOutcome>> {
    if let Some(outcome) = check_monitor_for_timeout(monitor_handle, runtime) {
        return Ok(Some(outcome));
    }
    if crate::interrupt::is_user_interrupt_requested() {
        return Ok(Some(WaitOutcome::UserInterrupted));
    }
    try_poll_child(child_arc, runtime.executor)
}

fn poll_wait_loop(
    child_arc: &Arc<std::sync::Mutex<Box<dyn crate::executor::AgentChild>>>,
    monitor_handle: &mut Option<std::thread::JoinHandle<MonitorResult>>,
    runtime: &PipelineRuntime<'_>,
) -> std::io::Result<WaitOutcome> {
    let check_interval = std::time::Duration::from_millis(100);
    loop {
        if let Some(outcome) = poll_wait_step(child_arc, monitor_handle, runtime)? {
            return Ok(outcome);
        }
        std::thread::sleep(check_interval);
    }
}

fn resolve_exit_code(status: std::process::ExitStatus, runtime: &PipelineRuntime<'_>) -> i32 {
    if status.code().is_none() && runtime.config.verbosity.is_debug() {
        runtime
            .logger
            .warn("Process terminated by signal (no exit code), treating as failure");
    }
    status.code().unwrap_or(1)
}

pub fn wait_for_completion_and_collect_stderr(
    child_arc: &Arc<std::sync::Mutex<Box<dyn crate::executor::AgentChild>>>,
    stderr_join_handle: &mut Option<std::thread::JoinHandle<std::io::Result<String>>>,
    monitor_handle: &mut Option<std::thread::JoinHandle<MonitorResult>>,
    runtime: &PipelineRuntime<'_>,
) -> std::io::Result<(i32, String, Option<MonitorResult>)> {
    let outcome = poll_wait_loop(child_arc, monitor_handle, runtime)?;

    let status = match outcome {
        WaitOutcome::Completed(status) => {
            // Child exited cleanly — parent's wait() in poll_wait_loop has already
            // reaped the child. No zombie reap needed.
            status
        }
        WaitOutcome::TimedOut(monitor_result) => {
            let stderr_output = try_take_stderr_output(stderr_join_handle, runtime);
            return Ok((
                crate::pipeline::prompt::SIGTERM_EXIT_CODE,
                stderr_output,
                Some(monitor_result),
            ));
        }
        WaitOutcome::UserInterrupted => {
            let stderr_output = try_take_stderr_output(stderr_join_handle, runtime);
            return Ok((
                crate::pipeline::prompt::SIGTERM_EXIT_CODE,
                stderr_output,
                None,
            ));
        }
    };

    let exit_code = resolve_exit_code(status, runtime);
    let stderr_output = collect_stderr_from_handle(stderr_join_handle, runtime)?;
    log_stderr_if_debug(&stderr_output, runtime);
    Ok((exit_code, stderr_output, None))
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::executor::MockAgentChild;
    use crate::executor::MockProcessExecutor;
    use crate::logger::{Colors, Logger};
    use crate::pipeline::Timer;
    use crate::workspace::MemoryWorkspace;
    use std::sync::atomic::{AtomicBool, Ordering};
    use std::sync::Arc;
    use std::time::{Duration, Instant};

    struct InterruptGuard;
    impl Drop for InterruptGuard {
        fn drop(&mut self) {
            let _ = crate::interrupt::take_user_interrupt_request();
            crate::interrupt::reset_user_interrupted_occurred();
        }
    }

    #[test]
    fn wait_loop_exits_promptly_when_user_interrupt_is_requested() {
        let _lock = crate::interrupt::interrupt_test_lock();

        let _ = crate::interrupt::take_user_interrupt_request();
        crate::interrupt::reset_user_interrupted_occurred();

        let (child, controller) = MockAgentChild::new_running(0);
        let child_arc: Arc<std::sync::Mutex<Box<dyn crate::executor::AgentChild>>> =
            Arc::new(std::sync::Mutex::new(Box::new(child)));

        let mut stderr_join_handle: Option<std::thread::JoinHandle<std::io::Result<String>>> = None;
        let mut monitor_handle: Option<std::thread::JoinHandle<MonitorResult>> = None;

        let workspace = MemoryWorkspace::new_test();
        let logger = Logger::new(Colors::new());
        let colors = Colors::new();
        let config = crate::config::Config::test_default();
        let mut timer = Timer::new();
        let executor_arc: Arc<dyn crate::executor::ProcessExecutor> =
            Arc::new(crate::executor::MockProcessExecutor::new());

        let runtime = PipelineRuntime {
            timer: &mut timer,
            logger: &logger,
            colors: &colors,
            config: &config,
            executor: executor_arc.as_ref(),
            executor_arc: Arc::clone(&executor_arc),
            workspace: &workspace,
            workspace_arc: std::sync::Arc::new(workspace.clone()),
        };

        crate::interrupt::request_user_interrupt();
        let _guard = InterruptGuard;
        let start = Instant::now();
        let result = wait_for_completion_and_collect_stderr(
            &child_arc,
            &mut stderr_join_handle,
            &mut monitor_handle,
            &runtime,
        );
        let elapsed = start.elapsed();
        let _ = crate::interrupt::take_user_interrupt_request();

        controller.store(false, Ordering::Release);

        assert!(
            elapsed < Duration::from_millis(250),
            "wait_for_completion_and_collect_stderr blocked for {elapsed:?} after user interrupt; \
             expected early exit within 250ms"
        );

        assert!(
            result.is_ok(),
            "expected Ok result on interrupt, got: {result:?}"
        );
    }

    #[test]
    fn monitor_thread_panic_is_treated_as_timeout_to_avoid_hanging_wait_loop() {
        let _lock = crate::interrupt::interrupt_test_lock();

        let _ = crate::interrupt::take_user_interrupt_request();
        crate::interrupt::reset_user_interrupted_occurred();

        let (child, controller) = MockAgentChild::new_running(0);
        let child_arc: Arc<std::sync::Mutex<Box<dyn crate::executor::AgentChild>>> =
            Arc::new(std::sync::Mutex::new(Box::new(child)));

        let mut stderr_join_handle: Option<std::thread::JoinHandle<std::io::Result<String>>> = None;
        let mut monitor_handle: Option<std::thread::JoinHandle<MonitorResult>> =
            Some(std::thread::spawn(|| panic!("monitor blew up")));

        while !monitor_handle
            .as_ref()
            .is_some_and(std::thread::JoinHandle::is_finished)
        {
            std::thread::yield_now();
        }

        let workspace = MemoryWorkspace::new_test();
        let logger = Logger::new(Colors::new());
        let colors = Colors::new();
        let config = crate::config::Config::test_default();
        let mut timer = Timer::new();

        let executor_arc: Arc<dyn crate::executor::ProcessExecutor> =
            Arc::new(crate::executor::MockProcessExecutor::new());

        let runtime = PipelineRuntime {
            timer: &mut timer,
            logger: &logger,
            colors: &colors,
            config: &config,
            executor: executor_arc.as_ref(),
            executor_arc: Arc::clone(&executor_arc),
            workspace: &workspace,
            workspace_arc: std::sync::Arc::new(workspace.clone()),
        };

        let done = Arc::new(AtomicBool::new(false));
        std::thread::scope(|scope| {
            let done_for_stopper = Arc::clone(&done);
            let controller_for_stopper = Arc::clone(&controller);
            scope.spawn(move || {
                let deadline = Instant::now() + Duration::from_millis(300);
                while Instant::now() < deadline {
                    if done_for_stopper.load(Ordering::Acquire) {
                        return;
                    }
                    std::thread::sleep(Duration::from_millis(1));
                }
                controller_for_stopper.store(false, Ordering::Release);
            });

            let start = Instant::now();
            let result = wait_for_completion_and_collect_stderr(
                &child_arc,
                &mut stderr_join_handle,
                &mut monitor_handle,
                &runtime,
            );
            let elapsed = start.elapsed();

            done.store(true, Ordering::Release);
            controller.store(false, Ordering::Release);

            assert!(
                elapsed < Duration::from_millis(250),
                "wait loop returned too late ({elapsed:?}); monitor panic was likely swallowed"
            );

            let (exit_code, _stderr, monitor_result) =
                result.expect("expected wait_for_completion to return Ok");
            assert_eq!(exit_code, crate::pipeline::prompt::SIGTERM_EXIT_CODE);
            assert!(matches!(
                monitor_result,
                Some(MonitorResult::TimedOut { .. })
            ));
        });
    }

    #[test]
    fn try_poll_child_kills_process_group_after_exit() {
        let child = MockAgentChild::new(0);
        let child_arc: Arc<std::sync::Mutex<Box<dyn crate::executor::AgentChild>>> =
            Arc::new(std::sync::Mutex::new(Box::new(child)));

        let executor = Arc::new(MockProcessExecutor::new());

        let outcome = try_poll_child(&child_arc, executor.as_ref());
        assert!(outcome.is_ok());
        assert!(outcome.unwrap().is_some());

        assert_eq!(executor.kill_process_group_calls(), vec![12345]);
    }
}