ironclaw 0.22.0

Secure personal AI assistant that protects your data and expands its capabilities on the fly
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
//! Success evaluation for jobs.

use async_trait::async_trait;
use serde::{Deserialize, Serialize};

use crate::context::{ActionRecord, JobContext};
use crate::error::EvaluationError;

/// Result of evaluating job success.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EvaluationResult {
    /// Whether the job was successful.
    pub success: bool,
    /// Confidence in the evaluation (0-1).
    pub confidence: f64,
    /// Detailed reasoning.
    pub reasoning: String,
    /// Specific issues found.
    pub issues: Vec<String>,
    /// Suggestions for improvement.
    pub suggestions: Vec<String>,
    /// Quality score (0-100).
    pub quality_score: u32,
}

impl EvaluationResult {
    /// Create a successful evaluation.
    pub fn success(reasoning: impl Into<String>, quality_score: u32) -> Self {
        Self {
            success: true,
            confidence: 0.9,
            reasoning: reasoning.into(),
            issues: vec![],
            suggestions: vec![],
            quality_score,
        }
    }

    /// Create a failed evaluation.
    pub fn failure(reasoning: impl Into<String>, issues: Vec<String>) -> Self {
        Self {
            success: false,
            confidence: 0.9,
            reasoning: reasoning.into(),
            issues,
            suggestions: vec![],
            quality_score: 0,
        }
    }
}

/// Trait for success evaluators.
#[async_trait]
pub trait SuccessEvaluator: Send + Sync {
    /// Evaluate whether a job was completed successfully.
    async fn evaluate(
        &self,
        job: &JobContext,
        actions: &[ActionRecord],
        output: Option<&str>,
    ) -> Result<EvaluationResult, EvaluationError>;
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::context::{ActionRecord, JobContext};
    use crate::error::EvaluationError;

    /// Rule-based success evaluator (test-only; no production callers).
    struct RuleBasedEvaluator {
        min_action_success_rate: f64,
        max_failures: u32,
    }

    impl RuleBasedEvaluator {
        fn new() -> Self {
            Self {
                min_action_success_rate: 0.8,
                max_failures: 3,
            }
        }

        fn with_min_success_rate(mut self, rate: f64) -> Self {
            self.min_action_success_rate = rate;
            self
        }

        fn with_max_failures(mut self, max: u32) -> Self {
            self.max_failures = max;
            self
        }
    }

    impl Default for RuleBasedEvaluator {
        fn default() -> Self {
            Self::new()
        }
    }

    #[async_trait::async_trait]
    impl SuccessEvaluator for RuleBasedEvaluator {
        async fn evaluate(
            &self,
            job: &JobContext,
            actions: &[ActionRecord],
            _output: Option<&str>,
        ) -> Result<EvaluationResult, EvaluationError> {
            let mut issues = Vec::new();

            if actions.is_empty() {
                return Ok(EvaluationResult::failure(
                    "No actions were taken",
                    vec!["No actions recorded".to_string()],
                ));
            }

            let successful = actions.iter().filter(|a| a.success).count();
            let total = actions.len();
            let success_rate = successful as f64 / total as f64;

            if success_rate < self.min_action_success_rate {
                issues.push(format!(
                    "Action success rate {:.1}% below threshold {:.1}%",
                    success_rate * 100.0,
                    self.min_action_success_rate * 100.0
                ));
            }

            let failures = actions.iter().filter(|a| !a.success).count() as u32;
            if failures > self.max_failures {
                issues.push(format!(
                    "Too many failures: {} (max {})",
                    failures, self.max_failures
                ));
            }

            for action in actions.iter().filter(|a| !a.success) {
                if let Some(ref error) = action.error
                    && (error.to_lowercase().contains("critical")
                        || error.to_lowercase().contains("fatal"))
                {
                    issues.push(format!("Critical error in {}: {}", action.tool_name, error));
                }
            }

            if job.state != crate::context::JobState::Completed
                && job.state != crate::context::JobState::Submitted
            {
                issues.push(format!("Job not in completed state: {:?}", job.state));
            }

            let quality_score = if issues.is_empty() {
                let base_score = (success_rate * 80.0) as u32;
                let completion_bonus = if job.state == crate::context::JobState::Completed {
                    20
                } else {
                    0
                };
                (base_score + completion_bonus).min(100)
            } else {
                ((success_rate * 50.0) as u32).min(50)
            };

            if issues.is_empty() {
                Ok(EvaluationResult::success(
                    format!(
                        "Job completed successfully with {}/{} actions succeeding ({:.1}%)",
                        successful,
                        total,
                        success_rate * 100.0
                    ),
                    quality_score,
                ))
            } else {
                Ok(EvaluationResult {
                    success: false,
                    confidence: 0.85,
                    reasoning: format!("Job had {} issues", issues.len()),
                    issues,
                    suggestions: vec![
                        "Review failed actions for common patterns".to_string(),
                        "Consider adjusting retry logic".to_string(),
                    ],
                    quality_score,
                })
            }
        }
    }

