reinhardt-server 0.1.0-rc.25

HTTP server implementation for Reinhardt framework
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
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
#[cfg(feature = "websocket")]
use futures_util::{SinkExt, StreamExt};
#[cfg(feature = "websocket")]
use std::collections::HashMap;
#[cfg(feature = "websocket")]
use std::net::SocketAddr;
#[cfg(feature = "websocket")]
use std::sync::Arc;
#[cfg(feature = "websocket")]
use tokio::net::{TcpListener, TcpStream};
#[cfg(feature = "websocket")]
use tokio::sync::{Mutex, RwLock, broadcast};
#[cfg(feature = "websocket")]
use tokio_tungstenite::{WebSocketStream, accept_async, tungstenite::Message};

#[cfg(feature = "websocket")]
use crate::shutdown::ShutdownCoordinator;

/// Type alias for WebSocket stream writer
#[cfg(feature = "websocket")]
type WsWriter = futures_util::stream::SplitSink<WebSocketStream<TcpStream>, Message>;

/// Client connection information
#[cfg(feature = "websocket")]
struct Client {
	// Allow dead_code: stored for logging and debugging WebSocket client connections
	#[allow(dead_code)]
	addr: SocketAddr,
	sender: Arc<Mutex<WsWriter>>,
}

/// Broadcast manager for WebSocket connections
#[cfg(feature = "websocket")]
#[derive(Clone)]
pub struct BroadcastManager {
	clients: Arc<RwLock<HashMap<SocketAddr, Arc<Client>>>>,
	broadcast_tx: broadcast::Sender<String>,
}

#[cfg(feature = "websocket")]
impl BroadcastManager {
	/// Create a new broadcast manager with the specified capacity
	///
	/// The capacity determines how many messages can be queued before older messages are dropped.
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_server::server::BroadcastManager;
	///
	/// let manager = BroadcastManager::new(100);
	/// ```
	pub fn new(capacity: usize) -> Self {
		let (broadcast_tx, _) = broadcast::channel(capacity);
		Self {
			clients: Arc::new(RwLock::new(HashMap::new())),
			broadcast_tx,
		}
	}

	/// Register a new client connection
	async fn register_client(&self, addr: SocketAddr, sender: WsWriter) {
		let client = Arc::new(Client {
			addr,
			sender: Arc::new(Mutex::new(sender)),
		});
		self.clients.write().await.insert(addr, client);
	}

	/// Unregister a client connection
	async fn unregister_client(&self, addr: &SocketAddr) {
		self.clients.write().await.remove(addr);
	}

	/// Broadcast a message to all connected clients
	///
	/// # Examples
	///
	/// ```no_run
	/// use reinhardt_server::server::BroadcastManager;
	///
	/// # async fn example() {
	/// let manager = BroadcastManager::new(100);
	/// manager.broadcast("Hello, everyone!".to_string()).await;
	/// # }
	/// ```
	pub async fn broadcast(&self, message: String) {
		// Send through broadcast channel (ignore if no receivers)
		let _ = self.broadcast_tx.send(message.clone());
	}

	/// Get the number of connected clients
	///
	/// # Examples
	///
	/// ```no_run
	/// use reinhardt_server::server::BroadcastManager;
	///
	/// # async fn example() {
	/// let manager = BroadcastManager::new(100);
	/// let count = manager.client_count().await;
	/// println!("Connected clients: {}", count);
	/// # }
	/// ```
	pub async fn client_count(&self) -> usize {
		self.clients.read().await.len()
	}

	/// Subscribe to broadcast messages
	fn subscribe(&self) -> broadcast::Receiver<String> {
		self.broadcast_tx.subscribe()
	}
}

/// Trait for handling WebSocket messages
#[cfg(feature = "websocket")]
#[async_trait::async_trait]
pub trait WebSocketHandler: Send + Sync {
	/// Handle an incoming WebSocket message
	async fn handle_message(&self, message: String) -> Result<String, String>;

	/// Called when a WebSocket connection is established
	async fn on_connect(&self) {}

	/// Called when a WebSocket connection is closed
	async fn on_disconnect(&self) {}
}

