awaken-server 0.6.0

Multi-protocol HTTP server with SSE, mailbox, and protocol adapters for Awaken
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
use std::collections::{HashMap, HashSet};
use std::time::Duration;

use awaken_runtime::registry::model_capabilities::{
    ModelCapabilityPatch, normalize_capability_model_name, parse_provider_model_capabilities,
};
use awaken_server_contract::{ModelPoolSpec, ModelSpec, ProviderSpec};
use futures::future::join_all;
use reqwest::header::{AUTHORIZATION, HeaderMap, HeaderName, HeaderValue};

use super::build_default_headers_from_options;

/// Result of a provider-capability discovery pass.
///
/// `attempted` distinguishes providers we actually issued a discovery request
/// for (whether it then succeeded or failed) from providers we deliberately did
/// not probe this round (no referenced model needs discovery, or the default
/// endpoint was skipped for lack of credentials). The capability cache uses it
/// to warn about *stale* snapshots only when discovery was attempted and failed,
/// never when discovery was simply unnecessary.
#[derive(Default)]
pub(super) struct ProviderCapabilityDiscovery {
    pub(super) discovered: HashMap<String, HashMap<String, ModelCapabilityPatch>>,
    pub(super) attempted: HashSet<String>,
}

enum DiscoveryOutcome {
    /// Discovery was not issued (skipped endpoint or no resolvable model URL).
    NotAttempted,
    /// A discovery request was issued but did not yield usable metadata.
    Failed,
    /// A discovery request succeeded; the map may be empty.
    Discovered(HashMap<String, ModelCapabilityPatch>),
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum DiscoveryAuthScheme {
    Bearer,
    GoogleApiKey,
    None,
    Invalid,
}

impl DiscoveryAuthScheme {
    fn default_for_schema(schema: &str) -> Self {
        match schema {
            "gemini" => Self::GoogleApiKey,
            _ => Self::Bearer,
        }
    }
}

pub(super) async fn discover_provider_capabilities(
    providers: &[ProviderSpec],
    models: &[ModelSpec],
    pools: &[ModelPoolSpec],
) -> ProviderCapabilityDiscovery {
    let wanted = referenced_models_by_provider(providers, models, pools);
    if wanted.is_empty() {
        return ProviderCapabilityDiscovery::default();
    }

    let client = reqwest::Client::new();
    let tasks = providers
        .iter()
        .filter(|provider| wanted.contains_key(&provider.id))
        .map(|provider| {
            let client = client.clone();
            let wanted = wanted.get(&provider.id).cloned().unwrap_or_default();
            async move {
                let outcome = discover_one_provider(&client, provider, &wanted).await;
                (provider.id.clone(), outcome)
            }
        });

    let mut result = ProviderCapabilityDiscovery::default();
    for (provider_id, outcome) in join_all(tasks).await {
        match outcome {
            DiscoveryOutcome::NotAttempted => {}
            DiscoveryOutcome::Failed => {
                result.attempted.insert(provider_id);
            }
            DiscoveryOutcome::Discovered(capabilities) => {
                result.attempted.insert(provider_id.clone());
                result.discovered.insert(provider_id, capabilities);
            }
        }
    }
    result
}

async fn discover_one_provider(
    client: &reqwest::Client,
    provider: &ProviderSpec,
    wanted: &HashSet<String>,
) -> DiscoveryOutcome {
    // Only providers with a known `/models` schema are probed. An unknown or
    // custom adapter is NOT assumed to be OpenAI-compatible — its endpoint
    // would otherwise be parsed as trusted OpenAI metadata. Custom providers
    // opt in explicitly via `adapter_options.model_discovery_schema`.
    let Some(schema) = provider_discovery_schema(provider) else {
        tracing::debug!(
            provider_id = %provider.id,
            adapter = %provider.adapter,
            "skipping model capability discovery: adapter has no known /models schema \
             (set adapter_options.model_discovery_schema to opt in)"
        );
        return DiscoveryOutcome::NotAttempted;
    };
    if should_skip_unauthenticated_default_endpoint(provider) {
        tracing::debug!(
            provider_id = %provider.id,
            adapter = %provider.adapter,
            "skipping provider model capability discovery without explicit credentials"
        );
        return DiscoveryOutcome::NotAttempted;
    }
    let url = match model_list_url(provider) {
        Some(url) => url,
        None => return DiscoveryOutcome::NotAttempted,
    };
    let mut request = client
        .get(url.clone())
        .timeout(Duration::from_secs(provider.timeout_secs.clamp(1, 30)));
    match discovery_headers(provider, schema) {
        Ok(Some(headers)) => {
            request = request.headers(headers);
        }
        Ok(None) => {}
        Err(()) => {
            return DiscoveryOutcome::NotAttempted;
        }
    }

    let response = match request.send().await {
        Ok(response) => response,
        Err(error) => {
            tracing::warn!(
                provider_id = %provider.id,
                adapter = %provider.adapter,
                url = %url,
                error = %error,
                "failed to discover provider model capabilities"
            );
            return DiscoveryOutcome::Failed;
        }
    };
    if !response.status().is_success() {
        tracing::warn!(
            provider_id = %provider.id,
            adapter = %provider.adapter,
            url = %url,
            status = %response.status(),
            "provider model capability discovery returned non-success status"
        );
        return DiscoveryOutcome::Failed;
    }

    let payload = match response.json::<serde_json::Value>().await {
        Ok(payload) => payload,
        Err(error) => {
            tracing::warn!(
                provider_id = %provider.id,
                adapter = %provider.adapter,
                url = %url,
                error = %error,
                "provider model capability discovery returned invalid json"
            );
            return DiscoveryOutcome::Failed;
        }
    };
    let parsed = parse_provider_model_capabilities(schema, &payload);
    if !parsed.keys().any(|model| wanted.contains(model)) {
        tracing::debug!(
            provider_id = %provider.id,
            adapter = %provider.adapter,
            "provider model capability discovery succeeded without wanted model metadata"
        );
    }
    DiscoveryOutcome::Discovered(parsed)
}

fn referenced_models_by_provider(
    providers: &[ProviderSpec],
    models: &[ModelSpec],
    pools: &[ModelPoolSpec],
) -> HashMap<String, HashSet<String>> {
    let schema_by_provider: HashMap<&str, &'static str> = providers
        .iter()
        .filter_map(|provider| {
            provider_discovery_schema(provider).map(|schema| (provider.id.as_str(), schema))
        })
        .collect();
    let models_by_id: HashMap<_, _> = models
        .iter()
        .map(|model| (model.id.as_str(), model))
        .collect();
    let mut out: HashMap<String, HashSet<String>> = HashMap::new();

    let consider = |model: &ModelSpec, out: &mut HashMap<String, HashSet<String>>| {
        let Some(schema) = schema_by_provider.get(model.provider_id.as_str()) else {
            return;
        };
        if needs_capability_discovery(model, schema) {
            out.entry(model.provider_id.clone())
                .or_default()
                .insert(normalize_capability_model_name(&model.upstream_model));
        }
    };

    for model in models {
        consider(model, &mut out);
    }
    for pool in pools {
        for member in &pool.members {
            let Some(model) = models_by_id.get(member.model_id.as_str()) else {
                continue;
            };
            consider(model, &mut out);
        }
    }

    out
}

/// Whether a model still has a capability field that *this provider's discovery
/// schema can fill*. Token limits are discoverable on every schema, but only the
/// OpenAI-compatible schema surfaces modalities and knowledge cutoff — so a
/// Gemini-backed model missing only those fields must not keep re-triggering a
/// probe on every publish (the probe could never fill them).
fn needs_capability_discovery(model: &ModelSpec, schema: &str) -> bool {
    let token_limits_missing = model.context_window.is_none() || model.max_output_tokens.is_none();
    let modalities_missing =
        model.modalities.input.is_empty() || model.modalities.output.is_empty();
    let cutoff_missing = model.knowledge_cutoff.is_none();
    match schema {
        "openai" => token_limits_missing || modalities_missing || cutoff_missing,
        "gemini" => token_limits_missing,
        _ => false,
    }
}

fn model_list_url(provider: &ProviderSpec) -> Option<reqwest::Url> {
    let base = provider
        .base_url
        .as_deref()
        .filter(|value| !value.trim().is_empty())
        .or_else(|| default_model_base_url(&provider.adapter))?;
    let trimmed = base.trim();
    if base_url_looks_like_inference_endpoint(trimmed) {
        tracing::warn!(
            provider_id = %provider.id,
            base_url = trimmed,
            "skipping provider model discovery because base_url is not an API root"
        );
        return None;
    }
    if trimmed.ends_with("/models") || trimmed.ends_with("/models/") {
        return reqwest::Url::parse(trimmed).ok();
    }
    let base = if trimmed.ends_with('/') {
        trimmed.to_owned()
    } else {
        format!("{trimmed}/")
    };
    reqwest::Url::parse(&base).ok()?.join("models").ok()
}

fn base_url_looks_like_inference_endpoint(value: &str) -> bool {
    let Ok(url) = reqwest::Url::parse(value) else {
        return false;
    };
    let path = url.path().trim_end_matches('/');
    path.ends_with("/chat/completions")
        || path.ends_with("/completions")
        || path.ends_with("/responses")
        || path.ends_with(":generateContent")
        || path.ends_with(":streamGenerateContent")
}

fn default_model_base_url(adapter: &str) -> Option<&'static str> {
    match adapter.to_ascii_lowercase().as_str() {
        "openai" => Some("https://api.openai.com/v1/"),
        "openrouter" => Some("https://openrouter.ai/api/v1/"),
        "gemini" | "google" => Some("https://generativelanguage.googleapis.com/v1beta/"),
        _ => None,
    }
}

