feat: 检查网址时返回具体的报错信息 (#172)

close #167

Author: he0119

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/lang/zh-CN/
 
 - 使用 jinja 渲染评论
 - 发布信息更新后如果发现不通过将拉取请求转成草稿
+- 检查网址时返回具体的报错信息
 
 ### Changed
 

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

@@ -9,8 +9,10 @@
 第 {{ loc[1] + 1 }} 个标签颜色错误<dt>请确保标签颜色符合十六进制颜色码规则。</dt>
 {%- elif loc|length == 2 and loc[0] == "tags" and type == "type_error.dict" %}
 第 {{ loc[1] + 1 }} 个标签格式错误。<dt>请确保标签为字典。</dt>
-{%- elif type == "value_error.homepage.unreachable" %}
+{%- elif type == "value_error.homepage" and error.ctx.status_code != -1 %}
 项目 <a href="{{ error.input }}">主页</a> 返回状态码 {{ error.ctx.status_code }}。<dt>请确保你的项目主页可访问。</dt>
+{%- elif type == "value_error.homepage" and error.ctx.status_code == -1 %}
+项目 <a href="{{ error.input }}">主页</a> 访问出错。<details><summary>错误信息</summary>{{ error.ctx.msg }}</details>
 {%- elif type == "value_error.project_link.not_found" %}
 项目 <a href="https://pypi.org/project/{{ error.input }}/">{{ error.input }}</a> 未发布至 PyPI。<dt>请将你的项目发布至 PyPI。</dt>
 {%- elif type == "value_error.project_link.name" %}

src/utils/validation/errors.py

@@ -3,11 +3,10 @@
 
 class HomepageError(PydanticValueError):
     code = "homepage"
+    msg_template = "项目主页无法访问。"
 
-
-class HomepageUnreachableError(HomepageError):
-    code = "homepage.unreachable"
-    msg_template = "项目主页不可访问。"
+    def __init__(self, status_code: int, msg: str) -> None:
+        super().__init__(status_code=status_code, msg=msg)
 
 
 class ModuleNameError(PydanticValueError):

src/utils/validation/models.py

@@ -22,7 +22,7 @@ class ErrorDict(PydanticErrorDict, total=False):
 )
 from .errors import (
     DuplicationError,
-    HomepageUnreachableError,
+    HomepageError,
     ModuleNameError,
     PluginSupportedAdaptersMissingError,
     PluginTypeError,
@@ -117,9 +117,9 @@ class PublishInfo(abc.ABC, BaseModel):
     @validator("homepage", pre=True)
     def homepage_validator(cls, v: str) -> str:
         if v:
-            status_code = check_url(v)
+            status_code, msg = check_url(v)
             if status_code != 200:
-                raise HomepageUnreachableError(status_code=status_code)
+                raise HomepageError(status_code=status_code, msg=msg)
         return v
 
     @validator("tags", pre=True)

src/utils/validation/utils.py

@@ -10,22 +10,22 @@
 def check_pypi(project_link: str) -> bool:
     """检查项目是否存在"""
     url = f"https://pypi.org/pypi/{project_link}/json"
-    status_code = check_url(url)
+    status_code, _ = check_url(url)
     return status_code == 200
 
 
 @cache
-def check_url(url: str) -> int | None:
+def check_url(url: str) -> tuple[int, str]:
     """检查网址是否可以访问
 
-    返回状态码，如果报错则返回 None
+    返回状态码，如果报错则返回 -1
     """
     logger.info(f"检查网址 {url}")
     try:
         r = httpx.get(url, follow_redirects=True)
-        return r.status_code
-    except:
-        pass
+        return r.status_code, ""
+    except Exception as e:
+        return -1, str(e)
 
 
 def get_adapters() -> set[str]:

tests/publish/render/test_render_error.py

@@ -25,7 +25,7 @@ async def test_render_error_bot(app: App):
             {
                 "loc": ("homepage",),
                 "msg": "项目主页不可访问。",
-                "type": "value_error.homepage.unreachable",
+                "type": "value_error.homepage",
                 "ctx": {"status_code": 404},
                 "input": "https://www.baidu.com",
             },
@@ -92,7 +92,7 @@ async def test_render_error_adapter(app: App):
             {
                 "loc": ("homepage",),
                 "msg": "项目主页不可访问。",
-                "type": "value_error.homepage.unreachable",
+                "type": "value_error.homepage",
                 "ctx": {"status_code": 404},
                 "input": "https://www.baidu.com",
             },
@@ -158,7 +158,7 @@ async def test_render_error_plugin(app: App, mocker: MockFixture):
             {
                 "loc": ("homepage",),
                 "msg": "项目主页不可访问。",
-                "type": "value_error.homepage.unreachable",
+                "type": "value_error.homepage",
                 "ctx": {"status_code": 404},
                 "input": "https://www.baidu.com",
             },
@@ -400,3 +400,50 @@ async def test_render_unknown_error(app: App, mocker: MockFixture):
         comment
         == """# 📃 商店发布检查结果\n\n> Plugin: 帮助\n\n**⚠️ 在发布检查过程中，我们发现以下问题：**\n\n<pre><code><li>⚠️ tests &gt; 2 &gt; test: unknown error</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"""
     )
+
+
+async def test_render_http_error(app: App, mocker: MockFixture):
+    """网络请求报错"""
+    from src.plugins.publish.config import plugin_config
+    from src.plugins.publish.render import render_comment
+    from src.utils.validation import PublishType, ValidationDict
+
+    mocker.patch.object(plugin_config, "plugin_test_result", True)
+    mocker.patch.object(plugin_config, "plugin_test_metadata", {})
+
+    result: ValidationDict = {
+        "valid": False,
+        "data": {
+            "author": "he0119",
+            "tags": [],
+            "is_official": False,
+        },
+        "errors": [
+            {
+                "loc": ("homepage",),
+                "msg": "项目主页不可访问。",
+                "type": "value_error.homepage",
+                "ctx": {"status_code": 404},
+                "input": "https://www.baidu.com",
+            },
+            {
+                "loc": ("homepage",),
+                "msg": "项目主页无法访问。",
+                "type": "value_error.homepage",
+                "ctx": {
+                    "status_code": -1,
+                    "msg": "Request URL is missing an 'http://' or 'https://' protocol.",
+                },
+                "input": "12312",
+            },
+        ],
+        "type": PublishType.PLUGIN,
+        "name": "帮助",
+        "author": "he0119",
+    }
+
+    comment = await render_comment(result)
+    assert (
+        comment
+        == """# 📃 商店发布检查结果\n\n> Plugin: 帮助\n\n**⚠️ 在发布检查过程中，我们发现以下问题：**\n\n<pre><code><li>⚠️ 项目 <a href="https://www.baidu.com">主页</a> 返回状态码 404。<dt>请确保你的项目主页可访问。</dt></li><li>⚠️ 项目 <a href="12312">主页</a> 访问出错。<details><summary>错误信息</summary>Request URL is missing an &#39;http://&#39; or &#39;https://&#39; protocol.</details></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"""
+    )