mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-09-17 15:47:14 +00:00
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
@@ -1705,8 +1705,31 @@
|
||||
"subHappGroupNetwork": "Network & TUN Engine",
|
||||
"subHappGroupThemes": "Appearance & Theme",
|
||||
"subHappGroupFailover": "Migration & App Management",
|
||||
"subHappGroupAndroid": "Android Per-App Proxy"
|
||||
|
||||
"subHappGroupAndroid": "Android Per-App Proxy",
|
||||
"discordSettings": "Discord Bot",
|
||||
"discordBotEnable": "Enable Discord Notifications",
|
||||
"discordBotEnableDesc": "Send system and event alerts to a Discord channel via bot",
|
||||
"discordBotToken": "Discord Bot Token",
|
||||
"discordBotTokenDesc": "Bot token from the Discord Developer Portal",
|
||||
"discordTokenConfigured": "Token is configured. Enter a new token to replace it.",
|
||||
"discordTokenPlaceholder": "Enter bot token",
|
||||
"discordChannelId": "Channel ID",
|
||||
"discordChannelIdDesc": "The Discord channel ID where notifications will be sent",
|
||||
"discordAdminIds": "Admin User IDs",
|
||||
"discordAdminIdsDesc": "Comma-separated Discord user IDs allowed to run bot commands. Messages from anyone else are ignored, and an empty list turns commands off.",
|
||||
"discordEventBusNotify": "Discord Notifications",
|
||||
"testDiscord": "Send Test Notification",
|
||||
"testDiscordDesc": "Send a test notification to verify your bot token and channel ID",
|
||||
"discordNotInitialized": "Discord service not initialized",
|
||||
"discordBotNotEnabled": "Discord bot is not enabled",
|
||||
"discordTestFailed": "Discord test failed",
|
||||
"discordTestSuccess": "Test notification sent successfully",
|
||||
"discordBotLanguage": "Discord Bot Language",
|
||||
"discordNotifyTime": "Notification Time",
|
||||
"discordNotifyTimeDesc": "How often the Discord bot sends periodic reports. Pick a preset interval, or choose Custom to enter a raw crontab expression.",
|
||||
"discordNotifyBackup": "Database Backup",
|
||||
"discordNotifyBackupDesc": "Send a database backup file with a report.",
|
||||
"discordEventBusNotifyDesc": "Select which events trigger Discord notifications"
|
||||
},
|
||||
"xray": {
|
||||
"save": "Save",
|
||||
@@ -2390,6 +2413,81 @@
|
||||
"chooseInbound": "Choose an Inbound"
|
||||
}
|
||||
},
|
||||
"discord": {
|
||||
"test": {
|
||||
"title": "3x-ui Discord Notification Test",
|
||||
"body": "This is a test notification confirming that Discord notifications are configured correctly."
|
||||
},
|
||||
"footer": "3x-ui Panel",
|
||||
"fields": {
|
||||
"panelVersion": "Panel Version",
|
||||
"xrayCore": "Xray Core",
|
||||
"systemLoad": "System Load",
|
||||
"networkTraffic": "Network Traffic",
|
||||
"totalUsed": "Total Used",
|
||||
"quota": "Quota",
|
||||
"error": "Error",
|
||||
"delay": "Delay",
|
||||
"outbound": "Outbound",
|
||||
"node": "Node",
|
||||
"threshold": "Threshold",
|
||||
"reason": "Reason",
|
||||
"time": "Time",
|
||||
"source": "Source"
|
||||
},
|
||||
"values": {
|
||||
"uptime": "{{ .Days }}d {{ .Hours }}h",
|
||||
"traffic": "↑{{ .Up }} ↓{{ .Down }} (Total: {{ .Total }})",
|
||||
"counts": "Total: {{ .Total }} | Depleting: {{ .Depleting }} | Disabled: {{ .Disabled }}",
|
||||
"inbound": "Protocol: `{{ .Protocol }}` | Port: `{{ .Port }}` | Clients: `{{ .Clients }}` | Traffic: `↑{{ .Up }} ↓{{ .Down }}` | State: `{{ .State }}`"
|
||||
},
|
||||
"alerts": {
|
||||
"outboundDown": "Outbound Down",
|
||||
"outboundUp": "Outbound Up",
|
||||
"nodeDown": "Node Down",
|
||||
"nodeUp": "Node Up",
|
||||
"xrayCrash": "Xray Core Crashed",
|
||||
"cpuHigh": "CPU Threshold Exceeded",
|
||||
"memoryHigh": "Memory Threshold Exceeded",
|
||||
"loginSuccess": "Login Success",
|
||||
"loginFailed": "Login Failed"
|
||||
},
|
||||
"report": {
|
||||
"title": "📊 3x-ui Status Report",
|
||||
"summary": "Periodic server and proxy status report for **{{ .Host }}**",
|
||||
"footer": "3x-ui Scheduled Report • Schedule: {{ .RunTime }}"
|
||||
},
|
||||
"commands": {
|
||||
"helpTitle": "🤖 3x-ui Discord Bot Commands",
|
||||
"helpDescription": "Available commands for monitoring and managing the 3x-ui server:",
|
||||
"helpStatus": "Display system load, RAM, CPU, connections, and online users",
|
||||
"helpReport": "Generate a full status report (with DB backup if configured)",
|
||||
"helpBackup": "Send the database backup file immediately",
|
||||
"helpUsage": "Query traffic usage, quota, and expiry for a client",
|
||||
"helpInbounds": "List all configured inbounds with ports and client stats",
|
||||
"helpRestart": "Restart the Xray core",
|
||||
"helpHelp": "Display this list of available commands",
|
||||
"statusTitle": "⚡ 3x-ui Server Status",
|
||||
"statusDescription": "Current operational metrics for **{{ .Host }}**",
|
||||
"backupTitle": "🗄️ Database Backup",
|
||||
"backupDescription": "Backup archive for 3x-ui generated at `{{ .Time }}`",
|
||||
"backupUnavailable": "❌ Backup service unavailable",
|
||||
"backupFailed": "❌ Failed to read database backup: {{ .Error }}",
|
||||
"usageHint": "⚠️ Usage: `!usage <email>` or `/usage <email>`",
|
||||
"usageTitle": "👤 Client Usage: {{ .Email }}",
|
||||
"usageDescription": "Inbound: **{{ .Remark }}** (Port {{ .Port }})",
|
||||
"clientNotFound": "⚠️ Client `{{ .Email }}` was not found in any configured inbound.",
|
||||
"inboundsUnavailable": "❌ Inbound service unavailable",
|
||||
"inboundsFailed": "❌ Failed to load inbounds: {{ .Error }}",
|
||||
"inboundsTitle": "🔌 Configured Inbounds",
|
||||
"inboundsDescription": "Total inbounds: **{{ .Count }}**",
|
||||
"noInbounds": "ℹ️ No inbounds configured.",
|
||||
"xrayUnavailable": "❌ Xray service unavailable",
|
||||
"restarting": "🔄 Restarting Xray core...",
|
||||
"restartFailed": "❌ Failed to restart Xray: {{ .Error }}",
|
||||
"restartSuccess": "✅ Xray core restarted successfully."
|
||||
}
|
||||
},
|
||||
"email": {
|
||||
"labelStatus": "Status",
|
||||
"labelOutbound": "Outbound",
|
||||
|
||||
Reference in New Issue
Block a user