hyper-function-core 0.1.1

Hyper Function
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
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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
use std::{io::Cursor, vec};

use futures_util::{
    stream::{SplitSink, SplitStream},
    SinkExt, StreamExt,
};
use tokio::net::TcpStream;
use tokio_tungstenite::{
    connect_async,
    tungstenite::{error::Error, Message},
    MaybeTlsStream, WebSocketStream,
};

pub enum Packet {
    OPEN(PacketOpen),
    CLOSE(PacketClose),
    PING(PacketPing),
    PONG(PacketPong),
    RETRY(PacketRetry),
    REDIRECT(PacketRedirect),
    MESSAGE(PacketMessage),
    ACK(PacketAck),
}

#[derive(Debug)]
pub struct PacketOpen {
    pub ping_interval: u8,   // ping interval second
    pub ping_timeout: u8,    // ping timeout second
    pub compress_size: u8, // min compress size kb, message payload great than this should be compress
    pub compress_method: u8, // compression method 0: no, 1: defalte
}

#[derive(Debug)]
pub struct PacketClose {
    pub reason: String,
}

#[derive(Debug)]
pub struct PacketPing {}
#[derive(Debug)]
pub struct PacketPong {}

#[derive(Debug)]
pub struct PacketRetry {
    pub delay: u8,
}

#[derive(Debug)]
pub struct PacketRedirect {
    pub delay: u8,
    pub target: String,
}

#[derive(Debug)]
pub struct PacketMessage {
    pub id: i32,
    pub pkg_id: i32,
    pub headers: Vec<Vec<u8>>,
    pub payload: Vec<u8>,
    pub socket_id: Vec<u8>,
    pub compress: u8,
}

#[derive(Debug)]
pub struct PacketAck {
    pub id: i32,
    pub pkg_id: i32,
}

pub struct Transport {}

impl Transport {
    pub async fn connect(
        mut url: url::Url,
    ) -> Result<WebSocketStream<MaybeTlsStream<TcpStream>>, Error> {
        url.query_pairs_mut()
            .append_pair("ts", &chrono::Utc::now().timestamp_millis().to_string());

        let (stream, _) = connect_async(url).await?;

        Ok(stream)
    }

    pub async fn send_message(
        sink: &mut SplitSink<WebSocketStream<MaybeTlsStream<TcpStream>>, Message>,
        data: (String, Vec<u8>),
    ) -> Result<(), Error> {
        let (socket_id, mut data) = data;
        let mut buf = Vec::with_capacity(4 + data.len() + socket_id.len());
        rmp::encode::write_pfix(&mut buf, 12).unwrap();
        buf.append(&mut data);
        rmp::encode::write_str(&mut buf, &socket_id).unwrap();
        rmp::encode::write_pfix(&mut buf, 0).unwrap();

        sink.send(Message::Binary(buf)).await?;
        Ok(())
    }

    pub async fn next(
        stream: &mut SplitStream<WebSocketStream<MaybeTlsStream<TcpStream>>>,
    ) -> Option<Vec<Packet>> {
        if let Some(msg) = stream.next().await {
            let mut packets: Vec<Packet> = Vec::new();
            if msg.is_err() {
                // TODO handle error
                return Some(packets);
            }

            let data = msg.unwrap().into_data();
            let data_len = data.len() as u64;
            let mut cur = Cursor::new(&data);

            while cur.position() < data_len {
                if let Some(packet) = Transport::parse_packet(&mut cur) {
                    packets.push(packet);
                } else {
                    // unkonw packet
                    return Some(packets);
                }
            }

            return Some(packets);
        } else {
            None
        }
    }

    pub fn parse_packet(cur: &mut Cursor<&Vec<u8>>) -> Option<Packet> {
        let packet_type = match rmp::decode::read_pfix(cur) {
            Ok(v) => v,
            Err(_) => return None,
        };

        match packet_type {
            // open
            6 => {
                let ping_interval = match rmp::decode::read_pfix(cur) {
                    Ok(v) => v,
                    Err(_) => return None,
                };

                let ping_timeout = match rmp::decode::read_pfix(cur) {
                    Ok(v) => v,
                    Err(_) => return None,
                };

                let compress_size = match rmp::decode::read_pfix(cur) {
                    Ok(v) => v,
                    Err(_) => return None,
                };

                let compress_method = match rmp::decode::read_pfix(cur) {
                    Ok(v) => v,
                    Err(_) => return None,
                };

                return Some(Packet::OPEN(PacketOpen {
                    ping_interval,
                    ping_timeout,
                    compress_size,
                    compress_method,
                }));
            }
            // close
            7 => {
                let reason_len = match rmp::decode::read_str_len(cur) {
                    Ok(v) => v,
                    Err(_) => return None,
                };

                let reason_end = cur.position() + reason_len as u64;
                let reason =
                    cur.get_ref().as_slice()[cur.position() as usize..reason_end as usize].to_vec();
                cur.set_position(reason_end);

                let reason = match String::from_utf8(reason) {
                    Ok(v) => v,
                    Err(_) => return None,
                };

                return Some(Packet::CLOSE(PacketClose { reason }));
            }
            // ping
            8 => {
                return Some(Packet::PING(PacketPing {}));
            }
            // pong
            9 => {
                return Some(Packet::PONG(PacketPong {}));
            }
            // retry
            10 => {
                let delay = match rmp::decode::read_pfix(cur) {
                    Ok(v) => v,
                    Err(_) => return None,
                };
                return Some(Packet::RETRY(PacketRetry { delay }));
            }
            // redirect
            11 => {
                let delay = match rmp::decode::read_pfix(cur) {
                    Ok(v) => v,
                    Err(_) => return None,
                };

                let target_len = match rmp::decode::read_str_len(cur) {
                    Ok(v) => v,
                    Err(_) => return None,
                };

                let target_end = cur.position() + target_len as u64;
                let target =
                    cur.get_ref().as_slice()[cur.position() as usize..target_end as usize].to_vec();
                cur.set_position(target_end);

                let target = match String::from_utf8(target) {
                    Ok(v) => v,
                    Err(_) => return None,
                };

                return Some(Packet::REDIRECT(PacketRedirect { delay, target }));
            }
            // message
            12 => {
                let data = cur.get_ref().as_slice();

                let id: i32 = match rmp::decode::read_int(cur) {
                    Ok(v) => v,
                    Err(_) => return None,
                };

                let pkg_id: i32 = match rmp::decode::read_int(cur) {
                    Ok(v) => v,
                    Err(_) => return None,
                };

                let header_count = match rmp::decode::read_map_len(cur) {
                    Ok(v) => v,
                    Err(_) => return None,
                };

                let mut headers: Vec<Vec<u8>>;
                if header_count != 0 {
                    headers = Vec::with_capacity((header_count * 2) as usize);
                    for _ in 0..header_count {
                        let key_len = match rmp::decode::read_str_len(cur) {
                            Ok(v) => v,
                            Err(_) => return None,
                        };

                        let key_end = cur.position() + key_len as u64;
                        let key = data[cur.position() as usize..key_end as usize].to_vec();
                        cur.set_position(key_end);
                        headers.push(key);

                        let val_len = match rmp::decode::read_str_len(cur) {
                            Ok(v) => v,
                            Err(_) => return None,
                        };

                        let val_end = cur.position() + val_len as u64;
                        let val = data[cur.position() as usize..val_end as usize].to_vec();
                        cur.set_position(val_end);
                        headers.push(val);
                    }
                } else {
                    headers = vec![];
                }

                let payload_len = match rmp::decode::read_bin_len(cur) {
                    Ok(v) => v,
                    Err(_) => return None,
                };

                let payload_end = cur.position() + payload_len as u64;
                let payload = data[cur.position() as usize..payload_end as usize].to_vec();
                cur.set_position(payload_end);

                let socket_id_len = match rmp::decode::read_str_len(cur) {
                    Ok(v) => v,
                    Err(_) => return None,
                };

                let socket_id_end = cur.position() + socket_id_len as u64;
                let socket_id = data[cur.position() as usize..socket_id_end as usize].to_vec();
                cur.set_position(socket_id_end);

                let compress = match rmp::decode::read_pfix(cur) {
                    Ok(v) => v,
                    Err(_) => return None,
                };

                let packet = PacketMessage {
                    id,
                    pkg_id,
                    headers,
                    payload,
                    socket_id,
                    compress,
                };

                return Some(Packet::MESSAGE(packet));
            }
            // ack
            13 => {
                let id: i32 = match rmp::decode::read_int(cur) {
                    Ok(v) => v,
                    Err(_) => return None,
                };

                let pkg_id: i32 = match rmp::decode::read_int(cur) {
                    Ok(v) => v,
                    Err(_) => return None,
                };

                let packet = PacketAck { id, pkg_id };

                return Some(Packet::ACK(packet));
            }
            _ => {
                // unknown packet stop parsing
                return None;
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use std::io::Cursor;

    use crate::gateway::transport::*;

    #[test]
    fn decode_packet_open() {
        let mut data = Vec::new();
        // packet message
        rmp::encode::write_pfix(&mut data, 6).unwrap();
        rmp::encode::write_pfix(&mut data, 25).unwrap();
        rmp::encode::write_pfix(&mut data, 20).unwrap();
        rmp::encode::write_pfix(&mut data, 0).unwrap();
        rmp::encode::write_pfix(&mut data, 0).unwrap();

        let mut cur = Cursor::new(&data);
        let packet = Transport::parse_packet(&mut cur).expect("parse packet open failed");
        match packet {
            Packet::OPEN(packet) => {
                assert_eq!(packet.ping_interval, 25);
                assert_eq!(packet.ping_timeout, 20);
                assert_eq!(packet.compress_size, 0);
                assert_eq!(packet.compress_method, 0);
            }
            _ => panic!("parse packet open failed"),
        }
    }

    #[test]
    fn decode_packet_close() {
        let mut data = Vec::new();
        // packet message
        rmp::encode::write_pfix(&mut data, 7).unwrap();
        rmp::encode::write_str(&mut data, "no reason").unwrap();

        let mut cur = Cursor::new(&data);
        let packet = Transport::parse_packet(&mut cur).expect("parse packet close failed");
        match packet {
            Packet::CLOSE(packet) => {
                assert_eq!(packet.reason, "no reason");
            }
            _ => panic!("parse packet open failed"),
        }
    }

    #[test]
    fn decode_packet_ping() {
        let mut data = Vec::new();
        // packet message
        rmp::encode::write_pfix(&mut data, 8).unwrap();

        let mut cur = Cursor::new(&data);
        let packet = Transport::parse_packet(&mut cur).expect("parse packet ping failed");
        match packet {
            Packet::PING(packet) => {}
            _ => panic!("parse packet ping failed"),
        }
    }

    #[test]
    fn decode_packet_pong() {
        let mut data = Vec::new();
        // packet message
        rmp::encode::write_pfix(&mut data, 9).unwrap();

        let mut cur = Cursor::new(&data);
        let packet = Transport::parse_packet(&mut cur).expect("parse packet pong failed");
        match packet {
            Packet::PONG(packet) => {}
            _ => panic!("parse packet pong failed"),
        }
    }

    #[test]
    fn decode_packet_retry() {
        let mut data = Vec::new();
        // packet message
        rmp::encode::write_pfix(&mut data, 10).unwrap();
        rmp::encode::write_pfix(&mut data, 3).unwrap();

        let mut cur = Cursor::new(&data);
        let packet = Transport::parse_packet(&mut cur).expect("parse packet retry failed");
        match packet {
            Packet::RETRY(packet) => {
                assert_eq!(packet.delay, 3);
            }
            _ => panic!("parse packet retry failed"),
        }
    }

    #[test]
    fn decode_packet_redirect() {
        let mut data = Vec::new();
        // packet message
        rmp::encode::write_pfix(&mut data, 11).unwrap();
        rmp::encode::write_pfix(&mut data, 6).unwrap();
        rmp::encode::write_str(&mut data, "123").unwrap();

        let mut cur = Cursor::new(&data);
        let packet = Transport::parse_packet(&mut cur).expect("parse packet redirect failed");
        match packet {
            Packet::REDIRECT(packet) => {
                assert_eq!(packet.delay, 6);
                assert_eq!(packet.target, "123");
            }
            _ => panic!("parse packet redirect failed"),
        }
    }

    #[test]
    fn decode_packet_message() {
        let mut data = Vec::new();
        // packet message
        rmp::encode::write_pfix(&mut data, 12).unwrap();
        // message id
        rmp::encode::write_sint(&mut data, 1).unwrap();
        // package id
        rmp::encode::write_sint(&mut data, 2).unwrap();
        // headers
        rmp::encode::write_map_len(&mut data, 3).unwrap();
        rmp::encode::write_str(&mut data, "a").unwrap();
        rmp::encode::write_str(&mut data, "1").unwrap();
        rmp::encode::write_str(&mut data, "b").unwrap();
        rmp::encode::write_str(&mut data, "2").unwrap();
        rmp::encode::write_str(&mut data, "c").unwrap();
        rmp::encode::write_str(&mut data, "3").unwrap();
        // payload
        rmp::encode::write_bin(&mut data, &[0x01, 0x02, 0x03]).unwrap();
        // socket id
        rmp::encode::write_str(&mut data, "socketid:1").unwrap();
        // compress
        rmp::encode::write_pfix(&mut data, 0).unwrap();

        let mut cur = Cursor::new(&data);
        let msg = Transport::parse_packet(&mut cur).expect("parse packet message failed");
        match msg {
            Packet::MESSAGE(msg) => {
                assert_eq!(msg.id, 1);
                assert_eq!(msg.pkg_id, 2);
                assert_eq!(msg.headers.len(), 3 * 2);
                assert_eq!(msg.headers[0], "a".as_bytes());
                assert_eq!(msg.headers[1], "1".as_bytes());
                assert_eq!(msg.headers[2], "b".as_bytes());
                assert_eq!(msg.headers[3], "2".as_bytes());
                assert_eq!(msg.headers[4], "c".as_bytes());
                assert_eq!(msg.headers[5], "3".as_bytes());
                assert_eq!(msg.payload, vec![0x01, 0x02, 0x03]);
            }
            _ => panic!("should be message"),
        }
    }

    #[test]
    fn decode_packet_message_with_no_headers() {
        let mut data = Vec::new();
        // packet message
        rmp::encode::write_pfix(&mut data, 12).unwrap();
        // message id
        rmp::encode::write_sint(&mut data, 1).unwrap();
        // package id
        rmp::encode::write_sint(&mut data, 2).unwrap();
        // headers
        rmp::encode::write_map_len(&mut data, 0).unwrap();
        // payload
        rmp::encode::write_bin(&mut data, &[0x01, 0x02, 0x03]).unwrap();
        // socket id
        rmp::encode::write_str(&mut data, "socketid:1").unwrap();
        // compress
        rmp::encode::write_pfix(&mut data, 0).unwrap();

        let mut cur = Cursor::new(&data);
        let msg = Transport::parse_packet(&mut cur).expect("parse packet message failed");
        match msg {
            Packet::MESSAGE(msg) => {
                assert_eq!(msg.id, 1);
                assert_eq!(msg.pkg_id, 2);
                assert_eq!(msg.headers.len(), 0);
                assert_eq!(msg.payload, vec![0x01, 0x02, 0x03]);
            }
            _ => panic!("should be message"),
        }
    }

    #[test]
    fn decode_packet_message_with_three_message_mixin() {
        let mut data = Vec::new();
        // packet message
        rmp::encode::write_pfix(&mut data, 12).unwrap();
        // message id
        rmp::encode::write_sint(&mut data, 1).unwrap();
        // package id
        rmp::encode::write_sint(&mut data, 2).unwrap();
        // headers
        rmp::encode::write_map_len(&mut data, 0).unwrap();
        // payload
        rmp::encode::write_bin(&mut data, &[0x01, 0x02, 0x03]).unwrap();
        // socket id
        rmp::encode::write_str(&mut data, "socketid:1").unwrap();
        // compress
        rmp::encode::write_pfix(&mut data, 0).unwrap();

        let data = vec![data.as_slice(), data.as_slice(), data.as_slice()].concat();

        let mut msgs: Vec<PacketMessage> = Vec::new();
        let mut cur = Cursor::new(&data);

        while cur.position() < data.len() as u64 {
            let msg = Transport::parse_packet(&mut cur).unwrap();
            match msg {
                Packet::MESSAGE(msg) => {
                    msgs.push(msg);
                }
                _ => panic!("should be message"),
            }
        }

        assert_eq!(msgs.len(), 3);

        for msg in msgs {
            assert_eq!(msg.id, 1);
            assert_eq!(msg.pkg_id, 2);
            assert_eq!(msg.headers.len(), 0);
            assert_eq!(msg.payload, vec![0x01, 0x02, 0x03]);
        }
    }

    #[test]
    fn decode_packet_ack() {
        let mut data = Vec::new();
        // packet message
        rmp::encode::write_pfix(&mut data, 13).unwrap();
        rmp::encode::write_pfix(&mut data, 3).unwrap();
        rmp::encode::write_pfix(&mut data, 8).unwrap();

        let mut cur = Cursor::new(&data);
        let packet = Transport::parse_packet(&mut cur).expect("parse packet ack failed");
        match packet {
            Packet::ACK(packet) => {
                assert_eq!(packet.id, 3);
                assert_eq!(packet.pkg_id, 8);
            }
            _ => panic!("parse packet ack failed"),
        }
    }

    #[test]
    fn wrong_data_should_return_none() {
        let mut data = Vec::new();
        // packet ack
        rmp::encode::write_pfix(&mut data, 13).unwrap();
        rmp::encode::write_pfix(&mut data, 3).unwrap();
        // wrong type
        rmp::encode::write_str(&mut data, "bla").unwrap();

        let mut cur = Cursor::new(&data);
        let packet = Transport::parse_packet(&mut cur);
        assert_eq!(packet.is_none(), true);
    }
}