wecom-aibot-rust-sdk 1.0.2

企业微信智能机器人 Rust SDK —— 基于 WebSocket 长连接通道,提供消息收发、流式回复、模板卡片、事件回调、文件下载解密等核心能力
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
/// WebSocket 长连接管理器
///
/// 对标 Node.js SDK src/ws.ts
/// 负责维护与企业微信的 WebSocket 长连接,包括心跳、重连、认证、串行回复队列等。

use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;
use std::time::Duration;

use futures::{SinkExt, StreamExt};
use serde_json::json;
use tokio::sync::Mutex;
use tokio::net::TcpStream;
use tokio::sync::mpsc;
use tokio::time;
use tokio_tungstenite::tungstenite::client::IntoClientRequest;
use tokio_tungstenite::tungstenite::Message;
use tokio_tungstenite::{connect_async_tls_with_config, WebSocketStream};
use tokio_tungstenite::MaybeTlsStream;

use crate::types::{Logger, SdkError, WsCmd, WsFrame, WsFrameHeaders, WSClientOptions};
use crate::utils::generate_req_id;

/// SDK 内置默认 WebSocket 连接地址
const DEFAULT_WS_URL: &str = "wss://openws.work.weixin.qq.com";

/// WebSocket 连接状态
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[allow(dead_code)]
enum ConnectionState {
    Disconnected,
    Connecting,
    Connected,
    Authenticated,
}

/// WebSocket 长连接管理器
///
/// 负责维护与企业微信的 WebSocket 长连接,包括心跳、重连、认证等。
pub struct WsConnectionManager {
    logger: Arc<dyn Logger>,
    options: WSClientOptions,

    // 连接状态
    state: Arc<Mutex<ConnectionState>>,
    reconnect_attempts: Arc<AtomicUsize>,
    is_manual_close: Arc<Mutex<bool>>,

    // WebSocket 连接
    ws_tx: Arc<Mutex<Option<mpsc::UnboundedSender<Message>>>>,

    // 心跳相关
    missed_pong_count: Arc<AtomicUsize>,
    max_missed_pong: usize,

    // 事件通道
    event_tx: mpsc::UnboundedSender<WsFrame>,
    event_rx: Arc<Mutex<Option<mpsc::UnboundedReceiver<WsFrame>>>>,
}

impl WsConnectionManager {
    /// 创建新的 WebSocket 连接管理器
    pub fn new(options: WSClientOptions, logger: Arc<dyn Logger>) -> Self {
        let (event_tx, event_rx) = mpsc::unbounded_channel::<WsFrame>();

        Self {
            logger,
            options: options.clone(),
            state: Arc::new(Mutex::new(ConnectionState::Disconnected)),
            reconnect_attempts: Arc::new(AtomicUsize::new(0)),
            is_manual_close: Arc::new(Mutex::new(false)),
            ws_tx: Arc::new(Mutex::new(None)),
            missed_pong_count: Arc::new(AtomicUsize::new(0)),
            max_missed_pong: 2,
            event_tx,
            event_rx: Arc::new(Mutex::new(Some(event_rx))),
        }
    }

    /// 获取事件接收器
    pub async fn get_event_receiver(&self) -> mpsc::UnboundedReceiver<WsFrame> {
        self.event_rx.lock().await.take().expect("Event receiver already taken")
    }

    /// 建立 WebSocket 连接
    pub async fn connect(&self) -> Result<(), SdkError> {
        *self.is_manual_close.lock().await = false;

        let ws_url = self.options.ws_url.as_deref().unwrap_or(DEFAULT_WS_URL);
        self.logger.info(&format!("Connecting to WebSocket: {}...", ws_url));

        match self._connect_impl(ws_url).await {
            Ok(_) => {
                self.logger.info("WebSocket connection established");
                Ok(())
            }
            Err(e) => {
                self.logger.error(&format!("Failed to create WebSocket connection: {}", e));
                Err(e)
            }
        }
    }

