Skip to content

Open-source status page, incident response and uptime monitoring

21.0 KB
Raw Blame
import { db, eq } from "@openstatus/db";
import { auditLog, user } from "@openstatus/db/src/schema";
import type { AuditEntry } from "@openstatus/db/src/schema";
import { afterAll, beforeAll, describe, expect, test } from "vitest";

import {
  clearAuditLog,
  createWorkspaceFixture,
  makeApiKeyCtx,
  makeSlackCtx,
  makeSystemCtx,
  makeUserCtx,
  readAuditLog,
  withTestTransaction,
} from "../../../test/helpers";
import type { ServiceContext } from "../../context";
import { NotFoundError } from "../../errors";
import { diffTopLevel, emitAudit } from "../emit";
import { getAuditLog } from "../get";

/**
 * Test-only escape hatch around `emitAudit`'s compile-time snapshot
 * contract (`.create` requires `after`, `.delete` requires `before`,
 * `.update` requires both). Several tests here intentionally pass
 * bare entries to exercise the runtime path — column persistence,
 * actor derivation, ordering — without caring about snapshot shape.
 * Real call sites must satisfy the full type.
 */
async function emitLoose(
  tx: Parameters<typeof emitAudit>[0],
  ctx: ServiceContext,
  entry: unknown,
) {
  return emitAudit(tx, ctx, entry as AuditEntry);
}

let teamCtx: ServiceContext;
let teamUserId: number;
let otherCtx: ServiceContext;

beforeAll(async () => {
  const team = await createWorkspaceFixture("team");
  teamUserId = team.userId;
  teamCtx = makeUserCtx(team.workspace, { userId: teamUserId });
  // Built here rather than inside a test: `withTestTransaction` holds an open
  // transaction on the shared connection, and a committed write mid-stream
  // aborts it.
  const other = await createWorkspaceFixture("free");
  otherCtx = makeUserCtx(other.workspace, { userId: other.userId });
  // Wipe rows from prior aborted runs — the fail-closed test below runs
  // outside `withTestTransaction` and could leak on a botched prior run.
  await clearAuditLog(teamCtx.workspace.id);
});

afterAll(async () => {
  await clearAuditLog(teamCtx.workspace.id);
});

describe("diffTopLevel", () => {
  test("empty when objects are equal", () => {
    const result = diffTopLevel(
      { name: "a", count: 1 },
      { name: "a", count: 1 },
    );
    expect(result).toEqual([]);
  });

  test("reports top-level keys that differ", () => {
    const result = diffTopLevel(
      { name: "a", count: 1 },
      { name: "b", count: 1 },
    );
    expect(result).toEqual(["name"]);
  });

  test("reports additions and removals as changed", () => {
    const added = diffTopLevel({ name: "a" }, { name: "a", extra: "x" });
    expect(added).toEqual(["extra"]);
    const removed = diffTopLevel({ name: "a", extra: "x" }, { name: "a" });
    expect(removed).toEqual(["extra"]);
  });

  test("ignores updatedAt and createdAt", () => {
    const before = {
      name: "a",
      createdAt: new Date("2025-01-01"),
      updatedAt: new Date("2025-01-01"),
    };
    const after = {
      name: "a",
      createdAt: new Date("2025-06-01"),
      updatedAt: new Date("2025-06-01"),
    };
    expect(diffTopLevel(before, after)).toEqual([]);
  });

  test("reports non-ignored changes alongside ignored ones", () => {
    const before = {
      name: "a",
      updatedAt: new Date("2025-01-01"),
    };
    const after = {
      name: "b",
      updatedAt: new Date("2025-06-01"),
    };
    expect(diffTopLevel(before, after)).toEqual(["name"]);
  });

  test("treats null and undefined as absent — both absent means unchanged", () => {
    expect(diffTopLevel({ a: null }, { a: undefined })).toEqual([]);
    expect(diffTopLevel({ a: undefined }, { a: null })).toEqual([]);
    expect(diffTopLevel({}, { a: null })).toEqual([]);
    expect(diffTopLevel({ a: null }, {})).toEqual([]);
  });

  test("treats null → value as changed", () => {
    expect(diffTopLevel({ a: null }, { a: "x" })).toEqual(["a"]);
    expect(diffTopLevel({ a: "x" }, { a: null })).toEqual(["a"]);
  });

  test("top-level only — nested object changes report the parent key", () => {
    const before = { headers: { Authorization: "old" }, name: "a" };
    const after = { headers: { Authorization: "new" }, name: "a" };
    expect(diffTopLevel(before, after)).toEqual(["headers"]);
  });

  test("array equality is deep, not reference-based", () => {
    const before = { tags: [1, 2, 3] };
    const after = { tags: [1, 2, 3] };
    expect(diffTopLevel(before, after)).toEqual([]);
    const changed = diffTopLevel({ tags: [1, 2] }, { tags: [1, 2, 3] });
    expect(changed).toEqual(["tags"]);
  });
});

