feat(discord): add Discord notification bot service (#6486)

* feat(discord): add Discord notification bot service, settings UI, and event subscriber
- internal/web/service/discord: implement lightweight Discord REST API v10 client and EventBus subscriber
- internal/web/service/setting: add discordBotEnable, discordBotToken, discordChannelId, discordEnabledEvents, discordCpu, discordMemory settings and secret protection
- internal/web/controller: register POST /panel/api/setting/testDiscord endpoint
- frontend: add Discord settings tab, notifications configuration, sidebar navigation, and command palette integration
- translation: add localization keys across all 13 locales
- tests: add comprehensive unit tests with httptest server and verify route/i18n contracts

* fix(discord): address PR review findings on concurrency, linting, i18n, and stories

- subscriber: eliminate unbounded goroutines, sending inline per EventBus contract
- discord: accept context.Context in SendMessage, SendEmbed, SendTest with http.NewRequestWithContext
- format: apply gofumpt to controller and entity struct alignments
- i18n: localize testDiscord controller responses across all 13 locales
- storybook: add DiscordNotifications.stories.tsx component story

* docs: add Discord bot setup and operations guide

- add docs/content/docs/en/operations/discord-bot.mdx with setup steps, event indicators, settings, and troubleshooting
- add docs/content/docs/ru/operations/discord-bot.mdx with localized instructions
- update operations/meta.json across en, ru, zh, fa
- link Discord bot from panel configuration overview

* feat(discord): add discordLang, discordRunTime, discordBotBackup settings and update settings UI

- internal/web/entity: add DiscordRunTime, DiscordBotBackup, DiscordLang fields to AllSetting
- internal/web/service/setting: add defaultValueMap entries, getters, and setters
- frontend: update AllSetting schema, model defaults, and generate OpenAPI / Zod contracts
- frontend: extract shared NotifyTimeField component and update DiscordTab with General and Notifications tabs
- translation: add localization keys across all 13 locales

* feat(discord): implement scheduled status reports and database backup attachments

- internal/web/service/discord: add SendMessageWithFiles supporting multipart uploads
- internal/web/service/discord: implement BuildReport and SendReport generating rich status embeds
- internal/web/service/discord: attach database backup (and config.json) when discordBotBackup is enabled
- internal/web/job: implement DiscordNotifyJob scheduled via robfig/cron
- internal/web/locale: add LocalizerFor and I18nForLang helpers
- internal/web/controller: trigger reloadDiscordFunc to dynamically reschedule cron upon setting changes
- internal/web/web: register and reschedule DiscordNotifyJob
- tests: comprehensive unit tests for multipart uploads, status reporting, and job execution

* feat(discord): add interactive bot commands via Gateway WebSocket and update documentation

- internal/web/service/discord/gateway: connect to Discord Gateway v10 via WebSocket (gorilla/websocket)
- internal/web/service/discord/gateway: handle heartbeat loop, reconnection, and command dispatch
- commands: implement !status, !report, !backup, !usage <email>, !inbounds, !restart, !help (with ! and / prefixes)
- internal/web/web: start/stop Gateway client with server and reload dynamically on setting updates
- docs: update operations guide (en, ru) with scheduled reports, backups, commands, and privileged intents
- tests: add end-to-end WebSocket Gateway test verifying command handling

* style(discord): fix goimports formatting and add 3x-ui to gitignore

* fix(discord): stop gateway panics, reconnect storms and proxy bypass

The Gateway client wrote to its websocket from both the heartbeat ticker
and the read loop answering server-requested op 1 heartbeats. gorilla
panics on concurrent writes and neither goroutine recovers, so a colliding
heartbeat took the whole panel process down; writes now share writeMu.

It also reconnected every 5s forever after close codes Discord marks
non-reconnectable (4004 bad token, 4010-4014, including 4014 when Message
Content Intent is off), re-identifying and logging a warning each time.
The loop now stops on those codes; the docs say to restart the panel.

The gateway dialed with websocket.DefaultDialer, bypassing the panel
egress proxy the REST client already uses, so where Discord is filtered
notifications arrived but commands never connected.

* fix(discord): deliver the scheduled report when the backup upload fails

SendReport posted the report embed and the x-ui.db/config.json attachments
in one multipart request. Once the database outgrows Discord's upload cap
(20 MiB by default) the request is rejected and the report embed is lost
with it on every run, leaving only a log warning. Send the embed first and
the attachments as a second message.

* chore(discord): delete tests that pass whether or not the code works

TestDiscordNotifyJob_NilServiceNoPanic and TestHandleEvent_NilDiscordService
feed a nil DiscordService that web.go never passes, and
TestDiscordNotifyJob_DisabledNoPanic passes with or without the enable
guard because Xray is not running under test.

* fix(discord): require admin user IDs for bot commands and honor discordLang

Any member who could post in the configured channel could run !backup
(the whole x-ui.db and config.json, even with discordBotBackup off),
!restart and !usage. Commands now run only for the Discord user IDs in
the new discordAdminIds setting; an empty list turns commands off.

discordLang was saved and offered in the UI, but nothing read it, so
every embed stayed English. The test message, alerts, the scheduled
report and command replies now render through I18nForLang in the chosen
language, with a discord section in all 13 locales. InitLocalizer takes
an fs.FS so tests load the real translation files.

---------

Co-authored-by: Sanaei <ho3ein.sanaei@gmail.com>
This commit is contained in:
Egor
2026-09-13 17:04:53 +05:00
committed by GitHub
parent cba8f0672f
commit bf7ce2daaa
59 changed files with 6271 additions and 206 deletions
+100 -2
View File
@@ -1587,8 +1587,31 @@
"subHappGroupNetwork": "网络与 TUN 引擎",
"subHappGroupThemes": "界面与主题外观",
"subHappGroupFailover": "迁移与客户端管理",
"subHappGroupAndroid": "Android 分应用代理"
"subHappGroupAndroid": "Android 分应用代理",
"discordSettings": "Discord 机器人",
"discordBotEnable": "启用 Discord 通知",
"discordBotEnableDesc": "通过机器人向 Discord 频道发送系统和事件警报",
"discordBotToken": "Discord 机器人令牌",
"discordBotTokenDesc": "来自 Discord 开发者门户的机器人令牌",
"discordTokenConfigured": "令牌已配置。输入新令牌以替换。",
"discordTokenPlaceholder": "输入机器人令牌",
"discordChannelId": "频道 ID",
"discordChannelIdDesc": "接收通知的 Discord 频道 ID",
"discordAdminIds": "管理员用户 ID",
"discordAdminIdsDesc": "允许运行机器人命令的 Discord 用户 ID,以英文逗号分隔。其他人的消息会被忽略,列表为空时命令将被关闭。",
"discordEventBusNotify": "Discord 通知",
"testDiscord": "发送测试通知",
"testDiscordDesc": "发送测试通知以验证您的机器人令牌和频道 ID",
"discordNotInitialized": "Discord 服务未初始化",
"discordBotNotEnabled": "Discord 机器人未启用",
"discordTestFailed": "Discord 测试失败",
"discordTestSuccess": "测试通知发送成功",
"discordBotLanguage": "Discord 机器人语言",
"discordNotifyTime": "通知时间",
"discordNotifyTimeDesc": "Discord 机器人发送周期性报告的频率。选择预设间隔,或选择“自定义”以输入 crontab 表达式。",
"discordNotifyBackup": "数据库备份",
"discordNotifyBackupDesc": "发送带有报告的数据库备份文件",
"discordEventBusNotifyDesc": "选择触发 Discord 通知的事件"
},
"xray": {
"importRules": "导入规则",
@@ -2390,6 +2413,81 @@
"chooseInbound": "选择一个入站"
}
},
"discord": {
"test": {
"title": "3x-ui Discord 通知测试",
"body": "这是一条测试通知,确认 Discord 通知已正确配置。"
},
"footer": "3x-ui 面板",
"fields": {
"panelVersion": "面板版本",
"xrayCore": "Xray 核心",
"systemLoad": "系统负载",
"networkTraffic": "网络流量",
"totalUsed": "已用总量",
"quota": "配额",
"error": "错误",
"delay": "延迟",
"outbound": "出站",
"node": "节点",
"threshold": "阈值",
"reason": "原因",
"time": "时间",
"source": "来源"
},
"values": {
"uptime": "{{ .Days }}天 {{ .Hours }}小时",
"traffic": "↑{{ .Up }} ↓{{ .Down }}(总计:{{ .Total }})",
"counts": "总计:{{ .Total }} | 即将耗尽:{{ .Depleting }} | 已禁用:{{ .Disabled }}",
"inbound": "协议:`{{ .Protocol }}` | 端口:`{{ .Port }}` | 客户端:`{{ .Clients }}` | 流量:`↑{{ .Up }} ↓{{ .Down }}` | 状态:`{{ .State }}`"
},
"alerts": {
"outboundDown": "出站已断开",
"outboundUp": "出站已恢复",
"nodeDown": "节点已离线",
"nodeUp": "节点已恢复",
"xrayCrash": "Xray 核心崩溃",
"cpuHigh": "CPU 超出阈值",
"memoryHigh": "内存超出阈值",
"loginSuccess": "登录成功",
"loginFailed": "登录失败"
},
"report": {
"title": "📊 3x-ui 状态报告",
"summary": "**{{ .Host }}** 的服务器与代理定期状态报告",
"footer": "3x-ui 定时报告 • 计划:{{ .RunTime }}"
},
"commands": {
"helpTitle": "🤖 3x-ui Discord 机器人命令",
"helpDescription": "用于监控和管理 3x-ui 服务器的可用命令:",
"helpStatus": "显示系统负载、内存、CPU、连接数和在线用户",
"helpReport": "生成完整状态报告(如已配置则附带数据库备份)",
"helpBackup": "立即发送数据库备份文件",
"helpUsage": "查询客户端的流量使用、配额和到期时间",
"helpInbounds": "列出所有已配置的入站及其端口和客户端统计",
"helpRestart": "重启 Xray 核心",
"helpHelp": "显示此可用命令列表",
"statusTitle": "⚡ 3x-ui 服务器状态",
"statusDescription": "**{{ .Host }}** 的当前运行指标",
"backupTitle": "🗄️ 数据库备份",
"backupDescription": "3x-ui 备份生成于 `{{ .Time }}`",
"backupUnavailable": "❌ 备份服务不可用",
"backupFailed": "❌ 读取数据库备份失败:{{ .Error }}",
"usageHint": "⚠️ 用法:`!usage <email>` 或 `/usage <email>`",
"usageTitle": "👤 客户端用量:{{ .Email }}",
"usageDescription": "入站:**{{ .Remark }}**(端口 {{ .Port }})",
"clientNotFound": "⚠️ 在任何已配置的入站中均未找到客户端 `{{ .Email }}`。",
"inboundsUnavailable": "❌ 入站服务不可用",
"inboundsFailed": "❌ 加载入站失败:{{ .Error }}",
"inboundsTitle": "🔌 已配置的入站",
"inboundsDescription": "入站总数:**{{ .Count }}**",
"noInbounds": "ℹ️ 尚未配置任何入站。",
"xrayUnavailable": "❌ Xray 服务不可用",
"restarting": "🔄 正在重启 Xray 核心...",
"restartFailed": "❌ 重启 Xray 失败:{{ .Error }}",
"restartSuccess": "✅ Xray 核心已成功重启。"
}
},
"email": {
"labelStatus": "状态",
"labelOutbound": "出站",