sboulahtit/orion
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: standardize modular architecture patterns

Browse Source 
- Rename module definition variables to follow naming convention:
  - catalog/definition.py: module → catalog_module
  - checkout/definition.py: module → checkout_module
  - cart/definition.py: module → cart_module

- Add router attachment functions for lazy loading:
  - get_catalog_module_with_routers()
  - get_checkout_module_with_routers()
  - get_cart_module_with_routers()

- Move billing exceptions to exceptions.py:
  - Add backwards-compatible aliases (BillingServiceError, etc.)
  - Update billing_service.py to import from exceptions.py

- Standardize VendorEmailSettingsService DI pattern:
  - Change from db in __init__ to db as method parameter
  - Create singleton vendor_email_settings_service instance
  - Update routes and tests to use new pattern

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Samir Boulahtit
2026-02-03 18:40:03 +01:00
parent b769f5a047
commit a76128e016
11 changed files with 209 additions and 142 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
app/modules/cms/services/__init__.py
View File

@@ -19,7 +19,8 @@ from app.modules.cms.services.vendor_theme_service import (
)
from app.modules.cms.services.vendor_email_settings_service import (
VendorEmailSettingsService,
get_vendor_email_settings_service,
vendor_email_settings_service,
get_vendor_email_settings_service, # Deprecated: use vendor_email_settings_service
)
__all__ = [
@@ -30,5 +31,6 @@ __all__ = [
"VendorThemeService",
"vendor_theme_service",
"VendorEmailSettingsService",
"get_vendor_email_settings_service",
"vendor_email_settings_service",
"get_vendor_email_settings_service", # Deprecated
]

63
app/modules/cms/services/vendor_email_settings_service.py
View File

@@ -42,24 +42,21 @@ PREMIUM_TIERS = {TierCode.BUSINESS, TierCode.ENTERPRISE}
class VendorEmailSettingsService:
"""Service for managing vendor email settings."""
def __init__(self, db: Session):
self.db = db
# =========================================================================
# READ OPERATIONS
# =========================================================================
def get_settings(self, vendor_id: int) -> VendorEmailSettings | None:
def get_settings(self, db: Session, vendor_id: int) -> VendorEmailSettings | None:
"""Get email settings for a vendor."""
return (
self.db.query(VendorEmailSettings)
db.query(VendorEmailSettings)
.filter(VendorEmailSettings.vendor_id == vendor_id)
.first()
)
def get_settings_or_404(self, vendor_id: int) -> VendorEmailSettings:
def get_settings_or_404(self, db: Session, vendor_id: int) -> VendorEmailSettings:
"""Get email settings or raise 404."""
settings = self.get_settings(vendor_id)
settings = self.get_settings(db, vendor_id)
if not settings:
raise ResourceNotFoundException(
resource_type="vendor_email_settings",
@@ -67,19 +64,19 @@ class VendorEmailSettingsService:
)
return settings
def is_configured(self, vendor_id: int) -> bool:
def is_configured(self, db: Session, vendor_id: int) -> bool:
"""Check if vendor has configured email settings."""
settings = self.get_settings(vendor_id)
settings = self.get_settings(db, vendor_id)
return settings is not None and settings.is_configured
def get_status(self, vendor_id: int) -> dict:
def get_status(self, db: Session, vendor_id: int) -> dict:
"""
Get email configuration status for a vendor.
Returns:
dict with is_configured, is_verified, provider, etc.
"""
settings = self.get_settings(vendor_id)
settings = self.get_settings(db, vendor_id)
if not settings:
return {
"is_configured": False,
@@ -115,6 +112,7 @@ class VendorEmailSettingsService:
def create_or_update(
self,
db: Session,
vendor_id: int,
data: dict,
current_tier: TierCode | None = None,
@@ -123,6 +121,7 @@ class VendorEmailSettingsService:
Create or update vendor email settings.
Args:
db: Database session
vendor_id: Vendor ID
data: Settings data (from_email, from_name, smtp_*, etc.)
current_tier: Vendor's current subscription tier (for premium provider validation)
@@ -143,10 +142,10 @@ class VendorEmailSettingsService:
details={"required_permission": "business_tier"},
)
settings = self.get_settings(vendor_id)
settings = self.get_settings(db, vendor_id)
if not settings:
settings = VendorEmailSettings(vendor_id=vendor_id)
self.db.add(settings)
db.add(settings)
# Update fields
for field in [
@@ -190,36 +189,41 @@ class VendorEmailSettingsService:
settings.is_verified = False
settings.verification_error = None
self.db.flush()
db.flush()
logger.info(f"Updated email settings for vendor {vendor_id}: provider={settings.provider}")
return settings
def delete(self, vendor_id: int) -> None:
def delete(self, db: Session, vendor_id: int) -> None:
"""
Delete email settings for a vendor.
Args:
db: Database session
vendor_id: Vendor ID
Raises:
ResourceNotFoundException: If settings not found
"""
settings = self.get_settings(vendor_id)
settings = self.get_settings(db, vendor_id)
if not settings:
raise ResourceNotFoundException(
resource_type="vendor_email_settings",
identifier=str(vendor_id),
)
self.db.delete(settings)
self.db.flush()
db.delete(settings)
db.flush()
logger.info(f"Deleted email settings for vendor {vendor_id}")
# =========================================================================
# VERIFICATION
# =========================================================================
def verify_settings(self, vendor_id: int, test_email: str) -> dict:
def verify_settings(self, db: Session, vendor_id: int, test_email: str) -> dict:
"""
Verify email settings by sending a test email.
Args:
db: Database session
vendor_id: Vendor ID
test_email: Email address to send test email to
@@ -230,7 +234,7 @@ class VendorEmailSettingsService:
ResourceNotFoundException: If settings not found
ValidationException: If settings incomplete
"""
settings = self.get_settings_or_404(vendor_id)
settings = self.get_settings_or_404(db, vendor_id)
if not settings.is_fully_configured():
raise ValidationException(
@@ -256,7 +260,7 @@ class VendorEmailSettingsService:
# Mark as verified
settings.mark_verified()
self.db.flush()
db.flush()
logger.info(f"Email settings verified for vendor {vendor_id}")
return {
@@ -269,7 +273,7 @@ class VendorEmailSettingsService:
except Exception as e:
error_msg = str(e)
settings.mark_verification_failed(error_msg)
self.db.flush()
db.flush()
logger.warning(f"Email verification failed for vendor {vendor_id}: {error_msg}")
# Return error dict instead of raising - verification failure is not a server error
@@ -476,7 +480,16 @@ class VendorEmailSettingsService:
return providers
# Module-level service factory
# Module-level service instance (singleton pattern)
vendor_email_settings_service = VendorEmailSettingsService()
# Deprecated: Factory function for backwards compatibility
def get_vendor_email_settings_service(db: Session) -> VendorEmailSettingsService:
"""Factory function to get a VendorEmailSettingsService instance."""
return VendorEmailSettingsService(db)
"""
Factory function to get a VendorEmailSettingsService instance.
Deprecated: Use the singleton `vendor_email_settings_service` instead and pass
`db` to individual methods.
"""
return vendor_email_settings_service