Files
3x-ui/internal/web/service/xray_setting_routing_sync_test.go
T
nima1024m af3f460065 fix(routing): sync xray rules when panel inbound tags change or are deleted (#5367)
* fix(routing): sync xray rules when panel inbound tags change or are deleted

When an auto-generated inbound tag changes (e.g. port edit), propagate the
rename into xrayTemplateConfig routing rules and loopback outbounds. On
inbound delete, drop rules that only matched that tag and strip the tag from
rules that also match on domain, IP, or other fields.

Run the template update after the inbound DB transaction commits so SQLite
WAL reads see the stored xray settings reliably.

* fix(inbounds): return needRestart after deferred routing tag sync

Use a named needRestart return in UpdateInbound so the post-commit PropagateInboundTagRename defer can signal callers to restart Xray.

---------

Co-authored-by: Sanaei <ho3ein.sanaei@gmail.com>
2026-06-20 01:18:31 +02:00

303 lines
8.4 KiB
Go

package service
import (
"encoding/json"
"testing"
"github.com/mhsanaei/3x-ui/v3/internal/database"
"github.com/mhsanaei/3x-ui/v3/internal/database/model"
)
func seedXrayTemplate(t *testing.T, template string) {
t.Helper()
s := &SettingService{}
if err := s.saveSetting("xrayTemplateConfig", template); err != nil {
t.Fatalf("saveSetting: %v", err)
}
}
func routingRulesFromTemplate(t *testing.T, template string) []map[string]any {
t.Helper()
var cfg map[string]any
if err := json.Unmarshal([]byte(template), &cfg); err != nil {
t.Fatalf("unmarshal template: %v", err)
}
return routingRulesFromCfg(cfg)
}
func TestPropagateInboundTagRename_UpdatesRoutingRule(t *testing.T) {
setupSettingTestDB(t)
seedXrayTemplate(t, `{
"routing": {
"rules": [
{"type":"field","inboundTag":["in-21368-tcp"],"outboundTag":"direct"},
{"type":"field","inboundTag":["api"],"outboundTag":"api"}
]
},
"outbounds": [{"tag":"direct","protocol":"freedom"}]
}`)
svc := &XraySettingService{}
changed, err := svc.PropagateInboundTagRename("in-21368-tcp", "in-33000-tcp")
if err != nil {
t.Fatalf("PropagateInboundTagRename: %v", err)
}
if !changed {
t.Fatal("expected routing template to change")
}
got, err := svc.GetXrayConfigTemplate()
if err != nil {
t.Fatalf("GetXrayConfigTemplate: %v", err)
}
rules := routingRulesFromTemplate(t, got)
if len(rules) != 2 {
t.Fatalf("rules len = %d, want 2", len(rules))
}
if tags := readInboundTags(rules[1]["inboundTag"]); tags[0] != "in-33000-tcp" {
t.Fatalf("renamed rule inboundTag = %v, want [in-33000-tcp]", tags)
}
if tags := readInboundTags(rules[0]["inboundTag"]); tags[0] != "api" {
t.Fatalf("api rule should stay untouched, got %v", tags)
}
}
func TestPropagateInboundTagRename_UpdatesLoopbackOutbound(t *testing.T) {
setupSettingTestDB(t)
seedXrayTemplate(t, `{
"routing": {"rules": []},
"outbounds": [
{"tag":"loop","protocol":"loopback","settings":{"inboundTag":"in-21368-tcp"}}
]
}`)
svc := &XraySettingService{}
if _, err := svc.PropagateInboundTagRename("in-21368-tcp", "in-33000-tcp"); err != nil {
t.Fatalf("PropagateInboundTagRename: %v", err)
}
got, err := svc.GetXrayConfigTemplate()
if err != nil {
t.Fatalf("GetXrayConfigTemplate: %v", err)
}
var cfg map[string]any
if err := json.Unmarshal([]byte(got), &cfg); err != nil {
t.Fatalf("unmarshal: %v", err)
}
outbounds := outboundsFromCfg(cfg)
settings := outbounds[0].(map[string]any)["settings"].(map[string]any)
if settings["inboundTag"] != "in-33000-tcp" {
t.Fatalf("loopback inboundTag = %v, want in-33000-tcp", settings["inboundTag"])
}
}
func TestRemoveInboundTagReferences_DropsInboundOnlyRule(t *testing.T) {
setupSettingTestDB(t)
seedXrayTemplate(t, `{
"routing": {
"rules": [
{"type":"field","inboundTag":["in-21368-tcp"],"outboundTag":"direct"},
{"type":"field","inboundTag":["api"],"outboundTag":"api"}
]
}
}`)
svc := &XraySettingService{}
changed, err := svc.RemoveInboundTagReferences("in-21368-tcp")
if err != nil {
t.Fatalf("RemoveInboundTagReferences: %v", err)
}
if !changed {
t.Fatal("expected template to change")
}
got, err := svc.GetXrayConfigTemplate()
if err != nil {
t.Fatalf("GetXrayConfigTemplate: %v", err)
}
rules := routingRulesFromTemplate(t, got)
if len(rules) != 1 {
t.Fatalf("rules len = %d, want 1 (api rule only)", len(rules))
}
if tags := readInboundTags(rules[0]["inboundTag"]); tags[0] != "api" {
t.Fatalf("remaining rule = %v, want api rule", tags)
}
}
func TestRemoveInboundTagReferences_KeepsRuleWithOtherMatchers(t *testing.T) {
setupSettingTestDB(t)
seedXrayTemplate(t, `{
"routing": {
"rules": [
{"type":"field","inboundTag":["api"],"outboundTag":"api"},
{
"type":"field",
"inboundTag":["in-21368-tcp"],
"domain":["example.com"],
"outboundTag":"direct"
}
]
}
}`)
svc := &XraySettingService{}
if _, err := svc.RemoveInboundTagReferences("in-21368-tcp"); err != nil {
t.Fatalf("RemoveInboundTagReferences: %v", err)
}
got, err := svc.GetXrayConfigTemplate()
if err != nil {
t.Fatalf("GetXrayConfigTemplate: %v", err)
}
rule := findRuleByOutbound(t, got, "direct")
if _, ok := rule["inboundTag"]; ok {
t.Fatalf("inboundTag should be removed, rule = %#v", rule)
}
if domain, _ := rule["domain"].([]any); len(domain) != 1 {
t.Fatalf("domain matcher should remain, rule = %#v", rule)
}
}
func TestRemoveInboundTagReferences_RemovesOneTagFromMultiInboundRule(t *testing.T) {
setupSettingTestDB(t)
seedXrayTemplate(t, `{
"routing": {
"rules": [
{"type":"field","inboundTag":["api"],"outboundTag":"api"},
{
"type":"field",
"inboundTag":["in-21368-tcp","in-443-tcp"],
"outboundTag":"direct"
}
]
}
}`)
svc := &XraySettingService{}
if _, err := svc.RemoveInboundTagReferences("in-21368-tcp"); err != nil {
t.Fatalf("RemoveInboundTagReferences: %v", err)
}
got, err := svc.GetXrayConfigTemplate()
if err != nil {
t.Fatalf("GetXrayConfigTemplate: %v", err)
}
rule := findRuleByOutbound(t, got, "direct")
if tags := readInboundTags(rule["inboundTag"]); len(tags) != 1 || tags[0] != "in-443-tcp" {
t.Fatalf("inboundTag = %v, want [in-443-tcp]", tags)
}
}
func findRuleByOutbound(t *testing.T, template, outbound string) map[string]any {
t.Helper()
for _, rule := range routingRulesFromTemplate(t, template) {
if rule["outboundTag"] == outbound {
return rule
}
}
t.Fatalf("no rule with outboundTag %q in %s", outbound, template)
return nil
}
func TestPropagateInboundTagRename_WorksWithConflictDB(t *testing.T) {
setupConflictDB(t)
seedXrayTemplate(t, `{
"routing": {
"rules": [
{"type":"field","inboundTag":["in-22435-tcp"],"outboundTag":"direct"}
]
},
"outbounds": [{"tag":"direct","protocol":"freedom"}]
}`)
svc := &XraySettingService{}
changed, err := svc.PropagateInboundTagRename("in-22435-tcp", "in-33000-tcp")
if err != nil {
t.Fatalf("PropagateInboundTagRename: %v", err)
}
if !changed {
t.Fatal("expected template to change")
}
}
func TestUpdateInbound_PropagatesRoutingRuleOnPortChange(t *testing.T) {
setupConflictDB(t)
seedXrayTemplate(t, `{
"routing": {
"rules": [
{"type":"field","inboundTag":["api"],"outboundTag":"api"},
{"type":"field","inboundTag":["in-22435-tcp"],"outboundTag":"direct"}
]
},
"outbounds": [{"tag":"direct","protocol":"freedom"}]
}`)
seedInboundConflict(t, "in-22435-tcp", "0.0.0.0", 22435, model.VLESS, `{"network":"tcp"}`, `{"clients":[]}`)
var existing model.Inbound
if err := database.GetDB().Where("tag = ?", "in-22435-tcp").First(&existing).Error; err != nil {
t.Fatalf("read seeded row: %v", err)
}
svc := &InboundService{}
update := existing
update.Port = 33000
update.Tag = "in-22435-tcp"
got, needRestart, err := svc.UpdateInbound(&update)
if err != nil {
t.Fatalf("UpdateInbound: %v", err)
}
if got.Tag != "in-33000-tcp" {
t.Fatalf("returned tag = %q, want in-33000-tcp", got.Tag)
}
if !needRestart {
t.Fatal("expected needRestart after routing template sync on tag rename")
}
xraySvc := &XraySettingService{}
template, err := xraySvc.GetXrayConfigTemplate()
if err != nil {
t.Fatalf("GetXrayConfigTemplate: %v", err)
}
rule := findRuleByOutbound(t, template, "direct")
if tags := readInboundTags(rule["inboundTag"]); tags[0] != "in-33000-tcp" {
t.Fatalf("routing inboundTag = %v, want [in-33000-tcp]", tags)
}
}
func TestDelInbound_RemovesInboundOnlyRoutingRule(t *testing.T) {
setupConflictDB(t)
seedXrayTemplate(t, `{
"routing": {
"rules": [
{"type":"field","inboundTag":["api"],"outboundTag":"api"},
{"type":"field","inboundTag":["in-22435-tcp"],"outboundTag":"direct"},
{"type":"field","inboundTag":["in-443-tcp"],"outboundTag":"blocked"}
]
}
}`)
seedInboundConflict(t, "in-22435-tcp", "0.0.0.0", 22435, model.VLESS, `{"network":"tcp"}`, `{"clients":[]}`)
var existing model.Inbound
if err := database.GetDB().Where("tag = ?", "in-22435-tcp").First(&existing).Error; err != nil {
t.Fatalf("read seeded row: %v", err)
}
svc := &InboundService{}
if _, err := svc.DelInbound(existing.Id); err != nil {
t.Fatalf("DelInbound: %v", err)
}
xraySvc := &XraySettingService{}
template, err := xraySvc.GetXrayConfigTemplate()
if err != nil {
t.Fatalf("GetXrayConfigTemplate: %v", err)
}
rules := routingRulesFromTemplate(t, template)
for _, rule := range rules {
if rule["outboundTag"] == "direct" {
t.Fatalf("direct rule should be removed, got %#v", rule)
}
}
findRuleByOutbound(t, template, "blocked")
}