sockudo-core 4.6.0

Core traits, types, error handling, and configuration for Sockudo
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
use super::buffer::{RewindGate, SizedMessage};
use super::*;
use bytes::Bytes;
use sockudo_protocol::messages::PusherMessage;
use sockudo_ws::axum_integration::WebSocketWriter;

#[test]
fn test_socket_id_generation() {
    let id1 = SocketId::new();
    let id2 = SocketId::new();

    assert_ne!(id1, id2);
    let id1_str = id1.to_string();
    let id2_str = id2.to_string();
    assert!(id1_str.contains('.'));
    assert!(id2_str.contains('.'));
}

#[test]
fn test_connection_state() {
    let mut state = ConnectionState::new();

    assert!(!state.is_subscribed("test-channel"));
    state.add_subscription("test-channel".to_string());
    assert!(state.is_subscribed("test-channel"));
    assert!(state.remove_subscription("test-channel"));
    assert!(!state.is_subscribed("test-channel"));
}

#[test]
fn test_connection_capabilities_allow_matching_channels() {
    let capabilities = ConnectionCapabilities {
        subscribe: Some(vec!["chat:*".to_string()]),
        publish: Some(vec!["private-chat:*".to_string()]),
        presence: Some(vec!["presence-chat:*".to_string()]),
        ..Default::default()
    };

    assert!(capabilities.allows_subscribe("chat:room-1"));
    assert!(capabilities.allows_subscribe("presence-chat:room-1"));
    assert!(capabilities.allows_publish("private-chat:room-1"));
    assert!(!capabilities.allows_publish("private-news:room-1"));
    assert!(!capabilities.allows_annotation_publish("chat:room-1"));
}

#[test]
fn test_connection_capabilities_default_to_unrestricted_when_missing() {
    let capabilities = ConnectionCapabilities::default();

    assert!(capabilities.allows_subscribe("chat:room-1"));
    assert!(capabilities.allows_publish("private-chat:room-1"));
    assert!(!capabilities.allows_message_mutation_any(
        crate::versioned_message_auth::MutationKind::Update,
        "chat:room-1"
    ));
    assert!(!capabilities.allows_message_mutation_own(
        crate::versioned_message_auth::MutationKind::Update,
        "chat:room-1"
    ));
}

#[test]
fn test_connection_capabilities_allow_matching_mutation_channels() {
    let capabilities = ConnectionCapabilities {
        subscribe: None,
        publish: None,
        presence: None,
        message_update_own: Some(vec!["chat:*".to_string()]),
        message_update_any: Some(vec!["admin:*".to_string()]),
        message_delete_own: Some(vec!["chat:*".to_string()]),
        message_delete_any: None,
        message_append_own: None,
        message_append_any: Some(vec!["stream:*".to_string()]),
        ..Default::default()
    };

    assert!(capabilities.allows_message_mutation_own(
        crate::versioned_message_auth::MutationKind::Update,
        "chat:room-1"
    ));
    assert!(capabilities.allows_message_mutation_any(
        crate::versioned_message_auth::MutationKind::Update,
        "admin:room-1"
    ));
    assert!(capabilities.allows_message_mutation_own(
        crate::versioned_message_auth::MutationKind::Delete,
        "chat:room-1"
    ));
    assert!(capabilities.allows_message_mutation_any(
        crate::versioned_message_auth::MutationKind::Append,
        "stream:room-1"
    ));
    assert!(!capabilities.allows_message_mutation_any(
        crate::versioned_message_auth::MutationKind::Delete,
        "chat:room-1"
    ));
}

#[test]
fn test_connection_capabilities_parse_hyphenated_annotation_grants() {
    let capabilities: ConnectionCapabilities = sonic_rs::from_str(
        r#"{
                "annotation-publish":["chat:*"],
                "annotation-delete-own":["chat:*"],
                "annotation-delete-any":["admin:*"],
                "annotation-subscribe":["chat:*"]
            }"#,
    )
    .unwrap();

    assert!(capabilities.allows_annotation_publish("chat:room-1"));
    assert!(capabilities.allows_annotation_delete_own("chat:room-1"));
    assert!(capabilities.allows_annotation_delete_any("admin:room-1"));
    assert!(capabilities.allows_annotation_subscribe("chat:room-1"));
    assert!(!capabilities.allows_annotation_publish("news:room-1"));
}

#[test]
fn test_socket_id_display() {
    let id = SocketId::from_string("123.456").unwrap();
    assert_eq!(format!("{id}"), "123.456");
}

