🔨 提取GitHub相关操作

[AkashiCoin]

Summary by Sourcery

将与 GitHub 相关的操作重构到一个专用的实用程序模块中，增强模块化和可重用性。更新自动更新和 Web UI 资产管理流程以使用新的实用程序函数，提高一致性和可维护性。调整测试以符合重构后的代码。

增强功能：

• 将与 GitHub 相关的操作重构到一个单独的实用程序模块中，以提高模块化和可重用性。
• 通过使用统一的方法从 GitHub 获取版本信息和下载 URL 来改进更新机制。
• 通过动态确定要挂载的文件夹和改进日志记录来增强 Web UI 资产管理。
• 通过删除硬编码的 GitHub URL 和模式并使用默认的 GitHub URL 来简化配置。

测试：

• 更新测试以反映 GitHub URL 处理的变化，并确保与新的实用程序函数兼容。

Original summary in English

Summary by Sourcery

Refactor GitHub-related operations into a dedicated utility module, enhancing modularity and reusability. Update the auto-update and web UI asset management processes to use the new utility functions, improving consistency and maintainability. Adjust tests to align with the refactored code.

Enhancements:

• Refactor GitHub-related operations into a separate utility module for better modularity and reusability.
• Improve the update mechanism by using a unified method to fetch version information and download URLs from GitHub.
• Enhance the web UI asset management by dynamically determining folders to mount and improving logging.
• Simplify the configuration by removing hardcoded GitHub URLs and patterns, and using a default GitHub URL.

Tests:

• Update tests to reflect changes in GitHub URL handling and ensure compatibility with the new utility functions.

[sourcery-ai]

审核指南由 Sourcery 提供

此拉取请求将与 GitHub 相关的操作重构到一个单独的实用程序模块中，更新了自动更新和插件商店功能以使用新的实用程序，并对 WebUI 资产管理进行了一些调整。更改旨在改善代码组织、可重用性和可维护性。

文件级更改

更改	详情	文件
将与 GitHub 相关的操作提取到一个新的实用程序模块中	为 GitHub 实用程序创建了新文件：models.py, func.py, consts.py 和 init.py 实现了用于处理存储库信息的 RepoInfo 类 添加了用于获取不同 GitHub 资源的最快下载 URL 的函数 将与 GitHub 操作相关的常量和模式移动到 consts.py	zhenxun/utils/github_utils/models.py zhenxun/utils/github_utils/func.py zhenxun/utils/github_utils/consts.py zhenxun/utils/github_utils/__init__.py
更新自动更新功能以使用新的 GitHub 实用程序	使用 RepoInfo 替换硬编码的 URL 以动态生成 URL 更新版本获取逻辑以使用新的 GitHub 实用程序 通过使用新的实用程序函数简化更新过程	zhenxun/builtin_plugins/auto_update/_data_source.py zhenxun/builtin_plugins/auto_update/config.py
重构插件商店以使用新的 GitHub 实用程序	更新插件安装过程以使用 RepoInfo 进行 URL 生成 删除与 GitHub 操作相关的冗余代码 简化获取插件信息和文件的过程	zhenxun/builtin_plugins/plugin_store/data_source.py zhenxun/builtin_plugins/plugin_store/config.py
更新 WebUI 资产管理	将 WebUI 相关的常量移动到配置文件中 更新资产下载过程以使用新的 GitHub 实用程序 改进 WebUI 初始化过程中的错误处理和日志记录	zhenxun/builtin_plugins/web_ui/public/__init__.py zhenxun/builtin_plugins/web_ui/public/data_source.py zhenxun/builtin_plugins/web_ui/config.py
更新测试以适应新的 GitHub 实用程序	为新的 GitHub 实用程序函数添加了模拟的 API 调用 更新测试用例以使用新的 RepoInfo 类和实用程序函数	tests/builtin_plugins/auto_update/test_check_update.py

---

提示

