Termix/src/backend/tests/utils/audit-retention-migration.test.ts

import { afterEach, describe, expect, it } from "vitest";
import Database from "better-sqlite3";
import {
  migrateAuditRetention,
  userDeleteIsDestructive,
} from "../../utils/audit-retention-migration.js";

let db: Database.Database | null = null;

afterEach(() => {
  db?.close();
  db = null;
});

/** The pre-migration shape: both tables cascade from users. */
function legacyDatabase(): Database.Database {
  const sqlite = new Database(":memory:");
  sqlite.exec(`
    PRAGMA foreign_keys = ON;

    CREATE TABLE users (
        id TEXT PRIMARY KEY,
        username TEXT NOT NULL
    );

    CREATE TABLE ssh_data (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        name TEXT NOT NULL
    );

    CREATE TABLE host_access (
        id INTEGER PRIMARY KEY AUTOINCREMENT
    );

    CREATE TABLE audit_logs (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        user_id TEXT NOT NULL,
        username TEXT NOT NULL,
        action TEXT NOT NULL,
        resource_type TEXT NOT NULL,
        resource_id TEXT,
        resource_name TEXT,
        details TEXT,
        ip_address TEXT,
        user_agent TEXT,
        success INTEGER NOT NULL,
        error_message TEXT,
        timestamp TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
        FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE
    );

    CREATE TABLE session_recordings (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        host_id INTEGER NOT NULL,
        user_id TEXT NOT NULL,
        access_id INTEGER,
        started_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
        ended_at TEXT,
        duration INTEGER,
        commands TEXT,
        dangerous_actions TEXT,
        recording_path TEXT,
        protocol TEXT NOT NULL DEFAULT 'ssh',
        format TEXT NOT NULL DEFAULT 'text',
        terminated_by_owner INTEGER DEFAULT 0,
        termination_reason TEXT,
        FOREIGN KEY (host_id) REFERENCES ssh_data (id) ON DELETE CASCADE,
        FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE,
        FOREIGN KEY (access_id) REFERENCES host_access (id) ON DELETE SET NULL
    );

    INSERT INTO users (id, username) VALUES ('u-1', 'alice'), ('u-2', 'bob');
    INSERT INTO ssh_data (id, name) VALUES (1, 'prod-db');

    INSERT INTO audit_logs
      (user_id, username, action, resource_type, resource_id, success, timestamp)
    VALUES
      ('u-1', 'alice', 'host.delete', 'host', '1', 1, '2026-07-01 10:00:00'),
      ('u-1', 'alice', 'credential.view', 'credential', '9', 1, '2026-07-02 11:00:00'),
      ('u-2', 'bob', 'host.create', 'host', '2', 1, '2026-07-03 12:00:00');

    INSERT INTO session_recordings
      (host_id, user_id, started_at, recording_path, protocol, format)
    VALUES
      (1, 'u-1', '2026-07-01 10:00:00', '/rec/a.guac', 'ssh', 'text'),
      (1, 'u-2', '2026-07-03 12:00:00', '/rec/b.guac', 'ssh', 'text');
  `);
  return sqlite;
}

describe("audit retention migration", () => {
  it("detects the destructive shape and reports it fixed afterwards", () => {
    db = legacyDatabase();

    expect(userDeleteIsDestructive(db, "audit_logs")).toBe(true);
    expect(userDeleteIsDestructive(db, "session_recordings")).toBe(true);

    expect(migrateAuditRetention(db)).toEqual([
      "audit_logs",
      "session_recordings",
    ]);

    expect(userDeleteIsDestructive(db, "audit_logs")).toBe(false);
    expect(userDeleteIsDestructive(db, "session_recordings")).toBe(false);
  });

  it("keeps the audit trail when the user is deleted", () => {
    db = legacyDatabase();
    migrateAuditRetention(db);

    db.exec("DELETE FROM users WHERE id = 'u-1'");

    const rows = db
      .prepare(
        "SELECT user_id, username, action FROM audit_logs ORDER BY timestamp",
      )
      .all() as { user_id: string | null; username: string; action: string }[];

    expect(rows).toHaveLength(3);
    // The account is gone, but the record still names who acted.
    expect(rows[0]).toEqual({
      user_id: null,
      username: "alice",
      action: "host.delete",
    });
    expect(rows[2].user_id).toBe("u-2");
  });

  it("backfills a username onto recordings so they stay attributable", () => {
    db = legacyDatabase();
    migrateAuditRetention(db);

    db.exec("DELETE FROM users WHERE id = 'u-1'");

    const rows = db
      .prepare(
        "SELECT user_id, username, recording_path FROM session_recordings ORDER BY started_at",
      )
      .all() as { user_id: string | null; username: string | null }[];

    expect(rows).toHaveLength(2);
    expect(rows[0].user_id).toBeNull();
    expect(rows[0].username).toBe("alice");
  });

  it("loses no data in the copy", () => {
    db = legacyDatabase();
    const before = db
      .prepare("SELECT * FROM audit_logs ORDER BY id")
      .all() as Record<string, unknown>[];

    migrateAuditRetention(db);

    const after = db
      .prepare("SELECT * FROM audit_logs ORDER BY id")
      .all() as Record<string, unknown>[];

    expect(after).toEqual(before);
  });

  it("still cascades recordings when their host is deleted", () => {
    db = legacyDatabase();
    migrateAuditRetention(db);

    db.exec("PRAGMA foreign_keys = ON");
    db.exec("DELETE FROM ssh_data WHERE id = 1");

    expect(
      db.prepare("SELECT COUNT(*) AS n FROM session_recordings").get(),
    ).toEqual({ n: 0 });
  });

  it("is idempotent and leaves an already-migrated database alone", () => {
    db = legacyDatabase();
    migrateAuditRetention(db);

    const rowsAfterFirst = db.prepare("SELECT * FROM audit_logs").all();
    expect(migrateAuditRetention(db)).toEqual([]);
    expect(db.prepare("SELECT * FROM audit_logs").all()).toEqual(
      rowsAfterFirst,
    );
  });

  it("does nothing on a database without the tables", () => {
    db = new Database(":memory:");

    expect(() => migrateAuditRetention(db)).not.toThrow();
    expect(migrateAuditRetention(db)).toEqual([]);
  });
});