feat(balancer): add balancer-to-balancer fallback support (#5586)

* feat(balancer): add balancer-to-balancer fallback support Xray does not natively support using a balancer as fallbackTag for another balancer. This feature automates the loopback workaround: when a user selects a balancer as fallback, the panel generates a loopback outbound + routing rule in the template. How it works: - User picks fallback balancer from dropdown - Panel creates loopback outbound _bl_{target} + routing rule - Balancer fallbackTag set to _bl_{target} - Traffic: Balancer A → loopback _bl_B → routing rule → Balancer B Key features: - Dedup: multiple balancers sharing same fallback reuse one loopback - DFS cycle detection at edit time and on save - Self-reference guard (cannot select own balancer) - Delete protection (blocks if used as fallback by others) - Cleans up routing rules referencing deleted balancers - Override resolves balancer tags through loopback mechanism - All live status tags resolved for display - Internal _bl_ objects filtered from Outbounds/Routing UI - Backward-compatible with old _bl_ naming format - Translations for all 13 locales * fix(review): override regression, save payload sync, i18n completeness - OverrideBalancer: only resolve to loopback when resolution succeeds, pass original target through for plain outbound tags - onSaveAll: serialize cleaned template before save to ensure the healed/cleaned config is what gets persisted - Add reservedPrefix translation key to all 12 non-English locales - Restore trailing newlines in all 13 translation JSON files * fix(test): update balancer form modal tests after cycle-detection guard The okButtonProps disabled guard (added in 56d5825c) prevents the modal from firing onOk when the form is invalid. The old tests clicked the button expecting validation errors to appear, but antd Modal never calls onOk on a disabled button — causing false failures. Rewrite to test the actual guard behavior: - Button starts disabled (empty form) - Stays disabled with tag only (selector still empty) - Stays disabled for duplicate tag - Disabled button does not trigger onConfirm --------- Co-authored-by: MHSanaei <ho3ein.sanaei@gmail.com>
2026-07-16 01:26:07 +00:00 · 2026-07-09 02:59:51 +03:00
parent ea24ef0a69
commit 142dab9ee8
24 changed files with 932 additions and 60 deletions
@@ -2,6 +2,8 @@ import { describe, it, expect, vi } from 'vitest';
 import { fireEvent } from '@testing-library/react';

 import BalancerFormModal from '@/pages/xray/balancers/BalancerFormModal';
+import type { BalancerFormValue } from '@/pages/xray/balancers/BalancerFormModal';
+import type { BalancerObject } from '@/schemas/routing';
 import { renderWithProviders } from './test-utils';

 function renderModal(onConfirm = vi.fn()) {
@@ -10,6 +12,9 @@ function renderModal(onConfirm = vi.fn()) {
      open
      balancer={null}
      outboundTags={['proxy', 'direct']}
+      balancerTags={[]}
+      balancers={[]}
+      templateSettings={null}
      otherTags={['existing']}
      onClose={() => {}}
      onConfirm={onConfirm}
@@ -28,9 +33,9 @@ function explainText(): string {
    .join(' | ');
 }

-function createButton(): HTMLElement {
+function primaryButton(): HTMLElement {
  const btn = document.querySelector('.ant-modal-footer .ant-btn-primary');
-  if (!btn) throw new Error('Create button not found');
+  if (!btn) throw new Error('Primary button not found');
  return btn as HTMLElement;
 }

@@ -41,18 +46,43 @@ describe('BalancerFormModal', () => {
    expect(erroredItemCount()).toBe(0);
    expect(explainText()).not.toContain('Tag is required');
    expect(explainText()).not.toContain('Pick at least one outbound');
-    expect(createButton().hasAttribute('disabled')).toBe(false);
+    expect(primaryButton().hasAttribute('disabled')).toBe(false);
  });

  it('reveals required-field errors only after a save attempt, without confirming', () => {
    const { onConfirm } = renderModal();
    expect(erroredItemCount()).toBe(0);

-    fireEvent.click(createButton());
+    fireEvent.click(primaryButton());

    expect(erroredItemCount()).toBe(2);
    expect(explainText()).toContain('Tag is required');
    expect(explainText()).toContain('Pick at least one outbound');
    expect(onConfirm).not.toHaveBeenCalled();
  });
+
+  it('disables save and warns when the chosen fallback would create a balancer cycle', () => {
+    const editing: BalancerFormValue = { tag: 'A', strategy: 'random', selector: ['proxy'], fallbackTag: 'B' };
+    const others: BalancerObject[] = [{ tag: 'B', selector: ['direct'], fallbackTag: 'A' }];
+    const onConfirm = vi.fn();
+    renderWithProviders(
+      <BalancerFormModal
+        open
+        balancer={editing}
+        outboundTags={['proxy', 'direct']}
+        balancerTags={['A', 'B']}
+        balancers={others}
+        templateSettings={null}
+        otherTags={['B']}
+        onClose={() => {}}
+        onConfirm={onConfirm}
+      />,
+    );
+
+    expect(document.querySelector('.ant-alert-error')).toBeTruthy();
+    expect(primaryButton().hasAttribute('disabled')).toBe(true);
+
+    fireEvent.click(primaryButton());
+    expect(onConfirm).not.toHaveBeenCalled();
+  });
 });
@@ -0,0 +1,285 @@
+import { describe, it, expect } from 'vitest';
+
+import type { XraySettingsValue } from '@/hooks/useXraySetting';
+import {
+  isBalancerLoopbackTag,
+  loopbackTagFor,
+  balancerTagFromLoopback,
+  resolveLoopbackFallback,
+  ensureBalancerLoopback,
+  ensureMissingBalancerLoopbacks,
+  removeBalancerLoopback,
+  removeBalancerLoopbackIfOrphaned,
+  propagateBalancerTagRename,
+  detectBalancerCycles,
+  cleanupOrphanedBalancerLoopbacks,
+} from '@/pages/xray/balancers/balancer-loopback';
+
+interface OutboundEntry {
+  tag?: string;
+  protocol?: string;
+  settings?: { inboundTag?: string };
+}
+interface RuleEntry {
+  type?: string;
+  inboundTag?: string[];
+  balancerTag?: string;
+}
+interface BalancerEntry {
+  tag?: string;
+  selector?: string[];
+  fallbackTag?: string;
+}
+
+function makeSettings(input: {
+  outbounds?: OutboundEntry[];
+  rules?: RuleEntry[];
+  balancers?: BalancerEntry[];
+}): XraySettingsValue {
+  return {
+    outbounds: input.outbounds,
+    routing: {
+      rules: input.rules,
+      balancers: input.balancers,
+    },
+  } as XraySettingsValue;
+}
+
+function outboundTags(settings: XraySettingsValue): string[] {
+  return ((settings.outbounds ?? []) as OutboundEntry[]).map((o) => o.tag ?? '');
+}
+
+function loopbackOutbounds(settings: XraySettingsValue): OutboundEntry[] {
+  return ((settings.outbounds ?? []) as OutboundEntry[]).filter((o) => o.protocol === 'loopback');
+}
+
+function ruleEntries(settings: XraySettingsValue): RuleEntry[] {
+  return (settings.routing?.rules ?? []) as RuleEntry[];
+}
+
+function balancerEntries(settings: XraySettingsValue): BalancerEntry[] {
+  return (settings.routing?.balancers ?? []) as BalancerEntry[];
+}
+
+describe('loopback tag helpers', () => {
+  const cases: Array<{ tag: string; isLoopback: boolean; roundtrip: string | null }> = [
+    { tag: '_bl_main', isLoopback: true, roundtrip: 'main' },
+    { tag: 'main', isLoopback: false, roundtrip: null },
+    { tag: '_bl_', isLoopback: true, roundtrip: '' },
+    { tag: 'proxy_bl_', isLoopback: false, roundtrip: null },
+  ];
+
+  it.each(cases)('classifies $tag', ({ tag, isLoopback, roundtrip }) => {
+    expect(isBalancerLoopbackTag(tag)).toBe(isLoopback);
+    expect(balancerTagFromLoopback(tag)).toBe(roundtrip);
+  });
+
+  it('builds a loopback tag that round-trips back to the balancer tag', () => {
+    expect(loopbackTagFor('cluster-a')).toBe('_bl_cluster-a');
+    expect(balancerTagFromLoopback(loopbackTagFor('cluster-a'))).toBe('cluster-a');
+  });
+});
+
+describe('resolveLoopbackFallback', () => {
+  const settings = makeSettings({
+    rules: [{ type: 'field', inboundTag: ['_bl_bal1'], balancerTag: 'bal1' }],
+  });
+
+  const cases: Array<{ name: string; input: string; expected: string }> = [
+    { name: 'resolves a loopback tag through its routing rule', input: '_bl_bal1', expected: 'bal1' },
+    { name: 'returns a plain outbound tag unchanged', input: 'direct', expected: 'direct' },
+    { name: 'returns an empty tag unchanged', input: '', expected: '' },
+    { name: 'derives the balancer tag when no rule maps it', input: '_bl_bal2', expected: 'bal2' },
+  ];
+
+  it.each(cases)('$name', ({ input, expected }) => {
+    expect(resolveLoopbackFallback(settings, input)).toBe(expected);
+  });
+});
+
+describe('ensureBalancerLoopback dedup', () => {
+  it('creates exactly one loopback outbound and one rule when called repeatedly', () => {
+    const settings = makeSettings({ outbounds: [], rules: [], balancers: [] });
+
+    ensureBalancerLoopback(settings, 'bal1');
+    ensureBalancerLoopback(settings, 'bal1');
+
+    const loopbacks = loopbackOutbounds(settings);
+    expect(loopbacks).toHaveLength(1);
+    expect(loopbacks[0]).toEqual({
+      tag: '_bl_bal1',
+      protocol: 'loopback',
+      settings: { inboundTag: '_bl_bal1' },
+    });
+
+    const matchingRules = ruleEntries(settings).filter(
+      (r) => Array.isArray(r.inboundTag) && r.inboundTag.includes('_bl_bal1'),
+    );
+    expect(matchingRules).toHaveLength(1);
+    expect(matchingRules[0].balancerTag).toBe('bal1');
+  });
+
+  it('does not duplicate a loopback shared by multiple balancers', () => {
+    const settings = makeSettings({
+      outbounds: [],
+      rules: [],
+      balancers: [
+        { tag: 'A', selector: [], fallbackTag: '_bl_shared' },
+        { tag: 'B', selector: [], fallbackTag: '_bl_shared' },
+      ],
+    });
+
+    ensureMissingBalancerLoopbacks(settings);
+
+    expect(loopbackOutbounds(settings)).toHaveLength(1);
+    expect(
+      ruleEntries(settings).filter(
+        (r) => Array.isArray(r.inboundTag) && r.inboundTag.includes('_bl_shared'),
+      ),
+    ).toHaveLength(1);
+  });
+});
+
+describe('detectBalancerCycles', () => {
+  const cases: Array<{ name: string; balancers: BalancerEntry[]; expected: string[][] }> = [
+    {
+      name: 'two-balancer loop A -> B -> A',
+      balancers: [
+        { tag: 'A', fallbackTag: '_bl_B' },
+        { tag: 'B', fallbackTag: '_bl_A' },
+      ],
+      expected: [
+        ['A', 'B'],
+        ['B', 'A'],
+      ],
+    },
+    {
+      name: 'self loop A -> A',
+      balancers: [{ tag: 'A', fallbackTag: '_bl_A' }],
+      expected: [['A', 'A']],
+    },
+    {
+      name: 'three-balancer loop A -> B -> C -> A',
+      balancers: [
+        { tag: 'A', fallbackTag: '_bl_B' },
+        { tag: 'B', fallbackTag: '_bl_C' },
+        { tag: 'C', fallbackTag: '_bl_A' },
+      ],
+      expected: [
+        ['A', 'B'],
+        ['B', 'C'],
+        ['C', 'A'],
+      ],
+    },
+    {
+      name: 'linear chain is not a cycle',
+      balancers: [{ tag: 'A', fallbackTag: '_bl_B' }, { tag: 'B' }],
+      expected: [],
+    },
+    {
+      name: 'non-loopback fallback is ignored',
+      balancers: [{ tag: 'A', fallbackTag: 'direct' }],
+      expected: [],
+    },
+  ];
+
+  it.each(cases)('$name', ({ balancers, expected }) => {
+    expect(detectBalancerCycles(makeSettings({ balancers }))).toEqual(expected);
+  });
+});
+
+describe('propagateBalancerTagRename', () => {
+  it('rewrites the loopback outbound, its rule and referring fallback tags', () => {
+    const settings = makeSettings({
+      outbounds: [{ tag: '_bl_old', protocol: 'loopback', settings: { inboundTag: '_bl_old' } }],
+      rules: [{ type: 'field', inboundTag: ['_bl_old'], balancerTag: 'old' }],
+      balancers: [{ tag: 'user', selector: [], fallbackTag: '_bl_old' }],
+    });
+
+    propagateBalancerTagRename(settings, 'old', 'new');
+
+    const [outbound] = loopbackOutbounds(settings);
+    expect(outbound.tag).toBe('_bl_new');
+    expect(outbound.settings?.inboundTag).toBe('_bl_new');
+    expect(ruleEntries(settings)[0].inboundTag).toEqual(['_bl_new']);
+    expect(balancerEntries(settings)[0].fallbackTag).toBe('_bl_new');
+  });
+
+  it('leaves unrelated loopback tags untouched', () => {
+    const settings = makeSettings({
+      outbounds: [{ tag: '_bl_other', protocol: 'loopback', settings: { inboundTag: '_bl_other' } }],
+      rules: [{ type: 'field', inboundTag: ['_bl_other'], balancerTag: 'other' }],
+      balancers: [{ tag: 'user', selector: [], fallbackTag: '_bl_other' }],
+    });
+
+    propagateBalancerTagRename(settings, 'old', 'new');
+
+    expect(loopbackOutbounds(settings)[0].tag).toBe('_bl_other');
+    expect(ruleEntries(settings)[0].inboundTag).toEqual(['_bl_other']);
+    expect(balancerEntries(settings)[0].fallbackTag).toBe('_bl_other');
+  });
+});
+
+describe('orphan cleanup', () => {
+  it('cleanupOrphanedBalancerLoopbacks removes only unreferenced loopbacks', () => {
+    const settings = makeSettings({
+      outbounds: [
+        { tag: '_bl_gone', protocol: 'loopback', settings: { inboundTag: '_bl_gone' } },
+        { tag: '_bl_kept', protocol: 'loopback', settings: { inboundTag: '_bl_kept' } },
+        { tag: 'proxy', protocol: 'vless' },
+      ],
+      rules: [
+        { type: 'field', inboundTag: ['_bl_gone'], balancerTag: 'gone' },
+        { type: 'field', inboundTag: ['_bl_kept'], balancerTag: 'kept' },
+      ],
+      balancers: [{ tag: 'user', selector: [], fallbackTag: '_bl_kept' }],
+    });
+
+    cleanupOrphanedBalancerLoopbacks(settings);
+
+    expect(outboundTags(settings)).toEqual(['_bl_kept', 'proxy']);
+    expect(ruleEntries(settings).map((r) => r.inboundTag)).toEqual([['_bl_kept']]);
+  });
+
+  it('removeBalancerLoopbackIfOrphaned keeps a loopback that is still referenced', () => {
+    const settings = makeSettings({
+      outbounds: [{ tag: '_bl_kept', protocol: 'loopback', settings: { inboundTag: '_bl_kept' } }],
+      rules: [{ type: 'field', inboundTag: ['_bl_kept'], balancerTag: 'kept' }],
+      balancers: [{ tag: 'user', selector: [], fallbackTag: '_bl_kept' }],
+    });
+
+    removeBalancerLoopbackIfOrphaned(settings, 'kept');
+
+    expect(loopbackOutbounds(settings)).toHaveLength(1);
+    expect(ruleEntries(settings)).toHaveLength(1);
+  });
+
+  it('removeBalancerLoopbackIfOrphaned drops a loopback with no referrers', () => {
+    const settings = makeSettings({
+      outbounds: [{ tag: '_bl_kept', protocol: 'loopback', settings: { inboundTag: '_bl_kept' } }],
+      rules: [{ type: 'field', inboundTag: ['_bl_kept'], balancerTag: 'kept' }],
+      balancers: [],
+    });
+
+    removeBalancerLoopbackIfOrphaned(settings, 'kept');
+
+    expect(loopbackOutbounds(settings)).toHaveLength(0);
+    expect(ruleEntries(settings)).toHaveLength(0);
+  });
+
+  it('removeBalancerLoopback deletes the outbound and rule directly', () => {
+    const settings = makeSettings({
+      outbounds: [
+        { tag: '_bl_kept', protocol: 'loopback', settings: { inboundTag: '_bl_kept' } },
+        { tag: 'proxy', protocol: 'vless' },
+      ],
+      rules: [{ type: 'field', inboundTag: ['_bl_kept'], balancerTag: 'kept' }],
+      balancers: [{ tag: 'user', selector: [], fallbackTag: '_bl_kept' }],
+    });
+
+    removeBalancerLoopback(settings, 'kept');
+
+    expect(outboundTags(settings)).toEqual(['proxy']);
+    expect(ruleEntries(settings)).toHaveLength(0);
+  });
+});