Samir Boulahtit
d7a0ff8818
This commit completes the migration to a fully module-driven architecture: ## Models Migration - Moved all domain models from models/database/ to their respective modules: - tenancy: User, Admin, Vendor, Company, Platform, VendorDomain, etc. - cms: MediaFile, VendorTheme - messaging: Email, VendorEmailSettings, VendorEmailTemplate - core: AdminMenuConfig - models/database/ now only contains Base and TimestampMixin (infrastructure) ## Schemas Migration - Moved all domain schemas from models/schema/ to their respective modules: - tenancy: company, vendor, admin, team, vendor_domain - cms: media, image, vendor_theme - messaging: email - models/schema/ now only contains base.py and auth.py (infrastructure) ## Routes Migration - Moved admin routes from app/api/v1/admin/ to modules: - menu_config.py -> core module - modules.py -> tenancy module - module_config.py -> tenancy module - app/api/v1/admin/ now only aggregates auto-discovered module routes ## Menu System - Implemented module-driven menu system with MenuDiscoveryService - Extended FrontendType enum: PLATFORM, ADMIN, VENDOR, STOREFRONT - Added MenuItemDefinition and MenuSectionDefinition dataclasses - Each module now defines its own menu items in definition.py - MenuService integrates with MenuDiscoveryService for template rendering ## Documentation - Updated docs/architecture/models-structure.md - Updated docs/architecture/menu-management.md - Updated architecture validation rules for new exceptions ## Architecture Validation - Updated MOD-019 rule to allow base.py in models/schema/ - Created core module exceptions.py and schemas/ directory - All validation errors resolved (only warnings remain) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
137 lines
4.8 KiB
Python
137 lines
4.8 KiB
Python
# app/modules/monitoring/definition.py
|
|
"""
|
|
Monitoring module definition.
|
|
|
|
Defines the monitoring module including its features, menu items,
|
|
route configurations, and self-contained module settings.
|
|
"""
|
|
|
|
from app.modules.base import MenuItemDefinition, MenuSectionDefinition, ModuleDefinition
|
|
from app.modules.enums import FrontendType
|
|
|
|
|
|
def _get_admin_router():
|
|
"""Lazy import of admin router to avoid circular imports."""
|
|
from app.modules.monitoring.routes.admin import admin_router
|
|
|
|
return admin_router
|
|
|
|
|
|
# Monitoring module definition
|
|
monitoring_module = ModuleDefinition(
|
|
code="monitoring",
|
|
name="Platform Monitoring",
|
|
description="Logs, background tasks, imports, system health, Flower, and Grafana integration.",
|
|
version="1.0.0",
|
|
features=[
|
|
"application_logs", # Log viewing
|
|
"background_tasks", # Task monitoring
|
|
"import_jobs", # Import job tracking
|
|
"capacity_monitoring", # System capacity
|
|
"testing_hub", # Test runner
|
|
"code_quality", # Code quality tools
|
|
"flower_integration", # Celery Flower link
|
|
"grafana_integration", # Grafana dashboard link
|
|
],
|
|
menu_items={
|
|
FrontendType.ADMIN: [
|
|
"imports", # Import jobs
|
|
"background-tasks", # Background tasks
|
|
"logs", # Application logs
|
|
"platform-health", # Platform health
|
|
"testing", # Testing hub
|
|
"code-quality", # Code quality
|
|
],
|
|
FrontendType.VENDOR: [], # No vendor menu items
|
|
},
|
|
# New module-driven menu definitions
|
|
menus={
|
|
FrontendType.ADMIN: [
|
|
MenuSectionDefinition(
|
|
id="platformHealth",
|
|
label_key="monitoring.menu.platform_health",
|
|
icon="chart-bar",
|
|
order=75,
|
|
is_super_admin_only=True,
|
|
items=[
|
|
MenuItemDefinition(
|
|
id="platform-health",
|
|
label_key="monitoring.menu.capacity_monitor",
|
|
icon="chart-bar",
|
|
route="/admin/platform-health",
|
|
order=10,
|
|
),
|
|
MenuItemDefinition(
|
|
id="testing",
|
|
label_key="monitoring.menu.testing_hub",
|
|
icon="beaker",
|
|
route="/admin/testing",
|
|
order=20,
|
|
),
|
|
MenuItemDefinition(
|
|
id="code-quality",
|
|
label_key="monitoring.menu.code_quality",
|
|
icon="shield-check",
|
|
route="/admin/code-quality",
|
|
order=30,
|
|
),
|
|
],
|
|
),
|
|
MenuSectionDefinition(
|
|
id="monitoring",
|
|
label_key="monitoring.menu.platform_monitoring",
|
|
icon="collection",
|
|
order=80,
|
|
is_super_admin_only=True,
|
|
items=[
|
|
MenuItemDefinition(
|
|
id="imports",
|
|
label_key="monitoring.menu.import_jobs",
|
|
icon="cube",
|
|
route="/admin/imports",
|
|
order=10,
|
|
),
|
|
MenuItemDefinition(
|
|
id="background-tasks",
|
|
label_key="monitoring.menu.background_tasks",
|
|
icon="collection",
|
|
route="/admin/background-tasks",
|
|
order=20,
|
|
),
|
|
MenuItemDefinition(
|
|
id="logs",
|
|
label_key="monitoring.menu.application_logs",
|
|
icon="document-text",
|
|
route="/admin/logs",
|
|
order=30,
|
|
),
|
|
],
|
|
),
|
|
],
|
|
},
|
|
is_core=False,
|
|
is_internal=True, # Internal module - admin-only, not customer-facing
|
|
# =========================================================================
|
|
# Self-Contained Module Configuration
|
|
# =========================================================================
|
|
is_self_contained=True,
|
|
services_path="app.modules.monitoring.services",
|
|
models_path="app.modules.monitoring.models",
|
|
schemas_path="app.modules.monitoring.schemas",
|
|
exceptions_path="app.modules.monitoring.exceptions",
|
|
)
|
|
|
|
|
|
def get_monitoring_module_with_routers() -> ModuleDefinition:
|
|
"""
|
|
Get monitoring module with routers attached.
|
|
|
|
This function attaches the routers lazily to avoid circular imports
|
|
during module initialization.
|
|
"""
|
|
monitoring_module.admin_router = _get_admin_router()
|
|
return monitoring_module
|
|
|
|
|
|
__all__ = ["monitoring_module", "get_monitoring_module_with_routers"]
|