fix: 调整蓝鲸插件接口信息同步到网关的逻辑 && 蓝鲸插件部署优化 --story=130029401

Author: Xinkai Yi

bk-plugin-framework/bk_plugin_framework/kit/__init__.py

@@ -14,9 +14,9 @@
 except ImportError:
     from pydantic import Field  # noqa
 
-from bk_plugin_framework.kit.plugin import Context  # noqa
 from bk_plugin_framework.kit.plugin import (  # noqa
     Callback,
+    Context,
     ContextRequire,
     FormModel,
     InputsModel,

bk-plugin-framework/bk_plugin_framework/kit/plugin.py

@@ -20,7 +20,10 @@
 
 from bk_plugin_framework.constants import State
 from bk_plugin_framework.hub import VersionHub
-from bk_plugin_framework.runtime.callback.api import CallbackPreparation, prepare_callback
+from bk_plugin_framework.runtime.callback.api import (
+    CallbackPreparation,
+    prepare_callback,
+)
 
 VALID_VERSION_PATTERN = re.compile(r"^[0-9]+\.[0-9]+\.[0-9][a-z0-9]*$")
 

bk-plugin-framework/bk_plugin_framework/runtime/callback/celery/tasks.py

@@ -19,7 +19,11 @@
 from bk_plugin_framework.envs import settings
 from bk_plugin_framework.hub import VersionHub
 from bk_plugin_framework.kit import State
-from bk_plugin_framework.metrics import BK_PLUGIN_CALLBACK_EXCEPTION_COUNT, BK_PLUGIN_CALLBACK_TIME, HOSTNAME
+from bk_plugin_framework.metrics import (
+    BK_PLUGIN_CALLBACK_EXCEPTION_COUNT,
+    BK_PLUGIN_CALLBACK_TIME,
+    HOSTNAME,
+)
 from bk_plugin_framework.runtime.executor import BKPluginExecutor
 from bk_plugin_framework.runtime.schedule.models import Schedule
 from bk_plugin_framework.runtime.schedule.utils import get_schedule_lock

bk-plugin-framework/bk_plugin_framework/runtime/executor.py

@@ -22,7 +22,14 @@
 
 from django.utils.timezone import now
 
-from bk_plugin_framework.kit import Callback, Context, ContextRequire, InputsModel, Plugin, State
+from bk_plugin_framework.kit import (
+    Callback,
+    Context,
+    ContextRequire,
+    InputsModel,
+    Plugin,
+    State,
+)
 from bk_plugin_framework.kit.plugin import PluginCallbackModel
 from bk_plugin_framework.metrics import (
     BK_PLUGIN_EXECUTE_EXCEPTION_COUNT,

bk-plugin-framework/bk_plugin_framework/serializers.py

@@ -0,0 +1,19 @@
+from drf_spectacular.utils import extend_schema_serializer
+from rest_framework import serializers
+
+
+def standard_response_enveloper(serializer_class, many: bool = False):
+    """统一响应包装器"""
+    component_name = "Enveloped{}{}".format(
+        serializer_class.__name__.replace("Serializer", ""),
+        "List" if many else "",
+    )
+
+    @extend_schema_serializer(many=False, component_name=component_name)
+    class EnvelopeSerializer(serializers.Serializer):
+        code = serializers.IntegerField(help_text="状态码，0表示成功")
+        data = serializer_class(many=many)
+        message = serializers.CharField(help_text="响应消息")
+        result = serializers.BooleanField(help_text="操作结果")
+
+    return EnvelopeSerializer

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/callback.py

@@ -14,26 +14,50 @@
 import traceback
 
 from apigw_manager.apigw.decorators import apigw_require
+from apigw_manager.drf.utils import gen_apigateway_resource_config
 from blueapps.account.decorators import login_exempt
 from django.utils.decorators import method_decorator
-from drf_yasg.utils import swagger_auto_schema
+from drf_spectacular.utils import extend_schema
+from rest_framework import serializers
 from rest_framework.decorators import action
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
 from bk_plugin_framework.runtime.callback.api import callback, parse_callback_token
+from bk_plugin_framework.serializers import standard_response_enveloper
 
 logger = logging.getLogger("bk_plugin")
 
 
+class PluginCallbackParamsSerializer(serializers.Serializer):
+    token = serializers.CharField(help_text="插件回调token", required=True)
+
+
+class PluginCallbackResponseSerializer(serializers.Serializer):
+    result = serializers.BooleanField(help_text="回调结果，True表示成功，False表示失败")
+    message = serializers.CharField(help_text="回调结果信息", required=False)
+
+
 @method_decorator(login_exempt, name="dispatch")
 @method_decorator(apigw_require, name="dispatch")
 class PluginCallback(APIView):
     authentication_classes = []  # csrf exempt
 
-    @swagger_auto_schema(
-        method="POST",
-        operation_summary="plugin callback",
+    @extend_schema(
+        exclude=True,
+        summary="插件回调",
+        operation_id="callback",
+        request=PluginCallbackParamsSerializer,
+        responses={200: standard_response_enveloper(PluginCallbackResponseSerializer)},
+        extensions=gen_apigateway_resource_config(
+            is_public=True,
+            allow_apply_permission=True,
+            user_verified_required=False,
+            app_verified_required=True,
+            resource_permission_required=True,
+            description_en="plugin callback",
+            match_subpath=False,
+        ),
     )
     @action(methods=["POST"], detail=True)
     def post(self, request, token):

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/detail.py

@@ -11,16 +11,20 @@
 
 import logging
 
+from apigw_manager.drf.utils import gen_apigateway_resource_config
 from blueapps.account.decorators import login_exempt
 from django.utils.decorators import method_decorator
-from drf_yasg.utils import swagger_auto_schema
+from drf_spectacular.utils import extend_schema
 from rest_framework import permissions, serializers, status
 from rest_framework.decorators import action
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
 from bk_plugin_framework.hub import VersionHub
-from bk_plugin_framework.services.bpf_service.api.serializers import StandardResponseSerializer
+from bk_plugin_framework.serializers import standard_response_enveloper
+from bk_plugin_framework.services.bpf_service.api.serializers import (
+    StandardResponseSerializer,
+)
 
 logger = logging.getLogger("root")
 
@@ -64,10 +68,20 @@ class DetailFormsSerializer(serializers.Serializer):
 class Detail(APIView):
     permission_classes = [permissions.AllowAny]
 
-    @swagger_auto_schema(
-        method="GET",
-        operation_summary="Get plugin detail for specific version",
-        responses={200: DetailResponseSerializer},
+    @extend_schema(
+        exclude=True,
+        summary="获取指定版本的插件详情",
+        operation_id="plugin_detail",
+        responses={200: standard_response_enveloper(DetailResponseSerializer)},
+        extensions=gen_apigateway_resource_config(
+            is_public=True,
+            allow_apply_permission=True,
+            user_verified_required=True,
+            app_verified_required=True,
+            resource_permission_required=True,
+            description_en="Get plugin detail for specific version",
+            match_subpath=False,
+        ),
     )
     @action(methods=["GET"], detail=True)
     def get(self, request, version):

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/invoke.py

@@ -12,9 +12,10 @@
 import logging
 
 from apigw_manager.apigw.decorators import apigw_require
+from apigw_manager.drf.utils import gen_apigateway_resource_config
 from blueapps.account.decorators import login_exempt
 from django.utils.decorators import method_decorator
-from drf_yasg.utils import swagger_auto_schema
+from drf_spectacular.utils import extend_schema
 from rest_framework import serializers, status
 from rest_framework.decorators import action
 from rest_framework.exceptions import ValidationError
@@ -23,8 +24,13 @@
 
 from bk_plugin_framework.hub import VersionHub
 from bk_plugin_framework.runtime.executor import BKPluginExecutor
-from bk_plugin_framework.services.bpf_service.api.permissions import ScopeAllowPermission
-from bk_plugin_framework.services.bpf_service.api.serializers import StandardResponseSerializer
+from bk_plugin_framework.serializers import standard_response_enveloper
+from bk_plugin_framework.services.bpf_service.api.permissions import (
+    ScopeAllowPermission,
+)
+from bk_plugin_framework.services.bpf_service.api.serializers import (
+    StandardResponseSerializer,
+)
 
 logger = logging.getLogger("bk_plugin")
 
@@ -52,11 +58,21 @@ class Invoke(APIView):
     authentication_classes = []  # csrf exempt
     permission_classes = [ScopeAllowPermission]
 
-    @swagger_auto_schema(
-        method="POST",
-        operation_summary="Invoke specific version plugin",
-        request_body=InvokeParamsSerializer,
-        responses={200: InvokeResponseSerializer},
+    @extend_schema(
+        exclude=True,
+        summary="调用指定版本插件",
+        operation_id="invoke",
+        request=InvokeParamsSerializer,
+        responses={200: standard_response_enveloper(InvokeResponseSerializer)},
+        extensions=gen_apigateway_resource_config(
+            is_public=True,
+            allow_apply_permission=True,
+            user_verified_required=False,
+            app_verified_required=True,
+            resource_permission_required=True,
+            description_en="Invoke specific version plugin",
+            match_subpath=False,
+        ),
     )
     @action(methods=["POST"], detail=True)
     def post(self, request, version):

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/logs.py

@@ -11,16 +11,20 @@
 
 import logging
 
+from apigw_manager.drf.utils import gen_apigateway_resource_config
 from blueapps.account.decorators import login_exempt
 from django.utils.decorators import method_decorator
-from drf_yasg.utils import swagger_auto_schema
+from drf_spectacular.utils import extend_schema
 from rest_framework import permissions, serializers
 from rest_framework.decorators import action
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
 from bk_plugin_framework.runtime.loghub.models import LogEntry
-from bk_plugin_framework.services.bpf_service.api.serializers import StandardResponseSerializer
+from bk_plugin_framework.serializers import standard_response_enveloper
+from bk_plugin_framework.services.bpf_service.api.serializers import (
+    StandardResponseSerializer,
+)
 
 logger = logging.getLogger("root")
 
@@ -40,10 +44,20 @@ class Logs(APIView):
 
     permission_classes = [permissions.AllowAny]
 
-    @swagger_auto_schema(
-        method="GET",
-        operation_summary="Get plugin execution log with trace_id",
-        responses={200: LogsResponseSerializer},
+    @extend_schema(
+        exclude=True,
+        summary="获取插件执行日志",
+        operation_id="plugin_logs",
+        responses={200: standard_response_enveloper(LogsResponseSerializer)},
+        extensions=gen_apigateway_resource_config(
+            is_public=True,
+            allow_apply_permission=True,
+            user_verified_required=True,
+            app_verified_required=True,
+            resource_permission_required=True,
+            description_en="Get plugin execution log with trace_id",
+            match_subpath=False,
+        ),
     )
     @action(methods=["GET"], detail=True)
     def get(self, request, trace_id):

bk-plugin-framework/bk_plugin_framework/services/bpf_service/api/meta.py

@@ -12,18 +12,22 @@
 import logging
 from importlib import import_module
 
+from apigw_manager.drf.utils import gen_apigateway_resource_config
 from blueapps.account.decorators import login_exempt
 from django.conf import settings
 from django.utils.decorators import method_decorator
-from drf_yasg.utils import swagger_auto_schema
+from drf_spectacular.utils import extend_schema
 from rest_framework import permissions, serializers
 from rest_framework.decorators import action
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
 from bk_plugin_framework import __version__ as bpf_version
 from bk_plugin_framework.hub import VersionHub
-from bk_plugin_framework.services.bpf_service.api.serializers import StandardResponseSerializer
+from bk_plugin_framework.serializers import standard_response_enveloper
+from bk_plugin_framework.services.bpf_service.api.serializers import (
+    StandardResponseSerializer,
+)
 
 logger = logging.getLogger("root")
 
@@ -58,10 +62,20 @@ class Meta(APIView):
 
     permission_classes = [permissions.AllowAny]
 
-    @swagger_auto_schema(
-        method="GET",
-        operation_summary="Get plugin meta info",
-        responses={200: MetaResponseSerializer},
+    @extend_schema(
+        exclude=True,
+        summary="获取插件元信息",
+        operation_id="plugin_meta_info",
+        responses={200: standard_response_enveloper(MetaResponseSerializer)},
+        extensions=gen_apigateway_resource_config(
+            is_public=True,
+            allow_apply_permission=True,
+            user_verified_required=True,
+            app_verified_required=True,
+            resource_permission_required=True,
+            description_en="Get plugin meta info",
+            match_subpath=False,
+        ),
     )
     @action(methods=["GET"], detail=True)
     def get(self, request):