File size: 15,684 Bytes
1762def |
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 |
"""
WebSocket message batching for improved performance.
This module implements message batching to reduce WebSocket overhead
by combining multiple messages before sending.
"""
import asyncio
from typing import List, Dict, Any, Optional, Set
from datetime import datetime, timedelta
from dataclasses import dataclass, field
import time
from src.core import get_logger
from src.core.json_utils import dumps
logger = get_logger(__name__)
@dataclass
class BatchedMessage:
"""A message waiting to be sent."""
connection_id: str
message: Dict[str, Any]
timestamp: float = field(default_factory=time.time)
priority: int = 0 # Higher priority = sent sooner
class MessageBatcher:
"""
WebSocket message batcher for improved performance.
Features:
- Batches messages to reduce overhead
- Priority-based message ordering
- Automatic flush on size/time thresholds
- Per-connection batching
- Compression support
"""
def __init__(
self,
batch_size: int = 10,
batch_interval_ms: int = 50,
max_batch_bytes: int = 64 * 1024, # 64KB
enable_compression: bool = True
):
"""
Initialize message batcher.
Args:
batch_size: Maximum messages per batch
batch_interval_ms: Maximum time to wait before sending
max_batch_bytes: Maximum batch size in bytes
enable_compression: Enable message compression
"""
self.batch_size = batch_size
self.batch_interval_ms = batch_interval_ms
self.max_batch_bytes = max_batch_bytes
self.enable_compression = enable_compression
# Message queues per connection
self._queues: Dict[str, List[BatchedMessage]] = {}
# Active connections
self._connections: Dict[str, Any] = {}
# Flush tasks
self._flush_tasks: Dict[str, asyncio.Task] = {}
# Statistics
self._stats = {
"messages_queued": 0,
"messages_sent": 0,
"batches_sent": 0,
"bytes_sent": 0,
"compression_ratio": 0.0
}
# Lock for thread safety
self._lock = asyncio.Lock()
async def register_connection(self, connection_id: str, websocket: Any):
"""
Register a WebSocket connection.
Args:
connection_id: Unique connection ID
websocket: WebSocket connection object
"""
async with self._lock:
self._connections[connection_id] = websocket
self._queues[connection_id] = []
logger.info(f"Registered WebSocket connection: {connection_id}")
async def unregister_connection(self, connection_id: str):
"""
Unregister a WebSocket connection.
Args:
connection_id: Connection ID to remove
"""
async with self._lock:
# Cancel flush task if exists
if connection_id in self._flush_tasks:
self._flush_tasks[connection_id].cancel()
del self._flush_tasks[connection_id]
# Clear queue
if connection_id in self._queues:
del self._queues[connection_id]
# Remove connection
if connection_id in self._connections:
del self._connections[connection_id]
logger.info(f"Unregistered WebSocket connection: {connection_id}")
async def queue_message(
self,
connection_id: str,
message: Dict[str, Any],
priority: int = 0
):
"""
Queue a message for batched sending.
Args:
connection_id: Target connection
message: Message to send
priority: Message priority (higher = sent sooner)
"""
async with self._lock:
if connection_id not in self._connections:
logger.warning(f"Connection {connection_id} not registered")
return
# Add message to queue
batched_msg = BatchedMessage(
connection_id=connection_id,
message=message,
priority=priority
)
self._queues[connection_id].append(batched_msg)
self._stats["messages_queued"] += 1
# Check if we should flush immediately
should_flush = await self._should_flush(connection_id)
if should_flush:
await self._flush_connection(connection_id)
elif connection_id not in self._flush_tasks:
# Schedule flush task
self._flush_tasks[connection_id] = asyncio.create_task(
self._scheduled_flush(connection_id)
)
async def broadcast_message(
self,
message: Dict[str, Any],
connection_ids: Optional[Set[str]] = None,
priority: int = 0
):
"""
Broadcast a message to multiple connections.
Args:
message: Message to broadcast
connection_ids: Target connections (all if None)
priority: Message priority
"""
if connection_ids is None:
connection_ids = set(self._connections.keys())
# Queue for each connection
for conn_id in connection_ids:
await self.queue_message(conn_id, message, priority)
async def flush_all(self):
"""Force flush all pending messages."""
async with self._lock:
for connection_id in list(self._connections.keys()):
await self._flush_connection(connection_id)
async def _should_flush(self, connection_id: str) -> bool:
"""Check if we should flush messages for a connection."""
queue = self._queues.get(connection_id, [])
if not queue:
return False
# Check batch size
if len(queue) >= self.batch_size:
return True
# Check message age
oldest_msg = queue[0]
age_ms = (time.time() - oldest_msg.timestamp) * 1000
if age_ms >= self.batch_interval_ms:
return True
# Check batch byte size
batch_size = sum(
len(dumps(msg.message))
for msg in queue
)
if batch_size >= self.max_batch_bytes:
return True
# Check for high priority messages
if any(msg.priority > 5 for msg in queue):
return True
return False
async def _scheduled_flush(self, connection_id: str):
"""Scheduled flush task for a connection."""
try:
await asyncio.sleep(self.batch_interval_ms / 1000.0)
async with self._lock:
await self._flush_connection(connection_id)
except asyncio.CancelledError:
pass
finally:
async with self._lock:
if connection_id in self._flush_tasks:
del self._flush_tasks[connection_id]
async def _flush_connection(self, connection_id: str):
"""
Flush pending messages for a connection.
Note: Must be called with lock held.
"""
queue = self._queues.get(connection_id, [])
if not queue:
return
websocket = self._connections.get(connection_id)
if not websocket:
return
try:
# Sort by priority (descending) and timestamp (ascending)
queue.sort(key=lambda m: (-m.priority, m.timestamp))
# Take batch
batch = queue[:self.batch_size]
self._queues[connection_id] = queue[self.batch_size:]
# Create batch message
batch_data = {
"type": "batch",
"timestamp": datetime.utcnow().isoformat(),
"messages": [msg.message for msg in batch],
"count": len(batch)
}
# Serialize
message_str = dumps(batch_data)
message_bytes = message_str.encode("utf-8")
# Compress if enabled
if self.enable_compression and len(message_bytes) > 1024:
import gzip
compressed = gzip.compress(message_bytes)
if len(compressed) < len(message_bytes):
# Send compressed
await websocket.send_bytes(compressed)
# Update stats
self._stats["compression_ratio"] = (
1.0 - len(compressed) / len(message_bytes)
)
else:
# Send uncompressed
await websocket.send_text(message_str)
else:
# Send uncompressed
await websocket.send_text(message_str)
# Update statistics
self._stats["messages_sent"] += len(batch)
self._stats["batches_sent"] += 1
self._stats["bytes_sent"] += len(message_bytes)
logger.debug(
f"Sent batch of {len(batch)} messages to {connection_id}"
)
except Exception as e:
logger.error(f"Failed to flush messages for {connection_id}: {e}")
# Put messages back in queue
self._queues[connection_id] = batch + self._queues[connection_id]
def get_stats(self) -> Dict[str, Any]:
"""Get batcher statistics."""
return {
**self._stats,
"active_connections": len(self._connections),
"pending_messages": sum(
len(queue) for queue in self._queues.values()
),
"avg_batch_size": (
self._stats["messages_sent"] / self._stats["batches_sent"]
if self._stats["batches_sent"] > 0 else 0
)
}
class WebSocketManager:
"""
Enhanced WebSocket manager with message batching.
Manages WebSocket connections and provides batched messaging.
"""
def __init__(
self,
batch_size: int = 10,
batch_interval_ms: int = 50,
enable_compression: bool = True
):
"""
Initialize WebSocket manager.
Args:
batch_size: Maximum messages per batch
batch_interval_ms: Maximum time to wait before sending
enable_compression: Enable message compression
"""
self.batcher = MessageBatcher(
batch_size=batch_size,
batch_interval_ms=batch_interval_ms,
enable_compression=enable_compression
)
# Room management
self._rooms: Dict[str, Set[str]] = {}
self._connection_rooms: Dict[str, Set[str]] = {}
async def connect(self, connection_id: str, websocket: Any):
"""
Connect a WebSocket client.
Args:
connection_id: Unique connection ID
websocket: WebSocket connection object
"""
await self.batcher.register_connection(connection_id, websocket)
self._connection_rooms[connection_id] = set()
# Send welcome message
await self.send_message(
connection_id,
{
"type": "connected",
"connection_id": connection_id,
"timestamp": datetime.utcnow().isoformat()
},
priority=10 # High priority
)
async def disconnect(self, connection_id: str):
"""
Disconnect a WebSocket client.
Args:
connection_id: Connection to disconnect
"""
# Leave all rooms
if connection_id in self._connection_rooms:
for room in list(self._connection_rooms[connection_id]):
await self.leave_room(connection_id, room)
del self._connection_rooms[connection_id]
# Unregister from batcher
await self.batcher.unregister_connection(connection_id)
async def join_room(self, connection_id: str, room: str):
"""
Add connection to a room.
Args:
connection_id: Connection ID
room: Room name
"""
if room not in self._rooms:
self._rooms[room] = set()
self._rooms[room].add(connection_id)
if connection_id in self._connection_rooms:
self._connection_rooms[connection_id].add(room)
logger.info(f"Connection {connection_id} joined room {room}")
async def leave_room(self, connection_id: str, room: str):
"""
Remove connection from a room.
Args:
connection_id: Connection ID
room: Room name
"""
if room in self._rooms:
self._rooms[room].discard(connection_id)
if not self._rooms[room]:
del self._rooms[room]
if connection_id in self._connection_rooms:
self._connection_rooms[connection_id].discard(room)
logger.info(f"Connection {connection_id} left room {room}")
async def send_message(
self,
connection_id: str,
message: Dict[str, Any],
priority: int = 0
):
"""
Send a message to a specific connection.
Args:
connection_id: Target connection
message: Message to send
priority: Message priority
"""
await self.batcher.queue_message(connection_id, message, priority)
async def send_to_room(
self,
room: str,
message: Dict[str, Any],
exclude: Optional[Set[str]] = None,
priority: int = 0
):
"""
Send a message to all connections in a room.
Args:
room: Target room
message: Message to send
exclude: Connections to exclude
priority: Message priority
"""
if room not in self._rooms:
return
connections = self._rooms[room]
if exclude:
connections = connections - exclude
await self.batcher.broadcast_message(message, connections, priority)
async def broadcast(
self,
message: Dict[str, Any],
priority: int = 0
):
"""
Broadcast a message to all connections.
Args:
message: Message to broadcast
priority: Message priority
"""
await self.batcher.broadcast_message(message, priority=priority)
async def flush_all(self):
"""Force flush all pending messages."""
await self.batcher.flush_all()
def get_stats(self) -> Dict[str, Any]:
"""Get manager statistics."""
return {
"batcher": self.batcher.get_stats(),
"rooms": {
room: len(connections)
for room, connections in self._rooms.items()
},
"total_connections": len(self._connection_rooms)
}
# Global WebSocket manager instance
websocket_manager = WebSocketManager(
batch_size=20,
batch_interval_ms=50,
enable_compression=True
) |