codewhale-runtime 0.10.3

Headless Codewhale runtime, split out of the terminal UI one module at a time; no terminal UI dependency
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
use super::test_support::{EnvGuard, no_managed_config};
use super::*;
use crate::test_support::{EnvVarGuard, lock_test_env};
use codewhale_config::catalog::bundled_catalog_offerings;
use codewhale_config::catalog::reviewed::bundled_reviewed;
use codewhale_config::descriptors::{bundled_provider_descriptors, compatibility_for_kind};
use codewhale_config::route::offering::bundled_offerings;
use codewhale_config::route::{
    LogicalModelRef, ProviderDescriptor as RouteProviderDescriptor, RouteError, RouteRequest,
    RouteResolver,
};
use std::collections::{BTreeMap, BTreeSet};
use std::fs;
use std::path::Path;

const GOLDEN_PATH: &str = concat!(
    env!("CARGO_MANIFEST_DIR"),
    "/src/config/model_resolution.golden.tsv"
);

const REGENERATE_COMMAND: &str = "WRITE_GOLDEN=1 CODEWHALE_SCCACHE=1 python3 scripts/build-lock.py \
/tmp/codewhale-build.lock -- sh scripts/with-hermetic-test-home.sh sh scripts/dev-cargo.sh test \
--locked -p codewhale-runtime --lib config::model_resolution_golden";

const COLUMNS: [&str; 14] = [
    "provider",
    "input",
    "input_kind",
    "runtime_canonical",
    "runtime_normalized",
    "runtime_wire",
    "runtime_requested",
    "tui_default_model",
    "cli_model",
    "route_canonical",
    "route_wire",
    "route_endpoint",
    "route_context",
    "disagree",
];

const IDENTITY_COLUMNS: [(&str, usize); 7] = [
    ("runtime_normalized", 4),
    ("runtime_wire", 5),
    ("runtime_requested", 6),
    ("tui_default_model", 7),
    ("cli_model", 8),
    ("route_canonical", 9),
    ("route_wire", 10),
];

const PROVIDER_ENV_SUFFIXES: [&str; 8] = [
    "_MODEL",
    "_BASE_URL",
    "_API_BASE",
    "_PROVIDER",
    "_MODE",
    "_HTTP_HEADERS",
    "_DEFAULT_TEXT_MODEL",
    "_PROFILE",
];

struct Target {
    label: String,
    kind: ProviderKind,
    catalog_provider_id: String,
    config_identity: String,
    config_table: String,
    custom_base_url: Option<String>,
    default_model: String,
}

impl Target {
    fn builtin(kind: ProviderKind) -> Self {
        Self {
            label: kind.as_str().to_string(),
            kind,
            catalog_provider_id: kind.as_str().to_string(),
            config_identity: kind.as_str().to_string(),
            config_table: compatibility_for_kind(kind).config_key.to_string(),
            custom_base_url: None,
            default_model: RouteProviderDescriptor::for_kind(kind)
                .default_wire_model()
                .as_str()
                .to_string(),
        }
    }

    fn data_only(descriptor: &codewhale_config::descriptors::ProviderDescriptor) -> Self {
        Self {
            label: format!("descriptor:{}", descriptor.id),
            kind: ProviderKind::Custom,
            catalog_provider_id: descriptor.id.clone(),
            config_identity: descriptor.id.clone(),
            config_table: descriptor.id.clone(),
            custom_base_url: Some(descriptor.base_url.clone()),
            default_model: descriptor.default_model.clone(),
        }
    }

    fn config_body(&self, model: &str) -> String {
        let model = toml::Value::String(model.to_string()).to_string();
        let identity = toml::Value::String(self.config_identity.clone()).to_string();
        let table = &self.config_table;
        match &self.custom_base_url {
            None => format!(
                "provider = {identity}\n\n[providers.{table}]\napi_key = \"k\"\nmodel = {model}\n"
            ),
            Some(base_url) => {
                let base_url = toml::Value::String(base_url.clone()).to_string();
                format!(
                    "provider = {identity}\n\n[providers.{table}]\nkind = \"openai-compatible\"\n\
                     base_url = {base_url}\napi_key = \"k\"\nmodel = {model}\n"
                )
            }
        }
    }
}

fn targets() -> Vec<Target> {
    ProviderKind::ALL
        .iter()
        .copied()
        .map(Target::builtin)
        .chain(bundled_provider_descriptors().iter().map(Target::data_only))
        .collect()
}

fn provider_model_rules(provider_id: &str) -> Option<serde_json::Value> {
    let descriptors: serde_json::Value = serde_json::from_str(include_str!(concat!(
        env!("CARGO_MANIFEST_DIR"),
        "/../config/assets/provider_descriptors.json"
    )))
    .expect("provider_descriptors.json parses");
    descriptors["providers"]
        .as_array()
        .expect("provider rows")
        .iter()
        .find(|row| row["id"] == provider_id)
        .map(|row| row["models"].clone())
}