• 通过在拉取请求上评论 @sourcery-ai review 来触发新的 Sourcery 审核。
• 通过直接回复审核评论继续与 Sourcery 的讨论。
• 您可以随时通过访问您的仪表板更改您的审核设置：
  • 启用或禁用 Sourcery 生成的拉取请求摘要或审核指南；
  • 更改审核语言；
• 如果您有任何问题或反馈，您可以随时联系我们。

Original review guide in English

Reviewer's Guide by Sourcery

This pull request refactors GitHub-related operations into a separate utility module, updates the auto-update and plugin store functionalities to use the new utility, and makes some adjustments to the WebUI asset management. The changes aim to improve code organization, reusability, and maintainability.

File-Level Changes

Change	Details	Files
Extracted GitHub-related operations into a new utility module	Created new files for GitHub utilities: models.py, func.py, consts.py, and init.py Implemented RepoInfo class for handling repository information Added functions for getting fastest download URLs for different GitHub resources Moved constants and patterns related to GitHub operations to consts.py	zhenxun/utils/github_utils/models.py zhenxun/utils/github_utils/func.py zhenxun/utils/github_utils/consts.py zhenxun/utils/github_utils/__init__.py
Updated auto-update functionality to use the new GitHub utilities	Replaced hardcoded URLs with dynamic URL generation using RepoInfo Updated version fetching logic to use the new GitHub utilities Simplified the update process by using the new utility functions	zhenxun/builtin_plugins/auto_update/_data_source.py zhenxun/builtin_plugins/auto_update/config.py
Refactored plugin store to use the new GitHub utilities	Updated plugin installation process to use RepoInfo for URL generation Removed redundant code related to GitHub operations Simplified the process of fetching plugin information and files	zhenxun/builtin_plugins/plugin_store/data_source.py zhenxun/builtin_plugins/plugin_store/config.py
Updated WebUI asset management	Moved WebUI-related constants to the config file Updated the asset download process to use the new GitHub utilities Improved error handling and logging in the WebUI initialization process	zhenxun/builtin_plugins/web_ui/public/__init__.py zhenxun/builtin_plugins/web_ui/public/data_source.py zhenxun/builtin_plugins/web_ui/config.py
Updated tests to accommodate the new GitHub utilities	Added mocked API calls for the new GitHub utility functions Updated test cases to use the new RepoInfo class and utility functions	tests/builtin_plugins/auto_update/test_check_update.py

---

Tips

• Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
• Continue your discussion with Sourcery by replying directly to review comments.
• You can change your review settings at any time by accessing your dashboard:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[sourcery-ai]

嘿 @AkashiCoin - 我已经审查了你的更改，它们看起来很棒！

这是我在审查期间查看的内容

• 🟡 一般问题：发现3个问题
• 🟡 安全性：发现1个问题
• 🟡 测试：发现1个问题
• 🟡 复杂性：发现1个问题
• 🟢 文档：一切看起来都很好

---

Sourcery对开源项目免费 - 如果你喜欢我们的审查，请考虑分享它们 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{帮助我变得更有用！请点击每条评论上的👍或👎告诉我它是否有帮助。}

Original comment in English

Hey @AkashiCoin - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 3 issues found
• 🟡 Security: 1 issue found
• 🟡 Testing: 1 issue found
• 🟡 Complexity: 1 issue found
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

[sourcery-ai]

建议： 考虑在parse_github_url中提供更具信息性的错误消息

与其仅仅说“github地址格式错误”，不如提供更多关于URL具体错误的上下文信息。这将帮助开发人员更容易地调试问题。

def parse_github_url(github_url: str) -> "RepoInfo":
    try:
        # 解析逻辑在此
        pass
    except ValueError as e:
        raise ValueError(f"无效的GitHub URL格式：{e}。预期格式：https://github.com/owner/repo")

Original comment in English

suggestion: Consider providing more informative error messages in parse_github_url

