fix(openapi): fix doc import and publish update(1.14) (#1053)

TencentBlueKing · Oct 23, 2024 · 05a5143 · 05a5143
1 parent e66d2fc
commit 05a5143
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 9 deletions.
diff --git a/src/dashboard/apigateway/apigateway/apps/support/managers.py b/src/dashboard/apigateway/apigateway/apps/support/managers.py
@@ -97,7 +97,10 @@ def save_released_resource_doc(self, resource_doc_version, force: bool = False)
             )
             for doc in resource_doc_version.data
         ]
-        self.bulk_create(resource_doc_to_add, batch_size=RELEASED_RESOURCE_DOC_CREATE_BATCH_SIZE)
+        # 异步同时(多个stage同时发布同一版本)更新会存在一些冲突问题
+        self.bulk_create(
+            resource_doc_to_add, batch_size=RELEASED_RESOURCE_DOC_CREATE_BATCH_SIZE, ignore_conflicts=True
+        )
 
     def clear_unreleased_resource_doc(self, gateway_id: int) -> None:
         """清理未发布的资源文档，如已发布版本被新版本替代的情况"""

diff --git a/src/dashboard/apigateway/apigateway/biz/resource/importer/openapi.py b/src/dashboard/apigateway/apigateway/biz/resource/importer/openapi.py
@@ -150,9 +150,9 @@ def parse(self):
 
     def _get_parser(self, parse_result) -> BaseParser:
         if self.version == OPENAPIV2:
-            return BaseParser(parse_result.specification)
+            return BaseParser(parse_result.specification, str(self.version))
 
-        return OpenAPIV3Parser(parse_result.specification)
+        return OpenAPIV3Parser(parse_result.specification, str(self.version))
 
     def get_resource_list(self, raw=False):
         """

diff --git a/src/dashboard/apigateway/apigateway/biz/resource/importer/parser.py b/src/dashboard/apigateway/apigateway/biz/resource/importer/parser.py
@@ -23,6 +23,7 @@
 from urllib.parse import urlparse
 
 from django.utils.translation import gettext as _
+from openapi_spec_validator.versions import OPENAPIV30, OPENAPIV31
 from pydantic import parse_obj_as
 
 from apigateway.biz.constants import OpenAPIFormatEnum
@@ -46,6 +47,7 @@ class BaseParser:
     """
 
     _openapi_data: Dict[str, Any]
+    _openapi_version: Optional[str] = str(OPENAPIV30)
 
     def get_resources(self) -> List[Dict[str, Any]]:
         resources = []
@@ -107,7 +109,7 @@ def _get_openapi_schema(self, operation: Dict[str, Any]):
           }
         }
         """
-        openapi_schema = {}
+        openapi_schema = {"version": self._openapi_version}
         request_body = self._get_request_body(operation)
         if len(request_body) > 0:
             openapi_schema["requestBody"] = request_body
@@ -330,7 +332,7 @@ def _get_base_path(self):
         return parsed_url.path
 
     def _get_openapi_schema(self, operation: Dict[str, Any]):
-        openapi_schema = {}
+        openapi_schema = {"version": self._openapi_version}
         if "parameters" in operation:
             openapi_schema["parameters"] = operation.get("parameters", [])
 
@@ -469,8 +471,12 @@ def to_openapi(self, resources: list, file_type: str = "") -> str:
         return yaml_export_dumps(content)
 
     def _get_openapi_content(self, resources: list) -> Dict[str, Any]:
+        openapi_version = "3.0.1"
+        if resources and resources[0].get("openapi_schema", {}).get("version") == str(OPENAPIV31):
+            openapi_version = "3.1.0"
+
         return {
-            "openapi": "3.0.1",
+            "openapi": openapi_version,
             "servers": [{"url": "/"}],
             "info": {
                 "version": self.api_version,
@@ -520,6 +526,10 @@ def _generate_paths(self, resources: List[Dict]) -> Dict[str, Any]:
             # schema
             schema = resource.get("openapi_schema", {})
 
+            # remove openapi version
+            if "version" in schema:
+                del schema["version"]
+
             operation.update(schema)
 
             if self.include_bk_apigateway_resource:

diff --git a/src/dashboard/apigateway/apigateway/core/managers.py b/src/dashboard/apigateway/apigateway/core/managers.py
@@ -266,7 +266,8 @@ def save_released_resource(self, resource_version, force: bool = False) -> None:
             )
             for resource in resource_version.data
         ]
-        self.bulk_create(resource_to_add, batch_size=RELEASED_RESOURCE_CREATE_BATCH_SIZE)
+        # 异步同时(多个stage同时发布同一版本)更新会存在一些冲突问题
+        self.bulk_create(resource_to_add, batch_size=RELEASED_RESOURCE_CREATE_BATCH_SIZE, ignore_conflicts=True)
 
     def get_released_resource(self, gateway_id: int, resource_version_id: int, resource_name: str) -> Optional[dict]:
         released_resource = self.filter(

diff --git a/src/dashboard/apigateway/apigateway/tests/apis/web/resource/test_views.py b/src/dashboard/apigateway/apigateway/tests/apis/web/resource/test_views.py
@@ -480,6 +480,7 @@ class TestResourceImportCheckApi:
                         },
                         "labels": ["pet"],
                         "openapi_schema": {
+                            "version": "OpenAPIV2.0",
                             "parameters": [
                                 {
                                     "name": "userId",
@@ -488,7 +489,7 @@ class TestResourceImportCheckApi:
                                     "description": "ID of User",
                                     "schema": {"type": "integer", "format": "int64"},
                                 }
-                            ]
+                            ],
                         },
                         "plugin_configs": None,
                     }
@@ -555,7 +556,9 @@ class TestResourceImportCheckApi:
                             "config": {"method": "GET", "path": "/hello/", "match_subpath": False, "timeout": 30},
                         },
                         "labels": ["pet"],
-                        "openapi_schema": {},
+                        "openapi_schema": {
+                            "version": "OpenAPIV2.0",
+                        },
                         "plugin_configs": None,
                     }
                 ],