Skip to content

Never stop coding. Free MIT AI gateway: one endpoint, 375 providers (150+ free), 1,400+ models Kimi, Claude, GPT, Gemini, GLM, DeepSeek, MiniMax. Works with Claude Code, Codex, Cursor, OpenCode, Cline & Copilot. Quota-aware auto-fallback, RTK+Caveman compression saves 15-95% tokens, MCP/A2A, Desktop/PWA. Built by 900+ contributors

11.7 KB
Raw Blame
/**
 * tests/unit/radar-db.test.ts
 *
 * TDD regression guard for the Radar client local DB module:
 * - radar_feed_cache: single-row signed feed cache
 * - radar_settings: opt-in + encrypted supporter key
 *
 * Covers: empty state, round-trip, upsert replacement, encryption at rest,
 * key clear, and settings persistence.
 */
import test from "node:test";
import assert from "node:assert/strict";
import fs from "node:fs";
import os from "node:os";
import path from "node:path";

// Isolate DB state in a temp directory
const TEST_DATA_DIR = fs.mkdtempSync(path.join(os.tmpdir(), "omniroute-radar-db-"));
process.env.DATA_DIR = TEST_DATA_DIR;
// Enable encryption so we can verify at-rest encryption of supporter key
process.env.STORAGE_ENCRYPTION_KEY = "test-encryption-key-for-radar-db-tests-32b!";

const core = await import("../../src/lib/db/core.ts");
const radar = await import("../../src/lib/db/radar.ts");

async function resetStorage() {
  core.resetDbInstance();

  for (let attempt = 0; attempt < 10; attempt++) {
    try {
      if (fs.existsSync(TEST_DATA_DIR)) {
        fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true, maxRetries: 5, retryDelay: 100 });
      }
      break;
    } catch (error: unknown) {
      const code = (error as NodeJS.ErrnoException | undefined)?.code;
      if ((code === "EBUSY" || code === "EPERM") && attempt < 9) {
        await new Promise((resolve) => setTimeout(resolve, 50 * (attempt + 1)));
      } else {
        throw error;
      }
    }
  }

  fs.mkdirSync(TEST_DATA_DIR, { recursive: true });
}

test.beforeEach(async () => {
  await resetStorage();
});

test.after(async () => {
  core.resetDbInstance();
  fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true, maxRetries: 5, retryDelay: 100 });
  delete process.env.STORAGE_ENCRYPTION_KEY;
});

// ---------------------------------------------------------------------------
// radar_feed_cache
// ---------------------------------------------------------------------------

test("getRadarCache returns null when no cache exists", () => {
  const db = core.getDbInstance();
  const result = radar.getRadarCache();
  assert.equal(result, null, "empty cache must return null");
});

test("setRadarCache then getRadarCache round-trips exactly", () => {
  const db = core.getDbInstance();
  const feed = {
    version: "2026-08-03T00:00:00Z",
    tier: "community",
    payload: JSON.stringify({ models: [{ id: "gpt-4o", provider: "openai" }] }),
    signature: "ed25519:abc123def456",
  };

  radar.setRadarCache(feed);
  const result = radar.getRadarCache();

  assert.ok(result, "cache must not be null after set");
  assert.equal(result.version, feed.version, "version must round-trip");
  assert.equal(result.tier, feed.tier, "tier must round-trip");
  assert.equal(result.payload, feed.payload, "payload must round-trip byte-identically");
  assert.equal(result.signature, feed.signature, "signature must round-trip");
  assert.ok(result.fetchedAt, "fetchedAt must be set");
});

test("second setRadarCache REPLACES the row (still single row)", () => {
  const db = core.getDbInstance();

  radar.setRadarCache({
    version: "v1",
    tier: "community",
    payload: '{"old":true}',
    signature: "sig-old",
  });

  radar.setRadarCache({
    version: "v2",
    tier: "live",
    payload: '{"new":true}',
    signature: "sig-new",
  });

  const result = radar.getRadarCache();
  assert.ok(result);
  assert.equal(result.version, "v2", "must have the second version");
  assert.equal(result.tier, "live", "must have the second tier");
  assert.equal(result.payload, '{"new":true}', "must have the second payload");

  // Verify only one row exists
  const count = db.prepare("SELECT COUNT(*) AS c FROM radar_feed_cache").get() as { c: number };
  assert.equal(count.c, 1, "must have exactly one row");
});

