tideway 0.7.17

A batteries-included Rust web framework built on Axum for building SaaS applications quickly
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

#[cfg(feature = "websocket")]
#[cfg(test)]
mod websocket_tests {
    use crate::error::TidewayError;
    use crate::websocket::{Connection, ConnectionManager, Message};
    use std::sync::Arc;
    use tokio::sync::mpsc;

    #[tokio::test]
    async fn test_connection_manager_register_unregister() {
        let manager = ConnectionManager::new();

        // Create a mock connection (using bounded channel as expected by Connection)
        let (tx, _rx) = mpsc::channel::<Message>(16);
        let conn = Arc::new(tokio::sync::RwLock::new(Connection::new(
            "test-conn-1".to_string(),
            tx,
        )));

        // Register
        assert!(manager.register(conn.clone()).await.is_ok());
        assert_eq!(manager.connection_count(), 1);

        // Unregister
        manager.unregister("test-conn-1").await;
        assert_eq!(manager.connection_count(), 0);
    }

    #[tokio::test]
    async fn test_room_operations() {
        let manager = Arc::new(ConnectionManager::new());

        // Create connections (using bounded channel as expected by Connection)
        let (tx1, _rx1) = mpsc::channel::<Message>(16);
        let conn1 = Arc::new(tokio::sync::RwLock::new(Connection::new(
            "conn-1".to_string(),
            tx1,
        )));

        let (tx2, _rx2) = mpsc::channel::<Message>(16);
        let conn2 = Arc::new(tokio::sync::RwLock::new(Connection::new(
            "conn-2".to_string(),
            tx2,
        )));

        // Register connections
        assert!(manager.register(conn1.clone()).await.is_ok());
        assert!(manager.register(conn2.clone()).await.is_ok());

        // Add to room
        manager.add_to_room("conn-1", "room-1");
        manager.add_to_room("conn-2", "room-1");

        // Check room members
        let members = manager.room_members("room-1");
        assert_eq!(members.len(), 2);
        assert!(members.contains(&"conn-1".to_string()));
        assert!(members.contains(&"conn-2".to_string()));

        // Remove from room
        manager.remove_from_room("conn-1", "room-1");
        let members = manager.room_members("room-1");
        assert_eq!(members.len(), 1);
        assert_eq!(members[0], "conn-2");
    }

    #[tokio::test]
    async fn test_broadcast_to_room() {
        let manager = Arc::new(ConnectionManager::new());

        // Create connections with receivers (using bounded channel as expected by Connection)
        let (tx1, mut rx1) = mpsc::channel::<Message>(16);
        let conn1 = Arc::new(tokio::sync::RwLock::new(Connection::new(
            "conn-1".to_string(),
            tx1,
        )));

        let (tx2, mut rx2) = mpsc::channel::<Message>(16);
        let conn2 = Arc::new(tokio::sync::RwLock::new(Connection::new(
            "conn-2".to_string(),
            tx2,
        )));

        // Register and add to room
        assert!(manager.register(conn1.clone()).await.is_ok());
        assert!(manager.register(conn2.clone()).await.is_ok());
        manager.add_to_room("conn-1", "room-1");
        manager.add_to_room("conn-2", "room-1");

        // Broadcast to room
        manager
            .broadcast_text_to_room("room-1", "Hello room!")
            .await
            .unwrap();

        // Check messages received
        let msg1 = rx1.recv().await.unwrap();
        let msg2 = rx2.recv().await.unwrap();

        assert!(matches!(msg1, Message::Text(ref t) if t == "Hello room!"));
        assert!(matches!(msg2, Message::Text(ref t) if t == "Hello room!"));
    }

    #[tokio::test]
    async fn test_broadcast_does_not_unregister_on_lock_contention() {
        use tokio::time::{Duration, timeout};

        let manager = Arc::new(ConnectionManager::new());

        let (tx, mut rx) = mpsc::channel::<Message>(16);
        let conn = Arc::new(tokio::sync::RwLock::new(Connection::new(
            "conn-1".to_string(),
            tx,
        )));

        assert!(manager.register(conn.clone()).await.is_ok());
        assert_eq!(manager.connection_count(), 1);

        let (lock_acquired_tx, lock_acquired_rx) = tokio::sync::oneshot::channel();
        let conn_for_lock = conn.clone();
        let hold_lock = tokio::spawn(async move {
            let _guard = conn_for_lock.write().await;
            let _ = lock_acquired_tx.send(());
            tokio::time::sleep(Duration::from_millis(50)).await;
        });

        // Ensure the write lock is held before broadcasting.
        let _ = lock_acquired_rx.await;

        // Broadcast should wait for lock contention, not treat it as a dead connection.
        assert!(manager.broadcast_text("hello").await.is_ok());
        hold_lock.await.unwrap();

        let received = timeout(Duration::from_millis(250), rx.recv())
            .await
            .expect("message should be delivered")
            .expect("channel should still be open");
        assert!(matches!(received, Message::Text(ref t) if t == "hello"));
        assert_eq!(manager.connection_count(), 1);
    }