    async fn _connect_impl(&self, ws_url: &str) -> Result<(), SdkError> {
        let mut request = ws_url.into_client_request()?;
        request.headers_mut().insert(
            "Sec-WebSocket-Protocol",
            "aibot".parse().unwrap(),
        );

        let (ws_stream, _) = connect_async_tls_with_config(
            request,
            None,
            false,
            None,
        ).await?;

        let (ws_write, mut ws_read) = ws_stream.split();
        let (msg_tx, mut msg_rx) = mpsc::unbounded_channel::<Message>();

        *self.ws_tx.lock().await = Some(msg_tx);
        *self.state.lock().await = ConnectionState::Connected;
        self.reconnect_attempts.store(0, Ordering::SeqCst);
        self.missed_pong_count.store(0, Ordering::SeqCst);

        // 发送认证帧
        let auth_frame = WsFrame {
            cmd: Some(WsCmd::SUBSCRIBE.to_string()),
            headers: WsFrameHeaders::new(generate_req_id(WsCmd::SUBSCRIBE)),
            body: Some(json!({
                "bot_id": self.options.bot_id,
                "secret": self.options.secret
            })),
            errcode: None,
            errmsg: None,
        };
        let auth_msg = Message::Text(serde_json::to_string(&auth_frame)?);

        // 使用 msg_tx 发送认证帧
        if let Some(tx) = self.ws_tx.lock().await.as_ref() {
            let _ = tx.send(auth_msg);
        }

        // 启动消息处理循环
        let state_clone = self.state.clone();
        let logger_clone = self.logger.clone();
        let missed_pong_clone = self.missed_pong_count.clone();
        let max_missed_pong = self.max_missed_pong;
        let heartbeat_interval = self.options.heartbeat_interval;
        let event_tx = self.event_tx.clone();

        tokio::spawn(async move {
            Self::_receive_loop(
                &mut ws_read,
                ws_write,
                &mut msg_rx,
                &state_clone,
                &logger_clone,
                &missed_pong_clone,
                max_missed_pong,
                heartbeat_interval,
                &event_tx,
            ).await;
        });

        self.logger.info("Auth frame sent");
        Ok(())
    }

    async fn _receive_loop(
        ws_read: &mut futures::stream::SplitStream<WebSocketStream<MaybeTlsStream<TcpStream>>>,
        mut ws_write: futures::stream::SplitSink<WebSocketStream<MaybeTlsStream<TcpStream>>, Message>,
        msg_rx: &mut mpsc::UnboundedReceiver<Message>,
        state: &Arc<Mutex<ConnectionState>>,
        logger: &Arc<dyn Logger>,
        missed_pong_count: &Arc<AtomicUsize>,
        max_missed_pong: usize,
        heartbeat_interval: u64,
        event_tx: &mpsc::UnboundedSender<WsFrame>,
    ) {
        let mut heartbeat_interval = time::interval(Duration::from_millis(heartbeat_interval));

        loop {
            tokio::select! {
                Some(msg_result) = ws_read.next() => {
                    match msg_result {
                        Ok(msg) => {
                            if let Message::Text(text) = msg {
                                logger.debug(&format!("Received raw WebSocket message: {}", text));
                                if let Ok(frame) = serde_json::from_str::<WsFrame>(&text) {
                                    Self::_handle_frame(
                                        &frame,
                                        state,
                                        logger,
                                        missed_pong_count,
                                        event_tx,
                                    ).await;
                                }
                            }
                        }
                        Err(e) => {
                            logger.error(&format!("WebSocket error: {}", e));
                            break;
                        }
                    }
                }
                Some(msg) = msg_rx.recv() => {
                    // 通过 WebSocket 实际发送消息
                    if ws_write.send(msg).await.is_err() {
                        logger.error("Failed to send message via WebSocket");
                        break;
                    }
                }
                _ = heartbeat_interval.tick() => {
                    // 心跳逻辑
                    let count = missed_pong_count.fetch_add(1, Ordering::SeqCst) + 1;
                    if count >= max_missed_pong {
                        logger.warn(&format!("No heartbeat ack received for {} consecutive pings, connection considered dead", count));
                        break;
                    }

                    let heartbeat_frame = WsFrame {
                        cmd: Some(WsCmd::HEARTBEAT.to_string()),
                        headers: WsFrameHeaders::new(generate_req_id(WsCmd::HEARTBEAT)),
                        body: None,
                        errcode: None,
                        errmsg: None,
                    };

                    if ws_write.send(Message::Text(serde_json::to_string(&heartbeat_frame).unwrap_or_default())).await.is_err() {
                        logger.error("Failed to send heartbeat via WebSocket");
                        break;
                    }
                }
            }
        }
    }