test("setRadarCache uses fetchedAt when provided", () => {
  const db = core.getDbInstance();
  const fixed = "2026-08-03T12:00:00.000Z";

  radar.setRadarCache({
    version: "v1",
    tier: "community",
    payload: "{}",
    signature: "sig",
    fetchedAt: fixed,
  });

  const result = radar.getRadarCache();
  assert.ok(result);
  assert.equal(result.fetchedAt, fixed, "must use the provided fetchedAt");
});

// ---------------------------------------------------------------------------
// radar_settings
// ---------------------------------------------------------------------------

test("getRadarSettings defaults: optIn false, key null", () => {
  const db = core.getDbInstance();
  const settings = radar.getRadarSettings();

  assert.equal(settings.optIn, false, "default optIn must be false");
  assert.equal(settings.supporterKey, null, "default supporterKey must be null");
  assert.ok(settings.updatedAt, "updatedAt must be set on first read");
});

test("setRadarOptIn(true) persists", () => {
  const db = core.getDbInstance();

  radar.setRadarOptIn(true);
  const settings = radar.getRadarSettings();
  assert.equal(settings.optIn, true, "optIn must be true after setRadarOptIn(true)");

  radar.setRadarOptIn(false);
  const settings2 = radar.getRadarSettings();
  assert.equal(settings2.optIn, false, "optIn must be false after setRadarOptIn(false)");
});

test("setRadarKey encrypts at rest and getRadarSettings decrypts", () => {
  const db = core.getDbInstance();
  const clearKey = "omr_" + "a".repeat(40);

  radar.setRadarKey(clearKey);
  const settings = radar.getRadarSettings();

  assert.equal(settings.supporterKey, clearKey, "getRadarSettings must return the clear key");

  // Direct DB query to prove encryption at rest
  interface SettingsRow {
    supporter_key_encrypted: string | null;
  }
  const row = db
    .prepare("SELECT supporter_key_encrypted FROM radar_settings WHERE id = 1")
    .get() as SettingsRow;
  assert.ok(row, "radar_settings row must exist");
  assert.ok(
    row.supporter_key_encrypted !== clearKey,
    "stored value must NOT be the clear key (encryption at rest)"
  );
  assert.ok(
    row.supporter_key_encrypted?.startsWith("enc:v1:"),
    "stored value must carry the enc:v1: prefix"
  );
});

test("setRadarKey(null) clears the key", () => {
  const db = core.getDbInstance();

  radar.setRadarKey("omr_" + "b".repeat(40));
  assert.ok(radar.getRadarSettings().supporterKey, "key must be set");

  radar.setRadarKey(null);
  const settings = radar.getRadarSettings();
  assert.equal(settings.supporterKey, null, "key must be null after clearing");

  // Direct DB check
  const cleared = db
    .prepare("SELECT supporter_key_encrypted FROM radar_settings WHERE id = 1")
    .get() as { supporter_key_encrypted: string | null };
  assert.equal(cleared.supporter_key_encrypted, null, "DB value must be null");
});

test("changing the supporter key invalidates the entitlement-sensitive referrals cache", () => {
  radar.setRadarCache({
    version: "2026.08.07.1",
    tier: "live",
    payload: '{"models":[]}',
    signature: "catalog-live-signature",
  });
  radar.setRadarReferralsCache({
    generatedAt: "2026-08-07T12:00:00.000Z",
    tier: "live",
    payload: '{"referrals":{"fixed":[],"campaigns":[{"provider":"groq"}]}}',
    signature: "live-signature",
  });
  assert.ok(radar.getRadarReferralsCache(), "precondition: live referrals cache exists");
  assert.ok(radar.getRadarCache(), "precondition: live catalog cache exists");

  radar.setRadarKey("omr_" + "d".repeat(40));

  assert.equal(
    radar.getRadarReferralsCache(),
    null,
    "a new key must force the next referrals read to resolve entitlement server-side"
  );
  assert.equal(
    radar.getRadarCache(),
    null,
    "a new key must force the next catalog sync to resolve entitlement server-side"
  );
});