    #[tokio::test]
    async fn test_unregister_cleans_stale_room_membership_after_lock_contention() {
        let manager = Arc::new(ConnectionManager::new());

        let (tx, _rx) = mpsc::channel::<Message>(16);
        let conn = Arc::new(tokio::sync::RwLock::new(Connection::new(
            "conn-1".to_string(),
            tx,
        )));

        assert!(manager.register(conn.clone()).await.is_ok());

        // Hold a write lock so add_to_room can't update connection-local room state.
        let conn_write_guard = conn.write().await;
        manager.add_to_room("conn-1", "room-1");
        drop(conn_write_guard);

        // Manager room index contains the member even though local state missed the update.
        assert_eq!(manager.room_members("room-1").len(), 1);

        manager.unregister("conn-1").await;

        // Unregister should fully clean stale room membership.
        assert!(manager.room_members("room-1").is_empty());
        assert_eq!(manager.room_count(), 0);
    }

    #[tokio::test]
    async fn test_connection_limit_enforced() {
        // Create manager with limit of 2 connections
        let manager = ConnectionManager::with_max_connections(2);

        // Create 3 connections
        let (tx1, _rx1) = mpsc::channel::<Message>(16);
        let conn1 = Arc::new(tokio::sync::RwLock::new(Connection::new(
            "conn-1".to_string(),
            tx1,
        )));

        let (tx2, _rx2) = mpsc::channel::<Message>(16);
        let conn2 = Arc::new(tokio::sync::RwLock::new(Connection::new(
            "conn-2".to_string(),
            tx2,
        )));

        let (tx3, _rx3) = mpsc::channel::<Message>(16);
        let conn3 = Arc::new(tokio::sync::RwLock::new(Connection::new(
            "conn-3".to_string(),
            tx3,
        )));

        // First two should succeed
        assert!(manager.register(conn1).await.is_ok());
        assert!(manager.register(conn2).await.is_ok());
        assert_eq!(manager.connection_count(), 2);

        // Third should be rejected
        let result = manager.register(conn3).await;
        assert!(result.is_err());
        assert_eq!(manager.connection_count(), 2);

        // Error should be service unavailable
        if let Err(TidewayError::ServiceUnavailable(msg)) = result {
            assert!(msg.contains("connection limit"));
        } else {
            panic!("Expected ServiceUnavailable error");
        }
    }

    #[tokio::test]
    async fn test_connection_limit_after_unregister() {
        // Create manager with limit of 1 connection
        let manager = ConnectionManager::with_max_connections(1);

        let (tx1, _rx1) = mpsc::channel::<Message>(16);
        let conn1 = Arc::new(tokio::sync::RwLock::new(Connection::new(
            "conn-1".to_string(),
            tx1,
        )));

        let (tx2, _rx2) = mpsc::channel::<Message>(16);
        let conn2 = Arc::new(tokio::sync::RwLock::new(Connection::new(
            "conn-2".to_string(),
            tx2,
        )));

        // First should succeed
        assert!(manager.register(conn1).await.is_ok());
        assert_eq!(manager.connection_count(), 1);

        // Second should fail (at limit)
        assert!(manager.register(conn2.clone()).await.is_err());

        // Unregister first connection
        manager.unregister("conn-1").await;
        assert_eq!(manager.connection_count(), 0);

        // Now second should succeed
        assert!(manager.register(conn2).await.is_ok());
        assert_eq!(manager.connection_count(), 1);
    }

    #[tokio::test]
    async fn test_concurrent_registration_respects_limit() {
        use std::sync::atomic::{AtomicUsize, Ordering};

        // Test that concurrent registrations don't exceed the limit
        // This tests the CAS-based atomic registration
        let manager = Arc::new(ConnectionManager::with_max_connections(5));
        let success_count = Arc::new(AtomicUsize::new(0));
        let failure_count = Arc::new(AtomicUsize::new(0));

        let mut handles = vec![];

        // Spawn 20 concurrent tasks trying to register
        for i in 0..20 {
            let manager = manager.clone();
            let success_count = success_count.clone();
            let failure_count = failure_count.clone();

            handles.push(tokio::spawn(async move {
                let (tx, _rx) = mpsc::channel::<Message>(16);
                let conn = Arc::new(tokio::sync::RwLock::new(Connection::new(
                    format!("conn-{}", i),
                    tx,
                )));

                match manager.register(conn).await {
                    Ok(_) => {
                        success_count.fetch_add(1, Ordering::Relaxed);
                    }
                    Err(_) => {
                        failure_count.fetch_add(1, Ordering::Relaxed);
                    }
                }
            }));
        }

        // Wait for all tasks to complete
        for handle in handles {
            handle.await.unwrap();
        }

        // Verify: exactly 5 succeeded (the limit)
        let successes = success_count.load(Ordering::Relaxed);
        let failures = failure_count.load(Ordering::Relaxed);

        assert_eq!(successes, 5, "Exactly 5 connections should have succeeded");
        assert_eq!(failures, 15, "15 connections should have been rejected");
        assert_eq!(
            manager.connection_count(),
            5,
            "Connection count should be exactly 5"
        );
    }
}