feat: add module definition completeness validation and permissions
Add new validation rules MOD-020 to MOD-023 for module definition completeness and standardize permissions across all modules. Changes: - Add MOD-020: Module definitions must have required attributes - Add MOD-021: Modules with menus should have features - Add MOD-022: Feature modules should have permissions - Add MOD-023: Modules with routers should use get_*_with_routers pattern Module permissions added: - analytics: view, export, manage_dashboards - billing: view_tiers, manage_tiers, view_subscriptions, manage_subscriptions, view_invoices - cart: view, manage - checkout: view_settings, manage_settings - cms: view_pages, manage_pages, view_media, manage_media, manage_themes - loyalty: view_programs, manage_programs, view_rewards, manage_rewards - marketplace: view_integration, manage_integration, sync_products - messaging: view_messages, send_messages, manage_templates - payments: view_gateways, manage_gateways, view_transactions Module improvements: - Complete cart module with features and permissions - Complete checkout module with features and permissions - Add features to catalog module - Add version to cms module - Fix loyalty platform_router attachment - Add path definitions to payments module - Remove empty scheduled_tasks from dev_tools module Documentation: - Update module-system.md with new validation rules - Update architecture-rules.md with MOD-020 to MOD-023 Tests: - Add unit tests for module definition completeness - Add tests for permission structure validation Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
@@ -6,7 +6,7 @@ Defines the loyalty module including its features, menu items,
|
||||
route configurations, and scheduled tasks.
|
||||
"""
|
||||
|
||||
from app.modules.base import MenuItemDefinition, MenuSectionDefinition, ModuleDefinition, ScheduledTask
|
||||
from app.modules.base import MenuItemDefinition, MenuSectionDefinition, ModuleDefinition, PermissionDefinition, ScheduledTask
|
||||
from app.modules.enums import FrontendType
|
||||
|
||||
|
||||
@@ -24,11 +24,11 @@ def _get_vendor_router():
|
||||
return vendor_router
|
||||
|
||||
|
||||
def _get_public_router():
|
||||
"""Lazy import of public router to avoid circular imports."""
|
||||
from app.modules.loyalty.routes.api.public import public_router
|
||||
def _get_platform_router():
|
||||
"""Lazy import of platform router to avoid circular imports."""
|
||||
from app.modules.loyalty.routes.api.platform import platform_router
|
||||
|
||||
return public_router
|
||||
return platform_router
|
||||
|
||||
|
||||
# Loyalty module definition
|
||||
@@ -60,6 +60,33 @@ loyalty_module = ModuleDefinition(
|
||||
"loyalty_stats", # Dashboard statistics
|
||||
"loyalty_reports", # Transaction reports
|
||||
],
|
||||
# Module-driven permissions
|
||||
permissions=[
|
||||
PermissionDefinition(
|
||||
id="loyalty.view_programs",
|
||||
label_key="loyalty.permissions.view_programs",
|
||||
description_key="loyalty.permissions.view_programs_desc",
|
||||
category="loyalty",
|
||||
),
|
||||
PermissionDefinition(
|
||||
id="loyalty.manage_programs",
|
||||
label_key="loyalty.permissions.manage_programs",
|
||||
description_key="loyalty.permissions.manage_programs_desc",
|
||||
category="loyalty",
|
||||
),
|
||||
PermissionDefinition(
|
||||
id="loyalty.view_rewards",
|
||||
label_key="loyalty.permissions.view_rewards",
|
||||
description_key="loyalty.permissions.view_rewards_desc",
|
||||
category="loyalty",
|
||||
),
|
||||
PermissionDefinition(
|
||||
id="loyalty.manage_rewards",
|
||||
label_key="loyalty.permissions.manage_rewards",
|
||||
description_key="loyalty.permissions.manage_rewards_desc",
|
||||
category="loyalty",
|
||||
),
|
||||
],
|
||||
menu_items={
|
||||
FrontendType.ADMIN: [
|
||||
"loyalty-programs", # View all programs
|
||||
@@ -168,8 +195,7 @@ def get_loyalty_module_with_routers() -> ModuleDefinition:
|
||||
"""
|
||||
loyalty_module.admin_router = _get_admin_router()
|
||||
loyalty_module.vendor_router = _get_vendor_router()
|
||||
# Note: public_router needs to be attached separately in main.py
|
||||
# as it doesn't require authentication
|
||||
loyalty_module.platform_router = _get_platform_router()
|
||||
return loyalty_module
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user