Instead of just saying 'github地址格式错误', provide more context about what specifically was wrong with the URL. This will help developers debug issues more easily.

def parse_github_url(github_url: str) -> "RepoInfo":
    try:
        # Parsing logic here
        pass
    except ValueError as e:
        raise ValueError(f"Invalid GitHub URL format: {e}. Expected format: https://github.com/owner/repo")

[sourcery-ai]

建议： 改进__get_version_from_repo方法中的错误处理

考虑重试请求或以不同方式处理特定类型的异常。这可以使更新过程更加稳健。例如，您可能希望在网络错误时重试，但在身份验证错误时不重试。

    async def __get_version_from_repo(cls, repo_info: RepoInfo) -> str:
        max_retries = 3
        retry_delay = 1

        for attempt in range(max_retries):
            try:
                return await cls.__fetch_version(repo_info)
            except aiohttp.ClientError as e:
                if attempt == max_retries - 1:
                    raise
                await asyncio.sleep(retry_delay)

Original comment in English

suggestion: Improve error handling in __get_version_from_repo method

Consider retrying the request or handling specific types of exceptions differently. This could make the update process more robust. For example, you might want to retry on network errors but not on authentication errors.

    async def __get_version_from_repo(cls, repo_info: RepoInfo) -> str:
        max_retries = 3
        retry_delay = 1

        for attempt in range(max_retries):
            try:
                return await cls.__fetch_version(repo_info)
            except aiohttp.ClientError as e:
                if attempt == max_retries - 1:
                    raise
                await asyncio.sleep(retry_delay)

[sourcery-ai]

🚨 问题（安全性）： 挂载静态文件时的潜在安全风险

遍历PUBLIC_PATH中的所有文件夹并挂载它们，如果存在意外的文件夹，可能会带来安全风险。考虑明确列出允许的文件夹。

Original comment in English

🚨 issue (security): Potential security risk in mounting static files

Iterating over all folders in PUBLIC_PATH and mounting them could be a security risk if unexpected folders are present. Consider explicitly listing the allowed folders instead.

[sourcery-ai]

建议（bug风险）： 避免使用裸except子句

通常最好捕获特定的异常，而不是使用裸except。这允许更精确的错误处理，并避免意外捕获和抑制未预料的错误。

Suggested change

	except Exception as e:
	except (ValueError, TypeError, AttributeError) as e:

Original comment in English

suggestion (bug_risk): Avoid using bare except clauses

It's generally better to catch specific exceptions rather than using a bare except. This allows for more precise error handling and avoids accidentally catching and suppressing unexpected errors.

Suggested change

	except Exception as e:
	except (ValueError, TypeError, AttributeError) as e:

[sourcery-ai]

建议（测试）： 为与GitHub相关的URL添加新的模拟响应

这些新的模拟响应针对raw.githubusercontent.com、github.com和codeload.github.com，改进了与GitHub相关操作的测试覆盖率。考虑添加断言以验证在测试期间这些端点是否按预期被调用。

Original comment in English

suggestion (testing): New mock responses added for GitHub-related URLs

These new mock responses for raw.githubusercontent.com, github.com, and codeload.github.com improve the test coverage for GitHub-related operations. Consider adding assertions to verify that these endpoints are called as expected during the tests.

[sourcery-ai]

问题（复杂性）： 考虑简化JsdelivrAPI类并使用策略模式进行API实现。

当前的实现引入了不必要的复杂性，特别是在JsdelivrAPI类中。以下是一些简化代码同时保持功能的建议：

1. 合并full_files_path和recurrence_files方法：