    #[tokio::test]
    async fn test_rule_based_evaluator_success() {
        let evaluator = RuleBasedEvaluator::new();

        let mut job = JobContext::new("Test", "Test job");
        job.transition_to(crate::context::JobState::InProgress, None)
            .unwrap();
        job.transition_to(crate::context::JobState::Completed, None)
            .unwrap();

        let actions = vec![
            create_action(true),
            create_action(true),
            create_action(true),
        ];

        let result = evaluator.evaluate(&job, &actions, None).await.unwrap();
        assert!(result.success);
        assert!(result.quality_score > 80);
    }

    #[tokio::test]
    async fn test_rule_based_evaluator_failure() {
        let evaluator = RuleBasedEvaluator::new().with_max_failures(1);

        let job = JobContext::new("Test", "Test job");

        let actions = vec![
            create_action(true),
            create_action(false),
            create_action(false),
        ];

        let result = evaluator.evaluate(&job, &actions, None).await.unwrap();
        assert!(!result.success);
        assert!(!result.issues.is_empty());
    }

    fn create_action(success: bool) -> ActionRecord {
        create_action_with_error(success, "Test error")
    }

    fn create_action_with_error(success: bool, error_msg: &str) -> ActionRecord {
        let mut action = ActionRecord::new(0, "test", serde_json::json!({}));
        if success {
            action = action.succeed(
                None,
                serde_json::json!({}),
                std::time::Duration::from_secs(1),
            );
        } else {
            action = action.fail(error_msg, std::time::Duration::from_secs(1));
        }
        action
    }

    fn completed_job(title: &str) -> JobContext {
        let mut job = JobContext::new(title, "test job");
        job.transition_to(crate::context::JobState::InProgress, None)
            .unwrap();
        job.transition_to(crate::context::JobState::Completed, None)
            .unwrap();
        job
    }

    // --- EvaluationResult construction ---

    #[test]
    fn test_evaluation_result_success_defaults() {
        let result = EvaluationResult::success("all good", 85);
        assert!(result.success);
        assert_eq!(result.confidence, 0.9);
        assert_eq!(result.reasoning, "all good");
        assert!(result.issues.is_empty());
        assert!(result.suggestions.is_empty());
        assert_eq!(result.quality_score, 85);
    }

    #[test]
    fn test_evaluation_result_failure_defaults() {
        let issues = vec!["bad thing".to_string(), "worse thing".to_string()];
        let result = EvaluationResult::failure("went wrong", issues.clone());
        assert!(!result.success);
        assert_eq!(result.confidence, 0.9);
        assert_eq!(result.reasoning, "went wrong");
        assert_eq!(result.issues, issues);
        assert_eq!(result.quality_score, 0);
    }

    #[test]
    fn test_evaluation_result_serde_roundtrip() {
        let result = EvaluationResult {
            success: true,
            confidence: 0.75,
            reasoning: "looks fine".to_string(),
            issues: vec!["minor".to_string()],
            suggestions: vec!["try harder".to_string()],
            quality_score: 60,
        };
        let json = serde_json::to_string(&result).unwrap();
        let deserialized: EvaluationResult = serde_json::from_str(&json).unwrap();
        assert_eq!(deserialized.success, result.success);
        assert_eq!(deserialized.confidence, result.confidence);
        assert_eq!(deserialized.reasoning, result.reasoning);
        assert_eq!(deserialized.issues, result.issues);
        assert_eq!(deserialized.suggestions, result.suggestions);
        assert_eq!(deserialized.quality_score, result.quality_score);
    }

    // --- RuleBasedEvaluator builder ---

    #[test]
    fn test_rule_based_evaluator_default() {
        let eval = RuleBasedEvaluator::default();
        assert_eq!(eval.min_action_success_rate, 0.8);
        assert_eq!(eval.max_failures, 3);
    }

    #[test]
    fn test_rule_based_evaluator_builder_methods() {
        let eval = RuleBasedEvaluator::new()
            .with_min_success_rate(0.5)
            .with_max_failures(10);
        assert_eq!(eval.min_action_success_rate, 0.5);
        assert_eq!(eval.max_failures, 10);
    }

    // --- RuleBasedEvaluator::evaluate edge cases ---

    #[tokio::test]
    async fn test_empty_actions_fails() {
        let eval = RuleBasedEvaluator::new();
        let job = completed_job("empty");
        let result = eval.evaluate(&job, &[], None).await.unwrap();
        assert!(!result.success);
        assert!(result.issues.iter().any(|i| i.contains("No actions")));
    }

    #[tokio::test]
    async fn test_all_actions_succeed_completed_job_gets_100() {
        let eval = RuleBasedEvaluator::new();
        let job = completed_job("perfect");
        let actions = vec![
            create_action(true),
            create_action(true),
            create_action(true),
            create_action(true),
            create_action(true),
        ];
        let result = eval.evaluate(&job, &actions, None).await.unwrap();
        assert!(result.success);
        // 100% success rate -> base 80, completion bonus 20 -> 100
        assert_eq!(result.quality_score, 100);
    }

