feat: 新增蓝鲸插件框架集成蓝鲸可编程网关 && 插件部署优化功能 by kaik-bit · Pull Request #111 · TencentBlueKing/bk-plugin-framework-python

kaik-bit · 2026-01-04T08:02:00Z

feat: 新增蓝鲸插件框架集成蓝鲸可编程网关 && 插件部署优化功能

tencentblueking-adm · 2026-01-04T08:02:08Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

Xinkai Yi seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

codecov-commenter · 2026-01-04T08:03:50Z

Codecov Report

❌ Patch coverage is 97.82609% with 1 line in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (master@48bf0a7). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
...bk_plugin_framework/services/bpf_service/models.py	90.90%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##             master     #111   +/-   ##
=========================================
  Coverage          ?   90.97%           
=========================================
  Files             ?       38           
  Lines             ?     1330           
  Branches          ?        0           
=========================================
  Hits              ?     1210           
  Misses            ?      120           
  Partials          ?        0

Files with missing lines	Coverage Δ
...-plugin-framework/bk_plugin_framework/constants.py	`100.00% <ø> (ø)`
bk-plugin-framework/bk_plugin_framework/envs.py	`75.00% <100.00%> (ø)`
...ugin-framework/bk_plugin_framework/hub/__init__.py	`97.36% <100.00%> (ø)`
...ugin-framework/bk_plugin_framework/kit/__init__.py	`60.00% <ø> (ø)`
...plugin-framework/bk_plugin_framework/kit/plugin.py	`87.09% <100.00%> (ø)`
bk-plugin-framework/bk_plugin_framework/metrics.py	`96.15% <100.00%> (ø)`
...k/bk_plugin_framework/runtime/callback/__init__.py	`100.00% <ø> (ø)`
...mework/bk_plugin_framework/runtime/callback/api.py	`65.30% <100.00%> (ø)`
...ework/bk_plugin_framework/runtime/callback/apps.py	`100.00% <ø> (ø)`
..._plugin_framework/runtime/callback/celery/tasks.py	`96.00% <100.00%> (ø)`
... and 27 more

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 48bf0a7...6aea9f8. Read the comment docs.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

dengyh · 2026-01-04T08:22:27Z

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


-from drf_yasg.utils import swagger_auto_schema
+from apigw_manager.apigw.decorators import apigw_require
+from bk_plugin_framework.runtime.callback.api import callback, parse_callback_token


这里bk_plugin_framework是本地模块吧，其他都是第三方依赖，应该分开的

其他应该也有类似的问题

已修复这个问题

dengyh · 2026-01-06T13:38:01Z

template/{{cookiecutter.project_name}}/requirements.txt

-# DO NOT DELETE ANY PACKAGE IN base SECTION !!!
-bk-plugin-framework==2.2.9
-# opentelemetry
+amqp==2.6.1


本地用于测试增加的依赖包不应该放上来，正常安装runtime和framework就够了

dengyh · 2026-01-06T13:39:13Z

template/{{cookiecutter.project_name}}/app_desc.yml

            description: pip version control
          - name: BK_APIGW_MANAGER_MAINTAINERS
-            value: {{cookiecutter.init_apigw_maintainer}}
+            value: simonyi


这里有名字

已修改还原

dengyh · 2026-01-06T13:39:46Z

template/{{cookiecutter.project_name}}/app_desc.yml

          procCommand: celery-prometheus-exporter --broker amqp://$RABBITMQ_USER:$RABBITMQ_PASSWORD@$RABBITMQ_HOST:$RABBITMQ_PORT/$RABBITMQ_VHOST --addr 0.0.0.0:5001 --queue-list plugin_schedule plugin_callback schedule_delete
      configuration:
        env:
+          - name: PYTHONPATH


这个文件的环境变量不应该改吧

已修改回复为模板样例

dengyh · 2026-01-06T13:43:08Z

bk-plugin-framework/bk_plugin_framework/serializers.py

+from rest_framework import serializers
+
+
+def enveloper(serializer_class, many: bool = False):


最好有比较明确的含义，比如StandardResponse类似的

已经修改为standard_response_enveloper