/// WebSocket server with broadcast support
#[cfg(feature = "websocket")]
pub struct WebSocketServer {
	handler: Arc<dyn WebSocketHandler>,
	/// Optional broadcast manager for sending messages to multiple connected clients.
	pub broadcast_manager: Option<BroadcastManager>,
}

#[cfg(feature = "websocket")]
impl WebSocketServer {
	/// Create a new WebSocket server with the given handler
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_server::server::WebSocketServer;
	/// use reinhardt_server::server::WebSocketHandler;
	///
	/// struct EchoHandler;
	///
	/// #[async_trait::async_trait]
	/// impl WebSocketHandler for EchoHandler {
	///     async fn handle_message(&self, message: String) -> Result<String, String> {
	///         Ok(format!("Echo: {}", message))
	///     }
	/// }
	///
	/// let server = WebSocketServer::new(EchoHandler);
	/// ```
	pub fn new<H: WebSocketHandler + 'static>(handler: H) -> Self {
		Self {
			handler: Arc::new(handler),
			broadcast_manager: None,
		}
	}

	/// Enable broadcast support with the specified capacity
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_server::server::WebSocketServer;
	/// use reinhardt_server::server::WebSocketHandler;
	///
	/// struct EchoHandler;
	///
	/// #[async_trait::async_trait]
	/// impl WebSocketHandler for EchoHandler {
	///     async fn handle_message(&self, message: String) -> Result<String, String> {
	///         Ok(format!("Echo: {}", message))
	///     }
	/// }
	///
	/// let server = WebSocketServer::new(EchoHandler)
	///     .with_broadcast(100);
	/// ```
	pub fn with_broadcast(mut self, capacity: usize) -> Self {
		self.broadcast_manager = Some(BroadcastManager::new(capacity));
		self
	}

	/// Create a new WebSocketServer from an existing `Arc<dyn WebSocketHandler>`
	///
	/// This is useful when you already have a handler wrapped in Arc,
	/// such as in test fixtures or dependency injection scenarios.
	///
	/// # Examples
	///
	/// ```
	/// use std::sync::Arc;
	/// use reinhardt_server::server::WebSocketServer;
	/// use reinhardt_server::server::WebSocketHandler;
	///
	/// struct EchoHandler;
	///
	/// #[async_trait::async_trait]
	/// impl WebSocketHandler for EchoHandler {
	///     async fn handle_message(&self, message: String) -> Result<String, String> {
	///         Ok(format!("Echo: {}", message))
	///     }
	/// }
	///
	/// let handler: Arc<dyn WebSocketHandler> = Arc::new(EchoHandler);
	/// let server = WebSocketServer::from_arc(handler);
	/// ```
	pub fn from_arc(handler: Arc<dyn WebSocketHandler>) -> Self {
		Self {
			handler,
			broadcast_manager: None,
		}
	}

	/// Get a reference to the broadcast manager if enabled
	///
	/// # Examples
	///
	/// ```
	/// use reinhardt_server::server::WebSocketServer;
	/// use reinhardt_server::server::WebSocketHandler;
	///
	/// struct EchoHandler;
	///
	/// #[async_trait::async_trait]
	/// impl WebSocketHandler for EchoHandler {
	///     async fn handle_message(&self, message: String) -> Result<String, String> {
	///         Ok(format!("Echo: {}", message))
	///     }
	/// }
	///
	/// # async fn example() {
	/// let server = WebSocketServer::new(EchoHandler)
	///     .with_broadcast(100);
	///
	/// if let Some(manager) = server.broadcast_manager() {
	///     manager.broadcast("Hello!".to_string()).await;
	/// }
	/// # }
	/// ```
	pub fn broadcast_manager(&self) -> Option<&BroadcastManager> {
		self.broadcast_manager.as_ref()
	}
	/// Start the WebSocket server and listen on the given address
	///
	/// This method starts the server and begins accepting WebSocket connections.
	/// It runs indefinitely until an error occurs.
	///
	/// # Examples
	///
	/// ```no_run
	/// use std::net::SocketAddr;
	/// use reinhardt_server::server::WebSocketServer;
	/// use reinhardt_server::server::WebSocketHandler;
	///
	/// struct EchoHandler;
	///
	/// #[async_trait::async_trait]
	/// impl WebSocketHandler for EchoHandler {
	///     async fn handle_message(&self, message: String) -> Result<String, String> {
	///         Ok(message)
	///     }
	/// }
	///
	/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
	/// let server = WebSocketServer::new(EchoHandler);
	/// let addr: SocketAddr = "127.0.0.1:9001".parse()?;
	/// server.listen(addr).await?;
	/// # Ok(())
	/// # }
	/// ```
	pub async fn listen(self, addr: SocketAddr) -> Result<(), Box<dyn std::error::Error>> {
		let listener = TcpListener::bind(addr).await?;
		println!("WebSocket server listening on ws://{}", addr);

		let broadcast_manager = self.broadcast_manager.clone();

		loop {
			let (stream, peer_addr) = listener.accept().await?;
			let handler = self.handler.clone();
			let manager = broadcast_manager.clone();

			tokio::spawn(async move {
				if let Err(e) = Self::handle_connection(stream, handler, peer_addr, manager).await {
					eprintln!("Error handling WebSocket connection: {:?}", e);
				}
			});
		}
	}

	/// Start the WebSocket server with graceful shutdown support
	///
	/// This method starts the server and listens for connections until a shutdown
	/// signal is received via the coordinator. It supports graceful shutdown.
	///
	/// # Examples
	///
	/// ```no_run
	/// use std::net::SocketAddr;
	/// use std::time::Duration;
	/// use reinhardt_server::server::{WebSocketServer, ShutdownCoordinator};
	/// use reinhardt_server::server::WebSocketHandler;
	///
	/// struct EchoHandler;
	///
	/// #[async_trait::async_trait]
	/// impl WebSocketHandler for EchoHandler {
	///     async fn handle_message(&self, message: String) -> Result<String, String> {
	///         Ok(message)
	///     }
	/// }
	///
	/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
	/// let server = WebSocketServer::new(EchoHandler);
	/// let addr: SocketAddr = "127.0.0.1:9001".parse()?;
	/// let coordinator = ShutdownCoordinator::new(Duration::from_secs(30));
	/// server.listen_with_shutdown(addr, coordinator).await?;
	/// # Ok(())
	/// # }
	/// ```
	pub async fn listen_with_shutdown(
		self,
		addr: SocketAddr,
		coordinator: ShutdownCoordinator,
	) -> Result<(), Box<dyn std::error::Error>> {
		let listener = TcpListener::bind(addr).await?;
		println!("WebSocket server listening on ws://{}", addr);

		let broadcast_manager = self.broadcast_manager.clone();
		let mut shutdown_rx = coordinator.subscribe();

		loop {
			tokio::select! {
				result = listener.accept() => {
					let (stream, peer_addr) = result?;
					let handler = self.handler.clone();
					let manager = broadcast_manager.clone();
					let mut conn_shutdown = coordinator.subscribe();

					tokio::spawn(async move {
						tokio::select! {
							result = Self::handle_connection(stream, handler, peer_addr, manager) => {
								if let Err(e) = result {
									eprintln!("Error handling WebSocket connection: {:?}", e);
								}
							}
							_ = conn_shutdown.recv() => {
								// Connection interrupted by shutdown
							}
						}
					});
				}
				_ = shutdown_rx.recv() => {
					println!("Shutdown signal received, stopping WebSocket server...");
					break;
				}
			}
		}

		coordinator.notify_shutdown_complete();
		Ok(())
	}

	/// Handle a single WebSocket connection
	///
	/// This is an internal method used by the server to process individual WebSocket connections.
	/// It manages the WebSocket handshake, message handling, and connection lifecycle.
	///
	/// # Examples
	///
	/// ```no_run
	/// use std::sync::Arc;
	/// use std::net::SocketAddr;
	/// use tokio::net::TcpStream;
	/// use reinhardt_server::server::WebSocketServer;
	/// use reinhardt_server::server::WebSocketHandler;
	///
	/// struct EchoHandler;
	///
	/// #[async_trait::async_trait]
	/// impl WebSocketHandler for EchoHandler {
	///     async fn handle_message(&self, message: String) -> Result<String, String> {
	///         Ok(message)
	///     }
	/// }
	///
	/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
	/// let addr: SocketAddr = "127.0.0.1:9001".parse()?;
	/// let stream = TcpStream::connect(addr).await?;
	/// WebSocketServer::handle_connection(stream, Arc::new(EchoHandler), addr, None).await?;
	/// # Ok(())
	/// # }
	/// ```
	pub async fn handle_connection(
		stream: TcpStream,
		handler: Arc<dyn WebSocketHandler>,
		peer_addr: SocketAddr,
		broadcast_manager: Option<BroadcastManager>,
	) -> Result<(), Box<dyn std::error::Error>> {
		#[cfg(debug_assertions)]
		eprintln!("[ws:debug] new connection from: {}", peer_addr);

		let ws_stream = accept_async(stream).await?;
		let (write, mut read) = ws_stream.split();

		// Register client if broadcast is enabled, or keep write for direct use
		let mut direct_write = if let Some(ref manager) = broadcast_manager {
			manager.register_client(peer_addr, write).await;
			None
		} else {
			Some(write)
		};

		let use_broadcast = broadcast_manager.is_some();

		// Notify handler of connection
		handler.on_connect().await;

		// Subscribe to broadcast messages if enabled
		let mut broadcast_rx = broadcast_manager.as_ref().map(|m| m.subscribe());

		// Handle messages
		loop {
			tokio::select! {
				// Handle incoming messages from client
				message = read.next() => {
					match message {
						Some(Ok(msg)) => {
							if msg.is_text() {
								let text = msg.to_text()?;
								#[cfg(debug_assertions)]
								eprintln!("[ws:trace] text message from peer ({} bytes)", text.len());

								// Process message through handler
								match handler.handle_message(text.to_string()).await {
									Ok(response) => {
										if use_broadcast {
											// Broadcast mode: send through broadcast manager
											if let Some(ref manager) = broadcast_manager
												&& let Some(clients) = manager.clients.read().await.get(&peer_addr) {
													let mut sender = clients.sender.lock().await;
													sender.send(Message::Text(response.into())).await?;
												}
										} else if let Some(ref mut w) = direct_write {
											// Normal mode: send directly
											w.send(Message::Text(response.into())).await?;
										}
									}
									Err(error) => {
										if use_broadcast {
											if let Some(ref manager) = broadcast_manager
												&& let Some(clients) = manager.clients.read().await.get(&peer_addr) {
													let mut sender = clients.sender.lock().await;
													sender.send(Message::Text(error.into())).await?;
												}
										} else if let Some(ref mut w) = direct_write {
											w.send(Message::Text(error.into())).await?;
										}
									}
								}
							} else if msg.is_binary() {
								let data = msg.into_data();
								#[cfg(debug_assertions)]
								eprintln!("[ws:trace] binary message from peer ({} bytes)", data.len());

								// Echo binary messages directly back to client
								if use_broadcast {
									// Broadcast mode: send through broadcast manager
									if let Some(ref manager) = broadcast_manager
										&& let Some(clients) = manager.clients.read().await.get(&peer_addr) {
											let mut sender = clients.sender.lock().await;
											sender.send(Message::Binary(data)).await?;
										}
								} else if let Some(ref mut w) = direct_write {
									// Normal mode: send directly
									w.send(Message::Binary(data)).await?;
								}
							} else if msg.is_close() {
								#[cfg(debug_assertions)]
								eprintln!("[ws:debug] connection closing for peer");
								// Send close frame response before closing
								if use_broadcast {
									if let Some(ref manager) = broadcast_manager
										&& let Some(clients) = manager.clients.read().await.get(&peer_addr) {
											let mut sender = clients.sender.lock().await;
											let _ = sender.send(Message::Close(None)).await;
											// Flush to ensure close frame is sent before disconnecting
											let _ = sender.flush().await;
										}
								} else if let Some(ref mut w) = direct_write {
									let _ = w.send(Message::Close(None)).await;
									// Flush to ensure close frame is sent before disconnecting
									let _ = w.flush().await;
								}
								// Brief delay to ensure client receives close frame (RFC 6455 compliance)
								tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;
								break;
							}
						}
						Some(Err(e)) => {
							eprintln!("WebSocket error: {}", e);
							break;
						}
						None => break,
					}
				}
				// Handle broadcast messages
				broadcast_msg = async {
					match &mut broadcast_rx {
						Some(rx) => rx.recv().await.ok(),
						None => std::future::pending().await,
					}
				} => {
					if let Some(msg) = broadcast_msg
						&& let Some(ref manager) = broadcast_manager
							&& let Some(client) = manager.clients.read().await.get(&peer_addr) {
								let mut sender = client.sender.lock().await;
								if let Err(e) = sender.send(Message::Text(msg.into())).await {
									eprintln!("Failed to send broadcast message: {}", e);
									break;
								}
							}
				}
			}
		}

		// Unregister client if broadcast is enabled
		if let Some(ref manager) = broadcast_manager {
			manager.unregister_client(&peer_addr).await;
		}

		// Notify handler of disconnection
		handler.on_disconnect().await;

		#[cfg(debug_assertions)]
		eprintln!("[ws:debug] connection closed for peer");
		Ok(())
	}
}