describe("emitAudit — row persistence", () => {
  test("inserts a row with the expected columns", async () => {
    await withTestTransaction(async (tx) => {
      await emitLoose(tx, teamCtx, {
        action: "monitor.create",
        entityType: "monitor",
        entityId: 9001,
        metadata: { jobType: "http", url: "https://example.com" },
      });

      const rows = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "monitor",
        entityId: 9001,
        db: tx,
      });
      expect(rows).toHaveLength(1);
      const row = rows[0];
      expect(row).toBeDefined();
      if (!row) throw new Error("unreachable");
      expect(row.workspaceId).toBe(teamCtx.workspace.id);
      expect(row.action).toBe("monitor.create");
      expect(row.entityType).toBe("monitor");
      expect(row.entityId).toBe("9001");
      expect(row.actorType).toBe("user");
      expect(row.actorId).toBe(String(teamUserId));
      expect(row.actorUserId).toBe(teamUserId);
      expect(row.metadata).toEqual({
        jobType: "http",
        url: "https://example.com",
      });
      expect(row.before).toBeNull();
      expect(row.after).toBeNull();
      expect(row.changedFields).toBeNull();
      expect(row.createdAt).toBeInstanceOf(Date);
    });
  });

  test("stringifies numeric entityIds", async () => {
    await withTestTransaction(async (tx) => {
      await emitLoose(tx, teamCtx, {
        action: "page.delete",
        entityType: "page",
        entityId: 42,
      });
      const [row] = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "page",
        entityId: 42,
        db: tx,
      });
      expect(row?.entityId).toBe("42");
    });
  });

  // This test intentionally runs OUTSIDE `withTestTransaction`. Its whole
  // point is to verify that a real outer transaction rolls back when an
  // emit-bearing block throws — wrapping it in another tx would assert
  // against the wrapping tx instead of the committed db.
  test("fail-closed: insert error rolls the enclosing tx back", async () => {
    let threw = false;
    try {
      await db.transaction(async (tx) => {
        await emitLoose(tx, teamCtx, {
          action: "monitor.create",
          entityType: "monitor",
          entityId: 9002,
        });
        throw new Error("simulated downstream failure");
      });
    } catch {
      threw = true;
    }
    expect(threw).toBe(true);
    const rows = await readAuditLog({
      workspaceId: teamCtx.workspace.id,
      entityType: "monitor",
      entityId: 9002,
    });
    expect(rows).toHaveLength(0);
  });
});

