Merge branch 'main' into fix/1535

Merge PR #1651: feat: add WebSocket load testing infrastructure (#1505)

index.html

@@ -395,6 +395,7 @@
 <div id="memory-connections-panel" class="memory-connections-panel" style="display:none;" aria-label="Memory Connections Panel"></div>
 
 <script src="./boot.js"></script>
+<script src="./js/heartbeat.js"></script>
 <script src="./avatar-customization.js"></script>
 <script src="./lod-system.js"></script>
 <script>

js/heartbeat.js

@@ -0,0 +1,293 @@
+/**
+ * WebSocket Heartbeat Client for The Nexus
+ * Issue #1535: feat: WebSocket heartbeat with auto-reconnect from client
+ * 
+ * Provides:
+ * - Client sends heartbeat ping every 30s
+ * - Server responds with pong + user count
+ * - Client auto-reconnects on missed 2 heartbeats
+ * - Reconnect preserves user position/identity
+ */
+
+class NexusHeartbeat {
+    constructor(options = {}) {
+        this.heartbeatInterval = options.heartbeatInterval || 30000; // 30 seconds
+        this.maxMissedHeartbeats = options.maxMissedHeartbeats || 2;
+        this.reconnectDelay = options.reconnectDelay || 1000; // 1 second
+        this.maxReconnectDelay = options.maxReconnectDelay || 30000; // 30 seconds
+        
+        this.ws = null;
+        this.heartbeatTimer = null;
+        this.missedHeartbeats = 0;
+        this.isConnected = false;
+        this.userId = options.userId || this.generateUserId();
+        this.position = options.position || { x: 0, y: 0, z: 0 };
+        this.reconnectAttempts = 0;
+        
+        // Callbacks
+        this.onConnect = options.onConnect || (() => {});
+        this.onDisconnect = options.onDisconnect || (() => {});
+        this.onHeartbeat = options.onHeartbeat || (() => {});
+        this.onUserCount = options.onUserCount || (() => {});
+        this.onError = options.onError || console.error;
+        
+        // Bind methods
+        this.connect = this.connect.bind(this);
+        this.disconnect = this.disconnect.bind(this);
+        this.sendHeartbeat = this.sendHeartbeat.bind(this);
+        this.handleMessage = this.handleMessage.bind(this);
+        this.handleClose = this.handleClose.bind(this);
+        this.handleError = this.handleError.bind(this);
+    }
+    
+    generateUserId() {
+        return 'user_' + Math.random().toString(36).substr(2, 9);
+    }
+    
+    connect(url) {
+        if (this.ws && this.ws.readyState === WebSocket.OPEN) {
+            console.warn('Already connected');
+            return;
+        }
+        
+        this.url = url;
+        console.log(`Connecting to ${url}...`);
+        
+        try {
+            this.ws = new WebSocket(url);
+            this.ws.onopen = this.handleOpen.bind(this);
+            this.ws.onmessage = this.handleMessage;
+            this.ws.onclose = this.handleClose;
+            this.ws.onerror = this.handleError;
+        } catch (error) {
+            this.onError('Failed to create WebSocket:', error);
+            this.scheduleReconnect();
+        }
+    }
+    
+    disconnect() {
+        console.log('Disconnecting...');
+        
+        // Stop heartbeat
+        this.stopHeartbeat();
+        
+        // Close WebSocket
+        if (this.ws) {
+            this.ws.onclose = null; // Prevent reconnect on manual disconnect
+            this.ws.close(1000, 'Manual disconnect');
+            this.ws = null;
+        }
+        
+        this.isConnected = false;
+        this.missedHeartbeats = 0;
+        this.reconnectAttempts = 0;
+    }
+    
+    handleOpen() {
+        console.log('Connected to WebSocket');
+        this.isConnected = true;
+        this.missedHeartbeats = 0;
+        this.reconnectAttempts = 0;
+        
+        // Send reconnect message with user info
+        this.sendReconnect();
+        
+        // Start heartbeat
+        this.startHeartbeat();
+        
+        // Call connect callback
+        this.onConnect();
+    }
+    
+    handleMessage(event) {
+        try {
+            const data = JSON.parse(event.data);
+            
+            if (data.type === 'pong') {
+                // Reset missed heartbeats
+                this.missedHeartbeats = 0;
+                
+                // Update user count
+                if (data.user_count !== undefined) {
+                    this.onUserCount(data.user_count);
+                }
+                
+                // Call heartbeat callback
+                this.onHeartbeat(data);
+                
+                console.debug('Heartbeat pong received');
+            } else if (data.type === 'health') {
+                // Health check response
+                console.debug('Health check:', data);
+            } else {
+                // Regular message
+                console.debug('Message received:', data);
+            }
+        } catch (error) {
+            // Not JSON or parse error
+            console.debug('Non-JSON message received:', event.data);
+        }
+    }
+    
+    handleClose(event) {
+        console.log(`WebSocket closed: ${event.code} ${event.reason}`);
+        this.isConnected = false;
+        this.stopHeartbeat();
+        
+        // Call disconnect callback
+        this.onDisconnect(event);
+        
+        // Schedule reconnect if not manual disconnect
+        if (event.code !== 1000) {
+            this.scheduleReconnect();
+        }
+    }
+    
+    handleError(error) {
+        this.onError('WebSocket error:', error);
+    }
+    
+    startHeartbeat() {
+        if (this.heartbeatTimer) {
+            clearInterval(this.heartbeatTimer);
+        }
+        
+        console.log(`Starting heartbeat every ${this.heartbeatInterval / 1000}s`);
+        
+        this.heartbeatTimer = setInterval(() => {
+            this.sendHeartbeat();
+        }, this.heartbeatInterval);
+        
+        // Send initial heartbeat
+        this.sendHeartbeat();
+    }
+    
+    stopHeartbeat() {
+        if (this.heartbeatTimer) {
+            clearInterval(this.heartbeatTimer);
+            this.heartbeatTimer = null;
+        }
+    }
+    
+    sendHeartbeat() {
+        if (!this.isConnected || !this.ws || this.ws.readyState !== WebSocket.OPEN) {
+            console.warn('Cannot send heartbeat: not connected');
+            return;
+        }
+        
+        const heartbeat = {
+            type: 'heartbeat',
+            timestamp: Date.now(),
+            user_id: this.userId,
+            position: this.position
+        };
+        
+        try {
+            this.ws.send(JSON.stringify(heartbeat));
+            console.debug('Heartbeat sent');
+            
+            // Check for missed heartbeats
+            this.missedHeartbeats++;
+            if (this.missedHeartbeats > this.maxMissedHeartbeats) {
+                console.warn(`Missed ${this.missedHeartbeats} heartbeats, reconnecting...`);
+                this.ws.close(4000, 'Missed heartbeats');
+            }
+        } catch (error) {
+            this.onError('Failed to send heartbeat:', error);
+            this.ws.close(4001, 'Heartbeat send failed');
+        }
+    }
+    
+    sendReconnect() {
+        if (!this.isConnected || !this.ws || this.ws.readyState !== WebSocket.OPEN) {
+            console.warn('Cannot send reconnect: not connected');
+            return;
+        }
+        
+        const reconnect = {
+            type: 'reconnect',
+            timestamp: Date.now(),
+            user_id: this.userId,
+            position: this.position
+        };
+        
+        try {
+            this.ws.send(JSON.stringify(reconnect));
+            console.log('Reconnect message sent');
+        } catch (error) {
+            this.onError('Failed to send reconnect:', error);
+        }
+    }
+    
+    scheduleReconnect() {
+        if (this.reconnectAttempts >= 10) {
+            console.error('Max reconnect attempts reached');
+            return;
+        }
+        
+        // Exponential backoff
+        const delay = Math.min(
+            this.reconnectDelay * Math.pow(2, this.reconnectAttempts),
+            this.maxReconnectDelay
+        );
+        
+        console.log(`Reconnecting in ${delay / 1000}s (attempt ${this.reconnectAttempts + 1})...`);
+        
+        setTimeout(() => {
+            this.reconnectAttempts++;
+            this.connect(this.url);
+        }, delay);
+    }
+    
+    updatePosition(x, y, z) {
+        this.position = { x, y, z };
+        
+        // Send position update if connected
+        if (this.isConnected && this.ws && this.ws.readyState === WebSocket.OPEN) {
+            const update = {
+                type: 'position',
+                timestamp: Date.now(),
+                user_id: this.userId,
+                position: this.position
+            };
+            
+            try {
+                this.ws.send(JSON.stringify(update));
+            } catch (error) {
+                console.warn('Failed to send position update:', error);
+            }
+        }
+    }
+    
+    getUserId() {
+        return this.userId;
+    }
+    
+    getPosition() {
+        return { ...this.position };
+    }
+    
+    isConnectionActive() {
+        return this.isConnected && this.ws && this.ws.readyState === WebSocket.OPEN;
+    }
+    
+    getStats() {
+        return {
+            connected: this.isConnected,
+            userId: this.userId,
+            position: this.position,
+            missedHeartbeats: this.missedHeartbeats,
+            reconnectAttempts: this.reconnectAttempts
+        };
+    }
+}
+
+// Export for use in other modules
+if (typeof module !== 'undefined' && module.exports) {
+    module.exports = NexusHeartbeat;
+}
+
+// Global instance for browser use
+if (typeof window !== 'undefined') {
+    window.NexusHeartbeat = NexusHeartbeat;
+}