/// Resolve the `/models` discovery schema for a provider, or `None` to skip
/// discovery entirely.
///
/// Built-in adapters map to their native schema. Any other adapter must opt in
/// explicitly via `adapter_options.model_discovery_schema` (`"openai"` /
/// `"openai-compatible"` or `"gemini"`) — so a custom OpenAI-compatible gateway
/// can be discovered while an unknown adapter is never silently trusted as
/// OpenAI metadata. The returned string is the `provider_source` passed to
/// [`parse_provider_model_capabilities`].
fn provider_discovery_schema(provider: &ProviderSpec) -> Option<&'static str> {
    if let Some(value) = provider.adapter_options.get("model_discovery_schema") {
        let Some(declared) = value.as_str() else {
            tracing::warn!(
                provider_id = %provider.id,
                "invalid non-string adapter_options.model_discovery_schema"
            );
            return None;
        };
        return match declared.to_ascii_lowercase().as_str() {
            "openai" | "openai-compatible" | "openrouter" => Some("openai"),
            "gemini" | "google" => Some("gemini"),
            other => {
                tracing::warn!(
                    provider_id = %provider.id,
                    model_discovery_schema = other,
                    "ignoring unknown adapter_options.model_discovery_schema"
                );
                None
            }
        };
    }
    match provider.adapter.to_ascii_lowercase().as_str() {
        "openai" | "openrouter" => Some("openai"),
        "gemini" | "google" => Some("gemini"),
        _ => None,
    }
}

