@lancewu602/mihomo-dash 0.0.0-stage → 0.6.1

package/server/tests/service.test.js

@@ -0,0 +1,470 @@
+/**
+ * 开机自启（server/src/shared/service.js）单元测试。
+ *
+ * 全部用桩执行器 + 临时 HOME / 状态目录，**不碰本机的 launchd / systemd**：
+ * 只断言生成的服务定义内容与真实 argv（固定 argv、不经 shell）。
+ * 运行：npm test
+ */
+import assert from 'node:assert/strict';
+import { after, before, test } from 'node:test';
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+import {
+  createServiceManager,
+  parseLaunchctlPrint,
+  parseSystemctlState,
+  renderPlist,
+  renderUnit,
+} from '../src/shared/service.js';
+
+/** @type {string} */ let tmpDir;
+/** @type {string} */ let home;
+/** @type {string} */ let cliDir;
+
+const ENTRIES = {
+  panel: '/opt/mihomo-dash/server/src/index.js',
+  kernel: '/opt/mihomo-dash/server/src/kernel/run.js',
+};
+
+const OPTS = () => ({
+  node: '/usr/local/bin/node',
+  entries: ENTRIES,
+  cliDir,
+  port: 8981,
+  host: '127.0.0.1',
+});
+
+/**
+ * 桩执行器：记录每次真实 argv，按 `cmd 子命令` 或 `cmd` 取预设返回值。
+ * @param {Record<string, any>} [handlers]
+ */
+function stubRun(handlers = {}) {
+  const calls = [];
+  const run = (cmd, args) => {
+    calls.push([cmd, ...args]);
+    const h = handlers[`${cmd} ${args[0]}`] ?? handlers[cmd];
+    if (typeof h === 'function') return h(args);
+    if (h) return h;
+    return { ok: true, status: 0, stdout: '', stderr: '' };
+  };
+  return { run, calls };
+}
+
+const ok = (stdout = '') => ({ ok: true, status: 0, stdout, stderr: '' });
+const fail = (stderr = 'boom') => ({ ok: false, status: 5, stdout: '', stderr });
+const plistFile = (label) => path.join(home, 'Library', 'LaunchAgents', `${label}.plist`);
+const unitFile = (unit) => path.join(home, '.config', 'systemd', 'user', unit);
+
+before(() => {
+  tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'mihomo-dash-service-'));
+  home = path.join(tmpDir, 'home');
+  cliDir = path.join(tmpDir, 'cli');
+  fs.mkdirSync(home, { recursive: true });
+  fs.mkdirSync(cliDir, { recursive: true });
+});
+
+after(() => fs.rmSync(tmpDir, { recursive: true, force: true }));
+
+test('plist：固定 argv 指向 job 自己的入口脚本，RunAtLoad 有、KeepAlive 没有（只开机起一次）', () => {
+  const panel = renderPlist('panel', OPTS());
+  assert.match(panel, /<key>Label<\/key>\s*<string>com\.mihomo-dash\.panel<\/string>/);
+  assert.match(
+    panel,
+    /<string>\/usr\/local\/bin\/node<\/string>\s*<string>\/opt\/mihomo-dash\/server\/src\/index\.js<\/string>\s*<string>--port<\/string>\s*<string>8981<\/string>\s*<string>--host<\/string>\s*<string>127\.0\.0\.1<\/string>/,
+  );
+  assert.match(panel, /<key>RunAtLoad<\/key>\s*<true\/>/);
+  // 只开机起一次：不能出现 KeepAlive 键（注释里提到这个词不算）
+  assert.doesNotMatch(panel, /<key>KeepAlive<\/key>/);
+  assert.doesNotMatch(renderUnit('panel', OPTS()), /Restart=(always|on-failure)/);
+  assert.match(panel, new RegExp(`daemon\\.log`));
+  // 内核那个 job 只带 kernel，不带端口
+  const kernel = renderPlist('kernel', OPTS());
+  assert.doesNotMatch(kernel, /--port/);
+  assert.match(kernel, /kernel\.log/);
+  // kernel job 没有额外参数：argv 就是 node + 内核入口脚本
+  assert.match(
+    kernel,
+    /<string>\/usr\/local\/bin\/node<\/string>\s*<string>\/opt\/mihomo-dash\/server\/src\/kernel\/run\.js<\/string>\s*<\/array>/,
+  );
+  // CLI 里已经没 service 子命令了，服务定义只能指向 runner 脚本
+  assert.doesNotMatch(panel + kernel, /<string>service<\/string>/);
+  // 「登录项 → 允许在后台」靠这个键认领归属（不写就显示成 node 的 Node.js Foundation）
+  for (const text of [panel, kernel]) {
+    assert.match(
+      text,
+      /<key>AssociatedBundleIdentifiers<\/key>\s*<array>\s*<string>com\.mihomo-dash<\/string>/,
+    );
+  }
+});
+
+test('plist：路径里的 XML 特殊字符会被转义', () => {
+  const text = renderPlist('panel', { ...OPTS(), cliDir: '/tmp/a & b<c>d' });
+  assert.match(text, /\/tmp\/a &amp; b&lt;c&gt;d/);
+  assert.doesNotMatch(text, /& b<c>/);
+});
+
+test('systemd 单元：ExecStart 固定 argv、Restart=no、日志 append', () => {
+  const unit = renderUnit('panel', OPTS());
+  assert.match(unit, /^# 由 `mihomo-dash service install` 生成/m);
+  assert.match(unit, /Description=mihomo-dash 面板/);
+  assert.match(
+    unit,
+    /ExecStart=\/usr\/local\/bin\/node \/opt\/mihomo-dash\/server\/src\/index\.js --port 8981 --host 127\.0\.0\.1/,
+  );
+  assert.match(unit, /Restart=no/);
+  assert.match(unit, /WantedBy=default\.target/);
+  assert.match(unit, new RegExp(`StandardOutput=append:${cliDir}/daemon\\.log`));
+  // 含空格的路径要加引号，否则 systemd 会把参数拆开
+  const quoted = renderUnit('kernel', {
+    ...OPTS(),
+    entries: { ...ENTRIES, kernel: '/opt/my dash/server/src/kernel/run.js' },
+  });
+  assert.match(
+    quoted,
+    /ExecStart=\/usr\/local\/bin\/node "\/opt\/my dash\/server\/src\/kernel\/run\.js"/,
+  );
+});
+
+test('macOS 安装：写两个 plist，launchctl bootstrap 走 gui 域，全程不经 shell', async () => {
+  // 全新安装：两个 job 都还没装载
+  const { run, calls } = stubRun({ 'launchctl print': () => fail('Could not find service') });
+  const svc = createServiceManager({
+    run,
+    platform: 'darwin',
+    home,
+    cliDir,
+    uid: 501,
+    node: OPTS().node,
+    entries: ENTRIES,
+  });
+  const res = await svc.install({ port: 8981, host: '127.0.0.1' });
+
+  assert.deepEqual(res.errors, []);
+  assert.ok(fs.existsSync(plistFile('com.mihomo-dash.panel')));
+  assert.ok(fs.existsSync(plistFile('com.mihomo-dash.kernel')));
+  assert.ok(res.files.length === 2);
+  assert.deepEqual(
+    calls.find((c) => c[0] === 'launchctl' && c[1] === 'bootstrap'),
+    ['launchctl', 'bootstrap', 'gui/501', plistFile('com.mihomo-dash.panel')],
+  );
+  // 安装不 bootout：那会当场杀掉正在服务这个请求的面板
+  assert.ok(!calls.some((c) => c[1] === 'bootout'));
+  // 固定 argv：命令只有 launchctl，没有 sh -c 这类拼接
+  assert.deepEqual([...new Set(calls.map((c) => c[0]))], ['launchctl']);
+  assert.ok(calls.every((c) => c.slice(1).every((a) => typeof a === 'string')));
+  assert.equal(res.loadedIn.panel, 'gui/501');
+  assert.match(res.hints.join('\n'), /Node 固定为 \/usr\/local\/bin\/node/);
+});
+
+test('macOS 安装：已装载的 job 不 bootout，只更新定义并说明下次登录生效', async () => {
+  const { run, calls } = stubRun({ 'launchctl print': () => ok('state = running\n') });
+  const svc = createServiceManager({ run, platform: 'darwin', home, cliDir, uid: 501 });
+  const res = await svc.install();
+  assert.ok(!calls.some((c) => c[1] === 'bootout'));
+  assert.ok(!calls.some((c) => c[1] === 'bootstrap'));
+  assert.match(res.notes.join('\n'), /只更新了定义/);
+  assert.equal(res.loadedIn.panel, 'gui/501');
+});
+
+test('macOS 安装：manualRunning 不影响装载（darwin 一律 bootstrap，「已装载」才是真的）', async () => {
+  const { run, calls } = stubRun({ 'launchctl print': () => fail('Could not find service') });
+  const svc = createServiceManager({ run, platform: 'darwin', home, cliDir, uid: 501 });
+  const res = await svc.install({ manualRunning: ['panel', 'kernel'] });
+  assert.ok(fs.existsSync(plistFile('com.mihomo-dash.panel')));
+  assert.deepEqual(res.errors, []);
+  // manualRunning 只影响 Linux：darwin 两个 job 都 bootstrap（进程会因端口被占自己退出）
+  assert.ok(calls.some((c) => c[1] === 'bootstrap' && /panel/.test(c[3] || '')));
+  assert.ok(calls.some((c) => c[1] === 'bootstrap' && /kernel/.test(c[3] || '')));
+  assert.equal(res.loadedIn.panel, 'gui/501');
+});
+
+test('macOS 安装：gui 域 bootstrap 失败时退到 user 域；失败时只报错不抛异常', async () => {
+  const { run } = stubRun({
+    'launchctl print': () => fail('Could not find service'),
+    'launchctl bootstrap': (args) =>
+      args[1] === 'user/501' ? ok() : fail('Bootstrap failed: 5: Input/output error'),
+  });
+  const svc = createServiceManager({ run, platform: 'darwin', home, cliDir, uid: 501 });
+  const res = await svc.install();
+  assert.equal(res.loadedIn.panel, 'user/501');
+  assert.deepEqual(res.errors, []);
+
+  const broken = createServiceManager({
+    run: stubRun({
+      'launchctl print': () => fail('Could not find service'),
+      'launchctl bootstrap': () => fail('nope'),
+    }).run,
+    platform: 'darwin',
+    home,
+    cliDir,
+    uid: 501,
+  });
+  const res2 = await broken.install();
+  assert.match(res2.errors.join('\n'), /bootstrap 失败/);
+  assert.ok(fs.existsSync(plistFile('com.mihomo-dash.panel')), 'plist 仍然写好，下次登录照样启动');
+});
+
+test('macOS 卸载：只删 plist，不 bootout（不动正在跑的进程）', async () => {
+  const { run, calls } = stubRun({ 'launchctl print': () => fail('Could not find service') });
+  const svc = createServiceManager({ run, platform: 'darwin', home, cliDir, uid: 501 });
+  await svc.install();
+  const res = await svc.uninstall();
+  assert.ok(!calls.some((c) => c[1] === 'bootout'), '卸载不 bootout：会连当前面板的响应一起带走');
+  assert.equal(res.removed.length, 2);
+  assert.ok(!fs.existsSync(plistFile('com.mihomo-dash.panel')));
+  assert.ok(!fs.existsSync(plistFile('com.mihomo-dash.kernel')));
+  assert.match(res.notes.join('\n'), /正在跑的进程没动/);
+  assert.ok(!res.notes.join('\n').includes('还挂着'), '没装载就不该提残留');
+});
+
+test('macOS 卸载：定义删了但 launchd 里仍挂着时，如实说明（不 bootout）', async () => {
+  const { run, calls } = stubRun({ 'launchctl print': () => ok('state = not running\n') });
+  const svc = createServiceManager({ run, platform: 'darwin', home, cliDir, uid: 501 });
+  await svc.install(); // 已装载 → 只更新定义
+  const res = await svc.uninstall();
+  assert.ok(!calls.some((c) => c[1] === 'bootout'), '卸载不 bootout：会连当前面板的响应一起带走');
+  assert.equal(res.removed.length, 2);
+  assert.match(res.notes.join('\n'), /panel: plist 已删，但 launchd 里这个 job 还挂着/);
+  assert.match(res.notes.join('\n'), /重新登录后它就没了/);
+});
+
+test('Linux 安装/卸载：daemon-reload + enable --now / disable（不 --now）', async () => {
+  const { run, calls } = stubRun();
+  const svc = createServiceManager({ run, platform: 'linux', home, cliDir });
+  const res = await svc.install({ port: 8982, host: '0.0.0.0' });
+  assert.deepEqual(res.errors, []);
+  assert.ok(fs.existsSync(unitFile('mihomo-dash-panel.service')));
+  assert.ok(fs.existsSync(unitFile('mihomo-dash-kernel.service')));
+  assert.ok(calls.some((c) => c.join(' ') === 'systemctl --user daemon-reload'));
+  assert.ok(
+    calls.some((c) => c.join(' ') === 'systemctl --user enable --now mihomo-dash-panel.service'),
+  );
+  assert.match(fs.readFileSync(unitFile('mihomo-dash-panel.service'), 'utf8'), /--port 8982/);
+  assert.deepEqual([...new Set(calls.map((c) => c[0]))], ['systemctl']);
+
+  const res2 = await svc.uninstall();
+  assert.equal(res2.removed.length, 2);
+  // disable 不能带 --now：unit 文件与 enable 链接是两回事，disable 才管「下次登录不再拉起」
+  assert.ok(
+    calls.some((c) => c.join(' ') === 'systemctl --user disable mihomo-dash-kernel.service'),
+  );
+  assert.ok(!calls.some((c) => c.includes('--now') && c.includes('disable')));
+});
+
+test('Linux 安装：manualRunning 的 job 只 enable（不 --now），不拉第二个实例', async () => {
+  const { run, calls } = stubRun();
+  const svc = createServiceManager({ run, platform: 'linux', home, cliDir });
+  const res = await svc.install({ manualRunning: ['panel'] });
+  assert.deepEqual(res.errors, []);
+  assert.ok(calls.some((c) => c.join(' ') === 'systemctl --user enable mihomo-dash-panel.service'));
+  assert.ok(
+    !calls.some((c) => c.join(' ') === 'systemctl --user enable --now mihomo-dash-panel.service'),
+  );
+  assert.ok(
+    calls.some((c) => c.join(' ') === 'systemctl --user enable --now mihomo-dash-kernel.service'),
+  );
+  assert.match(res.notes.join('\n'), /正在手动运行/);
+});
+
+test('Linux 状态：is-enabled / is-active 组合出「已装 / 已启用 / 运行中」，并报 linger', async () => {
+  const { run } = stubRun({
+    'systemctl --user': (args) => {
+      const cmd = args[1];
+      if (cmd === 'is-enabled') return ok('enabled');
+      if (cmd === 'is-active') return ok('active');
+      return ok();
+    },
+    loginctl: () => ok('Linger=yes\n'),
+  });
+  const svc = createServiceManager({ run, platform: 'linux', home, cliDir, user: 'didi' });
+  await svc.install();
+  const res = await svc.status();
+  assert.equal(res.linger, true, 'Linger=yes → 开机即起');
+  assert.equal(res.jobs.length, 2);
+  for (const j of res.jobs) {
+    assert.equal(j.installed, true);
+    assert.equal(j.running, true);
+    assert.equal(j.domain, 'systemd --user');
+  }
+
+  const off = createServiceManager({
+    run: stubRun({
+      'systemctl --user': (args) => (args[1] === 'is-enabled' ? ok('disabled') : ok('inactive')),
+      loginctl: () => ok('Linger=no\n'),
+    }).run,
+    platform: 'linux',
+    home,
+    cliDir,
+    user: 'didi',
+  });
+  const res2 = await off.status();
+  assert.equal(res2.jobs[0].installed, true);
+  assert.equal(res2.jobs[0].running, false);
+  assert.equal(res2.linger, false, 'Linger=no → 只会在登录后启动');
+});
+
+test('Linux 没有可用 systemd：如实说不支持，不去装一个注定跑不起来的服务', async () => {
+  const { run } = stubRun({
+    'systemctl --user': () => fail('spawnSync systemctl ENOENT'),
+  });
+  const svc = createServiceManager({ run, platform: 'linux', home, cliDir });
+
+  const st = await svc.status();
+  assert.equal(st.supported, false);
+  assert.deepEqual(st.jobs, []);
+  assert.match(st.hint, /没有可用的 systemd 用户实例/);
+  assert.match(st.hint, /ENOENT/);
+
+  for (const res of [await svc.install(), await svc.uninstall(), await svc.start()]) {
+    assert.equal(res.supported, false, JSON.stringify(res));
+    assert.match(res.hint, /没有可用的 systemd 用户实例/);
+  }
+});
+
+test('Linux 连不上用户实例（容器 / 没有会话）：也算不可用，不静默失败', async () => {
+  const { run } = stubRun({
+    'systemctl --user': () => fail('Failed to connect to bus: No such file or directory'),
+  });
+  const svc = createServiceManager({ run, platform: 'linux', home, cliDir });
+  const st = await svc.status();
+  assert.equal(st.supported, false);
+  assert.match(st.hint, /Failed to connect to bus/);
+  assert.match(st.hint, /先在有用户会话的环境里跑/);
+});
+
+test('macOS 状态：从 launchctl print 读 state / pid；未装载时如实说', async () => {
+  const printPanel = `gui/501/com.mihomo-dash.panel = {
+	active count = 1
+	path = /Users/x/Library/LaunchAgents/com.mihomo-dash.panel.plist
+	state = running
+	program = /usr/local/bin/node
+	arguments = {
+		pid = 4321
+	}
+	last exit code = (never exited)
+}
+`;
+  const { run } = stubRun({
+    'launchctl print': (args) =>
+      args[1].endsWith('com.mihomo-dash.panel') ? ok(printPanel) : fail('Could not find service'),
+  });
+  const svc = createServiceManager({ run, platform: 'darwin', home, cliDir, uid: 501 });
+  await svc.install();
+  const res = await svc.status();
+  const panel = res.jobs.find((j) => j.job === 'panel');
+  const kernel = res.jobs.find((j) => j.job === 'kernel');
+  assert.deepEqual(
+    { loaded: panel.loaded, running: panel.running, pid: panel.pid, domain: panel.domain },
+    { loaded: true, running: true, pid: 4321, domain: 'gui/501' },
+  );
+  assert.deepEqual(
+    { loaded: kernel.loaded, running: kernel.running },
+    { loaded: false, running: false },
+  );
+});
+
+test('service start：未安装时报错提示；已装载时按平台 kickstart / start', async () => {
+  const missing = createServiceManager({
+    run: stubRun().run,
+    platform: 'darwin',
+    home: path.join(tmpDir, 'empty-home'),
+    cliDir,
+    uid: 501,
+  });
+  const res0 = await missing.start('kernel');
+  assert.match(res0.errors.join('\n'), /还没安装开机自启/);
+
+  const { run, calls } = stubRun({ 'launchctl print': () => ok('state = not running\n') });
+  const svc = createServiceManager({ run, platform: 'darwin', home, cliDir, uid: 501 });
+  await svc.install();
+  const res = await svc.start('kernel');
+  assert.deepEqual(res.errors, []);
+  assert.deepEqual(
+    calls.find((c) => c[1] === 'kickstart'),
+    ['launchctl', 'kickstart', 'gui/501/com.mihomo-dash.kernel'],
+  );
+});
+
+test('Windows / 未知平台：不支持，给可执行的提示而不是空白', async () => {
+  const svc = createServiceManager({ run: stubRun().run, platform: 'win32', home, cliDir });
+  assert.equal(svc.supported, false);
+  assert.match(svc.hint, /启动/);
+  const res = await svc.install();
+  assert.equal(res.supported, false);
+  assert.deepEqual(res.files, []);
+  const start = await svc.start();
+  assert.equal(start.supported, false);
+});
+
+test('未知 job 名直接报错，不静默生成一个错文件', () => {
+  assert.throws(() => renderPlist('nope', OPTS()), /未知服务/);
+  assert.throws(() => renderUnit('nope', OPTS()), /未知服务/);
+});
+
+test('解析工具：launchctl print 取第一处 state / pid，systemd 两个查询归一化', () => {
+  const parsed = parseLaunchctlPrint(
+    'gui/501/x = {\n\tstate = running\n\tpid = 99\n\t\tstate = active\n}\n',
+  );
+  assert.deepEqual(parsed, { state: 'running', pid: 99 });
+  assert.deepEqual(parseSystemctlState('enabled', 'active'), {
+    installed: true,
+    enabled: true,
+    active: true,
+    state: 'active',
+  });
+  assert.deepEqual(parseSystemctlState('not-found', 'inactive'), {
+    installed: false,
+    enabled: false,
+    active: false,
+    state: 'inactive',
+  });
+});
+
+test('system 单元（Debian 默认）：写 /etc/systemd/system、不带 --user、multi-user.target', async () => {
+  const { createServiceManager } = await import('../src/shared/service.js');
+  const calls = [];
+  const svc = createServiceManager({
+    platform: 'linux',
+    uid: 0,
+    home,
+    cliDir,
+    systemDir: path.join(tmpDir, 'etc-systemd'),
+    entries: ENTRIES,
+    run: async (cmd, args) => {
+      calls.push([cmd, ...args]);
+      return { ok: true, stdout: '', stderr: '' };
+    },
+  });
+  assert.equal(svc.scope, 'system', 'root 时默认 system');
+
+  const res = await svc.install({ port: 8981, host: '127.0.0.1' });
+
+  assert.deepEqual(res.errors, []);
+  assert.equal(res.scope, 'system');
+  assert.ok(res.files.every((f) => f.startsWith(path.join(tmpDir, 'etc-systemd'))));
+  const unit = fs.readFileSync(res.files[0], 'utf8');
+  assert.match(unit, /WantedBy=multi-user\.target/);
+  assert.match(unit, /作用域：system/);
+  // system 作用域不能出现 --user
+  const systemctl = calls.filter((c) => c[0] === 'systemctl').map((c) => c.slice(1));
+  assert.ok(systemctl.length > 0);
+  assert.ok(
+    systemctl.every((args) => !args.includes('--user')),
+    JSON.stringify(systemctl),
+  );
+  assert.ok(systemctl.some((args) => args.includes('enable') && args.includes('--now')));
+});
+
+test('非 root 且没指定作用域：默认用用户级（不写 /etc）', async () => {
+  const { createServiceManager } = await import('../src/shared/service.js');
+  const svc = createServiceManager({
+    platform: 'linux',
+    uid: 1000,
+    home,
+    cliDir,
+    entries: ENTRIES,
+    run: async () => ({ ok: true, stdout: '', stderr: '' }),
+  });
+  assert.equal(svc.scope, 'user');
+});