systemprompt-models 0.55.0

//! Gateway routing patterns and stable route-id synthesis.
//!
//! A [`GatewayRoute`] maps an external `model_pattern` (exact, prefix `foo*`,
//! suffix `*foo`, or catch-all `*`) onto a provider in the registry. When a
//! route omits an explicit id, [`synthesize_route_id`] derives a stable one
//! from `(model_pattern, provider)` so `access_control_rules` can address the
//! route by a name that survives reordering. A model's connectivity is never
//! embedded here — [`GatewayRoute::resolve`] looks the provider up in the
//! registry at use time. A route may also name a `fallback_provider`: when
//! the primary upstream is unreachable or exhausts the transient-failure retry
//! budget, dispatch re-binds the same request to that provider (optionally
//! under `fallback_upstream_model`) — [`GatewayRoute::fallback_view`] is the
//! route as the fallback provider sees it.
//!
//! Copyright (c) systemprompt.io — Business Source License 1.1.
//! See <https://systemprompt.io> for licensing details.

use std::collections::HashMap;

use serde::{Deserialize, Serialize};
use systemprompt_identifiers::{ProviderId, RouteId};

use super::error::{GatewayProfileError, GatewayResult};
use super::route_id::{match_pattern, synthesize_route_id};
use crate::services::ai::ModelPricing;
use crate::services::providers::{ProviderEntry, ProviderRegistry};
use crate::wire::canonical::{CanonicalContent, CanonicalRequest, ReasoningEffort, ResponseFormat};

fn default_route_id() -> RouteId {
    RouteId::new("")
}

#[derive(Debug, Clone, Serialize, Deserialize, schemars::JsonSchema)]
#[serde(deny_unknown_fields)]
pub struct GatewayRoute {
    #[serde(default = "default_route_id")]
    pub id: RouteId,
    pub model_pattern: String,
    pub provider: ProviderId,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub upstream_model: Option<String>,
    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
    pub extra_headers: HashMap<String, String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pricing: Option<ModelPricing>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub when: Option<RouteMatch>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub requires: Option<RouteRequirements>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub fallback_provider: Option<ProviderId>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub fallback_upstream_model: Option<String>,
}

impl GatewayRoute {
    pub fn matches(&self, model: &str) -> bool {
        match_pattern(&self.model_pattern, model)
    }

    pub fn matches_request(&self, request: &CanonicalRequest) -> bool {
        self.matches(request.model.as_str())
            && self
                .when
                .as_ref()
                .is_none_or(|w| w.matches_request(request))
    }

    pub fn effective_upstream_model<'a>(&'a self, requested: &'a str) -> &'a str {
        self.upstream_model.as_deref().unwrap_or(requested)
    }

    pub fn ensure_id(&mut self) {
        if self.id.as_str().trim().is_empty() {
            self.id = synthesize_route_id(&self.model_pattern, self.provider.as_str());
        }
    }

    pub fn resolve<'a>(&self, registry: &'a ProviderRegistry) -> Option<&'a ProviderEntry> {
        registry.find_provider(self.provider.as_str())
    }

    #[must_use]
    pub fn fallback_view(&self) -> Option<Self> {
        let fallback = self.fallback_provider.clone()?;
        Some(Self {
            provider: fallback,
            upstream_model: self.fallback_upstream_model.clone(),
            pricing: None,
            fallback_provider: None,
            fallback_upstream_model: None,
            ..self.clone()
        })
    }
}

/// Request-shape predicates a route can require beyond the model glob.
///
/// Every field is optional; an absent predicate is a wildcard, so an empty
/// block matches all requests. The trustworthy discriminators in real agent
/// loops are `thinking` / `min_reasoning_effort` / `stream` and the model name
/// itself — the full tool catalogue is typically resent on every step, so
/// `requires_tools` / `min_tools` are weak signals retained for completeness.
#[derive(Debug, Clone, Copy, Default, Serialize, Deserialize, schemars::JsonSchema)]
#[serde(deny_unknown_fields)]
pub struct RouteMatch {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub requires_tools: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub min_tools: Option<usize>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub thinking: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub min_reasoning_effort: Option<ReasoningEffort>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub stream: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub min_input_tokens: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub response_format: Option<ResponseFormatKind>,
}

