ci: publish with web frontend

[lss233]

Summary by Sourcery

发布带有 Web 前端的应用程序。

增强功能：

• 更新 Web 应用程序，从 "web" 目录提供静态文件。
• 实现一个通用路由，为任何未匹配的路径（在 / 之后）提供 index.html，以支持客户端路由。

构建：

• 在 Docker 镜像中打包 Web 前端文件。
• 在 8080 端口提供 Web 前端服务。

持续集成（CI）：

• 在 CI 工作流程中下载并解压 Web 前端分发 ZIP 文件。

Original summary in English

Summary by Sourcery

Publish the application with a web frontend.

Enhancements:

• Update the web application to serve static files from the "web" directory.
• Implement a catch-all route to serve index.html for any unmatched paths after / to support client-side routing.

Build:

• Bundle the web frontend files in the Docker image.
• Serve the web frontend on port 8080.

CI:

• Download and extract the web frontend distribution zip file during the CI workflow.

[sourcery-ai]

审阅者指南 by Sourcery

该拉取请求通过修改静态文件服务方式、更新部署工作流以包含Web资源管理以及优化API路由中的工作流注册调用，来增强Web前端的CI/CD流程。

Quart应用的静态文件服务序列图

sequenceDiagram
    actor Client as "HTTP Client"
    participant App as "Quart App"

    %% Request for root path
    Client->>App: GET /
    App-->>Client: index.html (via send_static_file)

    %% Request for a static asset
    Client->>App: GET /<file_path>
    App->>App: Check if path starts with 'backend-api'
    alt Valid file request
        App->>App: Attempt to send_static_file(file_path)
        App-->>Client: file content
    else Error or file not found
        App->>App: Fallback to send_static_file('index.html')
        App-->>Client: index.html
    end

Loading

文件级变更

变更	详情	文件
更新静态文件服务逻辑	从Quart构造函数中移除静态文件夹初始化参数，并以编程方式设置。 调整静态文件夹路径为'../../web'。 为'/'引入新路由，以使用日志记录提供index.html。 添加通用的捕获所有路由，用于提供静态文件，并在出错时回退到index.html，同时排除某些路径。	framework/web/app.py
增强Web前端部署的CI工作流	移除冗余的echo语句。 添加新步骤，从远程发布下载dist.zip文件并将其解压到指定目录。	.github/workflows/quickstart-windows.yml
改进用于Web资源集成的Dockerfile	添加命令以下载和解压包含Web分发的dist.zip文件。 确保清理下载的zip文件。 暴露8080端口以允许外部访问Web服务。	Dockerfile
优化API路由中的工作流注册查找	在API路由的工作流存在性检查中，将get_workflow的使用替换为get。	framework/web/api/dispatch/routes.py

---

提示和命令

与Sourcery交互

• 触发新审阅： 在拉取请求上评论 @sourcery-ai review。
• 继续讨论： 直接回复Sourcery的审阅评论。
• 从审阅评论生成GitHub问题： 通过回复审阅评论，要求Sourcery创建一个问题。您也可以用 @sourcery-ai issue 回复审阅评论来创建问题。
• 生成拉取请求标题： 在拉取请求标题的任何位置写 @sourcery-ai 以随时生成标题。您也可以在拉取请求上评论 @sourcery-ai title 以随时（重新）生成标题。
• 生成拉取请求摘要： 在拉取请求正文的任何位置写 @sourcery-ai summary 以随时在您想要的位置生成PR摘要。您也可以在拉取请求上评论 @sourcery-ai summary 以随时（重新）生成摘要。
• 生成审阅者指南： 在拉取请求上评论 @sourcery-ai guide 以随时（重新）生成审阅者指南。
• 解决所有Sourcery评论： 在拉取请求上评论 @sourcery-ai resolve 以解决所有Sourcery评论。如果您已经处理了所有评论，并且不想再看到它们，这很有用。
• 取消所有Sourcery审阅： 在拉取请求上评论 @sourcery-ai dismiss 以取消所有现有的Sourcery审阅。特别适用于您想重新开始审阅的情况 - 别忘了评论 @sourcery-ai review 以触发新的审阅！
• 为问题生成行动计划： 在问题上评论 @sourcery-ai plan 以为其生成行动计划。

自定义您的体验

访问您的仪表板以：

• 启用或禁用审阅功能，如Sourcery生成的拉取请求摘要、审阅者指南等。
• 更改审阅语言。
• 添加、删除或编辑自定义审阅说明。
• 调整其他审阅设置。

获取帮助

• 联系我们的支持团队以获取问题或反馈。
• 访问我们的文档以获取详细指南和信息。
• 通过关注我们的X/Twitter、LinkedIn或GitHub与Sourcery团队保持联系。

Original review guide in English

Reviewer's Guide by Sourcery

This pull request enhances the CI/CD process for the web frontend by modifying how static files are served, updating the deployment workflows to include web asset management, and refining the workflow registry calls in the API routes.

Sequence diagram for static file serving in Quart App

sequenceDiagram
    actor Client as "HTTP Client"
    participant App as "Quart App"

    %% Request for root path
    Client->>App: GET /
    App-->>Client: index.html (via send_static_file)

    %% Request for a static asset
    Client->>App: GET /<file_path>
    App->>App: Check if path starts with 'backend-api'
    alt Valid file request
        App->>App: Attempt to send_static_file(file_path)
        App-->>Client: file content
    else Error or file not found
        App->>App: Fallback to send_static_file('index.html')
        App-->>Client: index.html
    end

Loading

File-Level Changes

Change	Details	Files
Update static file serving logic	Removed the static_folder initialization parameter from the Quart constructor and set it programmatically. Adjusted static folder path to '../../web'. Introduced a new route for '/' to serve index.html with logging. Added a generic catch-all route for serving static files with a fallback to index.html on error, while excluding certain paths.	framework/web/app.py
Enhance CI workflow for web frontend deployment	Removed the redundant echo statement. Added a new step to download the dist.zip file from a remote release and extract it into the designated directory.	.github/workflows/quickstart-windows.yml
Improve Dockerfile for web asset integration	Added commands to download and unzip the dist.zip file containing the web distribution. Ensured proper cleanup of the downloaded zip file. Exposed port 8080 to allow external access to the web service.	Dockerfile
Refine workflow registry lookup in API routes	Replaced usage of get_workflow with get in the workflow existence checks within API routing.	framework/web/api/dispatch/routes.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

嘿 @lss233 - 我已经审查了你的更改 - 以下是一些反馈：

整体评论：

• 考虑在索引路由中将打印语句替换为异步日志记录器，以实现更好的生产日志记录。
• 在 serve_static 中捕获更具体的异常，而不是使用通用异常，以避免掩盖意外错误。

以下是我在审查期间查看的内容

• 🟢 一般问题：一切看起来都很好
• 🟢 安全性：一切看起来都很好
• 🟢 测试：一切看起来都很好
• 🟢 复杂性：一切看起来都很好
• 🟢 文档：一切看起来都很好

---

Sourcery 对开源是免费的 - 如果你喜欢我们的评论，请考虑分享它们 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{帮助我变得更有用！请在每条评论上点击 👍 或 👎，我将使用这些反馈来改进你的评论。}

Original comment in English

Hey @lss233 - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider replacing the print statement in the index route with an asynchronous logger for better production logging.
• Catch more specific exceptions in serve_static instead of the generic exception to avoid masking unintended errors.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 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 and I'll use the feedback to improve your reviews.}