Samir Boulahtit
3e38db79aa
Add protocol-based widget system following the MetricsProvider pattern: - Create DashboardWidgetProviderProtocol in contracts/widgets.py - Add WidgetAggregatorService in core to discover and aggregate widgets - Implement MarketplaceWidgetProvider for recent_imports widget - Implement TenancyWidgetProvider for recent_vendors widget - Update admin dashboard to use widget_aggregator - Add widget_provider field to ModuleDefinition Architecture documentation: - Add widget-provider-pattern.md with implementation guide - Add cross-module-import-rules.md enforcing core/optional separation - Update module-system.md with widget_provider and import rules This enables modules to provide rich dashboard widgets without core modules importing from optional modules, maintaining true module independence. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
83 lines
2.4 KiB
Python
83 lines
2.4 KiB
Python
# app/modules/contracts/__init__.py
|
|
"""
|
|
Cross-module contracts using Protocol pattern.
|
|
|
|
This module defines type-safe interfaces for cross-module communication.
|
|
Modules depend on protocols rather than concrete implementations, enabling:
|
|
- Loose coupling between modules
|
|
- Testability through mock implementations
|
|
- Clear dependency boundaries
|
|
|
|
Usage:
|
|
from app.modules.contracts.cms import ContentServiceProtocol
|
|
|
|
class OrderService:
|
|
def __init__(self, content: ContentServiceProtocol | None = None):
|
|
self._content = content
|
|
|
|
@property
|
|
def content(self) -> ContentServiceProtocol:
|
|
if self._content is None:
|
|
from app.modules.cms.services import content_page_service
|
|
self._content = content_page_service
|
|
return self._content
|
|
|
|
Metrics Provider Pattern:
|
|
from app.modules.contracts.metrics import MetricsProviderProtocol, MetricValue
|
|
|
|
class OrderMetricsProvider:
|
|
@property
|
|
def metrics_category(self) -> str:
|
|
return "orders"
|
|
|
|
def get_vendor_metrics(self, db, vendor_id, context=None) -> list[MetricValue]:
|
|
return [MetricValue(key="orders.total", value=42, label="Total", category="orders")]
|
|
|
|
Widget Provider Pattern:
|
|
from app.modules.contracts.widgets import DashboardWidgetProviderProtocol, DashboardWidget
|
|
|
|
class OrderWidgetProvider:
|
|
@property
|
|
def widgets_category(self) -> str:
|
|
return "orders"
|
|
|
|
def get_vendor_widgets(self, db, vendor_id, context=None) -> list[DashboardWidget]:
|
|
return [DashboardWidget(key="orders.recent", widget_type="list", ...)]
|
|
"""
|
|
|
|
from app.modules.contracts.base import ServiceProtocol
|
|
from app.modules.contracts.cms import ContentServiceProtocol
|
|
from app.modules.contracts.metrics import (
|
|
MetricValue,
|
|
MetricsContext,
|
|
MetricsProviderProtocol,
|
|
)
|
|
from app.modules.contracts.widgets import (
|
|
BreakdownWidget,
|
|
DashboardWidget,
|
|
DashboardWidgetProviderProtocol,
|
|
ListWidget,
|
|
WidgetBreakdownItem,
|
|
WidgetContext,
|
|
WidgetListItem,
|
|
)
|
|
|
|
__all__ = [
|
|
# Base protocols
|
|
"ServiceProtocol",
|
|
# CMS protocols
|
|
"ContentServiceProtocol",
|
|
# Metrics protocols
|
|
"MetricValue",
|
|
"MetricsContext",
|
|
"MetricsProviderProtocol",
|
|
# Widget protocols
|
|
"WidgetContext",
|
|
"WidgetListItem",
|
|
"WidgetBreakdownItem",
|
|
"ListWidget",
|
|
"BreakdownWidget",
|
|
"DashboardWidget",
|
|
"DashboardWidgetProviderProtocol",
|
|
]
|