fix: resolve circular import in module system
The circular import occurred because: 1. app.modules.base imported FrontendType from models.database.admin_menu_config 2. This triggered models/database/__init__.py which runs model discovery 3. Model discovery imported module definitions 4. Module definitions imported from app.modules.base (still initializing) Solution: Move FrontendType and MANDATORY_MENU_ITEMS to a new app/modules/enums.py file. The models file re-exports them for backward compatibility with existing imports. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
@@ -44,7 +44,7 @@ if TYPE_CHECKING:
|
|||||||
from fastapi import APIRouter
|
from fastapi import APIRouter
|
||||||
from pydantic import BaseModel
|
from pydantic import BaseModel
|
||||||
|
|
||||||
from models.database.admin_menu_config import FrontendType
|
from app.modules.enums import FrontendType
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
@dataclass
|
||||||
|
|||||||
46
app/modules/enums.py
Normal file
46
app/modules/enums.py
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
# app/modules/enums.py
|
||||||
|
"""
|
||||||
|
Module system enums.
|
||||||
|
|
||||||
|
This file contains enums used by the module system that need to be
|
||||||
|
importable without triggering database model imports.
|
||||||
|
|
||||||
|
The FrontendType enum is defined here to break a circular import:
|
||||||
|
- app.modules.base imports FrontendType
|
||||||
|
- Previously FrontendType was in models.database.admin_menu_config
|
||||||
|
- Importing from models.database triggers model discovery
|
||||||
|
- Model discovery imports module definitions
|
||||||
|
- Module definitions import from app.modules.base → CIRCULAR
|
||||||
|
|
||||||
|
By defining FrontendType here, we break this cycle.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import enum
|
||||||
|
|
||||||
|
|
||||||
|
class FrontendType(str, enum.Enum):
|
||||||
|
"""Frontend types that can have menu configuration."""
|
||||||
|
|
||||||
|
ADMIN = "admin" # Admin panel (super admins, platform admins)
|
||||||
|
VENDOR = "vendor" # Vendor dashboard
|
||||||
|
|
||||||
|
|
||||||
|
# Menu items that cannot be hidden - always visible regardless of config
|
||||||
|
# Organized by frontend type
|
||||||
|
MANDATORY_MENU_ITEMS = {
|
||||||
|
FrontendType.ADMIN: frozenset({
|
||||||
|
"dashboard", # Default landing page after login
|
||||||
|
"companies",
|
||||||
|
"vendors",
|
||||||
|
"admin-users",
|
||||||
|
"settings",
|
||||||
|
"my-menu", # Super admin menu config - must always be accessible
|
||||||
|
}),
|
||||||
|
FrontendType.VENDOR: frozenset({
|
||||||
|
"dashboard", # Default landing page after login
|
||||||
|
"settings",
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = ["FrontendType", "MANDATORY_MENU_ITEMS"]
|
||||||
@@ -19,8 +19,6 @@ Design:
|
|||||||
- Only stores non-default state (is_visible=False) to keep table small
|
- Only stores non-default state (is_visible=False) to keep table small
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import enum
|
|
||||||
|
|
||||||
from sqlalchemy import (
|
from sqlalchemy import (
|
||||||
Boolean,
|
Boolean,
|
||||||
CheckConstraint,
|
CheckConstraint,
|
||||||
@@ -37,30 +35,11 @@ from sqlalchemy.orm import relationship
|
|||||||
from app.core.database import Base
|
from app.core.database import Base
|
||||||
from models.database.base import TimestampMixin
|
from models.database.base import TimestampMixin
|
||||||
|
|
||||||
|
# Import FrontendType and MANDATORY_MENU_ITEMS from the central location
|
||||||
class FrontendType(str, enum.Enum):
|
# and re-export for backward compatibility with existing imports.
|
||||||
"""Frontend types that can have menu configuration."""
|
# These were moved to app.modules.enums to break a circular import:
|
||||||
|
# app.modules.base -> models.database -> model discovery -> module definitions -> app.modules.base
|
||||||
ADMIN = "admin" # Admin panel (super admins, platform admins)
|
from app.modules.enums import FrontendType, MANDATORY_MENU_ITEMS
|
||||||
VENDOR = "vendor" # Vendor dashboard
|
|
||||||
|
|
||||||
|
|
||||||
# Menu items that cannot be hidden - always visible regardless of config
|
|
||||||
# Organized by frontend type
|
|
||||||
MANDATORY_MENU_ITEMS = {
|
|
||||||
FrontendType.ADMIN: frozenset({
|
|
||||||
"dashboard", # Default landing page after login
|
|
||||||
"companies",
|
|
||||||
"vendors",
|
|
||||||
"admin-users",
|
|
||||||
"settings",
|
|
||||||
"my-menu", # Super admin menu config - must always be accessible
|
|
||||||
}),
|
|
||||||
FrontendType.VENDOR: frozenset({
|
|
||||||
"dashboard", # Default landing page after login
|
|
||||||
"settings",
|
|
||||||
}),
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
class AdminMenuConfig(Base, TimestampMixin):
|
class AdminMenuConfig(Base, TimestampMixin):
|
||||||
|
|||||||
Reference in New Issue
Block a user