Skip to content

fix(ws): BetterGI 与 ZZZ-OD 迁移到 Publisher 出口 - #615

Merged
AthenaHibou merged 3 commits into
AUTO-MAS-Project:devfrom
qiyinxi:fix/sentry-be-20260908
Sep 8, 2026
Merged

AthenaHibou merged 3 commits into
AUTO-MAS-Project:devfrom
qiyinxi:fix/sentry-be-20260908

Conversation

@qiyinxi

@qiyinxi qiyinxi commented Sep 8, 2026 •

Copy link
Copy Markdown
Member

Closes #613

问题

#295(a671fdd1,2026-08-28)删除了 Config.send_websocket_message,98 处调用当时全部迁到 Publisher。但 BetterGI 专项 #410(a2c78cfe,09-01)与 ZZZ-OD 专项 #593(f735b547,09-08)都在 #295 之前拉出分支、之后合入,合并时没跟随这次迁移,dev 上因此留下 18 处调用、0 处定义。

AppConfig 没有 __getattr__,所以这些路径运行时必抛 AttributeError,并把真实的出错原因整个盖掉——Sentry 上看到的就是 BetterGI任务出现异常: 'AppConfig' object has no attribute 'send_websocket_message',而不是「配置检查为什么没过」。

改动

18 处全部按 app/task/MAA 的既有写法迁移:

# 之前
await Config.send_websocket_message(
    id=self.task_info.task_id, type="Info", data={"Error": msg}
)
# 之后
await Publisher.send(
    id=self.task_info.task_id,
    type=protocol.TASK_NOTICE,
    data=WSTaskNoticeData(level="error", message=msg),
)

18 处原本形态完全一致(type="Info" + data={"Error": ...}),所以是一一对应的机械迁移,没有改动任何触发条件、状态赋值或控制流。BetterGI/ScriptConfig.py 与 ZzzOd/ScriptConfig.py 迁移后不再用到 Config,顺带去掉了该 import。

分布:BetterGI/manager.py 4、BetterGI/AutoProxy.py 1、BetterGI/ScriptConfig.py 1、ZzzOd/manager.py 9、ZzzOd/AutoProxy.py 2、ZzzOd/ScriptConfig.py 1。

ZZZ-OD 模块目前整体没过 ruff format,本 PR 没有顺手格式化,以免把无关重排混进来。

本地验证

.venv/Scripts/python.exe -m pytest tests -q
682 passed, 3 skipped, 1 warning, 151 subtests passed in 7.65s

.venv/Scripts/python.exe -m pytest tests --collect-only -q   # 685 collected, 退出码 0
.venv/Scripts/python.exe -m ruff check app/task/BetterGI app/task/ZzzOd   # All checks passed
grep -rn "send_websocket_message" app/                        # 0 处残留

未做真机手测:触发这些分支需要装 BetterGI / ZZZ-OD 并造出「检查不通过」的场景,本地没有环境。迁移是形态一致的机械替换,Publisher.send 与旧方法签名相同(id / type / data),风险集中在提示能否正常送达前端,建议合并前由专项作者跑一次能触发提示的路径。

请审阅

@TCddddd BetterGI 专项部分,@AthenaHibou ZZZ-OD 专项部分。确认没问题后请你们自行合并,我不代合。

Summary by Sourcery

将 BetterGI 和 ZZZ-OD 的错误通知迁移到 Publisher,恢复真实任务错误信息向前端的正常传递。

Bug Fixes:

  • 修复 BetterGI 和 ZZZ-OD 任务错误提示因使用已移除的 WebSocket 配置接口而无法发送,导致前端显示无关的属性错误。

Enhancements:

  • 统一将 BetterGI 和 ZZZ-OD 的任务通知迁移到现行 Publisher WebSocket 出口,并使用标准化任务通知格式。
Original summary in English

Summary by Sourcery

将 BetterGI 和 ZZZ-OD 的错误通知迁移到 Publisher,恢复真实任务错误信息向前端的正常传递。

Bug Fixes:

  • 修复 BetterGI 和 ZZZ-OD 任务错误提示因使用已移除的 WebSocket 配置接口而无法发送,导致前端显示无关的属性错误。

Enhancements:

  • 统一将 BetterGI 和 ZZZ-OD 的任务通知迁移到现行 Publisher WebSocket 出口,并使用标准化任务通知格式。
Original summary in English
Original summary in English