fn should_skip_unauthenticated_default_endpoint(provider: &ProviderSpec) -> bool {
    if provider.base_url.is_some() || provider.api_key.is_some() {
        return false;
    }
    matches!(
        provider.adapter.to_ascii_lowercase().as_str(),
        "openai" | "gemini" | "google"
    )
}

fn provider_discovery_auth_scheme(provider: &ProviderSpec, schema: &str) -> DiscoveryAuthScheme {
    let default = DiscoveryAuthScheme::default_for_schema(schema);
    let Some(value) = provider.adapter_options.get("model_discovery_auth") else {
        return default;
    };
    let Some(declared) = value.as_str() else {
        tracing::warn!(
            provider_id = %provider.id,
            "invalid non-string adapter_options.model_discovery_auth; skipping discovery"
        );
        return DiscoveryAuthScheme::Invalid;
    };
    match declared.to_ascii_lowercase().as_str() {
        "bearer" | "authorization-bearer" => DiscoveryAuthScheme::Bearer,
        "x-goog-api-key" | "google-api-key" | "gemini-api-key" => DiscoveryAuthScheme::GoogleApiKey,
        "none" | "no-auth" | "disabled" => DiscoveryAuthScheme::None,
        other => {
            tracing::warn!(
                provider_id = %provider.id,
                model_discovery_auth = other,
                "invalid adapter_options.model_discovery_auth; skipping discovery"
            );
            DiscoveryAuthScheme::Invalid
        }
    }
}