describe("emitAudit — changed_fields derivation", () => {
  test("null when only after is supplied (create-shape)", async () => {
    await withTestTransaction(async (tx) => {
      await emitAudit(tx, teamCtx, {
        action: "monitor.create",
        entityType: "monitor",
        entityId: 9100,
        after: { name: "fresh" },
      });
      const [row] = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "monitor",
        entityId: 9100,
        db: tx,
      });
      expect(row?.changedFields).toBeNull();
    });
  });

  test("null when only before is supplied (delete-shape)", async () => {
    await withTestTransaction(async (tx) => {
      await emitAudit(tx, teamCtx, {
        action: "monitor.delete",
        entityType: "monitor",
        entityId: 9101,
        before: { name: "going" },
      });
      const [row] = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "monitor",
        entityId: 9101,
        db: tx,
      });
      expect(row?.changedFields).toBeNull();
    });
  });

  test("no-op update (before === after) skips the insert entirely", async () => {
    await withTestTransaction(async (tx) => {
      await emitAudit(tx, teamCtx, {
        action: "monitor.update",
        entityType: "monitor",
        entityId: 9102,
        before: { name: "same", url: "https://x" },
        after: { name: "same", url: "https://x" },
      });
      const rows = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "monitor",
        entityId: 9102,
        db: tx,
      });
      expect(rows).toHaveLength(0);
    });
  });

  test("ignoring updatedAt/createdAt only → still a no-op, still skipped", async () => {
    await withTestTransaction(async (tx) => {
      await emitAudit(tx, teamCtx, {
        action: "monitor.update",
        entityType: "monitor",
        entityId: 9105,
        before: { name: "a", updatedAt: new Date("2025-01-01") },
        after: { name: "a", updatedAt: new Date("2025-06-01") },
      });
      const rows = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "monitor",
        entityId: 9105,
        db: tx,
      });
      expect(rows).toHaveLength(0);
    });
  });

  test("metadata-only update with empty row diff still lands", async () => {
    // Off-row mutations (e.g. component-scope edits on `page_subscriber`)
    // change a join table, not the row itself — `before === after` for
    // every column. The metadata is the signal, so the row must land.
    await withTestTransaction(async (tx) => {
      await emitLoose(tx, teamCtx, {
        action: "page_subscriber.update",
        entityType: "page_subscriber",
        entityId: 9106,
        before: { name: "same" },
        after: { name: "same" },
        metadata: { componentIds: [1, 2] },
      });
      const rows = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "page_subscriber",
        entityId: 9106,
        db: tx,
      });
      expect(rows).toHaveLength(1);
      expect(rows[0]?.changedFields).toEqual([]);
      expect(rows[0]?.metadata).toEqual({ componentIds: [1, 2] });
    });
  });

  test("populated with the changed top-level keys", async () => {
    await withTestTransaction(async (tx) => {
      await emitAudit(tx, teamCtx, {
        action: "monitor.update",
        entityType: "monitor",
        entityId: 9103,
        before: { name: "old", url: "https://a", method: "GET" },
        after: { name: "new", url: "https://b", method: "GET" },
      });
      const [row] = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "monitor",
        entityId: 9103,
        db: tx,
      });
      expect(row?.changedFields?.sort()).toEqual(["name", "url"]);
    });
  });

  test("ignores updatedAt when computing the diff — a real change still records only the real key", async () => {
    await withTestTransaction(async (tx) => {
      await emitAudit(tx, teamCtx, {
        action: "monitor.update",
        entityType: "monitor",
        entityId: 9104,
        before: { name: "old", updatedAt: new Date("2025-01-01") },
        after: { name: "new", updatedAt: new Date("2025-06-01") },
      });
      const [row] = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "monitor",
        entityId: 9104,
        db: tx,
      });
      expect(row?.changedFields).toEqual(["name"]);
    });
  });
});

