Files
ai_agent/backend/app/admin.py
T
furyhawk 8351e73d39 feat: add Zustand stores for conversation, file preview, sidebar, theme, and knowledge base selection
- Implemented `conversation-store` for managing conversations and messages.
- Created `file-preview-store` to handle file preview state.
- Added `sidebar-store` for sidebar visibility management.
- Developed `theme-store` for theme persistence and management.
- Introduced `kb-selection-store` for managing active knowledge base selections with persistence.

chore: define API and chat types

- Added types for API responses, authentication, chat messages, conversations, and projects.
- Defined interfaces for various entities including users, sessions, and message ratings.

build: configure TypeScript and testing setup

- Set up `tsconfig.json` for TypeScript configuration.
- Created `vitest.config.ts` for testing configuration with Vitest.
- Added `vitest.setup.ts` for global test setup including mocks for Next.js router and media queries.
- Configured Vercel deployment settings in `vercel.json`.
2026-06-11 16:54:43 +08:00

399 lines
12 KiB
Python

"""SQLAdmin configuration with automatic model discovery."""
from typing import Any, ClassVar
from fastapi import FastAPI
from sqladmin import Admin, ModelView
from sqladmin.authentication import AuthenticationBackend
from sqlalchemy import String, inspect
from sqlalchemy.engine import Engine
from sqlalchemy.orm import DeclarativeBase
from starlette.requests import Request
from app.core.config import settings
from app.core.security import verify_password
from app.db.base import Base
from app.db.models.conversation import ToolCall
from app.db.models.user import User, UserRole
# Columns that should be excluded from forms (sensitive data)
SENSITIVE_COLUMN_PATTERNS: list[str] = [
"password",
"hashed_password",
"secret",
"token",
"api_key",
"refresh_token",
]
# Columns that should be searchable by default (string columns)
SEARCHABLE_COLUMN_TYPES: tuple[type, ...] = (String,)
# Columns that are auto-generated and should be excluded from create/edit forms
AUTO_GENERATED_COLUMNS: list[str] = [
"created_at",
"updated_at",
]
# Model icons mapping (model name -> Font Awesome icon)
MODEL_ICONS: dict[str, str] = {
"User": "fa-solid fa-user",
"Session": "fa-solid fa-key",
"Conversation": "fa-solid fa-comments",
"Message": "fa-solid fa-message",
"ToolCall": "fa-solid fa-wrench",
"Webhook": "fa-solid fa-link",
"WebhookDelivery": "fa-solid fa-paper-plane",
}
def discover_models(base: type[DeclarativeBase]) -> list[type]:
"""Discover all SQLAlchemy models registered with the given Base.
Args:
base: The SQLAlchemy DeclarativeBase class.
Returns:
List of model classes that inherit from the Base.
"""
return [mapper.class_ for mapper in base.registry.mappers]
def get_model_columns(model: type) -> list[str]:
"""Get all column names from a SQLAlchemy model.
Args:
model: The SQLAlchemy model class.
Returns:
List of column names.
"""
mapper: Any = inspect(model)
return [column.key for column in mapper.columns]
def get_searchable_columns(model: type) -> list[str]:
"""Get columns suitable for searching (String type columns).
Args:
model: The SQLAlchemy model class.
Returns:
List of searchable column names.
"""
mapper: Any = inspect(model)
searchable = []
for column in mapper.columns:
# Include String columns that are not sensitive
is_searchable_type = isinstance(column.type, SEARCHABLE_COLUMN_TYPES)
is_sensitive = any(pattern in column.key.lower() for pattern in SENSITIVE_COLUMN_PATTERNS)
if is_searchable_type and not is_sensitive:
searchable.append(column.key)
return searchable
def get_sortable_columns(model: type) -> list[str]:
"""Get columns suitable for sorting.
Args:
model: The SQLAlchemy model class.
Returns:
List of sortable column names.
"""
mapper: Any = inspect(model)
return [column.key for column in mapper.columns]
def get_form_excluded_columns(model: type) -> list[str]:
"""Get columns that should be excluded from create/edit forms.
Excludes sensitive columns and auto-generated columns.
Args:
model: The SQLAlchemy model class.
Returns:
List of column names to exclude from forms.
"""
excluded = []
for column_name in get_model_columns(model):
# Exclude sensitive columns
if (
any(pattern in column_name.lower() for pattern in SENSITIVE_COLUMN_PATTERNS)
or column_name in AUTO_GENERATED_COLUMNS
):
excluded.append(column_name)
return excluded
def pluralize(name: str) -> str:
"""Simple pluralization for model names.
Args:
name: Singular name.
Returns:
Pluralized name.
"""
if name.endswith("y"):
return name[:-1] + "ies"
elif name.endswith("s") or name.endswith("x") or name.endswith("ch") or name.endswith("sh"):
return name + "es"
return name + "s"
def create_model_admin(
model: type,
*,
name: str | None = None,
name_plural: str | None = None,
icon: str | None = None,
column_list: list[Any] | None = None,
column_searchable_list: list[Any] | None = None,
column_sortable_list: list[Any] | None = None,
form_excluded_columns: list[Any] | None = None,
can_create: bool = True,
can_edit: bool = True,
can_delete: bool = True,
can_view_details: bool = True,
) -> type[ModelView]:
"""Dynamically create a ModelView class for a SQLAlchemy model.
Args:
model: The SQLAlchemy model class.
name: Display name (defaults to model class name).
name_plural: Plural display name (defaults to auto-pluralized name).
icon: Font Awesome icon class.
column_list: Columns to display in list view.
column_searchable_list: Columns to enable search on.
column_sortable_list: Columns to enable sorting on.
form_excluded_columns: Columns to exclude from forms.
can_create: Allow creating new records.
can_edit: Allow editing records.
can_delete: Allow deleting records.
can_view_details: Allow viewing record details.
Returns:
A dynamically created ModelView subclass.
"""
import types
model_name = model.__name__
# Use provided values or generate defaults
_name = name or model_name
_name_plural = name_plural or pluralize(_name)
_icon = icon or MODEL_ICONS.get(model_name, "fa-solid fa-database")
# Get column attributes from the model
_column_list = column_list
if _column_list is None:
columns = get_model_columns(model)
_column_list = [getattr(model, col) for col in columns if hasattr(model, col)]
_column_searchable_list = column_searchable_list
if _column_searchable_list is None:
searchable = get_searchable_columns(model)
_column_searchable_list = [getattr(model, col) for col in searchable if hasattr(model, col)]
_column_sortable_list = column_sortable_list
if _column_sortable_list is None:
sortable = get_sortable_columns(model)
_column_sortable_list = [getattr(model, col) for col in sortable if hasattr(model, col)]
_form_excluded_columns = form_excluded_columns
if _form_excluded_columns is None:
excluded = get_form_excluded_columns(model)
_form_excluded_columns = [getattr(model, col) for col in excluded if hasattr(model, col)]
# Create class attributes in the exec_body callback
def exec_body(ns: dict[str, Any]) -> None:
ns["name"] = _name
ns["name_plural"] = _name_plural
ns["icon"] = _icon
ns["column_list"] = _column_list
ns["column_searchable_list"] = _column_searchable_list
ns["column_sortable_list"] = _column_sortable_list
ns["form_excluded_columns"] = _form_excluded_columns
ns["can_create"] = can_create
ns["can_edit"] = can_edit
ns["can_delete"] = can_delete
ns["can_view_details"] = can_view_details
# Add ClassVar type hints for sqladmin compatibility
ns["__annotations__"] = {
"column_list": ClassVar,
"column_searchable_list": ClassVar,
"column_sortable_list": ClassVar,
"form_excluded_columns": ClassVar,
"can_create": ClassVar,
"can_edit": ClassVar,
"can_delete": ClassVar,
"can_view_details": ClassVar,
}
# Create the class using types.new_class to properly pass model kwarg to metaclass
class_name = f"{model_name}Admin"
admin_class = types.new_class(
class_name,
(ModelView,),
{"model": model}, # Pass model to metaclass
exec_body,
)
return admin_class
def register_models_auto(
admin: Admin,
base: type[DeclarativeBase],
*,
exclude_models: list[type] | None = None,
custom_configs: dict[type, dict[str, Any]] | None = None,
) -> list[type[ModelView]]:
"""Auto-discover and register all models with the admin panel.
Args:
admin: The SQLAdmin instance.
base: The SQLAlchemy DeclarativeBase class.
exclude_models: Models to exclude from auto-registration.
custom_configs: Custom configuration overrides per model.
Returns:
List of registered ModelView classes.
"""
exclude_models = exclude_models or []
custom_configs = custom_configs or {}
registered_views: list[type[ModelView]] = []
models = discover_models(base)
for model in models:
if model in exclude_models:
continue
# Get custom config for this model if provided
config = custom_configs.get(model, {})
# Create and register the admin view
admin_class = create_model_admin(model, **config)
admin.add_view(admin_class)
registered_views.append(admin_class)
return registered_views
# SQLAdmin requires a synchronous engine
_sync_engine: Engine | None = None
def get_sync_engine() -> Engine:
"""Get or create the synchronous engine for SQLAdmin."""
global _sync_engine
if _sync_engine is None:
from sqlalchemy import create_engine
_sync_engine = create_engine(settings.DATABASE_URL_SYNC, echo=settings.DEBUG)
return _sync_engine
class AdminAuth(AuthenticationBackend):
"""Admin panel authentication backend.
Requires superuser credentials to access the admin panel.
"""
async def login(self, request: Request) -> bool:
"""Validate admin login credentials."""
form = await request.form()
email = form.get("username")
password = form.get("password")
if not email or not password:
return False
assert isinstance(email, str)
assert isinstance(password, str)
# Get user from database
from sqlalchemy.orm import Session as DBSession
with DBSession(get_sync_engine()) as session:
user = session.query(User).filter(User.email == email).first()
if (
user
and user.hashed_password
and verify_password(password, user.hashed_password)
and user.has_role(UserRole.ADMIN)
):
# Store user info in session
request.session["admin_user_id"] = str(user.id)
request.session["admin_email"] = user.email
return True
return False
async def logout(self, request: Request) -> bool:
"""Clear admin session."""
request.session.clear()
return True
async def authenticate(self, request: Request) -> bool:
"""Check if user is authenticated."""
admin_user_id = request.session.get("admin_user_id")
if not admin_user_id:
return False
# Verify user still exists and is superuser
from sqlalchemy.orm import Session as DBSession
with DBSession(get_sync_engine()) as session:
user = session.query(User).filter(User.id == admin_user_id).first()
if user and user.has_role(UserRole.ADMIN) and user.is_active:
return True
# User no longer valid, clear session
request.session.clear()
return False
CUSTOM_MODEL_CONFIGS: dict[type, dict[str, Any]] = {
User: {
"icon": "fa-solid fa-user",
"form_excluded_columns": [User.hashed_password, User.created_at, User.updated_at],
},
ToolCall: {
"icon": "fa-solid fa-wrench",
"can_create": False, # Tool calls are created by the agent
},
}
def setup_admin(app: FastAPI) -> Admin:
"""Setup SQLAdmin for the FastAPI app with automatic model discovery.
Automatically discovers all SQLAlchemy models from the Base registry
and creates admin views for them with sensible defaults.
Custom configurations can be provided in CUSTOM_MODEL_CONFIGS to override
default behavior for specific models.
"""
sync_engine = get_sync_engine()
authentication_backend = AdminAuth(secret_key=settings.SECRET_KEY)
admin = Admin(
app,
sync_engine,
title="ai_agent Admin",
authentication_backend=authentication_backend,
)
# Auto-register all models from Base with custom configs
register_models_auto(
admin,
Base,
custom_configs=CUSTOM_MODEL_CONFIGS,
)
return admin