Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/openstatusHQ/openstatus. 🫖 Status page with uptime monitoring & API monitoring as code 🫖 openstatus.dev
bun drizzle-orm monitoring monitoring-as-code nextjs observability on-call open-source shadcn-ui status-page statuspage synthetic-monitoring tinybird turso uptime uptime-checker uptime-monitor
Something went wrong. Try again.
9.1 kB · 314 lines
TypeScript
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315import { db, eq, inArray } from "@openstatus/db";import { notification, notificationTrigger, notificationsToMonitors,} from "@openstatus/db/src/schema";import { createMonitor, createNotification, createTestWorkspace, linkNotificationToMonitor,} from "@openstatus/db/src/test/factories";import { afterAll, afterEach, assertSpyCalls, beforeAll, beforeEach, describe, expect, type Stub, stub, test,} from "@openstatus/test-utils";
import { checkerAudit } from "../utils/audit-log";import { triggerNotifications } from "./alerting";import { providerToFunction } from "./utils";
// Deno has no module mocking, so we stub the methods on the real singletons// that alerting.ts reads at call time. Stubbing per-test resolves them to no-op// to avoid real HTTP / Tinybird calls and gives a fresh call count each test.// biome-ignore lint/suspicious/noExplicitAny: heterogeneous provider stubstype AnyStub = Stub<any>;let stubs: AnyStub[] = [];
const stubSend = ( provider: "email" | "slack" | "discord", verb: "sendAlert" | "sendRecovery" | "sendDegraded",): AnyStub => { const s = stub(providerToFunction[provider], verb, () => Promise.resolve()); stubs.push(s); return s;};
let mockEmailSendAlert: AnyStub;let mockEmailSendRecovery: AnyStub;let mockEmailSendDegraded: AnyStub;let mockSlackSendAlert: AnyStub;let mockSlackSendRecovery: AnyStub;let mockSlackSendDegraded: AnyStub;let mockDiscordSendAlert: AnyStub;let mockDiscordSendRecovery: AnyStub;let mockDiscordSendDegraded: AnyStub;
// Own workspace + monitors: asserting on "how many notifications fired for this// monitor" only holds if no other suite can attach one.// Unique cronTimestamp per test avoids unique-constraint conflicts.let workspaceId: number;let emailMonitorId: number;let emailNotificationId: number;let noNotifMonitorId: number;
beforeEach(() => { stubs = []; // biome-ignore lint/suspicious/noExplicitAny: avoid Tinybird call stubs.push( stub(checkerAudit, "publishAuditLog", () => Promise.resolve()) as AnyStub, ); mockEmailSendAlert = stubSend("email", "sendAlert"); mockEmailSendRecovery = stubSend("email", "sendRecovery"); mockEmailSendDegraded = stubSend("email", "sendDegraded"); mockSlackSendAlert = stubSend("slack", "sendAlert"); mockSlackSendRecovery = stubSend("slack", "sendRecovery"); mockSlackSendDegraded = stubSend("slack", "sendDegraded"); mockDiscordSendAlert = stubSend("discord", "sendAlert"); mockDiscordSendRecovery = stubSend("discord", "sendRecovery"); mockDiscordSendDegraded = stubSend("discord", "sendDegraded");});
afterEach(() => { for (const s of stubs) s.restore(); stubs = [];});
beforeAll(async () => { const { workspace } = await createTestWorkspace(); workspaceId = workspace.id; emailMonitorId = (await createMonitor(workspaceId)).id; noNotifMonitorId = (await createMonitor(workspaceId)).id; emailNotificationId = ( await createNotification(workspaceId, { name: "sample test notification", provider: "email", data: JSON.stringify({ email: "ping@openstatus.dev" }), }) ).id; await linkNotificationToMonitor(emailNotificationId, emailMonitorId);});
await describe("triggerNotifications", async () => { test("should send alert notification and return triggered list", async () => { const cronTimestamp = 9000001;
const result = await triggerNotifications({ monitorId: String(emailMonitorId), statusCode: 500, message: "Internal Server Error", notifType: "alert", cronTimestamp, incidentId: undefined, regions: ["ams"], latency: 1500, });
assertSpyCalls(mockEmailSendAlert, 1); expect(result).toHaveLength(1); expect(result[0]).toEqual({ notificationId: emailNotificationId, provider: "email", }); });
test("should send recovery notification and return triggered list", async () => { const cronTimestamp = 9000002;
const result = await triggerNotifications({ monitorId: String(emailMonitorId), statusCode: 200, notifType: "recovery", cronTimestamp, regions: ["ams"], });
assertSpyCalls(mockEmailSendRecovery, 1); expect(result).toHaveLength(1); expect(result[0]).toEqual({ notificationId: emailNotificationId, provider: "email", }); });
test("should send degraded notification and return triggered list", async () => { const cronTimestamp = 9000003;
const result = await triggerNotifications({ monitorId: String(emailMonitorId), statusCode: 200, notifType: "degraded", cronTimestamp, latency: 5000, regions: ["ams"], });
assertSpyCalls(mockEmailSendDegraded, 1); expect(result).toHaveLength(1); expect(result[0]).toEqual({ notificationId: emailNotificationId, provider: "email", }); });
test("should return empty list when monitor has no notifications", async () => { const cronTimestamp = 9000004;
// Monitor 2 has no notifications linked in seed data const result = await triggerNotifications({ monitorId: String(noNotifMonitorId), statusCode: 500, notifType: "alert", cronTimestamp, });
assertSpyCalls(mockEmailSendAlert, 0); expect(result).toHaveLength(0); });
test("should skip duplicate notification trigger for same cronTimestamp", async () => { const cronTimestamp = 9000005;
const first = await triggerNotifications({ monitorId: String(emailMonitorId), statusCode: 500, notifType: "alert", cronTimestamp, });
expect(first).toHaveLength(1); assertSpyCalls(mockEmailSendAlert, 1);
// Same cronTimestamp should be skipped due to unique constraint const second = await triggerNotifications({ monitorId: String(emailMonitorId), statusCode: 500, notifType: "alert", cronTimestamp, });
// still only the first call — the duplicate was skipped assertSpyCalls(mockEmailSendAlert, 1); expect(second).toHaveLength(0); });});
describe("triggerNotifications with multiple providers", () => { const testNotificationIds: number[] = [];
let testMonitorId: number;
beforeAll(async () => { testMonitorId = (await createMonitor(workspaceId)).id; });
afterAll(async () => { // Clean up notification triggers await db .delete(notificationTrigger) .where(eq(notificationTrigger.monitorId, testMonitorId)) .run();
// Clean up notification-to-monitor links await db .delete(notificationsToMonitors) .where(eq(notificationsToMonitors.monitorId, testMonitorId)) .run();
// Clean up test notifications if (testNotificationIds.length > 0) { await db .delete(notification) .where(inArray(notification.id, testNotificationIds)) .run(); } });
test("should trigger all linked providers and return each in the result", async () => { // Create slack notification const [slackNotif] = await db .insert(notification) .values({ name: "test-slack", provider: "slack", data: '{"slack":"https://hooks.slack.com/test"}', workspaceId, }) .returning();
// Create discord notification const [discordNotif] = await db .insert(notification) .values({ name: "test-discord", provider: "discord", data: '{"discord":"https://discord.com/api/webhooks/test"}', workspaceId, }) .returning();
testNotificationIds.push(slackNotif.id, discordNotif.id);
// Link both to monitor 3 await db .insert(notificationsToMonitors) .values([ { monitorId: testMonitorId, notificationId: slackNotif.id }, { monitorId: testMonitorId, notificationId: discordNotif.id }, ]) .run();
const cronTimestamp = 9100001;
const result = await triggerNotifications({ monitorId: String(testMonitorId), statusCode: 500, message: "Server Error", notifType: "alert", cronTimestamp, regions: ["ams"], });
assertSpyCalls(mockSlackSendAlert, 1); assertSpyCalls(mockDiscordSendAlert, 1); assertSpyCalls(mockEmailSendAlert, 0);
expect(result).toHaveLength(2); expect(result).toContainEqual({ notificationId: slackNotif.id, provider: "slack", }); expect(result).toContainEqual({ notificationId: discordNotif.id, provider: "discord", }); });
test("should trigger recovery on all linked providers", async () => { const cronTimestamp = 9100002;
const result = await triggerNotifications({ monitorId: String(testMonitorId), statusCode: 200, notifType: "recovery", cronTimestamp, regions: ["ams"], });
assertSpyCalls(mockSlackSendRecovery, 1); assertSpyCalls(mockDiscordSendRecovery, 1);
expect(result).toHaveLength(2); const providers = result.map((r) => r.provider).sort(); expect(providers).toEqual(["discord", "slack"]); });});