describe("emitAudit — actor derivation", () => {
  test("user actor → actorId and actorUserId are the same id", async () => {
    await withTestTransaction(async (tx) => {
      await emitLoose(tx, teamCtx, {
        action: "workspace.update",
        entityType: "workspace",
        entityId: teamCtx.workspace.id,
      });
      const [row] = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "workspace",
        db: tx,
      });
      expect(row?.actorType).toBe("user");
      expect(row?.actorId).toBe(String(teamUserId));
      expect(row?.actorUserId).toBe(teamUserId);
    });
  });

  test("apiKey actor without linked user → actorUserId null", async () => {
    await withTestTransaction(async (tx) => {
      const ctx = makeApiKeyCtx(teamCtx.workspace, { keyId: "k_anon" });
      await emitLoose(tx, ctx, {
        action: "api_key.delete",
        entityType: "api_key",
        entityId: 9200,
      });
      const [row] = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "api_key",
        entityId: 9200,
        db: tx,
      });
      expect(row?.actorType).toBe("apiKey");
      expect(row?.actorId).toBe("k_anon");
      expect(row?.actorUserId).toBeNull();
    });
  });

  test("apiKey actor with linked user → actorUserId populated", async () => {
    await withTestTransaction(async (tx) => {
      const ctx = makeApiKeyCtx(teamCtx.workspace, {
        keyId: "k_linked",
        userId: 42,
      });
      await emitLoose(tx, ctx, {
        action: "api_key.delete",
        entityType: "api_key",
        entityId: 9201,
      });
      const [row] = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "api_key",
        entityId: 9201,
        db: tx,
      });
      expect(row?.actorType).toBe("apiKey");
      expect(row?.actorId).toBe("k_linked");
      expect(row?.actorUserId).toBe(42);
    });
  });

  test("slack actor → actorId is slackUserId", async () => {
    await withTestTransaction(async (tx) => {
      const ctx = makeSlackCtx(teamCtx.workspace, {
        teamId: "T1",
        slackUserId: "U9",
        userId: 7,
      });
      await emitLoose(tx, ctx, {
        action: "maintenance.update",
        entityType: "maintenance",
        entityId: 9300,
      });
      const [row] = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "maintenance",
        entityId: 9300,
        db: tx,
      });
      expect(row?.actorType).toBe("slack");
      expect(row?.actorId).toBe("U9");
      expect(row?.actorUserId).toBe(7);
    });
  });

  test("system actor → actorId is the job name, actorUserId null", async () => {
    await withTestTransaction(async (tx) => {
      const ctx = makeSystemCtx(teamCtx.workspace, { job: "cleanup-job" });
      await emitLoose(tx, ctx, {
        action: "monitor.delete",
        entityType: "monitor",
        entityId: 9400,
      });
      const [row] = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "monitor",
        entityId: 9400,
        db: tx,
      });
      expect(row?.actorType).toBe("system");
      expect(row?.actorId).toBe("cleanup-job");
      expect(row?.actorUserId).toBeNull();
    });
  });
});

describe("emitAudit — ordering", () => {
  test("autoincrement id provides a stable tiebreaker within the same ms", async () => {
    await withTestTransaction(async (tx) => {
      for (let i = 0; i < 5; i++) {
        await emitLoose(tx, teamCtx, {
          action: "monitor.update",
          entityType: "monitor",
          entityId: 9500 + i,
        });
      }
      const rows = await tx
        .select()
        .from(auditLog)
        .where(eq(auditLog.workspaceId, teamCtx.workspace.id))
        .orderBy(auditLog.id)
        .all();
      const emitted = rows.filter(
        (r) =>
          r.action === "monitor.update" &&
          Number(r.entityId) >= 9500 &&
          Number(r.entityId) < 9505,
      );
      expect(emitted).toHaveLength(5);
      const ids = emitted.map((r) => Number(r.entityId));
      expect(ids).toEqual([9500, 9501, 9502, 9503, 9504]);
      // Ids are monotonically increasing → reads ordered by (createdAt DESC, id DESC)
      // get a deterministic order even when createdAt collides.
      for (let i = 1; i < emitted.length; i++) {
        const prev = emitted[i - 1];
        const curr = emitted[i];
        if (!prev || !curr) throw new Error("unreachable");
        expect(curr.id).toBeGreaterThan(prev.id);
      }
    });
  });
});

describe("emitAudit — entry-shape regressions", () => {
  test("entry without metadata serializes null to the metadata column", async () => {
    await withTestTransaction(async (tx) => {
      await emitLoose(tx, teamCtx, {
        action: "monitor.update",
        entityType: "monitor",
        entityId: 9600,
      });
      const [row] = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "monitor",
        entityId: 9600,
        db: tx,
      });
      expect(row?.metadata).toBeNull();
    });
  });
});