fn offering_ids_by_provider() -> BTreeMap<String, BTreeSet<String>> {
    let mut ids: BTreeMap<String, BTreeSet<String>> = BTreeMap::new();
    let reviewed = bundled_offerings();
    let asset = bundled_catalog_offerings()
        .iter()
        .map(|row| row.to_offering())
        .collect::<Vec<_>>();
    for offering in reviewed.iter().chain(asset.iter()) {
        ids.entry(offering.provider.as_str().to_string())
            .or_default()
            .insert(offering.wire_model_id.as_str().to_string());
    }
    ids
}

fn committed_inputs() -> BTreeMap<String, BTreeSet<String>> {
    let mut inputs: BTreeMap<String, BTreeSet<String>> = BTreeMap::new();
    let text = fs::read_to_string(GOLDEN_PATH).unwrap_or_default();
    for line in text.lines().skip(1) {
        let mut cells = line.split('\t');
        let (Some(provider), Some(input)) = (cells.next(), cells.next()) else {
            continue;
        };
        let input = if input.starts_with('"') {
            serde_json::from_str::<String>(input).expect("quoted golden input")
        } else {
            input.to_string()
        };
        inputs
            .entry(provider.to_string())
            .or_default()
            .insert(input);
    }
    inputs
}

fn inputs_for(
    target: &Target,
    offerings: &BTreeMap<String, BTreeSet<String>>,
    committed: &BTreeMap<String, BTreeSet<String>>,
) -> BTreeMap<String, BTreeSet<&'static str>> {
    let mut inputs: BTreeMap<String, BTreeSet<&'static str>> = BTreeMap::new();
    let mut add = |input: &str, kind: &'static str| {
        inputs.entry(input.to_string()).or_default().insert(kind);
    };
    let reviewed = bundled_reviewed();
    let is_builtin = target.custom_base_url.is_none();

    add(&target.default_model, "default");
    let provider_offerings = offerings.get(&target.catalog_provider_id);
    for id in provider_offerings.into_iter().flatten() {
        add(id, "offering");
    }

    if is_builtin && let Some(rules) = provider_model_rules(&target.catalog_provider_id) {
        for table in ["aliases", "wire_slugs"] {
            for (key, value) in rules[table].as_object().expect("models table") {
                add(key, "alias-key");
                add(value.as_str().expect("models target"), "alias-target");
            }
        }
    }
    if is_builtin {
        for selection in reviewed
            .selections
            .iter()
            .filter(|selection| selection.provider == target.catalog_provider_id)
        {
            add(&selection.id, "alias-target");
        }
    }

    let variant_bases = std::iter::once(target.default_model.clone()).chain(
        provider_offerings
            .into_iter()
            .flatten()
            .find(|id| **id != target.default_model)
            .cloned(),
    );
    for base in variant_bases.collect::<Vec<_>>() {
        add(&base.to_uppercase(), "variant-uppercase");
        add(&format!("models/{base}"), "variant-models-prefix");
        add(
            &format!("{}/{base}", target.catalog_provider_id),
            "variant-provider-prefix",
        );
        add(&format!("  {base}  "), "variant-whitespace");
    }

    add("auto", "sentinel-auto");
    add("totally-unknown-model-x", "unknown");
    if !matches!(
        target.kind,
        ProviderKind::Deepseek | ProviderKind::DeepseekAnthropic
    ) {
        add("deepseek-v4-pro", "foreign-deepseek");
    }
    for input in committed.get(&target.label).into_iter().flatten() {
        inputs
            .entry(input.clone())
            .or_insert_with(|| BTreeSet::from(["carried"]));
    }
    inputs
}

fn optional_cell(value: Option<String>) -> String {
    match value {
        Some(value) if !value.is_empty() => value,
        _ => "-".to_string(),
    }
}

fn route_error_tag(error: &RouteError) -> &'static str {
    match error {
        RouteError::EmptyModel => "-!empty-model",
        RouteError::InvalidProvider(_) => "-!invalid-provider",
        RouteError::AmbiguousModel(_) => "-!ambiguous-model",
        RouteError::ForeignModelForDirectProvider { .. } => "-!foreign-model",
        RouteError::ResponsesProfile { .. } => "-!responses-profile",
        RouteError::UnsupportedModelProtocol { .. } => "-!unsupported-protocol",
    }
}

fn route_cells(target: &Target, input: &str) -> [String; 4] {
    let request = RouteRequest {
        explicit_provider: Some(target.kind),
        model_selector: Some(LogicalModelRef::from(input)),
        base_url_override: target.custom_base_url.clone(),
        ..RouteRequest::default()
    };
    match RouteResolver::bundled().resolve(&request) {
        Ok(candidate) => [
            optional_cell(
                candidate
                    .canonical_model()
                    .map(|id| id.as_str().to_string()),
            ),
            optional_cell(Some(candidate.wire_model_id().as_str().to_string())),
            optional_cell(Some(candidate.endpoint().endpoint_key.clone())),
            optional_cell(
                candidate
                    .limits()
                    .context_tokens
                    .map(|tokens| tokens.to_string()),
            ),
        ],
        Err(error) => std::array::from_fn(|_| route_error_tag(&error).to_string()),
    }
}

