Files
AstrBot/astrbot/dashboard/api/chat_projects.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

216 lines
6.4 KiB
Python

from __future__ import annotations
from fastapi import APIRouter, Depends, Query, Request
from astrbot.dashboard.async_utils import run_maybe_async
from astrbot.dashboard.responses import error, ok
from astrbot.dashboard.schemas import ChatProjectRequest
from astrbot.dashboard.services.chatui_project_service import (
ChatUIProjectService,
ChatUIProjectServiceError,
)
from .auth import AuthContext, require_dashboard_user, require_scope
router = APIRouter(tags=["Chat Projects"])
legacy_router = APIRouter(
prefix="/api/chatui_project",
tags=["Dashboard Chat Projects"],
include_in_schema=False,
)
def get_service(request: Request) -> ChatUIProjectService:
return request.app.state.services.chat_projects
async def require_chat_scope(request: Request) -> AuthContext:
return await require_scope(request, "chat")
async def _json_or_empty(request: Request) -> dict:
try:
data = await request.json()
except Exception:
return {}
return data if isinstance(data, dict) else {}
def _model_dict(payload) -> dict:
return payload.model_dump(exclude_none=True)
async def _run(operation):
try:
result = await run_maybe_async(operation)
return ok(result)
except ChatUIProjectServiceError as exc:
return error(str(exc))
@router.get("/chat/projects")
async def list_chat_projects(
auth: AuthContext = Depends(require_chat_scope),
service: ChatUIProjectService = Depends(get_service),
):
return await _run(lambda: service.list_projects(auth.username))
@legacy_router.get("/list")
async def list_dashboard_chat_projects(
username: str = Depends(require_dashboard_user),
service: ChatUIProjectService = Depends(get_service),
):
return await _run(lambda: service.list_projects(username))
@router.post("/chat/projects")
async def create_chat_project(
payload: ChatProjectRequest,
auth: AuthContext = Depends(require_chat_scope),
service: ChatUIProjectService = Depends(get_service),
):
return await _run(
lambda: service.create_project(auth.username, _model_dict(payload))
)
@legacy_router.post("/create")
async def create_dashboard_chat_project(
request: Request,
username: str = Depends(require_dashboard_user),
service: ChatUIProjectService = Depends(get_service),
):
body = await _json_or_empty(request)
return await _run(lambda: service.create_project(username, body))
@router.get("/chat/projects/{project_id}")
async def get_chat_project(
project_id: str,
auth: AuthContext = Depends(require_chat_scope),
service: ChatUIProjectService = Depends(get_service),
):
return await _run(lambda: service.get_project(auth.username, project_id))
@legacy_router.get("/get")
async def get_dashboard_chat_project(
project_id: str | None = Query(default=None),
username: str = Depends(require_dashboard_user),
service: ChatUIProjectService = Depends(get_service),
):
return await _run(lambda: service.get_project_from_query(username, project_id))
@router.patch("/chat/projects/{project_id}")
async def update_chat_project(
project_id: str,
payload: ChatProjectRequest,
auth: AuthContext = Depends(require_chat_scope),
service: ChatUIProjectService = Depends(get_service),
):
return await _run(
lambda: service.update_project(
auth.username,
{"project_id": project_id, **_model_dict(payload)},
)
)
@legacy_router.post("/update")
async def update_dashboard_chat_project(
request: Request,
username: str = Depends(require_dashboard_user),
service: ChatUIProjectService = Depends(get_service),
):
body = await _json_or_empty(request)
return await _run(lambda: service.update_project(username, body))
@router.delete("/chat/projects/{project_id}")
async def delete_chat_project(
project_id: str,
auth: AuthContext = Depends(require_chat_scope),
service: ChatUIProjectService = Depends(get_service),
):
return await _run(lambda: service.delete_project(auth.username, project_id))
@legacy_router.get("/delete")
async def delete_dashboard_chat_project(
project_id: str | None = Query(default=None),
username: str = Depends(require_dashboard_user),
service: ChatUIProjectService = Depends(get_service),
):
return await _run(lambda: service.delete_project_from_query(username, project_id))
@router.get("/chat/projects/{project_id}/sessions")
async def list_chat_project_sessions(
project_id: str,
auth: AuthContext = Depends(require_chat_scope),
service: ChatUIProjectService = Depends(get_service),
):
return await _run(lambda: service.get_project_sessions(auth.username, project_id))
@legacy_router.get("/get_sessions")
async def list_dashboard_chat_project_sessions(
project_id: str | None = Query(default=None),
username: str = Depends(require_dashboard_user),
service: ChatUIProjectService = Depends(get_service),
):
return await _run(
lambda: service.get_project_sessions_from_query(username, project_id)
)
@router.post("/chat/projects/{project_id}/sessions/{session_id}")
async def add_chat_project_session(
project_id: str,
session_id: str,
auth: AuthContext = Depends(require_chat_scope),
service: ChatUIProjectService = Depends(get_service),
):
return await _run(
lambda: service.add_session_to_project(
auth.username,
{"project_id": project_id, "session_id": session_id},
)
)
@legacy_router.post("/add_session")
async def add_dashboard_chat_project_session(
request: Request,
username: str = Depends(require_dashboard_user),
service: ChatUIProjectService = Depends(get_service),
):
body = await _json_or_empty(request)
return await _run(lambda: service.add_session_to_project(username, body))
@router.delete("/chat/projects/sessions/{session_id}")
async def remove_chat_project_session(
session_id: str,
auth: AuthContext = Depends(require_chat_scope),
service: ChatUIProjectService = Depends(get_service),
):
return await _run(
lambda: service.remove_session_from_project(
auth.username,
{"session_id": session_id},
)
)
@legacy_router.post("/remove_session")
async def remove_dashboard_chat_project_session(
request: Request,
username: str = Depends(require_dashboard_user),
service: ChatUIProjectService = Depends(get_service),
):
body = await _json_or_empty(request)
return await _run(lambda: service.remove_session_from_project(username, body))