feat(happ): add routing editor, optional ad blocking, and LAN bypass preset (#6545)

* feat(happ): make ad blocking optional in routing presets

Add an independent AdBlock toggle for Iran, China, and global presets, applied only when generating routing rules. Update the China preset to Bypass-CN and cover preset behavior and localized controls.

* feat: add visual routing editor with JSON support and localization updates

- Implemented a new modal for editing routing profiles with basic and advanced tabs.
- Added functionality to load, parse, and generate routing profiles in JSON format.
- Enhanced user experience with validation and error handling for JSON input.
- Updated translations for Russian, Turkish, Ukrainian, Vietnamese, Chinese (Simplified and Traditional) to include new routing editor terms.
- Created helper functions for managing routing profiles and generating deep links.
- Added unit tests for routing editor functionalities and JSON handling.

* feat: update routing editor to preserve null lists in profiles and enhance validation messages
This commit is contained in:
NgaiYeanCoi
2026-09-27 04:57:01 +08:00
committed by GitHub
parent 94fa317e76
commit 5e15120cec
22 changed files with 1363 additions and 209 deletions
@@ -0,0 +1,211 @@
import { useState } from 'react';
import { describe, expect, it, vi } from 'vitest';
import { fireEvent, screen } from '@testing-library/react';
import { AllSetting } from '@/models/setting';
import HappSettingsContent from '@/pages/settings/HappSettingsContent';
import { renderWithProviders } from './test-utils';
const chinaProfile = {
Name: 'Bypass-CN',
GlobalProxy: 'true',
RouteOrder: 'block-proxy-direct',
RemoteDNSType: 'DoH',
RemoteDNSDomain: 'https://cloudflare-dns.com/dns-query',
RemoteDNSIP: '1.1.1.1',
DomesticDNSType: 'DoH',
DomesticDNSDomain: 'https://dns.alidns.com/dns-query',
DomesticDNSIP: '223.5.5.5',
DnsHosts: {
'cloudflare-dns.com': '1.1.1.1',
'dns.alidns.com': '223.5.5.5',
},
DirectSites: ['geosite:private', 'geosite:cn', 'geosite:geolocation-cn'],
DirectIp: [
'geoip:cn',
'geoip:private',
'127.0.0.0/8',
'10.0.0.0/8',
'172.16.0.0/12',
'192.168.0.0/16',
'169.254.0.0/16',
'224.0.0.0/4',
'255.255.255.255',
],
ProxySites: [],
ProxyIp: [],
BlockSites: [],
BlockIp: [],
DomainStrategy: 'IPIfNonMatch',
FakeDNS: 'false',
UseChunkFiles: 'true',
};
function renderSettings(isMobile = false) {
const updateSetting = vi.fn<(patch: Partial<AllSetting>) => void>();
function SettingsHarness() {
const [allSetting, setAllSetting] = useState(() => {
const settings = new AllSetting();
settings.subRoutingRules = 'https://example.com/existing-routing';
return settings;
});
return (
<HappSettingsContent
allSetting={allSetting}
updateSetting={(patch) => {
updateSetting(patch);
setAllSetting((previous) => Object.assign(new AllSetting(), previous, patch));
}}
isMobile={isMobile}
remoteSourceBadge={() => null}
/>
);
}
renderWithProviders(<SettingsHarness />);
return updateSetting;
}
function openPresets() {
const select = screen.getByRole('combobox').closest('.ant-select');
if (!select) throw new Error('Routing preset select not found');
fireEvent.mouseDown(select.querySelector('.ant-select-selector') ?? select);
return Array.from(
document.querySelectorAll(
'.ant-select-dropdown:not(.ant-select-dropdown-hidden) .ant-select-item-option',
),
);
}
function choosePreset(label: string) {
const option = openPresets().find((item) => item.textContent === label);
if (!option) throw new Error(`Routing preset '${label}' not found`);
fireEvent.click(option);
}
function routingRules() {
return (screen.getByRole('textbox', { name: 'Routing rules' }) as HTMLTextAreaElement).value;
}
function routingProfile(): Record<string, unknown> {
const prefix = 'happ://routing/onadd/';
const link = routingRules();
expect(link.startsWith(prefix)).toBe(true);
return JSON.parse(atob(link.slice(prefix.length))) as Record<string, unknown>;
}
describe('Happ routing preset controls', () => {
it('keeps selecting and toggling local until Apply updates the routing rules', () => {
const updateSetting = renderSettings();
choosePreset('China Direct (Bypass-CN)');
const includeAdblock = screen.getByRole('switch', { name: 'Include AdBlock' });
expect(includeAdblock.getAttribute('aria-checked')).toBe('false');
fireEvent.click(includeAdblock);
expect(includeAdblock.getAttribute('aria-checked')).toBe('true');
expect(updateSetting).not.toHaveBeenCalled();
expect(routingRules()).toBe('https://example.com/existing-routing');
fireEvent.click(screen.getByRole('button', { name: 'Apply preset' }));
expect(updateSetting).toHaveBeenCalledExactlyOnceWith({ subRoutingRules: routingRules() });
expect(routingProfile().BlockSites).toEqual(['geosite:category-ads-all']);
});
it.each([
['Iran Bypass', 'Iran Bypass'],
['China Direct (Bypass-CN)', 'Bypass-CN'],
['Full Proxy', 'Global Proxy'],
['Global Bypass Local Network', 'Global Bypass Local Network'],
])('applies %s without AdBlock by default', (label, profileName) => {
renderSettings();
choosePreset(label);
expect(
screen.getByRole('switch', { name: 'Include AdBlock' }).getAttribute('aria-checked'),
).toBe('false');
fireEvent.click(screen.getByRole('button', { name: 'Apply preset' }));
expect(routingProfile()).toMatchObject({ Name: profileName, BlockSites: [] });
});
it('keeps LAN bypass separate from Full Proxy when switching presets', () => {
renderSettings();
choosePreset('Global Bypass Local Network');
fireEvent.click(screen.getByRole('switch', { name: 'Include AdBlock' }));
fireEvent.click(screen.getByRole('button', { name: 'Apply preset' }));
expect(routingProfile()).toMatchObject({
Name: 'Global Bypass Local Network',
GlobalProxy: 'true',
DirectSites: ['geosite:private'],
DirectIp: ['geoip:private'],
BlockSites: ['geosite:category-ads-all'],
});
choosePreset('Full Proxy');
fireEvent.click(screen.getByRole('button', { name: 'Apply preset' }));
expect(routingProfile()).toMatchObject({
Name: 'Global Proxy',
GlobalProxy: 'true',
DirectSites: [],
DirectIp: [],
BlockSites: ['geosite:category-ads-all'],
});
});
it('preserves China routing when opting in and clears AdBlock when reapplied after opting out', () => {
const updateSetting = renderSettings(true);
choosePreset('China Direct (Bypass-CN)');
const includeAdblock = screen.getByRole('switch', { name: 'Include AdBlock' });
fireEvent.click(includeAdblock);
fireEvent.click(screen.getByRole('button', { name: 'Apply preset' }));
expect(routingProfile()).toEqual({
...chinaProfile,
BlockSites: ['geosite:category-ads-all'],
});
const withAdblock = routingRules();
fireEvent.click(includeAdblock);
expect(routingRules()).toBe(withAdblock);
expect(updateSetting).toHaveBeenCalledTimes(1);
fireEvent.click(screen.getByRole('button', { name: 'Apply preset' }));
expect(updateSetting).toHaveBeenCalledTimes(2);
expect(routingProfile()).toEqual(chinaProfile);
});
it('offers only base presets so AdBlock cannot replace a country preset', () => {
renderSettings();
expect(openPresets().map((option) => option.textContent)).toEqual([
'Iran Bypass',
'China Direct (Bypass-CN)',
'Full Proxy',
'Global Bypass Local Network',
'Disable Routing (happ://routing/off)',
]);
});
it('disables AdBlock for Off and applies the off link even after opting in', () => {
const updateSetting = renderSettings();
const includeAdblock = screen.getByRole('switch', { name: 'Include AdBlock' });
fireEvent.click(includeAdblock);
choosePreset('Disable Routing (happ://routing/off)');
expect((includeAdblock as HTMLButtonElement).disabled).toBe(true);
expect(updateSetting).not.toHaveBeenCalled();
fireEvent.click(screen.getByRole('button', { name: 'Apply preset' }));
expect(updateSetting).toHaveBeenCalledExactlyOnceWith({
subRoutingRules: 'happ://routing/off',
});
expect(routingRules()).toBe('happ://routing/off');
});
});