forked from HomeLab/unraid-mcp
316193c04b
Addresses all critical, high, medium, and low issues from full codebase review. 494 tests pass, ruff clean, ty type-check clean. Security: - Add tool_error_handler context manager (exceptions.py) — standardised error handling, eliminates 11 bare except-reraise patterns - Remove unused exception subclasses (ConfigurationError, UnraidAPIError, SubscriptionError, ValidationError, IdempotentOperationError) - Harden GraphQL subscription query validator with allow-list and forbidden-keyword regex (diagnostics.py) - Add input validation for rclone create_remote config_data: injection, path-traversal, and key-count limits (rclone.py) - Validate notifications importance enum before GraphQL request (notifications.py) - Sanitise HTTP/network/JSON error messages — no raw exception strings leaked to clients (client.py) - Strip path/creds from displayed API URL via _safe_display_url (health.py) - Enable Ruff S (bandit) rule category in pyproject.toml - Harden container mutations to strict-only matching — no fuzzy/substring for destructive operations (docker.py) Performance: - Token-bucket rate limiter (90 tokens, 9 req/s) with 429 retry backoff (client.py) - Lazy asyncio.Lock init via _get_client_lock() — fixes event-loop module-load crash (client.py) - Double-checked locking in get_http_client() for fast-path (client.py) - Short hex container ID fast-path skips list fetch (docker.py) - Cap resource_data log content to 1 MB / 5,000 lines (manager.py) - Reset reconnect counter after 30 s stable connection (manager.py) - Move tail_lines validation to module level; enforce 10,000 line cap (storage.py, docker.py) - force_terminal=True removed from logging RichHandler (logging.py) Architecture: - Register diagnostic tools in server startup (server.py) - Move ALL_ACTIONS computation to module level in all tools - Consolidate format_kb / format_bytes into shared core/utils.py - Add _safe_get() helper in core/utils.py for nested dict traversal - Extract _analyze_subscription_status() from health.py diagnose handler - Validate required config at startup — fail fast with CRITICAL log (server.py) Code quality: - Remove ~90 lines of dead Rich formatting helpers from logging.py - Remove dead self.websocket attribute from SubscriptionManager - Remove dead setup_uvicorn_logging() wrapper - Move _VALID_IMPORTANCE to module level (N806 fix) - Add slots=True to all three dataclasses (SubscriptionData, SystemHealth, APIResponse) - Fix None rendering as literal "None" string in info.py summaries - Change fuzzy-match log messages from INFO to DEBUG (docker.py) - UTC-aware datetimes throughout (manager.py, diagnostics.py) Infrastructure: - Upgrade base image python:3.11-slim → python:3.12-slim (Dockerfile) - Add non-root appuser (UID/GID 1000) with HEALTHCHECK (Dockerfile) - Add read_only, cap_drop: ALL, tmpfs /tmp to docker-compose.yml - Single-source version via importlib.metadata (pyproject.toml → __init__.py) - Add open_timeout to all websockets.connect() calls Tests: - Update error message matchers to match sanitised messages (test_client.py) - Fix patch targets for UNRAID_API_URL → utils module (test_subscriptions.py) - Fix importance="info" → importance="normal" (test_notifications.py, http_layer) - Fix naive datetime fixtures → UTC-aware (test_subscriptions.py) Co-authored-by: Claude <claude@anthropic.com>
96 lines
3.5 KiB
Python
96 lines
3.5 KiB
Python
"""MCP resources that expose subscription data.
|
|
|
|
This module defines MCP resources that bridge between the subscription manager
|
|
and the MCP protocol, providing fallback queries when subscription data is unavailable.
|
|
"""
|
|
|
|
import json
|
|
import os
|
|
|
|
import anyio
|
|
from fastmcp import FastMCP
|
|
|
|
from ..config.logging import logger
|
|
from .manager import subscription_manager
|
|
|
|
|
|
# Global flag to track subscription startup
|
|
_subscriptions_started = False
|
|
|
|
|
|
async def ensure_subscriptions_started() -> None:
|
|
"""Ensure subscriptions are started, called from async context."""
|
|
global _subscriptions_started
|
|
|
|
if _subscriptions_started:
|
|
return
|
|
|
|
logger.info("[STARTUP] First async operation detected, starting subscriptions...")
|
|
try:
|
|
await autostart_subscriptions()
|
|
_subscriptions_started = True
|
|
logger.info("[STARTUP] Subscriptions started successfully")
|
|
except Exception as e:
|
|
logger.error(f"[STARTUP] Failed to start subscriptions: {e}", exc_info=True)
|
|
|
|
|
|
async def autostart_subscriptions() -> None:
|
|
"""Auto-start all subscriptions marked for auto-start in SubscriptionManager."""
|
|
logger.info("[AUTOSTART] Initiating subscription auto-start process...")
|
|
|
|
try:
|
|
# Use the new SubscriptionManager auto-start method
|
|
await subscription_manager.auto_start_all_subscriptions()
|
|
logger.info("[AUTOSTART] Auto-start process completed successfully")
|
|
except Exception as e:
|
|
logger.error(f"[AUTOSTART] Failed during auto-start process: {e}", exc_info=True)
|
|
|
|
# Optional log file subscription
|
|
log_path = os.getenv("UNRAID_AUTOSTART_LOG_PATH")
|
|
if log_path is None:
|
|
# Default to syslog if available
|
|
default_path = "/var/log/syslog"
|
|
if await anyio.Path(default_path).exists():
|
|
log_path = default_path
|
|
logger.info(f"[AUTOSTART] Using default log path: {default_path}")
|
|
|
|
if log_path:
|
|
try:
|
|
logger.info(f"[AUTOSTART] Starting log file subscription for: {log_path}")
|
|
config = subscription_manager.subscription_configs.get("logFileSubscription")
|
|
if config:
|
|
await subscription_manager.start_subscription(
|
|
"logFileSubscription", str(config["query"]), {"path": log_path}
|
|
)
|
|
logger.info(f"[AUTOSTART] Log file subscription started for: {log_path}")
|
|
else:
|
|
logger.error("[AUTOSTART] logFileSubscription config not found")
|
|
except Exception as e:
|
|
logger.error(f"[AUTOSTART] Failed to start log file subscription: {e}", exc_info=True)
|
|
else:
|
|
logger.info("[AUTOSTART] No log file path configured for auto-start")
|
|
|
|
|
|
def register_subscription_resources(mcp: FastMCP) -> None:
|
|
"""Register all subscription resources with the FastMCP instance.
|
|
|
|
Args:
|
|
mcp: FastMCP instance to register resources with
|
|
"""
|
|
|
|
@mcp.resource("unraid://logs/stream")
|
|
async def logs_stream_resource() -> str:
|
|
"""Real-time log stream data from subscription."""
|
|
await ensure_subscriptions_started()
|
|
data = await subscription_manager.get_resource_data("logFileSubscription")
|
|
if data:
|
|
return json.dumps(data, indent=2)
|
|
return json.dumps(
|
|
{
|
|
"status": "No subscription data yet",
|
|
"message": "Subscriptions auto-start on server boot. If this persists, check server logs for WebSocket/auth issues.",
|
|
}
|
|
)
|
|
|
|
logger.info("Subscription resources registered successfully")
|