@lancewu602/mihomo-dash 0.0.0-stage → 0.6.1

package/server/tests/settings.test.js

@@ -0,0 +1,456 @@
+/**
+ * 快捷设置持久化（server/src/http/settings.js）集成测试。
+ * 用桩 HTTP 服务替代内核（记录 PATCH /configs 请求，可切换为失败），验证：
+ * 文本改写保留注释、缺失键插入位置、多键一次写入、非法参数拒绝、内核失败时报错。运行：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 # 运行模式（注释要保留）
+log-level: warning
+allow-lan: false
+
+disable-keep-alive: false
+geodata-mode: false
+geo-auto-update: false
+geo-update-interval: 24
+geox-url:
+  geosite: "https://example.com/geosite.dat" # 站点库（注释要保留）
+  geoip: "https://example.com/geoip.dat"
+
+proxy-providers:
+  airport:
+    type: http
+    url: "https://example.com/link/aaa"
+
+rules:
+  - MATCH,节点选择
+`;
+
+/** 缺 mode / log-level：应插到头部注释块之后 */
+const SPARSE_CONFIG = `# 顶部注释
+# 第二行注释
+
+mixed-port: 7890
+allow-lan: false
+`;
+
+/** @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 {Array<{ method?: string, url: string, body: string }>} */ let requests;
+/** @type {typeof import('../src/http/settings.js')} */ let settings;
+
+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 requestAt = (i = 0) => JSON.parse(requests[i].body);
+const resetConfig = (text = BASE_CONFIG) => writeConfig(text);
+
+before(async () => {
+  tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'mihomo-dash-settings-'));
+  cfgDir = path.join(tmpDir, 'mihomo');
+  cliDir = path.join(tmpDir, 'cli');
+  fs.mkdirSync(cfgDir, { recursive: true });
+
+  server = http.createServer((req, res) => {
+    let body = '';
+    req.on('data', (c) => (body += c));
+    req.on('end', () => {
+      requests.push({ method: req.method, url: req.url || '', body });
+      res.writeHead(kernelDown ? 500 : 200, { 'content-type': 'application/json' });
+      res.end(kernelDown ? JSON.stringify({ message: 'mock patch 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;
+  settings = await import('../src/http/settings.js');
+});
+
+after(() => {
+  server?.close();
+  fs.rmSync(tmpDir, { recursive: true, force: true });
+});
+
+beforeEach(() => {
+  kernelDown = false;
+  requests = [];
+  resetConfig();
+});
+
+test('mode：改写值、保留注释与其余段落、PATCH 运行时生效', async () => {
+  const r = await settings.setSettings({ mode: 'global' });
+
+  assert.deepEqual(r.applied, ['mode']);
+  assert.equal(r.previous.mode, 'rule');
+  assert.equal(r.persisted, true);
+
+  const text = readConfig();
+  assert.match(text, /^# Document: https:\/\/wiki\.metacubex\.one/m);
+  assert.match(text, /mode: global # 运行模式（注释要保留）/); // 注释保留、值被替换
+
+  const doc = parseConfig();
+  assert.equal(doc.mode, 'global');
+  assert.equal(doc['mixed-port'], 7890);
+  assert.equal(doc['allow-lan'], false);
+  assert.deepEqual(doc.rules, ['MATCH,节点选择']); // 其余段落原样
+  assert.equal(doc['proxy-providers'].airport.url, 'https://example.com/link/aaa');
+
+  assert.equal(requests.length, 1);
+  assert.equal(requests[0].method, 'PATCH');
+  assert.equal(requests[0].url, '/configs');
+  assert.deepEqual(requestAt(), { mode: 'global' });
+});
+
+test('多键一次写入：混合类型（数字 / 布尔 / 字符串），一次写盘一次 PATCH', async () => {
+  const r = await settings.setSettings({
+    'mixed-port': 7891,
+    'allow-lan': true,
+    'log-level': 'info',
+  });
+
+  assert.deepEqual(r.applied, ['mixed-port', 'allow-lan', 'log-level']);
+  const doc = parseConfig();
+  assert.equal(doc['mixed-port'], 7891);
+  assert.equal(doc['allow-lan'], true);
+  assert.equal(doc['log-level'], 'info');
+  assert.equal(doc.mode, 'rule');
+  assert.equal(requests.length, 1);
+  assert.deepEqual(requestAt(), { 'mixed-port': 7891, 'allow-lan': true, 'log-level': 'info' });
+});
+
+test('缺键插入：新键落到固定顺序的位置上，文件头注释留在原地', async () => {
+  resetConfig(SPARSE_CONFIG);
+  const r = await settings.setSettings({ 'log-level': 'error', mode: 'direct' });
+
+  assert.deepEqual(r.previous, { 'log-level': null, mode: null });
+  // 文件头注释不动；mixed-port（基础运行）→ mode → log-level（都在基础运行组内）按固定顺序排
+  assert.equal(
+    readConfig(),
+    `# 顶部注释
+# 第二行注释
+mixed-port: 7890
+allow-lan: false
+mode: direct
+log-level: error
+external-controller: 127.0.0.1:${stubPort}
+`,
+  );
+  assert.equal(parseConfig().mode, 'direct');
+  assert.equal(parseConfig()['log-level'], 'error');
+});
+
+test('大小写与空白容忍：GLOBAL → global；INFO → info', async () => {
+  const r = await settings.setSettings({ mode: '  GLOBAL ', 'log-level': ' INFO ' });
+  assert.deepEqual(r.applied, ['mode', 'log-level']);
+  assert.equal(parseConfig().mode, 'global');
+  assert.equal(parseConfig()['log-level'], 'info');
+});
+
+test('非法值：全部拒绝且不改动配置、不请求内核', async () => {
+  const beforeText = readConfig();
+  const bad = [
+    { mode: 'proxy' },
+    { mode: '' },
+    { 'mixed-port': 0 },
+    { 'mixed-port': 65536 },
+    { 'mixed-port': 'abc' },
+    { 'allow-lan': 'yes' },
+    { 'log-level': 'trace' },
+    { unknown: 1 },
+    {},
+    { mode: 'global', 'mixed-port': -1 }, // 任一键非法则整体拒绝
+  ];
+  for (const patch of bad) {
+    await assert.rejects(() => settings.setSettings(patch), /非法|不支持的配置项|未指定/);
+  }
+  assert.equal(readConfig(), beforeText);
+  assert.equal(requests.length, 0);
+});
+
+test('配置已是目标值：不写盘，仅 PATCH 对齐运行时', async () => {
+  const r = await settings.setSettings({ mode: 'rule', 'mixed-port': 7890 });
+  assert.deepEqual(r.applied, []);
+  assert.equal(r.persisted, false);
+  assert.deepEqual(r.previous, { mode: 'rule', 'mixed-port': 7890 });
+  assert.equal(readConfig(), withKernel(BASE_CONFIG));
+  assert.deepEqual(requestAt(), { mode: 'rule', 'mixed-port': 7890 });
+});
+
+test('部分键变化：只改写变化的那一个', async () => {
+  const r = await settings.setSettings({ mode: 'rule', 'allow-lan': true });
+  assert.deepEqual(r.applied, ['allow-lan']);
+  const text = readConfig();
+  assert.match(text, /mode: rule # 运行模式（注释要保留）/); // 未变化的行原样
+  assert.equal(parseConfig()['allow-lan'], true);
+});
+
+test('内核 PATCH 失败：报错，config.yaml 停在新内容', async () => {
+  kernelDown = true;
+  await assert.rejects(() => settings.setSettings({ mode: 'global' }), /内核返回 500/);
+
+  assert.equal(parseConfig().mode, 'global'); // 写盘已完成，失败只发生在运行时应用这一步
+});
+
+test('原配置缺键：新增行写入后 PATCH 失败也不回退', async () => {
+  resetConfig(SPARSE_CONFIG);
+  kernelDown = true;
+  await assert.rejects(() => settings.setSettings({ mode: 'global' }), /内核返回 500/);
+  assert.equal(parseConfig().mode, 'global');
+  assert.match(readConfig(), /^mode: global$/m);
+});
+
+test('tcp-concurrent：PATCH 运行时生效（内核 schema 里有它，不用整包重载）', async () => {
+  const r = await settings.setSettings({ 'tcp-concurrent': true });
+
+  assert.deepEqual(r.applied, ['tcp-concurrent']);
+  assert.equal(r.reloaded, false);
+  assert.equal(parseConfig()['tcp-concurrent'], true);
+  assert.equal(requests.length, 1);
+  assert.equal(requests[0].method, 'PATCH');
+  assert.deepEqual(requestAt(), { 'tcp-concurrent': true });
+});
+
+test('find-process-mode：三个取值都接受、写盘 + PATCH 即时生效（不用重载、不用重启内核）', async () => {
+  for (const mode of ['off', 'strict', 'always']) {
+    resetConfig();
+    requests.length = 0;
+    const r = await settings.setSettings({ 'find-process-mode': mode });
+    assert.deepEqual(r.applied, ['find-process-mode']);
+    assert.equal(r.reloaded, false, `${mode} 不该走整包热重载`);
+    assert.equal(parseConfig()['find-process-mode'], mode);
+    assert.deepEqual(requestAt(), { 'find-process-mode': mode });
+  }
+  // 大小写 / 空白归一化
+  resetConfig();
+  requests.length = 0;
+  await settings.setSettings({ 'find-process-mode': ' ALWAYS ' });
+  assert.equal(parseConfig()['find-process-mode'], 'always');
+});
+
+test('find-process-mode 非法值：拒绝且不改文件', async () => {
+  const before = readConfig();
+  await assert.rejects(
+    () => settings.setSettings({ 'find-process-mode': 'yes' }),
+    /find-process-mode 非法/,
+  );
+  assert.equal(readConfig(), before);
+  assert.equal(requests.length, 0);
+});
+
+test('find-process-mode 已在目标值：不重写文件，只 PATCH 对齐一次运行时', async () => {
+  writeConfig(`${BASE_CONFIG}find-process-mode: always\n`);
+  const before = readConfig();
+  const r = await settings.setSettings({ 'find-process-mode': 'always' });
+  assert.deepEqual(r.applied, []);
+  assert.equal(r.persisted, false);
+  assert.equal(readConfig(), before, '文件不该被重写');
+  // 与其它标量键一致：没变化也会把运行时对齐一次
+  assert.equal(requests.length, 1);
+  assert.deepEqual(requestAt(), { 'find-process-mode': 'always' });
+});
+
+test('unified-delay：PATCH 会被静默忽略，所以走整包热重载', async () => {
+  const r = await settings.setSettings({ 'unified-delay': true });
+
+  assert.deepEqual(r.applied, ['unified-delay']);
+  assert.equal(r.reloaded, true);
+  assert.equal(parseConfig()['unified-delay'], true);
+  assert.equal(requests.length, 1);
+  assert.equal(requests[0].method, 'PUT');
+  assert.equal(requests[0].url, '/configs?force=true');
+});
+
+test('unified-delay 非法值：拒绝且不改文件', async () => {
+  const before = readConfig();
+  await assert.rejects(
+    () => settings.setSettings({ 'unified-delay': 'yes' }),
+    /需为 true \/ false/,
+  );
+  assert.equal(readConfig(), before);
+});
+
+test('GEO 开关与间隔：改写顶层键、保留注释，并整包热重载（PUT /configs?force=true）', async () => {
+  const r = await settings.setSettings({
+    'geodata-mode': true,
+    'geo-auto-update': true,
+    'geo-update-interval': 12,
+  });
+
+  assert.deepEqual(r.applied, ['geodata-mode', 'geo-auto-update', 'geo-update-interval']);
+  assert.equal(r.reloaded, true);
+  assert.equal(r.persisted, true);
+
+  const doc = parseConfig();
+  assert.equal(doc['geodata-mode'], true);
+  assert.equal(doc['geo-auto-update'], true);
+  assert.equal(doc['geo-update-interval'], 12);
+  assert.match(readConfig(), /^# Document: https:\/\/wiki\.metacubex\.one/m);
+
+  assert.equal(requests.length, 1);
+  assert.equal(requests[0].method, 'PUT');
+  assert.equal(requests[0].url, '/configs?force=true');
+});
+
+test('geox-url：就地改写已有子键（保留注释）、新增缺失子键、原样保留其它段落', async () => {
+  const r = await settings.setSettings({
+    'geox-url': {
+      geosite: 'https://cdn.example.com/geosite.dat',
+      mmdb: 'https://cdn.example.com/geoip.metadb',
+    },
+  });
+
+  assert.deepEqual(r.applied, ['geox-url']);
+  assert.equal(r.reloaded, true);
+
+  const text = readConfig();
+  assert.match(text, /geosite: "https:\/\/cdn\.example\.com\/geosite\.dat" # 站点库（注释要保留）/);
+  assert.equal(
+    parseConfig()['geox-url'].geoip,
+    'https://example.com/geoip.dat', // 未提及的子键不动
+  );
+  const geox = parseConfig()['geox-url'];
+  assert.deepEqual(geox, {
+    geosite: 'https://cdn.example.com/geosite.dat',
+    geoip: 'https://example.com/geoip.dat',
+    mmdb: 'https://cdn.example.com/geoip.metadb',
+  });
+  assert.equal(parseConfig()['mixed-port'], 7890);
+  assert.equal(requests[0].url, '/configs?force=true');
+});
+
+test('geox-url：空串删掉子键（回退内核默认），删空后连同段落头一起移除', async () => {
+  const r = await settings.setSettings({ 'geox-url': { geoip: '' } });
+  assert.deepEqual(r.applied, ['geox-url']);
+  assert.deepEqual(Object.keys(parseConfig()['geox-url']), ['geosite']);
+
+  await settings.setSettings({ 'geox-url': { geosite: '' } });
+  assert.equal(parseConfig()['geox-url'], undefined);
+  assert.doesNotMatch(readConfig(), /geox-url/);
+  // 其余段落与注释不受影响
+  assert.match(readConfig(), /^# Document: https:\/\/wiki\.metacubex\.one/m);
+  assert.equal(parseConfig()['mixed-port'], 7890);
+  assert.deepEqual(parseConfig()['proxy-providers'], {
+    airport: { type: 'http', url: 'https://example.com/link/aaa' },
+  });
+});
+
+test('geox-url：段落地不存在时新建块状段落，并落到 GEO 那一组的位置上', async () => {
+  resetConfig(SPARSE_CONFIG);
+  await settings.setSettings({ 'geox-url': { geoip: 'https://cdn.example.com/geoip.dat' } });
+
+  assert.equal(
+    readConfig(),
+    `# 顶部注释
+# 第二行注释
+mixed-port: 7890
+allow-lan: false
+external-controller: 127.0.0.1:${stubPort}
+geox-url:
+  geoip: "https://cdn.example.com/geoip.dat"
+`,
+  );
+  assert.deepEqual(parseConfig()['geox-url'], { geoip: 'https://cdn.example.com/geoip.dat' });
+});
+
+test('geox-url：子键名必须是 config.yaml 里的写法（geo-site / geo-ip 会被拒绝）', async () => {
+  const beforeText = readConfig();
+  await assert.rejects(
+    () => settings.setSettings({ 'geox-url': { 'geo-site': 'https://a.com/x' } }),
+    /不支持的子键/,
+  );
+  assert.equal(readConfig(), beforeText);
+  assert.equal(requests.length, 0);
+});
+
+test('GEO 键已是目标值：不写盘、不请求内核', async () => {
+  const r = await settings.setSettings({
+    'geodata-mode': false,
+    'geo-auto-update': false,
+    'geo-update-interval': 24,
+    'geox-url': { geosite: 'https://example.com/geosite.dat' },
+  });
+  assert.deepEqual(r.applied, []);
+  assert.equal(r.persisted, false);
+  assert.equal(r.reloaded, false);
+  assert.equal(readConfig(), withKernel(BASE_CONFIG));
+  assert.equal(requests.length, 0);
+});
+
+test('GEO 非法值：全部拒绝且不改动配置', async () => {
+  const beforeText = readConfig();
+  const bad = [
+    { 'geodata-mode': 'yes' },
+    { 'geo-auto-update': 1 },
+    { 'geo-update-interval': 0 },
+    { 'geo-update-interval': 721 },
+    { 'geox-url': {} },
+    { 'geox-url': { geoip: 'ftp://a.com/x' } },
+    { 'geox-url': { unknown: 'https://a.com/x' } },
+    { 'geox-url': 'https://a.com/x' },
+  ];
+  for (const patch of bad) {
+    await assert.rejects(() => settings.setSettings(patch), /非法|不支持|未指定/);
+  }
+  assert.equal(readConfig(), beforeText);
+  assert.equal(requests.length, 0);
+});
+
+test('GEO 热重载失败：报错，config.yaml 停在新内容', async () => {
+  kernelDown = true;
+  await assert.rejects(() => settings.setSettings({ 'geodata-mode': true }), /热重载失败/);
+  assert.equal(parseConfig()['geodata-mode'], true);
+});
+
+test('混合键（标量 + GEO）：GEO 键存在时整体走整包热重载', async () => {
+  const r = await settings.setSettings({ mode: 'global', 'geodata-mode': true });
+  assert.deepEqual(r.applied, ['mode', 'geodata-mode']);
+  assert.equal(r.reloaded, true);
+  assert.equal(parseConfig().mode, 'global');
+  assert.equal(requests.length, 1);
+  assert.equal(requests[0].url, '/configs?force=true');
+});
+
+test('内核没在跑（连不上）：写盘照旧成功，返回 reloaded:false + warning（PATCH 与整包重载两条路都一样）', async () => {
+  // 指向没人监听的端口：fetch 直接失败（没有 HTTP 状态码），与「内核回了错」不是一回事。
+  // 这里直接改文件绕过了写盘接口，所以手动清一下控制接口缓存（面板里由 saveFile / saveConfigWithReload 负责）。
+  fs.writeFileSync(
+    configPath(),
+    `mixed-port: 7890
+external-controller: 127.0.0.1:1
+mode: rule
+`,
+  );
+  const { resetControllerCache } = await import('../src/kernel/client.js');
+  resetControllerCache();
+
+  const patched = await settings.setSettings({ mode: 'global' });
+  assert.equal(patched.persisted, true);
+  assert.equal(patched.reloaded, false);
+  assert.match(patched.warning, /内核没在运行/);
+  assert.equal(parseConfig().mode, 'global');
+
+  const reloaded = await settings.setSettings({ 'unified-delay': true });
+  assert.equal(reloaded.persisted, true);
+  assert.equal(reloaded.reloaded, false);
+  assert.match(reloaded.warning, /内核没在运行/);
+  assert.equal(parseConfig()['unified-delay'], true);
+});