AUTO-MAS-Project#295 删除 Config.send_websocket_message 后,BetterGI(AUTO-MAS-Project#410) 与 ZZZ-OD(AUTO-MAS-Project#593)
两个专项分支在其之后合入却没跟随迁移,共 18 处仍调用该方法。AppConfig 没有
__getattr__,这些路径运行时必抛 AttributeError,把真实的出错原因盖掉。

按 app/task/MAA 的既有写法统一改为
Publisher.send(type=protocol.TASK_NOTICE, data=WSTaskNoticeData(level="error", ...)),
语义与原调用一一对应,未改动任何触发条件。

Closes AUTO-MAS-Project#613

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@qiyinxi qiyinxi added bug Something isn't working Sentry daily Sentry daily issues labels Sep 8, 2026

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @qiyinxi, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 4 days and 3 hours by commenting @sourcery-ai review. Upgrade to get a review now.

@qiyinxi
qiyinxi requested a review from AthenaHibou September 8, 2026 08:25
@sourcery-ai

sourcery-ai Bot commented Sep 8, 2026

Copy link
Copy Markdown

审查者指南

本 PR 修复 BetterGI 与 ZZZ-OD 分支遗留的 18 处失效 WebSocket 调用,将其机械迁移为现行 Publisher.send + TASK_NOTICE/WSTaskNoticeData 方案,不改变业务控制流;测试、收集测试和目标目录静态检查均已通过,但仍建议专项作者实际触发错误路径确认前端通知可达。

任务错误通知迁移时序图

sequenceDiagram
    participant Task as BetterGI_or_ZZZOD_Task
    participant Publisher
    participant WebSocket as WebSocket_Client

    Task->>Publisher: send(id, protocol.TASK_NOTICE, WSTaskNoticeData)
    Publisher->>WebSocket: Publish task notice
    WebSocket-->>Publisher: Delivery result
Loading

文件级变更

变更 详情 文件
将 BetterGI 和 ZZZ-OD 中遗留的 WebSocket 错误通知迁移到 Publisher 出口。
  • 替换 18 处 Config.send_websocket_message 调用
  • 统一使用 protocol.TASK_NOTICE 和 WSTaskNoticeData 表达错误消息
  • 保留原有触发条件、状态更新和控制流
  • 移除仅因通知调用而不再需要的 Config 导入
app/task/BetterGI/manager.py
app/task/BetterGI/AutoProxy.py
app/task/BetterGI/ScriptConfig.py
app/task/ZzzOd/manager.py
app/task/ZzzOd/AutoProxy.py
app/task/ZzzOd/ScriptConfig.py
更新项目版本元数据。
  • 调整版本文件内容
res/version.json
完成静态检查和测试验证。
  • 全量测试通过,收集测试正常
  • BetterGI 与 ZZZ-OD 目录 Ruff 检查通过
  • 确认 app/ 下无 send_websocket_message 残留

可能关联的问题


提示和命令

与 Sourcery 交互

  • 触发新的审查: 在拉取请求中评论 @sourcery-ai review。
  • 继续讨论: 直接回复 Sourcery 的审查评论。
  • 根据审查评论创建 GitHub issue: 回复审查评论,请 Sourcery 根据该评论创建 issue。你也可以使用 @sourcery-ai issue 回复审查评论,以根据该评论创建 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 生成的拉取请求摘要、审查者指南等。
  • 更改审查语言。
  • 添加、移除或编辑自定义审查指令。
  • 调整其他审查设置。

获取帮助

Original review guide in English

Reviewer's Guide

本 PR 修复 BetterGI 与 ZZZ-OD 分支遗留的 18 处失效 WebSocket 调用,将其机械迁移为现行 Publisher.send + TASK_NOTICE/WSTaskNoticeData 方案,不改变业务控制流;测试、收集测试和目标目录静态检查均已通过,但仍建议专项作者实际触发错误路径确认前端通知可达。

Sequence diagram for task error notification migration

sequenceDiagram
    participant Task as BetterGI_or_ZZZOD_Task
    participant Publisher
    participant WebSocket as WebSocket_Client

    Task->>Publisher: send(id, protocol.TASK_NOTICE, WSTaskNoticeData)
    Publisher->>WebSocket: Publish task notice
    WebSocket-->>Publisher: Delivery result
Loading

File-Level Changes

Change Details Files
将 BetterGI 和 ZZZ-OD 中遗留的 WebSocket 错误通知迁移到 Publisher 出口。
  • 替换 18 处 Config.send_websocket_message 调用
  • 统一使用 protocol.TASK_NOTICE 和 WSTaskNoticeData 表达错误消息
  • 保留原有触发条件、状态更新和控制流
  • 移除仅因通知调用而不再需要的 Config 导入
