@lancewu602/mihomo-dash 0.0.0-stage → 0.6.1

package/server/tests/rules.test.js

@@ -0,0 +1,463 @@
+/**
+ * 面板管理的规则（server/src/http/rules.js）集成测试。
+ * 用桩 HTTP 服务替代内核（只响应 PUT /configs），验证：只改标记块、保留注释与其余规则、
+ * 自定义规则只收 DOMAIN-SUFFIX（其它类型被拒）、可删、内核重载失败时报错、块空时连标记一起清理；
+ * 以及「系统规则」那几条的启 / 禁（禁用 = 注释掉该行）与改目标。
+ * 运行：npm test
+ */
+import assert from 'node:assert/strict';
+import { after, before, beforeEach, test } from 'node:test';
+import fs from 'node:fs';
+import http from 'node:http';
+import os from 'node:os';
+import path from 'node:path';
+import yaml from 'js-yaml';
+
+const BASE_CONFIG = `# Document: https://wiki.metacubex.one/config/
+mixed-port: 7890
+mode: rule
+
+proxy-groups:
+  - name: 节点选择
+    type: select
+    proxies: [自动选择]
+  # 组注释
+
+rules:
+  # >>> mihomo-dash 自定义规则（这块由面板维护，请通过规则页增删排序）
+  - DOMAIN-SUFFIX,postman.com,节点选择
+  # <<< mihomo-dash 自定义规则
+  - GEOSITE,cn,DIRECT
+  - MATCH,DIRECT
+`;
+
+/** @type {string} */ let tmpDir;
+/** @type {string} */ let cfgDir;
+/** @type {string} */ let cliDir;
+/** @type {import('node:http').Server} */ let server;
+/** @type {boolean} */ let kernelDown = false;
+/** @type {typeof import('../src/http/rules.js')} */ let rules;
+
+const configPath = () => path.join(cfgDir, 'config.yaml');
+const readConfig = () => fs.readFileSync(configPath(), 'utf8');
+/** 代码只认 config.yaml 的 external-controller（环境变量覆盖已去掉），桩内核地址必须写进配置 */
+let stubPort = 0;
+const withKernel = (text) =>
+  `${text}${text.endsWith('\n') ? '' : '\n'}external-controller: 127.0.0.1:${stubPort}\n`;
+const writeConfig = (text) => fs.writeFileSync(configPath(), withKernel(text));
+const parseConfig = () => yaml.load(readConfig());
+/** 面板管理的规则原文（顺序即文件里的顺序） */
+const managed = () => rules.listCustomRules().rules.map((r) => r.raw);
+
+before(async () => {
+  tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'mihomo-dash-rules-'));
+  cfgDir = path.join(tmpDir, 'mihomo');
+  cliDir = path.join(tmpDir, 'cli');
+  fs.mkdirSync(cfgDir, { recursive: true });
+
+  server = http.createServer((_req, res) => {
+    res.writeHead(kernelDown ? 500 : 200, { 'content-type': 'application/json' });
+    res.end(kernelDown ? JSON.stringify({ message: 'mock reload failure' }) : '{}');
+  });
+  await new Promise((resolve) => server.listen(0, '127.0.0.1', resolve));
+
+  // 必须在 import 之前注入环境变量：paths.js / kernel.js 在模块加载时读取
+  process.env.MIHOMO_DIR = cfgDir;
+  process.env.MIHOMO_DASH_DIR = cliDir;
+  stubPort = server.address().port;
+  rules = await import('../src/http/rules.js');
+});
+
+after(() => {
+  server?.close();
+  fs.rmSync(tmpDir, { recursive: true, force: true });
+});
+
+beforeEach(() => {
+  kernelDown = false;
+  writeConfig(BASE_CONFIG);
+});
+
+test('读取：块内条目无论什么类型都纳管，带原文与拆解结果', () => {
+  writeConfig(
+    BASE_CONFIG.replace(
+      '  - DOMAIN-SUFFIX,postman.com,节点选择\n',
+      '  - DOMAIN-SUFFIX,postman.com,节点选择\n  - GEOSITE,gfw,节点选择\n  - MATCH,DIRECT\n',
+    ),
+  );
+
+  const data = rules.listCustomRules();
+  assert.equal(data.exists, true);
+  assert.deepEqual(data.rules, [
+    {
+      raw: 'DOMAIN-SUFFIX,postman.com,节点选择',
+      type: 'DOMAIN-SUFFIX',
+      payload: 'postman.com',
+      target: '节点选择',
+    },
+    { raw: 'GEOSITE,gfw,节点选择', type: 'GEOSITE', payload: 'gfw', target: '节点选择' },
+    { raw: 'MATCH,DIRECT', type: 'MATCH', payload: '', target: 'DIRECT' },
+  ]);
+  // total 是 rules 段条目总数（含块外的 GEOSITE,cn 与 MATCH）
+  assert.equal(data.total, 5);
+});
+
+test('读取：没有标记块时 exists=false', () => {
+  writeConfig('rules:\n  - MATCH,DIRECT\n');
+  const data = rules.listCustomRules();
+  assert.equal(data.exists, false);
+  assert.deepEqual(data.rules, []);
+  assert.equal(data.total, 1);
+});
+
+test('新增：默认插到第一条 MATCH 之前（写它后面不会生效），保留注释与其它段落', async () => {
+  const r = await rules.addRule({
+    type: 'DOMAIN-SUFFIX',
+    payload: 'Example.COM',
+    target: '节点选择',
+  });
+
+  assert.equal(r.rule, 'DOMAIN-SUFFIX,example.com,节点选择'); // 域名统一小写
+  assert.equal(r.insertedBefore, null, '块内没有 MATCH 时追加到末尾');
+  assert.deepEqual(parseConfig().rules, [
+    'DOMAIN-SUFFIX,postman.com,节点选择',
+    'DOMAIN-SUFFIX,example.com,节点选择',
+    'GEOSITE,cn,DIRECT',
+    'MATCH,DIRECT',
+  ]);
+
+  // 新行落在两行标记之间；注释与其它段落原样保留
+  const text = readConfig();
+  const lines = text.split('\n');
+  const added = lines.indexOf('  - DOMAIN-SUFFIX,example.com,节点选择');
+  assert.ok(added > lines.findIndex((l) => l.includes('>>> mihomo-dash')));
+  assert.ok(added < lines.indexOf('  # <<< mihomo-dash 自定义规则'));
+  assert.match(text, /# Document: https:\/\/wiki\.metacubex\.one/);
+  assert.match(text, /# 组注释/);
+  assert.deepEqual(parseConfig()['proxy-groups'], yaml.load(BASE_CONFIG)['proxy-groups']);
+});
+
+test('新增：块内已经有 MATCH 时插到它之前', async () => {
+  writeConfig(
+    BASE_CONFIG.replace(
+      '  - DOMAIN-SUFFIX,postman.com,节点选择\n',
+      '  - DOMAIN-SUFFIX,postman.com,节点选择\n  - MATCH,DIRECT\n',
+    ),
+  );
+
+  const r = await rules.addRule({ type: 'DOMAIN-SUFFIX', payload: 'github.com', target: 'DIRECT' });
+  assert.equal(r.insertedBefore, 'MATCH,DIRECT');
+  assert.deepEqual(managed(), [
+    'DOMAIN-SUFFIX,postman.com,节点选择',
+    'DOMAIN-SUFFIX,github.com,DIRECT',
+    'MATCH,DIRECT',
+  ]);
+});
+
+test('新增：只接受 DOMAIN-SUFFIX，其它类型一律拒绝且不改文件', async () => {
+  // 先把底里那条 MATCH 去掉，避免兜底规则干扰
+  writeConfig(
+    'rules:\n  # >>> mihomo-dash 自定义规则\n  - DOMAIN-SUFFIX,postman.com,节点选择\n  # <<< mihomo-dash 自定义规则\n',
+  );
+  const before = readConfig();
+
+  for (const input of [
+    { type: 'geosite', payload: 'category-ai-!cn', target: '节点选择' },
+    { type: 'GEOIP', payload: 'private', target: 'DIRECT' },
+    { type: 'MATCH', target: '节点选择' },
+    { rule: 'GEOSITE,cn,DIRECT' },
+    { rule: 'IP-CIDR,1.1.1.0/24,DIRECT,no-resolve' },
+  ]) {
+    await assert.rejects(() => rules.addRule(input), /面板只加 DOMAIN-SUFFIX 规则/);
+  }
+  assert.equal(readConfig(), before, '被拒的请求不能改文件');
+
+  // DOMAIN-SUFFIX 照旧：整行原文可以，省略 type 也默认 DOMAIN-SUFFIX
+  writeConfig('rules:\n  - MATCH,DIRECT\n');
+  await rules.addRule({ rule: 'DOMAIN-SUFFIX,raw.com,DIRECT' });
+  await rules.addRule({ payload: 'added.com', target: 'REJECT' });
+  assert.deepEqual(parseConfig().rules, [
+    'DOMAIN-SUFFIX,raw.com,DIRECT',
+    'DOMAIN-SUFFIX,added.com,REJECT',
+    'MATCH,DIRECT',
+  ]);
+  assert.deepEqual(managed(), ['DOMAIN-SUFFIX,raw.com,DIRECT', 'DOMAIN-SUFFIX,added.com,REJECT']);
+});
+
+test('新增：没有标记块时在 rules 段首创建块', async () => {
+  writeConfig(
+    BASE_CONFIG.replace(/ {2}# >>>.*\n {2}# <<<.*\n/, '').replace(
+      '  - DOMAIN-SUFFIX,postman.com,节点选择\n',
+      '',
+    ),
+  );
+
+  await rules.addRule({ type: 'DOMAIN-SUFFIX', payload: 'github.com', target: 'DIRECT' });
+
+  const lines = readConfig().split('\n');
+  const begin = lines.findIndex((l) => l.includes('>>> mihomo-dash'));
+  assert.deepEqual(lines.slice(begin, begin + 3), [
+    '  # >>> mihomo-dash 自定义规则（这块由面板维护，请通过规则页增删排序）',
+    '  - DOMAIN-SUFFIX,github.com,DIRECT',
+    '  # <<< mihomo-dash 自定义规则',
+  ]);
+  assert.deepEqual(parseConfig().rules, [
+    'DOMAIN-SUFFIX,github.com,DIRECT',
+    'GEOSITE,cn,DIRECT',
+    'MATCH,DIRECT',
+  ]);
+});
+
+test('新增：rules: [] 流式空段也能写入', async () => {
+  writeConfig('mode: rule\nrules: []\n');
+  await rules.addRule({ type: 'DOMAIN-SUFFIX', payload: 'a.com', target: 'REJECT' });
+  assert.deepEqual(parseConfig().rules, ['DOMAIN-SUFFIX,a.com,REJECT']);
+  assert.match(readConfig(), /^rules:$/m);
+});
+
+test('新增校验：重复 / 非法类型 / 非法域名 / 空参数 / 空目标 / 无 rules 段都拒绝且不改文件', async () => {
+  const before = readConfig();
+  await assert.rejects(
+    () => rules.addRule({ type: 'DOMAIN-SUFFIX', payload: 'postman.com', target: 'DIRECT' }),
+    /规则已存在/,
+  );
+  await assert.rejects(
+    () => rules.addRule({ type: 'BAD TYPE', payload: 'x', target: 'DIRECT' }),
+    /面板只加 DOMAIN-SUFFIX 规则/,
+  );
+  await assert.rejects(
+    () => rules.addRule({ type: 'DOMAIN-SUFFIX', payload: 'not a domain', target: 'DIRECT' }),
+    /域名不合法/,
+  );
+  await assert.rejects(
+    () => rules.addRule({ type: 'DOMAIN-SUFFIX', payload: '', target: 'DIRECT' }),
+    /域名不能为空/,
+  );
+  assert.throws(() => rules.normalizeDomain(''), /域名不能为空/);
+  await assert.rejects(
+    () => rules.addRule({ type: 'GEOSITE', payload: 'cn', target: 'DIRECT' }),
+    /面板只加 DOMAIN-SUFFIX 规则/,
+  );
+  await assert.rejects(() => rules.addRule({ rule: 'GEOSITE只有一段' }), /规则格式不对/);
+  await assert.rejects(
+    () => rules.addRule({ type: 'DOMAIN-SUFFIX', payload: 'a.com', target: '' }),
+    /目标不能为空/,
+  );
+  await assert.rejects(
+    () => rules.addRule({ type: 'DOMAIN-SUFFIX', payload: 'a.com', target: 'a,b' }),
+    /不能包含/,
+  );
+  assert.equal(readConfig(), before, '被拒的请求不能改文件');
+
+  writeConfig('mode: rule\n');
+  await assert.rejects(
+    () => rules.addRule({ type: 'DOMAIN-SUFFIX', payload: 'a.com', target: 'DIRECT' }),
+    /未找到 rules 段/,
+  );
+});
+
+test('新增：内核热重载失败时报错，config.yaml 停在新内容', async () => {
+  kernelDown = true;
+  await assert.rejects(
+    () => rules.addRule({ type: 'DOMAIN-SUFFIX', payload: 'rollback.com', target: 'DIRECT' }),
+    /热重载失败/,
+  );
+  kernelDown = false;
+  assert.match(readConfig(), /DOMAIN-SUFFIX,rollback.com,DIRECT/);
+});
+
+test('删除：按原文移除块内条目，保留其余规则与注释', async () => {
+  const r = await rules.removeRule({ raw: 'DOMAIN-SUFFIX,postman.com,节点选择' });
+
+  assert.equal(r.rule, 'DOMAIN-SUFFIX,postman.com,节点选择');
+  assert.deepEqual(parseConfig().rules, ['GEOSITE,cn,DIRECT', 'MATCH,DIRECT']);
+  const text = readConfig();
+  assert.match(text, /# 组注释/);
+  // 块内已无条目：起始 / 结束标记一并移除，不留空块
+  assert.equal(text.includes('>>> mihomo-dash'), false);
+  assert.equal(text.includes('<<< mihomo-dash'), false);
+});
+
+test('删除：块内还有其它条目时保留标记与相邻条目（删 GEOSITE 也行）', async () => {
+  writeConfig(
+    BASE_CONFIG.replace(
+      '  - DOMAIN-SUFFIX,postman.com,节点选择\n',
+      '  - DOMAIN-SUFFIX,postman.com,节点选择\n  - GEOSITE,gfw,节点选择\n',
+    ),
+  );
+
+  await rules.removeRule({ raw: 'GEOSITE,gfw,节点选择' });
+
+  const text = readConfig();
+  assert.match(text, />>> mihomo-dash/);
+  assert.match(text, /<<< mihomo-dash/);
+  assert.deepEqual(managed(), ['DOMAIN-SUFFIX,postman.com,节点选择']);
+  assert.deepEqual(parseConfig().rules, [
+    'DOMAIN-SUFFIX,postman.com,节点选择',
+    'GEOSITE,cn,DIRECT',
+    'MATCH,DIRECT',
+  ]);
+});
+
+test('删除：找不到 / 没有块时报错', async () => {
+  await assert.rejects(() => rules.removeRule({ raw: 'DOMAIN-SUFFIX,nope.com,DIRECT' }), /未找到/);
+  await assert.rejects(() => rules.removeRule({}), /缺少要删除的规则/);
+
+  writeConfig('rules:\n  - MATCH,DIRECT\n');
+  await assert.rejects(() => rules.removeRule({ raw: 'MATCH,DIRECT' }), /没有面板管理的规则块/);
+});
+
+test('删除：rules 段只剩最后一条时连同段头一起移除', async () => {
+  writeConfig(
+    'mode: rule\nrules:\n  # >>> mihomo-dash 自定义规则\n  - DOMAIN-SUFFIX,only.com,DIRECT\n  # <<< mihomo-dash 自定义规则\n',
+  );
+
+  await rules.removeRule({ raw: 'DOMAIN-SUFFIX,only.com,DIRECT' });
+
+  assert.equal(readConfig().includes('rules'), false);
+  assert.equal(parseConfig().mode, 'rule');
+});
+
+test('系统规则：读出固定清单在当前配置里的状态（含被注释掉的 = 已禁用）', () => {
+  writeConfig(
+    [
+      'proxy-groups:',
+      '  - name: 节点选择',
+      '    type: select',
+      '    proxies: [DIRECT]',
+      'rules:',
+      '  # >>> mihomo-dash 自定义规则（这块由面板维护，请通过规则页增删排序）',
+      '  - DOMAIN-SUFFIX,postman.com,节点选择',
+      '  # <<< mihomo-dash 自定义规则',
+      '  - GEOSITE,private,DIRECT',
+      '  # - GEOSITE,category-ads-all,REJECT',
+      '  - GEOSITE,gfw,节点选择',
+      '  - MATCH,DIRECT',
+      '',
+    ].join('\n'),
+  );
+  const { rules: list } = rules.listSystemRules();
+  assert.deepEqual(
+    list.map((r) => [r.key, r.enabled, r.target]),
+    [
+      ['private', true, 'DIRECT'],
+      ['ads', false, 'REJECT'], // 被注释掉的那行：内容还能读出来
+      ['cn', false, 'DIRECT'], // 配置里没有：cn 本来就是直连，默认目标 DIRECT
+      ['gfw', true, '节点选择'],
+      ['scholar', false, '节点选择'], // 配置里没有：这三条默认走第一个策略组
+      ['ai', false, '节点选择'],
+      ['match', true, 'DIRECT'],
+    ],
+  );
+  assert.equal(list.find((r) => r.key === 'match').locked, true);
+});
+
+test('系统规则：禁用 = 把那行注释掉（内容留着），启用 = 原样放开', async () => {
+  writeConfig('rules:\n  - GEOSITE,gfw,节点选择\n  - MATCH,DIRECT\n');
+  await rules.setSystemRule({ key: 'gfw', enabled: false });
+
+  const text = readConfig();
+  assert.match(text, /^ {2}# - GEOSITE,gfw,节点选择$/m);
+  assert.deepEqual(parseConfig().rules, ['MATCH,DIRECT']); // 解析结果里它消失了 = 不再生效
+
+  await rules.setSystemRule({ key: 'gfw', enabled: true });
+  assert.match(readConfig(), /^ {2}- GEOSITE,gfw,节点选择$/m);
+  assert.deepEqual(parseConfig().rules, ['GEOSITE,gfw,节点选择', 'MATCH,DIRECT']);
+});
+
+test('系统规则：配置里没有那一条时，启用会按固定顺序插到合适位置', async () => {
+  writeConfig('rules:\n  - GEOSITE,cn,DIRECT\n  - MATCH,DIRECT\n');
+  await rules.setSystemRule({ key: 'gfw', enabled: true, target: '节点选择' });
+  // private → ads → cn → gfw → scholar → ai → MATCH：gfw 排在 cn 之后、MATCH 之前
+  assert.deepEqual(parseConfig().rules, [
+    'GEOSITE,cn,DIRECT',
+    'GEOSITE,gfw,节点选择',
+    'MATCH,DIRECT',
+  ]);
+
+  await rules.setSystemRule({ key: 'private', enabled: true, target: 'DIRECT' });
+  assert.deepEqual(parseConfig().rules, [
+    'GEOSITE,private,DIRECT',
+    'GEOSITE,cn,DIRECT',
+    'GEOSITE,gfw,节点选择',
+    'MATCH,DIRECT',
+  ]);
+  // 只改目标，不动启停状态
+  await rules.setSystemRule({ key: 'gfw', target: '备用组' });
+  assert.deepEqual(parseConfig().rules, [
+    'GEOSITE,private,DIRECT',
+    'GEOSITE,cn,DIRECT',
+    'GEOSITE,gfw,备用组',
+    'MATCH,DIRECT',
+  ]);
+});
+
+test('系统规则：MATCH 不能禁用；未知 key / 空目标都拒绝且不改文件', async () => {
+  writeConfig('rules:\n  - GEOSITE,gfw,节点选择\n  - MATCH,DIRECT\n');
+  const before = readConfig();
+  await assert.rejects(
+    () => rules.setSystemRule({ key: 'match', enabled: false }),
+    /兜底规则，不能禁用/,
+  );
+  await assert.rejects(() => rules.setSystemRule({ key: 'nope', enabled: true }), /未知的系统规则/);
+  await assert.rejects(() => rules.setSystemRule({ key: 'gfw', target: '  ' }), /目标不能为空/);
+  assert.equal(readConfig(), before);
+  // 禁用一条本来就没启用的：不用写盘
+  const r = await rules.setSystemRule({ key: 'cn', enabled: false });
+  assert.equal(r.enabled, false);
+  assert.equal(readConfig(), before);
+});
+
+test('config.yaml 还不存在时：系统规则照样列全（都算未启用），自定义规则为空，不报错', () => {
+  fs.rmSync(configPath(), { force: true });
+  try {
+    const sys = rules.listSystemRules();
+    assert.equal(sys.rules.length, 7);
+    assert.deepEqual(
+      sys.rules.map((r) => r.enabled),
+      [false, false, false, false, false, false, false],
+    );
+    // 目标回落：直连/拒绝那几条用自己的默认值，走代理的三条没组可退 → DIRECT
+    assert.deepEqual(
+      sys.rules.map((r) => r.target),
+      ['DIRECT', 'REJECT', 'DIRECT', 'DIRECT', 'DIRECT', 'DIRECT', 'DIRECT'],
+    );
+    assert.deepEqual(rules.listCustomRules(), { exists: false, rules: [], total: 0 });
+  } finally {
+    writeConfig(BASE_CONFIG);
+  }
+});
+
+test('缩进 0 的列表写法：自定义规则与系统规则的启 / 禁都保住原缩进', async () => {
+  writeConfig(`mixed-port: 7890
+proxy-groups:
+- name: 节点选择
+  type: select
+  proxies: [DIRECT]
+rules:
+- MATCH,节点选择
+`);
+
+  // 新建标记块 + 新增规则：缩进跟着 rules 段里现有条目（0）
+  await rules.addRule({ rule: 'DOMAIN-SUFFIX,a.com,DIRECT' });
+  let text = readConfig();
+  assert.match(text, /^# >>> mihomo-dash 自定义规则/m);
+  assert.match(text, /^- DOMAIN-SUFFIX,a\.com,DIRECT$/m);
+  assert.deepEqual(managed(), ['DOMAIN-SUFFIX,a.com,DIRECT']);
+
+  // 系统规则：启用插到 MATCH 之前（indent 0），禁用写成同缩进的注释
+  await rules.setSystemRule({ key: 'gfw', enabled: true, target: '节点选择' });
+  text = readConfig();
+  assert.match(text, /^- GEOSITE,gfw,节点选择\n- MATCH,节点选择$/m);
+  assert.deepEqual(parseConfig().rules, [
+    'DOMAIN-SUFFIX,a.com,DIRECT',
+    'GEOSITE,gfw,节点选择',
+    'MATCH,节点选择',
+  ]);
+
+  await rules.setSystemRule({ key: 'gfw', enabled: false });
+  text = readConfig();
+  assert.match(text, /^# - GEOSITE,gfw,节点选择$/m, '禁用行也用缩进 0');
+  assert.deepEqual(parseConfig().rules, ['DOMAIN-SUFFIX,a.com,DIRECT', 'MATCH,节点选择']);
+  assert.equal(rules.listSystemRules().rules.find((r) => r.key === 'gfw').enabled, false);
+});