aix-rs 1.0.0

Manage AI gateway profiles and launch AI coding tools with the right credentials
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
mod failure;
mod report;

use self::failure::{budget_failure, gateway_failure, safe_load_failure, safe_validation_failure};
use self::report::{print_human, DoctorOutput, DoctorReport};
use crate::cache::Cache;
use crate::commands::GatewayRequestOptions;
use crate::config::{self, CacheConfig, Config};
use crate::error::{AixError, DoctorFailureCategory};
use crate::gateway::{BudgetClient, OpenAiClient};
use crate::output;
use color_eyre::Result;
use std::path::PathBuf;
use std::time::{Duration, Instant};

pub async fn run(
    options: GatewayRequestOptions,
    config_path: Option<PathBuf>,
    json: bool,
) -> Result<()> {
    let GatewayRequestOptions { selection, timeout } = options;
    let report = diagnose(selection.profile, config_path, timeout).await?;
    let failed = report.failure_category.is_some();
    if json {
        let data = DoctorOutput {
            checks: &report.checks,
        };
        if failed {
            let mut stderr = std::io::stderr().lock();
            output::print_json_to("doctor", data, &mut stderr)?;
        } else {
            output::print_json("doctor", data)?;
        }
    } else {
        if failed {
            let mut stderr = std::io::stderr().lock();
            print_human(&report.checks, &mut stderr)?;
        } else {
            let mut stdout = std::io::stdout().lock();
            print_human(&report.checks, &mut stdout)?;
        }
    }

    match report.failure_category {
        Some(category) => Err(AixError::DoctorChecksFailed { category }.into()),
        None => Ok(()),
    }
}

