PaperClipAI/server/src/__tests__/config-file.test.ts

import fs from "node:fs";
import os from "node:os";
import path from "node:path";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { readConfigFile } from "../config-file.js";

const ORIGINAL_PAPERCLIP_CONFIG = process.env.PAPERCLIP_CONFIG;

function writeConfig(configPath: string, value: unknown): void {
  fs.writeFileSync(configPath, `${JSON.stringify(value, null, 2)}\n`);
}

function escapeRegExp(value: string): string {
  return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
}

function minimalConfig(): unknown {
  return {
    $meta: {
      version: 1,
      updatedAt: "2026-07-05T00:00:00.000Z",
      source: "configure",
    },
    database: {
      mode: "embedded-postgres",
    },
    logging: {
      mode: "file",
    },
    server: {},
  };
}

describe("readConfigFile", () => {
  let tempDir: string;
  let configPath: string;

  beforeEach(() => {
    tempDir = fs.mkdtempSync(path.join(os.tmpdir(), "paperclip-config-file-test-"));
    configPath = path.join(tempDir, "config.json");
    process.env.PAPERCLIP_CONFIG = configPath;
  });

  afterEach(() => {
    vi.restoreAllMocks();
    if (ORIGINAL_PAPERCLIP_CONFIG === undefined) {
      delete process.env.PAPERCLIP_CONFIG;
    } else {
      process.env.PAPERCLIP_CONFIG = ORIGINAL_PAPERCLIP_CONFIG;
    }

    fs.rmSync(tempDir, { recursive: true, force: true });
  });

  it("returns null when the config file does not exist", () => {
    expect(readConfigFile()).toBeNull();
  });

  it("throws a path-specific error when the config file is invalid JSON", () => {
    fs.writeFileSync(configPath, "{");

    expect(() => readConfigFile()).toThrow(
      new RegExp(`Invalid Paperclip config at ${escapeRegExp(configPath)}: failed to read or parse JSON`),
    );
  });

  it("throws a field-specific error when the config file fails schema validation", () => {
    const config = minimalConfig();
    if (typeof config === "object" && config !== null) {
      (config as { $meta: { source: string } }).$meta.source = "edited-by-hand";
    }

    writeConfig(configPath, config);

    expect(() => readConfigFile()).toThrow(/Invalid Paperclip config .* \$meta\.source:/);
  });

  it("parses a valid config file", () => {
    writeConfig(configPath, minimalConfig());

    expect(readConfigFile()).toMatchObject({
      $meta: {
        source: "configure",
      },
      database: {
        mode: "embedded-postgres",
      },
      logging: {
        mode: "file",
      },
    });
  });

  it("preserves explicit bucket provenance without changing defaults for existing readers", () => {
    for (const bucket of [undefined, "paperclip"]) {
      writeConfig(configPath, {
        ...minimalConfig() as object,
        storage: { provider: "s3", s3: bucket === undefined ? {} : { bucket } },
      });
      expect(readConfigFile()?.storage.s3.bucket).toBe("paperclip");
      expect(readConfigFile({ includeProvenance: true })).toMatchObject({
        config: { storage: { s3: { bucket: "paperclip" } } },
        explicitStorageS3Bucket: bucket !== undefined,
      });
    }
  });

  it("warns about likely misspellings without stripping them", () => {
    const config = {
      ...(minimalConfig() as Record<string, unknown>),
      server: {
        ports: 3200,
      },
    };
    const warn = vi.spyOn(console, "warn").mockImplementation(() => undefined);
    writeConfig(configPath, config);

    expect(readConfigFile()).toMatchObject({
      server: {
        port: 3100,
        ports: 3200,
      },
    });
    expect(warn).toHaveBeenCalledWith(
      "Unknown config key server.ports; did you mean server.port? It will be preserved.",
    );
  });
});