    async fn _send_auth<W>(&self, ws_write: &mut W) -> Result<(), SdkError>
    where
        W: SinkExt<Message> + Unpin,
        W::Error: std::fmt::Display,
    {
        let auth_frame = WsFrame {
            cmd: Some(WsCmd::SUBSCRIBE.to_string()),
            headers: WsFrameHeaders::new(generate_req_id(WsCmd::SUBSCRIBE)),
            body: Some(json!({
                "bot_id": self.options.bot_id,
                "secret": self.options.secret
            })),
            errcode: None,
            errmsg: None,
        };

        let msg = Message::Text(serde_json::to_string(&auth_frame)?);
        ws_write.send(msg).await.map_err(|e| {
            SdkError::WebSocket(format!("Failed to send auth frame: {}", e))
        })?;

        self.logger.info("Auth frame sent");
        Ok(())
    }

    async fn _handle_frame(
        frame: &WsFrame,
        state: &Arc<Mutex<ConnectionState>>,
        logger: &Arc<dyn Logger>,
        missed_pong_count: &Arc<AtomicUsize>,
        event_tx: &mpsc::UnboundedSender<WsFrame>,
    ) {
        let cmd = frame.cmd.as_deref();
        let req_id = frame.headers.req_id.as_str();

        // 消息推送回调 - 转发到事件通道
        if cmd == Some(WsCmd::CALLBACK) || cmd == Some(WsCmd::EVENT_CALLBACK) {
            logger.debug(&format!("Received push message: {:?}, req_id={}", frame.body, req_id));
            let _ = event_tx.send(frame.clone());
            return;
        }

        if req_id.starts_with(WsCmd::SUBSCRIBE) {
            // 认证响应
            let errcode = frame.errcode.unwrap_or(-1);
            if errcode != 0 {
                logger.error(&format!(
                    "Authentication failed: errcode={}, errmsg={}",
                    errcode,
                    frame.errmsg.as_deref().unwrap_or("unknown")
                ));
                return;
            }
            logger.info("Authentication successful");
            *state.lock().await = ConnectionState::Authenticated;
            missed_pong_count.store(0, Ordering::SeqCst);
            return;
        }

        if req_id.starts_with(WsCmd::HEARTBEAT) {
            // 心跳响应
            let errcode = frame.errcode.unwrap_or(-1);
            if errcode != 0 {
                logger.warn(&format!(
                    "Heartbeat ack error: errcode={}, errmsg={}",
                    errcode,
                    frame.errmsg.as_deref().unwrap_or("unknown")
                ));
                return;
            }
            missed_pong_count.store(0, Ordering::SeqCst);
            logger.debug("Received heartbeat ack");
            return;
        }

        // 未知帧类型
        logger.debug(&format!("Received frame: cmd={:?}, req_id={}, errcode={:?}", cmd, req_id, frame.errcode));
    }

    /// 发送数据帧
    pub async fn send(&self, frame: &WsFrame) -> Result<(), SdkError> {
        let ws_tx = self.ws_tx.lock().await;
        let tx_clone = ws_tx.clone();
        drop(ws_tx); // 释放锁后再发送消息

        if let Some(tx) = tx_clone.as_ref() {
            let msg_str = serde_json::to_string(frame)?;
            self.logger.debug(&format!("Sending message: {}", msg_str));
            match tx.send(Message::Text(msg_str)) {
                Ok(_) => {
                    self.logger.debug("Message sent successfully on wire");
                    Ok(())
                },
                Err(e) => {
                    self.logger.error(&format!("Failed to send message on wire: {}", e));
                    Err(SdkError::WebSocket(format!("Failed to send message: {}", e)))
                }
            }
        } else {
            Err(SdkError::WebSocket("WebSocket not connected".to_string()))
        }
    }