async fn diagnose(
    profile_arg: Option<String>,
    config_path: Option<PathBuf>,
    timeout: Duration,
) -> Result<DoctorReport> {
    let mut report = DoctorReport::new();

    let path = match config::find_config_path(config_path.as_deref()) {
        Ok(Some(path)) => {
            report.pass("config_discovery", "config file found", None);
            Some(path)
        }
        Ok(None) => {
            report.fail(
                "config_discovery",
                "no config file could be resolved",
                "pass --config <PATH> or set AIX_CONFIG",
                None,
                DoctorFailureCategory::Config,
            );
            None
        }
        Err(_) => {
            report.fail(
                "config_discovery",
                "config path resolution failed",
                "check --config and AIX_CONFIG",
                None,
                DoctorFailureCategory::Config,
            );
            None
        }
    };

    let mut config = None;
    let mut config_is_valid = false;
    let mut env_files_loaded = false;
    if let Some(path) = path {
        match config::load(&path) {
            Ok(loaded) => match config::validate(&loaded) {
                Ok(()) => {
                    config_is_valid = true;
                    config = Some(loaded);
                    if config::load_env_files(config.as_ref().expect("config was just set")).is_ok()
                    {
                        env_files_loaded = true;
                        report.pass(
                            "config_validation",
                            "config parsed, validated, and configured env files loaded",
                            None,
                        );
                    } else {
                        report.fail(
                            "config_validation",
                            "a configured environment file could not be loaded",
                            "check that each configured env_files path exists and is readable",
                            None,
                            DoctorFailureCategory::Config,
                        );
                    }
                }
                Err(error) => {
                    report.fail_with("config_validation", safe_validation_failure(&error), None)
                }
            },
            Err(error) => report.fail_with("config_validation", safe_load_failure(&error), None),
        }
    } else {
        report.skipped("config_validation", "no config file was discovered");
    }

    let selected_profile = if config_is_valid {
        let cfg = config.as_ref().expect("validated config is available");
        match resolve_profile_without_picker(profile_arg, cfg) {
            Some(name) => match cfg.profiles.get(&name) {
                Some(profile) => {
                    report.pass(
                        "profile_selection",
                        "profile resolved without an interactive picker",
                        None,
                    );
                    Some(profile)
                }
                None => {
                    report.fail(
                        "profile_selection",
                        "selected profile is not defined in the config",
                        "choose a name under [profiles] or set a valid default_profile",
                        None,
                        DoctorFailureCategory::Config,
                    );
                    None
                }
            },
            None => {
                report.fail(
                    "profile_selection",
                    "no profile can be resolved without an interactive picker",
                    "pass PROFILE or --profile, set AIX_PROFILE, or configure default_profile",
                    None,
                    DoctorFailureCategory::Config,
                );
                None
            }
        }
    } else {
        report.skipped(
            "profile_selection",
            "config parsing or structural validation did not pass",
        );
        None
    };

    if selected_profile
        .as_ref()
        .is_some_and(|profile| profile.auth.is_chatgpt())
    {
        return Err(AixError::ChatGptAuthUnsupported.into());
    }

    let (api_key, base_url) = match (selected_profile, config.as_ref(), env_files_loaded) {
        (Some(profile), Some(cfg), true) => {
            let api_key = match profile.resolve_api_key() {
                Ok(value) if !value.expose_secret().trim().is_empty() => {
                    report.pass(
                        "api_key",
                        "API key source resolved to a non-empty value",
                        None,
                    );
                    Some(value)
                }
                Ok(_) => {
                    report.fail(
                        "api_key",
                        "API key source resolved to an empty value",
                        "check the selected profile's api_key source",
                        None,
                        DoctorFailureCategory::Secret,
                    );
                    None
                }
                Err(_) => {
                    report.fail(
                        "api_key",
                        "API key source could not be resolved",
                        "check the selected profile's api_key source",
                        None,
                        DoctorFailureCategory::Secret,
                    );
                    None
                }
            };

            let base_url = match config::resolve_base_url(profile, &cfg.endpoint) {
                Ok(value) if !value.expose_secret().trim().is_empty() => {
                    report.pass(
                        "base_url",
                        "base URL source resolved to a non-empty value",
                        None,
                    );
                    Some(value)
                }
                Ok(_) => {
                    report.fail(
                        "base_url",
                        "base URL source resolved to an empty value",
                        "check the profile base_url or endpoint.base_url source",
                        None,
                        DoctorFailureCategory::Secret,
                    );
                    None
                }
                Err(_) => {
                    report.fail(
                        "base_url",
                        "base URL source could not be resolved",
                        "check the profile base_url or endpoint.base_url source",
                        None,
                        DoctorFailureCategory::Secret,
                    );
                    None
                }
            };
            (api_key, base_url)
        }
        (Some(_), Some(_), false) => {
            report.skipped(
                "api_key",
                "configured env files did not load; secret sources may depend on them",
            );
            report.skipped(
                "base_url",
                "configured env files did not load; secret sources may depend on them",
            );
            (None, None)
        }
        _ => {
            report.skipped("api_key", "profile selection did not pass");
            report.skipped("base_url", "profile selection did not pass");
            (None, None)
        }
    };

    match (&api_key, &base_url) {
        (Some(api_key), Some(base_url)) => {
            let client = OpenAiClient::with_timeout(
                base_url.expose_secret(),
                api_key.expose_secret(),
                timeout,
            );
            let started = Instant::now();
            let response = client.models().await;
            let duration_ms = elapsed_ms(started.elapsed());
            match response {
                Ok(response) => {
                    report.pass(
                        "gateway_auth",
                        "authenticated OpenAI-compatible request succeeded",
                        Some(duration_ms),
                    );
                    match crate::commands::models::validate_response(response) {
                        Ok(()) => report.pass(
                            "model_discovery",
                            "GET /v1/models returned a parseable model list",
                            Some(duration_ms),
                        ),
                        Err(_) => report.fail(
                            "model_discovery",
                            "GET /v1/models did not return a valid model list",
                            "ensure the gateway returns a data array with a non-empty string id for each model",
                            Some(duration_ms),
                            DoctorFailureCategory::Network,
                        ),
                    }
                }
                Err(AixError::GatewayProtocolError(_)) => {
                    // The transport only reports this after receiving a successful HTTP status.
                    report.pass(
                        "gateway_auth",
                        "gateway accepted the authenticated request",
                        Some(duration_ms),
                    );
                    report.fail(
                        "model_discovery",
                        "GET /v1/models returned malformed JSON",
                        "ensure the gateway returns a valid OpenAI-compatible models response",
                        Some(duration_ms),
                        DoctorFailureCategory::Network,
                    );
                }
                Err(error) => {
                    report.fail_with("gateway_auth", gateway_failure(&error), Some(duration_ms));
                    report.skipped(
                        "model_discovery",
                        "the authenticated /v1/models request did not succeed",
                    );
                }
            }
        }
        _ => {
            report.skipped(
                "gateway_auth",
                "a non-empty API key and base URL are required",
            );
            report.skipped(
                "model_discovery",
                "the authenticated /v1/models request was skipped",
            );
        }
    }

    match (config.as_ref(), &api_key, &base_url) {
        (Some(_), Some(api_key), Some(base_url)) if config_is_valid && env_files_loaded => {
            let started = Instant::now();
            let result = BudgetClient::with_timeout(
                base_url.expose_secret(),
                api_key.expose_secret(),
                timeout,
            )
            .key_info()
            .await;
            let duration_ms = elapsed_ms(started.elapsed());
            match result {
                Ok(_) => report.pass(
                    "budget_info",
                    "GET /v1/key/info returned native budget information",
                    Some(duration_ms),
                ),
                Err(AixError::GatewayError {
                    status: 404 | 405 | 501,
                    ..
                }) => report.not_applicable(
                    "budget_info",
                    "GET /v1/key/info is not supported by this gateway",
                ),
                Err(error) => {
                    report.fail_with("budget_info", budget_failure(&error), Some(duration_ms));
                }
            }
        }
        _ => report.skipped(
            "budget_info",
            "a valid config, API key, and base URL are required",
        ),
    }

    let default_cache_config = CacheConfig::default();
    let cache_config = config
        .as_ref()
        .map(|cfg| &cfg.cache)
        .unwrap_or(&default_cache_config);
    if Cache::from_config(cache_config).check_writable().is_ok() {
        report.pass(
            "cache_directory",
            "cache directory is accessible and writable",
            None,
        );
    } else {
        report.fail(
            "cache_directory",
            "cache directory could not be created or written",
            "check permissions for AIX_CACHE_DIR or the platform cache directory",
            None,
            DoctorFailureCategory::Internal,
        );
    }

    Ok(report)
}

fn resolve_profile_without_picker(profile: Option<String>, config: &Config) -> Option<String> {
    profile.or_else(|| config.default_profile.clone())
}

fn elapsed_ms(duration: Duration) -> u64 {
    u64::try_from(duration.as_millis()).unwrap_or(u64::MAX)
}

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

    #[test]
    fn profile_resolution_does_not_pick_interactively() {
        let config: Config = toml::from_str(
            r#"
[endpoint]
base_url = "https://gateway.example"
[profiles.work]
api_key = "test-key"
"#,
        )
        .unwrap();

        assert_eq!(resolve_profile_without_picker(None, &config), None);
        assert_eq!(
            resolve_profile_without_picker(Some("other".to_string()), &config),
            Some("other".to_string())
        );
    }

    #[test]
    fn profile_resolution_uses_default_without_interactive_picker() {
        let config: Config = toml::from_str(
            r#"
default_profile = "work"
[endpoint]
base_url = "https://gateway.example"
[profiles.work]
api_key = "test-key"
"#,
        )
        .unwrap();

        assert_eq!(
            resolve_profile_without_picker(None, &config),
            Some("work".to_string())
        );
    }
}