@serfab/cadre-host 1.13.0 → 1.15.0

package/src/installer/__tests__/installer.smoke.test.ts

@@ -1,263 +1,184 @@
-import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
-import { existsSync, mkdtempSync, rmSync } from 'node:fs';
-import { tmpdir } from 'node:os';
-import { join } from 'node:path';
-
-import { Installer } from '../index.js';
-import type { ServiceHost, ServiceHostContext, ServiceHostStatus } from '../service-host/types.js';
-
-class FakeServiceHost implements ServiceHost {
-  readonly name = 'cadre-host';
-  installCalls: ServiceHostContext[] = [];
-  uninstallCalls: ServiceHostContext[] = [];
-  installed = false;
-  running = false;
-
-  async install(ctx: ServiceHostContext): Promise<void> {
-    this.installCalls.push(ctx);
-    this.installed = true;
-    this.running = true;
-  }
-  async uninstall(ctx: ServiceHostContext): Promise<void> {
-    this.uninstallCalls.push(ctx);
-    this.installed = false;
-    this.running = false;
-  }
-  async restart(_ctx: ServiceHostContext): Promise<void> {
-    this.running = true;
-  }
-  async status(_ctx: ServiceHostContext): Promise<ServiceHostStatus> {
-    return { installed: this.installed, running: this.running };
-  }
-  renderUnit(_ctx: ServiceHostContext): string | null {
-    return 'rendered-unit';
-  }
-}
-
-describe('Installer smoke', () => {
-  let tmp: string;
-
-  beforeEach(() => {
-    tmp = mkdtempSync(join(tmpdir(), 'cadre-host-installer-smoke-'));
-  });
-
-  afterEach(() => {
-    rmSync(tmp, { recursive: true, force: true });
-  });
-
-  it('install creates config + identity + invokes service-host', async () => {
-    const fake = new FakeServiceHost();
-    const installer = new Installer({ platform: 'linux', installerVersion: 'test-1.0.0' });
-    const result = await installer.install({
-      nonInteractive: true,
-      dataDir: tmp,
-      uiPort: 19999,
-      libp2pPort: 14001,
-      openBrowser: false,
-      noInvite: true,
-      serviceHost: fake,
-    });
-
-    expect(result.dataDir).toBe(tmp);
-    expect(result.uiUrl).toBe('http://127.0.0.1:19999/');
-    expect(result.serviceName).toBe('cadre-host');
-    expect(result.configPath).toBe(join(tmp, 'host.config.json'));
-
-    expect(existsSync(join(tmp, 'host.config.json'))).toBe(true);
-    expect(existsSync(join(tmp, 'identity.key'))).toBe(true);
-    expect(existsSync(join(tmp, 'nat.json'))).toBe(true);
-    expect(existsSync(join(tmp, 'logs'))).toBe(true);
-
-    expect(fake.installCalls).toHaveLength(1);
-    expect(fake.installCalls[0]!.dataDir).toBe(tmp);
-  });
-
-  it('noService writes the data dir without registering a service', async () => {
-    const fake = new FakeServiceHost();
-    const installer = new Installer({ platform: 'linux', installerVersion: 'test-1.0.0' });
-    const result = await installer.install({
-      nonInteractive: true,
-      dataDir: tmp,
-      uiPort: 19995,
-      libp2pPort: 14005,
-      noService: true,
-      serviceHost: fake,
-    });
-
-    expect(fake.installCalls).toHaveLength(0);
-    expect(result.serviceName).toBeUndefined();
-    expect(result.uiUrl).toBe('http://127.0.0.1:19995/');
-    expect(existsSync(join(tmp, 'host.config.json'))).toBe(true);
-    expect(existsSync(join(tmp, 'identity.key'))).toBe(true);
-    expect(existsSync(join(tmp, 'nat.json'))).toBe(true);
-  });
-
-  it('noService on an interactive install skips the enrollment-invite fetch', async () => {
-    const fetchSpy = vi.spyOn(globalThis, 'fetch');
-    try {
-      const installer = new Installer({ platform: 'linux', installerVersion: 'test-1.0.0' });
-      const result = await installer.install({
-        nonInteractive: false,
-        noService: true,
-        wizard: async () => ({
-          dataDir: tmp,
-          uiPort: 19994,
-          libp2pPort: 14006,
-          upnpEnabled: false,
-          configureDdns: false,
-          ownCadre: false,
-        }),
-      });
-
-      expect(fetchSpy).not.toHaveBeenCalled();
-      expect(result.enrollmentInvite).toBeUndefined();
-      expect(existsSync(join(tmp, 'host.config.json'))).toBe(true);
-    } finally {
-      fetchSpy.mockRestore();
-    }
-  });
-
-  it('uninstall removes data only when --remove-data is set', async () => {
-    const fake = new FakeServiceHost();
-    const installer = new Installer({ platform: 'linux' });
-    await installer.install({
-      nonInteractive: true,
-      dataDir: tmp,
-      uiPort: 19998,
-      libp2pPort: 14002,
-      openBrowser: false,
-      noInvite: true,
-      serviceHost: fake,
-    });
-    expect(existsSync(join(tmp, 'host.config.json'))).toBe(true);
-
-    await installer.uninstall({ yes: true, removeData: false, dataDir: tmp, serviceHost: fake });
-    expect(fake.uninstallCalls).toHaveLength(1);
-    expect(existsSync(join(tmp, 'host.config.json'))).toBe(true);
-
-    await installer.uninstall({ yes: true, removeData: true, dataDir: tmp, serviceHost: fake });
-    expect(existsSync(tmp)).toBe(false);
-  });
-
-  it('rejects --system in v1', async () => {
-    const fake = new FakeServiceHost();
-    const installer = new Installer({ platform: 'linux' });
-    await expect(installer.install({
-      nonInteractive: true,
-      dataDir: tmp,
-      system: true,
-      serviceHost: fake,
-      openBrowser: false,
-      noInvite: true,
-    })).rejects.toThrow(/system.*not yet supported/);
-    expect(fake.installCalls).toHaveLength(0);
-  });
-
-  it('passes CLI overrides to the wizard as suggested defaults', async () => {
-    // Regression: the interactive wizard previously showed the platform
-    // default (`~/.local/share/cadre-host`) in the prompt even when the
-    // caller passed `--data-dir <path>`. Whatever the user typed was then
-    // silently discarded because the CLI flag won post-hoc. The fix: CLI
-    // overrides become the wizard's suggested defaults, and the wizard's
-    // returned answers stand on their own.
-    const fake = new FakeServiceHost();
-    const installer = new Installer({ platform: 'linux' });
-    let seenDefaults: { dataDir: string; uiPort: number; libp2pPort: number; upnpEnabled: boolean; ownCadre: boolean } | undefined;
-    await installer.install({
-      nonInteractive: false,
-      dataDir: tmp,
-      uiPort: 19997,
-      libp2pPort: 14003,
-      noUpnp: true,
-      openBrowser: false,
-      noInvite: true,
-      serviceHost: fake,
-      wizard: async (defaults) => {
-        seenDefaults = { ...defaults };
-        // Simulate the user pressing Enter at every prompt.
-        return {
-          dataDir: defaults.dataDir,
-          uiPort: defaults.uiPort,
-          libp2pPort: defaults.libp2pPort,
-          upnpEnabled: defaults.upnpEnabled,
-          configureDdns: false,
-          ownCadre: defaults.ownCadre,
-        };
-      },
-    });
-
-    expect(seenDefaults).toEqual({
-      dataDir: tmp,
-      uiPort: 19997,
-      libp2pPort: 14003,
-      upnpEnabled: false,
-      ownCadre: false,
-    });
-    expect(fake.installCalls).toHaveLength(1);
-    expect(fake.installCalls[0]!.dataDir).toBe(tmp);
-  });
-
-  it('honors wizard-typed input when no CLI override is passed', async () => {
-    // Mirror of the previous test: with no `--data-dir`, the wizard's
-    // returned value is what the installer uses.
-    const fake = new FakeServiceHost();
-    const installer = new Installer({ platform: 'linux' });
-    await installer.install({
-      nonInteractive: false,
-      openBrowser: false,
-      noInvite: true,
-      serviceHost: fake,
-      wizard: async () => ({
-        dataDir: tmp,
-        uiPort: 19996,
-        libp2pPort: 14004,
-        upnpEnabled: true,
-        configureDdns: false,
-        ownCadre: false,
-      }),
-    });
-    expect(fake.installCalls).toHaveLength(1);
-    expect(fake.installCalls[0]!.dataDir).toBe(tmp);
-  });
-
-  it('writes ownCadre.enabled=false by default and true when opted in', async () => {
-    const { readHostConfig } = await import('../config.js');
-
-    // Default (donor-only): --own-cadre absent → ownCadre.enabled false.
-    const fakeA = new FakeServiceHost();
-    const installerA = new Installer({ platform: 'linux' });
-    await installerA.install({
-      nonInteractive: true, dataDir: tmp, openBrowser: false, noInvite: true, serviceHost: fakeA,
-    });
-    const donorCfg = readHostConfig(join(tmp, 'host.config.json'));
-    expect(donorCfg.ownCadre).toEqual({ enabled: false });
-
-    // Opt-in: ownCadre:true (the --own-cadre flag) → ownCadre.enabled true.
-    const tmp2 = mkdtempSync(join(tmpdir(), 'cadre-host-installer-owncadre-'));
-    try {
-      const fakeB = new FakeServiceHost();
-      const installerB = new Installer({ platform: 'linux' });
-      await installerB.install({
-        nonInteractive: true, dataDir: tmp2, ownCadre: true, openBrowser: false, noInvite: true, serviceHost: fakeB,
-      });
-      const founderCfg = readHostConfig(join(tmp2, 'host.config.json'));
-      expect(founderCfg.ownCadre).toEqual({ enabled: true });
-    } finally {
-      rmSync(tmp2, { recursive: true, force: true });
-    }
-  });
-
-  it('re-running install preserves the existing identity', async () => {
-    const fake = new FakeServiceHost();
-    const installer = new Installer({ platform: 'linux' });
-    await installer.install({
-      nonInteractive: true, dataDir: tmp, openBrowser: false, noInvite: true, serviceHost: fake,
-    });
-    const idBefore = (await import('node:fs')).readFileSync(join(tmp, 'identity.key'));
-    await installer.install({
-      nonInteractive: true, dataDir: tmp, openBrowser: false, noInvite: true, serviceHost: fake,
-    });
-    const idAfter = (await import('node:fs')).readFileSync(join(tmp, 'identity.key'));
-    expect(Buffer.from(idBefore).equals(Buffer.from(idAfter))).toBe(true);
-  });
-});
+import { afterEach, beforeEach, describe, expect, it } from 'vitest';
+import { existsSync, mkdtempSync, rmSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+
+import { Installer } from '../index.js';
+import type { ServiceHost, ServiceHostContext, ServiceHostStatus } from '../service-host/types.js';
+
+class FakeServiceHost implements ServiceHost {
+  readonly name = 'cadre-host';
+  installCalls: ServiceHostContext[] = [];
+  uninstallCalls: ServiceHostContext[] = [];
+  installed = false;
+  running = false;
+
+  async install(ctx: ServiceHostContext): Promise<void> {
+    this.installCalls.push(ctx);
+    this.installed = true;
+    this.running = true;
+  }
+  async uninstall(ctx: ServiceHostContext): Promise<void> {
+    this.uninstallCalls.push(ctx);
+    this.installed = false;
+    this.running = false;
+  }
+  async restart(_ctx: ServiceHostContext): Promise<void> {
+    this.running = true;
+  }
+  async status(_ctx: ServiceHostContext): Promise<ServiceHostStatus> {
+    return { installed: this.installed, running: this.running };
+  }
+  renderUnit(_ctx: ServiceHostContext): string | null {
+    return 'rendered-unit';
+  }
+}
+
+describe('Installer smoke', () => {
+  let tmp: string;
+
+  beforeEach(() => {
+    tmp = mkdtempSync(join(tmpdir(), 'cadre-host-installer-smoke-'));
+  });
+
+  afterEach(() => {
+    rmSync(tmp, { recursive: true, force: true });
+  });
+
+  it('install creates config + invokes service-host', async () => {
+    const fake = new FakeServiceHost();
+    const installer = new Installer({ platform: 'linux', installerVersion: 'test-1.0.0' });
+    const result = await installer.install({
+      nonInteractive: true,
+      dataDir: tmp,
+      uiPort: 19999,
+      openBrowser: false,
+      serviceHost: fake,
+    });
+
+    expect(result.dataDir).toBe(tmp);
+    expect(result.uiUrl).toBe('http://127.0.0.1:19999/');
+    expect(result.serviceName).toBe('cadre-host');
+    expect(result.configPath).toBe(join(tmp, 'host.config.json'));
+
+    expect(existsSync(join(tmp, 'host.config.json'))).toBe(true);
+    // The host holds no identity of its own; each node writes its own key in its workdir.
+    expect(existsSync(join(tmp, 'identity.key'))).toBe(false);
+    expect(existsSync(join(tmp, 'nat.json'))).toBe(true);
+    expect(existsSync(join(tmp, 'logs'))).toBe(true);
+
+    expect(fake.installCalls).toHaveLength(1);
+    expect(fake.installCalls[0]!.dataDir).toBe(tmp);
+  });
+
+  it('noService writes the data dir without registering a service', async () => {
+    const fake = new FakeServiceHost();
+    const installer = new Installer({ platform: 'linux', installerVersion: 'test-1.0.0' });
+    const result = await installer.install({
+      nonInteractive: true,
+      dataDir: tmp,
+      uiPort: 19995,
+      noService: true,
+      serviceHost: fake,
+    });
+
+    expect(fake.installCalls).toHaveLength(0);
+    expect(result.serviceName).toBeUndefined();
+    expect(result.uiUrl).toBe('http://127.0.0.1:19995/');
+    expect(existsSync(join(tmp, 'host.config.json'))).toBe(true);
+    expect(existsSync(join(tmp, 'nat.json'))).toBe(true);
+  });
+
+  it('uninstall removes data only when --remove-data is set', async () => {
+    const fake = new FakeServiceHost();
+    const installer = new Installer({ platform: 'linux' });
+    await installer.install({
+      nonInteractive: true,
+      dataDir: tmp,
+      uiPort: 19998,
+      openBrowser: false,
+      serviceHost: fake,
+    });
+    expect(existsSync(join(tmp, 'host.config.json'))).toBe(true);
+
+    await installer.uninstall({ yes: true, removeData: false, dataDir: tmp, serviceHost: fake });
+    expect(fake.uninstallCalls).toHaveLength(1);
+    expect(existsSync(join(tmp, 'host.config.json'))).toBe(true);
+
+    await installer.uninstall({ yes: true, removeData: true, dataDir: tmp, serviceHost: fake });
+    expect(existsSync(tmp)).toBe(false);
+  });
+
+  it('rejects --system in v1', async () => {
+    const fake = new FakeServiceHost();
+    const installer = new Installer({ platform: 'linux' });
+    await expect(installer.install({
+      nonInteractive: true,
+      dataDir: tmp,
+      system: true,
+      serviceHost: fake,
+      openBrowser: false,
+    })).rejects.toThrow(/system.*not yet supported/);
+    expect(fake.installCalls).toHaveLength(0);
+  });
+
+  it('passes CLI overrides to the wizard as suggested defaults', async () => {
+    // Regression: the interactive wizard previously showed the platform
+    // default (`~/.local/share/cadre-host`) in the prompt even when the
+    // caller passed `--data-dir <path>`. Whatever the user typed was then
+    // silently discarded because the CLI flag won post-hoc. The fix: CLI
+    // overrides become the wizard's suggested defaults, and the wizard's
+    // returned answers stand on their own.
+    const fake = new FakeServiceHost();
+    const installer = new Installer({ platform: 'linux' });
+    let seenDefaults: Record<string, unknown> | undefined;
+    await installer.install({
+      nonInteractive: false,
+      dataDir: tmp,
+      uiPort: 19997,
+      noUpnp: true,
+      openBrowser: false,
+      serviceHost: fake,
+      publicInterfaceAddress: () => null,
+      wizard: async (defaults) => {
+        seenDefaults = { ...defaults };
+        // Simulate the user pressing Enter at every prompt.
+        return {
+          dataDir: defaults.dataDir,
+          uiPort: defaults.uiPort,
+          upnpEnabled: defaults.upnpEnabled,
+        };
+      },
+    });
+
+    // Every value came from a flag, so the wizard is told not to ask for any of them.
+    expect(seenDefaults).toEqual({
+      dataDir: tmp,
+      uiPort: 19997,
+      upnpEnabled: false,
+      given: { dataDir: true, uiPort: true, upnpEnabled: true },
+      publicInterfaceIp: null,
+    });
+    expect(fake.installCalls).toHaveLength(1);
+    expect(fake.installCalls[0]!.dataDir).toBe(tmp);
+  });
+
+  it('honors wizard-typed input when no CLI override is passed', async () => {
+    // Mirror of the previous test: with no `--data-dir`, the wizard's
+    // returned value is what the installer uses.
+    const fake = new FakeServiceHost();
+    const installer = new Installer({ platform: 'linux' });
+    await installer.install({
+      nonInteractive: false,
+      openBrowser: false,
+      serviceHost: fake,
+      wizard: async () => ({
+        dataDir: tmp,
+        uiPort: 19996,
+        upnpEnabled: true,
+      }),
+    });
+    expect(fake.installCalls).toHaveLength(1);
+    expect(fake.installCalls[0]!.dataDir).toBe(tmp);
+  });
+});

package/src/installer/__tests__/wizard.test.ts

@@ -5,9 +5,7 @@ import { runWizardWith, type WizardDefaults } from '../wizard.js';
 const defaults: WizardDefaults = {
   dataDir: '/data/cadre-host',
   uiPort: 8765,
-  libp2pPort: 4001,
   upnpEnabled: true,
-  ownCadre: false,
 };
 
 function scripted(answers: ReadonlyArray<string>): (label: string, fallback: string) => Promise<string> {
@@ -20,14 +18,11 @@ function scripted(answers: ReadonlyArray<string>): (label: string, fallback: str
 
 describe('runWizardWith', () => {
   it('returns the defaults when every answer is blank', async () => {
-    const out = await runWizardWith(defaults, scripted(['', '', '', '', '', '']));
+    const out = await runWizardWith(defaults, scripted(['', '', '', '']));
     expect(out).toEqual({
       dataDir: '/data/cadre-host',
       uiPort: 8765,
-      libp2pPort: 4001,
       upnpEnabled: true,
-      configureDdns: false,
-      ownCadre: false,
     });
   });
 
@@ -35,30 +30,47 @@ describe('runWizardWith', () => {
     const out = await runWizardWith(defaults, scripted([
       '/srv/host',
       '9000',
-      '5000',
       'n',
       'y',
-      'y',
     ]));
     expect(out).toEqual({
       dataDir: '/srv/host',
       uiPort: 9000,
-      libp2pPort: 5000,
       upnpEnabled: false,
-      configureDdns: true,
-      ownCadre: true,
     });
   });
 
   it('rejects invalid port input', async () => {
     await expect(
-      runWizardWith(defaults, scripted(['', 'banana', '', '', ''])),
+      runWizardWith(defaults, scripted(['', 'banana', '', ''])),
     ).rejects.toThrow(/Invalid port/);
   });
 
+  it('asks nothing a flag already answered', async () => {
+    const asked: string[] = [];
+    const out = await runWizardWith(
+      { ...defaults, dataDir: '/srv/host', uiPort: 9000, upnpEnabled: false, given: { dataDir: true, uiPort: true, upnpEnabled: true } },
+      async (label) => { asked.push(label); return ''; },
+    );
+    expect(asked).toEqual([]);
+    expect(out).toEqual({ dataDir: '/srv/host', uiPort: 9000, upnpEnabled: false });
+  });
+
+  it('does not ask about UPnP on a machine with a public IP, and says why', async () => {
+    const asked: string[] = [];
+    const said: string[] = [];
+    await runWizardWith(
+      { ...defaults, given: { dataDir: true }, publicInterfaceIp: '203.0.113.7' },
+      async (label) => { asked.push(label); return ''; },
+      (line) => said.push(line),
+    );
+    expect(asked).toEqual(['UI port (localhost only)']);
+    expect(said.join(' ')).toMatch(/public IP address \(203\.0\.113\.7\).*no UPnP/);
+  });
+
   it('rejects unrecognized yes/no answers', async () => {
     await expect(
-      runWizardWith(defaults, scripted(['', '', '', 'maybe', ''])),
+      runWizardWith(defaults, scripted(['', '', 'maybe', ''])),
     ).rejects.toThrow(/Invalid yes\/no/);
   });
 });