/// Helper function to create and run a WebSocket server
///
/// This is a convenience function that creates a `WebSocketServer` and starts listening.
///
/// # Examples
///
/// ```no_run
/// use std::net::SocketAddr;
/// use reinhardt_server::server::serve_websocket;
/// use reinhardt_server::server::WebSocketHandler;
///
/// struct ChatHandler;
///
/// #[async_trait::async_trait]
/// impl WebSocketHandler for ChatHandler {
///     async fn handle_message(&self, message: String) -> Result<String, String> {
///         Ok(format!("Received: {}", message))
///     }
///
///     async fn on_connect(&self) {
///         println!("Client connected");
///     }
///
///     async fn on_disconnect(&self) {
///         println!("Client disconnected");
///     }
/// }
///
/// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
/// let addr: SocketAddr = "127.0.0.1:9001".parse()?;
/// serve_websocket(addr, ChatHandler).await?;
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "websocket")]
pub async fn serve_websocket<H: WebSocketHandler + 'static>(
	addr: SocketAddr,
	handler: H,
) -> Result<(), Box<dyn std::error::Error>> {
	let server = WebSocketServer::new(handler);
	server.listen(addr).await
}

#[cfg(all(test, feature = "websocket"))]
mod tests {
	use super::*;

	struct EchoHandler;

