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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
use super::packet::*;
use super::session::*;
use cyfs_base::{bucky_time_now, BuckyError, BuckyErrorCode, BuckyResult};
use cyfs_debug::Mutex;

use async_trait::async_trait;
use futures::future::{AbortHandle, Abortable};
use futures::prelude::*;
use lru_time_cache::LruCache;
use std::sync::{
    atomic::{AtomicU32, Ordering},
    Arc,
};
use std::time::Duration;

// ws request的默认超时时间
const WS_REQUEST_DEFAULT_TIMEOUT: Duration = Duration::from_secs(60 * 10 * 10);

#[async_trait]
pub trait WebSocketRequestHandler: Send + Sync + 'static {
    async fn on_request(
        &self,
        requestor: Arc<WebSocketRequestManager>,
        cmd: u16,
        content: Vec<u8>,
    ) -> BuckyResult<Option<Vec<u8>>> {
        self.process_string_request(requestor, cmd, content).await
    }

    async fn process_string_request(
        &self,
        requestor: Arc<WebSocketRequestManager>,
        cmd: u16,
        content: Vec<u8>,
    ) -> BuckyResult<Option<Vec<u8>>> {
        let content = String::from_utf8(content).map_err(|e| {
            let msg = format!(
                "decode ws packet as string failed! sid={}, cmd={}, {}",
                requestor.sid(),
                cmd,
                e
            );
            error!("{}", msg);

            BuckyError::new(BuckyErrorCode::InvalidFormat, msg)
        })?;

        self.on_string_request(requestor, cmd, content)
            .await
            .map(|v| v.map(|v| v.into_bytes()))
    }

    async fn on_string_request(
        &self,
        _requestor: Arc<WebSocketRequestManager>,
        _cmd: u16,
        _content: String,
    ) -> BuckyResult<Option<String>> {
        unimplemented!();
    }

    async fn on_session_begin(&self, session: &Arc<WebSocketSession>);
    async fn on_session_end(&self, session: &Arc<WebSocketSession>);

    fn clone_handler(&self) -> Box<dyn WebSocketRequestHandler>;
}

struct RequestItem {
    seq: u16,
    send_tick: u64,
    resp: Option<BuckyResult<Vec<u8>>>,
    waker: Option<AbortHandle>,
}

impl RequestItem {
    fn new(seq: u16) -> Self {
        Self {
            seq,
            send_tick: bucky_time_now(),
            resp: None,
            waker: None,
        }
    }

    fn resp(&mut self, code: BuckyErrorCode) {
        if let Some(waker) = self.waker.take() {
            if self.resp.is_none() {
                self.resp = Some(Err(BuckyError::from(code)));
            } else {
                warn!(
                    "end ws request with {:?} but already has resp! send_tick={}, seq={}",
                    code, self.send_tick, self.seq
                );
                unreachable!();
            }

            waker.abort();
        }
    }

    fn timeout(&mut self) {
        self.resp(BuckyErrorCode::Timeout);
    }

    fn abort(&mut self) {
        self.resp(BuckyErrorCode::Aborted);
    }
}

impl Drop for RequestItem {
    fn drop(&mut self) {
        // info!("will drop ws request! seq={}", self.seq);
        self.abort();
    }
}

struct WebSocketRequestContainer {
    list: LruCache<u16, Arc<Mutex<RequestItem>>>,
    next_seq: u16,
}

impl WebSocketRequestContainer {
    fn new() -> Self {
        let list = LruCache::with_expiry_duration(WS_REQUEST_DEFAULT_TIMEOUT);

        Self { list, next_seq: 1 }
    }