fn configured_chain_cells(target: &Target, input: &str, config_path: &Path) -> [String; 2] {
    fs::write(config_path, target.config_body(input)).expect("write golden fixture config");
    let tui = match Config::load(Some(config_path.to_path_buf()), None) {
        Ok(config) => optional_cell(Some(config.default_model())),
        Err(_) => "-!load".to_string(),
    };
    let cli = match codewhale_config::ConfigStore::load(Some(config_path.to_path_buf())) {
        Ok(store) => {
            let resolved = store
                .config
                .resolve_runtime_options(&codewhale_config::CliRuntimeOverrides::default());
            if resolved.model_error.is_some() {
                "-!load".to_string()
            } else {
                optional_cell(Some(resolved.model))
            }
        }
        Err(_) => "-!load".to_string(),
    };
    [tui, cli]
}

fn tsv_cell(value: &str) -> String {
    if value != value.trim() || value.contains(['\t', '\n', '\r']) {
        format!("{value:?}")
    } else {
        value.to_string()
    }
}

fn render_row(cells: &[String]) -> String {
    cells
        .iter()
        .map(|cell| tsv_cell(cell))
        .collect::<Vec<_>>()
        .join("\t")
}

fn golden_table(config_path: &Path) -> String {
    let offerings = offering_ids_by_provider();
    let committed = committed_inputs();
    let mut targets = targets();
    targets.sort_by(|a, b| a.label.cmp(&b.label));

    let mut out = COLUMNS.join("\t");
    out.push('\n');
    for target in &targets {
        for (input, kinds) in inputs_for(target, &offerings, &committed) {
            let mut cells: Vec<String> = Vec::with_capacity(COLUMNS.len());
            cells.push(target.label.clone());
            cells.push(input.clone());
            cells.push(kinds.into_iter().collect::<Vec<_>>().join("+"));
            let resolved = codewhale_config::route::resolve_model(target.kind, &input, None).ok();
            let trimmed = input.trim();
            let fallback_wire = (!trimmed.is_empty()).then(|| {
                resolved
                    .as_ref()
                    .map_or_else(|| trimmed.to_string(), |r| r.wire_id.clone())
            });
            cells.push(optional_cell(resolved.as_ref().map(|r| r.logical.clone())));
            cells.push(optional_cell(resolved.as_ref().map(|r| r.wire_id.clone())));
            cells.push(optional_cell(fallback_wire));
            cells.push(optional_cell(resolved.as_ref().map(|r| r.logical.clone())));
            cells.extend(configured_chain_cells(target, &input, config_path));
            cells.extend(route_cells(target, &input));
            let canonical = &cells[3];
            let disagree = IDENTITY_COLUMNS
                .iter()
                .filter(|(_, index)| cells[*index] != *canonical)
                .map(|(name, _)| *name)
                .collect::<Vec<_>>()
                .join(",");
            cells.push(if disagree.is_empty() {
                "-".to_string()
            } else {
                disagree
            });
            out.push_str(&render_row(&cells));
            out.push('\n');
        }
    }
    out
}

struct StrippedProviderEnv {
    _guards: Vec<EnvVarGuard>,
}

impl StrippedProviderEnv {
    fn new() -> Self {
        let mut names: BTreeSet<String> = ProviderKind::ALL
            .iter()
            .flat_map(|kind| RouteProviderDescriptor::for_kind(*kind).env_vars().iter())
            .map(|name| (*name).to_string())
            .collect();
        names.extend(
            bundled_provider_descriptors()
                .iter()
                .map(|descriptor| descriptor.api_key_env.clone()),
        );
        names.extend(
            std::env::vars_os()
                .filter_map(|(name, _)| name.into_string().ok())
                .filter(|name| {
                    PROVIDER_ENV_SUFFIXES
                        .iter()
                        .any(|suffix| name.ends_with(suffix))
                }),
        );
        let guards = names
            .into_iter()
            .map(|name| EnvVarGuard::remove(Box::leak(name.into_boxed_str())))
            .collect();
        Self { _guards: guards }
    }
}

#[test]
fn model_resolution_matches_the_committed_golden() {
    let _lock = lock_test_env();
    let _stripped = StrippedProviderEnv::new();
    let root = tempfile::tempdir().expect("golden tempdir");
    let _guard = EnvGuard::new(root.path());
    let _managed = no_managed_config(root.path());
    let config_path = root.path().join(".deepseek").join("config.toml");
    fs::create_dir_all(config_path.parent().expect("config dir")).expect("create config dir");

    let actual = golden_table(&config_path);
    if std::env::var("WRITE_GOLDEN").ok().as_deref() == Some("1") {
        fs::write(GOLDEN_PATH, &actual).expect("write model resolution golden");
        return;
    }
    let expected = fs::read_to_string(GOLDEN_PATH)
        .unwrap_or_default()
        .replace("\r\n", "\n");
    if actual != expected {
        let divergence = crate::test_support::first_divergence(&expected, &actual);
        panic!(
            "model resolution changed from {GOLDEN_PATH} (first divergence: {divergence:?}); \
             if the change is intended, regenerate with: {REGENERATE_COMMAND}"
        );
    }
}