	#[async_trait::async_trait]
	impl WebSocketHandler for EchoHandler {
		async fn handle_message(&self, message: String) -> Result<String, String> {
			Ok(format!("Echo: {}", message))
		}
	}

	#[tokio::test]
	async fn test_websocket_server_creation() {
		let _server = WebSocketServer::new(EchoHandler);
	}

	#[tokio::test]
	async fn test_websocket_server_with_broadcast() {
		let _server = WebSocketServer::new(EchoHandler).with_broadcast(100);
	}

	#[tokio::test]
	async fn test_broadcast_manager_creation() {
		let manager = BroadcastManager::new(50);
		assert_eq!(manager.client_count().await, 0);
	}

	#[tokio::test]
	async fn test_broadcast_manager_broadcast() {
		let manager = BroadcastManager::new(50);

		// Subscribe before broadcasting
		let mut rx = manager.subscribe();

		// Broadcast a message
		manager.broadcast("Hello!".to_string()).await;

		// Receive the message
		let received = rx.recv().await.unwrap();
		assert_eq!(received, "Hello!");
	}

	#[tokio::test]
	async fn test_broadcast_manager_multiple_subscribers() {
		let manager = BroadcastManager::new(50);

		// Subscribe multiple receivers
		let mut rx1 = manager.subscribe();
		let mut rx2 = manager.subscribe();
		let mut rx3 = manager.subscribe();

		// Broadcast a message
		manager.broadcast("Broadcast message".to_string()).await;

		// All receivers should get the message
		assert_eq!(rx1.recv().await.unwrap(), "Broadcast message");
		assert_eq!(rx2.recv().await.unwrap(), "Broadcast message");
		assert_eq!(rx3.recv().await.unwrap(), "Broadcast message");
	}
}