Plugin Stuff

Author: Aegis Stack

aegis/core/components.py

@@ -5,9 +5,11 @@
 used for project generation and validation.
 """
 
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from enum import Enum
 
+from .file_manifest import FileManifest
+
 
 class ComponentType(Enum):
     """Component type classifications."""
@@ -35,27 +37,17 @@ class ComponentSpec:
     name: str
     type: ComponentType
     description: str
-    requires: list[str] | None = None  # Hard dependencies
-    recommends: list[str] | None = None  # Soft dependencies
-    conflicts: list[str] | None = None  # Mutual exclusions
-    docker_services: list[str] | None = None
-    pyproject_deps: list[str] | None = None
-    template_files: list[str] | None = None
-
-    def __post_init__(self) -> None:
-        """Ensure all list fields are initialized."""
-        if self.requires is None:
-            self.requires = []
-        if self.recommends is None:
-            self.recommends = []
-        if self.conflicts is None:
-            self.conflicts = []
-        if self.docker_services is None:
-            self.docker_services = []
-        if self.pyproject_deps is None:
-            self.pyproject_deps = []
-        if self.template_files is None:
-            self.template_files = []
+    requires: list[str] = field(default_factory=list)  # Hard dependencies
+    recommends: list[str] = field(default_factory=list)  # Soft dependencies
+    conflicts: list[str] = field(default_factory=list)  # Mutual exclusions
+    docker_services: list[str] = field(default_factory=list)
+    pyproject_deps: list[str] = field(default_factory=list)
+    template_files: list[str] = field(default_factory=list)
+    # R1 file manifest used by cleanup_components(). The legacy
+    # post_gen_tasks.get_component_file_mapping() dict is still maintained
+    # separately, so this manifest must be kept aligned with it by hand
+    # until R2 derives the mapping from manifests. See file_manifest.py.
+    files: FileManifest = field(default_factory=FileManifest)
 
 
 # Component registry - single source of truth
@@ -66,20 +58,28 @@ def __post_init__(self) -> None:
         description="FastAPI backend server",
         pyproject_deps=["fastapi==0.116.1", "uvicorn==0.35.0"],
         template_files=["app/components/backend/"],
+        # backend is a CORE component; never cleaned up.
     ),
     "frontend": ComponentSpec(
         name="frontend",
         type=ComponentType.CORE,
         description="Flet frontend interface",
         pyproject_deps=["flet==0.28.3"],
         template_files=["app/components/frontend/"],
+        # frontend is a CORE component; never cleaned up.
     ),
     "redis": ComponentSpec(
         name="redis",
         type=ComponentType.INFRASTRUCTURE,
         description="Redis cache and message broker",
         docker_services=["redis"],
         pyproject_deps=["redis==5.0.8"],
+        files=FileManifest(
+            primary=[
+                "app/components/frontend/dashboard/cards/redis_card.py",
+                "app/components/frontend/dashboard/modals/redis_modal.py",
+            ],
+        ),
     ),
     "worker": ComponentSpec(
         name="worker",
@@ -89,6 +89,26 @@ def __post_init__(self) -> None:
         pyproject_deps=["arq==0.25.0"],
         docker_services=["worker-system", "worker-load-test"],
         template_files=["app/components/worker/"],
+        files=FileManifest(
+            # Mirrors cleanup_components() lines 316-333 (worker NOT enabled).
+            # task_history_section.py is intentionally NOT here — cleanup
+            # leaves it. worker_taskiq.py IS here — cleanup removes it.
+            primary=[
+                "app/components/worker",
+                "app/cli/load_test.py",
+                "app/services/load_test.py",
+                "app/services/load_test_models.py",
+                "app/services/load_test_workloads.py",
+                "tests/services/test_load_test_models.py",
+                "tests/services/test_load_test_service.py",
+                "tests/services/test_worker_health_registration.py",
+                "app/components/backend/api/worker.py",
+                "app/components/backend/api/worker_taskiq.py",
+                "tests/api/test_worker_endpoints.py",
+                "app/components/frontend/dashboard/cards/worker_card.py",
+                "app/components/frontend/dashboard/modals/worker_modal.py",
+            ],
+        ),
     ),
     "scheduler": ComponentSpec(
         name="scheduler",
@@ -97,6 +117,22 @@ def __post_init__(self) -> None:
         pyproject_deps=["apscheduler==3.10.4"],
         docker_services=["scheduler"],
         template_files=["app/components/scheduler.py", "app/entrypoints/scheduler.py"],
+        files=FileManifest(
+            primary=[
+                "app/entrypoints/scheduler.py",
+                "app/components/scheduler",
+                "tests/components/test_scheduler.py",
+                "docs/components/scheduler.md",
+                "app/components/backend/api/scheduler.py",
+                "tests/api/test_scheduler_endpoints.py",
+                "app/components/frontend/dashboard/cards/scheduler_card.py",
+                "app/components/frontend/dashboard/modals/scheduler_modal.py",
+                "tests/services/test_scheduled_task_manager.py",
+            ],
+            # scheduler persistence cleanup is option-driven
+            # (scheduler_backend == MEMORY), not a simple AnswerKey toggle —
+            # it stays inline in cleanup_components() for R1.
+        ),
     ),
     "database": ComponentSpec(
         name="database",
@@ -105,20 +141,41 @@ def __post_init__(self) -> None:
         pyproject_deps=["sqlmodel>=0.0.14", "sqlalchemy>=2.0.0"],
         # Note: async driver (aiosqlite or asyncpg) selected based on database_type in copier.yml
         template_files=["app/core/db.py"],
+        files=FileManifest(
+            primary=[
+                "app/core/db.py",
+                "app/components/frontend/dashboard/cards/database_card.py",
+                "app/components/frontend/dashboard/modals/database_modal.py",
+            ],
+        ),
     ),
     "ingress": ComponentSpec(
         name="ingress",
         type=ComponentType.INFRASTRUCTURE,
         description="Traefik reverse proxy and load balancer",
         docker_services=["traefik"],
         recommends=["backend"],
+        files=FileManifest(
+            primary=[
+                "traefik",
+                "app/components/frontend/dashboard/cards/ingress_card.py",
+                "app/components/frontend/dashboard/modals/ingress_modal.py",
+            ],
+        ),
     ),
     "observability": ComponentSpec(
         name="observability",
         type=ComponentType.INFRASTRUCTURE,
         description="Logfire observability, tracing, and metrics",
         pyproject_deps=["logfire[fastapi,httpx]"],
         template_files=["app/components/backend/middleware/logfire_tracing.py"],
+        files=FileManifest(
+            primary=[
+                "app/components/backend/middleware/logfire_tracing.py",
+                "app/components/frontend/dashboard/cards/observability_card.py",
+                "app/components/frontend/dashboard/modals/observability_modal.py",
+            ],
+        ),
     ),
 }
 

aegis/core/file_manifest.py

@@ -0,0 +1,131 @@
+"""
+Declarative file manifest per service / component spec.
+
+R1 of the plugin system refactor. Centralises the per-spec file
+ownership needed for declarative cleanup, replacing the **Pattern A**
+imperative blocks ("if X is not selected, remove these files") that
+were scattered through ``aegis/core/post_gen_tasks.py``.
+
+What R1 does NOT do (deliberately deferred to R2):
+
+* ``post_gen_tasks.get_component_file_mapping()`` is still a hard-coded
+  dict. ``compute_file_mapping()`` below is a forward-compat helper for
+  the eventual migration; it is not currently called by core code. The
+  legacy dict and each spec's ``files.primary`` can therefore drift —
+  keep them aligned by hand until R2 derives the mapping from manifests.
+* Sub-feature, cross-spec, and worker-backend cleanups remain inline in
+  ``cleanup_components`` (their gating predicates are non-uniform).
+
+Everything else stays inline in ``cleanup_components`` for R1:
+
+* Pattern B sub-feature cleanup (``ai_rag``, ``ai_voice``, ``auth_org``,
+  AI memory backend, ollama mode, scheduler memory backend). Each has
+  its own gating predicate; uniform reducer rules don't fit yet.
+* Pattern C cross-spec aggregations (``alembic`` only when no service
+  needs migrations; ``services_card.py`` only when no services;
+  ``docs/components`` only when no components).
+* Pattern D worker backend-variant rename + delete-others.
+
+The ``extras`` field on ``FileManifest`` is captured here for
+documentation / future use (``get_component_file_mapping`` legacy keys
+like ``ai_rag``, ``ai_voice``, ``scheduler_persistence``), but the R1
+reducer ignores it. R2 generalises the spec model and lights up
+``extras``-driven cleanup uniformly.
+"""
+
+from __future__ import annotations
+
+import shutil
+from collections.abc import Iterable
+from dataclasses import dataclass, field
+from pathlib import Path
+from typing import Any
+
+
+@dataclass
+class FileManifest:
+    """File ownership for a single service or component spec.
+
+    See module docstring for the role this plays in R1.
+    """
+
+    primary: list[str] = field(default_factory=list)
+    """Files cleaned up when the parent spec is not selected.
+
+    Paths are relative to the project root. Each entry may be a file path
+    or a directory path; directories are removed recursively.
+    """
+
+    extras: dict[str, list[str]] = field(default_factory=dict)
+    """Sub-feature file groups, keyed by their legacy mapping identifier.
+
+    Captured on the spec for documentation and forward-compatibility
+    with ``get_component_file_mapping()``. **Not** consumed by the R1
+    cleanup reducer — sub-feature cleanup remains inline in
+    ``cleanup_components`` because each sub-feature has its own gating
+    predicate (some by AnswerKey toggle, some by option value, some
+    only when the parent is also on). R2 unifies the spec model and
+    lights up uniform extras-driven cleanup.
+
+    Example: ``{"ai_rag": [...], "ai_voice": [...]}`` on the AI service.
+    """
+
+
+def compute_file_mapping(specs: Iterable[Any]) -> dict[str, list[str]]:
+    """Build the legacy component-file mapping from spec manifests.
+
+    Output shape matches ``post_gen_tasks.get_component_file_mapping()``:
+    ``{spec_name: [files...], extra_key: [files...], ...}``.
+
+    Specs without a populated ``FileManifest`` are skipped — non-migrated
+    specs do not break the reducer.
+    """
+    mapping: dict[str, list[str]] = {}
+    for spec in specs:
+        manifest = getattr(spec, "files", None)
+        if not isinstance(manifest, FileManifest):
+            continue
+        if manifest.primary:
+            mapping[spec.name] = list(manifest.primary)
+        for extra_key, extra_files in manifest.extras.items():
+            if extra_files:
+                mapping[extra_key] = list(extra_files)
+    return mapping
+
+
+def iter_cleanup_paths(spec: Any, *, selected: bool) -> Iterable[str]:
+    """Yield project-relative paths to remove for one spec when it is off.
+
+    R1 scope: only Pattern A primary cleanup. When ``selected`` is True,
+    yields nothing (sub-feature cleanup is handled inline). When False,
+    yields the spec's ``primary`` paths.
+
+    Args:
+        spec: A spec object exposing ``.files: FileManifest``. Specs
+            without a manifest yield nothing.
+        selected: Whether this spec is selected (its ``include_*`` flag
+            is truthy in the context).
+
+    Yields:
+        Relative paths to remove (file or directory; caller decides how).
+    """
+    if selected:
+        return
+    manifest = getattr(spec, "files", None)
+    if not isinstance(manifest, FileManifest):
+        return
+    yield from manifest.primary
+
+
+def apply_cleanup_path(project_path: Path, rel_path: str) -> None:
+    """Remove a single project-relative path. File or directory; no-op if absent.
+
+    Mirrors the union of ``post_gen_tasks.remove_file`` and
+    ``post_gen_tasks.remove_dir`` so callers don't need to know the kind.
+    """
+    full = project_path / rel_path
+    if full.is_file() or full.is_symlink():
+        full.unlink()
+    elif full.is_dir():
+        shutil.rmtree(full)
+    # else: missing -> silent no-op, matches existing behaviour.