#[test]
fn test_buffer_limit_messages_only() {
    let limit = BufferLimit::Messages(1000);
    assert_eq!(limit.channel_capacity(), 1000);
    assert!(!limit.tracks_bytes());
    assert_eq!(limit.message_limit(), Some(1000));
    assert_eq!(limit.byte_limit(), None);
}

#[test]
fn test_buffer_limit_bytes_only() {
    let limit = BufferLimit::Bytes(1_048_576);
    assert_eq!(limit.channel_capacity(), 10_000);
    assert!(limit.tracks_bytes());
    assert_eq!(limit.message_limit(), None);
    assert_eq!(limit.byte_limit(), Some(1_048_576));
}

#[test]
fn test_buffer_limit_both() {
    let limit = BufferLimit::Both {
        messages: 1000,
        bytes: 1_048_576,
    };
    assert_eq!(limit.channel_capacity(), 1000);
    assert!(limit.tracks_bytes());
    assert_eq!(limit.message_limit(), Some(1000));
    assert_eq!(limit.byte_limit(), Some(1_048_576));
}

#[test]
fn test_websocket_buffer_config_default() {
    let config = WebSocketBufferConfig::default();
    assert_eq!(config.limit, BufferLimit::Messages(1000));
    assert!(config.disconnect_on_full);
    assert!(!config.tracks_bytes());
}

#[test]
fn test_byte_counter_basic() {
    let counter = ByteCounter::new();
    assert_eq!(counter.get(), 0);

    assert_eq!(counter.add(100), 100);
    assert_eq!(counter.get(), 100);

    assert_eq!(counter.add(50), 150);
    assert_eq!(counter.get(), 150);

    counter.sub(30);
    assert_eq!(counter.get(), 120);
}

#[test]
fn test_byte_counter_would_exceed() {
    let counter = ByteCounter::new();
    counter.add(900);

    assert!(!counter.would_exceed(100, 1000));
    assert!(counter.would_exceed(101, 1000));
    assert!(counter.would_exceed(200, 1000));
}

#[test]
fn test_sized_message() {
    let bytes = Bytes::from("hello world");
    let msg = SizedMessage::new(bytes.clone());
    assert_eq!(msg.size, 11);
    assert_eq!(msg.bytes, bytes);
}

#[test]
fn test_rewind_gate_buffers_and_drains_messages() {
    let mut gate = RewindGate::default();
    let message = BufferedRewindMessage {
        serial: Some(1),
        message_id: Some("msg-1".to_string()),
        message: PusherMessage {
            event: Some("evt".to_string()),
            channel: Some("chat".to_string()),
            data: None,
            name: None,
            user_id: None,
            tags: None,
            sequence: None,
            conflation_key: None,
            message_id: Some("msg-1".to_string()),
            stream_id: Some("stream-1".to_string()),
            serial: Some(1),
            idempotency_key: None,
            extras: None,
            delta_sequence: None,
            delta_conflation_key: None,
        },
    };
    gate.buffered.push(message.clone());
    let drained = std::mem::take(&mut gate.buffered);
    assert_eq!(drained.len(), 1);
    assert_eq!(drained[0].serial, Some(1));
    assert_eq!(drained[0].message_id.as_deref(), Some("msg-1"));
    assert!(gate.buffered.is_empty());
}

#[test]
fn test_websocket_buffer_config_message_limit() {
    let config = WebSocketBufferConfig::with_message_limit(500, false);
    assert_eq!(config.channel_capacity(), 500);
    assert!(!config.disconnect_on_full);
    assert!(!config.tracks_bytes());
}

#[test]
fn test_websocket_buffer_config_byte_limit() {
    let config = WebSocketBufferConfig::with_byte_limit(1_048_576, true);
    assert_eq!(config.channel_capacity(), 10_000);
    assert!(config.disconnect_on_full);
    assert!(config.tracks_bytes());
}

#[test]
fn test_websocket_buffer_config_both_limits() {
    let config = WebSocketBufferConfig::with_both_limits(1000, 1_048_576, true);
    assert_eq!(config.channel_capacity(), 1000);
    assert!(config.disconnect_on_full);
    assert!(config.tracks_bytes());
}

#[test]
fn test_websocket_buffer_config_legacy_new() {
    let config = WebSocketBufferConfig::new(500, false);
    assert_eq!(config.channel_capacity(), 500);
    assert!(!config.disconnect_on_full);
}

use futures_util::StreamExt;

type ClientWs = sockudo_ws::WebSocketStream<sockudo_ws::Stream<sockudo_ws::Http1>>;

