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.6 kB · 241 lines
TypeScript
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242import "./test-preload.ts";import { expect } from "@std/expect";import { afterEach, beforeEach, describe, test } from "@std/testing/bdd";import { assertSpyCalls, returnsNext, type Stub, stub,} from "@std/testing/mock";
import { EmailClient } from "./client";
function makeSubscribers(n: number) { return Array.from({ length: n }, (_, i) => ({ email: `user-${i}@example.com`, token: `token-${i}`, }));}
function baseReq( overrides: Partial<Parameters<EmailClient["sendStatusReportUpdate"]>[0]> = {},) { return { subscribers: makeSubscribers(1), pageSlug: "demo", pageTitle: "Demo", reportTitle: "Outage", status: "investigating" as const, date: "2026-04-21T09:59:58Z", message: "We are investigating.", pageComponents: [] as string[], ...overrides, };}
// biome-ignore lint/suspicious/noExplicitAny: test doubles for the Resend batch resultconst ok = { data: { data: [] }, error: null } as any;// biome-ignore lint/suspicious/noExplicitAny: simulated Resend application errorconst fail = { data: null, error: { name: "application_error" } } as any;// biome-ignore lint/suspicious/noExplicitAny: simulated Resend 409 conflictconst idempotencyConflict = { data: null, error: { name: "invalid_idempotent_request" },} as any;
describe("EmailClient.sendStatusReportUpdate - idempotency & chunking", () => { let client: EmailClient; // biome-ignore lint/suspicious/noExplicitAny: stub over the Resend batch method let batchSend: Stub<any>;
beforeEach(() => { // zero backoff so the retry test doesn't wait on the real exponential sleep client = new EmailClient({ apiKey: "re_test_123", retryBackoff: "0 millis", }); batchSend = stub(client.client.batch, "send", () => Promise.resolve(ok)); });
afterEach(() => { batchSend.restore(); });
test("passes the base idempotency key suffixed with the batch index", async () => { await client.sendStatusReportUpdate( baseReq({ idempotencyKey: "status-report-update:5" }), );
assertSpyCalls(batchSend, 1); const options = batchSend.calls[0].args[1]; expect(options).toEqual({ idempotencyKey: "status-report-update:5:0" }); });
test("gives each 100-recipient chunk a distinct key and its own slice", async () => { await client.sendStatusReportUpdate( baseReq({ subscribers: makeSubscribers(250), idempotencyKey: "status-report-update:9", }), );
assertSpyCalls(batchSend, 3); const keys = batchSend.calls.map((c) => c.args[1]?.idempotencyKey); expect(keys).toEqual([ "status-report-update:9:0", "status-report-update:9:1", "status-report-update:9:2", ]); const sizes = batchSend.calls.map((c) => c.args[0].length); expect(sizes).toEqual([100, 100, 50]); });
test("omits the option entirely when no base key is provided", async () => { await client.sendStatusReportUpdate(baseReq());
const options = batchSend.calls[0].args[1]; expect(options).toBeUndefined(); });
test("reuses the same key across a retry so Resend dedupes the resend", async () => { batchSend.restore(); batchSend = stub( client.client.batch, "send", returnsNext([Promise.resolve(fail), Promise.resolve(ok)]), );
await client.sendStatusReportUpdate( baseReq({ idempotencyKey: "status-report-update:7" }), );
// failure → retry: the second attempt must carry the identical key, or // Resend would treat the retry as a fresh batch and double-send. assertSpyCalls(batchSend, 2); const keys = batchSend.calls.map((c) => c.args[1]?.idempotencyKey); expect(keys).toEqual([ "status-report-update:7:0", "status-report-update:7:0", ]); });
test("does not retry a deterministic idempotency conflict", async () => { batchSend.restore(); batchSend = stub(client.client.batch, "send", () => Promise.resolve(idempotencyConflict), );
await client.sendStatusReportUpdate( baseReq({ idempotencyKey: "status-report-update:7" }), );
// a 409 invalid_idempotent_request replays identically on every attempt; // retrying only re-logs the same error. assertSpyCalls(batchSend, 1); });});
describe("EmailClient.sendMonitorAlert", () => { let client: EmailClient; // biome-ignore lint/suspicious/noExplicitAny: stub over the Resend send method let send: Stub<any>;
beforeEach(() => { client = new EmailClient({ apiKey: "re_test_123" }); send = stub(client.client.emails, "send", () => Promise.resolve(ok)); });
afterEach(() => { send.restore(); });
const req = { to: "ping@openstatus.dev", type: "degraded" as const, monitorId: 42, name: "Ping Pong", url: "https://openstatus.dev/ping", status: "200", latency: "300 ms", region: "Amsterdam, Netherlands", degradedAfter: 250, };
test("sends the rendered template from the system sender", async () => { await client.sendMonitorAlert(req);
assertSpyCalls(send, 1); const payload = send.calls[0].args[0]; expect(payload.to).toBe("ping@openstatus.dev"); expect(payload.from).toBe( "openstatus <notifications@notifications.openstatus.dev>", ); expect(payload.replyTo).toBe("ping@openstatus.dev"); expect(payload.subject).toBe( "Ping Pong is slow — 300 ms from Amsterdam, Netherlands", ); expect(payload.html).toContain("Ping Pong is answering slowly"); expect(payload.html).toContain("threshold 250 ms"); expect(payload.html).toContain("https://app.openstatus.dev/monitors/42"); });
test("rethrows a Resend error so the outbox can retry", async () => { send.restore(); send = stub(client.client.emails, "send", () => Promise.resolve(fail));
await expect(client.sendMonitorAlert(req)).rejects.toEqual({ name: "application_error", }); });});
describe("EmailClient.sendPrivateLocationAlert", () => { let client: EmailClient; // biome-ignore lint/suspicious/noExplicitAny: stub over the Resend batch method let batchSend: Stub<any>;
beforeEach(() => { client = new EmailClient({ apiKey: "re_test_123" }); batchSend = stub(client.client.batch, "send", () => Promise.resolve(ok)); });
afterEach(() => { batchSend.restore(); });
const req = { to: ["a@example.com", "b@example.com"], locationName: "eu-west-private", status: "error" as const, lastSeenAt: new Date("2026-07-23T10:00:00Z"), monitorCount: 4, };
test("sends one mail per member with subject, sender and body", async () => { await client.sendPrivateLocationAlert(req);
assertSpyCalls(batchSend, 1); const emails = batchSend.calls[0].args[0]; expect(emails.map((e: { to: string }) => e.to)).toEqual(req.to); expect(emails[0].from).toBe( "openstatus <notifications@notifications.openstatus.dev>", ); expect(emails[0].subject).toBe( 'Checks paused — "eu-west-private" stopped reporting', ); expect(emails[0].html).toContain("4 monitors"); expect(emails[0].html).toContain("23 Jul, 10:00 UTC"); });
test("does nothing without recipients", async () => { await client.sendPrivateLocationAlert({ ...req, to: [] }); assertSpyCalls(batchSend, 0); });
test("swallows a non rate-limit failure", async () => { batchSend.restore(); batchSend = stub(client.client.batch, "send", () => Promise.resolve(fail)); await client.sendPrivateLocationAlert(req); assertSpyCalls(batchSend, 1); });});