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

//! Cloud integration for containerized deployments.
//!
//! This module provides abstractions for ralph-workflow to run in cloud
//! environments with external orchestration. All cloud functionality is:
//!
//! - **Environment-variable configured only** (not in config files)
//! - **Disabled by default**
//! - **Invisible to CLI users** (no CLI flags, no help text)
//! - **Purely additive** (zero behavior change when disabled)
//!
//! ## Architecture
//!
//! Cloud support is trait-based for testability:
//! - `CloudReporter` - Abstract interface for progress reporting
//! - `NoopCloudReporter` - Default (does nothing)
//! - `HttpCloudReporter` - Production HTTP API client (in io boundary)
//! - `MockCloudReporter` - Testing (captures calls)
//!
//! ## Boundary Modules
//!
//! - `io/` - HTTP client for cloud API communication
//! - `runtime/` - Thread spawning for heartbeat background task

pub mod io;
pub mod io_redaction;
pub mod redaction;
pub mod runtime;
pub mod types;

pub use types::{CloudError, PipelineResult, ProgressEventType, ProgressUpdate};

pub type HttpCloudReporter = crate::cloud::io::HttpCloudReporter;
pub type HeartbeatGuard = crate::cloud::runtime::HeartbeatGuard;

pub trait CloudReporter: Send + Sync {
    fn report_progress(&self, update: &ProgressUpdate) -> Result<(), CloudError>;
    fn heartbeat(&self) -> Result<(), CloudError>;
    fn report_completion(&self, result: &PipelineResult) -> Result<(), CloudError>;
}

pub struct NoopCloudReporter;

impl CloudReporter for NoopCloudReporter {
    fn report_progress(&self, _update: &ProgressUpdate) -> Result<(), CloudError> {
        Ok(())
    }

    fn heartbeat(&self) -> Result<(), CloudError> {
        Ok(())
    }

    fn report_completion(&self, _result: &PipelineResult) -> Result<(), CloudError> {
        Ok(())
    }
}

#[cfg(any(test, feature = "test-utils"))]
pub mod mock;
#[cfg(any(test, feature = "test-utils"))]
pub use mock::MockCloudReporter;