Files
3x-ui/internal/web/service/sub_balancer.go
T
DIMFLIX 7100fbcd08 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>
2026-09-02 20:21:27 +02:00

137 lines
3.8 KiB
Go

package service
import (
"math"
"slices"
"strings"
"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/common"
)
var subBalancerStrategies = map[string]struct{}{
"leastLoad": {},
"leastPing": {},
"random": {},
"roundRobin": {},
}
// SubBalancerService manages client-side JSON-subscription balancers; rows
// are read per request by internal/sub, so mutations need no xray restart.
type SubBalancerService struct{}
func (s *SubBalancerService) validate(b *model.SubBalancer) error {
b.Remark = strings.TrimSpace(b.Remark)
if b.Remark == "" {
return common.NewError("balancer remark is required")
}
if len(b.Remark) > 256 {
return common.NewError("balancer remark too long (max 256)")
}
if b.Strategy == "" {
b.Strategy = "random"
}
if _, ok := subBalancerStrategies[b.Strategy]; !ok {
return common.NewError("invalid balancer strategy:", b.Strategy)
}
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
err := database.GetDB().Model(&model.SubBalancer{}).
Order("sort_order asc, id asc").Find(&balancers).Error
return balancers, err
}
func (s *SubBalancerService) Get(id int) (*model.SubBalancer, error) {
var balancer model.SubBalancer
if err := database.GetDB().First(&balancer, id).Error; err != nil {
return nil, err
}
return &balancer, nil
}
func (s *SubBalancerService) Create(balancer *model.SubBalancer) (*model.SubBalancer, error) {
if err := s.validate(balancer); err != nil {
return nil, err
}
if err := database.GetDB().Create(balancer).Error; err != nil {
return nil, err
}
return balancer, nil
}
func (s *SubBalancerService) Update(id int, balancer *model.SubBalancer, enabled *bool) (*model.SubBalancer, error) {
if err := s.validate(balancer); err != nil {
return nil, err
}
current, err := s.Get(id)
if err != nil {
return nil, err
}
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
}
if err := database.GetDB().Save(current).Error; err != nil {
return nil, err
}
return current, nil
}
func (s *SubBalancerService) Delete(id int) error {
res := database.GetDB().Delete(&model.SubBalancer{}, id)
if res.Error != nil {
return res.Error
}
if res.RowsAffected == 0 {
return common.NewError("sub balancer not found")
}
return nil
}