class JsdelivrAPI(BaseAPI):
    # ...

    def get_file_paths(self, module_path: str, is_dir: bool = True) -> list[str]:
        paths = module_path.split("/")
        cur_file = self
        for path in paths[:-1]:  # 导航到正确的目录
            cur_file = next((f for f in cur_file.files if f.type == FileType.DIR and f.name == path), None)
            if not cur_file:
                raise ValueError(f"模块路径{module_path}不存在")

        def collect_files(file, current_path):
            if file.type == FileType.FILE:
                return [f"{current_path}/{file.name}"]
            elif file.type == FileType.DIR and file.files:
                return [path for f in file.files for path in collect_files(f, f"{current_path}/{file.name}")]
            return []

        return collect_files(cur_file, "/".join(paths[:-1]))

2. 考虑使用策略模式而不是继承进行API实现：

from typing import Protocol

class APIStrategy(Protocol):
    async def parse_repo_info(self, repo_info: RepoInfo) -> dict:
        ...

    def get_files(self, module_path: str, is_dir: bool) -> list[str]:
        ...

class RepoAPI:
    def __init__(self, strategy: APIStrategy):
        self.strategy = strategy

    async def parse_repo_info(self, repo_info: RepoInfo) -> dict:
        return await self.strategy.parse_repo_info(repo_info)

    def get_files(self, module_path: str, is_dir: bool) -> list[str]:
        return self.strategy.get_files(module_path, is_dir)

# 为不同的API实现策略
class JsdelivrStrategy:
    # 实现JsdelivrAPI特定的方法

class GitHubStrategy:
    # 实现GitHubAPI特定的方法

# 使用
jsdelivr_api = RepoAPI(JsdelivrStrategy())
github_api = RepoAPI(GitHubStrategy())

这些更改简化了代码结构，减少了嵌套，并使得在不增加复杂性的情况下更容易添加新的API实现。策略模式允许在不使用深层继承层次结构的情况下更灵活地组合行为。

Original comment in English

issue (complexity): Consider simplifying the JsdelivrAPI class and using a strategy pattern for API implementations.

The current implementation introduces unnecessary complexity, particularly in the JsdelivrAPI class. Here are some suggestions to simplify the code while maintaining functionality:

1. Combine full_files_path and recurrence_files methods:

class JsdelivrAPI(BaseAPI):
    # ...

    def get_file_paths(self, module_path: str, is_dir: bool = True) -> list[str]:
        paths = module_path.split("/")
        cur_file = self
        for path in paths[:-1]:  # Navigate to the correct directory
            cur_file = next((f for f in cur_file.files if f.type == FileType.DIR and f.name == path), None)
            if not cur_file:
                raise ValueError(f"Module path {module_path} does not exist")

        def collect_files(file, current_path):
            if file.type == FileType.FILE:
                return [f"{current_path}/{file.name}"]
            elif file.type == FileType.DIR and file.files:
                return [path for f in file.files for path in collect_files(f, f"{current_path}/{file.name}")]
            return []

        return collect_files(cur_file, "/".join(paths[:-1]))

2. Consider using a strategy pattern instead of inheritance for API implementations:

from typing import Protocol

class APIStrategy(Protocol):
    async def parse_repo_info(self, repo_info: RepoInfo) -> dict:
        ...

    def get_files(self, module_path: str, is_dir: bool) -> list[str]:
        ...

class RepoAPI:
    def __init__(self, strategy: APIStrategy):
        self.strategy = strategy

    async def parse_repo_info(self, repo_info: RepoInfo) -> dict:
        return await self.strategy.parse_repo_info(repo_info)

    def get_files(self, module_path: str, is_dir: bool) -> list[str]:
        return self.strategy.get_files(module_path, is_dir)

# Implement strategies for different APIs
class JsdelivrStrategy:
    # Implement JsdelivrAPI-specific methods

class GitHubStrategy:
    # Implement GitHubAPI-specific methods

# Usage
jsdelivr_api = RepoAPI(JsdelivrStrategy())
github_api = RepoAPI(GitHubStrategy())

These changes simplify the code structure, reduce nesting, and make it easier to add new API implementations without increasing complexity. The strategy pattern allows for more flexible composition of behaviors without deep inheritance hierarchies.