mirror of
https://github.com/fastapi-practices/fastapi-best-architecture.git
synced 2026-09-23 13:33:08 +00:00
9251a5d5fd
* feat(plugin): support capability plugins Add capability plugin metadata and parsing so plugins without app/api sections can participate in dependency ordering and hooks without being routed as app plugins. Also rebuild missing plugin status cache from the normalized plugin config when a route dependency checks plugin state. * refactor code --------- Co-authored-by: linwu@onemt.com.cn <linwu@onemt.com.cn> Co-authored-by: Wu Clan <jianhengwu0407@gmail.com>
81 lines
2.5 KiB
Python
81 lines
2.5 KiB
Python
import json
|
|
|
|
from typing import cast
|
|
|
|
from fastapi import Request
|
|
|
|
from backend.common.enums import StatusType
|
|
from backend.common.exception import errors
|
|
from backend.common.log import log
|
|
from backend.core.conf import settings
|
|
from backend.database.redis import redis_client
|
|
from backend.plugin.errors import PluginInjectError
|
|
|
|
|
|
async def repair_plugin_cache(plugin: str) -> str:
|
|
"""
|
|
修复丢失的插件状态缓存
|
|
|
|
:param plugin: 插件名称
|
|
:return:
|
|
"""
|
|
from backend.plugin.core import load_plugin_config
|
|
from backend.plugin.validator import validate_plugin_config
|
|
|
|
plugin_config = load_plugin_config(plugin)
|
|
validate_plugin_config(plugin, plugin_config)
|
|
plugin_config['plugin']['name'] = plugin
|
|
plugin_config['plugin']['enable'] = str(StatusType.enable.value)
|
|
plugin_info = json.dumps(plugin_config, ensure_ascii=False)
|
|
await redis_client.set(f'{settings.PLUGIN_REDIS_PREFIX}:{plugin}', plugin_info)
|
|
return plugin_info
|
|
|
|
|
|
def get_plugin_enable(plugin_info: str | None, default_status: int) -> str:
|
|
"""
|
|
解析插件启用状态
|
|
|
|
:param plugin_info: 插件缓存信息
|
|
:param default_status: 默认状态值
|
|
:return:
|
|
"""
|
|
if not plugin_info:
|
|
return str(default_status)
|
|
|
|
try:
|
|
return json.loads(plugin_info)['plugin']['enable']
|
|
except Exception:
|
|
return str(default_status)
|
|
|
|
|
|
class PluginStatusChecker:
|
|
"""插件状态检查器"""
|
|
|
|
def __init__(self, plugin: str) -> None:
|
|
"""
|
|
初始化插件状态检查器
|
|
|
|
:param plugin: 插件名称
|
|
:return:
|
|
"""
|
|
self.plugin = plugin
|
|
|
|
async def __call__(self, request: Request) -> None:
|
|
"""
|
|
验证插件状态
|
|
|
|
:param request: FastAPI 请求对象
|
|
:return:
|
|
"""
|
|
plugin_info = cast('str | None', await redis_client.get(f'{settings.PLUGIN_REDIS_PREFIX}:{self.plugin}'))
|
|
if not plugin_info:
|
|
log.warning('插件 {} 状态未初始化或丢失，尝试自动修复', self.plugin)
|
|
try:
|
|
plugin_info = await repair_plugin_cache(self.plugin)
|
|
except Exception as e:
|
|
log.exception('插件 {} 状态自动修复失败', self.plugin)
|
|
raise PluginInjectError('插件状态未初始化或丢失，请联系系统管理员') from e
|
|
|
|
if get_plugin_enable(plugin_info, StatusType.disable.value) != str(StatusType.enable.value):
|
|
raise errors.ServerError(msg=f'插件 {self.plugin} 未启用，请联系系统管理员')
|