impl RouteMatch {
    #[must_use]
    pub fn matches_request(&self, request: &CanonicalRequest) -> bool {
        self.requires_tools
            .is_none_or(|want| request.tools.is_empty() != want)
            && self.min_tools.is_none_or(|n| request.tools.len() >= n)
            && self
                .thinking
                .is_none_or(|want| request.thinking.is_some_and(|t| t.enabled) == want)
            && self
                .min_reasoning_effort
                .is_none_or(|floor| request.reasoning_effort.is_some_and(|e| e >= floor))
            && self.stream.is_none_or(|want| request.stream == want)
            && self
                .min_input_tokens
                .is_none_or(|n| estimate_input_tokens(request) >= n)
            && self.response_format.is_none_or(|want| {
                ResponseFormatKind::from(request.response_format.as_ref()) == want
            })
    }

    #[must_use]
    pub fn matched_predicates(&self) -> Vec<&'static str> {
        let mut out = Vec::new();
        if self.requires_tools.is_some() {
            out.push("requires_tools");
        }
        if self.min_tools.is_some() {
            out.push("min_tools");
        }
        if self.thinking.is_some() {
            out.push("thinking");
        }
        if self.min_reasoning_effort.is_some() {
            out.push("min_reasoning_effort");
        }
        if self.stream.is_some() {
            out.push("stream");
        }
        if self.min_input_tokens.is_some() {
            out.push("min_input_tokens");
        }
        if self.response_format.is_some() {
            out.push("response_format");
        }
        out
    }

    pub const fn validate(&self) -> GatewayResult<()> {
        if matches!(self.min_tools, Some(0)) {
            return Err(GatewayProfileError::RouteMatchZeroMinTools);
        }
        if let (Some(false), Some(n)) = (self.requires_tools, self.min_tools)
            && n >= 1
        {
            return Err(GatewayProfileError::RouteMatchContradictoryTools);
        }
        Ok(())
    }
}

/// Governance demands a route places on its *target*, not on the request.
///
/// `european: true` restricts the route to providers/models whose effective
/// [`ModelGovernance`](crate::services::ai::ModelGovernance) declares
/// `european`, and `no_retain: true` likewise. Checked at boot for every model
/// the route can reach, and re-checked at dispatch so a selector-refined route
/// or unlisted model cannot bypass it.
#[derive(Debug, Clone, Copy, Default, Serialize, Deserialize, schemars::JsonSchema)]
#[serde(deny_unknown_fields)]
pub struct RouteRequirements {
    #[serde(default)]
    pub european: bool,
    #[serde(default)]
    pub no_retain: bool,
}

impl RouteRequirements {
    #[must_use]
    pub fn unmet(&self, governance: crate::services::ai::ModelGovernance) -> Vec<&'static str> {
        let mut out = Vec::new();
        if self.european && !governance.european {
            out.push("european");
        }
        if self.no_retain && !governance.no_retain {
            out.push("no_retain");
        }
        out
    }

    #[must_use]
    pub fn declared(&self) -> Vec<&'static str> {
        let mut out = Vec::new();
        if self.european {
            out.push("european");
        }
        if self.no_retain {
            out.push("no_retain");
        }
        out
    }
}

/// Profile-side, serializable mirror of the wire [`ResponseFormat`], with an
/// explicit `Text` variant standing in for the wire type's absence (`None`).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, schemars::JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ResponseFormatKind {
    Text,
    JsonObject,
    JsonSchema,
}

impl From<Option<&ResponseFormat>> for ResponseFormatKind {
    fn from(value: Option<&ResponseFormat>) -> Self {
        match value {
            None => Self::Text,
            Some(ResponseFormat::JsonObject) => Self::JsonObject,
            Some(ResponseFormat::JsonSchema { .. }) => Self::JsonSchema,
        }
    }
}

fn estimate_input_tokens(request: &CanonicalRequest) -> u32 {
    let mut chars = request
        .system
        .iter()
        .map(|block| block.text.len())
        .sum::<usize>();
    for message in &request.messages {
        for part in &message.content {
            accumulate_text_len(part, &mut chars);
        }
    }
    u32::try_from(chars / 4 + 1).unwrap_or(u32::MAX)
}

fn accumulate_text_len(part: &CanonicalContent, acc: &mut usize) {
    match part {
        CanonicalContent::Text { text, .. } | CanonicalContent::Thinking { text, .. } => {
            *acc += text.len();
        },
        CanonicalContent::ToolResult { content, .. } => {
            for inner in content {
                accumulate_text_len(inner, acc);
            }
        },
        CanonicalContent::ToolUse { .. } | CanonicalContent::Image { .. } => {},
    }
}