mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-09-03 08:57:15 +00:00
feat(sub): leastLoad member weights for subscription balancers (#6304)
* feat(model): add MemberWeights to SubBalancer Per-inbound leastLoad weights, stored with the same gorm json serializer as InboundIds so AutoMigrate adds the text column on every dialect (postgresModelSettled sees the missing column and re-runs). Absent entries mean weight 1.0; only meaningful for strategy leastLoad. * feat(sub): accept memberWeights on the sub-balancer API Parsed as one JSON form field (gin cannot bind bracket-keyed maps from urlencoded bodies). validate() rejects weights under any strategy but leastLoad — xray would silently ignore costs there, so storing them would pretend a knob exists. Non-positive weights error instead of defaulting: a zero usually means a typo'd "never pick this node". Entries for inbounds no longer selected are dropped on save. * feat(sub): emit leastLoad strategy costs from member weights costs[] is built after the tagging loop reuses the exact retagged tags (bal-N-protocol[-k]) and each member's owning inbound id. Members without a configured weight default to 1.0, but costs are omitted entirely unless at least one explicit weight survives — an all-1.0 array would bloat every subscription response for no effect. * feat(sub-balancers): leastLoad member weight inputs Weight fields render only under leastLoad and hide on strategy change without dropping their values, so an accidental toggle away and back loses nothing until save; non-leastLoad submits strip them entirely because xray would ignore costs. Weights travel as one JSON form field (gin cannot bind bracket-keyed maps) and every locale gets the three new keys in the same commit per the dead-keys rule. * docs(api): document memberWeights on sub-balancers leastLoad-only JSON form field; update notes that omitting it clears stored weights. Regenerated openapi artifacts via make gen + the docs copy/gen:api step nothing checks automatically. * fix(api-docs): use the allowed object ParamType for memberWeights * fix(sub-balancers): cap the member-weight list height Many selected inbounds pushed the modal body past the viewport. The weight rows now scroll inside a 220px viewport, mirroring the inbound picker's listHeight so both lists read the same. * fix(sub): anchor leastLoad cost matches to exact member tags Verified against xray-core: without regexp, WeightManager matches costs by substring (strings.Index), so the bare tag "bal-1-vless" also hits the deduplicated "bal-1-vless-2" and both members get the first entry's weight. Anchored ^tag$ regexps make every cost entry match only its own member. Also confirmed value<=0 makes xray derive a weight from the first digit of the matched tag — validating weights > 0 server-side was the right call. * fix(sub-balancers): keep member weights across the enabled toggle The table's toggleEnabled re-posted a full-row payload without memberWeights, and the update path treats an absent key as "erase" — flipping the switch silently dropped every configured weight. Round-trip the stored weights through the toggle payload, and prove persistence with a re-Get in the weight-validation test (the returned struct alone would stay green even if Save skipped the column). * fix(sub-balancers): address review on member weights - omitempty on MemberWeights: the panel sends null for every pre-existing and non-leastLoad balancer, which failed the hand-written zod response schema on every fetch (zod .optional() accepts undefined only; switched to .nullish() per repo convention) and drifted the generated contract. Regenerated openapi artifacts + docs copy + MDX. - Bound weights to the positive float32 range: xray decodes costs as float32, so an over-range value makes clients reject the whole subscription document and an underflow decays to the tag-digit fallback weight. Tests for both directions. - Trim six comment blocks to the 2-line cap from CLAUDE.md. --------- Co-authored-by: DIMFLIX <dimflix@users.noreply.github.com>
This commit is contained in:
@@ -1,6 +1,8 @@
|
||||
package service
|
||||
|
||||
import (
|
||||
"math"
|
||||
"slices"
|
||||
"strings"
|
||||
|
||||
"github.com/mhsanaei/3x-ui/v3/internal/database"
|
||||
@@ -36,12 +38,44 @@ func (s *SubBalancerService) validate(b *model.SubBalancer) error {
|
||||
if len(b.InboundIds) == 0 {
|
||||
return common.NewError("balancer must select at least one inbound")
|
||||
}
|
||||
if err := s.validateWeights(b); err != nil {
|
||||
return err
|
||||
}
|
||||
if b.SortOrder < 1 {
|
||||
b.SortOrder = 1
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// validateWeights rejects weights xray cannot honor (non-positive, outside
|
||||
// float32 range, non-leastLoad strategy) and drops stray inbound ids.
|
||||
func (s *SubBalancerService) validateWeights(b *model.SubBalancer) error {
|
||||
if len(b.MemberWeights) == 0 {
|
||||
b.MemberWeights = nil
|
||||
return nil
|
||||
}
|
||||
if b.Strategy != "leastLoad" {
|
||||
return common.NewError("balancer weights only apply to the leastLoad strategy")
|
||||
}
|
||||
cleaned := make(map[int]float64, len(b.MemberWeights))
|
||||
for id, weight := range b.MemberWeights {
|
||||
if !slices.Contains(b.InboundIds, id) {
|
||||
continue
|
||||
}
|
||||
// xray decodes costs as float32; out-of-range values make it reject the
|
||||
// whole config, and underflow decays to the tag-digit fallback weight.
|
||||
if weight <= 0 || weight > math.MaxFloat32 || weight < math.SmallestNonzeroFloat32 {
|
||||
return common.NewError("balancer member weights must be a positive float32 value")
|
||||
}
|
||||
cleaned[id] = weight
|
||||
}
|
||||
if len(cleaned) == 0 {
|
||||
cleaned = nil
|
||||
}
|
||||
b.MemberWeights = cleaned
|
||||
return nil
|
||||
}
|
||||
|
||||
// List returns all balancers in subscription order.
|
||||
func (s *SubBalancerService) List() ([]*model.SubBalancer, error) {
|
||||
var balancers []*model.SubBalancer
|
||||
@@ -79,6 +113,7 @@ func (s *SubBalancerService) Update(id int, balancer *model.SubBalancer, enabled
|
||||
current.Remark = balancer.Remark
|
||||
current.Strategy = balancer.Strategy
|
||||
current.InboundIds = balancer.InboundIds
|
||||
current.MemberWeights = balancer.MemberWeights
|
||||
current.SortOrder = balancer.SortOrder
|
||||
if enabled != nil {
|
||||
current.Enabled = *enabled
|
||||
|
||||
@@ -159,3 +159,91 @@ func TestSubBalancerServiceValidation(t *testing.T) {
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Weights are a leastLoad-only knob (xray ignores costs elsewhere); non-positive
|
||||
// weights are rejected rather than defaulted — a zero means "never pick this".
|
||||
func TestSubBalancerServiceWeightValidation(t *testing.T) {
|
||||
setupSubBalancerDB(t)
|
||||
svc := &SubBalancerService{}
|
||||
|
||||
if _, err := svc.Create(&model.SubBalancer{
|
||||
Remark: "w", Strategy: "random", InboundIds: []int{1},
|
||||
MemberWeights: map[int]float64{1: 0.5},
|
||||
}); err == nil || !strings.Contains(err.Error(), "leastLoad strategy") {
|
||||
t.Fatalf("weights with random = %v, want leastLoad-strategy error", err)
|
||||
}
|
||||
|
||||
if _, err := svc.Create(&model.SubBalancer{
|
||||
Remark: "w", Strategy: "leastLoad", InboundIds: []int{1},
|
||||
MemberWeights: map[int]float64{1: -0.5},
|
||||
}); err == nil || !strings.Contains(err.Error(), "positive float32") {
|
||||
t.Fatalf("negative weight = %v, must be rejected", err)
|
||||
}
|
||||
|
||||
if _, err := svc.Create(&model.SubBalancer{
|
||||
Remark: "w", Strategy: "leastLoad", InboundIds: []int{1},
|
||||
MemberWeights: map[int]float64{1: 1e39},
|
||||
}); err == nil || !strings.Contains(err.Error(), "positive float32") {
|
||||
t.Fatalf("above-float32 weight = %v, must be rejected", err)
|
||||
}
|
||||
|
||||
if _, err := svc.Create(&model.SubBalancer{
|
||||
Remark: "w", Strategy: "leastLoad", InboundIds: []int{1},
|
||||
MemberWeights: map[int]float64{1: 1e-50},
|
||||
}); err == nil || !strings.Contains(err.Error(), "positive float32") {
|
||||
t.Fatalf("underflowing weight = %v, must be rejected", err)
|
||||
}
|
||||
|
||||
stray, err := svc.Create(&model.SubBalancer{
|
||||
Remark: "stray", Strategy: "leastLoad", InboundIds: []int{1, 2},
|
||||
MemberWeights: map[int]float64{2: 0.25, 99: 3.0},
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("create with stray weight id: %v", err)
|
||||
}
|
||||
stored, err := svc.Get(stray.Id)
|
||||
if err != nil {
|
||||
t.Fatalf("get: %v", err)
|
||||
}
|
||||
if len(stored.MemberWeights) != 1 || stored.MemberWeights[2] != 0.25 {
|
||||
t.Fatalf("memberWeights = %v, want only {2:0.25} (id 99 dropped)", stored.MemberWeights)
|
||||
}
|
||||
|
||||
reweighted, err := svc.Update(stray.Id, &model.SubBalancer{
|
||||
Remark: "stray", Strategy: "leastLoad", InboundIds: []int{1, 2},
|
||||
MemberWeights: map[int]float64{1: 2.5}, SortOrder: 1,
|
||||
}, nil)
|
||||
if err != nil {
|
||||
t.Fatalf("update weights: %v", err)
|
||||
}
|
||||
if reweighted.MemberWeights[1] != 2.5 || len(reweighted.MemberWeights) != 1 {
|
||||
t.Fatalf("updated memberWeights = %v, want {1:2.5}", reweighted.MemberWeights)
|
||||
}
|
||||
|
||||
cleared, err := svc.Update(stray.Id, &model.SubBalancer{
|
||||
Remark: "stray", Strategy: "leastLoad", InboundIds: []int{1, 2}, SortOrder: 1,
|
||||
}, nil)
|
||||
if err != nil {
|
||||
t.Fatalf("update without weights: %v", err)
|
||||
}
|
||||
if cleared.MemberWeights != nil {
|
||||
t.Fatalf("absent memberWeights must clear stored weights, got %v", cleared.MemberWeights)
|
||||
}
|
||||
|
||||
// A toggle-style update (weights key absent) must not erase stored weights
|
||||
// when the payload carries them back — re-Get to prove the column survived.
|
||||
toggled, err := svc.Update(stray.Id, &model.SubBalancer{
|
||||
Remark: "stray", Strategy: "leastLoad", InboundIds: []int{1, 2},
|
||||
MemberWeights: map[int]float64{1: 2.5}, SortOrder: 1,
|
||||
}, nil)
|
||||
if err != nil {
|
||||
t.Fatalf("toggle-style update with weights: %v", err)
|
||||
}
|
||||
reget, err := svc.Get(toggled.Id)
|
||||
if err != nil {
|
||||
t.Fatalf("get after toggle-style update: %v", err)
|
||||
}
|
||||
if len(reget.MemberWeights) != 1 || reget.MemberWeights[1] != 2.5 {
|
||||
t.Fatalf("re-Get memberWeights = %v, want persisted {1:2.5}", reget.MemberWeights)
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user