mirror of
https://github.com/insistence/RuoYi-Vue3-FastAPI.git
synced 2026-10-17 06:55:35 +00:00
insistence
4bd83bc7cd
* feat: 支持 v2 插件、原生扩展与签名发布 * fix: 修复测试 * feat: 增强宿主 SDK、运行观测与制品维护能力 * feat: 增强文件传输、配置观测与本地开发能力 * feat: 支持 SSE 实时事件流并完善开发脚手架 * feat: 完善长连接鉴权复核与关闭回收 * feat: 增强生命周期与任务关闭可靠性 * feat: 收紧健康检查契约并补齐前端与真实网络验收 * feat: 增加SDK溯源与离线更新工具并验证跨版本兼容 * feat: 增加持久化业务示例与受控 Python 交付 * feat: 增加统一运行诊断与多worker状态观测 * feat: 增加固定目标发布等待与自动验收 * fix: 修复多环境插件部署前缀与代理配置不一致 * fix: 修复测试
249 lines
8.6 KiB
Python
249 lines
8.6 KiB
Python
import asyncio
|
|
import inspect
|
|
from dataclasses import dataclass
|
|
from time import perf_counter
|
|
from typing import Any, cast
|
|
|
|
from common.constant import PluginRuntimeConstant
|
|
from plugins.core.discovery.scanner import DiscoveredPlugin
|
|
from plugins.core.runtime.callable import LoadedPluginCallable, PluginCallableLoader
|
|
from plugins.core.sdk.definition import await_plugin_callback
|
|
from plugins.core.types import JSONObject
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class PluginHealthContext:
|
|
"""
|
|
插件健康检查上下文。
|
|
|
|
:param plugin_id: 插件 ID
|
|
:param discovered_plugin: 已发现插件对象
|
|
:param app: FastAPI 应用对象
|
|
:param query_db: orm对象
|
|
"""
|
|
|
|
plugin_id: str
|
|
discovered_plugin: DiscoveredPlugin
|
|
app: Any | None = None
|
|
query_db: Any | None = None
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class PluginHealthResult:
|
|
"""
|
|
插件健康检查结果。
|
|
|
|
:param plugin_id: 插件 ID
|
|
:param ok: 健康检查是否通过
|
|
:param status: 健康状态
|
|
:param message: 健康检查说明
|
|
:param checker: 健康检查声明路径
|
|
:param duration_ms: 检查耗时毫秒
|
|
:param details: 健康检查扩展详情
|
|
:param error: 健康检查异常信息
|
|
"""
|
|
|
|
plugin_id: str
|
|
ok: bool
|
|
status: str
|
|
message: str
|
|
checker: str | None
|
|
duration_ms: float
|
|
details: JSONObject
|
|
error: str | None = None
|
|
|
|
|
|
class PluginHealthChecker:
|
|
"""
|
|
插件健康检查器。
|
|
|
|
使用 Strategy + Command Runner 思路执行插件 manifest 中声明的只读健康检查 callable。
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
discovered_plugin: DiscoveredPlugin,
|
|
*,
|
|
timeout_seconds: float | None = None,
|
|
) -> None:
|
|
"""
|
|
初始化插件健康检查器。
|
|
|
|
:param discovered_plugin: 已发现插件对象
|
|
:param timeout_seconds: 异步健康检查超时时间
|
|
:return: None
|
|
"""
|
|
self.discovered_plugin = discovered_plugin
|
|
self.timeout_seconds = timeout_seconds or PluginRuntimeConstant.PLUGIN_HEALTH_TIMEOUT_SECONDS
|
|
|
|
async def check(self, *, app: Any | None = None, query_db: Any | None = None) -> PluginHealthResult:
|
|
"""
|
|
执行插件健康检查。
|
|
|
|
:param app: FastAPI 应用对象
|
|
:param query_db: orm对象
|
|
:return: 插件健康检查结果
|
|
"""
|
|
checker_path = self.discovered_plugin.manifest.backend.health.checker
|
|
started_at = perf_counter()
|
|
if not checker_path:
|
|
return self._build_result(
|
|
ok=True,
|
|
status='unknown',
|
|
message='插件未声明健康检查',
|
|
checker=None,
|
|
started_at=started_at,
|
|
)
|
|
|
|
try:
|
|
checker_callable = self._load_checker_callable(checker_path)
|
|
context = PluginHealthContext(
|
|
plugin_id=self.discovered_plugin.manifest.id,
|
|
discovered_plugin=self.discovered_plugin,
|
|
app=app,
|
|
query_db=query_db,
|
|
)
|
|
raw_result = await self._invoke_checker_with_timeout(checker_callable, context)
|
|
return self._normalize_result(raw_result, checker_path, started_at)
|
|
except asyncio.TimeoutError:
|
|
return self._build_result(
|
|
ok=False,
|
|
status='timeout',
|
|
message='插件健康检查执行超时',
|
|
checker=checker_path,
|
|
started_at=started_at,
|
|
error=f'插件健康检查执行超时，超过 {self.timeout_seconds} 秒',
|
|
)
|
|
except Exception as exc:
|
|
return self._build_result(
|
|
ok=False,
|
|
status='error',
|
|
message='插件健康检查执行失败',
|
|
checker=checker_path,
|
|
started_at=started_at,
|
|
error=str(exc),
|
|
)
|
|
|
|
def _load_checker_callable(self, checker_path: str) -> LoadedPluginCallable:
|
|
"""
|
|
加载健康检查 callable。
|
|
|
|
:param checker_path: 健康检查声明路径
|
|
:return: 健康检查 callable
|
|
"""
|
|
return PluginCallableLoader(self.discovered_plugin, label='健康检查').load(checker_path)
|
|
|
|
async def _invoke_checker_with_timeout(
|
|
self,
|
|
checker_callable: LoadedPluginCallable,
|
|
context: PluginHealthContext,
|
|
) -> object:
|
|
"""
|
|
在超时约束内执行健康检查 callable。
|
|
|
|
:param checker_callable: 已加载的健康检查 callable
|
|
:param context: 健康检查上下文
|
|
:return: 健康检查原始返回值
|
|
"""
|
|
callable_object = checker_callable.callable_object
|
|
if self.discovered_plugin.manifest.uses_entrypoint:
|
|
return await await_plugin_callback(callable_object, context, timeout=self.timeout_seconds)
|
|
if not inspect.iscoroutinefunction(callable_object):
|
|
raise TypeError('插件健康检查必须使用 async def 声明，平台不会在线程中执行不可终止的同步检查')
|
|
raw_result = self._invoke_checker(checker_callable, context)
|
|
if inspect.isawaitable(raw_result):
|
|
return await asyncio.wait_for(raw_result, timeout=self.timeout_seconds)
|
|
|
|
return raw_result
|
|
|
|
@staticmethod
|
|
def _invoke_checker(checker_callable: LoadedPluginCallable, context: PluginHealthContext) -> object:
|
|
"""
|
|
调用健康检查 callable。
|
|
|
|
:param checker_callable: 已加载的健康检查 callable
|
|
:param context: 健康检查上下文
|
|
:return: 健康检查原始返回值
|
|
"""
|
|
callable_object = checker_callable.callable_object
|
|
signature = inspect.signature(callable_object)
|
|
if not signature.parameters:
|
|
return callable_object()
|
|
|
|
return callable_object(context)
|
|
|
|
def _normalize_result(self, raw_result: object, checker_path: str, started_at: float) -> PluginHealthResult:
|
|
"""
|
|
规范化健康检查返回值。
|
|
|
|
:param raw_result: 健康检查原始返回值
|
|
:param checker_path: 健康检查声明路径
|
|
:param started_at: 检查开始时间
|
|
:return: 插件健康检查结果
|
|
"""
|
|
if self.discovered_plugin.manifest.uses_entrypoint and not (
|
|
isinstance(raw_result, bool) or (isinstance(raw_result, dict) and isinstance(raw_result.get('ok'), bool))
|
|
):
|
|
raise TypeError('v2 插件健康检查必须返回 bool 或包含 bool 类型 ok 字段的字典')
|
|
if isinstance(raw_result, dict):
|
|
raw_details = raw_result.get('details')
|
|
ok = bool(raw_result.get('ok', raw_result.get('healthy', True)))
|
|
return self._build_result(
|
|
ok=ok,
|
|
status=str(raw_result.get('status') or ('healthy' if ok else 'unhealthy')),
|
|
message=str(raw_result.get('message') or ('插件健康检查通过' if ok else '插件健康检查未通过')),
|
|
checker=checker_path,
|
|
started_at=started_at,
|
|
details=cast('JSONObject', raw_details) if isinstance(raw_details, dict) else {},
|
|
)
|
|
if isinstance(raw_result, bool):
|
|
return self._build_result(
|
|
ok=raw_result,
|
|
status='healthy' if raw_result else 'unhealthy',
|
|
message='插件健康检查通过' if raw_result else '插件健康检查未通过',
|
|
checker=checker_path,
|
|
started_at=started_at,
|
|
)
|
|
|
|
return self._build_result(
|
|
ok=True,
|
|
status='healthy',
|
|
message='插件健康检查通过',
|
|
checker=checker_path,
|
|
started_at=started_at,
|
|
)
|
|
|
|
def _build_result(
|
|
self,
|
|
*,
|
|
ok: bool,
|
|
status: str,
|
|
message: str,
|
|
checker: str | None,
|
|
started_at: float,
|
|
details: JSONObject | None = None,
|
|
error: str | None = None,
|
|
) -> PluginHealthResult:
|
|
"""
|
|
构建健康检查结果。
|
|
|
|
:param ok: 健康检查是否通过
|
|
:param status: 健康状态
|
|
:param message: 健康检查说明
|
|
:param checker: 健康检查声明路径
|
|
:param started_at: 检查开始时间
|
|
:param details: 健康检查扩展详情
|
|
:param error: 健康检查异常信息
|
|
:return: 插件健康检查结果
|
|
"""
|
|
return PluginHealthResult(
|
|
plugin_id=self.discovered_plugin.manifest.id,
|
|
ok=ok,
|
|
status=status,
|
|
message=message,
|
|
checker=checker,
|
|
duration_ms=round((perf_counter() - started_at) * 1000, 3),
|
|
details=details or {},
|
|
error=error,
|
|
)
|