    /// 通过 WebSocket 通道发送回复消息
    ///
    /// 注意:企业微信服务器对于 aibot_respond_msg 命令可能不返回 ack,
    /// 因此我们在发送成功后直接返回,不等待 ack。
    pub async fn send_reply(
        &self,
        req_id: &str,
        body: serde_json::Value,
        cmd: &str,
    ) -> Result<WsFrame, SdkError> {
        let frame = WsFrame {
            cmd: Some(cmd.to_string()),
            headers: WsFrameHeaders::new(req_id.to_string()),
            body: Some(body),
            errcode: None,
            errmsg: None,
        };

        // 直接发送消息
        self.send(&frame).await?;

        self.logger.debug(&format!("Reply message sent, reqId: {}", req_id));

        // 返回成功回执(模拟的,服务器可能不会返回 ack)
        Ok(WsFrame {
            cmd: Some(cmd.to_string()),
            headers: WsFrameHeaders::new(req_id.to_string()),
            body: None,
            errcode: Some(0),
            errmsg: None,
        })
    }

    /// 主动断开连接
    pub fn disconnect(&self) {
        *self.is_manual_close.blocking_lock() = true;
        self.logger.info("WebSocket connection manually closed");
    }

    /// 获取当前连接状态
    pub fn is_connected(&self) -> bool {
        *self.state.blocking_lock() == ConnectionState::Authenticated
    }

    /// 上传临时素材 - 初始化
    pub async fn upload_media_init(
        &self,
        media_type: &str,
        filename: &str,
        total_size: usize,
        total_chunks: usize,
        md5: &str,
    ) -> Result<String, SdkError> {
        let req_id = generate_req_id("upload_init");
        let frame = WsFrame {
            cmd: Some("aibot_upload_media_init".to_string()),
            headers: WsFrameHeaders::new(req_id.clone()),
            body: Some(json!({
                "type": media_type,
                "filename": filename,
                "total_size": total_size,
                "total_chunks": total_chunks,
                "md5": md5
            })),
            errcode: None,
            errmsg: None,
        };

        self.send(&frame).await?;
        self.logger.info("Upload media init sent");

        // 注意:这里需要等待响应获取 upload_id
        // 简化实现,直接返回 req_id,实际应该从响应中解析 upload_id
        Ok(req_id)
    }

    /// 上传临时素材 - 分片
    pub async fn upload_media_chunk(
        &self,
        upload_id: &str,
        chunk_index: usize,
        base64_data: String,
    ) -> Result<(), SdkError> {
        let req_id = generate_req_id("upload_chunk");
        let frame = WsFrame {
            cmd: Some("aibot_upload_media_chunk".to_string()),
            headers: WsFrameHeaders::new(req_id),
            body: Some(json!({
                "upload_id": upload_id,
                "chunk_index": chunk_index,
                "base64_data": base64_data
            })),
            errcode: None,
            errmsg: None,
        };

        self.send(&frame).await?;
        Ok(())
    }

    /// 上传临时素材 - 完成
    pub async fn upload_media_finish(
        &self,
        upload_id: &str,
    ) -> Result<serde_json::Value, SdkError> {
        let req_id = generate_req_id("upload_finish");
        let frame = WsFrame {
            cmd: Some("aibot_upload_media_finish".to_string()),
            headers: WsFrameHeaders::new(req_id),
            body: Some(json!({
                "upload_id": upload_id
            })),
            errcode: None,
            errmsg: None,
        };

        self.send(&frame).await?;
        self.logger.info("Upload media finish sent");

        // 注意:这里需要等待响应获取 media_id
        // 简化实现,返回成功
        Ok(json!({
            "upload_id": upload_id
        }))
    }
}