@hellcoder/companion 0.96.0

package/server/settings-manager.test.ts

@@ -0,0 +1,275 @@
+import { mkdtempSync, rmSync, readFileSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+import { tmpdir } from "node:os";
+import {
+  getSettings,
+  updateSettings,
+  _resetForTest,
+  DEFAULT_ANTHROPIC_MODEL,
+} from "./settings-manager.js";
+
+let tempDir: string;
+let settingsPath: string;
+
+beforeEach(() => {
+  tempDir = mkdtempSync(join(tmpdir(), "settings-manager-test-"));
+  settingsPath = join(tempDir, "settings.json");
+  _resetForTest(settingsPath);
+});
+
+afterEach(() => {
+  rmSync(tempDir, { recursive: true, force: true });
+  _resetForTest();
+});
+
+describe("settings-manager", () => {
+  it("returns defaults when file is missing", () => {
+    expect(getSettings()).toEqual({
+      anthropicApiKey: "",
+      anthropicModel: DEFAULT_ANTHROPIC_MODEL,
+      linearApiKey: "",
+      linearAutoTransition: false,
+      linearAutoTransitionStateId: "",
+      linearAutoTransitionStateName: "",
+    linearArchiveTransition: false,
+    linearArchiveTransitionStateId: "",
+    linearArchiveTransitionStateName: "",
+      linearOAuthClientId: "",
+      linearOAuthClientSecret: "",
+      linearOAuthWebhookSecret: "",
+      linearOAuthAccessToken: "",
+      linearOAuthRefreshToken: "",
+      claudeCodeOAuthToken: "",
+      openaiApiKey: "",
+      onboardingCompleted: false,
+      aiValidationEnabled: false,
+      aiValidationAutoApprove: true,
+      aiValidationAutoDeny: false,
+      publicUrl: "",
+      updateChannel: "stable",
+      dockerAutoUpdate: false,
+      updatedAt: 0,
+    });
+  });
+
+  it("updates and persists settings", () => {
+    const updated = updateSettings({ anthropicApiKey: "sk-ant-key" });
+    expect(updated.anthropicApiKey).toBe("sk-ant-key");
+    expect(updated.anthropicModel).toBe(DEFAULT_ANTHROPIC_MODEL);
+    expect(updated.linearApiKey).toBe("");
+    expect(updated.updatedAt).toBeGreaterThan(0);
+
+    const saved = JSON.parse(readFileSync(settingsPath, "utf-8"));
+    expect(saved.anthropicApiKey).toBe("sk-ant-key");
+    expect(saved.anthropicModel).toBe(DEFAULT_ANTHROPIC_MODEL);
+    expect(saved.linearApiKey).toBe("");
+  });
+
+  it("loads existing settings from disk", () => {
+    writeFileSync(
+      settingsPath,
+      JSON.stringify({
+        anthropicApiKey: "existing",
+        anthropicModel: "claude-haiku-3",
+        linearApiKey: "lin_api_abc",
+        updatedAt: 123,
+      }),
+      "utf-8",
+    );
+
+    _resetForTest(settingsPath);
+
+    expect(getSettings()).toEqual({
+      anthropicApiKey: "existing",
+      anthropicModel: "claude-haiku-3",
+      linearApiKey: "lin_api_abc",
+      linearAutoTransition: false,
+      linearAutoTransitionStateId: "",
+      linearAutoTransitionStateName: "",
+    linearArchiveTransition: false,
+    linearArchiveTransitionStateId: "",
+    linearArchiveTransitionStateName: "",
+      linearOAuthClientId: "",
+      linearOAuthClientSecret: "",
+      linearOAuthWebhookSecret: "",
+      linearOAuthAccessToken: "",
+      linearOAuthRefreshToken: "",
+      claudeCodeOAuthToken: "",
+      openaiApiKey: "",
+      onboardingCompleted: false,
+      aiValidationEnabled: false,
+      aiValidationAutoApprove: true,
+      aiValidationAutoDeny: false,
+      publicUrl: "",
+      updateChannel: "stable",
+      dockerAutoUpdate: false,
+      updatedAt: 123,
+    });
+  });
+
+  it("falls back to defaults for invalid JSON", () => {
+    writeFileSync(settingsPath, "not-json", "utf-8");
+    _resetForTest(settingsPath);
+
+    expect(getSettings().anthropicModel).toBe(DEFAULT_ANTHROPIC_MODEL);
+  });
+
+  // Migration: existing users with the old dot-form model ID should be auto-corrected
+  it("migrates persisted claude-sonnet-4.6 (dot) to claude-sonnet-4-6 (hyphen)", () => {
+    writeFileSync(
+      settingsPath,
+      JSON.stringify({
+        anthropicApiKey: "sk-ant-existing",
+        anthropicModel: "claude-sonnet-4.6",
+      }),
+      "utf-8",
+    );
+    _resetForTest(settingsPath);
+
+    const settings = getSettings();
+    expect(settings.anthropicModel).toBe(DEFAULT_ANTHROPIC_MODEL);
+    expect(settings.anthropicApiKey).toBe("sk-ant-existing");
+  });
+
+  it("updates only model while preserving existing key", () => {
+    updateSettings({ anthropicApiKey: "sk-ant-key" });
+    const updated = updateSettings({ anthropicModel: "claude-haiku-3" });
+
+    expect(updated.anthropicApiKey).toBe("sk-ant-key");
+    expect(updated.anthropicModel).toBe("claude-haiku-3");
+    expect(updated.linearApiKey).toBe("");
+  });
+
+  it("uses default model when empty model is provided", () => {
+    const updated = updateSettings({ anthropicModel: "" });
+    expect(updated.anthropicModel).toBe(DEFAULT_ANTHROPIC_MODEL);
+  });
+
+  it("normalizes malformed file shape to defaults", () => {
+    writeFileSync(
+      settingsPath,
+      JSON.stringify({
+        anthropicApiKey: 123,
+        anthropicModel: null,
+        linearApiKey: 123,
+        updatedAt: "x",
+      }),
+      "utf-8",
+    );
+    _resetForTest(settingsPath);
+
+    expect(getSettings()).toEqual({
+      anthropicApiKey: "",
+      anthropicModel: DEFAULT_ANTHROPIC_MODEL,
+      linearApiKey: "",
+      linearAutoTransition: false,
+      linearAutoTransitionStateId: "",
+      linearAutoTransitionStateName: "",
+    linearArchiveTransition: false,
+    linearArchiveTransitionStateId: "",
+    linearArchiveTransitionStateName: "",
+      linearOAuthClientId: "",
+      linearOAuthClientSecret: "",
+      linearOAuthWebhookSecret: "",
+      linearOAuthAccessToken: "",
+      linearOAuthRefreshToken: "",
+      claudeCodeOAuthToken: "",
+      openaiApiKey: "",
+      onboardingCompleted: false,
+      aiValidationEnabled: false,
+      aiValidationAutoApprove: true,
+      aiValidationAutoDeny: false,
+      publicUrl: "",
+      updateChannel: "stable",
+      dockerAutoUpdate: false,
+      updatedAt: 0,
+    });
+  });
+
+  it("updates linear key without touching anthropic settings", () => {
+    updateSettings({ anthropicApiKey: "sk-ant-key", anthropicModel: "claude-sonnet-4-6" });
+    const updated = updateSettings({ linearApiKey: "lin_api_123" });
+
+    expect(updated.anthropicApiKey).toBe("sk-ant-key");
+    expect(updated.anthropicModel).toBe("claude-sonnet-4-6");
+    expect(updated.linearApiKey).toBe("lin_api_123");
+  });
+
+  it("ignores undefined patch values and preserves existing keys", () => {
+    updateSettings({ anthropicApiKey: "sk-ant-key", linearApiKey: "lin_api_123" });
+    const updated = updateSettings({
+      anthropicApiKey: undefined,
+      anthropicModel: "claude-haiku-3",
+      linearApiKey: undefined,
+    });
+
+    expect(updated.anthropicApiKey).toBe("sk-ant-key");
+    expect(updated.anthropicModel).toBe("claude-haiku-3");
+    expect(updated.linearApiKey).toBe("lin_api_123");
+  });
+
+  it("updates updateChannel to prerelease", () => {
+    const updated = updateSettings({ updateChannel: "prerelease" });
+    expect(updated.updateChannel).toBe("prerelease");
+  });
+
+  it("defaults updateChannel to stable for invalid values", () => {
+    writeFileSync(
+      settingsPath,
+      JSON.stringify({ updateChannel: "invalid" }),
+      "utf-8",
+    );
+    _resetForTest(settingsPath);
+    expect(getSettings().updateChannel).toBe("stable");
+  });
+
+  it("preserves updateChannel when updating other settings", () => {
+    updateSettings({ updateChannel: "prerelease" });
+    const updated = updateSettings({ anthropicModel: "claude-haiku-3" });
+    expect(updated.updateChannel).toBe("prerelease");
+  });
+
+  // ─── publicUrl tests ────────────────────────────────────────────────────────
+
+  // Default settings include publicUrl as empty string
+  it("default settings include publicUrl as empty string", () => {
+    expect(getSettings().publicUrl).toBe("");
+  });
+
+  // updateSettings saves publicUrl when a valid URL is provided
+  it("saves publicUrl via updateSettings", () => {
+    const updated = updateSettings({ publicUrl: "https://example.com" });
+    expect(updated.publicUrl).toBe("https://example.com");
+
+    const saved = JSON.parse(readFileSync(settingsPath, "utf-8"));
+    expect(saved.publicUrl).toBe("https://example.com");
+  });
+
+  // updateSettings strips trailing slashes from publicUrl
+  it("strips trailing slashes from publicUrl", () => {
+    const updated = updateSettings({ publicUrl: "https://example.com///" });
+    expect(updated.publicUrl).toBe("https://example.com");
+  });
+
+  // Missing publicUrl in raw JSON on disk normalizes to empty string
+  it("normalizes missing publicUrl in raw JSON to empty string", () => {
+    writeFileSync(
+      settingsPath,
+      JSON.stringify({
+        anthropicApiKey: "key",
+        anthropicModel: "claude-sonnet-4-6",
+      }),
+      "utf-8",
+    );
+    _resetForTest(settingsPath);
+
+    expect(getSettings().publicUrl).toBe("");
+  });
+
+  // Updating other settings preserves an existing publicUrl value
+  it("preserves publicUrl when updating other settings", () => {
+    updateSettings({ publicUrl: "https://example.com" });
+    const updated = updateSettings({ anthropicModel: "claude-haiku-3" });
+    expect(updated.publicUrl).toBe("https://example.com");
+  });
+});

package/server/settings-manager.ts

@@ -0,0 +1,173 @@
+import {
+  mkdirSync,
+  readFileSync,
+  writeFileSync,
+  existsSync,
+} from "node:fs";
+import { join, dirname } from "node:path";
+import { COMPANION_HOME } from "./paths.js";
+
+export const DEFAULT_ANTHROPIC_MODEL = "claude-sonnet-4-6";
+
+export type UpdateChannel = "stable" | "prerelease";
+
+export interface CompanionSettings {
+  anthropicApiKey: string;
+  anthropicModel: string;
+  /** OAuth token obtained via `claude setup-token` — injected as CLAUDE_CODE_OAUTH_TOKEN */
+  claudeCodeOAuthToken: string;
+  /** OpenAI API key for Codex — injected as OPENAI_API_KEY */
+  openaiApiKey: string;
+  /** Whether the onboarding wizard has been completed */
+  onboardingCompleted: boolean;
+  linearApiKey: string;
+  linearAutoTransition: boolean;
+  linearAutoTransitionStateId: string;
+  linearAutoTransitionStateName: string;
+  linearArchiveTransition: boolean;
+  linearArchiveTransitionStateId: string;
+  linearArchiveTransitionStateName: string;
+  /** @deprecated Used only as staging during wizard flow. Per-agent credentials are in AgentConfig.triggers.linear. */
+  linearOAuthClientId: string;
+  /** @deprecated Used only as staging during wizard flow. Per-agent credentials are in AgentConfig.triggers.linear. */
+  linearOAuthClientSecret: string;
+  /** @deprecated Used only as staging during wizard flow. Per-agent credentials are in AgentConfig.triggers.linear. */
+  linearOAuthWebhookSecret: string;
+  /** @deprecated Used only as staging during wizard flow. Per-agent credentials are in AgentConfig.triggers.linear. */
+  linearOAuthAccessToken: string;
+  /** @deprecated Used only as staging during wizard flow. Per-agent credentials are in AgentConfig.triggers.linear. */
+  linearOAuthRefreshToken: string;
+  aiValidationEnabled: boolean;
+  aiValidationAutoApprove: boolean;
+  aiValidationAutoDeny: boolean;
+  publicUrl: string;
+  updateChannel: UpdateChannel;
+  dockerAutoUpdate: boolean;
+  updatedAt: number;
+}
+
+const DEFAULT_PATH = join(COMPANION_HOME, "settings.json");
+
+let loaded = false;
+let filePath = DEFAULT_PATH;
+let settings: CompanionSettings = {
+  anthropicApiKey: "",
+  anthropicModel: DEFAULT_ANTHROPIC_MODEL,
+  claudeCodeOAuthToken: "",
+  openaiApiKey: "",
+  onboardingCompleted: false,
+  linearApiKey: "",
+  linearAutoTransition: false,
+  linearAutoTransitionStateId: "",
+  linearAutoTransitionStateName: "",
+  linearArchiveTransition: false,
+  linearArchiveTransitionStateId: "",
+  linearArchiveTransitionStateName: "",
+  linearOAuthClientId: "",
+  linearOAuthClientSecret: "",
+  linearOAuthWebhookSecret: "",
+  linearOAuthAccessToken: "",
+  linearOAuthRefreshToken: "",
+  aiValidationEnabled: false,
+  aiValidationAutoApprove: true,
+  aiValidationAutoDeny: false,
+  publicUrl: "",
+  updateChannel: "stable",
+  dockerAutoUpdate: false,
+  updatedAt: 0,
+};
+
+function normalize(raw: Partial<CompanionSettings> | null | undefined): CompanionSettings {
+  return {
+    anthropicApiKey: typeof raw?.anthropicApiKey === "string" ? raw.anthropicApiKey : "",
+    anthropicModel:
+      typeof raw?.anthropicModel === "string" && raw.anthropicModel.trim()
+        ? raw.anthropicModel === "claude-sonnet-4.6" ? DEFAULT_ANTHROPIC_MODEL : raw.anthropicModel
+        : DEFAULT_ANTHROPIC_MODEL,
+    claudeCodeOAuthToken: typeof raw?.claudeCodeOAuthToken === "string" ? raw.claudeCodeOAuthToken : "",
+    openaiApiKey: typeof raw?.openaiApiKey === "string" ? raw.openaiApiKey : "",
+    onboardingCompleted: typeof raw?.onboardingCompleted === "boolean" ? raw.onboardingCompleted : false,
+    linearApiKey: typeof raw?.linearApiKey === "string" ? raw.linearApiKey : "",
+    linearAutoTransition: typeof raw?.linearAutoTransition === "boolean" ? raw.linearAutoTransition : false,
+    linearAutoTransitionStateId: typeof raw?.linearAutoTransitionStateId === "string" ? raw.linearAutoTransitionStateId : "",
+    linearAutoTransitionStateName: typeof raw?.linearAutoTransitionStateName === "string" ? raw.linearAutoTransitionStateName : "",
+    linearArchiveTransition: typeof raw?.linearArchiveTransition === "boolean" ? raw.linearArchiveTransition : false,
+    linearArchiveTransitionStateId: typeof raw?.linearArchiveTransitionStateId === "string" ? raw.linearArchiveTransitionStateId : "",
+    linearArchiveTransitionStateName: typeof raw?.linearArchiveTransitionStateName === "string" ? raw.linearArchiveTransitionStateName : "",
+    linearOAuthClientId: typeof raw?.linearOAuthClientId === "string" ? raw.linearOAuthClientId : "",
+    linearOAuthClientSecret: typeof raw?.linearOAuthClientSecret === "string" ? raw.linearOAuthClientSecret : "",
+    linearOAuthWebhookSecret: typeof raw?.linearOAuthWebhookSecret === "string" ? raw.linearOAuthWebhookSecret : "",
+    linearOAuthAccessToken: typeof raw?.linearOAuthAccessToken === "string" ? raw.linearOAuthAccessToken : "",
+    linearOAuthRefreshToken: typeof raw?.linearOAuthRefreshToken === "string" ? raw.linearOAuthRefreshToken : "",
+    aiValidationEnabled: typeof raw?.aiValidationEnabled === "boolean" ? raw.aiValidationEnabled : false,
+    aiValidationAutoApprove: typeof raw?.aiValidationAutoApprove === "boolean" ? raw.aiValidationAutoApprove : true,
+    aiValidationAutoDeny: typeof raw?.aiValidationAutoDeny === "boolean" ? raw.aiValidationAutoDeny : false,
+    publicUrl: typeof raw?.publicUrl === "string" ? raw.publicUrl.trim().replace(/\/+$/, "") : "",
+    updateChannel: raw?.updateChannel === "prerelease" ? "prerelease" : "stable",
+    dockerAutoUpdate: typeof raw?.dockerAutoUpdate === "boolean" ? raw.dockerAutoUpdate : false,
+    updatedAt: typeof raw?.updatedAt === "number" ? raw.updatedAt : 0,
+  };
+}
+
+function ensureLoaded(): void {
+  if (loaded) return;
+  try {
+    if (existsSync(filePath)) {
+      const raw = readFileSync(filePath, "utf-8");
+      settings = normalize(JSON.parse(raw) as Partial<CompanionSettings>);
+    }
+  } catch {
+    settings = normalize(null);
+  }
+  loaded = true;
+}
+
+function persist(): void {
+  mkdirSync(dirname(filePath), { recursive: true });
+  writeFileSync(filePath, JSON.stringify(settings, null, 2), "utf-8");
+}
+
+export function getSettings(): CompanionSettings {
+  ensureLoaded();
+  return { ...settings };
+}
+
+export function updateSettings(
+  patch: Partial<Pick<CompanionSettings, "anthropicApiKey" | "anthropicModel" | "claudeCodeOAuthToken" | "openaiApiKey" | "onboardingCompleted" | "linearApiKey" | "linearAutoTransition" | "linearAutoTransitionStateId" | "linearAutoTransitionStateName" | "linearArchiveTransition" | "linearArchiveTransitionStateId" | "linearArchiveTransitionStateName" | "linearOAuthClientId" | "linearOAuthClientSecret" | "linearOAuthWebhookSecret" | "linearOAuthAccessToken" | "linearOAuthRefreshToken" | "aiValidationEnabled" | "aiValidationAutoApprove" | "aiValidationAutoDeny" | "publicUrl" | "updateChannel" | "dockerAutoUpdate">>,
+): CompanionSettings {
+  ensureLoaded();
+  settings = normalize({
+    anthropicApiKey: patch.anthropicApiKey ?? settings.anthropicApiKey,
+    anthropicModel: patch.anthropicModel ?? settings.anthropicModel,
+    claudeCodeOAuthToken: patch.claudeCodeOAuthToken ?? settings.claudeCodeOAuthToken,
+    openaiApiKey: patch.openaiApiKey ?? settings.openaiApiKey,
+    onboardingCompleted: patch.onboardingCompleted ?? settings.onboardingCompleted,
+    linearApiKey: patch.linearApiKey ?? settings.linearApiKey,
+    linearAutoTransition: patch.linearAutoTransition ?? settings.linearAutoTransition,
+    linearAutoTransitionStateId: patch.linearAutoTransitionStateId ?? settings.linearAutoTransitionStateId,
+    linearAutoTransitionStateName: patch.linearAutoTransitionStateName ?? settings.linearAutoTransitionStateName,
+    linearArchiveTransition: patch.linearArchiveTransition ?? settings.linearArchiveTransition,
+    linearArchiveTransitionStateId: patch.linearArchiveTransitionStateId ?? settings.linearArchiveTransitionStateId,
+    linearArchiveTransitionStateName: patch.linearArchiveTransitionStateName ?? settings.linearArchiveTransitionStateName,
+    linearOAuthClientId: patch.linearOAuthClientId ?? settings.linearOAuthClientId,
+    linearOAuthClientSecret: patch.linearOAuthClientSecret ?? settings.linearOAuthClientSecret,
+    linearOAuthWebhookSecret: patch.linearOAuthWebhookSecret ?? settings.linearOAuthWebhookSecret,
+    linearOAuthAccessToken: patch.linearOAuthAccessToken ?? settings.linearOAuthAccessToken,
+    linearOAuthRefreshToken: patch.linearOAuthRefreshToken ?? settings.linearOAuthRefreshToken,
+    aiValidationEnabled: patch.aiValidationEnabled ?? settings.aiValidationEnabled,
+    aiValidationAutoApprove: patch.aiValidationAutoApprove ?? settings.aiValidationAutoApprove,
+    aiValidationAutoDeny: patch.aiValidationAutoDeny ?? settings.aiValidationAutoDeny,
+    publicUrl: patch.publicUrl ?? settings.publicUrl,
+    updateChannel: patch.updateChannel ?? settings.updateChannel,
+    dockerAutoUpdate: patch.dockerAutoUpdate ?? settings.dockerAutoUpdate,
+    updatedAt: Date.now(),
+  });
+  persist();
+  return { ...settings };
+}
+
+export function _resetForTest(customPath?: string): void {
+  loaded = false;
+  filePath = customPath || DEFAULT_PATH;
+  settings = normalize(null);
+}