ultimo 0.5.0

Modern Rust web framework with automatic TypeScript client generation
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
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
//! WebSocket frame encoding/decoding (RFC 6455)

use bytes::{Buf, BufMut, Bytes, BytesMut};
use std::io::{self, ErrorKind};

/// WebSocket opcode (4 bits)
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
pub enum OpCode {
    Continue = 0x0,
    Text = 0x1,
    Binary = 0x2,
    Close = 0x8,
    Ping = 0x9,
    Pong = 0xA,
}

impl OpCode {
    pub fn from_u8(byte: u8) -> Result<Self, io::Error> {
        match byte & 0x0F {
            0x0 => Ok(OpCode::Continue),
            0x1 => Ok(OpCode::Text),
            0x2 => Ok(OpCode::Binary),
            0x8 => Ok(OpCode::Close),
            0x9 => Ok(OpCode::Ping),
            0xA => Ok(OpCode::Pong),
            _ => Err(io::Error::new(ErrorKind::InvalidData, "invalid opcode")),
        }
    }

    pub fn is_control(&self) -> bool {
        matches!(self, OpCode::Close | OpCode::Ping | OpCode::Pong)
    }
}

/// WebSocket frame structure
#[derive(Debug, Clone)]
pub struct Frame {
    pub fin: bool,
    pub opcode: OpCode,
    pub mask: Option<[u8; 4]>,
    pub payload: Bytes,
}

impl Frame {
    /// Create a new text frame
    pub fn text(data: impl Into<String>) -> Self {
        Self {
            fin: true,
            opcode: OpCode::Text,
            mask: None,
            payload: Bytes::from(data.into().into_bytes()),
        }
    }

    /// Create a new binary frame
    pub fn binary(data: impl Into<Bytes>) -> Self {
        Self {
            fin: true,
            opcode: OpCode::Binary,
            mask: None,
            payload: data.into(),
        }
    }

    /// Create a close frame
    pub fn close(code: Option<u16>, reason: Option<&str>) -> Self {
        let mut payload = BytesMut::new();

        if let Some(code) = code {
            payload.put_u16(code);
            if let Some(reason) = reason {
                payload.put_slice(reason.as_bytes());
            }
        }

        Self {
            fin: true,
            opcode: OpCode::Close,
            mask: None,
            payload: payload.freeze(),
        }
    }

    /// Create a ping frame
    pub fn ping(data: impl Into<Bytes>) -> Self {
        Self {
            fin: true,
            opcode: OpCode::Ping,
            mask: None,
            payload: data.into(),
        }
    }

    /// Create a pong frame
    pub fn pong(data: impl Into<Bytes>) -> Self {
        Self {
            fin: true,
            opcode: OpCode::Pong,
            mask: None,
            payload: data.into(),
        }
    }

    /// Parse a frame from buffer
    pub fn parse(buf: &mut BytesMut) -> Result<Option<Self>, io::Error> {
        Self::parse_with_limits(buf, None)
    }

    /// Parse a frame from buffer with size limits
    pub fn parse_with_limits(
        buf: &mut BytesMut,
        max_frame_size: Option<usize>,
    ) -> Result<Option<Self>, io::Error> {
        if buf.len() < 2 {
            return Ok(None); // Need at least 2 bytes
        }

        // First byte: FIN (1 bit) + RSV (3 bits) + OpCode (4 bits)
        let first = buf[0];
        let fin = (first & 0x80) != 0;
        let opcode = OpCode::from_u8(first)?;

        // Second byte: MASK (1 bit) + Payload length (7 bits)
        let second = buf[1];
        let masked = (second & 0x80) != 0;
        let mut payload_len = (second & 0x7F) as u64;

        let mut header_len = 2;

        // Extended payload length
        if payload_len == 126 {
            if buf.len() < 4 {
                return Ok(None); // Need 2 more bytes
            }
            payload_len = u16::from_be_bytes([buf[2], buf[3]]) as u64;
            header_len += 2;
        } else if payload_len == 127 {
            if buf.len() < 10 {
                return Ok(None); // Need 8 more bytes
            }
            payload_len = u64::from_be_bytes([
                buf[2], buf[3], buf[4], buf[5], buf[6], buf[7], buf[8], buf[9],
            ]);
            header_len += 8;
        }

        // Check frame size limit
        if let Some(max_size) = max_frame_size {
            if payload_len > max_size as u64 {
                return Err(io::Error::new(
                    ErrorKind::InvalidData,
                    format!("Frame size {} exceeds maximum {}", payload_len, max_size),
                ));
            }
        }

        // Masking key (4 bytes if masked)
        let mask = if masked {
            if buf.len() < header_len + 4 {
                return Ok(None);
            }
            let mask_bytes = [
                buf[header_len],
                buf[header_len + 1],
                buf[header_len + 2],
                buf[header_len + 3],
            ];
            header_len += 4;
            Some(mask_bytes)
        } else {
            None
        };

        // Check if we have the full payload
        let total_len = header_len + payload_len as usize;
        if buf.len() < total_len {
            return Ok(None);
        }

        // Extract payload
        buf.advance(header_len);
        let mut payload = buf.split_to(payload_len as usize);

        // Unmask payload if needed
        if let Some(mask_key) = mask {
            for (i, byte) in payload.iter_mut().enumerate() {
                *byte ^= mask_key[i % 4];
            }
        }

        Ok(Some(Frame {
            fin,
            opcode,
            mask,
            payload: payload.freeze(),
        }))
    }

