fix: 修复支持的适配器字段验证信息错误的问题 (#177)

在没有跳过插件加载测试的情况下，应提示不是集合，而非 JSON 解码失败

Author: he0119

CHANGELOG.md

@@ -11,6 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/lang/zh-CN/
 
 - 翻译 Pydantic 验证错误信息
 
+### Fixed
+
+- 修复支持的适配器字段验证信息错误的问题
+
 ## [3.0.2] - 2023-08-28
 
 ### Fixed

src/plugins/publish/templates/render_error.md.jinja

@@ -35,6 +35,8 @@ PyPI 项目名 {{ error.input }} 不符合规范。<dt>请确保项目名正确
 {{ loc|loc_to_name }}: 格式错误。<dt>请确保其为字典。</dt>
 {%- elif type == "type_error.list" %}
 {{ loc|loc_to_name }}: 格式错误。<dt>请确保其为列表。</dt>
+{%- elif type == "type_error.set" %}
+{{ loc|loc_to_name }}: 格式错误。<dt>请确保其为集合。</dt>
 {%- elif type == "value_error.json" %}
 {{ loc|loc_to_name }}: 解码失败。<dt>请确保其为 JSON 格式。</dt>
 {%- elif type == "value_error.any_str.max_length" %}

src/utils/validation/__init__.py

@@ -4,7 +4,7 @@
 
 from pydantic import validate_model
 
-from .constants import CUSTOM_MESSAGES
+from .constants import CUSTOM_MESSAGES, VALIDATION_CONTEXT
 from .models import AdapterPublishInfo, BotPublishInfo, PluginPublishInfo, PublishInfo
 from .models import PublishType as PublishType
 from .models import Tag
@@ -25,6 +25,14 @@ def validate_info(
     if publish_type not in validation_model_map:
         raise ValueError("⚠️ 未知的发布类型。")  # pragma: no cover
 
+    # 如果升级至 pydantic 2 后，可以使用 validation-context
+    # https://docs.pydantic.dev/latest/usage/validators/#validation-context
+    validation_context = {
+        "previous_data": raw_data.get("previous_data"),
+        "skip_plugin_test": raw_data.get("skip_plugin_test"),
+    }
+    VALIDATION_CONTEXT.set(validation_context)
+
     data, _, errors = validate_model(validation_model_map[publish_type], raw_data)
 
     # tags 会被转成 list[Tag]，需要转成 dict
@@ -38,11 +46,6 @@ def validate_info(
             for tag in tags
         ]
 
-    # 这个字段仅用于判断是否重复
-    # 如果升级至 pydantic 2 后，可以使用 validation-context
-    # https://docs.pydantic.dev/latest/usage/validators/#validation-context
-    data.pop("previous_data", None)
-
     errors_with_input = []
     if errors:
         for error in convert_errors(errors, CUSTOM_MESSAGES):

src/utils/validation/constants.py

@@ -1,4 +1,6 @@
+import contextvars
 import re
+from typing import Any
 
 # PyPI 格式
 PYPI_PACKAGE_NAME_PATTERN = re.compile(
@@ -24,10 +26,14 @@
 CUSTOM_MESSAGES = {
     "type_error.dict": "值不是合法的字典",
     "type_error.list": "值不是合法的列表",
+    "type_error.set": "值不是合法的集合",
     "type_error.none.not_allowed": "值不能为 None",
     "value_error.json": "JSON 格式不合法",
     "value_error.missing": "字段不存在",
     "value_error.color": "颜色格式不正确",
     "value_error.any_str.max_length": "字符串长度不能超过 {limit_value} 个字符",
     "value_error.list.max_items": "列表长度不能超过 {limit_value} 个元素",
 }
+
+VALIDATION_CONTEXT = contextvars.ContextVar[dict[str, Any]]("validation_context")
+"""验证上下文"""

src/utils/validation/models.py

@@ -5,7 +5,7 @@
 
 from pydantic import BaseModel, Field, root_validator, validator
 from pydantic.color import Color
-from pydantic.errors import JsonError, ListError
+from pydantic.errors import JsonError, SetError
 
 if TYPE_CHECKING:
     from pydantic.error_wrappers import ErrorDict as PydanticErrorDict
@@ -19,6 +19,7 @@ class ErrorDict(PydanticErrorDict, total=False):
     PLUGIN_VALID_TYPE,
     PYPI_PACKAGE_NAME_PATTERN,
     PYTHON_MODULE_NAME_REGEX,
+    VALIDATION_CONTEXT,
 )
 from .errors import (
     DuplicationError,
@@ -56,8 +57,6 @@ class PyPIMixin(BaseModel):
     module_name: str
     project_link: str
 
-    previous_data: list[dict[str, Any]]
-
     @validator("module_name", pre=True)
     def module_name_validator(cls, v: str) -> str:
         if not PYTHON_MODULE_NAME_REGEX.match(v):
@@ -78,7 +77,7 @@ def prevent_duplication(cls, values: dict[str, Any]) -> dict[str, Any]:
         module_name = values.get("module_name")
         project_link = values.get("project_link")
 
-        data = values.get("previous_data")
+        data = VALIDATION_CONTEXT.get().get("previous_data")
         if data is None:
             raise ValueError("未获取到数据列表")
 
@@ -155,8 +154,9 @@ def type_validator(cls, v: str) -> str:
     def supported_adapters_validator(
         cls, v: str | list[str] | None
     ) -> list[str] | None:
+        skip_plugin_test = VALIDATION_CONTEXT.get().get("skip_plugin_test")
         # 如果是从 issue 中获取的数据，需要先解码
-        if isinstance(v, str):
+        if skip_plugin_test and isinstance(v, str):
             try:
                 v = json.loads(v)
             except json.JSONDecodeError:
@@ -166,8 +166,8 @@ def supported_adapters_validator(
         if v is None:
             return None
 
-        if not isinstance(v, list):
-            raise ListError()
+        if not isinstance(v, (list, set)):
+            raise SetError()
 
         supported_adapters = {resolve_adapter_name(x) for x in v}
         store_adapters = get_adapters()

tests/publish/render/test_render_error.py

@@ -349,8 +349,8 @@ async def test_render_type_eroor(app: App, mocker: MockFixture):
             },
             {
                 "loc": ("supported_adapters",),
-                "msg": "value is not a valid iterable",
-                "type": "type_error.list",
+                "msg": "value is not a valid set",
+                "type": "type_error.set",
                 "input": '"test"',
             },
         ],
@@ -362,7 +362,7 @@ async def test_render_type_eroor(app: App, mocker: MockFixture):
     comment = await render_comment(result)
     assert (
         comment
-        == """# 📃 商店发布检查结果\n\n> Plugin: 帮助\n\n**⚠️ 在发布检查过程中，我们发现以下问题：**\n\n<pre><code><li>⚠️ 插件类型 invalid 不符合规范。<dt>请确保插件类型正确，当前仅支持 application 与 library。</dt></li><li>⚠️ 适配器 missing 不存在。<dt>请确保适配器模块名称正确。</dt></li><li>⚠️ 插件支持的适配器: 格式错误。<dt>请确保其为列表。</dt></li></code></pre>\n\n<details>\n<summary>详情</summary>\n<pre><code><li>✅ 插件 <a href="https://github.com/owner/repo/actions/runs/123456">加载测试</a> 通过。</li></code></pre>\n</details>\n\n---\n\n💡 如需修改信息，请直接修改 issue，机器人会自动更新检查结果。\n💡 当插件加载测试失败时，请发布新版本后在当前页面下评论任意内容以触发测试。\n\n\n💪 Powered by [NoneFlow](https://github.com/nonebot/noneflow)\n<!-- NONEFLOW -->\n"""
+        == """# 📃 商店发布检查结果\n\n> Plugin: 帮助\n\n**⚠️ 在发布检查过程中，我们发现以下问题：**\n\n<pre><code><li>⚠️ 插件类型 invalid 不符合规范。<dt>请确保插件类型正确，当前仅支持 application 与 library。</dt></li><li>⚠️ 适配器 missing 不存在。<dt>请确保适配器模块名称正确。</dt></li><li>⚠️ 插件支持的适配器: 格式错误。<dt>请确保其为集合。</dt></li></code></pre>\n\n<details>\n<summary>详情</summary>\n<pre><code><li>✅ 插件 <a href="https://github.com/owner/repo/actions/runs/123456">加载测试</a> 通过。</li></code></pre>\n</details>\n\n---\n\n💡 如需修改信息，请直接修改 issue，机器人会自动更新检查结果。\n💡 当插件加载测试失败时，请发布新版本后在当前页面下评论任意内容以触发测试。\n\n\n💪 Powered by [NoneFlow](https://github.com/nonebot/noneflow)\n<!-- NONEFLOW -->\n"""
     )
 
 

tests/utils/validation/test_plugin_supported_adapters.py

@@ -18,18 +18,19 @@ async def test_plugin_supported_adapters_none(mocked_api: MockRouter) -> None:
     assert mocked_api["homepage"].called
 
 
-async def test_plugin_supported_adapters_list(mocked_api: MockRouter) -> None:
-    """不是列表的情况"""
+async def test_plugin_supported_adapters_set(mocked_api: MockRouter) -> None:
+    """不是集合的情况"""
     from src.utils.validation import PublishType, validate_info
 
-    data = generate_plugin_data(supported_adapters="test")  # type: ignore
+    data = generate_plugin_data(supported_adapters="test")
 
     result = validate_info(PublishType.PLUGIN, data)
 
     assert not result["valid"]
     assert "supported_adapters" not in result["data"]
     assert result["errors"]
-    assert result["errors"][0]["type"] == "type_error.list"
+    assert result["errors"][0]["type"] == "type_error.set"
+    assert result["errors"][0]["msg"] == "值不是合法的集合"
 
     assert mocked_api["homepage"].called
 
@@ -38,14 +39,14 @@ async def test_plugin_supported_adapters_json(mocked_api: MockRouter) -> None:
     """不是 JSON 的情况"""
     from src.utils.validation import PublishType, validate_info
 
-    data = generate_plugin_data()
-    data["supported_adapters"] = "test"
+    data = generate_plugin_data(supported_adapters="test", skip_test=True)
 
     result = validate_info(PublishType.PLUGIN, data)
 
     assert not result["valid"]
     assert "supported_adapters" not in result["data"]
     assert result["errors"]
     assert result["errors"][0]["type"] == "value_error.json"
+    assert result["errors"][0]["msg"] == "JSON 格式不合法"
 
     assert mocked_api["homepage"].called

tests/utils/validation/utils.py

@@ -59,7 +59,7 @@ def generate_plugin_data(
     desc: str | None = "desc",
     homepage: str | None = "https://nonebot.dev",
     type: str | None = "application",
-    supported_adapters: list[str] | None = None,
+    supported_adapters: Any = None,
     skip_test: bool | None = False,
     plugin_test_result: bool | None = True,
     plugin_test_output: str | None = "plugin_test_output",
@@ -75,10 +75,8 @@ def generate_plugin_data(
             "desc": desc,
             "homepage": homepage,
             "type": type,
-            "supported_adapters": json.dumps(supported_adapters)
-            if supported_adapters is not None
-            else None,
-            "skip_test": skip_test,
+            "supported_adapters": supported_adapters,
+            "skip_plugin_test": skip_test,
             "plugin_test_result": plugin_test_result,
             "plugin_test_output": plugin_test_output,
             "plugin_test_metadata": {},