describe("emitAudit — runtime Zod validation", () => {
  test("rejects an unknown action string", async () => {
    await withTestTransaction(async (tx) => {
      let threw = false;
      try {
        await emitAudit(tx, teamCtx, {
          // Cast through unknown — the runtime check is exactly the
          // point being tested; at compile time this would be a TS error.
          action: "monitor.bogus",
          entityType: "monitor",
          entityId: 9700,
        } as unknown as AuditEntry);
      } catch {
        threw = true;
      }
      expect(threw).toBe(true);
      const rows = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "monitor",
        entityId: 9700,
        db: tx,
      });
      expect(rows).toHaveLength(0);
    });
  });

  test("rejects a mismatched entityType for a known action", async () => {
    await withTestTransaction(async (tx) => {
      let threw = false;
      try {
        await emitAudit(tx, teamCtx, {
          action: "monitor.create",
          // `monitor.create` is bound to entityType: "monitor"; this should
          // fail the discriminator.
          entityType: "page",
          entityId: 9701,
        } as unknown as AuditEntry);
      } catch {
        threw = true;
      }
      expect(threw).toBe(true);
    });
  });

  test("rejects a non-integer entityId", async () => {
    await withTestTransaction(async (tx) => {
      let threw = false;
      try {
        await emitAudit(tx, teamCtx, {
          action: "monitor.delete",
          entityType: "monitor",
          // The schema requires `intId`; floats should fail.
          entityId: 1.5,
        } as unknown as AuditEntry);
      } catch {
        threw = true;
      }
      expect(threw).toBe(true);
    });
  });
});

describe("getAuditLog", () => {
  test("returns the row when scoped to the same workspace", async () => {
    await withTestTransaction(async (tx) => {
      await emitAudit(tx, teamCtx, {
        action: "monitor.update",
        entityType: "monitor",
        entityId: 9800,
        before: { name: "old" },
        after: { name: "new" },
      });
      const [inserted] = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "monitor",
        entityId: 9800,
        db: tx,
      });
      if (!inserted) throw new Error("unreachable");

      const row = await getAuditLog({
        ctx: { ...teamCtx, db: tx },
        input: { id: inserted.id },
      });
      expect(row.id).toBe(inserted.id);
      expect(row.action).toBe("monitor.update");
      expect(row.entityType).toBe("monitor");
      expect(row.entityId).toBe("9800");
      expect(row.changedFields).toEqual(["name"]);
      expect(row.user?.id).toBe(teamUserId);
    });
  });

  test("throws NotFoundError when the id belongs to another workspace", async () => {
    await withTestTransaction(async (tx) => {
      await emitAudit(tx, teamCtx, {
        action: "monitor.create",
        entityType: "monitor",
        entityId: 9801,
        after: { name: "in-team" },
      });
      const [inserted] = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "monitor",
        entityId: 9801,
        db: tx,
      });
      if (!inserted) throw new Error("unreachable");

      let caught: unknown;
      try {
        await getAuditLog({
          ctx: { ...otherCtx, db: tx },
          input: { id: inserted.id },
        });
      } catch (e) {
        caught = e;
      }
      expect(caught).toBeInstanceOf(NotFoundError);
    });
  });

  test("soft-deleted actor resolves to user: null", async () => {
    await withTestTransaction(async (tx) => {
      const ghostUserId = 9_999_001;
      await tx
        .insert(user)
        .values({
          id: ghostUserId,
          tenantId: `ghost-${ghostUserId}`,
          email: `ghost-${ghostUserId}@example.test`,
          deletedAt: new Date("2025-01-01"),
        })
        .run();

      const ghostCtx = makeUserCtx(teamCtx.workspace, { userId: ghostUserId });
      await emitAudit(tx, ghostCtx, {
        action: "monitor.create",
        entityType: "monitor",
        entityId: 9802,
        after: { name: "by-ghost" },
      });
      const [inserted] = await readAuditLog({
        workspaceId: teamCtx.workspace.id,
        entityType: "monitor",
        entityId: 9802,
        db: tx,
      });
      if (!inserted) throw new Error("unreachable");
      expect(inserted.actorUserId).toBe(ghostUserId);

      const row = await getAuditLog({
        ctx: { ...teamCtx, db: tx },
        input: { id: inserted.id },
      });
      expect(row.user).toBeNull();
    });
  });
});