server.py

@@ -3,20 +3,34 @@
 The Nexus WebSocket Gateway — Robust broadcast bridge for Timmy's consciousness.
 This server acts as the central hub for the-nexus, connecting the mind (nexus_think.py),
 the body (Evennia/Morrowind), and the visualization surface.
+
+Security features:
+- Binds to 127.0.0.1 by default (localhost only)
+- Optional external binding via NEXUS_WS_HOST environment variable
+- Token-based authentication via NEXUS_WS_TOKEN environment variable
+- Rate limiting on connections
+- Connection logging and monitoring
 """
 import asyncio
 import json
 import logging
+import os
 import signal
 import sys
-from typing import Set
+import time
+from typing import Set, Dict, Optional
+from collections import defaultdict
 
 # Branch protected file - see POLICY.md
 import websockets
 
 # Configuration
-PORT = 8765
-HOST = "0.0.0.0"  # Allow external connections if needed
+PORT = int(os.environ.get("NEXUS_WS_PORT", "8765"))
+HOST = os.environ.get("NEXUS_WS_HOST", "127.0.0.1")  # Default to localhost only
+AUTH_TOKEN = os.environ.get("NEXUS_WS_TOKEN", "")  # Empty = no auth required
+RATE_LIMIT_WINDOW = 60  # seconds
+RATE_LIMIT_MAX_CONNECTIONS = 10  # max connections per IP per window
+RATE_LIMIT_MAX_MESSAGES = 100  # max messages per connection per window
 
 # Logging setup
 logging.basicConfig(
@@ -28,15 +42,97 @@ logger = logging.getLogger("nexus-gateway")
 
 # State
 clients: Set[websockets.WebSocketServerProtocol] = set()
+connection_tracker: Dict[str, list] = defaultdict(list)  # IP -> [timestamps]
+message_tracker: Dict[int, list] = defaultdict(list)  # connection_id -> [timestamps]
+
+def check_rate_limit(ip: str) -> bool:
+    """Check if IP has exceeded connection rate limit."""
+    now = time.time()
+    # Clean old entries
+    connection_tracker[ip] = [t for t in connection_tracker[ip] if now - t < RATE_LIMIT_WINDOW]
+    
+    if len(connection_tracker[ip]) >= RATE_LIMIT_MAX_CONNECTIONS:
+        return False
+    
+    connection_tracker[ip].append(now)
+    return True
+
+def check_message_rate_limit(connection_id: int) -> bool:
+    """Check if connection has exceeded message rate limit."""
+    now = time.time()
+    # Clean old entries
+    message_tracker[connection_id] = [t for t in message_tracker[connection_id] if now - t < RATE_LIMIT_WINDOW]
+    
+    if len(message_tracker[connection_id]) >= RATE_LIMIT_MAX_MESSAGES:
+        return False
+    
+    message_tracker[connection_id].append(now)
+    return True
+
+async def authenticate_connection(websocket: websockets.WebSocketServerProtocol) -> bool:
+    """Authenticate WebSocket connection using token."""
+    if not AUTH_TOKEN:
+        # No authentication required
+        return True
+    
+    try:
+        # Wait for authentication message (first message should be auth)
+        auth_message = await asyncio.wait_for(websocket.recv(), timeout=5.0)
+        auth_data = json.loads(auth_message)
+        
+        if auth_data.get("type") != "auth":
+            logger.warning(f"Invalid auth message type from {websocket.remote_address}")
+            return False
+        
+        token = auth_data.get("token", "")
+        if token != AUTH_TOKEN:
+            logger.warning(f"Invalid auth token from {websocket.remote_address}")
+            return False
+        
+        logger.info(f"Authenticated connection from {websocket.remote_address}")
+        return True
+        
+    except asyncio.TimeoutError:
+        logger.warning(f"Authentication timeout from {websocket.remote_address}")
+        return False
+    except json.JSONDecodeError:
+        logger.warning(f"Invalid auth JSON from {websocket.remote_address}")
+        return False
+    except Exception as e:
+        logger.error(f"Authentication error from {websocket.remote_address}: {e}")
+        return False
 
 async def broadcast_handler(websocket: websockets.WebSocketServerProtocol):
     """Handles individual client connections and message broadcasting."""
-    clients.add(websocket)
     addr = websocket.remote_address
+    ip = addr[0] if addr else "unknown"
+    connection_id = id(websocket)
+    
+    # Check connection rate limit
+    if not check_rate_limit(ip):
+        logger.warning(f"Connection rate limit exceeded for {ip}")
+        await websocket.close(1008, "Rate limit exceeded")
+        return
+    
+    # Authenticate if token is required
+    if not await authenticate_connection(websocket):
+        await websocket.close(1008, "Authentication failed")
+        return
+    
+    clients.add(websocket)
     logger.info(f"Client connected from {addr}. Total clients: {len(clients)}")
     
     try:
         async for message in websocket:
+            # Check message rate limit
+            if not check_message_rate_limit(connection_id):
+                logger.warning(f"Message rate limit exceeded for {addr}")
+                await websocket.send(json.dumps({
+                    "type": "error",
+                    "message": "Message rate limit exceeded"
+                }))
+                continue
+            
             # Parse for logging/validation if it's JSON
             try:
                 data = json.loads(message)
@@ -81,6 +177,20 @@ async def broadcast_handler(websocket: websockets.WebSocketServerProtocol):
 
 async def main():
     """Main server loop with graceful shutdown."""
+    # Log security configuration
+    if AUTH_TOKEN:
+        logger.info("Authentication: ENABLED (token required)")
+    else:
+        logger.warning("Authentication: DISABLED (no token required)")
+    
+    if HOST == "0.0.0.0":
+        logger.warning("Host binding: 0.0.0.0 (all interfaces) - SECURITY RISK")
+    else:
+        logger.info(f"Host binding: {HOST} (localhost only)")
+    
+    logger.info(f"Rate limiting: {RATE_LIMIT_MAX_CONNECTIONS} connections/IP/{RATE_LIMIT_WINDOW}s, "
+                f"{RATE_LIMIT_MAX_MESSAGES} messages/connection/{RATE_LIMIT_WINDOW}s")
+    
     logger.info(f"Starting Nexus WS gateway on ws://{HOST}:{PORT}")
     
     # Set up signal handlers for graceful shutdown

tests/load/websocket_load_test.py

@@ -0,0 +1,193 @@
+#!/usr/bin/env python3
+"""
+WebSocket Load Test — Benchmark concurrent user sessions on the Nexus gateway.
+
+Tests:
+- Concurrent WebSocket connections
+- Message throughput under load
+- Memory profiling per connection
+- Connection failure/recovery
+
+Usage:
+    python3 tests/load/websocket_load_test.py                    # default (50 users)
+    python3 tests/load/websocket_load_test.py --users 200        # 200 concurrent
+    python3 tests/load/websocket_load_test.py --duration 60      # 60 second test
+    python3 tests/load/websocket_load_test.py --json             # JSON output
+
+Ref: #1505
+"""
+
+import asyncio
+import json
+import os
+import sys
+import time
+import argparse
+from dataclasses import dataclass, field
+from typing import List, Optional
+
+WS_URL = os.environ.get("WS_URL", "ws://localhost:8765")
+
+
+@dataclass
+class ConnectionStats:
+    connected: bool = False
+    connect_time_ms: float = 0
+    messages_sent: int = 0
+    messages_received: int = 0
+    errors: int = 0
+    latencies: List[float] = field(default_factory=list)
+    disconnected: bool = False
+
+
+async def ws_client(user_id: int, duration: int, stats: ConnectionStats, ws_url: str = WS_URL):
+    """Single WebSocket client for load testing."""
+    try:
+        import websockets
+    except ImportError:
+        # Fallback: use raw asyncio
+        stats.errors += 1
+        return
+
+    try:
+        start = time.time()
+        async with websockets.connect(ws_url, open_timeout=5) as ws:
+            stats.connect_time_ms = (time.time() - start) * 1000
+            stats.connected = True
+
+            # Send periodic messages for the duration
+            end_time = time.time() + duration
+            msg_count = 0
+            while time.time() < end_time:
+                try:
+                    msg_start = time.time()
+                    message = json.dumps({
+                        "type": "chat",
+                        "user": f"load-test-{user_id}",
+                        "content": f"Load test message {msg_count} from user {user_id}",
+                    })
+                    await ws.send(message)
+                    stats.messages_sent += 1
+
+                    # Wait for response (with timeout)
+                    try:
+                        response = await asyncio.wait_for(ws.recv(), timeout=5.0)
+                        stats.messages_received += 1
+                        latency = (time.time() - msg_start) * 1000
+                        stats.latencies.append(latency)
+                    except asyncio.TimeoutError:
+                        stats.errors += 1
+
+                    msg_count += 1
+                    await asyncio.sleep(0.5)  # 2 messages/sec per user
+
+                except websockets.exceptions.ConnectionClosed:
+                    stats.disconnected = True
+                    break
+                except Exception:
+                    stats.errors += 1
+
+    except Exception as e:
+        stats.errors += 1
+        if "Connection refused" in str(e) or "connect" in str(e).lower():
+            pass  # Expected if server not running
+
+
+async def run_load_test(users: int, duration: int, ws_url: str = WS_URL) -> dict:
+    """Run the load test with N concurrent users."""
+    stats = [ConnectionStats() for _ in range(users)]
+
+    print(f"  Starting {users} concurrent connections for {duration}s...")
+    start = time.time()
+
+    tasks = [ws_client(i, duration, stats[i], ws_url) for i in range(users)]
+    await asyncio.gather(*tasks, return_exceptions=True)
+
+    total_time = time.time() - start
+
+    # Aggregate results
+    connected = sum(1 for s in stats if s.connected)
+    total_sent = sum(s.messages_sent for s in stats)
+    total_received = sum(s.messages_received for s in stats)
+    total_errors = sum(s.errors for s in stats)
+    disconnected = sum(1 for s in stats if s.disconnected)
+
+    all_latencies = []
+    for s in stats:
+        all_latencies.extend(s.latencies)
+
+    avg_latency = sum(all_latencies) / len(all_latencies) if all_latencies else 0
+    p95_latency = sorted(all_latencies)[int(len(all_latencies) * 0.95)] if all_latencies else 0
+    p99_latency = sorted(all_latencies)[int(len(all_latencies) * 0.99)] if all_latencies else 0
+
+    avg_connect_time = sum(s.connect_time_ms for s in stats if s.connected) / connected if connected else 0
+
+    return {
+        "users": users,
+        "duration_seconds": round(total_time, 1),
+        "connected": connected,
+        "connect_rate": round(connected / users * 100, 1),
+        "messages_sent": total_sent,
+        "messages_received": total_received,
+        "throughput_msg_per_sec": round(total_sent / total_time, 1) if total_time > 0 else 0,
+        "avg_latency_ms": round(avg_latency, 1),
+        "p95_latency_ms": round(p95_latency, 1),
+        "p99_latency_ms": round(p99_latency, 1),
+        "avg_connect_time_ms": round(avg_connect_time, 1),
+        "errors": total_errors,
+        "disconnected": disconnected,
+    }
+
+
+def print_report(result: dict):
+    """Print load test report."""
+    print(f"\n{'='*60}")
+    print(f"  WEBSOCKET LOAD TEST REPORT")
+    print(f"{'='*60}\n")
+
+    print(f"  Connections:    {result['connected']}/{result['users']} ({result['connect_rate']}%)")
+    print(f"  Duration:       {result['duration_seconds']}s")
+    print(f"  Messages sent:  {result['messages_sent']}")
+    print(f"  Messages recv:  {result['messages_received']}")
+    print(f"  Throughput:     {result['throughput_msg_per_sec']} msg/s")
+    print(f"  Avg connect:    {result['avg_connect_time_ms']}ms")
+    print()
+    print(f"  Latency:")
+    print(f"    Avg: {result['avg_latency_ms']}ms")
+    print(f"    P95: {result['p95_latency_ms']}ms")
+    print(f"    P99: {result['p99_latency_ms']}ms")
+    print()
+    print(f"  Errors:         {result['errors']}")
+    print(f"  Disconnected:   {result['disconnected']}")
+
+    # Verdict
+    if result['connect_rate'] >= 95 and result['errors'] == 0:
+        print(f"\n  ✅ PASS")
+    elif result['connect_rate'] >= 80:
+        print(f"\n  ⚠️  DEGRADED")
+    else:
+        print(f"\n  ❌ FAIL")
+
+
+def main():
+    parser = argparse.ArgumentParser(description="WebSocket Load Test")
+    parser.add_argument("--users", type=int, default=50, help="Concurrent users")
+    parser.add_argument("--duration", type=int, default=30, help="Test duration in seconds")
+    parser.add_argument("--json", action="store_true", help="JSON output")
+    parser.add_argument("--url", default=WS_URL, help="WebSocket URL")
+    args = parser.parse_args()
+
+    ws_url = args.url
+
+    print(f"\nWebSocket Load Test — {args.users} users, {args.duration}s\n")
+
+    result = asyncio.run(run_load_test(args.users, args.duration, ws_url))
+
+    if args.json:
+        print(json.dumps(result, indent=2))
+    else:
+        print_report(result)
+
+
+if __name__ == "__main__":
+    main()