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.
7.5 kB · 250 lines
TypeScript
at incident-api
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251import { selectNotificationSchema } from "@openstatus/db/src/schema";import { COLORS } from "@openstatus/notification-base";import { expect } from "@std/expect";import { afterEach, beforeEach, describe, test } from "@std/testing/bdd";import { assertSpyCalls, type Stub, stub } from "@std/testing/mock";
import { buildAlertBlocks, buildDegradedBlocks, buildRecoveryBlocks, escapeSlackText,} from "./blocks";import { sendAlert, sendDegraded, sendRecovery, sendTestSlackMessage,} from "./index";
describe("Slack Notifications", () => { let fetchMock: Stub<typeof globalThis>;
beforeEach(() => { fetchMock = stub(globalThis, "fetch", () => Promise.resolve(new Response(null, { status: 200 })), ); });
afterEach(() => { fetchMock.restore(); });
const createMockMonitor = () => ({ id: "monitor-1", name: "API Health Check", url: "https://api.example.com/health", jobType: "http" as const, periodicity: "5m" as const, status: "active" as const, createdAt: new Date(), updatedAt: new Date(), region: "us-east-1", });
const createMockNotification = () => ({ id: 1, name: "Slack Notification", provider: "slack", workspaceId: 1, createdAt: new Date(), updatedAt: new Date(), data: '{"slack":"https://hooks.slack.com/services/url"}', });
test("Send Alert", async () => { const monitor = createMockMonitor(); const notification = selectNotificationSchema.parse( createMockNotification(), );
await sendAlert({ // @ts-expect-error monitor, notification, statusCode: 500, message: "Something went wrong", cronTimestamp: Date.now(), });
assertSpyCalls(fetchMock, 1); const callArgs = fetchMock.calls[0].args; expect(callArgs[0]).toBe("https://hooks.slack.com/services/url"); expect(callArgs[1].method).toBe("POST");
const body = JSON.parse(callArgs[1].body); expect(body.attachments).toBeDefined(); expect(body.attachments[0].color).toBe(COLORS.red); expect(body.attachments[0].blocks).toBeDefined(); expect(body.attachments[0].blocks.length).toBeGreaterThan(0); expect(body.attachments[0].blocks[0].text.text).toContain("is failing"); });
test("Send Alert without statusCode", async () => { const monitor = createMockMonitor(); const notification = selectNotificationSchema.parse( createMockNotification(), );
await sendAlert({ // @ts-expect-error monitor, notification, message: "Connection timeout", cronTimestamp: Date.now(), });
assertSpyCalls(fetchMock, 1); const callArgs = fetchMock.calls[0].args; const body = JSON.parse(callArgs[1].body); expect(body.attachments[0].color).toBe(COLORS.red); expect(body.attachments[0].blocks[3].fields[0].text).toContain("Unknown"); });
test("Send Recovery", async () => { const monitor = createMockMonitor(); const notification = selectNotificationSchema.parse( createMockNotification(), );
await sendRecovery({ // @ts-expect-error monitor, notification, statusCode: 200, message: "Service recovered", cronTimestamp: Date.now(), });
assertSpyCalls(fetchMock, 1); const callArgs = fetchMock.calls[0].args; const body = JSON.parse(callArgs[1].body); expect(body.attachments).toBeDefined(); expect(body.attachments[0].color).toBe(COLORS.green); expect(body.attachments[0].blocks[0].text.text).toContain("is recovered"); });
test("Send Degraded", async () => { const monitor = createMockMonitor(); const notification = selectNotificationSchema.parse( createMockNotification(), );
await sendDegraded({ // @ts-expect-error monitor, notification, statusCode: 503, message: "Service degraded", cronTimestamp: Date.now(), });
assertSpyCalls(fetchMock, 1); const callArgs = fetchMock.calls[0].args; const body = JSON.parse(callArgs[1].body); expect(body.attachments).toBeDefined(); expect(body.attachments[0].color).toBe(COLORS.yellow); expect(body.attachments[0].blocks[0].text.text).toContain("is degraded"); });
test("Send Test Slack Message", async () => { const webhookUrl = "https://hooks.slack.com/services/test/url";
await sendTestSlackMessage(webhookUrl);
assertSpyCalls(fetchMock, 1); const callArgs = fetchMock.calls[0].args; expect(callArgs[0]).toBe(webhookUrl);
const body = JSON.parse(callArgs[1].body); expect(body.attachments[0].blocks[0].text.text).toContain( "Test Notification", ); });
test("Send Test Slack Message throws error on empty webhookUrl", async () => { fetchMock.restore(); fetchMock = stub(globalThis, "fetch", () => Promise.reject(new Error("Network error")), );
expect(sendTestSlackMessage("")).rejects.toThrow(); assertSpyCalls(fetchMock, 0); });
test("Handle fetch error gracefully", async () => { fetchMock.restore(); fetchMock = stub(globalThis, "fetch", () => Promise.reject(new Error("Network error")), );
const monitor = createMockMonitor(); const notification = selectNotificationSchema.parse( createMockNotification(), );
await expect( sendAlert({ // @ts-expect-error monitor, notification, statusCode: 500, message: "Error", cronTimestamp: Date.now(), }), ).rejects.toThrow();
assertSpyCalls(fetchMock, 1); });});
describe("Slack title limits", () => { for (const [build, suffix] of [ [buildAlertBlocks, " is failing"], [buildRecoveryBlocks, " is recovered"], [buildDegradedBlocks, " is degraded"], ] as const) { test(`${build.name} keeps the status and complete characters within 150 characters`, () => { for (const monitorName of [ "API Health", "A".repeat(150 - suffix.length), "A".repeat(255), "A & <B>", "&<>".repeat(20), "&<>".repeat(85), "\u{1F680}".repeat(127), `A${"\u{1F680}".repeat(127)}`, ]) { const data = Object.freeze({ monitorName, monitorUrl: "https://example.com/health", monitorJobType: "http", statusCodeFormatted: "503 Service Unavailable", errorMessage: "Connection timeout", timestampFormatted: "Sep 9, 2026 at 00:00 UTC", regionsDisplay: "iad", latencyDisplay: "100ms", dashboardUrl: "https://app.openstatus.dev/monitors/1", }); const header = build(data).find((block) => block.type === "header"); if (header?.type !== "header") throw new Error("Missing Slack header"); const title = header.text.text; expect(title.length).toBeLessThanOrEqual(150); expect(title.endsWith(suffix)).toBe(true); const name = title.slice(0, -suffix.length); expect(name).not.toMatch(/&(?!amp;|lt;|gt;)/); expect(name.isWellFormed()).toBe(true); const decoded = name .replace(/</g, "<") .replace(/>/g, ">") .replace(/&/g, "&"); expect(decoded.length).toBeGreaterThan(0); expect(monitorName.startsWith(decoded)).toBe(true); if (escapeSlackText(monitorName).length <= 150 - suffix.length) { expect(decoded).toBe(monitorName); } expect(data.monitorName).toBe(monitorName); } }); }});