    fn new_request(
        &mut self,
        sid: u32,
    ) -> (
        u16,
        Arc<Mutex<RequestItem>>,
        Vec<(u16, Arc<Mutex<RequestItem>>)>,
    ) {
        let seq = self.next_seq;
        self.next_seq += 1;
        if self.next_seq == u16::MAX {
            warn!("ws request seq roll back! sid={}", sid);
            self.next_seq = 1;
        }

        let req_item = RequestItem::new(seq);

        let req_item = Arc::new(Mutex::new(req_item));
        let (old, mut list) = self.list.notify_insert(seq, req_item.clone());

        if let Some(old) = old {
            // 正常情况下不应该到这里,除非短时间内发了超大量的request,导致seq回环
            let seq;
            {
                let old_item = old.lock().unwrap();
                error!(
                    "replace old with same seq! sid={}, seq={}, send_tick={}",
                    sid, old_item.seq, old_item.send_tick
                );
                seq = old_item.seq;
            }

            // FIXME 先用超时对待
            list.push((seq, old));
        }

        (seq, req_item, list)
    }

    /*
    fn bind_waker(&mut self, seq: u16, waker: AbortHandle) {
        let (item, list) = self.list.notify_get_mut(&seq);
        if let Some(item) = item {
            let mut item = item.lock().unwrap();
            assert!(item.waker.is_none());
            item.waker = Some(waker);
        } else {
            unreachable!();
        }
        if !list.is_empty() {
            self.on_timeout(list);
        }
    }
    */

    fn remove_request(&mut self, seq: u16) -> Option<Arc<Mutex<RequestItem>>> {
        assert!(seq > 0);

        self.list.remove(&seq)
    }

    fn check_timeout(&mut self) -> Vec<(u16, Arc<Mutex<RequestItem>>)> {
        // 直接清除过期的元素,不能迭代这些元素,否则会导致这些元素被更新时间戳
        let (_, list) = self.list.notify_get(&0);

        list
    }

    // 清空所有元素
    fn clear(&mut self) {
        for (seq, item) in self.list.iter() {
            info!("will abort ws request: seq={}", seq);
            item.lock().unwrap().abort();
        }

        self.list.clear();
    }

    fn on_timeout(sid: u32, list: Vec<(u16, Arc<Mutex<RequestItem>>)>) {
        for (seq, item) in list {
            warn!("ws request droped on timeout! sid={}, seq={}", sid, seq);

            let mut item = item.lock().unwrap();
            if item.waker.is_some() {
                item.timeout();
            } else {
                // timeout的同时收到了应答,发生了竞争
                warn!(
                    "ws request timeout but already waked! sid={}, seq={}",
                    sid, seq
                );
            }
        }
    }
}

pub struct WebSocketRequestManager {
    reqs: Arc<Mutex<WebSocketRequestContainer>>,
    session: Arc<Mutex<Option<Arc<WebSocketSession>>>>,
    sid: AtomicU32,
    monitor_canceler: Arc<Mutex<Option<AbortHandle>>>,
    handler: Box<dyn WebSocketRequestHandler>,
}

impl Drop for WebSocketRequestManager {
    fn drop(&mut self) {
        let mut monitor_canceler = self.monitor_canceler.lock().unwrap();
        if let Some(canceler) = monitor_canceler.take() {
            info!("will stop ws request monitor: sid={}", self.sid());
            canceler.abort();
        }

        self.reqs.lock().unwrap().clear();
    }
}

impl WebSocketRequestManager {
    pub fn new(handler: Box<dyn WebSocketRequestHandler>) -> Self {
        let reqs = WebSocketRequestContainer::new();

        Self {
            reqs: Arc::new(Mutex::new(reqs)),
            session: Arc::new(Mutex::new(None)),
            sid: AtomicU32::new(0),
            monitor_canceler: Arc::new(Mutex::new(None)),
            handler,
        }
    }

    pub fn sid(&self) -> u32 {
        self.sid.load(Ordering::Relaxed)
    }

    pub fn session(&self) -> Option<Arc<WebSocketSession>> {
        self.session.lock().unwrap().clone()
    }

    pub fn is_session_valid(&self) -> bool {
        self.session.lock().unwrap().is_some()
    }