    #[tokio::test]
    async fn test_quality_score_no_completion_bonus_for_pending_job() {
        // Even if all actions succeed, a non-completed job gets flagged
        let eval = RuleBasedEvaluator::new();
        let job = JobContext::new("pending", "still pending");
        let actions = vec![create_action(true)];
        let result = eval.evaluate(&job, &actions, None).await.unwrap();
        // Job not in completed state => issues present
        assert!(!result.success);
        assert!(
            result
                .issues
                .iter()
                .any(|i| i.contains("not in completed state"))
        );
    }

    #[tokio::test]
    async fn test_submitted_state_counts_as_completed() {
        let eval = RuleBasedEvaluator::new();
        let mut job = JobContext::new("submitted", "test");
        job.transition_to(crate::context::JobState::InProgress, None)
            .unwrap();
        job.transition_to(crate::context::JobState::Completed, None)
            .unwrap();
        job.transition_to(crate::context::JobState::Submitted, None)
            .unwrap();
        let actions = vec![create_action(true)];
        let result = eval.evaluate(&job, &actions, None).await.unwrap();
        // Submitted is treated like completed for state check (no issue),
        // but completion bonus only applies for Completed state
        assert!(result.success);
    }

    #[tokio::test]
    async fn test_success_rate_below_threshold_fails() {
        let eval = RuleBasedEvaluator::new().with_min_success_rate(0.9);
        let job = completed_job("threshold");
        // 4 out of 5 = 80%, below 90% threshold
        let actions = vec![
            create_action(true),
            create_action(true),
            create_action(true),
            create_action(true),
            create_action(false),
        ];
        let result = eval.evaluate(&job, &actions, None).await.unwrap();
        assert!(!result.success);
        assert!(
            result
                .issues
                .iter()
                .any(|i| i.contains("success rate") && i.contains("below threshold"))
        );
    }

    #[tokio::test]
    async fn test_too_many_failures_flagged() {
        let eval = RuleBasedEvaluator::new().with_max_failures(1);
        let job = completed_job("failures");
        // 8 successes, 2 failures: rate is 80% (passes default 0.8) but failures > max 1
        let actions = vec![
            create_action(true),
            create_action(true),
            create_action(true),
            create_action(true),
            create_action(true),
            create_action(true),
            create_action(true),
            create_action(true),
            create_action(false),
            create_action(false),
        ];
        let result = eval.evaluate(&job, &actions, None).await.unwrap();
        assert!(!result.success);
        assert!(
            result
                .issues
                .iter()
                .any(|i| i.contains("Too many failures"))
        );
    }

    #[tokio::test]
    async fn test_critical_error_detected() {
        let eval = RuleBasedEvaluator::new().with_max_failures(10);
        let job = completed_job("critical");
        let actions = vec![
            create_action(true),
            create_action(true),
            create_action(true),
            create_action(true),
            create_action_with_error(false, "A CRITICAL system failure occurred"),
        ];
        let result = eval.evaluate(&job, &actions, None).await.unwrap();
        assert!(!result.success);
        assert!(result.issues.iter().any(|i| i.contains("Critical error")));
    }

    #[tokio::test]
    async fn test_fatal_error_detected() {
        let eval = RuleBasedEvaluator::new().with_max_failures(10);
        let job = completed_job("fatal");
        let actions = vec![
            create_action(true),
            create_action(true),
            create_action(true),
            create_action(true),
            create_action_with_error(false, "Fatal: disk full"),
        ];
        let result = eval.evaluate(&job, &actions, None).await.unwrap();
        assert!(result.issues.iter().any(|i| i.contains("Critical error")));
    }

    #[tokio::test]
    async fn test_quality_score_capped_at_50_with_issues() {
        let eval = RuleBasedEvaluator::new()
            .with_min_success_rate(0.0)
            .with_max_failures(100);
        // Job not completed => issues present, quality capped
        let job = JobContext::new("capped", "test");
        let actions = vec![create_action(true)];
        let result = eval.evaluate(&job, &actions, None).await.unwrap();
        assert!(!result.success);
        assert!(result.quality_score <= 50);
    }

    #[tokio::test]
    async fn test_failed_result_includes_suggestions() {
        let eval = RuleBasedEvaluator::new().with_max_failures(0);
        let job = completed_job("suggestions");
        let actions = vec![create_action(false)];
        let result = eval.evaluate(&job, &actions, None).await.unwrap();
        assert!(!result.success);
        assert!(!result.suggestions.is_empty());
        assert_eq!(result.confidence, 0.85);
    }

    #[tokio::test]
    async fn test_single_successful_action_completed_job() {
        let eval = RuleBasedEvaluator::new();
        let job = completed_job("single");
        let actions = vec![create_action(true)];
        let result = eval.evaluate(&job, &actions, None).await.unwrap();
        assert!(result.success);
        // 100% rate -> base 80, + 20 completion = 100
        assert_eq!(result.quality_score, 100);
        assert!(result.reasoning.contains("1/1"));
    }
}