Files
3x-ui/frontend/src/pages/settings/SubBalancerFormModal.tsx
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

244 lines
8.4 KiB
TypeScript

import { useEffect, useMemo } from 'react';
import { useTranslation } from 'react-i18next';
import { Form, Input, InputNumber, Modal, Select, Switch, message } from 'antd';
import { Controller, FormProvider, useForm, useWatch } from 'react-hook-form';
import { FormField, rhfZodValidate } from '@/components/form/rhf';
import SelectAllClearButtons from '@/components/form/SelectAllClearButtons';
import { useInboundOptions } from '@/api/queries/useInboundOptions';
import { formatInboundLabel } from '@/lib/inbounds/label';
import {
SubBalancerFormSchema,
SubBalancerStrategySchema,
type SubBalancer,
type SubBalancerFormValues,
type SubBalancerStrategy,
} from '@/schemas/subBalancer';
// The JSON subscription only builds proxy outbounds for these protocols;
// mtproto has no proxy-outbound case, so it is excluded from balancer members.
const MULTI_CLIENT_PROTOCOLS = new Set([
'shadowsocks',
'vless',
'vmess',
'trojan',
'hysteria',
'wireguard',
]);
const STRATEGY_LABEL_KEYS: Record<SubBalancerStrategy, string> = {
leastLoad: 'pages.settings.subBalancers.strategyLeastLoad',
leastPing: 'pages.settings.subBalancers.strategyLeastPing',
random: 'pages.settings.subBalancers.strategyRandom',
roundRobin: 'pages.settings.subBalancers.strategyRoundRobin',
};
function initialState(balancer: SubBalancer | null): SubBalancerFormValues {
return {
remark: balancer?.remark ?? '',
strategy: balancer?.strategy ?? 'random',
inboundIds: [...(balancer?.inboundIds ?? [])],
memberWeights: balancer?.memberWeights ? { ...balancer.memberWeights } : undefined,
sortOrder: balancer?.sortOrder ?? 1,
enabled: balancer?.enabled ?? true,
};
}
interface SubBalancerFormModalProps {
open: boolean;
balancer: SubBalancer | null;
onClose: () => void;
onConfirm: (values: SubBalancerFormValues) => void;
}
export default function SubBalancerFormModal({
open,
balancer,
onClose,
onConfirm,
}: SubBalancerFormModalProps) {
const { t } = useTranslation();
const [messageApi, messageContextHolder] = message.useMessage();
const methods = useForm<SubBalancerFormValues>({ defaultValues: initialState(balancer) });
const isEdit = balancer != null;
useEffect(() => {
if (open) methods.reset(initialState(balancer));
}, [open, balancer, methods]);
const inboundIds = useWatch({ control: methods.control, name: 'inboundIds' });
const strategy = useWatch({ control: methods.control, name: 'strategy' });
// Weights only make sense for leastLoad; the fields hide but keep their
// values so an accidental toggle away and back loses nothing until submit.
const showWeights = strategy === 'leastLoad';
const { data: inboundOptionsRaw } = useInboundOptions();
const inboundOptions = useMemo(
() =>
(inboundOptionsRaw ?? [])
.filter((ib) => MULTI_CLIENT_PROTOCOLS.has(ib.protocol || ''))
.filter((ib) => ib.enable || (inboundIds || []).includes(ib.id))
.map((ib) => ({
label: formatInboundLabel(ib.tag, ib.remark),
value: ib.id,
title: formatInboundLabel(ib.tag, ib.remark),
})),
[inboundOptionsRaw, inboundIds],
);
function onFinish(values: SubBalancerFormValues) {
const candidate: SubBalancerFormValues = { ...values };
if (candidate.memberWeights) {
const cleaned = Object.fromEntries(
Object.entries(candidate.memberWeights).filter(
([, v]) => typeof v === 'number' && Number.isFinite(v) && v > 0,
),
);
candidate.memberWeights = Object.keys(cleaned).length > 0 ? cleaned : undefined;
}
// xray ignores costs on every strategy but leastLoad — never send them.
if (candidate.strategy !== 'leastLoad') {
delete candidate.memberWeights;
}
const parsed = SubBalancerFormSchema.safeParse(candidate);
if (!parsed.success) {
messageApi.error(
t(parsed.error.issues[0]?.message ?? 'pages.settings.subBalancers.errRemarkRequired'),
);
return;
}
onConfirm(parsed.data);
}
const strategies = SubBalancerStrategySchema.options.map((value) => ({
value,
label: t(STRATEGY_LABEL_KEYS[value]),
}));
return (
<Modal
open={open}
title={
isEdit
? `${t('edit')} ${t('pages.settings.subBalancers.title')}`
: `+ ${t('pages.settings.subBalancers.add')}`
}
okText={isEdit ? t('pages.clients.submitEdit') : t('create')}
cancelText={t('close')}
mask={{ closable: false }}
width="640px"
onOk={methods.handleSubmit(onFinish)}
onCancel={onClose}
>
{messageContextHolder}
<FormProvider {...methods}>
<Form layout="vertical">
<FormField
label={t('pages.settings.subBalancers.remark')}
name="remark"
required
rules={{ validate: rhfZodValidate(SubBalancerFormSchema.shape.remark) }}
>
<Input placeholder={t('pages.settings.subBalancers.remarkPlaceholder')} />
</FormField>
<FormField label={t('pages.settings.subBalancers.strategy')} name="strategy" required>
<Select options={strategies} />
</FormField>
<FormField
label={t('pages.settings.subBalancers.sortOrder')}
name="sortOrder"
required
tooltip={t('pages.settings.subBalancers.sortOrderHelp')}
rules={{ validate: rhfZodValidate(SubBalancerFormSchema.shape.sortOrder) }}
>
<InputNumber min={1} precision={0} style={{ width: '100%' }} />
</FormField>
<FormField
label={t('pages.settings.subBalancers.inbounds')}
name="inboundIds"
required
rules={{ validate: rhfZodValidate(SubBalancerFormSchema.shape.inboundIds) }}
>
<Select
mode="multiple"
options={inboundOptions}
maxTagCount="responsive"
listHeight={220}
showSearch={{ optionFilterProp: 'label' }}
/>
</FormField>
<SelectAllClearButtons
options={inboundOptions}
value={inboundIds || []}
onChange={(v) => methods.setValue('inboundIds', v, { shouldDirty: true })}
/>
{showWeights && (inboundIds ?? []).length > 0 && (
<Form.Item
className="sub-balancer-weights"
label={t('pages.settings.subBalancers.weights')}
tooltip={t('pages.settings.subBalancers.weightsHelp')}
style={{ marginBottom: 16 }}
>
<div
style={{
display: 'flex',
flexDirection: 'column',
gap: 8,
maxHeight: 220,
overflowY: 'auto',
paddingRight: 4,
}}
>
{(inboundIds ?? []).map((id) => {
const option = inboundOptions.find((o) => o.value === id);
return (
<div key={id} style={{ display: 'flex', alignItems: 'center', gap: 8 }}>
<span
title={option?.title}
style={{
minWidth: 0,
flex: 1,
overflow: 'hidden',
textOverflow: 'ellipsis',
}}
>
{option?.label ?? `#${id}`}
</span>
<Controller
control={methods.control}
name={`memberWeights.${id}`}
render={({ field }) => (
<InputNumber
min={0.1}
step={0.1}
precision={1}
style={{ width: 120 }}
value={(field.value as number | undefined) ?? 1}
onChange={(v) => field.onChange(typeof v === 'number' ? v : undefined)}
/>
)}
/>
</div>
);
})}
</div>
</Form.Item>
)}
<FormField
label={t('pages.settings.subBalancers.enabled')}
name="enabled"
valueProp="checked"
>
<Switch />
</FormField>
</Form>
</FormProvider>
</Modal>
);
}