Files
3x-ui/internal/database/db_seed_test.go
T
ilyusha f9898e0b24 fix(sub): randomize fresh panel subscription paths (#6375)
* fix(sub): randomize fresh panel subscription paths

Seed distinct cryptographically random paths for base64, JSON, and Clash subscriptions when a panel database is first created. Persist them so restarts keep published URLs stable while upgrades preserve existing settings.

Generated-by: OpenCode:gpt-5.6-sol

* fix(sub): regenerate paths on settings reset

Keep subscription paths unpredictable after a factory reset, close the test database on failure, and update the builder, OpenAPI, and localized docs to describe panel-specific paths instead of obsolete fixed defaults.

Generated-by: OpenCode:gpt-5.6-sol
2026-09-03 16:34:37 +02:00

248 lines
7.1 KiB
Go

package database
import (
"encoding/json"
"path/filepath"
"regexp"
"testing"
"github.com/mhsanaei/3x-ui/v3/internal/database/model"
)
func TestInitDB_GeneratesPerPanelSubscriptionPaths(t *testing.T) {
pathPattern := regexp.MustCompile(`^/[0-9a-z]{16}/$`)
loadPaths := func(dbPath string) map[string]string {
t.Helper()
if err := InitDB(dbPath); err != nil {
t.Fatalf("InitDB failed: %v", err)
}
defer func() {
if err := CloseDB(); err != nil {
t.Errorf("CloseDB failed: %v", err)
}
}()
keys := []string{"subPath", "subJsonPath", "subClashPath"}
paths := make(map[string]string, len(keys))
for _, key := range keys {
var setting model.Setting
if err := db.Where("key = ?", key).First(&setting).Error; err != nil {
t.Fatalf("read %s: %v", key, err)
}
if !pathPattern.MatchString(setting.Value) {
t.Fatalf("%s = %q, want /<16 lowercase alphanumeric characters>/", key, setting.Value)
}
paths[key] = setting.Value
}
if paths["subPath"] == paths["subJsonPath"] || paths["subPath"] == paths["subClashPath"] || paths["subJsonPath"] == paths["subClashPath"] {
t.Fatalf("subscription paths must be distinct: %v", paths)
}
return paths
}
firstDB := filepath.Join(t.TempDir(), "x-ui.db")
first := loadPaths(firstDB)
reloaded := loadPaths(firstDB)
for key, firstPath := range first {
if firstPath != reloaded[key] {
t.Fatalf("%s changed after restart: %q, then %q", key, firstPath, reloaded[key])
}
}
second := loadPaths(filepath.Join(t.TempDir(), "x-ui.db"))
for key, firstPath := range first {
if firstPath == second[key] {
t.Fatalf("%s reused across panels: %q", key, firstPath)
}
}
}
func TestSeedClientsFromInboundJSON_IsIdempotentAgainstExistingClients(t *testing.T) {
dbDir := t.TempDir()
t.Setenv("XUI_DB_FOLDER", dbDir)
if err := InitDB(filepath.Join(dbDir, "x-ui.db")); err != nil {
t.Fatalf("InitDB failed: %v", err)
}
t.Cleanup(func() { _ = CloseDB() })
settings, err := json.Marshal(map[string]any{
"clients": []any{
map[string]any{
"id": "ce8d33df-3a64-4f10-8f9b-91c3a8e0c001",
"email": "alice@example.com",
"enable": true,
"flow": "",
"subId": "alice-sub",
"comment": "from-inbound-json",
},
},
})
if err != nil {
t.Fatalf("marshal settings: %v", err)
}
inbound := model.Inbound{
UserId: 1,
Port: 12345,
Protocol: model.VLESS,
Settings: string(settings),
Tag: "test-inbound",
}
if err := db.Create(&inbound).Error; err != nil {
t.Fatalf("seed inbound: %v", err)
}
preExisting := &model.ClientRecord{
Email: "alice@example.com",
UUID: "ce8d33df-3a64-4f10-8f9b-91c3a8e0c001",
SubID: "alice-sub",
Enable: true,
Comment: "added-via-api",
}
if err := db.Create(preExisting).Error; err != nil {
t.Fatalf("seed client row: %v", err)
}
if err := db.Where("seeder_name = ?", "ClientsTable").Delete(&model.HistoryOfSeeders{}).Error; err != nil {
t.Fatalf("clear ClientsTable history: %v", err)
}
if err := seedClientsFromInboundJSON(); err != nil {
t.Fatalf("seedClientsFromInboundJSON should be idempotent against existing rows, got: %v", err)
}
var count int64
if err := db.Model(&model.ClientRecord{}).Where("email = ?", "alice@example.com").Count(&count).Error; err != nil {
t.Fatalf("count clients: %v", err)
}
if count != 1 {
t.Fatalf("alice@example.com should resolve to exactly one row, got %d", count)
}
}
func TestNormalizeInboundClientSubId_FillsMissingAndPreservesExisting(t *testing.T) {
dbDir := t.TempDir()
t.Setenv("XUI_DB_FOLDER", dbDir)
if err := InitDB(filepath.Join(dbDir, "x-ui.db")); err != nil {
t.Fatalf("InitDB failed: %v", err)
}
t.Cleanup(func() { _ = CloseDB() })
settings, err := json.Marshal(map[string]any{
"clients": []any{
map[string]any{
"id": "00000000-0000-0000-0000-000000000001",
"email": "missing-sub@example.com",
"subId": "",
},
map[string]any{
"id": "00000000-0000-0000-0000-000000000002",
"email": "no-sub-key@example.com",
},
map[string]any{
"id": "00000000-0000-0000-0000-000000000003",
"email": "has-sub@example.com",
"subId": "keep-me-1234",
},
},
})
if err != nil {
t.Fatalf("marshal settings: %v", err)
}
inbound := model.Inbound{
UserId: 1,
Port: 23456,
Protocol: model.VLESS,
Settings: string(settings),
Tag: "subid-fix-inbound",
}
if err := db.Create(&inbound).Error; err != nil {
t.Fatalf("seed inbound: %v", err)
}
if err := db.Where("seeder_name = ?", "InboundClientSubIdFix").Delete(&model.HistoryOfSeeders{}).Error; err != nil {
t.Fatalf("clear seeder history: %v", err)
}
if err := normalizeInboundClientSubId(); err != nil {
t.Fatalf("normalizeInboundClientSubId: %v", err)
}
var reloaded model.Inbound
if err := db.First(&reloaded, inbound.Id).Error; err != nil {
t.Fatalf("reload inbound: %v", err)
}
var parsed map[string]any
if err := json.Unmarshal([]byte(reloaded.Settings), &parsed); err != nil {
t.Fatalf("unmarshal settings: %v", err)
}
clients, ok := parsed["clients"].([]any)
if !ok || len(clients) != 3 {
t.Fatalf("expected 3 clients, got %v", parsed["clients"])
}
subIdPattern := regexp.MustCompile(`^[0-9a-z]{16}$`)
for i := range 2 {
obj := clients[i].(map[string]any)
sub, _ := obj["subId"].(string)
if !subIdPattern.MatchString(sub) {
t.Fatalf("client %d: expected 16-char [0-9a-z] subId, got %q", i, sub)
}
}
preserved := clients[2].(map[string]any)["subId"].(string)
if preserved != "keep-me-1234" {
t.Fatalf("expected existing subId preserved, got %q", preserved)
}
var historyCount int64
if err := db.Model(&model.HistoryOfSeeders{}).Where("seeder_name = ?", "InboundClientSubIdFix").Count(&historyCount).Error; err != nil {
t.Fatalf("count seeder history: %v", err)
}
if historyCount != 1 {
t.Fatalf("expected one InboundClientSubIdFix history row, got %d", historyCount)
}
}
func TestNormalizeSettingPaths_RepairsLegacyValues(t *testing.T) {
dbDir := t.TempDir()
t.Setenv("XUI_DB_FOLDER", dbDir)
if err := InitDB(filepath.Join(dbDir, "x-ui.db")); err != nil {
t.Fatalf("InitDB failed: %v", err)
}
t.Cleanup(func() { _ = CloseDB() })
seed := []model.Setting{
{Key: "subJsonPath", Value: "YIrCXJOOOL"},
{Key: "subPath", Value: "/sub"},
{Key: "subClashPath", Value: "clash/"},
{Key: "webBasePath", Value: "/panel/"},
}
if err := db.Where("key IN ?", []string{"subPath", "subJsonPath", "subClashPath"}).Delete(&model.Setting{}).Error; err != nil {
t.Fatalf("clear generated subscription paths: %v", err)
}
for i := range seed {
if err := db.Create(&seed[i]).Error; err != nil {
t.Fatalf("seed setting %s: %v", seed[i].Key, err)
}
}
if err := normalizeSettingPaths(); err != nil {
t.Fatalf("normalizeSettingPaths: %v", err)
}
want := map[string]string{
"subJsonPath": "/YIrCXJOOOL/",
"subPath": "/sub/",
"subClashPath": "/clash/",
"webBasePath": "/panel/",
}
for key, expected := range want {
var row model.Setting
if err := db.Where("key = ?", key).First(&row).Error; err != nil {
t.Fatalf("read %s: %v", key, err)
}
if row.Value != expected {
t.Errorf("%s = %q, want %q", key, row.Value, expected)
}
}
}