botrs 0.12.0

A Rust QQ Bot framework based on QQ Guild Bot API
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

//! Top-level facade providing Go-style entry points for the QQ Bot Open API.
//!
//! These functions mirror the public surface of the official Go SDK so that
//! consumers used to that style can continue using the same names. The
//! framework itself is independent — these are simply convenience wrappers
//! around [`crate::api::BotApi`] and friends.

#![allow(non_snake_case, non_upper_case_globals)]

use std::collections::HashMap;
use std::sync::{LazyLock, RwLock};

use crate::api::{APIVersion, APIv1, BotApi};
use crate::error::{Result, err_not_found_openapi};
use crate::event::EventParseFunc;
use crate::http::HttpClient;
use crate::models::gateway::{EventType, OpCode, WSDispatchEvent};
use crate::session_manager::SessionManager;
use crate::token::Token;

pub static DefaultOpenAPIVersion: LazyLock<RwLock<APIVersion>> =
    LazyLock::new(|| RwLock::new(APIv1));

pub static VersionMapping: LazyLock<RwLock<HashMap<APIVersion, BotApi>>> =
    LazyLock::new(|| RwLock::new(HashMap::from([(APIv1, default_openapi_template())])));

fn default_openapi_template() -> BotApi {
    BotApi::new(HttpClient::new(crate::DEFAULT_TIMEOUT, false).expect("valid default api client"))
}

pub fn DefaultImpl() -> BotApi {
    let version = *DefaultOpenAPIVersion
        .read()
        .expect("openapi version lock poisoned");
    VersionMapping
        .read()
        .expect("openapi version mapping lock poisoned")
        .get(&version)
        .cloned()
        .unwrap_or_else(default_openapi_template)
}

pub fn SelectOpenAPIVersion(version: APIVersion) -> Result<()> {
    if VersionMapping
        .read()
        .expect("openapi version mapping lock poisoned")
        .contains_key(&version)
    {
        *DefaultOpenAPIVersion
            .write()
            .expect("openapi version lock poisoned") = version;
        Ok(())
    } else {
        Err(err_not_found_openapi().into())
    }
}

pub fn NewOpenAPI(app_id: impl Into<String>, token: Token) -> BotApi {
    new_openapi(app_id, token, false)
}

pub fn NewSandboxOpenAPI(app_id: impl Into<String>, token: Token) -> BotApi {
    new_openapi(app_id, token, true)
}

fn new_openapi(app_id: impl Into<String>, token: Token, in_sandbox: bool) -> BotApi {
    let version = *DefaultOpenAPIVersion
        .read()
        .expect("openapi version lock poisoned");
    let template = VersionMapping
        .read()
        .expect("openapi version mapping lock poisoned")
        .get(&version)
        .cloned()
        .unwrap_or_else(default_openapi_template);
    template
        .setup_from_template(app_id, token, in_sandbox)
        .expect("valid registered api template")
}

pub fn SetLogger(logger: impl crate::log::Logger + 'static) {
    crate::log::set_logger(logger);
}

pub fn SetSessionManager(manager: impl SessionManager + Clone + 'static) {
    crate::session_manager::SetSessionManager(manager);
}

pub fn SetWebsocketClient(client: impl crate::websocket::WebSocket + Clone + 'static) {
    crate::websocket::Register(client);
}

pub fn SetOpenAPIClient(version: APIVersion, client: BotApi) {
    VersionMapping
        .write()
        .expect("openapi version mapping lock poisoned")
        .insert(version, client);
}

pub fn RegisterDispatchEventHandler(event_type: impl Into<EventType>, handler: EventParseFunc) {
    crate::event::RegisterHandler(WSDispatchEvent as OpCode, event_type, handler);
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::sync::{LazyLock, Mutex};

    static OPENAPI_REGISTRY_TEST_LOCK: LazyLock<Mutex<()>> = LazyLock::new(|| Mutex::new(()));

    #[test]
    fn select_openapi_version_accepts_v1_only() {
        let _guard = OPENAPI_REGISTRY_TEST_LOCK.lock().unwrap();
        assert!(SelectOpenAPIVersion(APIv1).is_ok());
        assert!(SelectOpenAPIVersion(99).is_err());
    }

    #[test]
    fn new_openapi_uses_requested_environment() {
        let _guard = OPENAPI_REGISTRY_TEST_LOCK.lock().unwrap();
        SelectOpenAPIVersion(APIv1).unwrap();

        let token = Token::new("app", "secret");
        let api = NewSandboxOpenAPI("app", token);
        assert_eq!(api.Version(), APIv1);
        assert_eq!(api.GetAppID(), "app");
        assert!(api.token().is_some());
    }

    #[test]
    fn openapi_client_registry_controls_version_selection() {
        let _guard = OPENAPI_REGISTRY_TEST_LOCK.lock().unwrap();
        let custom_version = 42;
        let template = BotApi::new(HttpClient::new(9, false).unwrap()).SetDebug(true);
        SetOpenAPIClient(custom_version, template);
        SelectOpenAPIVersion(custom_version).unwrap();

        let api = NewSandboxOpenAPI("app", Token::new("app", "secret"));
        assert_eq!(api.http().timeout(), std::time::Duration::from_secs(9));
        assert!(api.http().is_sandbox());
        assert!(api.http().debug_enabled());

        SelectOpenAPIVersion(APIv1).unwrap();
    }
}