    /// Encode frame to bytes
    pub fn encode(&self) -> Bytes {
        let payload_len = self.payload.len();
        let mut buf = BytesMut::new();

        // First byte: FIN + RSV + OpCode
        let mut first = self.opcode as u8;
        if self.fin {
            first |= 0x80;
        }
        buf.put_u8(first);

        // Second byte: MASK + Payload length
        let mut second = 0u8;
        if self.mask.is_some() {
            second |= 0x80;
        }

        // Payload length encoding
        if payload_len < 126 {
            second |= payload_len as u8;
            buf.put_u8(second);
        } else if payload_len <= u16::MAX as usize {
            second |= 126;
            buf.put_u8(second);
            buf.put_u16(payload_len as u16);
        } else {
            second |= 127;
            buf.put_u8(second);
            buf.put_u64(payload_len as u64);
        }

        // Masking key
        if let Some(mask_key) = self.mask {
            buf.put_slice(&mask_key);
        }

        // Payload (masked if needed)
        if let Some(mask_key) = self.mask {
            let mut masked = self.payload.to_vec();
            for (i, byte) in masked.iter_mut().enumerate() {
                *byte ^= mask_key[i % 4];
            }
            buf.put_slice(&masked);
        } else {
            buf.put_slice(&self.payload);
        }

        buf.freeze()
    }
}

/// High-level WebSocket message
#[derive(Debug, Clone)]
pub enum Message {
    Text(String),
    Binary(Bytes),
    Ping(Bytes),
    Pong(Bytes),
    Close(Option<CloseFrame>),
}

#[derive(Debug, Clone)]
pub struct CloseFrame {
    pub code: u16,
    pub reason: String,
}

impl Message {
    /// Create message from frame
    pub fn from_frame(frame: Frame) -> Result<Self, io::Error> {
        Self::from_frame_with_limit(frame, None)
    }

    /// Create message from frame with size limit
    pub fn from_frame_with_limit(
        frame: Frame,
        max_message_size: Option<usize>,
    ) -> Result<Self, io::Error> {
        // Check message size limit
        if let Some(max_size) = max_message_size {
            if frame.payload.len() > max_size {
                return Err(io::Error::new(
                    ErrorKind::InvalidData,
                    format!(
                        "Message size {} exceeds maximum {}",
                        frame.payload.len(),
                        max_size
                    ),
                ));
            }
        }

        match frame.opcode {
            OpCode::Text => {
                let text = String::from_utf8(frame.payload.to_vec())
                    .map_err(|_| io::Error::new(ErrorKind::InvalidData, "invalid UTF-8"))?;
                Ok(Message::Text(text))
            }
            OpCode::Binary => Ok(Message::Binary(frame.payload)),
            OpCode::Ping => Ok(Message::Ping(frame.payload)),
            OpCode::Pong => Ok(Message::Pong(frame.payload)),
            OpCode::Close => {
                if frame.payload.len() >= 2 {
                    let mut buf = frame.payload.clone();
                    let code = buf.get_u16();
                    let reason = if buf.has_remaining() {
                        String::from_utf8(buf.to_vec()).unwrap_or_default()
                    } else {
                        String::new()
                    };
                    Ok(Message::Close(Some(CloseFrame { code, reason })))
                } else {
                    Ok(Message::Close(None))
                }
            }
            OpCode::Continue => Err(io::Error::new(
                ErrorKind::InvalidData,
                "unexpected continuation frame",
            )),
        }
    }

