@lancewu602/mihomo-dash 0.0.0-stage → 0.6.1

package/server/tests/config-order.test.js

@@ -0,0 +1,148 @@
+/**
+ * config.yaml 顶层键排序（server/src/http/config-order.js + config-files.js 的写入路径）测试。
+ *
+ * 断言的是「只搬位置、不改内容」：键下面的内容、行尾注释、键上方紧贴的说明、文件头注释都得保住，
+ * 块与块之间不留空行；排序结果必须幂等、解析出来跟原文一模一样。
+ * 运行：npm test
+ */
+import assert from 'node:assert/strict';
+import { after, before, 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';
+
+/** @type {Record<string, any>} */ let mods = {};
+/** @type {string} */ let tmpDir;
+/** @type {string} */ let cfgDir;
+/** @type {import('node:http').Server} */ let kernel;
+/** @type {number} */ let stubPort = 0;
+
+const configPath = () => path.join(cfgDir, 'config.yaml');
+const readConfig = () => fs.readFileSync(configPath(), 'utf8');
+const writeConfig = (text) => fs.writeFileSync(configPath(), text);
+/** 桩内核的地址也得写进配置（代码只认 config.yaml 的 external-controller） */
+
+before(async () => {
+  tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'mihomo-dash-order-'));
+  cfgDir = path.join(tmpDir, 'mihomo');
+  fs.mkdirSync(cfgDir, { recursive: true });
+
+  kernel = http.createServer((_req, res) => {
+    res.writeHead(200, { 'content-type': 'application/json' });
+    res.end('{}');
+  });
+  await new Promise((resolve) => kernel.listen(0, '127.0.0.1', resolve));
+  stubPort = kernel.address().port;
+
+  process.env.MIHOMO_DIR = cfgDir;
+  process.env.MIHOMO_DASH_DIR = path.join(tmpDir, 'cli');
+  mods = { order: await import('../src/http/config-order.js') };
+  mods.files = await import('../src/http/config-files.js');
+});
+
+after(async () => {
+  await new Promise((resolve) => kernel.close(resolve));
+  fs.rmSync(tmpDir, { recursive: true, force: true });
+});
+
+test('乱序的顶层键排成固定顺序；内容、注释、缩进一字不改，块之间不留空行', () => {
+  const src = `unified-delay: false
+geox-url:
+  geosite: "https://x/geosite.dat"
+  geoip: "https://x/geoip.dat"
+geo-update-interval: 12
+geodata-mode: true
+mixed-port: 7890
+# 运行模式
+mode: rule
+log-level: warning  # 行尾注释也要留着
+external-controller: 127.0.0.1:8190
+ipv6: true
+
+# ===== 规则 =====
+rules:
+  - MATCH,DIRECT
+`;
+  assert.equal(
+    mods.order.orderTopLevel(src),
+    `mixed-port: 7890
+ipv6: true
+# 运行模式
+mode: rule
+log-level: warning  # 行尾注释也要留着
+unified-delay: false
+external-controller: 127.0.0.1:8190
+geodata-mode: true
+geo-update-interval: 12
+geox-url:
+  geosite: "https://x/geosite.dat"
+  geoip: "https://x/geoip.dat"
+# ===== 规则 =====
+rules:
+  - MATCH,DIRECT
+`,
+  );
+});
+
+test('幂等，且解析结果与原文完全一致（排序只是排版）', () => {
+  const src = `rules:\n  - MATCH,DIRECT\nmixed-port: 7890\nunified-delay: true\ndns:\n  enable: true\n`;
+  const once = mods.order.orderTopLevel(src);
+  assert.equal(mods.order.orderTopLevel(once), once);
+  assert.deepEqual(yaml.load(once), yaml.load(src));
+});
+
+test('文件头注释留在最上面；面板不认识的键排在 rules 前面，保持相对顺序', () => {
+  const src = `# 我的配置\n# 第二行\n\naaa-unknown: 1\nproxy-providers:\n  p:\n    url: x\nbbb-unknown: 2\nrules:\n  - MATCH,DIRECT\n`;
+  assert.equal(
+    mods.order.orderTopLevel(src),
+    `# 我的配置\n# 第二行\nproxy-providers:\n  p:\n    url: x\naaa-unknown: 1\nbbb-unknown: 2\nrules:\n  - MATCH,DIRECT\n`,
+  );
+});
+
+test('块之间不留空行：原文分了块的也压成紧凑写法，块内部空行不动', () => {
+  assert.equal(
+    mods.order.orderTopLevel('rules:\n  - MATCH,DIRECT\n\nmixed-port: 7890\n\nmode: rule\n'),
+    'mixed-port: 7890\nmode: rule\nrules:\n  - MATCH,DIRECT\n',
+  );
+  // 段落里面自己留的空行（这里 dns 内部）不算块间分隔，原样保留
+  assert.equal(
+    mods.order.orderTopLevel('# 头\n\ndns:\n  enable: true\n\n  ipv6: false\nmixed-port: 7890\n'),
+    '# 头\nmixed-port: 7890\ndns:\n  enable: true\n\n  ipv6: false\n',
+  );
+});
+
+test('没有顶层键 / 空文件：原样返回，不抛错', () => {
+  assert.equal(mods.order.orderTopLevel(''), '');
+  assert.equal(mods.order.orderTopLevel('# 只有注释\n'), '# 只有注释\n');
+  assert.equal(mods.order.orderTopLevel('proxies:\n'), 'proxies:\n');
+});
+
+test('安全网：解析结果对不上时放弃排序，绝不拿用户文件冒险', () => {
+  // 同名顶层键在 YAML 里是错的（js-yaml 直接报错）：排序应当被跳过，文件原样写回去
+  const dup = 'mixed-port: 7890\nrules:\n  - MATCH,DIRECT\nmixed-port: 1\n';
+  assert.equal(mods.files.orderedConfigText(dup), dup);
+});
+
+test('写盘路径：saveFile（配置文件页）排 config.yaml，不排 providers/*.yaml', () => {
+  writeConfig('rules:\n  - MATCH,DIRECT\nmixed-port: 7890\n');
+  mods.files.saveFile('config.yaml', readConfig());
+  assert.equal(readConfig(), 'mixed-port: 7890\nrules:\n  - MATCH,DIRECT\n');
+
+  const prov = path.join(cfgDir, 'providers');
+  fs.mkdirSync(prov, { recursive: true });
+  fs.writeFileSync(path.join(prov, 'p.yaml'), 'proxies: []\n');
+  mods.files.saveFile('providers/p.yaml', 'proxies: []\n');
+  assert.equal(fs.readFileSync(path.join(prov, 'p.yaml'), 'utf8'), 'proxies: []\n');
+});
+
+test('写盘路径：saveConfigWithReload（GEO 键走的那条）也会排序 + 发重载请求', async () => {
+  await mods.files.saveConfigWithReload(
+    `rules:\n  - MATCH,DIRECT\nexternal-controller: 127.0.0.1:${stubPort}\n`,
+  );
+  assert.equal(
+    readConfig(),
+    `external-controller: 127.0.0.1:${stubPort}\nrules:\n  - MATCH,DIRECT\n`,
+  );
+});