WIP: Staged all changes

backend/src/core/logger.py

@@ -0,0 +1,92 @@
+# [DEF:LoggerModule:Module]
+# @SEMANTICS: logging, websocket, streaming, handler
+# @PURPOSE: Configures the application's logging system, including a custom handler for buffering logs and streaming them over WebSockets.
+# @LAYER: Core
+# @RELATION: Used by the main application and other modules to log events. The WebSocketLogHandler is used by the WebSocket endpoint in app.py.
+import logging
+from datetime import datetime
+from typing import Dict, Any, List, Optional
+from collections import deque
+
+from pydantic import BaseModel, Field
+
+# Re-using LogEntry from task_manager for consistency
+# [DEF:LogEntry:Class]
+# @SEMANTICS: log, entry, record, pydantic
+# @PURPOSE: A Pydantic model representing a single, structured log entry. This is a re-definition for consistency, as it's also defined in task_manager.py.
+class LogEntry(BaseModel):
+    timestamp: datetime = Field(default_factory=datetime.utcnow)
+    level: str
+    message: str
+    context: Optional[Dict[str, Any]] = None
+
+# [/DEF]
+
+# [DEF:WebSocketLogHandler:Class]
+# @SEMANTICS: logging, handler, websocket, buffer
+# @PURPOSE: A custom logging handler that captures log records into a buffer. It is designed to be extended for real-time log streaming over WebSockets.
+class WebSocketLogHandler(logging.Handler):
+    """
+    A logging handler that stores log records and can be extended to send them
+    over WebSockets.
+    """
+    def __init__(self, capacity: int = 1000):
+        super().__init__()
+        self.log_buffer: deque[LogEntry] = deque(maxlen=capacity)
+        # In a real implementation, you'd have a way to manage active WebSocket connections
+        # e.g., self.active_connections: Set[WebSocket] = set()
+
+    def emit(self, record: logging.LogRecord):
+        try:
+            log_entry = LogEntry(
+                level=record.levelname,
+                message=self.format(record),
+                context={
+                    "name": record.name,
+                    "pathname": record.pathname,
+                    "lineno": record.lineno,
+                    "funcName": record.funcName,
+                    "process": record.process,
+                    "thread": record.thread,
+                }
+            )
+            self.log_buffer.append(log_entry)
+            # Here you would typically send the log_entry to all active WebSocket connections
+            # for real-time streaming to the frontend.
+            # Example: for ws in self.active_connections: await ws.send_json(log_entry.dict())
+        except Exception:
+            self.handleError(record)
+
+    def get_recent_logs(self) -> List[LogEntry]:
+        """
+        Returns a list of recent log entries from the buffer.
+        """
+        return list(self.log_buffer)
+
+# [/DEF]
+
+# [DEF:Logger:Global]
+# @SEMANTICS: logger, global, instance
+# @PURPOSE: The global logger instance for the application, configured with both a console handler and the custom WebSocket handler.
+logger = logging.getLogger("superset_tools_app")
+logger.setLevel(logging.INFO)
+
+# Create a formatter
+formatter = logging.Formatter(
+    '[%(asctime)s][%(levelname)s][%(name)s] %(message)s'
+)
+
+# Add console handler
+console_handler = logging.StreamHandler()
+console_handler.setFormatter(formatter)
+logger.addHandler(console_handler)
+
+# Add WebSocket log handler
+websocket_log_handler = WebSocketLogHandler()
+websocket_log_handler.setFormatter(formatter)
+logger.addHandler(websocket_log_handler)
+
+# Example usage:
+# logger.info("Application started", extra={"context_key": "context_value"})
+# logger.error("An error occurred", exc_info=True)
+# [/DEF]