async fn create_server_writer_with_client() -> (WebSocketWriter, ClientWs) {
    use sockudo_ws::Config as WsConfig;
    use sockudo_ws::Http1;
    use sockudo_ws::axum_integration::WebSocket;
    use sockudo_ws::client::WebSocketClient;
    use tokio::net::{TcpListener, TcpStream};

    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let local_addr = listener.local_addr().unwrap();

    let server_task: tokio::task::JoinHandle<WebSocketWriter> = tokio::spawn(async move {
        let (mut stream, _) = listener.accept().await.unwrap();
        let _ = sockudo_ws::handshake::server_handshake(&mut stream)
            .await
            .unwrap();
        let ws = WebSocket::from_tcp(stream, WsConfig::default());
        let (_reader, writer) = ws.split();
        writer
    });

    let client_stream = TcpStream::connect(local_addr).await.unwrap();
    let client = WebSocketClient::<Http1>::new(WsConfig::default());
    let (client_ws, _): (ClientWs, _) = client
        .connect(client_stream, &local_addr.to_string(), "/", None)
        .await
        .unwrap();

    let writer = server_task.await.unwrap();
    (writer, client_ws)
}

#[tokio::test]
async fn close_with_error_code_sends_error_then_close_frame() {
    use sockudo_ws::Message;

    let socket_id = SocketId::new();
    let (writer, mut client) = create_server_writer_with_client().await;
    let mut ws = WebSocket::new(socket_id, writer);

    assert!(ws.is_connected());
    let result = ws.close(4200, "Server shutting down".to_string()).await;
    assert!(result.is_ok(), "close() should succeed: {result:?}");
    assert_eq!(ws.state.status, ConnectionStatus::Closed);

    // Give the background writer task time to flush both frames.
    tokio::time::sleep(std::time::Duration::from_millis(50)).await;

    // First frame received by the client must be the text error message.
    let first = tokio::time::timeout(std::time::Duration::from_secs(1), client.next())
        .await
        .expect("timed out waiting for first frame")
        .expect("client stream ended unexpectedly")
        .expect("frame read error");

    assert!(
        matches!(first, Message::Text(_)),
        "expected text error frame first, got: {first:?}"
    );
    if let Message::Text(payload) = &first {
        let text = std::str::from_utf8(payload).expect("error frame is not UTF-8");
        assert!(
            text.contains("4200"),
            "error frame should contain code 4200, got: {text}"
        );
    }

    // Second frame must be the close frame.
    let second = tokio::time::timeout(std::time::Duration::from_secs(1), client.next())
        .await
        .expect("timed out waiting for close frame")
        .expect("client stream ended unexpectedly")
        .expect("frame read error");

    assert!(
        matches!(second, Message::Close(_)),
        "expected close frame second, got: {second:?}"
    );
}

#[tokio::test]
async fn test_send_message_serializes_and_delivers() {
    use sockudo_ws::Message;

    let socket_id = SocketId::new();
    let (writer, mut client) = create_server_writer_with_client().await;
    let ws = WebSocket::new(socket_id, writer);
    let ws_ref = WebSocketRef::new(ws);

    let msg = PusherMessage::pong();
    let result = ws_ref.send_message(&msg);
    assert!(
        result.is_ok(),
        "send_message should succeed on active connection: {result:?}"
    );

    tokio::time::sleep(std::time::Duration::from_millis(50)).await;

    let frame = tokio::time::timeout(std::time::Duration::from_secs(1), client.next())
        .await
        .expect("timed out waiting for frame")
        .expect("client stream ended unexpectedly")
        .expect("frame read error");

    assert!(
        matches!(frame, Message::Text(_)),
        "Json wire format must deliver as Text frame, got: {frame:?}"
    );
    if let Message::Text(payload) = &frame {
        let text = std::str::from_utf8(payload).expect("payload is not UTF-8");
        assert!(
            text.contains("pong"),
            "serialized payload should contain 'pong', got: {text}"
        );
    }
}

#[tokio::test]
async fn test_send_broadcast_delivers_without_lock() {
    use sockudo_ws::Message;

    let socket_id = SocketId::new();
    let (writer, mut client) = create_server_writer_with_client().await;
    let ws = WebSocket::new(socket_id, writer);
    let ws_ref = WebSocketRef::new(ws);

    let payload = Bytes::from_static(b"{\"event\":\"broadcast-test\"}");
    let result = ws_ref.send_broadcast(payload);
    assert!(
        result.is_ok(),
        "send_broadcast should succeed without acquiring the inner lock: {result:?}"
    );

    tokio::time::sleep(std::time::Duration::from_millis(50)).await;

    let frame = tokio::time::timeout(std::time::Duration::from_secs(1), client.next())
        .await
        .expect("timed out waiting for broadcast frame")
        .expect("client stream ended unexpectedly")
        .expect("frame read error");

    assert!(
        matches!(frame, Message::Text(_)),
        "broadcast must arrive at client as a Text frame, got: {frame:?}"
    );
}

