Spaces:
Runtime error
Runtime error
File size: 17,064 Bytes
330b6e4 | 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 | """
Connection management for WebSocket communications.
This module manages WebSocket connections, tracks connection status,
and provides utilities for connection lifecycle management.
"""
import logging
from datetime import datetime, timedelta
from typing import Dict, Any, Optional, List, Set
from threading import Lock
import json
import redis
logger = logging.getLogger(__name__)
class ConnectionManagerError(Exception):
"""Base exception for connection manager errors."""
pass
class ConnectionManager:
"""Manages WebSocket connections and their lifecycle."""
def __init__(self, redis_client: redis.Redis, connection_timeout: int = 300):
"""
Initialize the connection manager.
Args:
redis_client: Redis client for connection persistence
connection_timeout: Connection timeout in seconds (default: 5 minutes)
"""
self.redis_client = redis_client
self.connection_timeout = connection_timeout
self.connections_prefix = "ws_connection:"
self.session_connections_prefix = "session_connections:"
self.user_connections_prefix = "user_connections:"
# In-memory cache for active connections (faster access)
self._active_connections: Dict[str, Dict[str, Any]] = {}
self._connections_lock = Lock()
def add_connection(self, client_id: str, connection_info: Dict[str, Any]) -> None:
"""
Add a new WebSocket connection.
Args:
client_id: Unique client identifier (socket ID)
connection_info: Connection information dictionary
Raises:
ConnectionManagerError: If connection cannot be added
"""
try:
with self._connections_lock:
# Add to in-memory cache
self._active_connections[client_id] = connection_info.copy()
# Persist to Redis
connection_key = f"{self.connections_prefix}{client_id}"
self.redis_client.setex(
connection_key,
self.connection_timeout,
json.dumps(connection_info)
)
# Add to session connections set
session_id = connection_info['session_id']
session_connections_key = f"{self.session_connections_prefix}{session_id}"
self.redis_client.sadd(session_connections_key, client_id)
self.redis_client.expire(session_connections_key, self.connection_timeout)
# Add to user connections set
user_id = connection_info['user_id']
user_connections_key = f"{self.user_connections_prefix}{user_id}"
self.redis_client.sadd(user_connections_key, client_id)
self.redis_client.expire(user_connections_key, self.connection_timeout)
logger.info(f"Added connection {client_id} for session {session_id}")
except redis.RedisError as e:
logger.error(f"Redis error adding connection {client_id}: {e}")
# Keep in memory even if Redis fails
except Exception as e:
logger.error(f"Error adding connection {client_id}: {e}")
raise ConnectionManagerError(f"Failed to add connection: {e}")
def remove_connection(self, client_id: str) -> Optional[Dict[str, Any]]:
"""
Remove a WebSocket connection.
Args:
client_id: Client identifier to remove
Returns:
Optional[Dict[str, Any]]: Connection info if found, None otherwise
"""
try:
with self._connections_lock:
# Get connection info before removal
connection_info = self._active_connections.get(client_id)
if not connection_info:
# Try to get from Redis
connection_info = self._get_connection_from_redis(client_id)
if connection_info:
# Remove from in-memory cache
self._active_connections.pop(client_id, None)
# Remove from Redis
connection_key = f"{self.connections_prefix}{client_id}"
self.redis_client.delete(connection_key)
# Remove from session connections set
session_id = connection_info['session_id']
session_connections_key = f"{self.session_connections_prefix}{session_id}"
self.redis_client.srem(session_connections_key, client_id)
# Remove from user connections set
user_id = connection_info['user_id']
user_connections_key = f"{self.user_connections_prefix}{user_id}"
self.redis_client.srem(user_connections_key, client_id)
logger.info(f"Removed connection {client_id}")
return connection_info
except redis.RedisError as e:
logger.error(f"Redis error removing connection {client_id}: {e}")
# Still remove from memory
with self._connections_lock:
return self._active_connections.pop(client_id, None)
except Exception as e:
logger.error(f"Error removing connection {client_id}: {e}")
return None
def get_connection(self, client_id: str) -> Optional[Dict[str, Any]]:
"""
Get connection information.
Args:
client_id: Client identifier
Returns:
Optional[Dict[str, Any]]: Connection info if found, None otherwise
"""
try:
with self._connections_lock:
# Check in-memory cache first
connection_info = self._active_connections.get(client_id)
if connection_info:
return connection_info.copy()
# Check Redis
connection_info = self._get_connection_from_redis(client_id)
if connection_info:
# Cache in memory
self._active_connections[client_id] = connection_info.copy()
return connection_info
return None
except Exception as e:
logger.error(f"Error getting connection {client_id}: {e}")
return None
def update_connection(self, client_id: str, connection_info: Dict[str, Any]) -> bool:
"""
Update connection information.
Args:
client_id: Client identifier
connection_info: Updated connection information
Returns:
bool: True if updated successfully, False otherwise
"""
try:
with self._connections_lock:
# Update in-memory cache
if client_id in self._active_connections:
self._active_connections[client_id] = connection_info.copy()
# Update in Redis
connection_key = f"{self.connections_prefix}{client_id}"
self.redis_client.setex(
connection_key,
self.connection_timeout,
json.dumps(connection_info)
)
logger.debug(f"Updated connection {client_id}")
return True
return False
except redis.RedisError as e:
logger.error(f"Redis error updating connection {client_id}: {e}")
# Update in memory only
with self._connections_lock:
if client_id in self._active_connections:
self._active_connections[client_id] = connection_info.copy()
return True
return False
except Exception as e:
logger.error(f"Error updating connection {client_id}: {e}")
return False
def update_connection_activity(self, client_id: str) -> bool:
"""
Update connection activity timestamp.
Args:
client_id: Client identifier
Returns:
bool: True if updated successfully, False otherwise
"""
try:
connection_info = self.get_connection(client_id)
if connection_info:
connection_info['last_activity'] = datetime.utcnow().isoformat()
return self.update_connection(client_id, connection_info)
return False
except Exception as e:
logger.error(f"Error updating connection activity {client_id}: {e}")
return False
def get_session_connections(self, session_id: str) -> List[str]:
"""
Get all connection IDs for a session.
Args:
session_id: Session identifier
Returns:
List[str]: List of client IDs connected to the session
"""
try:
session_connections_key = f"{self.session_connections_prefix}{session_id}"
client_ids = self.redis_client.smembers(session_connections_key)
# Convert bytes to strings and filter active connections
active_client_ids = []
for client_id_bytes in client_ids:
client_id = client_id_bytes.decode('utf-8')
if self.get_connection(client_id):
active_client_ids.append(client_id)
else:
# Clean up stale reference
self.redis_client.srem(session_connections_key, client_id)
return active_client_ids
except redis.RedisError as e:
logger.error(f"Redis error getting session connections: {e}")
return []
except Exception as e:
logger.error(f"Error getting session connections: {e}")
return []
def get_user_connections(self, user_id: str) -> List[str]:
"""
Get all connection IDs for a user.
Args:
user_id: User identifier
Returns:
List[str]: List of client IDs connected for the user
"""
try:
user_connections_key = f"{self.user_connections_prefix}{user_id}"
client_ids = self.redis_client.smembers(user_connections_key)
# Convert bytes to strings and filter active connections
active_client_ids = []
for client_id_bytes in client_ids:
client_id = client_id_bytes.decode('utf-8')
if self.get_connection(client_id):
active_client_ids.append(client_id)
else:
# Clean up stale reference
self.redis_client.srem(user_connections_key, client_id)
return active_client_ids
except redis.RedisError as e:
logger.error(f"Redis error getting user connections: {e}")
return []
except Exception as e:
logger.error(f"Error getting user connections: {e}")
return []
def get_all_connections(self) -> Dict[str, Dict[str, Any]]:
"""
Get all active connections.
Returns:
Dict[str, Dict[str, Any]]: Dictionary of client_id -> connection_info
"""
try:
with self._connections_lock:
return self._active_connections.copy()
except Exception as e:
logger.error(f"Error getting all connections: {e}")
return {}
def cleanup_expired_connections(self) -> int:
"""
Clean up expired connections.
Returns:
int: Number of connections cleaned up
"""
try:
cleaned_count = 0
cutoff_time = datetime.utcnow() - timedelta(seconds=self.connection_timeout)
with self._connections_lock:
expired_client_ids = []
for client_id, connection_info in self._active_connections.items():
try:
connected_at = datetime.fromisoformat(connection_info['connected_at'])
last_activity = connection_info.get('last_activity')
if last_activity:
last_activity_time = datetime.fromisoformat(last_activity)
if last_activity_time < cutoff_time:
expired_client_ids.append(client_id)
elif connected_at < cutoff_time:
expired_client_ids.append(client_id)
except (ValueError, KeyError):
# Invalid timestamp, mark for cleanup
expired_client_ids.append(client_id)
# Remove expired connections
for client_id in expired_client_ids:
self.remove_connection(client_id)
cleaned_count += 1
if cleaned_count > 0:
logger.info(f"Cleaned up {cleaned_count} expired connections")
return cleaned_count
except Exception as e:
logger.error(f"Error cleaning up expired connections: {e}")
return 0
def get_connection_stats(self) -> Dict[str, Any]:
"""
Get connection statistics.
Returns:
Dict[str, Any]: Connection statistics
"""
try:
with self._connections_lock:
total_connections = len(self._active_connections)
# Count connections by session and user
sessions = set()
users = set()
languages = {}
for connection_info in self._active_connections.values():
sessions.add(connection_info['session_id'])
users.add(connection_info['user_id'])
language = connection_info.get('language', 'unknown')
languages[language] = languages.get(language, 0) + 1
return {
'total_connections': total_connections,
'unique_sessions': len(sessions),
'unique_users': len(users),
'languages': languages,
'timestamp': datetime.utcnow().isoformat()
}
except Exception as e:
logger.error(f"Error getting connection stats: {e}")
return {
'total_connections': 0,
'unique_sessions': 0,
'unique_users': 0,
'languages': {},
'timestamp': datetime.utcnow().isoformat()
}
def _get_connection_from_redis(self, client_id: str) -> Optional[Dict[str, Any]]:
"""Get connection info from Redis."""
try:
connection_key = f"{self.connections_prefix}{client_id}"
connection_data = self.redis_client.get(connection_key)
if connection_data:
return json.loads(connection_data)
return None
except (redis.RedisError, json.JSONDecodeError) as e:
logger.warning(f"Error getting connection from Redis: {e}")
return None
def create_connection_manager(redis_client: redis.Redis,
connection_timeout: int = 300) -> ConnectionManager:
"""
Factory function to create a ConnectionManager instance.
Args:
redis_client: Redis client instance
connection_timeout: Connection timeout in seconds
Returns:
ConnectionManager: Configured connection manager
"""
return ConnectionManager(redis_client, connection_timeout) |