app/task/BetterGI/manager.py
app/task/BetterGI/AutoProxy.py
app/task/BetterGI/ScriptConfig.py
app/task/ZzzOd/manager.py
app/task/ZzzOd/AutoProxy.py
app/task/ZzzOd/ScriptConfig.py
更新项目版本元数据。
  • 调整版本文件内容
res/version.json
完成静态检查和测试验证。
  • 全量测试通过,收集测试正常
  • BetterGI 与 ZZZ-OD 目录 Ruff 检查通过
  • 确认 app/ 下无 send_websocket_message 残留

Possibly linked issues


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!

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

@AthenaHibou AthenaHibou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

已对照 issue #613 在本地 dev 逐条核验,结论:

Issue 属实:18 处 Config.send_websocket_message 调用的文件与行号和 issue 清单完全一致,app/ 下确无任何定义,AppConfig 也没有 __getattr__ 兜底,这些路径运行时必抛 AttributeError。

修改合理:18 处替换与 app/task/MAA 既有写法一致——Publisher.send(id, type, data) 签名匹配(模块级单例),protocol.TASK_NOTICE 与 WSTaskNoticeData(level="error", ...) 均存在且合法,前端订阅 task.notice 可正常收到提示;两个 ScriptConfig.py 删除 Config 导入后无残留引用,其余文件保留导入也正确。控制流、状态赋值与消息文案均未改动。代码部分 LGTM。

两处小问题,都在 res/version.json,建议顺手改掉:

  1. 新条目末尾缺署名,请补 by [@qiyinxi](https://github.com/qiyinxi)。
  2. 条目违反 changelog「写症状、不写根因」的约定:冒号后整段(“仍在调用早已删除的旧 WebSocket 出口…抛 AttributeError”)是根因和内部实现细节,且与开头表述重复。建议整条改为:
"BetterGI专项、ZZZ-OD专项 修复任务出错时提示送不到前端、用户看到的报错与实际出错原因无关的问题 by [@qiyinxi](https://github.com/qiyinxi)"

改完这处就可以合并了。

@AthenaHibou

Copy link
Copy Markdown
Member

@qiyinxi review

@qiyinxi

qiyinxi commented Sep 8, 2026

Copy link
Copy Markdown
Member Author

审了一遍,代码本身没发现问题,一处合并前要处理。

必修 res/version.json — 条目加错地方了。本分支 base 是 41061871,在 #622(095c7e68)之前;#622 之后 CHANGELOG.md 才是唯一手写来源,res/version.json 整份由 scripts/changelog.py 生成。现在这个文件与 dev 有冲突(dev 侧同一行被机器人补了署名并新增「开发流程」分类),合并 dev 后条目要搬到 CHANGELOG.md 顶部 v5.5.0-beta.3 段的「修复」下。

两点提醒:PR 存在冲突时 pull_request 工作流不运行,所以现在看不到「检查更新日志」的结果;另外此刻直接跑 changelog.py sync 会把 cf4d8991 那 92 行机器人署名一并回滚,建议等 version.json resync 落地后再跑,或先只手改 CHANGELOG.md。

核过没问题的部分

  • 18 处 Config.send_websocket_message 全部迁移,全仓(含 tests / frontend)无残留,type="Info" 也零命中,数量与 BetterGI 与 ZZZ-OD 共 18 处仍调用 #295 已删除的 Config.send_websocket_message,运行时必抛 AttributeError #613 列的一致。
  • 两个 ScriptConfig.py 删掉 from app.core import Config 后确无裸 Config 引用(ruff F821 + AST 扫描 + 实际 import 均通过),不会 NameError。
  • 调用形态与 app/task/HSR/manager.py:694、app/task/M9A/manager.py:223 同形;传入 message 的 check_result / sub_check / _guard_warnings 都是 str,不会触发 pydantic 校验异常。
  • suppress(Exception) 的包裹关系逐处比对无增减,控制流未变。
  • 前端消费者对得上:useBettergiGuiSession.ts:90、useZzzodGuiSession.ts:102、useSchedulerLogic.ts:825 都只处理 level === 'error'。

静态审为主,另在临时目录用锁定 venv 跑了 ruff / import / tests/task/test_zzzod_*.py(39 条通过);未真机验证 WS 端到端投递。

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sourcery assessment

Approved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working Sentry daily Sentry daily issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants