codewhale-workflow 0.9.4

Typed Workflow IR and validation for Codewhale
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
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
use std::collections::BTreeMap;

use serde::de::DeserializeOwned;
use serde::{Deserialize, Serialize};
use thiserror::Error;

use crate::{AgentType, ModelPolicy, WorkflowUsage};

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ModelRole {
    Planner,
    LeafReasoner,
    Implementer,
    Reviewer,
    Teacher,
    Student,
    JsonExtractor,
}

impl From<AgentType> for ModelRole {
    fn from(agent_type: AgentType) -> Self {
        match agent_type {
            AgentType::General | AgentType::Explore => Self::LeafReasoner,
            AgentType::Plan => Self::Planner,
            AgentType::Review | AgentType::Verifier => Self::Reviewer,
            AgentType::Implementer => Self::Implementer,
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)]
pub struct ModelCapabilities {
    #[serde(default)]
    pub tool_calls: bool,
    #[serde(default)]
    pub json_mode: bool,
    #[serde(default)]
    pub prompt_cache: bool,
    #[serde(default)]
    pub large_context: bool,
    #[serde(default)]
    pub streaming: bool,
}

impl ModelCapabilities {
    #[must_use]
    pub fn satisfies(self, required: Self) -> bool {
        (!required.tool_calls || self.tool_calls)
            && (!required.json_mode || self.json_mode)
            && (!required.prompt_cache || self.prompt_cache)
            && (!required.large_context || self.large_context)
            && (!required.streaming || self.streaming)
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ProviderModel {
    pub provider: String,
    pub model: String,
    #[serde(default)]
    pub capabilities: ModelCapabilities,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ResolvedModel {
    pub role: ModelRole,
    pub provider: String,
    pub model: String,
    pub capabilities: ModelCapabilities,
    pub source: ModelSelectionSource,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ModelSelectionSource {
    Primary,
    Fallback,
    RoleDefault,
}

#[derive(Debug, Clone, Default)]
pub struct ProviderRegistry {
    models: BTreeMap<String, ProviderModel>,
    role_policies: BTreeMap<ModelRole, ModelPolicy>,
}

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

    pub fn with_model(mut self, model: ProviderModel) -> Self {
        self.insert_model(model);
        self
    }

    pub fn with_role_policy(mut self, role: ModelRole, policy: ModelPolicy) -> Self {
        self.role_policies.insert(role, policy);
        self
    }

    pub fn insert_model(&mut self, model: ProviderModel) {
        self.models
            .insert(model_key(&model.provider, &model.model), model);
    }

    pub fn resolve_role(
        &self,
        role: ModelRole,
        policy: Option<&ModelPolicy>,
        required: ModelCapabilities,
    ) -> Result<ResolvedModel, ModelPolicyError> {
        let policy = match policy {
            Some(policy) => (policy, ModelSelectionSource::Primary),
            None => (
                self.role_policies
                    .get(&role)
                    .ok_or(ModelPolicyError::MissingPolicy { role })?,
                ModelSelectionSource::RoleDefault,
            ),
        };
        self.resolve_policy(role, policy.0, policy.1, required)
    }

    fn resolve_policy(
        &self,
        role: ModelRole,
        policy: &ModelPolicy,
        primary_source: ModelSelectionSource,
        required: ModelCapabilities,
    ) -> Result<ResolvedModel, ModelPolicyError> {
        let candidates = model_candidates(policy)?;
        let mut rejected = Vec::new();
        for (index, candidate) in candidates.iter().enumerate() {
            let source = if index == 0 {
                primary_source
            } else {
                ModelSelectionSource::Fallback
            };
            let Some(model) = self
                .models
                .get(&model_key(&candidate.provider, &candidate.model))
            else {
                rejected.push(format!(
                    "{}/{}: unknown",
                    candidate.provider, candidate.model
                ));
                continue;
            };
            if model.capabilities.satisfies(required) {
                return Ok(ResolvedModel {
                    role,
                    provider: model.provider.clone(),
                    model: model.model.clone(),
                    capabilities: model.capabilities,
                    source,
                });
            }
            rejected.push(format!(
                "{}/{}: missing required capabilities",
                model.provider, model.model
            ));
        }
        Err(ModelPolicyError::NoCapableModel { role, rejected })
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct CompletionRequest {
    pub role: ModelRole,
    pub prompt: String,
    #[serde(default)]
    pub require_json: bool,
    #[serde(default)]
    pub model_policy: ModelPolicy,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct CompletionResponse {
    pub text: String,
    #[serde(default)]
    pub usage: WorkflowUsage,
}

pub trait ModelProvider {
    fn provider(&self) -> &str;
    fn model(&self) -> &str;
    fn capabilities(&self) -> ModelCapabilities;
    fn complete(
        &self,
        request: &CompletionRequest,
    ) -> Result<CompletionResponse, ModelProviderError>;
}

#[derive(Debug, Clone)]
pub struct MockModelProvider {
    provider: String,
    model: String,
    capabilities: ModelCapabilities,
    response: CompletionResponse,
}

impl MockModelProvider {
    pub fn new(
        provider: impl Into<String>,
        model: impl Into<String>,
        capabilities: ModelCapabilities,
        response: impl Into<String>,
    ) -> Self {
        Self {
            provider: provider.into(),
            model: model.into(),
            capabilities,
            response: CompletionResponse {
                text: response.into(),
                usage: WorkflowUsage::default(),
            },
        }
    }
}

impl ModelProvider for MockModelProvider {
    fn provider(&self) -> &str {
        &self.provider
    }

    fn model(&self) -> &str {
        &self.model
    }

    fn capabilities(&self) -> ModelCapabilities {
        self.capabilities
    }

    fn complete(
        &self,
        _request: &CompletionRequest,
    ) -> Result<CompletionResponse, ModelProviderError> {
        Ok(self.response.clone())
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Error)]
pub enum ModelPolicyError {
    #[error("no model policy configured for role `{role:?}`")]
    MissingPolicy { role: ModelRole },
    #[error("model policy must include a model for role resolution")]
    MissingModel,
    #[error("fallback model `{model}` requires a provider when the primary policy has none")]
    MissingFallbackProvider { model: String },
    #[error("no configured model satisfies role `{role:?}` requirements: {rejected:?}")]
    NoCapableModel {
        role: ModelRole,
        rejected: Vec<String>,
    },
}

#[derive(Debug, Clone, PartialEq, Eq, Error)]
pub enum ModelProviderError {
    #[error("model provider `{provider}/{model}` failed: {reason}")]
    Failed {
        provider: String,
        model: String,
        reason: String,
    },
}

#[derive(Debug, Clone, PartialEq, Eq, Error)]
pub enum JsonRepairError {
    #[error("json parse failed before and after one repair pass: {reason}")]
    Parse { reason: String },
}

pub fn parse_json_with_repair<T: DeserializeOwned>(raw: &str) -> Result<T, JsonRepairError> {
    match serde_json::from_str(raw) {
        Ok(parsed) => Ok(parsed),
        Err(first) => {
            let repaired = repair_json_text_once(raw);
            serde_json::from_str(&repaired).map_err(|second| JsonRepairError::Parse {
                reason: format!("{first}; repair failed: {second}"),
            })
        }
    }
}

pub fn repair_json_text_once(raw: &str) -> String {
    let trimmed = raw.trim();
    let without_fence = trimmed
        .strip_prefix("```json")
        .or_else(|| trimmed.strip_prefix("```"))
        .and_then(|value| value.strip_suffix("```"))
        .map(str::trim)
        .unwrap_or(trimmed);

    first_valid_json_payload(without_fence)
        .unwrap_or(without_fence)
        .to_string()
}

#[derive(Debug, Clone, PartialEq, Eq)]
struct ModelCandidate {
    provider: String,
    model: String,
}

fn model_candidates(policy: &ModelPolicy) -> Result<Vec<ModelCandidate>, ModelPolicyError> {
    let mut candidates = Vec::new();
    let Some(primary_model) = policy.model.as_ref() else {
        return Err(ModelPolicyError::MissingModel);
    };
    candidates.push(candidate_from_model(
        policy.provider.as_deref(),
        primary_model,
    )?);
    for fallback in &policy.fallback_models {
        candidates.push(candidate_from_model(policy.provider.as_deref(), fallback)?);
    }
    Ok(candidates)
}

fn candidate_from_model(
    default_provider: Option<&str>,
    model: &str,
) -> Result<ModelCandidate, ModelPolicyError> {
    if let Some((provider, model)) = model.split_once('/') {
        return Ok(ModelCandidate {
            provider: provider.to_string(),
            model: model.to_string(),
        });
    }
    let Some(provider) = default_provider else {
        return Err(ModelPolicyError::MissingFallbackProvider {
            model: model.to_string(),
        });
    };
    Ok(ModelCandidate {
        provider: provider.to_string(),
        model: model.to_string(),
    })
}

fn model_key(provider: &str, model: &str) -> String {
    format!("{provider}/{model}")
}

// Repair scans untrusted model text once per possible container start. Keep the
// fallback bounded when malformed output contains a long delimiter flood.
const JSON_REPAIR_CANDIDATE_LIMIT: usize = 64;

fn first_valid_json_payload(raw: &str) -> Option<&str> {
    let mut attempted = 0;
    for (start, open) in raw.char_indices() {
        if !matches!(open, '{' | '[') {
            continue;
        }
        attempted += 1;
        if attempted > JSON_REPAIR_CANDIDATE_LIMIT {
            break;
        }

        let Some(candidate) = balanced_json_payload(&raw[start..]) else {
            continue;
        };
        if serde_json::from_str::<serde_json::Value>(candidate).is_ok() {
            return Some(candidate);
        }
    }
    None
}

fn balanced_json_payload(raw: &str) -> Option<&str> {
    let mut stack = Vec::new();
    let mut in_string = false;
    let mut escaped = false;

    for (offset, character) in raw.char_indices() {
        if in_string {
            if escaped {
                escaped = false;
            } else {
                match character {
                    '\\' => escaped = true,
                    '"' => in_string = false,
                    _ => {}
                }
            }
            continue;
        }

        match character {
            '"' => in_string = true,
            '{' | '[' => stack.push(character),
            '}' | ']' => {
                let expected_open = if character == '}' { '{' } else { '[' };
                if stack.pop() != Some(expected_open) {
                    return None;
                }
                if stack.is_empty() {
                    return Some(&raw[..offset + character.len_utf8()]);
                }
            }
            _ => {}
        }
    }
    None
}

#[cfg(test)]
mod tests {
    use super::*;

    fn model(provider: &str, model: &str, capabilities: ModelCapabilities) -> ProviderModel {
        ProviderModel {
            provider: provider.to_string(),
            model: model.to_string(),
            capabilities,
        }
    }

    #[test]
    fn provider_capability_fallback() {
        let registry = ProviderRegistry::new()
            .with_model(model("mock", "plain", ModelCapabilities::default()))
            .with_model(model(
                "mock",
                "json",
                ModelCapabilities {
                    json_mode: true,
                    ..ModelCapabilities::default()
                },
            ));
        let policy = ModelPolicy {
            provider: Some("mock".to_string()),
            model: Some("plain".to_string()),
            fallback_models: vec!["json".to_string()],
        };

        let resolved = registry
            .resolve_role(
                ModelRole::JsonExtractor,
                Some(&policy),
                ModelCapabilities {
                    json_mode: true,
                    ..ModelCapabilities::default()
                },
            )
            .expect("fallback json model should satisfy the role");

        assert_eq!(resolved.model, "json");
        assert_eq!(resolved.source, ModelSelectionSource::Fallback);
    }

    #[test]
    fn role_default_policy_resolves_model() {
        let registry = ProviderRegistry::new()
            .with_model(model(
                "mock",
                "planner",
                ModelCapabilities {
                    large_context: true,
                    ..ModelCapabilities::default()
                },
            ))
            .with_role_policy(
                ModelRole::Planner,
                ModelPolicy {
                    provider: Some("mock".to_string()),
                    model: Some("planner".to_string()),
                    fallback_models: Vec::new(),
                },
            );

        let resolved = registry
            .resolve_role(
                ModelRole::Planner,
                None,
                ModelCapabilities {
                    large_context: true,
                    ..ModelCapabilities::default()
                },
            )
            .expect("role default should resolve");

        assert_eq!(resolved.role, ModelRole::Planner);
        assert_eq!(resolved.source, ModelSelectionSource::RoleDefault);
    }

    #[test]
    fn agent_type_maps_to_model_role() {
        assert_eq!(ModelRole::from(AgentType::Plan), ModelRole::Planner);
        assert_eq!(
            ModelRole::from(AgentType::Implementer),
            ModelRole::Implementer
        );
        assert_eq!(ModelRole::from(AgentType::Verifier), ModelRole::Reviewer);
    }

    #[test]
    fn json_repair_fallback() {
        #[derive(Debug, Deserialize, PartialEq, Eq)]
        struct Payload {
            answer: String,
        }

        let parsed: Payload = parse_json_with_repair(
            r#"Here is the JSON:
```json
{"answer":"ok"}
```
"#,
        )
        .expect("repair should extract fenced JSON");

        assert_eq!(
            parsed,
            Payload {
                answer: "ok".to_string()
            }
        );
    }

    #[test]
    fn json_repair_fallback_fails_closed() {
        let err = parse_json_with_repair::<serde_json::Value>("not json")
            .expect_err("non-json text should fail closed");

        assert!(matches!(err, JsonRepairError::Parse { .. }));
    }

    #[test]
    fn mock_provider_returns_configured_response() {
        let provider = MockModelProvider::new(
            "mock",
            "fast",
            ModelCapabilities::default(),
            "mock response",
        );
        let request = CompletionRequest {
            role: ModelRole::LeafReasoner,
            prompt: "say something".to_string(),
            require_json: false,
            model_policy: ModelPolicy::default(),
        };

        let response = provider.complete(&request).expect("mock should respond");

        assert_eq!(provider.provider(), "mock");
        assert_eq!(provider.model(), "fast");
        assert_eq!(response.text, "mock response");
    }

    #[test]
    fn repair_json_text_once_extracts_supported_payloads() {
        // Plain JSON object
        assert_eq!(
            repair_json_text_once(r#"{"key": "value"}"#),
            r#"{"key": "value"}"#
        );

        // Plain JSON array
        assert_eq!(repair_json_text_once(r#"[1, 2, 3]"#), r#"[1, 2, 3]"#);

        // Markdown fenced JSON object
        assert_eq!(
            repair_json_text_once("```json\n{\"key\": \"value\"}\n```"),
            r#"{"key": "value"}"#
        );

        // Markdown fenced JSON array
        assert_eq!(
            repair_json_text_once("```json\n[1, 2, 3]\n```"),
            r#"[1, 2, 3]"#
        );

        // Generic markdown fence
        assert_eq!(
            repair_json_text_once("```\n{\"key\": \"value\"}\n```"),
            r#"{"key": "value"}"#
        );

        // JSON object embedded in text
        assert_eq!(
            repair_json_text_once("Here is the JSON:\n\n{\"key\": \"value\"}\n\nHope this helps!"),
            r#"{"key": "value"}"#
        );

        // JSON array embedded in text
        assert_eq!(
            repair_json_text_once("Some text before [1, 2, 3] and some text after"),
            r#"[1, 2, 3]"#
        );

        // Nested structures (object containing array)
        assert_eq!(
            repair_json_text_once(r#"{"key": [1, 2, 3]}"#),
            r#"{"key": [1, 2, 3]}"#
        );

        // Nested structures (array containing object)
        assert_eq!(
            repair_json_text_once(r#"[{"key": "value"}]"#),
            r#"[{"key": "value"}]"#
        );

        // Fenced JSON embedded in text
        assert_eq!(
            repair_json_text_once("Here is the JSON:\n```json\n{\"key\": \"value\"}\n```\nDone."),
            r#"{"key": "value"}"#
        );

        // No valid JSON, fallback to trimmed text
        assert_eq!(
            repair_json_text_once("Just some plain text without json"),
            "Just some plain text without json"
        );

        // Fenced plain text, falls back to stripped and trimmed text
        assert_eq!(
            repair_json_text_once("```json\nJust some plain text\n```"),
            "Just some plain text"
        );

        // An unmatched opening bracket must not block a later valid object.
        assert_eq!(repair_json_text_once("[note {\"ok\":1}"), r#"{"ok":1}"#);

        // Delimiters inside strings must not terminate the outer object.
        assert_eq!(
            repair_json_text_once(r#"Prefix text {"data": "[nested]"} postfix text"#),
            r#"{"data": "[nested]"}"#
        );

        // The earliest balanced candidate may still be invalid JSON. Keep scanning
        // until a balanced candidate also parses successfully.
        assert_eq!(
            repair_json_text_once(r#"[not-json] then {"ok":true}"#),
            r#"{"ok":true}"#
        );

        // Escaped quotes and backslashes stay inside the JSON string.
        assert_eq!(
            repair_json_text_once(
                r#"prefix {"value":"a \"quoted\" [item]","path":"C:\\tmp"} suffix"#
            ),
            r#"{"value":"a \"quoted\" [item]","path":"C:\\tmp"}"#
        );

        // A mismatched outer delimiter must not consume a later valid payload.
        assert_eq!(
            repair_json_text_once(r#"[broken} then [1,{"ok":true}]"#),
            r#"[1,{"ok":true}]"#
        );
    }
}