dengyh · 2026-01-09T03:30:38Z

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

-        operation_summary="Get plugin execution log with trace_id",
-        responses={200: LogsResponseSerializer},
+    @extend_schema(
+        summary="Get plugin execution log with trace_id",


这里需要确认下operation_id是否必填的，还有几个其他接口也有类似的

非必需的，不填 apigw 会自动命名为视图类名加上操作类型，类似 plugin_get、plugin_post 这种

dengyh · 2026-01-09T03:31:33Z

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

+            user_verified_required=True,
+            app_verified_required=True,
+            resource_permission_required=True,
+            description_en="插件调用",


描述不太准确吧，其他也有不准确的，一起看下

dengyh · 2026-01-09T03:32:23Z

...k/bk_plugin_framework/services/bpf_service/management/commands/sync_apigateway_if_changed.py

+
+    def _append_plugin_api_resource(self):
+        """在 resources.yaml 的 paths 节点下追加 plugin_api 资源配置"""
+        filepath = "/app/bk_plugin_runtime/resources.yaml"


最好用相对路径，这路是蓝鲸内部署的路径，如果paas构建环境换了，那这里就有问题了

已修改为与 apigw 生成 resources.yaml 的路径保持一致

dengyh · 2026-01-09T03:46:49Z

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

-        responses={200: ScheduleResponseSerializer},
+    @extend_schema(
+        summary="获取插件调度详情",
+        request=ScheduleParamsSerializer,


可编程网关的文档用的是parameters，可能需要确认下是不是get请求的旧用parameters，post请求的才用request

是的，我修改一下

Xinkai Yi added 2 commits December 29, 2025 21:04

feat: 新增接口响应封装 && pre-commit规范文件

a78f982

feat: 新增@extend_schema装饰器声明接口以支持自动接入蓝鲸API网关

1054d07

dengyh reviewed Jan 4, 2026

View reviewed changes

Xinkai Yi added 4 commits January 6, 2026 20:09

feat: 蓝鲸插件框架集成可编程网关实现部署即发布网关

b6bb861

fix: 修复第三方模块和本地模块在同一代码块的bug

8ff4a37

fix: 修复第三方模块和本地模块在同一代码块的bug

fe9550a

delete: 删除runtime中多余的用户认证配置

7f2c0c2

dengyh reviewed Jan 6, 2026

View reviewed changes

Xinkai Yi added 8 commits January 7, 2026 10:48

feat: 恢复app_desc.yml文件的环境变量

9c8ebaf

revert: 恢复app_desc.yaml的修改

3615718

fix: 恢复requirements.txt文件

16e57a0

fix: 恢复app_desc.yaml环境变量配置

6445e46

feat: 新增bk_plugin模块下的apis通用视图接口

e65b01c

feat: 新增通过对比resource.yaml文件hash值的方式实现网关部署优化

77f32dd

fix: 追加plugin_api的信息到resources.yaml文件中解决method为ANY的问题

46d6fa6

fix: 屏蔽schedule接口信息同步到网关apigw

7f129df

kaik-bit changed the title ~~Development~~ feat: 新增蓝鲸插件框架集成蓝鲸可编程网关 && 插件部署优化功能 Jan 8, 2026

dengyh reviewed Jan 9, 2026

View reviewed changes

Xinkai Yi added 3 commits January 9, 2026 15:24

fix: 修改接口描述不规范问题

2b1c49c

fix: 修改 resources.yaml的获取路径方式与 apigw 保持一致

017fc7a

fix: 删除Schedule视图接口多余的参数声明

6aea9f8

dengyh merged commit cb88b1c into TencentBlueKing:master Jan 9, 2026
4 of 5 checks passed

kaik-bit deleted the development branch January 15, 2026 03:43

		from rest_framework import serializers


		def enveloper(serializer_class, many: bool = False):

Conversation

kaik-bit commented Jan 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tencentblueking-adm commented Jan 4, 2026

Uh oh!

codecov-commenter commented Jan 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kaik-bit commented Jan 4, 2026 •

edited

Loading

codecov-commenter commented Jan 4, 2026 •

edited

Loading