fn discovery_headers(provider: &ProviderSpec, schema: &str) -> Result<Option<HeaderMap>, ()> {
    let mut headers = match build_default_headers_from_options(&provider.adapter_options) {
        Ok(Some(headers)) => strip_discovery_auth_headers(provider, headers),
        Ok(None) => HeaderMap::new(),
        Err(error) => {
            tracing::warn!(
                provider_id = %provider.id,
                error = %error,
                "invalid adapter_options.headers; skipping provider model capability discovery"
            );
            return Err(());
        }
    };

    if let Some(auth) = auth_headers(provider, schema)? {
        for (name, value) in &auth {
            headers.insert(name.clone(), value.clone());
        }
    }

    Ok((!headers.is_empty()).then_some(headers))
}

fn strip_discovery_auth_headers(provider: &ProviderSpec, headers: HeaderMap) -> HeaderMap {
    let mut safe = HeaderMap::new();
    for (name, value) in &headers {
        if is_discovery_auth_header(name) {
            tracing::warn!(
                provider_id = %provider.id,
                header = %name,
                "ignoring adapter_options.headers auth header for provider model capability discovery"
            );
            continue;
        }
        safe.insert(name.clone(), value.clone());
    }
    safe
}

fn is_discovery_auth_header(name: &HeaderName) -> bool {
    matches!(
        name.as_str().to_ascii_lowercase().as_str(),
        "authorization"
            | "proxy-authorization"
            | "cookie"
            | "x-goog-api-key"
            | "x-api-key"
            | "api-key"
            | "ocp-apim-subscription-key"
            | "x-auth-token"
    )
}

fn auth_headers(provider: &ProviderSpec, schema: &str) -> Result<Option<HeaderMap>, ()> {
    let scheme = provider_discovery_auth_scheme(provider, schema);
    if scheme == DiscoveryAuthScheme::None {
        return Ok(None);
    }
    if scheme == DiscoveryAuthScheme::Invalid {
        return Err(());
    }
    let Some(api_key) = provider
        .api_key
        .as_ref()
        .map(|key| key.expose_secret().trim())
        .filter(|key| !key.is_empty())
    else {
        return Ok(None);
    };
    let mut headers = HeaderMap::new();
    match scheme {
        DiscoveryAuthScheme::GoogleApiKey => {
            headers.insert(
                "x-goog-api-key",
                HeaderValue::from_str(api_key).map_err(|_| ())?,
            );
        }
        DiscoveryAuthScheme::Bearer => {
            headers.insert(
                AUTHORIZATION,
                HeaderValue::from_str(&format!("Bearer {api_key}")).map_err(|_| ())?,
            );
        }
        DiscoveryAuthScheme::None => return Ok(None),
        DiscoveryAuthScheme::Invalid => return Err(()),
    }
    Ok(Some(headers))
}

#[cfg(test)]
#[path = "provider_capability_discovery_tests.rs"]
mod tests;