test("setRadarKey uses existing AES-256-GCM encryption from encryption.ts", () => {
  const db = core.getDbInstance();
  const clearKey = "omr_" + "c".repeat(40);

  radar.setRadarKey(clearKey);

  const encRow = db
    .prepare("SELECT supporter_key_encrypted FROM radar_settings WHERE id = 1")
    .get() as { supporter_key_encrypted: string };

  // Verify it uses the enc:v1: format (same as provider credentials)
  assert.ok(
    encRow.supporter_key_encrypted.startsWith("enc:v1:"),
    "must use enc:v1: prefix (AES-256-GCM from encryption.ts)"
  );

  // Verify the format: enc:v1:<iv_hex>:<ciphertext_hex>:<authTag_hex>
  const body = encRow.supporter_key_encrypted.slice("enc:v1:".length);
  const parts = body.split(":");
  assert.equal(parts.length, 3, "must have 3 parts (iv:ciphertext:authTag)");
});

// ---------------------------------------------------------------------------
// radar_referrals_cache (migration 142) -- standalone `GET /v1/referrals/latest`
// cache, separate from radar_feed_cache (the catalog feed).
// ---------------------------------------------------------------------------

test("getRadarReferralsCache returns null when no cache exists", () => {
  const result = radar.getRadarReferralsCache();
  assert.equal(result, null, "empty referrals cache must return null");
});

test("setRadarReferralsCache then getRadarReferralsCache round-trips exactly", () => {
  const entry = {
    generatedAt: "2026-08-07T12:00:00.000Z",
    tier: "live",
    payload: JSON.stringify({ referrals: { fixed: [], campaigns: [] } }),
    signature: "ed25519:referrals-sig-abc",
  };

  radar.setRadarReferralsCache(entry);
  const result = radar.getRadarReferralsCache();

  assert.ok(result, "referrals cache must not be null after set");
  assert.equal(result.generatedAt, entry.generatedAt, "generatedAt must round-trip");
  assert.equal(result.tier, entry.tier, "tier must round-trip");
  assert.equal(result.payload, entry.payload, "payload must round-trip byte-identically");
  assert.equal(result.signature, entry.signature, "signature must round-trip");
  assert.ok(result.fetchedAt, "fetchedAt must be set");
});

test("second setRadarReferralsCache REPLACES the row (still single row)", () => {
  const db = core.getDbInstance();

  radar.setRadarReferralsCache({
    generatedAt: "2026-08-07T10:00:00.000Z",
    tier: "community",
    payload: '{"old":true}',
    signature: "sig-old",
  });

  radar.setRadarReferralsCache({
    generatedAt: "2026-08-07T12:00:00.000Z",
    tier: "live",
    payload: '{"new":true}',
    signature: "sig-new",
  });

  const result = radar.getRadarReferralsCache();
  assert.ok(result);
  assert.equal(result.generatedAt, "2026-08-07T12:00:00.000Z", "must have the second generatedAt");
  assert.equal(result.tier, "live", "must have the second tier");
  assert.equal(result.payload, '{"new":true}', "must have the second payload");

  const count = db.prepare("SELECT COUNT(*) AS c FROM radar_referrals_cache").get() as {
    c: number;
  };
  assert.equal(count.c, 1, "must have exactly one row");
});

test("setRadarReferralsCache uses fetchedAt when provided", () => {
  const fixed = "2026-08-07T12:00:00.000Z";

  radar.setRadarReferralsCache({
    generatedAt: "2026-08-07T12:00:00.000Z",
    tier: "community",
    payload: "{}",
    signature: "sig",
    fetchedAt: fixed,
  });

  const result = radar.getRadarReferralsCache();
  assert.ok(result);
  assert.equal(result.fetchedAt, fixed, "must use the provided fetchedAt");
});

test("radar_referrals_cache is independent of radar_feed_cache (separate tables)", () => {
  radar.setRadarCache({
    version: "2026.08.01.1",
    tier: "community",
    payload: '{"catalog":true}',
    signature: "catalog-sig",
  });
  radar.setRadarReferralsCache({
    generatedAt: "2026-08-07T12:00:00.000Z",
    tier: "live",
    payload: '{"referrals":true}',
    signature: "referrals-sig",
  });

  const catalogCache = radar.getRadarCache();
  const referralsCache = radar.getRadarReferralsCache();

  assert.equal(catalogCache?.payload, '{"catalog":true}');
  assert.equal(referralsCache?.payload, '{"referrals":true}');
  assert.notEqual(
    catalogCache?.payload,
    referralsCache?.payload,
    "the two caches must never share storage"
  );
});