    pub fn bind_session(&self, session: Arc<WebSocketSession>) {
        {
            let mut local = self.session.lock().unwrap();
            assert!(local.is_none());

            self.sid.store(session.sid(), Ordering::SeqCst);
            *local = Some(session);
        }

        self.monitor();
    }

    pub fn unbind_session(&self) {
        self.stop_monitor();

        // 强制所有pending的请求为超时
        self.reqs.lock().unwrap().clear();

        let _ = {
            let mut local = self.session.lock().unwrap();
            assert!(local.is_some());

            debug!(
                "ws request manager unbind session! sid={}",
                local.as_ref().unwrap().sid()
            );
            local.take()
        };
    }

    // 收到了msg
    pub async fn on_msg(
        requestor: Arc<WebSocketRequestManager>,
        packet: WSPacket,
    ) -> BuckyResult<()> {
        let cmd = packet.header.cmd;
        if cmd > 0 {
            let seq = packet.header.seq;

            let resp = requestor
                .handler
                .on_request(requestor.clone(), cmd, packet.content)
                .await?;

            // 如果seq==0,表示不需要应答,那么应该返回None
            if resp.is_none() {
                assert!(seq == 0);
            } else {
                assert!(seq > 0);

                // 发起应答,cmd需要设置为0
                let resp_packet = WSPacket::new_from_bytes(seq, 0, resp.unwrap());
                let buf = resp_packet.encode();
                requestor.post_to_session(buf).await?;
            }
        } else {
            requestor.on_resp(packet).await?;
        }
        Ok(())
    }

    // 发送一个字符串请求
    pub async fn post_req(&self, cmd: u16, msg: String) -> BuckyResult<String> {
        let content = self.post_bytes_req(cmd, msg.into_bytes()).await?;

        match String::from_utf8(content) {
            Ok(v) => Ok(v),
            Err(e) => {
                let msg = format!(
                    "decode ws resp as string failed! sid={}, cmd={}, {}",
                    self.sid(),
                    cmd,
                    e
                );
                error!("{}", msg);

                Err(BuckyError::new(BuckyErrorCode::InvalidFormat, msg))
            }
        }
    }

    // 发送一个请求并等待应答
    pub async fn post_bytes_req(&self, cmd: u16, msg: Vec<u8>) -> BuckyResult<Vec<u8>> {
        let (seq, item, timeout_list) = self.reqs.lock().unwrap().new_request(self.sid());
        assert!(seq > 0);

        // 首先处理超时的
        if !timeout_list.is_empty() {
            WebSocketRequestContainer::on_timeout(self.sid(), timeout_list);
        }

        // Init waker before send the packet
        let (abort_handle, abort_registration) = AbortHandle::new_pair();
        {
            let mut item = item.lock().unwrap();
            assert!(item.waker.is_none());
            item.waker = Some(abort_handle);
        }

        let packet = WSPacket::new_from_bytes(seq, cmd, msg);
        let buf = packet.encode();
        if let Err(e) = self.post_to_session(buf).await {
            self.reqs.lock().unwrap().remove_request(seq);

            return Err(e);
        }

        // info!("request send complete, now will wait for resp! cmd={}", cmd);

        // 等待唤醒
        let future = Abortable::new(async_std::future::pending::<()>(), abort_registration);
        future.await.unwrap_err();

        // 应答
        let mut item = item.lock().unwrap();
        if let Some(resp) = item.resp.take() {
            resp
        } else {
            unreachable!(
                "ws request item waked up without resp: sid={}, seq={}",
                self.sid(),
                item.seq
            );
        }
    }

    // 不带应答的请求
    async fn post_req_without_resp(&self, cmd: u16, msg: String) -> BuckyResult<()> {
        self.post_bytes_req_without_resp(cmd, msg.into_bytes())
            .await
    }

