Files
mihomo-patchbay/shared/inbound-groups.test.ts
T
im0o b1b251b897
release / release (push) Successful in 26s
legacy 入站可升级为命名入站
顶层端口字段没有 proxy 可写(listener/inbound/base.go:97),界面上
切不了订阅。升级删掉顶层键、建同端口的 listener:listen 按 allow-lan
推导后写死,全局规则里 MATCH 之前的部分复制成附加规则,来源照抄
MATCH 目标组的 use:,让流量去向尽量不变。udp 不写,命名入站解析时
默认就是开的(listener/parse.go:52)。
「默认」tag 随术语表改成 legacy,旧叫法进 avoid 列表。
2026-08-12 17:30:47 +08:00

501 lines
20 KiB
TypeScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import { describe, expect, it } from 'bun:test'
import {
applySetup,
applySubRules,
chainGroupName,
chainProviderName,
managedWiring,
panelGroups,
readSubRules,
sharedPeers,
subRuleName,
syncGenerated,
isGenerated,
linesMatching,
proxyGroupName,
pruneGenerated,
readSetup,
upgradeLegacyInbound,
} from './inbound-groups.ts'
import type { OutboundSetup } from './inbound-groups.ts'
import { collectInbounds } from './inbounds.ts'
import type { ConfigObject } from '../vendor/config-editor/index.ts'
const URL = 'http://127.0.0.1:3001/token/download/V2House'
/** 一份最小但完整的配置:一个订阅、一路入站,还没被 Patchbay 接管过。 */
function base(): ConfigObject {
return {
'proxy-providers': {
subs: { type: 'http', url: URL, path: './providers/subs.yaml', interval: 86400 },
},
listeners: [{ name: 'test1', type: 'mixed', port: 7778 }],
}
}
const plain: OutboundSetup = { proxy: { sources: ['subs'], filter: null }, chain: null }
const chained: OutboundSetup = {
proxy: { sources: ['subs'], filter: null },
chain: { sources: ['subs'], filter: '(?i)DMIT' },
}
describe('名字', () => {
it('三种生成物都带前缀', () => {
// 前缀是识别它们的唯一可靠标记,注释会被配置改写引擎丢掉(决策记录 0002)
expect(isGenerated(proxyGroupName('test1'))).toBe(true)
expect(isGenerated(chainGroupName('test1'))).toBe(true)
expect(isGenerated(chainProviderName('test1', 'subs'))).toBe(true)
})
it('用户自己建的组不会被认成生成的', () => {
expect(isGenerated('PROXY')).toBe(false)
})
it('不同的「入站 × 来源」组合不撞名', () => {
// proxy-providers 是个映射,撞名会让其中一份被静默丢掉,
// 表现是链式代理挂到了别的入站上
const names = new Set([
chainProviderName('a', 'b c'),
chainProviderName('a b', 'c'),
chainProviderName('a', 'b'),
])
expect(names.size).toBe(3)
})
})
describe('筛选预览', () => {
const lines = ['[vmess]DMIT.LAX.Pro.MTYQ', '[vless]Gomami.SIN Secret', '香港01', '香港011']
it('没写筛选条件就是全要', () => {
expect(linesMatching(null, lines)).toEqual(lines)
})
it('部分匹配,不自动加锚点', () => {
// 内核的筛选就是部分匹配,界面预览必须跟它一致,否则预览的数字骗人
expect(linesMatching('香港01', lines)).toEqual(['香港01', '香港011'])
})
it('反引号切成多条正则,取并集', () => {
expect(linesMatching('DMIT`Gomami', lines)).toEqual([
'[vmess]DMIT.LAX.Pro.MTYQ',
'[vless]Gomami.SIN Secret',
])
})
it('写法有误时返回空,让界面提示而不是显示一个错的数字', () => {
expect(linesMatching('[未闭合', lines)).toBeNull()
})
})
describe('一路入站的三个组', () => {
it('SELECT 的成员是另外两个组加 DIRECT,再加上订阅,AUTO 排第一', () => {
// AUTO 必须排第一:内核给没有选中记录的组默认用第一个成员,选中的线路被订阅删掉时
// 也回退到第一个成员。这两种情况落到 DIRECT 上就是静默直连(selector.go:103-112)
const groups = applySetup(base(), 'test1', plain)['proxy-groups'] as ConfigObject[]
expect(groups[0]).toEqual({
name: 'patchbay:test1',
type: 'select',
proxies: ['patchbay:test1 AUTO', 'patchbay:test1 FALLBACK', 'DIRECT'],
use: ['subs'],
})
})
it('AUTO 是 url-test,FALLBACK 是 fallback,都带测速地址', () => {
// 不写测速地址时内核会去借来源订阅的健康检查配置,那依赖订阅写了它,不能指望
const groups = applySetup(base(), 'test1', plain)['proxy-groups'] as ConfigObject[]
expect(groups[1]).toEqual({
name: 'patchbay:test1 AUTO',
type: 'url-test',
use: ['subs'],
url: 'https://www.gstatic.com/generate_204',
interval: 300,
})
expect((groups[2] as ConfigObject).type).toBe('fallback')
})
it('tab 的顺序是 SELECT、AUTO、FALLBACK,只有 SELECT 能点', () => {
// 另外两个自己决定用哪条,手动指定会被它们自己撤销,见 outbound-chain.ts
const data = applySetup(base(), 'test1', plain)
const runtime = {
'patchbay:test1': { type: 'Selector' },
'patchbay:test1 AUTO': { type: 'URLTest' },
'patchbay:test1 FALLBACK': { type: 'Fallback' },
}
const inbound = collectInbounds(data)[0]!
const panel = panelGroups(data, runtime, inbound)
expect(panel.shared).toBe(false)
expect(panel.groups.map((g) => g.label)).toEqual(['SELECT', 'AUTO', 'FALLBACK'])
expect(panel.groups.map((g) => g.pickable)).toEqual([true, false, false])
expect(panel.groups[0]!.uses).toEqual(['subs'])
})
it('内核里还没有的组不出现在 tab 上', () => {
// 保存完到内核重载完之间会有这么一小段,画一个点不出东西的 tab 只会让人以为坏了
const data = applySetup(base(), 'test1', plain)
const inbound = collectInbounds(data)[0]!
expect(panelGroups(data, {}, inbound).groups).toEqual([])
})
it('没接管的入站落到它顺着规则表走到的那个手动选择组,并标为共用', () => {
const data: ConfigObject = {
...base(),
rules: ['MATCH,PROXY'],
'proxy-groups': [{ name: 'PROXY', type: 'select', use: ['subs'] }],
}
const runtime = { PROXY: { type: 'Selector', now: 'A', all: ['A'] } }
const panel = panelGroups(data, runtime, collectInbounds(data)[0]!)
expect(panel.shared).toBe(true)
expect(panel.groups).toEqual([
{ name: 'PROXY', label: 'PROXY', uses: ['subs'], pickable: true },
])
})
it('两路没接管的入站落到同一个组时互为共用者', () => {
// 「共用」标记只该出现在这种情况:在其中一路上换选中会连带改掉另一路的去向
const data: ConfigObject = {
...base(),
'mixed-port': 7890,
rules: ['MATCH,PROXY'],
'proxy-groups': [{ name: 'PROXY', type: 'select', use: ['subs'] }],
}
const runtime = { PROXY: { type: 'Selector', now: 'A', all: ['A'] } }
const inbounds = collectInbounds(data)
const legacy = inbounds.find((i) => i.isDefault)!
expect(sharedPeers(data, runtime, inbounds, legacy)).toEqual(['test1'])
})
it('只有自己落在那个组上时没有共用者', () => {
const data: ConfigObject = {
'mixed-port': 7890,
rules: ['MATCH,PROXY'],
'proxy-groups': [{ name: 'PROXY', type: 'select', proxies: ['DIRECT'] }],
}
const runtime = { PROXY: { type: 'Selector', now: 'DIRECT', all: ['DIRECT'] } }
const inbounds = collectInbounds(data)
expect(sharedPeers(data, runtime, inbounds, inbounds[0]!)).toEqual([])
})
it('接管过的入站用的是自己的组,谈不上共用', () => {
const data = applySetup(base(), 'test1', plain)
const runtime = { 'patchbay:test1': { type: 'Selector' } }
const inbounds = collectInbounds(data)
expect(sharedPeers(data, runtime, inbounds, inbounds[0]!)).toEqual([])
})
it('筛选条件三个组共用一份', () => {
const groups = applySetup(base(), 'test1', {
proxy: { sources: ['subs'], filter: '(?i)hk' },
chain: null,
})['proxy-groups'] as ConfigObject[]
for (const g of groups) expect((g as ConfigObject).filter).toBe('(?i)hk')
})
})
describe('重建成当前形状', () => {
it('旧形状的生成组会被补齐成三个', () => {
// 改过生成规则之后,早先建的那些停在旧形状上,界面按新形状去找就静默少一块
const stale: ConfigObject = {
...base(),
'proxy-groups': [{ name: 'patchbay:test1', type: 'select', use: ['subs'] }],
listeners: [{ name: 'test1', type: 'mixed', port: 7778, proxy: 'patchbay:test1' }],
}
const fixed = syncGenerated(stale, collectInbounds(stale))
const names = (fixed['proxy-groups'] as ConfigObject[]).map((g) => (g as ConfigObject).name)
expect(names).toEqual(['patchbay:test1', 'patchbay:test1 AUTO', 'patchbay:test1 FALLBACK'])
})
it('没接管的入站不碰', () => {
const data = base()
expect(syncGenerated(data, collectInbounds(data))).toBe(data)
})
})
describe('读取设置', () => {
it('没有代理组时返回空,表示这一路由别的方式决定去向', () => {
expect(readSetup(base(), 'test1')).toBeNull()
})
it('没开链式代理时,来源就是代理组的 use', () => {
const setup: OutboundSetup = { proxy: { sources: ['subs'], filter: '(?i)hk' }, chain: null }
expect(readSetup(applySetup(base(), 'test1', setup), 'test1')).toEqual(setup)
})
it('开了链式代理时,来源从副本的 path 还原', () => {
// 代理组的 use 这时指向副本,用户选的订阅只能靠读同一个缓存文件认回来
const data = applySetup(base(), 'test1', chained)
expect(readSetup(data, 'test1')).toEqual(chained)
})
})
describe('写回设置', () => {
it('开链式代理时建入口组,三个组一起改用副本', () => {
const groups = applySetup(base(), 'test1', chained)['proxy-groups'] as ConfigObject[]
const copyName = chainProviderName('test1', 'subs')
// 只有副本挂着 dialer-proxy,自动测速和故障转移也得走副本,否则那两条路绕过了中转
for (const g of groups.slice(0, 3)) expect((g as ConfigObject).use).toEqual([copyName])
expect(groups[3]).toEqual({
name: 'patchbay:test1 链式',
type: 'select',
use: ['subs'],
filter: '(?i)DMIT',
})
})
it('副本读原订阅的缓存文件,自己不联网', () => {
// 副本要是自己去拉,订阅地址一不可达它就是空的,那一路入站的线路会全部消失,
// 表现是端口还在监听却一条线都没有
const data = applySetup(base(), 'test1', chained)
const copy = (data['proxy-providers'] as ConfigObject)[
chainProviderName('test1', 'subs')
] as ConfigObject
expect(copy.type).toBe('file')
expect(copy.path).toBe('./providers/subs.yaml')
expect(copy.url).toBeUndefined()
expect(copy.interval).toBeUndefined()
expect(copy.override).toEqual({ 'dialer-proxy': 'patchbay:test1 链式' })
})
it('原订阅没写 path 时给它补一个,否则副本认不到该读哪个文件', () => {
// 内核会按 url 哈希自己生成缓存路径,那个路径 Patchbay 算不出来
const data = base()
delete ((data['proxy-providers'] as ConfigObject).subs as ConfigObject).path
const next = applySetup(data, 'test1', chained)
const providers = next['proxy-providers'] as ConfigObject
expect((providers.subs as ConfigObject).path).toBe('./providers/subs.yaml')
expect(readSetup(next, 'test1')).toEqual(chained)
})
it('源订阅原有的 override 保留,不被覆盖', () => {
const data = base()
;((data['proxy-providers'] as ConfigObject).subs as ConfigObject).override = { udp: true }
const next = applySetup(data, 'test1', chained)
const copy = (next['proxy-providers'] as ConfigObject)[
chainProviderName('test1', 'subs')
] as ConfigObject
expect(copy.override).toEqual({ udp: true, 'dialer-proxy': 'patchbay:test1 链式' })
})
it('关掉链式代理时,入口组和副本一起消失', () => {
const off = applySetup(applySetup(base(), 'test1', chained), 'test1', plain)
const names = (off['proxy-groups'] as ConfigObject[]).map((g) => (g as ConfigObject).name)
expect(names).not.toContain('patchbay:test1 链式')
expect(Object.keys(off['proxy-providers'] as ConfigObject)).toEqual(['subs'])
})
it('换来源时旧副本立刻消失', () => {
// 留着的话就是一份没人引用、却还在按 interval 定时联网的订阅
const data = base()
const providers = data['proxy-providers'] as ConfigObject
providers.other = { type: 'http', url: 'http://other.example/x', path: './providers/o.yaml' }
const first = applySetup(data, 'test1', chained)
const second = applySetup(first, 'test1', {
proxy: { sources: ['other'], filter: null },
chain: { sources: ['subs'], filter: null },
})
const names = Object.keys(second['proxy-providers'] as ConfigObject)
expect(names).toContain(chainProviderName('test1', 'other'))
expect(names).not.toContain(chainProviderName('test1', 'subs'))
})
it('两路入站各自的副本互不干扰', () => {
const data = base()
;(data.listeners as ConfigObject[]).push({ name: 'test2', type: 'mixed', port: 7779 })
const next = applySetup(applySetup(data, 'test1', chained), 'test2', chained)
const providers = next['proxy-providers'] as ConfigObject
expect(Object.keys(providers)).toHaveLength(3)
expect(readSetup(next, 'test1')).toEqual(chained)
expect(readSetup(next, 'test2')).toEqual(chained)
})
})
describe('清理', () => {
it('删掉入站之后,几个组和副本连锁消失', () => {
// 链式引用:SELECT 引 AUTO 和 FALLBACK,三者引副本,副本引入口组,要反复扫才清得干净
const withInbound = applySetup(base(), 'test1', chained)
const removed: ConfigObject = { ...withInbound, listeners: [] }
const cleaned = pruneGenerated(removed)
expect(cleaned['proxy-groups']).toBeUndefined()
expect(Object.keys(cleaned['proxy-providers'] as ConfigObject)).toEqual(['subs'])
})
it('入站还在就一个都不删', () => {
const data = applySetup(base(), 'test1', chained)
expect(pruneGenerated(data)).toBe(data)
})
it('用户自己建的组和订阅一律不碰,哪怕真的没人引用', () => {
const data: ConfigObject = {
'proxy-groups': [{ name: '我建的组', type: 'select', use: ['subs'] }],
'proxy-providers': { subs: { type: 'http', url: URL } },
}
expect(pruneGenerated(data)).toBe(data)
})
it('没有可删的时候原样返回,不制造无谓的改动', () => {
// 返回同一个对象,落盘链路才看得出「内容没变」而跳过备份和重载
const data: ConfigObject = { 'proxy-groups': [{ name: 'PROXY' }] }
expect(pruneGenerated(data)).toBe(data)
})
it('被规则引用的生成组不删,连它引用的两个组一起留下', () => {
const data = applySetup(base(), 'test1', plain)
const orphaned: ConfigObject = { ...data, listeners: [], rules: ['MATCH,patchbay:test1'] }
expect((pruneGenerated(orphaned)['proxy-groups'] as ConfigObject[]).length).toBe(3)
})
})
describe('附加规则', () => {
const managed = () => applySetup(base(), 'test1', plain)
const listenerOf = (data: ConfigObject) => (data.listeners as ConfigObject[])[0]!
it('写入后 listener 换成 rule 形态,表底自动补兜底 MATCH', () => {
const next = applySubRules(managed(), 'test1', ['DOMAIN-SUFFIX,lan,DIRECT'])
const listener = listenerOf(next)
expect(listener.rule).toBe(subRuleName('test1'))
expect(listener.proxy).toBeUndefined()
expect((next['sub-rules'] as ConfigObject)[subRuleName('test1')]).toEqual([
'DOMAIN-SUFFIX,lan,DIRECT',
'MATCH,patchbay:test1',
])
})
it('读出来不含兜底 MATCH,往返一致', () => {
const rules = ['DOMAIN-SUFFIX,lan,DIRECT', 'GEOIP,CN,DIRECT']
const next = applySubRules(managed(), 'test1', rules)
expect(readSubRules(next, 'test1')).toEqual(rules)
expect(readSubRules(managed(), 'test1')).toEqual([])
})
it('清空后恢复 proxy 直连形态,sub-rules 键整个消失', () => {
const withRules = applySubRules(managed(), 'test1', ['GEOIP,CN,DIRECT'])
const cleared = applySubRules(withRules, 'test1', [])
const listener = listenerOf(cleared)
expect(listener.proxy).toBe(proxyGroupName('test1'))
expect(listener.rule).toBeUndefined()
expect(cleared['sub-rules']).toBeUndefined()
})
it('rule 形态仍被认成 Patchbay 接线,重建设置不会把 proxy 加回来', () => {
// proxy 会短路规则匹配(tunnel.go:318-325),加回来附加规则就静默失效了
const withRules = applySubRules(managed(), 'test1', ['GEOIP,CN,DIRECT'])
const inbound = collectInbounds(withRules).find((i) => i.name === 'test1')!
expect(managedWiring(withRules, inbound)).toBe(true)
const rebuilt = syncGenerated(withRules, collectInbounds(withRules))
const listener = listenerOf(rebuilt)
expect(listener.rule).toBe(subRuleName('test1'))
expect(listener.proxy).toBeUndefined()
})
it('rule 形态下专属组靠表底 MATCH 活着,不会被当孤儿清掉', () => {
const withRules = applySubRules(managed(), 'test1', ['GEOIP,CN,DIRECT'])
const pruned = pruneGenerated(withRules)
const groupNames = (pruned['proxy-groups'] as ConfigObject[]).map((g) => g.name)
expect(groupNames).toContain(proxyGroupName('test1'))
})
it('删掉入站后,附加规则表和组连锁消失', () => {
const withRules = applySubRules(managed(), 'test1', ['GEOIP,CN,DIRECT'])
const removed: ConfigObject = { ...withRules, listeners: [] }
const cleaned = pruneGenerated(removed)
expect(cleaned['sub-rules']).toBeUndefined()
expect(cleaned['proxy-groups']).toBeUndefined()
})
it('用户自己的 sub-rules 表不被清理', () => {
const data: ConfigObject = { ...base(), 'sub-rules': { mine: ['MATCH,DIRECT'] } }
expect((pruneGenerated(data)['sub-rules'] as ConfigObject).mine).toBeDefined()
})
})
describe('legacy 入站升级', () => {
/** 形状仿照目标机器:一个 legacy 混合端口,全局规则是内网直连加 MATCH 兜底。 */
function legacyBase(): ConfigObject {
return {
'mixed-port': 7890,
'allow-lan': true,
'proxy-providers': {
subs: { type: 'http', url: URL, path: './providers/subs.yaml' },
other: { type: 'http', url: `${URL}2`, path: './providers/other.yaml' },
},
'proxy-groups': [{ name: 'PROXY', type: 'select', proxies: ['DIRECT'], use: ['subs'] }],
rules: [
'IP-CIDR,192.168.0.0/16,DIRECT,no-resolve',
'MATCH,PROXY',
'DOMAIN,dead.example,DIRECT',
],
}
}
const legacyInbound = (data: ConfigObject) => collectInbounds(data).find((i) => i.isDefault)!
it('删掉顶层键,建同端口的命名入站,listen 按 allow-lan 推导写死', () => {
const data = legacyBase()
const next = upgradeLegacyInbound(data, legacyInbound(data))!
expect(next['mixed-port']).toBeUndefined()
expect((next.listeners as ConfigObject[]).at(-1)).toMatchObject({
name: 'mixed-port',
type: 'mixed',
port: 7890,
listen: '0.0.0.0',
})
})
it('allow-lan 关着时 listen 写 127.0.0.1', () => {
const data = { ...legacyBase(), 'allow-lan': false }
const next = upgradeLegacyInbound(data, legacyInbound(data))!
expect(((next.listeners as ConfigObject[]).at(-1) as ConfigObject).listen).toBe('127.0.0.1')
})
it('全局规则里第一条 MATCH 之前的部分复制成附加规则,全局规则原文不动', () => {
const data = legacyBase()
const next = upgradeLegacyInbound(data, legacyInbound(data))!
expect(readSubRules(next, 'mixed-port')).toEqual(['IP-CIDR,192.168.0.0/16,DIRECT,no-resolve'])
expect(next.rules).toEqual(legacyBase().rules)
})
it('升级完就在专属组模式下,来源照抄 MATCH 目标组的 use', () => {
const data = legacyBase()
const next = upgradeLegacyInbound(data, legacyInbound(data))!
expect(readSetup(next, 'mixed-port')).toEqual({
proxy: { sources: ['subs'], filter: null },
chain: null,
})
expect(managedWiring(next, collectInbounds(next).find((i) => i.name === 'mixed-port')!)).toBe(
true,
)
})
it('MATCH 目标组没有 use 时退回全部订阅', () => {
const data = legacyBase()
;(data['proxy-groups'] as ConfigObject[])[0] = { name: 'PROXY', type: 'select', proxies: ['DIRECT'] }
const next = upgradeLegacyInbound(data, legacyInbound(data))!
expect(readSetup(next, 'mixed-port')?.proxy.sources).toEqual(['subs', 'other'])
})
it('已有同名入站时返回 null,不写出重名的 listener', () => {
const data = { ...legacyBase(), listeners: [{ name: 'mixed-port', type: 'mixed', port: 1 }] }
expect(upgradeLegacyInbound(data, legacyInbound(data))).toBeNull()
})
})