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
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
use crate::protocol::{
ClientMessage, ErrorCode, GameDataEncoding, PlayerNameRulesPayload, ProtocolInfoPayload,
RateLimitInfo, ServerMessage,
};
use crate::server::{EnhancedGameServer, RegisterClientError};
use axum::extract::ws::{Message, WebSocket};
use futures_util::{SinkExt, StreamExt};
use std::net::SocketAddr;
use std::sync::Arc;
use std::time::Duration;
use tokio::sync::mpsc;
use tokio::sync::mpsc::error::TrySendError;
use tokio::time::Instant;
use super::batching::{send_batch, MessageBatcher};
use super::sending::{send_immediate_server_message, send_single_message};
use super::token_binding::{parse_client_message, TokenBindingHandshake};
pub(super) async fn handle_socket(
socket: WebSocket,
server: Arc<EnhancedGameServer>,
addr: SocketAddr,
token_binding: Option<TokenBindingHandshake>,
) {
let (mut sender, mut receiver) = socket.split();
let queue_capacity = server.config().websocket_config.batch_size.max(1) * 4;
let (tx, mut rx) = mpsc::channel::<Arc<ServerMessage>>(queue_capacity);
// Keep a clone of tx for sending auth responses
let tx_clone = tx.clone();
// Register client with server
let player_id = match server.register_client(tx, addr).await {
Ok(player_id) => {
tracing::info!(%player_id, client_addr = %addr, "WebSocket connection established");
player_id
}
Err(RegisterClientError::IpLimitExceeded { current, limit }) => {
let error_message = ServerMessage::Error {
message: format!("Too many connections from your IP ({current}/{limit})"),
error_code: Some(ErrorCode::TooManyConnections),
};
if let Err(err) = send_immediate_server_message(&mut sender, &error_message).await {
tracing::debug!(
client_addr = %addr,
error = %err,
"Failed to send IP limit error frame"
);
}
let _ = sender.close().await;
return;
}
};
// Track authentication state
let mut authenticated = !server.config().auth_enabled; // Auto-authenticated if auth disabled
// Track connection time for authentication timeout
let connection_start = Instant::now();
let auth_timeout = Duration::from_secs(server.config().websocket_config.auth_timeout_secs);
// Spawn task to handle outgoing messages
let server_clone = server.clone();
let player_id_clone = player_id;
let send_task = tokio::spawn(async move {
let config = server_clone.config();
let batching_enabled = config.websocket_config.enable_batching;
let batch_size = config.websocket_config.batch_size;
let batch_interval_ms = config.websocket_config.batch_interval_ms;
if batching_enabled {
// Batching mode: collect multiple messages and send together
let mut batcher = MessageBatcher::new(batch_size, batch_interval_ms);
let mut flush_interval =
tokio::time::interval(Duration::from_millis(batch_interval_ms));
flush_interval.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
loop {
tokio::select! {
// Receive new message from channel
message_opt = rx.recv() => {
if let Some(message) = message_opt {
batcher.queue(message);
// Flush if batch is full or time threshold exceeded
if batcher.should_flush()
&& send_batch(
&mut sender,
&mut batcher,
&player_id_clone,
&server_clone,
)
.await
.is_err()
{
break;
}
} else {
// Channel closed, flush remaining messages and exit
if !batcher.is_empty() {
let _ = send_batch(
&mut sender,
&mut batcher,
&player_id_clone,
&server_clone,
)
.await;
}
break;
}
}
// Periodic flush based on time interval
_ = flush_interval.tick() => {
if !batcher.is_empty()
&& batcher.should_flush()
&& send_batch(
&mut sender,
&mut batcher,
&player_id_clone,
&server_clone,
)
.await
.is_err()
{
break;
}
}
}
}
} else {
// Non-batching mode: send each message immediately (legacy behavior)
while let Some(message) = rx.recv().await {
if send_single_message(&mut sender, message, &player_id_clone, &server_clone)
.await
.is_err()
{
break;
}
}
}
// Cleanup when send task ends
server_clone.unregister_client(&player_id_clone).await;
});
// Handle incoming messages
let token_binding_for_receive = token_binding.clone();
let server_clone = server.clone();
let auth_timeout_secs = server.config().websocket_config.auth_timeout_secs;
let receive_task = tokio::spawn(async move {
let token_binding = token_binding_for_receive;
// Create authentication timeout timer
let auth_deadline = tokio::time::sleep_until(connection_start + auth_timeout);
tokio::pin!(auth_deadline);
loop {
let msg = if authenticated {
// If authenticated, no timeout needed
match receiver.next().await {
Some(msg) => msg,
None => break, // Connection closed
}
} else {
// If not authenticated, enforce timeout
tokio::select! {
msg_opt = receiver.next() => {
match msg_opt {
Some(msg) => msg,
None => break, // Connection closed
}
}
() = &mut auth_deadline => {
// Authentication timeout
tracing::warn!(%player_id, timeout_secs = auth_timeout_secs, "Authentication timeout, closing connection");
let _ = server_clone
.send_error_to_player(
&player_id,
format!("Authentication timeout - must authenticate within {auth_timeout_secs} seconds"),
Some(ErrorCode::AuthenticationTimeout),
)
.await;
break;
}
}
};
// Process the message
let msg = match msg {
Ok(msg) => msg,
Err(e) => {
tracing::warn!(%player_id, "WebSocket error: {}", e);
break;
}
};
match msg {
Message::Text(text) => {
// Check message size limit
let max_size = server_clone.config().max_message_size;
if text.len() > max_size {
tracing::warn!(
%player_id,
size = text.len(),
max = max_size,
"Message exceeds size limit"
);
let _ = server_clone
.send_error_to_player(
&player_id,
format!(
"Message too large ({} bytes, max {} bytes)",
text.len(),
max_size
),
Some(ErrorCode::MessageTooLarge),
)
.await;
continue;
}
let client_message = match parse_client_message(&text, token_binding.as_ref()) {
Ok(message) => message,
Err(err) => {
tracing::warn!(
%player_id,
error = %err,
"Rejected client WebSocket frame"
);
let _ = server_clone
.send_error_to_player(
&player_id,
err.user_message().to_string(),
Some(err.error_code()),
)
.await;
if err.should_disconnect() {
break;
}
continue;
}
};
match client_message {
ClientMessage::Authenticate {
app_id,
sdk_version,
platform,
game_data_format,
} => {
if authenticated {
tracing::warn!(%player_id, "Client already authenticated");
continue;
}
// Validate App ID
match server_clone.auth_middleware.validate_app_id(&app_id).await {
Ok(info) => {
let compatibility = match server_clone
.protocol_config()
.sdk_compatibility
.evaluate(platform.as_deref(), sdk_version.as_deref())
{
Ok(report) => report,
Err(err) => {
let error_message = err.to_string();
tracing::warn!(
%player_id,
app_id = %app_id,
?sdk_version,
?platform,
error = %error_message,
"SDK compatibility check failed"
);
if let Err(err) = tx_clone.try_send(Arc::new(
ServerMessage::AuthenticationError {
error: error_message,
error_code: ErrorCode::SdkVersionUnsupported,
},
)) {
if matches!(err, TrySendError::Full(_)) {
server_clone
.metrics()
.increment_websocket_messages_dropped();
}
tracing::warn!(
%player_id,
error = %err,
"Failed to enqueue SDK compatibility error"
);
}
continue;
}
};
authenticated = true;
server_clone.set_client_app_info(&player_id, info.clone());
server_clone.apply_app_bandwidth_policy(&info);
let supported_formats = server_clone
.protocol_config()
.supported_game_data_formats();
let negotiated_format = match game_data_format {
Some(format) if supported_formats.contains(&format) => {
format
}
Some(format) => {
let supported_list: Vec<String> = supported_formats
.iter()
.map(|f| format!("{f:?}"))
.collect();
let error_message = format!(
"Requested game data format {:?} is not supported. Server supports: {}. Falling back to JSON.",
format,
supported_list.join(", ")
);
tracing::warn!(
%player_id,
?format,
?supported_formats,
"Client requested unsupported game_data_format"
);
// Send error message to client about capability mismatch
if let Err(err) =
tx_clone.try_send(Arc::new(ServerMessage::Error {
message: error_message,
error_code: Some(
ErrorCode::UnsupportedGameDataFormat,
),
}))
{
if matches!(err, TrySendError::Full(_)) {
server_clone
.metrics()
.increment_websocket_messages_dropped();
}
tracing::warn!(
%player_id,
error = %err,
"Failed to enqueue game data format error"
);
}
GameDataEncoding::Json
}
None => GameDataEncoding::Json,
};
server_clone
.set_client_game_data_format(&player_id, negotiated_format);
tracing::info!(
%player_id,
app_name = %info.name,
app_id = %app_id,
?sdk_version,
?platform,
"Client authenticated"
);
// Send success response
let auth_response = ServerMessage::Authenticated {
app_name: info.name.clone(),
organization: info.organization.clone(),
rate_limits: RateLimitInfo {
per_minute: info.rate_limits.per_minute,
per_hour: info.rate_limits.per_hour,
per_day: info.rate_limits.per_day,
},
};
let player_name_rules =
PlayerNameRulesPayload::from_protocol_config(
server_clone.protocol_config(),
);
let protocol_info =
ServerMessage::ProtocolInfo(ProtocolInfoPayload {
platform: compatibility.platform.clone(),
sdk_version: compatibility.sdk_version.clone(),
minimum_version: compatibility.minimum_version.clone(),
recommended_version: compatibility
.recommended_version
.clone(),
capabilities: compatibility.capabilities.clone(),
notes: compatibility.notes.clone(),
game_data_formats: supported_formats,
player_name_rules: Some(player_name_rules),
});
if let Err(err) = tx_clone.try_send(Arc::new(auth_response)) {
if matches!(err, TrySendError::Full(_)) {
server_clone
.metrics()
.increment_websocket_messages_dropped();
}
tracing::warn!(
%player_id,
error = %err,
"Failed to enqueue authentication success response"
);
}
if let Err(err) = tx_clone.try_send(Arc::new(protocol_info)) {
if matches!(err, TrySendError::Full(_)) {
server_clone
.metrics()
.increment_websocket_messages_dropped();
}
tracing::warn!(
%player_id,
error = %err,
"Failed to enqueue protocol info response"
);
}
}
Err(e) => {
tracing::warn!(%player_id, %app_id, "Authentication failed: {:?}", e);
// Send error response.
// The AppIdExpired, AppIdRevoked, and AppIdSuspended
// variants are not currently returned by
// `validate_app_id`, but are retained for future
// backend implementations (e.g., app status management
// or admin-controlled app suspension).
let error_code = match e {
crate::auth::AuthError::InvalidAppId => {
ErrorCode::InvalidAppId
}
crate::auth::AuthError::AppIdExpired => {
ErrorCode::AppIdExpired
}
crate::auth::AuthError::AppIdRevoked => {
ErrorCode::AppIdRevoked
}
crate::auth::AuthError::AppIdSuspended => {
ErrorCode::AppIdSuspended
}
crate::auth::AuthError::RateLimitExceeded => {
ErrorCode::RateLimitExceeded
}
_ => ErrorCode::InternalError,
};
let auth_error = Arc::new(ServerMessage::AuthenticationError {
error: format!("{e:?}"),
error_code,
});
if let Err(err) = tx_clone.try_send(auth_error) {
if matches!(err, TrySendError::Full(_)) {
server_clone
.metrics()
.increment_websocket_messages_dropped();
}
tracing::warn!(
%player_id,
error = %err,
"Failed to enqueue authentication failure response"
);
}
// Close connection after auth failure
break;
}
}
}
other => {
if !authenticated {
tracing::warn!(%player_id, "Received message before authentication");
let _ = server_clone
.send_error_to_player(
&player_id,
"Authentication required".to_string(),
Some(ErrorCode::MissingAppId),
)
.await;
break;
}
server_clone.handle_client_message(&player_id, other).await;
}
}
}
Message::Binary(payload) => {
if !authenticated {
tracing::warn!(%player_id, "Received binary message before authentication");
let _ = server_clone
.send_error_to_player(
&player_id,
"Authentication required before sending binary data".to_string(),
Some(ErrorCode::MissingAppId),
)
.await;
break;
}
let encoding = server_clone.client_game_data_format(&player_id);
if encoding == GameDataEncoding::Json {
tracing::warn!(
%player_id,
"Client negotiated JSON game data but sent binary payload; dropping"
);
let _ = server_clone
.send_error_to_player(
&player_id,
"Binary payloads are disabled for this connection".to_string(),
Some(ErrorCode::InvalidInput),
)
.await;
continue;
}
// Payload from axum WebSocket is already Bytes - pass directly for zero-copy
server_clone
.handle_game_data_binary(&player_id, encoding, payload)
.await;
}
Message::Close(_) => {
tracing::info!(%player_id, "WebSocket connection closed");
break;
}
Message::Pong(_) => {
// Handle pong as ping response
server_clone
.handle_client_message(&player_id, ClientMessage::Ping)
.await;
}
_ => {
// Ignore other message types
}
}
}
// Cleanup when receive task ends
server_clone.unregister_client(&player_id).await;
});
// Wait for either task to complete
tokio::select! {
_ = send_task => {
tracing::info!(%player_id, "Send task completed");
}
_ = receive_task => {
tracing::info!(%player_id, "Receive task completed");
}
}
// Ensure cleanup
server.unregister_client(&player_id).await;
}
#[cfg(test)]
mod tests {
use super::*;
use crate::database::DatabaseConfig;
use crate::protocol::{ClientMessage, ServerMessage};
use crate::server::ServerConfig;
use std::net::SocketAddr;
use tokio_tungstenite::{connect_async, tungstenite::Message as TungsteniteMessage};
#[tokio::test(flavor = "multi_thread")]
async fn test_websocket_connection() {
// Add overall test timeout to prevent infinite hanging
let test_result = tokio::time::timeout(
tokio::time::Duration::from_secs(30),
test_websocket_connection_impl(),
)
.await;
match test_result {
Ok(_) => {} // Test completed successfully
Err(_) => panic!("Test timed out after 30 seconds"),
}
}
async fn test_websocket_connection_impl() {
// Start test server
let addr: SocketAddr = match "127.0.0.1:0".parse() {
Ok(addr) => addr,
Err(e) => {
tracing::error!("Failed to parse test address: {}", e);
return;
}
};
let listener = match tokio::net::TcpListener::bind(addr).await {
Ok(listener) => listener,
Err(e) => {
tracing::error!("Failed to bind test listener: {}", e);
return;
}
};
let addr = match listener.local_addr() {
Ok(addr) => addr,
Err(e) => {
tracing::error!("Failed to get local address: {}", e);
return;
}
};
let database_config = DatabaseConfig::InMemory;
let game_server = match EnhancedGameServer::new(
ServerConfig::default(),
crate::config::ProtocolConfig::default(),
crate::config::RelayTypeConfig::default(),
database_config,
crate::config::MetricsConfig::default(),
crate::config::AuthMaintenanceConfig::default(),
crate::config::CoordinationConfig::default(),
crate::config::TransportSecurityConfig::default(),
Vec::new(),
)
.await
{
Ok(server) => server,
Err(e) => {
tracing::error!("Failed to create game server: {}", e);
return;
}
};
let app =
super::super::routes::create_router("http://localhost:3000").with_state(game_server);
tokio::spawn(async move {
if let Err(e) = axum::serve(
listener,
app.into_make_service_with_connect_info::<SocketAddr>(),
)
.await
{
tracing::error!("Test server failed: {}", e);
}
});
// Give server time to start (longer timeout for CI environments)
tokio::time::sleep(tokio::time::Duration::from_millis(2000)).await;
// Connect to WebSocket with timeout
let url = format!("ws://{addr}/ws");
let (ws_stream, _) =
match tokio::time::timeout(tokio::time::Duration::from_secs(10), connect_async(&url))
.await
{
Ok(Ok((stream, response))) => (stream, response),
Ok(Err(e)) => {
tracing::error!("Failed to connect to WebSocket: {}", e);
return;
}
Err(_) => {
tracing::error!("WebSocket connection timed out after 10 seconds");
return;
}
};
let (mut ws_sender, mut ws_receiver) = ws_stream.split();
// Send join room message
let join_message = ClientMessage::JoinRoom {
game_name: "test_game".to_string(),
room_code: None,
player_name: "TestPlayer".to_string(),
max_players: Some(4),
supports_authority: Some(true),
relay_transport: None,
};
let json_message = match serde_json::to_string(&join_message) {
Ok(json) => json,
Err(e) => {
tracing::error!("Failed to serialize join message: {}", e);
return;
}
};
if let Err(e) = ws_sender
.send(TungsteniteMessage::Text(json_message.into()))
.await
{
tracing::error!("Failed to send WebSocket message: {}", e);
return;
}
// Receive response with timeout
let msg =
match tokio::time::timeout(tokio::time::Duration::from_secs(5), ws_receiver.next())
.await
{
Ok(Some(msg)) => msg,
Ok(None) => {
tracing::error!("WebSocket connection closed unexpectedly");
return;
}
Err(_) => {
tracing::error!("Timeout waiting for WebSocket response after 5 seconds");
return;
}
};
let msg = match msg {
Ok(msg) => msg,
Err(e) => {
tracing::error!("Failed to receive WebSocket message: {}", e);
return;
}
};
if let TungsteniteMessage::Text(text) = msg {
let server_message: ServerMessage = match serde_json::from_str(&text) {
Ok(msg) => msg,
Err(e) => {
tracing::error!("Failed to deserialize server message: {}", e);
return;
}
};
match server_message {
ServerMessage::RoomJoined(_) => {
// Success!
// Success, no action needed
}
ServerMessage::RoomJoinFailed { reason, .. } => {
tracing::error!("Failed to join room: {reason}");
panic!("Room join failed: {reason}");
}
_ => {
tracing::error!("Unexpected message type: {:?}", server_message);
panic!("Unexpected message type");
}
}
}
}
}