#[tokio::test]
async fn test_send_after_close_returns_error() {
    use crate::error::Error;

    let socket_id = SocketId::new();
    let (writer, _client) = create_server_writer_with_client().await;
    let ws = WebSocket::new(socket_id, writer);
    let ws_ref = WebSocketRef::new(ws);

    let close_result = ws_ref.close(1000, "normal closure".to_string()).await;
    assert!(
        close_result.is_ok(),
        "close() should succeed: {close_result:?}"
    );

    let msg = PusherMessage::pong();
    let send_result = ws_ref.send_message(&msg);

    assert!(
        send_result.is_err(),
        "send_message after close must return an error, not succeed"
    );
    assert!(
        matches!(send_result.unwrap_err(), Error::ConnectionClosed(_)),
        "error variant must be Error::ConnectionClosed"
    );
}

#[tokio::test]
async fn test_send_message_respects_wire_format() {
    use sockudo_protocol::WireFormat;
    use sockudo_ws::Message;

    {
        let socket_id = SocketId::new();
        let (writer, mut client) = create_server_writer_with_client().await;
        let ws = WebSocket::new(socket_id, writer);
        let ws_ref = WebSocketRef::new(ws);

        ws_ref.send_message(&PusherMessage::pong()).unwrap();
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;

        let frame = tokio::time::timeout(std::time::Duration::from_secs(1), client.next())
            .await
            .expect("timed out (json)")
            .expect("stream ended (json)")
            .expect("read error (json)");
        assert!(
            matches!(frame, Message::Text(_)),
            "WireFormat::Json must produce a Text frame, got: {frame:?}"
        );
    }

    {
        let socket_id = SocketId::new();
        let (writer, mut client) = create_server_writer_with_client().await;
        let mut ws = WebSocket::new(socket_id, writer);
        ws.state.wire_format = WireFormat::MessagePack;
        let ws_ref = WebSocketRef::new(ws);

        ws_ref.send_message(&PusherMessage::pong()).unwrap();
        tokio::time::sleep(std::time::Duration::from_millis(50)).await;

        let frame = tokio::time::timeout(std::time::Duration::from_secs(1), client.next())
            .await
            .expect("timed out (msgpack)")
            .expect("stream ended (msgpack)")
            .expect("read error (msgpack)");
        assert!(
            matches!(frame, Message::Binary(_)),
            "WireFormat::MessagePack must produce a Binary frame, got: {frame:?}"
        );
    }
}

#[tokio::test]
async fn test_concurrent_sends_preserve_ordering() {
    let socket_id = SocketId::new();
    let (writer, mut client) = create_server_writer_with_client().await;
    let buffer_config = WebSocketBufferConfig::new(2000, true);
    let ws = WebSocket::with_buffer_config(socket_id, writer, buffer_config);
    let ws_ref = WebSocketRef::new(ws);

    let mut handles = Vec::new();
    for _ in 0..10 {
        let clone = ws_ref.clone();
        handles.push(tokio::spawn(async move {
            let mut ok_count = 0usize;
            for _ in 0..100 {
                if clone.send_message(&PusherMessage::pong()).is_ok() {
                    ok_count += 1;
                }
            }
            ok_count
        }));
    }

    let mut total_sent = 0usize;
    for h in handles {
        total_sent += h.await.expect("sender task panicked");
    }
    assert_eq!(total_sent, 1000, "all 1000 sends must succeed (no drops)");

    let mut received = 0usize;
    while received < total_sent {
        match tokio::time::timeout(std::time::Duration::from_secs(5), client.next()).await {
            Ok(Some(Ok(_))) => received += 1,
            Ok(Some(Err(e))) => panic!("client read error after {received} messages: {e}"),
            Ok(None) => break,
            Err(_) => panic!("timed out after {received}/{total_sent} messages"),
        }
    }
    assert_eq!(
        received, total_sent,
        "every sent message must arrive at client (no drops)"
    );
}

#[tokio::test]
async fn test_shutdown_token_cancels_receiver() {
    let socket_id = SocketId::new();
    let (writer, _client) = create_server_writer_with_client().await;
    let ws = WebSocket::new(socket_id, writer);
    let ws_ref = WebSocketRef::new(ws);

    let token = ws_ref.cancellation_token();
    assert!(
        !token.is_cancelled(),
        "token must not be cancelled before shutdown()"
    );

    ws_ref.shutdown();

    assert!(
        token.is_cancelled(),
        "shutdown() must cancel the CancellationToken so the receiver task exits"
    );
}