Files
AstrBot/tests/unit/test_open_api_service_ws.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

134 lines
3.7 KiB
Python

from types import SimpleNamespace
import pytest
from astrbot.dashboard.services.open_api_service import (
OpenApiService,
OpenApiWebSocketChatBridge,
)
def _service() -> OpenApiService:
core_lifecycle = SimpleNamespace(
platform_manager=SimpleNamespace(platform_insts=[]),
platform_message_history_manager=None,
)
return OpenApiService(SimpleNamespace(), core_lifecycle)
def _bridge() -> OpenApiWebSocketChatBridge:
async def build_user_message_parts(_message):
return []
async def create_attachment_from_file(_filename, _attach_type):
return None
async def insert_user_message(_session_id, _effective_username, _message_parts):
pass
async def save_bot_message(_session_id, _message_parts, _agent_stats, _refs):
return None
return OpenApiWebSocketChatBridge(
build_user_message_parts=build_user_message_parts,
create_attachment_from_file=create_attachment_from_file,
extract_web_search_refs=lambda _text, _parts: {},
insert_user_message=insert_user_message,
save_bot_message=save_bot_message,
)
@pytest.mark.asyncio
async def test_run_chat_websocket_closes_when_api_key_is_invalid(monkeypatch):
service = _service()
sent: list[dict] = []
closed: list[tuple[int, str]] = []
async def authenticate_api_key(_raw_key):
return False, "Invalid API key"
monkeypatch.setattr(service, "authenticate_api_key", authenticate_api_key)
async def receive_json():
raise AssertionError("receive_json should not be called")
async def send_json(payload: dict) -> None:
sent.append(payload)
async def close(code: int, reason: str) -> None:
closed.append((code, reason))
await service.run_chat_websocket(
raw_api_key="bad",
receive_json=receive_json,
send_json=send_json,
close=close,
conf_list=[],
chat_bridge=_bridge(),
)
assert sent == [
{"type": "error", "code": "UNAUTHORIZED", "data": "Invalid API key"}
]
assert closed == [(1008, "Invalid API key")]
@pytest.mark.asyncio
async def test_run_chat_websocket_handles_control_messages(monkeypatch):
service = _service()
messages = iter(
[
["not", "an", "object"],
{"t": "ping"},
{"t": "unknown"},
{"t": "send", "message": "hello"},
]
)
sent: list[dict] = []
handled: list[dict] = []
async def authenticate_api_key(_raw_key):
return True, None
async def handle_chat_ws_send(**kwargs):
handled.append(kwargs["post_data"])
monkeypatch.setattr(service, "authenticate_api_key", authenticate_api_key)
monkeypatch.setattr(service, "handle_chat_ws_send", handle_chat_ws_send)
async def receive_json():
try:
return next(messages)
except StopIteration as exc:
raise RuntimeError("disconnect") from exc
async def send_json(payload: dict) -> None:
sent.append(payload)
async def close(_code: int, _reason: str) -> None:
raise AssertionError("close should not be called")
await service.run_chat_websocket(
raw_api_key="good",
receive_json=receive_json,
send_json=send_json,
close=close,
conf_list=[],
chat_bridge=_bridge(),
)
assert sent == [
{
"type": "error",
"code": "INVALID_MESSAGE",
"data": "message must be an object",
},
{"type": "pong"},
{
"type": "error",
"code": "INVALID_MESSAGE",
"data": "Unsupported message type: unknown",
},
]
assert handled == [{"t": "send", "message": "hello"}]