qodalis-cli-server-plugin-admin 1.0.0b1__tar.gz → 1.0.0b5__tar.gz

{qodalis_cli_server_plugin_admin-1.0.0b1 → qodalis_cli_server_plugin_admin-1.0.0b5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qodalis-cli-server-plugin-admin
-Version: 1.0.0b1
+Version: 1.0.0b5
 Summary: Admin dashboard plugin for Qodalis CLI servers
 Project-URL: Homepage, https://github.com/qodalis-solutions/cli-server-python
 Project-URL: Repository, https://github.com/qodalis-solutions/cli-server-python

{qodalis_cli_server_plugin_admin-1.0.0b1 → qodalis_cli_server_plugin_admin-1.0.0b5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "qodalis-cli-server-plugin-admin"
-version = "1.0.0b1"
+version = "1.0.0b5"
 description = "Admin dashboard plugin for Qodalis CLI servers"
 readme = { text = "", content-type = "text/plain" }
 license = "MIT"

{qodalis_cli_server_plugin_admin-1.0.0b1 → qodalis_cli_server_plugin_admin-1.0.0b5}/qodalis_cli_admin/auth/auth_controller.py

@@ -13,26 +13,21 @@ from .jwt_service import JwtService
 from ..services.admin_config import AdminConfig
 
 
-# ---------------------------------------------------------------------------
-# Request / Response models
-# ---------------------------------------------------------------------------
-
-
 class LoginRequest(BaseModel):
+    """Request body for the login endpoint."""
+
     username: str
     password: str
 
 
 class LoginResponse(BaseModel):
+    """Response body returned on successful login."""
+
     token: str
     expiresIn: int
     username: str
 
 
-# ---------------------------------------------------------------------------
-# Rate limiting helpers
-# ---------------------------------------------------------------------------
-
 _MAX_ATTEMPTS = 5
 _WINDOW_SECONDS = 60
 
@@ -47,20 +42,15 @@ class _RateLimiter:
         """Raise ``HTTPException(429)`` if the IP has exceeded the limit."""
         now = time.time()
         cutoff = now - _WINDOW_SECONDS
-        # Clean old entries
         self._attempts[ip] = [t for t in self._attempts[ip] if t > cutoff]
         if len(self._attempts[ip]) >= _MAX_ATTEMPTS:
             raise HTTPException(status_code=429, detail="Too many failed login attempts. Try again later.")
 
     def record_failure(self, ip: str) -> None:
+        """Record a failed login attempt for the given IP."""
         self._attempts[ip].append(time.time())
 
 
-# ---------------------------------------------------------------------------
-# Router factory
-# ---------------------------------------------------------------------------
-
-
 def create_auth_router(
     admin_config: AdminConfig,
     jwt_service: JwtService,
@@ -72,7 +62,6 @@ def create_auth_router(
 
     @router.post("/login", response_model=LoginResponse)
     async def login(body: LoginRequest, request: Request) -> Any:
-        # Check X-Forwarded-For header for real client IP behind proxy
         forwarded_for = request.headers.get("x-forwarded-for")
         if forwarded_for:
             client_ip = forwarded_for.split(",")[0].strip()

{qodalis_cli_server_plugin_admin-1.0.0b1 → qodalis_cli_server_plugin_admin-1.0.0b5}/qodalis_cli_admin/auth/auth_middleware.py

@@ -36,8 +36,6 @@ def create_auth_dependency(jwt_service: JwtService):
     return require_auth
 
 
-# Convenience alias — requires a JwtService instance to be set externally.
-# Prefer ``create_auth_dependency(jwt_service)`` for production use.
 async def require_auth(request: Request) -> dict[str, Any]:  # noqa: F811
-    """Placeholder — use :func:`create_auth_dependency` to create a real dependency."""
+    """No-op fallback; use ``create_auth_dependency`` to create a real dependency."""
     raise HTTPException(status_code=401, detail="Auth not configured")

{qodalis_cli_server_plugin_admin-1.0.0b1 → qodalis_cli_server_plugin_admin-1.0.0b5}/qodalis_cli_admin/auth/jwt_service.py

@@ -33,12 +33,9 @@ class JwtService:
     ) -> str:
         """Create a signed JWT token.
 
-        Parameters
-        ----------
-        payload:
-            Claims to embed in the token.
-        expires_in:
-            Lifetime in seconds.  Defaults to 24 hours.
+        Args:
+            payload: Claims to embed in the token.
+            expires_in: Lifetime in seconds. Defaults to 24 hours.
         """
         exp = int(time.time()) + (self.DEFAULT_EXPIRY_SECONDS if expires_in is None else expires_in)
         data = {**payload, "exp": exp, "iat": int(time.time())}
@@ -47,9 +44,7 @@ class JwtService:
     def verify_token(self, token: str) -> dict[str, Any]:
         """Decode and verify a JWT token.
 
-        Raises
-        ------
-        jwt.InvalidTokenError
-            If the token is invalid or expired.
+        Raises:
+            jwt.InvalidTokenError: If the token is invalid or expired.
         """
         return jwt.decode(token, self._secret, algorithms=["HS256"])

{qodalis_cli_server_plugin_admin-1.0.0b1 → qodalis_cli_server_plugin_admin-1.0.0b5}/qodalis_cli_admin/cli_admin_builder.py

@@ -42,10 +42,13 @@ class AdminBuildDeps:
 class CliAdminPlugin:
     """Result of building the admin plugin."""
 
+    prefix: str
+    dashboard_prefix: str
     router: APIRouter
     auth_dependency: Any
     log_buffer: LogRingBuffer
     dashboard_app: Any  # ASGI app (SPA fallback) or None
+    module_registry: ModuleRegistry | None = None
 
 
 class CliAdminBuilder:
@@ -77,7 +80,6 @@ class CliAdminBuilder:
         """Build the plugin, returning the router, auth dependency, and log buffer."""
         start_time = time.time()
 
-        # Services
         config = AdminConfig(
             username=self._username,
             password=self._password,
@@ -89,14 +91,11 @@ class CliAdminBuilder:
         module_registry = ModuleRegistry(deps.builder)
         auth_dep = create_auth_dependency(jwt_service)
 
-        # Build the top-level router
         router = APIRouter()
 
-        # Auth routes (login is public, /me is protected)
         auth_router = create_auth_router(config, jwt_service, auth_dependency=auth_dep)
         router.include_router(auth_router, prefix="/auth")
 
-        # Detect enabled features
         enabled_features: list[str] = list(deps.enabled_features or [])
 
         if "filesystem" not in enabled_features and (
@@ -112,7 +111,6 @@ class CliAdminBuilder:
                     enabled_features.append("jobs")
                     break
 
-        # Protected routes
         status_router = create_status_router(
             start_time, deps.event_socket_manager, auth_dep, enabled_features,
             registry=deps.registry,
@@ -131,7 +129,6 @@ class CliAdminBuilder:
         ws_clients_router = create_ws_clients_router(deps.event_socket_manager, auth_dep)
         router.include_router(ws_clients_router)
 
-        # Resolve dashboard SPA
         dashboard_dir = resolve_dashboard_dir(self._dashboard_path)
         dashboard_app = None
 
@@ -139,8 +136,11 @@ class CliAdminBuilder:
             dashboard_app = SPAStaticFiles(directory=dashboard_dir, html=True)
 
         return CliAdminPlugin(
+            prefix="/api/v1/qcli",
+            dashboard_prefix="/qcli/admin",
             router=router,
             auth_dependency=auth_dep,
             log_buffer=log_buffer,
             dashboard_app=dashboard_app,
+            module_registry=module_registry,
         )

{qodalis_cli_server_plugin_admin-1.0.0b1 → qodalis_cli_server_plugin_admin-1.0.0b5}/qodalis_cli_admin/controllers/config_controller.py

@@ -11,6 +11,8 @@ from ..services.admin_config import AdminConfig
 
 
 class UpdateConfigRequest(BaseModel):
+    """Request body for updating admin configuration settings."""
+
     settings: dict[str, Any]
 
 

{qodalis_cli_server_plugin_admin-1.0.0b1 → qodalis_cli_server_plugin_admin-1.0.0b5}/qodalis_cli_admin/dashboard_resolver.py

@@ -5,23 +5,22 @@ from pathlib import Path
 
 
 def resolve_dashboard_dir(explicit_path: str | None = None) -> str | None:
+    """Resolve the dashboard dist directory.
+
+    Searches in order: explicit path, bundled directory, npm package
+    (``node_modules/@qodalis/cli-server-dashboard/dist``), and relative
+    development paths.
+
+    Returns:
+        The absolute path to the dashboard directory, or ``None``.
     """
-    Resolve the dashboard dist directory. Looks for:
-    1. Explicitly configured path
-    2. Bundled dashboard directory (embedded in this package)
-    3. node_modules/@qodalis/cli-server-dashboard/dist (npm package)
-    4. Relative development paths (sibling repo)
-    """
-    # 1. Explicit override
     if explicit_path and os.path.isdir(explicit_path):
         return os.path.abspath(explicit_path)
 
-    # 2. Bundled dashboard directory (embedded in this package)
     bundled = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'dashboard')
     if os.path.isdir(bundled):
         return bundled
 
-    # 3. npm package — search upwards from cwd for node_modules
     current = os.getcwd()
     while current != os.path.dirname(current):
         candidate = os.path.join(
@@ -31,7 +30,6 @@ def resolve_dashboard_dir(explicit_path: str | None = None) -> str | None:
             return os.path.abspath(candidate)
         current = os.path.dirname(current)
 
-    # 4. Relative development paths
     this_dir = os.path.dirname(os.path.abspath(__file__))
     dev_paths = [
         os.path.join(this_dir, "..", "..", "..", "..", "cli-server-dashboard", "dist"),

{qodalis_cli_server_plugin_admin-1.0.0b1 → qodalis_cli_server_plugin_admin-1.0.0b5}/qodalis_cli_admin/services/admin_config.py

@@ -105,6 +105,7 @@ class AdminConfig:
 
 
 def _infer_type(val: Any) -> str:
+    """Infer a JSON-schema-style type string from a Python value."""
     if isinstance(val, bool):
         return "boolean"
     if isinstance(val, (int, float)):

{qodalis_cli_server_plugin_admin-1.0.0b1 → qodalis_cli_server_plugin_admin-1.0.0b5}/qodalis_cli_admin/services/log_ring_buffer.py

@@ -47,8 +47,6 @@ class LogRingBuffer:
         self._broadcast_fn = broadcast_fn
         self._handler: _RingBufferHandler | None = None
 
-    # -- public API -----------------------------------------------------------
-
     def add(self, entry: LogEntry) -> None:
         """Append a log entry to the buffer."""
         entry.level = (entry.level or "INFO").upper()
@@ -93,8 +91,6 @@ class LogRingBuffer:
             total,
         )
 
-    # -- logging integration --------------------------------------------------
-
     def install_handler(self, logger_name: str = "") -> None:
         """Install a :class:`logging.Handler` that feeds into this buffer."""
         if self._handler is not None:
@@ -118,6 +114,7 @@ class _RingBufferHandler(logging.Handler):
         self._ring = ring
 
     def emit(self, record: logging.LogRecord) -> None:
+        """Convert a log record to a LogEntry and append it to the ring buffer."""
         entry = LogEntry(
             timestamp=datetime.now(timezone.utc).isoformat(),
             level=record.levelname,

{qodalis_cli_server_plugin_admin-1.0.0b1 → qodalis_cli_server_plugin_admin-1.0.0b5}/qodalis_cli_admin/services/module_registry.py

@@ -1,19 +1,54 @@
-"""Module registry — reads modules from CliBuilder and tracks enabled state."""
+"""Module registry — reads modules from CliBuilder and tracks enabled state.
+
+Implements :class:`ICliProcessorFilter` so that processors belonging to
+disabled modules are blocked at execution time.
+"""
 
 from __future__ import annotations
 
 from typing import Any, TYPE_CHECKING
 
+from qodalis_cli_server_abstractions import ICliProcessorFilter
+
 if TYPE_CHECKING:
+    from qodalis_cli_server_abstractions import ICliCommandProcessor
     from qodalis_cli.extensions.cli_builder import CliBuilder
 
 
-class ModuleRegistry:
-    """Provides a read/toggle view over modules registered in :class:`CliBuilder`."""
+class ModuleRegistry(ICliProcessorFilter):
+    """Provides a read/toggle view over modules registered in :class:`CliBuilder`.
+
+    Also acts as a processor filter: processors that belong to a disabled
+    module are reported as *not allowed*, causing the executor to reject
+    the command with a user-friendly error.
+    """
 
     def __init__(self, builder: CliBuilder) -> None:
         self._builder = builder
         self._disabled: set[str] = set()
+        # Map each processor instance to its module id for fast lookup.
+        self._processor_to_module: dict[int, str] = {}
+        self._rebuild_processor_map()
+
+    def _rebuild_processor_map(self) -> None:
+        """(Re-)build the processor-to-module-id mapping."""
+        self._processor_to_module.clear()
+        for idx, module in enumerate(self._builder.modules):
+            module_id = str(idx)
+            for processor in module.processors:
+                self._processor_to_module[id(processor)] = module_id
+
+    # -- ICliProcessorFilter ------------------------------------------------
+
+    def is_allowed(self, processor: ICliCommandProcessor) -> bool:
+        """Return ``False`` if the processor belongs to a disabled module."""
+        module_id = self._processor_to_module.get(id(processor))
+        if module_id is None:
+            # Processor not registered via a module — always allowed.
+            return True
+        return module_id not in self._disabled
+
+    # -- Public API ---------------------------------------------------------
 
     def list(self) -> list[dict[str, Any]]:
         """Return a list of all modules with their enabled/disabled state."""
@@ -55,10 +90,4 @@ class ModuleRegistry:
             "enabled": enabled,
         }
 
-        if not enabled:
-            result["warning"] = (
-                "Module state tracked but command unregistration is not yet"
-                " supported. Processors remain active."
-            )
-
         return result

{qodalis_cli_server_plugin_admin-1.0.0b1 → qodalis_cli_server_plugin_admin-1.0.0b5}/qodalis_cli_admin/spa_static_files.py

@@ -24,12 +24,12 @@ class SPAStaticFiles(StaticFiles):
     """
 
     async def get_response(self, path: str, scope: Scope) -> Response:
+        """Return the static file or fall back to ``index.html`` for SPA routes."""
         try:
             return await super().get_response(path, scope)
         except StarletteHTTPException as exc:
             if exc.status_code != 404:
                 raise
-            # File not found — serve index.html for SPA client-side routing
             index = os.path.join(self.directory, "index.html")  # type: ignore[arg-type]
             if os.path.isfile(index):
                 return FileResponse(index, media_type="text/html")