    async fn post_bytes_req_without_resp(&self, cmd: u16, msg: Vec<u8>) -> BuckyResult<()> {
        let packet = WSPacket::new_from_bytes(0, cmd, msg);
        let buf = packet.encode();

        self.post_to_session(buf).await
    }

    // 收到了应答
    async fn on_resp(&self, packet: WSPacket) -> BuckyResult<()> {
        assert!(packet.header.cmd == 0);
        assert!(packet.header.seq > 0);

        let seq = packet.header.seq;
        let ret = self.reqs.lock().unwrap().remove_request(seq);
        if ret.is_none() {
            let msg = format!(
                "ws request recv resp but already been removed! sid={}, seq={}",
                self.sid(),
                seq
            );

            warn!("{}", msg);
            return Err(BuckyError::new(BuckyErrorCode::NotFound, msg));
        }

        let item = ret.unwrap();

        // 保存应答并唤醒
        let mut item = item.lock().unwrap();
        if let Some(waker) = item.waker.take() {
            if item.resp.is_none() {
                item.resp = Some(Ok(packet.content));
            } else {
                warn!(
                    "ws request recv resp but already has local resp! sid={}, seq={}",
                    self.sid(),
                    seq
                );
                unreachable!();
            }

            drop(item);

            waker.abort();
        } else {
            warn!(
                "ws request recv resp but already timeout! sid={}, seq={}",
                self.sid(),
                seq
            );
        }

        Ok(())
    }

    async fn post_to_session(&self, msg: Vec<u8>) -> BuckyResult<()> {
        let ret = self.session.lock().unwrap().clone();
        if ret.is_none() {
            warn!("ws session not exists: {}", self.sid());
            return Err(BuckyError::from(BuckyErrorCode::NotConnected));
        }

        let session = ret.unwrap();
        session.post_msg(msg).await.map_err(|e| e)?;
        Ok(())
    }

    fn monitor(&self) {
        let reqs = self.reqs.clone();
        let sid = self.sid();

        let (fut, handle) = future::abortable(async move {
            let mut interval = async_std::stream::interval(Duration::from_secs(15));
            while let Some(_) = interval.next().await {
                let list = reqs.lock().unwrap().check_timeout();

                if !list.is_empty() {
                    WebSocketRequestContainer::on_timeout(sid, list);
                }
            }
        });

        // 保存canceler,用以session结束时候取消
        let mut monitor_canceler = self.monitor_canceler.lock().unwrap();
        assert!(monitor_canceler.is_none());
        *monitor_canceler = Some(handle);

        async_std::task::spawn(async move {
            match fut.await {
                Ok(_) => {
                    info!("ws request monitor complete, sid={}", sid);
                    // 不应该到这里,只有被abort一种可能
                    unreachable!();
                }
                Err(_aborted) => {
                    info!("ws request monitor breaked, sid={}", sid);
                }
            };
        });
    }

    fn stop_monitor(&self) {
        let mut monitor_canceler = self.monitor_canceler.lock().unwrap();
        if let Some(canceler) = monitor_canceler.take() {
            debug!("will stop ws request monitor: sid={}", self.sid());
            canceler.abort();
        }
    }
}

#[cfg(test)]
mod tests {
    use futures::future::{AbortHandle, Abortable};

    async fn test_wakeup() {
        let (abort_handle, abort_registration) = AbortHandle::new_pair();

        abort_handle.abort();

        async_std::task::spawn(async move {
            async_std::task::sleep(std::time::Duration::from_secs(2)).await;
            abort_handle.abort();
        });

        // 等待唤醒
        let future = Abortable::new(async_std::future::pending::<()>(), abort_registration);
        future.await.unwrap_err();

        println!("future wait complete!");

        async_std::task::sleep(std::time::Duration::from_secs(3)).await;
    }

    #[test]
    fn test() {
        async_std::task::block_on(async move {
            test_wakeup().await;
        })
    }
}