Files
AstrBot/astrbot/dashboard/api/sessions.py
Weilong Liao 0d8e8682db refactor(core): migrate backend backbone from Quart to FastAPI and introduce more OpenAPI (#8688)
* refactor: migrate to fastapi

* structure refactor

* fix: pyright fix

* refactor: improve error handling and public messages in plugin services

* feat(api): refactor API client integration and enhance request handling

- Updated API client configuration to use a dedicated HTTP client.
- Introduced utility functions for generating options, queries, and form data for API requests.
- Refactored multiple API methods to utilize the new utility functions for improved consistency and readability.
- Renamed types for clarity and updated import statements accordingly.

feat(docs): add script to update OpenAPI JSON from YAML spec

- Created a Python script to convert OpenAPI YAML specification to JSON format.
- The script supports customizable input and output paths.
- Ensured the script handles directory creation for output paths and validates the YAML structure.

* fix

* feat(auth): implement rate limiting for v1 login endpoint and enhance request handling

* Refactor dashboard API routers to use legacy_router for backward compatibility

- Changed all instances of dashboard_router to legacy_router across multiple API modules including platform, plugins, providers, sessions, skills, stats, subagents, t2i, tools, updates, and asgi_runtime.
- Updated route definitions to ensure existing endpoints remain functional under the new router structure.
- Introduced support for Quart request context in asgi_runtime to enhance compatibility with existing Quart-based plugins.
- Added a test case to validate the functionality of the new Quart request context handling in plugin extensions.

* chore: remove cli test

* fix: update dashboard tests for fastapi migration

* chore: satisfy ruff checks

* fix: update openapi api key scopes

* fix: sync config scope chip selection

* fix: restore quart dependency

* docs: clarify quart plugin api compatibility

* docs: update openapi scope documentation

* fix: use singular skill openapi scope

* fix: hide update service exception details

* fix: address fastapi review comments

* fix: address dashboard review findings

* docs: revert unrelated package deployment changes

* docs: update agent api generation guidance

* feat: add plugin page web api helpers

* docs: add plugin page bridge demo

* fix: type plugin upload files

* fix: stabilize plugin page uploads

* fix: type plugin web request proxy

* docs: remove plugin page docs example

* fix: authenticate plugin page SSE bridge
2026-06-14 15:03:26 +08:00

415 lines
12 KiB
Python

from __future__ import annotations
from fastapi import APIRouter, Depends, Query, Request
from astrbot.core import logger
from astrbot.dashboard.async_utils import run_maybe_async
from astrbot.dashboard.responses import error, ok
from astrbot.dashboard.schemas import (
BatchSessionProviderRequest,
BatchSessionServiceRequest,
SessionGroupRequest,
SessionRuleRequest,
UmoListRequest,
)
from astrbot.dashboard.services.session_management_service import (
SessionManagementService,
SessionManagementServiceError,
)
from .auth import AuthContext, require_dashboard_user, require_scope
router = APIRouter(tags=["Sessions"])
legacy_router = APIRouter(
prefix="/api/session",
tags=["Dashboard Sessions"],
include_in_schema=False,
)
def get_service(request: Request) -> SessionManagementService:
return request.app.state.services.sessions
async def require_data_scope(request: Request) -> AuthContext:
return await require_scope(request, "data")
async def _json_or_empty(request: Request) -> dict:
try:
data = await request.json()
except Exception:
return {}
return data if isinstance(data, dict) else {}
def _service_error(exc: SessionManagementServiceError) -> dict:
return error(str(exc))
def _unexpected_error(prefix: str, exc: Exception) -> dict:
logger.error(f"{prefix}: {exc!s}")
return error(f"{prefix}: {exc!s}")
async def _run(operation, *, label: str) -> dict:
try:
result = await run_maybe_async(operation)
return ok(result)
except SessionManagementServiceError as exc:
return _service_error(exc)
except Exception as exc:
return _unexpected_error(label, exc)
async def _run_dashboard_json(
request: Request,
operation,
*,
label: str,
) -> dict:
body = await _json_or_empty(request)
return await _run(lambda: operation(body), label=label)
@router.get("/sessions")
async def list_sessions(
page: int = Query(1),
page_size: int = Query(20),
search: str = Query(""),
message_type: str = Query("all"),
platform: str = Query(""),
_auth: AuthContext = Depends(require_data_scope),
service: SessionManagementService = Depends(get_service),
):
try:
return ok(
await service.list_all_umos_with_status(
page=page,
page_size=page_size,
search=search.strip(),
message_type=message_type,
platform=platform,
)
)
except SessionManagementServiceError as exc:
return _service_error(exc)
except Exception as exc:
return _unexpected_error("获取会话状态列表失败", exc)
@router.get("/sessions/active-umos")
async def list_active_umos(
_auth: AuthContext = Depends(require_data_scope),
service: SessionManagementService = Depends(get_service),
):
try:
return ok(await service.list_active_umos())
except SessionManagementServiceError as exc:
return _service_error(exc)
except Exception as exc:
return _unexpected_error("获取 UMO 列表失败", exc)
@router.get("/sessions/rules")
async def list_session_rules(
page: int = Query(1),
page_size: int = Query(10),
search: str = Query(""),
_auth: AuthContext = Depends(require_data_scope),
service: SessionManagementService = Depends(get_service),
):
try:
return ok(
await service.list_session_rules(
page=page,
page_size=page_size,
search=search.strip(),
)
)
except SessionManagementServiceError as exc:
return _service_error(exc)
except Exception as exc:
return _unexpected_error("获取规则列表失败", exc)
@router.post("/sessions/rules")
async def update_session_rule(
payload: SessionRuleRequest,
_auth: AuthContext = Depends(require_data_scope),
service: SessionManagementService = Depends(get_service),
):
try:
return ok(
await service.update_session_rule(payload.model_dump(exclude_none=True))
)
except SessionManagementServiceError as exc:
return _service_error(exc)
except Exception as exc:
return _unexpected_error("更新会话规则失败", exc)
@router.post("/sessions/rules/delete")
async def delete_session_rule(
payload: UmoListRequest,
_auth: AuthContext = Depends(require_data_scope),
service: SessionManagementService = Depends(get_service),
):
try:
return ok(
await service.delete_session_rules(payload.model_dump(exclude_none=True))
)
except SessionManagementServiceError as exc:
return _service_error(exc)
except Exception as exc:
return _unexpected_error("删除会话规则失败", exc)
@router.patch("/sessions/provider")
async def update_session_provider(
payload: BatchSessionProviderRequest,
_auth: AuthContext = Depends(require_data_scope),
service: SessionManagementService = Depends(get_service),
):
try:
return ok(
await service.batch_update_provider(payload.model_dump(exclude_none=True))
)
except SessionManagementServiceError as exc:
return _service_error(exc)
except Exception as exc:
return _unexpected_error("批量更新 Provider 失败", exc)
@router.patch("/sessions/service")
async def update_session_service(
payload: BatchSessionServiceRequest,
_auth: AuthContext = Depends(require_data_scope),
service: SessionManagementService = Depends(get_service),
):
try:
return ok(
await service.batch_update_service(payload.model_dump(exclude_none=True))
)
except SessionManagementServiceError as exc:
return _service_error(exc)
except Exception as exc:
return _unexpected_error("批量更新服务状态失败", exc)
@router.get("/session-groups")
async def list_session_groups(
_auth: AuthContext = Depends(require_data_scope),
service: SessionManagementService = Depends(get_service),
):
try:
return ok(service.list_groups())
except SessionManagementServiceError as exc:
return _service_error(exc)
except Exception as exc:
return _unexpected_error("获取分组列表失败", exc)
@router.post("/session-groups")
async def create_session_group(
payload: SessionGroupRequest,
_auth: AuthContext = Depends(require_data_scope),
service: SessionManagementService = Depends(get_service),
):
try:
return ok(service.create_group(payload.model_dump(exclude_none=True)))
except SessionManagementServiceError as exc:
return _service_error(exc)
except Exception as exc:
return _unexpected_error("创建分组失败", exc)
@router.put("/session-groups/{group_id}")
async def update_session_group(
group_id: str,
payload: SessionGroupRequest,
_auth: AuthContext = Depends(require_data_scope),
service: SessionManagementService = Depends(get_service),
):
try:
body = payload.model_dump(exclude_none=True)
return ok(service.update_group({"group_id": group_id, **body}))
except SessionManagementServiceError as exc:
return _service_error(exc)
except Exception as exc:
return _unexpected_error("更新分组失败", exc)
@router.delete("/session-groups/{group_id}")
async def delete_session_group(
group_id: str,
_auth: AuthContext = Depends(require_data_scope),
service: SessionManagementService = Depends(get_service),
):
try:
return ok(service.delete_group({"group_id": group_id}))
except SessionManagementServiceError as exc:
return _service_error(exc)
except Exception as exc:
return _unexpected_error("删除分组失败", exc)
@legacy_router.get("/list-rule")
async def list_dashboard_session_rules(
page: int = Query(1),
page_size: int = Query(10),
search: str = Query(""),
_username: str = Depends(require_dashboard_user),
service: SessionManagementService = Depends(get_service),
):
return await _run(
lambda: service.list_session_rules(
page=page,
page_size=page_size,
search=search.strip(),
),
label="获取规则列表失败",
)
@legacy_router.post("/update-rule")
async def update_dashboard_session_rule(
request: Request,
_username: str = Depends(require_dashboard_user),
service: SessionManagementService = Depends(get_service),
):
return await _run_dashboard_json(
request,
service.update_session_rule,
label="更新会话规则失败",
)
@legacy_router.post("/delete-rule")
async def delete_dashboard_session_rule(
request: Request,
_username: str = Depends(require_dashboard_user),
service: SessionManagementService = Depends(get_service),
):
return await _run_dashboard_json(
request,
service.delete_session_rule,
label="删除会话规则失败",
)
@legacy_router.post("/batch-delete-rule")
async def batch_delete_dashboard_session_rule(
request: Request,
_username: str = Depends(require_dashboard_user),
service: SessionManagementService = Depends(get_service),
):
return await _run_dashboard_json(
request,
service.batch_delete_session_rule,
label="批量删除会话规则失败",
)
@legacy_router.get("/active-umos")
async def list_dashboard_active_umos(
_username: str = Depends(require_dashboard_user),
service: SessionManagementService = Depends(get_service),
):
return await _run(service.list_active_umos, label="获取 UMO 列表失败")
@legacy_router.get("/list-all-with-status")
async def list_dashboard_umos_with_status(
page: int = Query(1),
page_size: int = Query(20),
search: str = Query(""),
message_type: str = Query("all"),
platform: str = Query(""),
_username: str = Depends(require_dashboard_user),
service: SessionManagementService = Depends(get_service),
):
return await _run(
lambda: service.list_all_umos_with_status(
page=page,
page_size=page_size,
search=search.strip(),
message_type=message_type,
platform=platform,
),
label="获取会话状态列表失败",
)
@legacy_router.post("/batch-update-service")
async def batch_update_dashboard_session_service(
request: Request,
_username: str = Depends(require_dashboard_user),
service: SessionManagementService = Depends(get_service),
):
return await _run_dashboard_json(
request,
service.batch_update_service,
label="批量更新服务状态失败",
)
@legacy_router.post("/batch-update-provider")
async def batch_update_dashboard_session_provider(
request: Request,
_username: str = Depends(require_dashboard_user),
service: SessionManagementService = Depends(get_service),
):
return await _run_dashboard_json(
request,
service.batch_update_provider,
label="批量更新 Provider 失败",
)
@legacy_router.get("/groups")
async def list_dashboard_session_groups(
_username: str = Depends(require_dashboard_user),
service: SessionManagementService = Depends(get_service),
):
return await _run(service.list_groups, label="获取分组列表失败")
@legacy_router.post("/group/create")
async def create_dashboard_session_group(
request: Request,
_username: str = Depends(require_dashboard_user),
service: SessionManagementService = Depends(get_service),
):
return await _run_dashboard_json(
request,
service.create_group,
label="创建分组失败",
)
@legacy_router.post("/group/update")
async def update_dashboard_session_group(
request: Request,
_username: str = Depends(require_dashboard_user),
service: SessionManagementService = Depends(get_service),
):
return await _run_dashboard_json(
request,
service.update_group,
label="更新分组失败",
)
@legacy_router.post("/group/delete")
async def delete_dashboard_session_group(
request: Request,
_username: str = Depends(require_dashboard_user),
service: SessionManagementService = Depends(get_service),
):
return await _run_dashboard_json(
request,
service.delete_group,
label="删除分组失败",
)