blooio 0.3.0

//! Blocking executor backed by [`ureq`]. Pulls no async runtime.

use http::Method;
use http::header::AUTHORIZATION;

use crate::config::ClientConfig;
use crate::core::operation::Operation;
use crate::core::ratelimit::ResponseMeta;
use crate::core::request::RequestSpec;
use crate::core::response::parse_with;
use crate::error::{Error, Result};
use crate::secret::Secret;

/// Blocking Blooio API client.
///
/// A thin wrapper over a [`ureq::Agent`]; cloning shares the connection pool.
/// Resource accessors mirror those on the async [`Client`](crate::Client).
#[derive(Clone, Debug)]
pub struct BlockingClient {
    config: ClientConfig,
    agent: ureq::Agent,
    // Precomputed `Bearer <key>` header value. Built once (the key never
    // changes after construction) and kept in `Secret` so it stays redacted.
    auth_header: Secret<String>,
}

impl BlockingClient {
    /// Build a client from an API key using production defaults.
    pub fn new(api_key: impl Into<Secret<String>>) -> Result<Self> {
        Self::from_config(ClientConfig::new(api_key))
    }

    /// Build a client from a full [`ClientConfig`].
    pub fn from_config(config: ClientConfig) -> Result<Self> {
        let builder = ureq::Agent::config_builder()
            // We read non-2xx bodies ourselves to map them to `Error::Api`.
            .http_status_as_error(false)
            .user_agent(&config.user_agent)
            .timeout_global(Some(config.timeout));

        // When the native-tls backend is selected (and rustls is not), point
        // ureq at the native-tls provider explicitly.
        #[cfg(all(feature = "native-tls", not(feature = "rustls")))]
        let builder = builder.tls_config(
            ureq::tls::TlsConfig::builder()
                .provider(ureq::tls::TlsProvider::NativeTls)
                .build(),
        );

        let agent: ureq::Agent = builder.build().into();
        Ok(Self::from_config_and_agent(config, agent))
    }

    /// Build a client from configuration and a caller-provided [`ureq::Agent`].
    ///
    /// This lets applications reuse an existing connection pool, proxy setup,
    /// DNS resolver, and transport policy. The supplied agent is used as-is;
    /// values such as [`ClientConfig::timeout`] and
    /// [`ClientConfig::user_agent`] are not applied to it by this constructor.
    pub fn from_config_and_agent(config: ClientConfig, agent: ureq::Agent) -> Self {
        let auth_header = Secret::new(format!("Bearer {}", config.api_key.expose()));
        BlockingClient {
            config,
            agent,
            auth_header,
        }
    }

    /// The configuration this client was built with.
    pub fn config(&self) -> &ClientConfig {
        &self.config
    }

    fn apply<B>(
        &self,
        mut rb: ureq::RequestBuilder<B>,
        spec: &RequestSpec,
    ) -> ureq::RequestBuilder<B> {
        for (k, v) in &spec.query {
            rb = rb.query(*k, v);
        }
        // Key exposed only to set the header; never logged. The User-Agent is
        // configured on the agent at build time, not per-request.
        rb = rb.header(AUTHORIZATION.as_str(), self.auth_header.expose().as_str());
        for (k, v) in &spec.headers {
            rb = rb.header(*k, v);
        }
        rb
    }

    /// Execute an [`Operation`] and decode its response.
    ///
    /// The single blocking IO entry point; every resource method delegates
    /// here. Also the public escape hatch for uncovered operations.
    // Takes `op` by value to mirror the async `Client::send` signature; this
    // path only needs a borrow, but API symmetry across the two clients wins.
    #[allow(clippy::needless_pass_by_value)]
    pub fn send<O: Operation>(&self, op: O) -> Result<O::Output> {
        self.send_with_meta(op).map(|(out, _meta)| out)
    }

    /// Execute an [`Operation`] and decode its response, also returning the
    /// [`ResponseMeta`] (rate-limit headers and `Retry-After`) from the HTTP
    /// response. Use this when you want to self-pace against the API's limits.
    #[allow(clippy::needless_pass_by_value)]
    pub fn send_with_meta<O: Operation>(&self, op: O) -> Result<(O::Output, ResponseMeta)> {
        let mut spec = RequestSpec::build(&op)?;
        let retry = self.config.retry;
        // A retried mutating request must be idempotent.
        if retry.max_retries > 0 {
            spec.ensure_idempotency_key();
        }
        let url = self.config.url_for(&spec.path);

        let mut retries_done = 0u32;
        loop {
            match self.send_once::<O>(&spec, &url) {
                Ok(v) => return Ok(v),
                Err(e) if retry.should_retry(retries_done, &e) => {
                    let delay = retry.delay_for(retries_done, &e);
                    #[cfg(feature = "tracing")]
                    tracing::warn!(
                        attempt = retries_done + 1,
                        delay_ms = u64::try_from(delay.as_millis()).unwrap_or(u64::MAX),
                        code = ?e.code(),
                        "retrying request after transient failure"
                    );
                    std::thread::sleep(delay);
                    retries_done += 1;
                }
                Err(e) => return Err(e),
            }
        }
    }

    /// A single request attempt: build, send, and decode.
    fn send_once<O: Operation>(
        &self,
        spec: &RequestSpec,
        url: &str,
    ) -> Result<(O::Output, ResponseMeta)> {
        #[cfg(feature = "tracing")]
        let span = tracing::info_span!(
            "blooio.request",
            method = %spec.method,
            path = %spec.path,
            status = tracing::field::Empty,
            elapsed_ms = tracing::field::Empty,
        );
        #[cfg(feature = "tracing")]
        let _enter = span.enter();
        #[cfg(feature = "tracing")]
        let start = std::time::Instant::now();

        let result = match spec.method {
            Method::GET => self.apply(self.agent.get(url), spec).call(),
            Method::DELETE => self.apply(self.agent.delete(url), spec).call(),
            Method::POST => self.send_with_body(self.agent.post(url), spec),
            Method::PUT => self.send_with_body(self.agent.put(url), spec),
            Method::PATCH => self.send_with_body(self.agent.patch(url), spec),
            ref other => {
                return Err(Error::transport(format!("unsupported HTTP method {other}")));
            }
        };

        let mut resp = result.map_err(Error::transport)?;
        let status = resp.status().as_u16();
        let meta = ResponseMeta::from_headers(status, resp.headers());
        let bytes = resp.body_mut().read_to_vec().map_err(Error::transport)?;

        let parsed = parse_with(status, &bytes, meta.retry_after).map(|out| (out, meta));

        #[cfg(feature = "tracing")]
        {
            span.record("status", status);
            span.record(
                "elapsed_ms",
                u64::try_from(start.elapsed().as_millis()).unwrap_or(u64::MAX),
            );
            match &parsed {
                Ok(_) => tracing::debug!("request completed"),
                Err(e) => tracing::warn!(code = ?e.code(), "request failed"),
            }
        }

        parsed
    }

    fn send_with_body(
        &self,
        rb: ureq::RequestBuilder<ureq::typestate::WithBody>,
        spec: &RequestSpec,
    ) -> std::result::Result<http::Response<ureq::Body>, ureq::Error> {
        let rb = self.apply(rb, spec);
        match &spec.body {
            Some(body) => rb.content_type("application/json").send(body.as_slice()),
            None => rb.send_empty(),
        }
    }
}