botrs 0.12.0

//! OpenAPI extension points used to register custom client versions and filters.

#![allow(non_snake_case)]

use std::collections::HashSet;
use std::sync::{Arc, LazyLock, RwLock};

use reqwest::{Method, StatusCode, header::HeaderMap};

pub use crate::api::{APIVersion, APIVersionString, APIv1};
pub use crate::facade::{DefaultOpenAPIVersion, VersionMapping};

pub type OpenAPI = crate::api::BotApi;
pub type Base = OpenAPI;
pub type WebsocketAPI = OpenAPI;
pub type UserAPI = OpenAPI;
pub type MessageAPI = OpenAPI;
pub type DirectMessageAPI = OpenAPI;
pub type GuildAPI = OpenAPI;
pub type ChannelAPI = OpenAPI;
pub type AudioAPI = OpenAPI;
pub type RoleAPI = OpenAPI;
pub type MemberAPI = OpenAPI;
pub type ChannelPermissionsAPI = OpenAPI;
pub type AnnouncesAPI = OpenAPI;
pub type ScheduleAPI = OpenAPI;
pub type APIPermissionsAPI = OpenAPI;
pub type PinsAPI = OpenAPI;
pub type MessageReactionAPI = OpenAPI;
pub type WebhookAPI = OpenAPI;
pub type InteractionAPI = OpenAPI;
pub type MessageSettingAPI = OpenAPI;

pub fn Register(version: APIVersion, api: OpenAPI) {
    crate::facade::SetOpenAPIClient(version, api);
}

pub fn DefaultImpl() -> OpenAPI {
    crate::facade::DefaultImpl()
}

pub fn IsSuccessStatus(code: u16) -> bool {
    matches!(code, 200 | 204)
}

/// Request/response view passed to OpenAPI filters.
#[derive(Debug, Clone, Default)]
pub struct FilterContext {
    pub method: Option<Method>,
    pub url: Option<String>,
    pub request_headers: HeaderMap,
    pub response_status: Option<StatusCode>,
    pub response_headers: HeaderMap,
}

impl FilterContext {
    pub fn new(request_headers: HeaderMap, response_headers: HeaderMap) -> Self {
        Self {
            method: None,
            url: None,
            request_headers,
            response_status: None,
            response_headers,
        }
    }

    pub fn request(method: Method, url: impl Into<String>, request_headers: HeaderMap) -> Self {
        Self {
            method: Some(method),
            url: Some(url.into()),
            request_headers,
            response_status: None,
            response_headers: HeaderMap::new(),
        }
    }

    pub fn response(
        method: Method,
        url: impl Into<String>,
        request_headers: HeaderMap,
        response_status: StatusCode,
        response_headers: HeaderMap,
    ) -> Self {
        Self {
            method: Some(method),
            url: Some(url.into()),
            request_headers,
            response_status: Some(response_status),
            response_headers,
        }
    }
}

/// HTTP filter callback used by request and response interception chains.
pub type HTTPFilter = Arc<dyn Fn(&mut FilterContext) -> crate::Result<()> + Send + Sync + 'static>;

#[derive(Default)]
struct FilterChain {
    seen: HashSet<String>,
    filters: Vec<HTTPFilter>,
}

impl FilterChain {
    fn register(&mut self, name: impl Into<String>, filter: HTTPFilter) {
        let name = name.into();
        if self.seen.insert(name) {
            self.filters.push(filter);
        }
    }

    fn snapshot(&self) -> Vec<HTTPFilter> {
        self.filters.clone()
    }
}

fn run_filters(filters: Vec<HTTPFilter>, context: &mut FilterContext) -> crate::Result<()> {
    for filter in filters {
        filter(context)?;
    }
    Ok(())
}

static REQ_FILTERS: LazyLock<RwLock<FilterChain>> =
    LazyLock::new(|| RwLock::new(FilterChain::default()));
static RESP_FILTERS: LazyLock<RwLock<FilterChain>> =
    LazyLock::new(|| RwLock::new(FilterChain::default()));

pub fn RegisterReqFilter(
    name: impl Into<String>,
    filter: impl Fn(&mut FilterContext) -> crate::Result<()> + Send + Sync + 'static,
) {
    if let Ok(mut filters) = REQ_FILTERS.write() {
        filters.register(name, Arc::new(filter));
    }
}

pub fn RegisterRespFilter(
    name: impl Into<String>,
    filter: impl Fn(&mut FilterContext) -> crate::Result<()> + Send + Sync + 'static,
) {
    if let Ok(mut filters) = RESP_FILTERS.write() {
        filters.register(name, Arc::new(filter));
    }
}

pub fn DoReqFilterChains(context: &mut FilterContext) -> crate::Result<()> {
    let filters = REQ_FILTERS
        .read()
        .map_err(|_| crate::BotError::internal("request filter chain lock poisoned"))?
        .snapshot();
    run_filters(filters, context)
}

pub fn DoRespFilterChains(context: &mut FilterContext) -> crate::Result<()> {
    let filters = RESP_FILTERS
        .read()
        .map_err(|_| crate::BotError::internal("response filter chain lock poisoned"))?
        .snapshot();
    run_filters(filters, context)
}

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

    #[test]
    fn success_status_matches_official_codes() {
        assert!(IsSuccessStatus(200));
        assert!(IsSuccessStatus(204));
        assert!(!IsSuccessStatus(201));
        assert!(!IsSuccessStatus(202));
        assert!(!IsSuccessStatus(400));
    }

    #[test]
    fn openapi_registry_facade_dispatches_by_version() {
        let custom_version = 777;
        let template = crate::api::BotApi::new(
            crate::http::HttpClient::new(11, false).expect("valid test client"),
        );

        Register(custom_version, template);

        assert_eq!(
            VersionMapping
                .read()
                .expect("openapi registry lock poisoned")
                .get(&custom_version)
                .expect("registered custom openapi")
                .http()
                .timeout(),
            std::time::Duration::from_secs(11)
        );
        assert_eq!(DefaultImpl().Version(), crate::api::APIv1);
    }

    #[test]
    fn filters_run_in_registration_order_and_skip_duplicate_names() {
        RegisterReqFilter("test-order-a", |context| {
            context
                .request_headers
                .insert("x-filter-order", HeaderValue::from_static("a"));
            Ok(())
        });
        RegisterReqFilter("test-order-b", |context| {
            let value = context
                .request_headers
                .get("x-filter-order")
                .and_then(|value| value.to_str().ok())
                .unwrap_or_default()
                .to_string()
                + "b";
            context.request_headers.insert(
                "x-filter-order",
                HeaderValue::from_str(&value).expect("valid header value"),
            );
            Ok(())
        });
        RegisterReqFilter("test-order-b", |_| {
            panic!("duplicate filter should be ignored")
        });

        let mut context = FilterContext::default();
        DoReqFilterChains(&mut context).unwrap();
        assert_eq!(
            context
                .request_headers
                .get("x-filter-order")
                .and_then(|value| value.to_str().ok()),
            Some("ab")
        );
    }
}