kellnr-settings 6.9.0

use provcfg::{ClapArgs, Configurable};
use serde::{Deserialize, Serialize};
use url::Url;

fn default_proxy_url() -> Url {
    Url::parse("https://static.crates.io/crates/").unwrap()
}

fn default_index_url() -> Url {
    Url::parse("https://index.crates.io/").unwrap()
}

fn default_api_url() -> Url {
    Url::parse("https://crates.io/api/v1/crates/").unwrap()
}

fn default_user_agent() -> String {
    kellnr_common::cratesio_downloader::DEFAULT_USER_AGENT.to_string()
}

#[derive(Debug, Deserialize, Serialize, Eq, PartialEq, Clone, Configurable, ClapArgs)]
#[serde(default)]
#[configurable(clap_prefix = "proxy")]
pub struct Proxy {
    /// Enable crates.io proxy
    pub enabled: bool,

    /// Number of proxy threads
    pub num_threads: usize,

    /// Download crates on index update
    pub download_on_update: bool,

    /// Crates.io download URL
    pub url: Url,

    /// Crates.io index URL
    pub index: Url,

    /// Crates.io API URL
    pub api: Url,

    /// Connect timeout in seconds for upstream requests
    #[arg(long = "proxy-connect-timeout")]
    pub connect_timeout_seconds: u64,

    /// Request timeout in seconds for upstream downloads
    #[arg(long = "proxy-request-timeout")]
    pub request_timeout_seconds: u64,

    /// User-agent sent with requests to crates.io. crates.io's data-access
    /// policy asks for a user-agent that identifies the application and a way
    /// to get in contact, e.g. "kellnr.io/kellnr (contact@example.com)".
    #[arg(long = "proxy-user-agent")]
    pub user_agent: String,
}

impl Default for Proxy {
    fn default() -> Self {
        Self {
            enabled: false,
            num_threads: 10,
            download_on_update: false,
            url: default_proxy_url(),
            index: default_index_url(),
            api: default_api_url(),
            connect_timeout_seconds: 5,
            request_timeout_seconds: 30,
            user_agent: default_user_agent(),
        }
    }
}

impl Proxy {
    /// The upstream sparse-index URL that internal cargo invocations (e.g. the
    /// docs builder) should resolve crates.io dependencies from, if it differs
    /// from the built-in crates.io default.
    ///
    /// Returns `None` when the proxy is disabled or the default index is in
    /// use. In both cases cargo's own default (`index.crates.io`) is correct
    /// and source replacement would be redundant. When `Some`, callers should
    /// point cargo's `crates-io` source at this URL so dependency resolution
    /// honors `proxy.index` instead of hitting crates.io directly. See #1185.
    pub fn cratesio_index_override(&self) -> Option<&Url> {
        if self.enabled && self.index != default_index_url() {
            Some(&self.index)
        } else {
            None
        }
    }
}

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

    #[test]
    fn default_api_url_is_cratesio() {
        let proxy = Proxy::default();
        assert_eq!(
            proxy.api,
            Url::parse("https://crates.io/api/v1/crates/").unwrap()
        );
    }

    #[test]
    fn deserialize_custom_api_url_from_toml() {
        let toml = r#"
            api = "https://rsproxy.cn/api/v1/crates/"
        "#;
        let proxy: Proxy = toml::from_str(toml).unwrap();
        assert_eq!(
            proxy.api,
            Url::parse("https://rsproxy.cn/api/v1/crates/").unwrap()
        );
    }

    #[test]
    fn missing_api_url_uses_default() {
        let toml = r#"
            enabled = true
            url = "https://rsproxy.cn/api/v1/crates/"
            index = "https://rsproxy.cn/index/"
        "#;
        let proxy: Proxy = toml::from_str(toml).unwrap();
        assert_eq!(
            proxy.api,
            Url::parse("https://crates.io/api/v1/crates/").unwrap()
        );
    }

    #[test]
    fn api_url_join_produces_correct_crate_url() {
        let proxy: Proxy = toml::from_str(r#"api = "https://rsproxy.cn/api/v1/crates/""#).unwrap();
        let url = proxy.api.join("serde").unwrap();
        assert_eq!(url.as_str(), "https://rsproxy.cn/api/v1/crates/serde");
    }

    #[test]
    fn default_url_join_produces_correct_crate_url() {
        let proxy = Proxy::default();
        let url = proxy.api.join("tokio").unwrap();
        assert_eq!(url.as_str(), "https://crates.io/api/v1/crates/tokio");
    }

    #[test]
    fn default_user_agent_is_kellnr() {
        let proxy = Proxy::default();
        assert_eq!(proxy.user_agent, "kellnr.io/kellnr");
    }

    #[test]
    fn missing_user_agent_uses_default() {
        let proxy: Proxy = toml::from_str("enabled = true").unwrap();
        assert_eq!(proxy.user_agent, "kellnr.io/kellnr");
    }

    #[test]
    fn deserialize_custom_user_agent_from_toml() {
        let toml = r#"user_agent = "kellnr.io/kellnr (admin@example.com)""#;
        let proxy: Proxy = toml::from_str(toml).unwrap();
        assert_eq!(proxy.user_agent, "kellnr.io/kellnr (admin@example.com)");
    }

    #[test]
    fn index_override_none_when_disabled() {
        let proxy: Proxy = toml::from_str(r#"index = "https://rsproxy.cn/index/""#).unwrap();
        assert!(!proxy.enabled);
        assert_eq!(proxy.cratesio_index_override(), None);
    }

    #[test]
    fn index_override_none_when_default_index() {
        let proxy: Proxy = toml::from_str("enabled = true").unwrap();
        assert_eq!(proxy.cratesio_index_override(), None);
    }

    #[test]
    fn index_override_some_when_enabled_and_custom() {
        let toml = r#"
            enabled = true
            index = "https://rsproxy.cn/index/"
        "#;
        let proxy: Proxy = toml::from_str(toml).unwrap();
        assert_eq!(
            proxy.cratesio_index_override().map(Url::as_str),
            Some("https://rsproxy.cn/index/")
        );
    }
}