mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-09-14 18:32:15 +03:00
* 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>
250 lines
8.0 KiB
Go
250 lines
8.0 KiB
Go
package controller
|
|
|
|
import (
|
|
"encoding/json"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"path/filepath"
|
|
"strconv"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
|
|
"github.com/mhsanaei/3x-ui/v3/internal/database"
|
|
"github.com/mhsanaei/3x-ui/v3/internal/database/model"
|
|
"github.com/mhsanaei/3x-ui/v3/internal/util/crypto"
|
|
"github.com/mhsanaei/3x-ui/v3/internal/web/locale"
|
|
"github.com/mhsanaei/3x-ui/v3/internal/web/service"
|
|
"github.com/mhsanaei/3x-ui/v3/internal/web/service/discord"
|
|
)
|
|
|
|
func TestValidateRegex(t *testing.T) {
|
|
gin.SetMode(gin.TestMode)
|
|
router := gin.New()
|
|
NewSettingController(router.Group("/panel/api"))
|
|
|
|
tests := []struct {
|
|
name string
|
|
body string
|
|
success bool
|
|
}{
|
|
{name: "Go RE2 inline flag", body: `{"regex":"(?m)^general-purpose$"}`, success: true},
|
|
{name: "invalid expression", body: `{"regex":"["}`, success: false},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
req := httptest.NewRequest(http.MethodPost, "/panel/api/setting/validateRegex", strings.NewReader(tt.body))
|
|
req.Header.Set("Content-Type", "application/json")
|
|
resp := httptest.NewRecorder()
|
|
|
|
router.ServeHTTP(resp, req)
|
|
|
|
if resp.Code != http.StatusOK {
|
|
t.Fatalf("status = %d, want 200; body=%s", resp.Code, resp.Body.String())
|
|
}
|
|
needle := `"success":true`
|
|
if !tt.success {
|
|
needle = `"success":false`
|
|
}
|
|
if !strings.Contains(resp.Body.String(), needle) {
|
|
t.Fatalf("body = %s, want %s", resp.Body.String(), needle)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestAPITokenMutationRoutesEnforceExpectedScope(t *testing.T) {
|
|
t.Setenv("XUI_DB_FOLDER", t.TempDir())
|
|
if err := database.InitDB(filepath.Join(t.TempDir(), "x-ui.db")); err != nil {
|
|
t.Fatalf("InitDB: %v", err)
|
|
}
|
|
t.Cleanup(func() { _ = database.CloseDB() })
|
|
row := &model.ApiToken{Name: "route-scope", Token: crypto.HashTokenSHA256("token"), Enabled: true, Scope: model.ApiScopeNodeSync}
|
|
if err := database.GetDB().Create(row).Error; err != nil {
|
|
t.Fatalf("seed token: %v", err)
|
|
}
|
|
|
|
gin.SetMode(gin.TestMode)
|
|
router := gin.New()
|
|
NewSettingController(router.Group("/panel/api"))
|
|
for _, path := range []string{
|
|
"/panel/api/setting/apiTokens/delete/" + strconv.Itoa(row.Id),
|
|
"/panel/api/setting/apiTokens/setEnabled/" + strconv.Itoa(row.Id),
|
|
} {
|
|
body := `{"expectedScope":"admin","enabled":false}`
|
|
req := httptest.NewRequest(http.MethodPost, path, strings.NewReader(body))
|
|
req.Header.Set("Content-Type", "application/json")
|
|
resp := httptest.NewRecorder()
|
|
router.ServeHTTP(resp, req)
|
|
if !strings.Contains(resp.Body.String(), `"success":false`) {
|
|
t.Fatalf("%s accepted wrong expected scope: %s", path, resp.Body.String())
|
|
}
|
|
}
|
|
var stored model.ApiToken
|
|
if err := database.GetDB().First(&stored, row.Id).Error; err != nil {
|
|
t.Fatalf("token was deleted by wrong scope: %v", err)
|
|
}
|
|
if !stored.Enabled {
|
|
t.Fatal("token was disabled by wrong scope")
|
|
}
|
|
}
|
|
|
|
// GHSA-xqqw-jqqv-99h6: a save that keeps 2FA enabled must not be able to
|
|
// rebind the authenticator without presenting a current code.
|
|
func TestUpdateSettingRequiresCodeToReplaceTwoFactorToken(t *testing.T) {
|
|
t.Setenv("XUI_DB_FOLDER", t.TempDir())
|
|
if err := database.InitDB(filepath.Join(t.TempDir(), "x-ui.db")); err != nil {
|
|
t.Fatalf("InitDB: %v", err)
|
|
}
|
|
t.Cleanup(func() { _ = database.CloseDB() })
|
|
|
|
settingService := service.SettingService{}
|
|
if err := settingService.SetTwoFactorToken("ORIGINALSECRET234567"); err != nil {
|
|
t.Fatalf("seed token: %v", err)
|
|
}
|
|
if err := settingService.SetTwoFactorEnable(true); err != nil {
|
|
t.Fatalf("seed enable: %v", err)
|
|
}
|
|
|
|
post := func(t *testing.T, mutate func(map[string]any)) string {
|
|
t.Helper()
|
|
base, err := settingService.GetAllSetting()
|
|
if err != nil {
|
|
t.Fatalf("GetAllSetting: %v", err)
|
|
}
|
|
raw, err := json.Marshal(base)
|
|
if err != nil {
|
|
t.Fatalf("marshal: %v", err)
|
|
}
|
|
body := map[string]any{}
|
|
if err := json.Unmarshal(raw, &body); err != nil {
|
|
t.Fatalf("unmarshal: %v", err)
|
|
}
|
|
mutate(body)
|
|
payload, err := json.Marshal(body)
|
|
if err != nil {
|
|
t.Fatalf("marshal payload: %v", err)
|
|
}
|
|
|
|
gin.SetMode(gin.TestMode)
|
|
router := gin.New()
|
|
NewSettingController(router.Group("/panel/api"))
|
|
req := httptest.NewRequest(http.MethodPost, "/panel/api/setting/update", strings.NewReader(string(payload)))
|
|
req.Header.Set("Content-Type", "application/json")
|
|
resp := httptest.NewRecorder()
|
|
router.ServeHTTP(resp, req)
|
|
return resp.Body.String()
|
|
}
|
|
|
|
t.Run("rebind without code is rejected", func(t *testing.T) {
|
|
got := post(t, func(body map[string]any) {
|
|
body["twoFactorEnable"] = true
|
|
body["twoFactorToken"] = "ATTACKERSECRET567890"
|
|
})
|
|
if !strings.Contains(got, `"success":false`) {
|
|
t.Fatalf("rebind without a 2FA code was accepted: %s", got)
|
|
}
|
|
stored, err := settingService.GetTwoFactorToken()
|
|
if err != nil {
|
|
t.Fatalf("GetTwoFactorToken: %v", err)
|
|
}
|
|
if stored != "ORIGINALSECRET234567" {
|
|
t.Fatalf("stored 2FA secret = %q, want it unchanged", stored)
|
|
}
|
|
})
|
|
|
|
t.Run("ordinary save with redacted token still succeeds", func(t *testing.T) {
|
|
got := post(t, func(body map[string]any) {
|
|
body["twoFactorEnable"] = true
|
|
body["twoFactorToken"] = ""
|
|
})
|
|
if !strings.Contains(got, `"success":true`) {
|
|
t.Fatalf("normal settings save was rejected: %s", got)
|
|
}
|
|
stored, err := settingService.GetTwoFactorToken()
|
|
if err != nil {
|
|
t.Fatalf("GetTwoFactorToken: %v", err)
|
|
}
|
|
if stored != "ORIGINALSECRET234567" {
|
|
t.Fatalf("stored 2FA secret = %q, want it preserved", stored)
|
|
}
|
|
})
|
|
}
|
|
|
|
func TestTestDiscordEndpoint(t *testing.T) {
|
|
gin.SetMode(gin.TestMode)
|
|
|
|
// 1. Service not initialized
|
|
SetDiscordService(nil)
|
|
router := gin.New()
|
|
router.Use(func(c *gin.Context) {
|
|
c.Set("I18n", func(_ locale.I18nType, key string, _ ...string) string { return key })
|
|
c.Next()
|
|
})
|
|
NewSettingController(router.Group("/panel/api"))
|
|
|
|
req := httptest.NewRequest(http.MethodPost, "/panel/api/setting/testDiscord", nil)
|
|
resp := httptest.NewRecorder()
|
|
router.ServeHTTP(resp, req)
|
|
|
|
if !strings.Contains(resp.Body.String(), `"success":false`) || !strings.Contains(resp.Body.String(), "pages.settings.discordNotInitialized") {
|
|
t.Fatalf("expected uninitialized error, got %s", resp.Body.String())
|
|
}
|
|
|
|
// Setup DB
|
|
t.Setenv("XUI_DB_FOLDER", t.TempDir())
|
|
if err := database.InitDB(filepath.Join(t.TempDir(), "x-ui.db")); err != nil {
|
|
t.Fatalf("InitDB: %v", err)
|
|
}
|
|
t.Cleanup(func() {
|
|
_ = database.CloseDB()
|
|
SetDiscordService(nil)
|
|
})
|
|
|
|
settingService := service.SettingService{}
|
|
svc := discord.NewDiscordService(settingService)
|
|
SetDiscordService(svc)
|
|
|
|
// 2. Discord bot disabled
|
|
_ = settingService.SetDiscordBotEnable(false)
|
|
req = httptest.NewRequest(http.MethodPost, "/panel/api/setting/testDiscord", nil)
|
|
resp = httptest.NewRecorder()
|
|
router.ServeHTTP(resp, req)
|
|
|
|
if !strings.Contains(resp.Body.String(), `"success":false`) || !strings.Contains(resp.Body.String(), "pages.settings.discordBotNotEnabled") {
|
|
t.Fatalf("expected disabled error, got %s", resp.Body.String())
|
|
}
|
|
|
|
// 3. Discord bot enabled but missing config
|
|
_ = settingService.SetDiscordBotEnable(true)
|
|
req = httptest.NewRequest(http.MethodPost, "/panel/api/setting/testDiscord", nil)
|
|
resp = httptest.NewRecorder()
|
|
router.ServeHTTP(resp, req)
|
|
|
|
if !strings.Contains(resp.Body.String(), `"success":false`) || !strings.Contains(resp.Body.String(), "pages.settings.discordTestFailed") {
|
|
t.Fatalf("expected send failure error, got %s", resp.Body.String())
|
|
}
|
|
|
|
// 4. Discord bot enabled with working server
|
|
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte(`{"id": "msg-1"}`))
|
|
}))
|
|
defer server.Close()
|
|
|
|
_ = settingService.SetDiscordBotToken("test-bot-token")
|
|
_ = settingService.SetDiscordChannelId("123456789")
|
|
svc.SetBaseURL(server.URL)
|
|
svc.SetHTTPClient(server.Client())
|
|
|
|
req = httptest.NewRequest(http.MethodPost, "/panel/api/setting/testDiscord", nil)
|
|
resp = httptest.NewRecorder()
|
|
router.ServeHTTP(resp, req)
|
|
|
|
if !strings.Contains(resp.Body.String(), `"success":true`) || !strings.Contains(resp.Body.String(), "pages.settings.discordTestSuccess") {
|
|
t.Fatalf("expected success, got %s", resp.Body.String())
|
|
}
|
|
}
|