openab 無法看到其他BOT 傳遞內容

[slps970093]

Question

use case:
當 openab commit 並提交到 origin後，會觸發 ci host，跑完的結果會透過WEBHOOK API 打回至指定THREAD

webhook url 產生方式
頻道 -> 整合 -> webhook

[thepagent]

suggest use KIRO or other coding CLI to debug this and post more info here so we can figure out possible solutions.

[brettchien]

GitHub CI → Discord → openab 串接完整報告

本報告由 openab agent（Jellyfish）自動完成研究、實作與驗證，並由 agent 發佈此 comment。

Prompt to reproduce this setup (paste directly to an agent)

Set up GitHub CI → Discord → openab notification bridge:

1. Create a Discord Webhook in the target channel via API. Save the URL.
2. Create a thread in the same channel via API. Save the thread ID.
3. Set openab config.toml: allow_bot_messages = "mentions", trusted_bot_ids = [].
4. Add GitHub repo secrets: DISCORD_WEBHOOK_URL, DISCORD_THREAD_ID, DISCORD_BOT_ID (openab bot's Discord user ID).
5. Create .github/workflows/ci-discord-notify.yml. Pipe cargo check to check.log, clippy to clippy.log, test to test.log. Notify step: curl multipart POST to DISCORD_WEBHOOK_URL?thread_id=DISCORD_THREAD_ID, content="<@DISCORD_BOT_ID> result", allowed_mentions={"users":["DISCORD_BOT_ID"]}, attach all 3 logs. Use Webhook URL, not Bot Token (openab ignores its own messages).
6. Push a commit and verify: one webhook message appears in the thread with check.log, clippy.log, and test.log attached, and openab responds.

Pitfalls: use "on" not "@" before branch name (invalid user ID gets stripped by Discord); don't manually trigger workflow_dispatch (causes duplicate notifications).

日期：2026-04-16　專案：brettchien/openab　對應 issue：openab#362

環境版本

	版本
openab binary（OPENAB_VERSION）	0.7.6
openab image tag（OPENAB_IMAGE_TAG）	0.7.6

---

背景

openab 預設忽略所有 bot 訊息，導致 GitHub CI Webhook 打進 Discord 後 openab 收不到。本次目標是完整復現並解決這個串接問題。

---

問題根源分析

src/discord.rs 有兩層過濾：

1. 第 55–56 行（硬規則）：if msg.author.id == bot_id { return; } — bot 自己的訊息永遠忽略，任何設定都無法覆蓋
2. 第 72–128 行：allow_bot_messages / trusted_bot_ids 控制其他 bot 訊息的過濾

第一版失敗原因：CI workflow 用 Jellyfish 自己的 Bot Token 發通知，訊息 author 就是 Jellyfish，命中第一層硬規則直接被丟棄。

---

解決方案

架構

git push
  → GitHub Actions 觸發
  → cargo check / clippy / test
  → Notify Discord step（用 Webhook URL 發訊息）
  → Discord thread（author = GitHub CI webhook，非 Jellyfish）
  → openab 收到（allow_bot_messages = "all" 或 "mentions"，trusted_bot_ids 已清空）
  → openab 回應

關鍵：改用 Webhook URL 而非 Bot Token

方式	訊息 author	openab 能收到？
Bot Token（舊）	Jellyfish 自己	❌（硬規則擋掉）
Webhook URL（新）	GitHub CI webhook	✅

allow_bot_messages 模式選擇

模式	需要	推薦度
"all"	無額外設定	快速驗證用
"mentions"	CI webhook payload 加 <@BOT_ID> + allowed_mentions	正式使用推薦，更精準

Webhook 可以透過 allowed_mentions.users mention bot user，兩種模式均已驗證可行。

---

實作步驟

1. Discord 設定

• Webhook：在目標 channel 建立，名稱 GitHub CI，取得 Webhook URL
• 測試 thread：在同一 channel 建立，取得 thread ID

2. openab config.toml

方案 A：

[discord]
allow_bot_messages = "all"
trusted_bot_ids = []

方案 B（推薦）：

[discord]
allow_bot_messages = "mentions"
trusted_bot_ids = []

3. GitHub Secrets

Secret	內容
DISCORD_WEBHOOK_URL	Webhook 完整 URL
DISCORD_THREAD_ID	目標 thread 的 ID
DISCORD_BOT_TOKEN	openab Bot Token
DISCORD_BOT_ID	openab bot 的 Discord user ID（方案 B 需要）

4. Workflow 核心（Notify Discord step）

方案 A：allow_bot_messages = "all"（無 mention）

- name: Notify Discord
  if: always()
  run: |
    SHORT_SHA="${FULL_SHA:0:7}"
    if [ "$JOB_STATUS" = "success" ]; then EMOJI="✅"; else EMOJI="❌"; fi
    MSG="${EMOJI} CI ${JOB_STATUS} | ${REPO} on ${REF} (${SHORT_SHA})\n<${RUN_URL}>"
    curl -sf -X POST "${DISCORD_WEBHOOK_URL}?thread_id=${DISCORD_THREAD_ID}" \
      -F "payload_json={\"content\":\"${MSG}\"}" \
      -F "files[0]=@/tmp/check.log;filename=check.log;type=text/plain" \
      -F "files[1]=@/tmp/clippy.log;filename=clippy.log;type=text/plain" \
      -F "files[2]=@/tmp/test.log;filename=test.log;type=text/plain" \
      -o /dev/null

方案 B：allow_bot_messages = "mentions"（帶 @mention，推薦）

需額外 secret：DISCORD_BOT_ID（openab bot 的 Discord user ID）

- name: Notify Discord
  if: always()
  run: |
    SHORT_SHA="${FULL_SHA:0:7}"
    if [ "$JOB_STATUS" = "success" ]; then EMOJI="✅"; else EMOJI="❌"; fi
    MSG="<@${DISCORD_BOT_ID}> ${EMOJI} CI ${JOB_STATUS} | ${REPO} on ${REF} (${SHORT_SHA})\n<${RUN_URL}>"
    curl -sf -X POST "${DISCORD_WEBHOOK_URL}?thread_id=${DISCORD_THREAD_ID}" \
      -F "payload_json={\"content\":\"${MSG}\",\"allowed_mentions\":{\"users\":[\"${DISCORD_BOT_ID}\"]}}" \
      -F "files[0]=@/tmp/check.log;filename=check.log;type=text/plain" \
      -F "files[1]=@/tmp/clippy.log;filename=clippy.log;type=text/plain" \
      -F "files[2]=@/tmp/test.log;filename=test.log;type=text/plain" \
      -o /dev/null

---

所需權限

Discord Bot 權限

權限	用途
Read Message History	讀取 channel/thread 訊息紀錄
Send Messages	在 channel 發訊息
Send Messages in Threads	在 thread 發訊息
Manage Webhooks	透過 API 建立 Webhook
Attach Files	發送帶附件的訊息（log 檔）
Create Public Threads	建立測試 thread

注意：若 bot 已有 Administrator 權限，以上全部自動涵蓋，無需額外設定。

如何設定 Manage Webhooks 權限

方式 A：重新邀請 bot（永久生效）

1. Discord Developer Portal → 你的 Application → OAuth2 → URL Generator
2. Scopes 勾 bot，Bot Permissions 勾 Manage Webhooks
3. 複製產生的 URL，重新邀請 bot 進 server

方式 B：直接在 server 改角色（bot 已在 server）

1. Server Settings → Roles → 找到 bot 的角色
2. Permissions → 勾 Manage Webhooks → 儲存

方式 C：針對特定 channel（最小權限）

1. 對目標頻道右鍵 → Edit Channel → Permissions
2. 找到 bot 的角色 → Manage Webhooks 設為允許

---

GitHub Token Scopes

Scope	用途
repo	讀寫 repo 內容（含 workflow 檔）
workflow	建立／觸發 GitHub Actions workflow
secrets	寫入 repo secrets

---

過程中遇到的問題與修正

問題	原因	修正
openab 收不到 CI 通知	用 Bot Token 發訊息，author 是自己	改用 Webhook URL
${SHA:0:7} 顯示原始字串	bash substring 在 curl -d 字串內展開失敗	先存到 $SHORT_SHA 再帶入
@ main 在 Discord 顯示空白	main 不是有效的 Discord user ID，Discord 找不到對應 user 自動移除該 mention	改成 on main；若要 mention bot，需使用 <@BOT_ID> 格式並在 payload 加上 allowed_mentions: { users: ["BOT_ID"] }
重複通知	測試期間同時觸發 push + workflow_dispatch	正常 push 只觸發一次，非問題

---

最終驗證

[WEBHOOK] GitHub CI | ✅ CI success | {repo} on main ({sha})
  attachment: check.log
  attachment: clippy.log
  attachment: test.log
→ openab 回應：CI 通過了！

• 單次 push 只產生一則通知 ✅
• 附帶 check.log + clippy.log + test.log ✅
• openab 能讀到並回應 ✅

[brettchien]