    /// Convert message to frame
    pub fn to_frame(&self) -> Frame {
        match self {
            Message::Text(text) => Frame::text(text.clone()),
            Message::Binary(data) => Frame::binary(data.clone()),
            Message::Ping(data) => Frame::ping(data.clone()),
            Message::Pong(data) => Frame::pong(data.clone()),
            Message::Close(close_frame) => {
                if let Some(cf) = close_frame {
                    Frame::close(Some(cf.code), Some(&cf.reason))
                } else {
                    Frame::close(None, None)
                }
            }
        }
    }

    /// Convert message to fragmented frames with given chunk size
    /// Returns a vector of frames that should be sent in sequence
    pub fn to_fragmented_frames(&self, max_chunk_size: usize) -> Vec<Frame> {
        let (opcode, payload) = match self {
            Message::Text(text) => (OpCode::Text, Bytes::from(text.as_bytes().to_vec())),
            Message::Binary(data) => (OpCode::Binary, data.clone()),
            // Control frames cannot be fragmented
            _ => return vec![self.to_frame()],
        };

        if payload.len() <= max_chunk_size {
            // No need to fragment
            return vec![self.to_frame()];
        }

        let mut frames = Vec::new();
        let mut offset = 0;

        while offset < payload.len() {
            let end = (offset + max_chunk_size).min(payload.len());
            let chunk = payload.slice(offset..end);
            let is_first = offset == 0;
            let is_last = end >= payload.len();

            let frame = Frame {
                fin: is_last,
                opcode: if is_first { opcode } else { OpCode::Continue },
                mask: None,
                payload: chunk,
            };

            frames.push(frame);
            offset = end;
        }

        frames
    }
}

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

    #[test]
    fn test_frame_text_encode_decode() {
        let frame = Frame::text("Hello, WebSocket!");
        let encoded = frame.encode();

        let mut buf = BytesMut::from(encoded.as_ref());
        let decoded = Frame::parse(&mut buf).unwrap().unwrap();

        assert!(decoded.fin);
        assert_eq!(decoded.opcode, OpCode::Text);
        assert_eq!(decoded.payload, Bytes::from("Hello, WebSocket!"));
    }

    #[test]
    fn test_frame_binary_encode_decode() {
        let data = vec![1, 2, 3, 4, 5];
        let frame = Frame::binary(Bytes::from(data.clone()));
        let encoded = frame.encode();

        let mut buf = BytesMut::from(encoded.as_ref());
        let decoded = Frame::parse(&mut buf).unwrap().unwrap();

        assert_eq!(decoded.opcode, OpCode::Binary);
        assert_eq!(decoded.payload, Bytes::from(data));
    }

    #[test]
    fn test_frame_close_encode_decode() {
        let frame = Frame::close(Some(1000), Some("Normal closure"));
        let encoded = frame.encode();

        let mut buf = BytesMut::from(encoded.as_ref());
        let decoded = Frame::parse(&mut buf).unwrap().unwrap();

        assert_eq!(decoded.opcode, OpCode::Close);
        assert!(decoded.payload.len() >= 2);
    }

    #[test]
    fn test_frame_masking() {
        let mut frame = Frame::text("Test");
        frame.mask = Some([1, 2, 3, 4]);

        let encoded = frame.encode();
        let mut buf = BytesMut::from(encoded.as_ref());
        let decoded = Frame::parse(&mut buf).unwrap().unwrap();

        assert_eq!(decoded.payload, Bytes::from("Test"));
    }

    #[test]
    fn test_message_from_frame() {
        let frame = Frame::text("Hello");
        let message = Message::from_frame(frame).unwrap();

        match message {
            Message::Text(text) => assert_eq!(text, "Hello"),
            _ => panic!("Expected text message"),
        }
    }

    #[test]
    fn test_extended_payload_length_16bit() {
        // Test payload length that requires 16-bit encoding (126-65535 bytes)
        let payload = vec![0u8; 1000];
        let frame = Frame::binary(Bytes::from(payload.clone()));
        let encoded = frame.encode();

        let mut buf = BytesMut::from(encoded.as_ref());
        let decoded = Frame::parse(&mut buf).unwrap().unwrap();

        assert_eq!(decoded.payload.len(), 1000);
        assert_eq!(decoded.opcode, OpCode::Binary);
    }

    #[test]
    fn test_extended_payload_length_64bit() {
        // Test payload length that requires 64-bit encoding (>65535 bytes)
        let payload = vec![0u8; 70000];
        let frame = Frame::binary(Bytes::from(payload.clone()));
        let encoded = frame.encode();

        let mut buf = BytesMut::from(encoded.as_ref());
        let decoded = Frame::parse(&mut buf).unwrap().unwrap();

        assert_eq!(decoded.payload.len(), 70000);
        assert_eq!(decoded.opcode, OpCode::Binary);
    }

    #[test]
    fn test_partial_frame_parsing() {
        let frame = Frame::text("Hello, WebSocket!");
        let encoded = frame.encode();

        // Test with incomplete frame (only first byte)
        let mut buf = BytesMut::from(&encoded[..1]);
        assert!(Frame::parse(&mut buf).unwrap().is_none());

        // Test with incomplete header
        buf = BytesMut::from(&encoded[..3]);
        assert!(Frame::parse(&mut buf).unwrap().is_none());

        // Test with complete frame
        buf = BytesMut::from(encoded.as_ref());
        assert!(Frame::parse(&mut buf).unwrap().is_some());
    }

    #[test]
    fn test_empty_payload() {
        let frame = Frame::text("");
        let encoded = frame.encode();

        let mut buf = BytesMut::from(encoded.as_ref());
        let decoded = Frame::parse(&mut buf).unwrap().unwrap();

        assert_eq!(decoded.payload.len(), 0);
        assert_eq!(decoded.opcode, OpCode::Text);
    }

    #[test]
    fn test_ping_pong_frames() {
        let ping_data = Bytes::from("ping");
        let ping = Frame::ping(ping_data.clone());
        assert_eq!(ping.opcode, OpCode::Ping);
        assert_eq!(ping.payload, ping_data);

        let pong = Frame::pong(ping_data.clone());
        assert_eq!(pong.opcode, OpCode::Pong);
        assert_eq!(pong.payload, ping_data);
    }

    #[test]
    fn test_close_frame_with_reason() {
        let frame = Frame::close(Some(1000), Some("Normal closure"));
        let message = Message::from_frame(frame).unwrap();

        match message {
            Message::Close(Some(close_frame)) => {
                assert_eq!(close_frame.code, 1000);
                assert_eq!(close_frame.reason, "Normal closure");
            }
            _ => panic!("Expected close message with frame"),
        }
    }

    #[test]
    fn test_close_frame_without_reason() {
        let frame = Frame::close(Some(1001), None);
        let message = Message::from_frame(frame).unwrap();

        match message {
            Message::Close(Some(close_frame)) => {
                assert_eq!(close_frame.code, 1001);
                assert_eq!(close_frame.reason, "");
            }
            _ => panic!("Expected close message"),
        }
    }

    #[test]
    fn test_close_frame_empty() {
        let frame = Frame::close(None, None);
        let message = Message::from_frame(frame).unwrap();

        match message {
            Message::Close(None) => {}
            _ => panic!("Expected empty close message"),
        }
    }

    #[test]
    fn test_invalid_utf8_in_text_frame() {
        let mut frame = Frame::text("test");
        frame.payload = Bytes::from(vec![0xFF, 0xFE, 0xFD]); // Invalid UTF-8

        let result = Message::from_frame(frame);
        assert!(result.is_err());
    }

    #[test]
    fn test_message_to_frame_round_trip() {
        let messages = vec![
            Message::Text("Hello".to_string()),
            Message::Binary(Bytes::from(vec![1, 2, 3])),
            Message::Ping(Bytes::from("ping")),
            Message::Pong(Bytes::from("pong")),
            Message::Close(Some(CloseFrame {
                code: 1000,
                reason: "bye".to_string(),
            })),
        ];

        for msg in messages {
            let frame = msg.to_frame();
            let encoded = frame.encode();
            let mut buf = BytesMut::from(encoded.as_ref());
            let decoded = Frame::parse(&mut buf).unwrap().unwrap();
            let msg_back = Message::from_frame(decoded).unwrap();

            // Compare discriminants (enum variants)
            assert_eq!(
                std::mem::discriminant(&msg),
                std::mem::discriminant(&msg_back)
            );
        }
    }

    #[test]
    fn test_opcode_is_control() {
        assert!(OpCode::Close.is_control());
        assert!(OpCode::Ping.is_control());
        assert!(OpCode::Pong.is_control());
        assert!(!OpCode::Text.is_control());
        assert!(!OpCode::Binary.is_control());
        assert!(!OpCode::Continue.is_control());
    }

    #[test]
    fn test_invalid_opcode() {
        let result = OpCode::from_u8(0xFF);
        assert!(result.is_err());
    }
}