Skip to content

Open-source status page, incident response and uptime monitoring

feat: page-components [api] [Part 2.5] (#1777)

Maximilian Kaske90027d0ea549
diff --git a/apps/server/src/routes/v1/maintenances/get.test.ts b/apps/server/src/routes/v1/maintenances/get.test.ts
index fed0d509a..f239d61cb 100644
--- a/apps/server/src/routes/v1/maintenances/get.test.ts
+++ b/apps/server/src/routes/v1/maintenances/get.test.ts
@@ -14,6 +14,20 @@ test("return the maintenance", async () => {
expect(result.success).toBe(true);
});
+test("return the maintenance with monitorIds", async () => {
+ const res = await app.request("/v1/maintenance/1", {
+ headers: {
+ "x-openstatus-key": "1",
+ },
+ });
+ const result = MaintenanceSchema.safeParse(await res.json());
+
+ expect(res.status).toBe(200);
+ expect(result.success).toBe(true);
+ expect(result.data?.monitorIds).toBeDefined();
+ expect(Array.isArray(result.data?.monitorIds)).toBe(true);
+});
+
test("no auth key should return 401", async () => {
const res = await app.request("/v1/maintenance/1");
diff --git a/apps/server/src/routes/v1/maintenances/get.ts b/apps/server/src/routes/v1/maintenances/get.ts
index 31f0b9418..170f6cc1e 100644
--- a/apps/server/src/routes/v1/maintenances/get.ts
+++ b/apps/server/src/routes/v1/maintenances/get.ts
@@ -1,4 +1,5 @@
import { OpenStatusApiError, openApiErrorResponses } from "@/libs/errors";
+import { notEmpty } from "@/utils/not-empty";
import { createRoute } from "@hono/zod-openapi";
import { and, db, eq } from "@openstatus/db";
import { maintenance } from "@openstatus/db/src/schema/maintenances";
@@ -33,7 +34,7 @@ export function registerGetMaintenance(api: typeof maintenancesApi) {
const _maintenance = await db.query.maintenance.findFirst({
with: {
- maintenancesToMonitors: true,
+ maintenancesToPageComponents: { with: { pageComponent: true } },
},
where: and(
eq(maintenance.id, Number(id)),
@@ -50,7 +51,9 @@ export function registerGetMaintenance(api: typeof maintenancesApi) {
const data = MaintenanceSchema.parse({
..._maintenance,
- monitorIds: _maintenance.maintenancesToMonitors.map((m) => m.monitorId),
+ monitorIds: _maintenance.maintenancesToPageComponents
+ .map((m) => m.pageComponent.monitorId)
+ .filter(notEmpty),
});
return c.json(data, 200);
diff --git a/apps/server/src/routes/v1/maintenances/get_all.test.ts b/apps/server/src/routes/v1/maintenances/get_all.test.ts
index c2e087511..c905b5d59 100644
--- a/apps/server/src/routes/v1/maintenances/get_all.test.ts
+++ b/apps/server/src/routes/v1/maintenances/get_all.test.ts
@@ -17,6 +17,26 @@ test("return all maintenances", async () => {
expect(result.data?.length).toBeGreaterThan(0);
});
+test("return all maintenances with monitorIds", async () => {
+ const res = await app.request("/v1/maintenance", {
+ method: "GET",
+ headers: {
+ "x-openstatus-key": "1",
+ },
+ });
+
+ const result = MaintenanceSchema.array().safeParse(await res.json());
+
+ expect(res.status).toBe(200);
+ expect(result.success).toBe(true);
+ expect(result.data?.length).toBeGreaterThan(0);
+ // Each maintenance should have monitorIds defined
+ for (const maintenance of result.data || []) {
+ expect(maintenance.monitorIds).toBeDefined();
+ expect(Array.isArray(maintenance.monitorIds)).toBe(true);
+ }
+});
+
test("return empty maintenances", async () => {
const res = await app.request("/v1/maintenance", {
method: "GET",
diff --git a/apps/server/src/routes/v1/maintenances/get_all.ts b/apps/server/src/routes/v1/maintenances/get_all.ts
index a46956fc6..fd9a13744 100644
--- a/apps/server/src/routes/v1/maintenances/get_all.ts
+++ b/apps/server/src/routes/v1/maintenances/get_all.ts
@@ -1,4 +1,5 @@
import { openApiErrorResponses } from "@/libs/errors";
+import { notEmpty } from "@/utils/not-empty";
import { createRoute } from "@hono/zod-openapi";
import { db, desc, eq } from "@openstatus/db";
import { maintenance } from "@openstatus/db/src/schema/maintenances";
@@ -30,7 +31,7 @@ export function registerGetAllMaintenances(api: typeof maintenancesApi) {
const _maintenances = await db.query.maintenance.findMany({
with: {
- maintenancesToMonitors: true,
+ maintenancesToPageComponents: { with: { pageComponent: true } },
},
where: eq(maintenance.workspaceId, workspaceId),
orderBy: desc(maintenance.createdAt),
@@ -39,7 +40,9 @@ export function registerGetAllMaintenances(api: typeof maintenancesApi) {
const data = MaintenanceSchema.array().parse(
_maintenances.map((m) => ({
...m,
- monitorIds: m.maintenancesToMonitors.map((mtm) => mtm.monitorId),
+ monitorIds: m.maintenancesToPageComponents
+ .map((mtm) => mtm.pageComponent.monitorId)
+ .filter(notEmpty),
})),
);
diff --git a/apps/server/src/routes/v1/maintenances/post.test.ts b/apps/server/src/routes/v1/maintenances/post.test.ts
index 4d08bcd82..e244f306d 100644
--- a/apps/server/src/routes/v1/maintenances/post.test.ts
+++ b/apps/server/src/routes/v1/maintenances/post.test.ts
@@ -133,6 +133,34 @@ test("create a valid maintenance", async () => {
expect(res.status).toBe(200);
expect(result.success).toBe(true);
expect(result.data?.monitorIds?.length).toBe(1);
+ expect(result.data?.monitorIds).toEqual([1]);
+});
+
+test("create a maintenance with multiple monitorIds", async () => {
+ const from = new Date();
+ const to = new Date(from.getTime() + 3600000); // 1 hour later
+
+ const res = await app.request("/v1/maintenance", {
+ method: "POST",
+ headers: {
+ "x-openstatus-key": "1",
+ "content-type": "application/json",
+ },
+ body: JSON.stringify({
+ title: "Multi-Monitor Maintenance",
+ message: "Maintenance affecting multiple monitors",
+ from: from.toISOString(),
+ to: to.toISOString(),
+ monitorIds: [1, 2],
+ pageId: 1,
+ }),
+ });
+ const result = MaintenanceSchema.safeParse(await res.json());
+
+ expect(res.status).toBe(200);
+ expect(result.success).toBe(true);
+ expect(result.data?.monitorIds?.length).toBe(2);
+ expect(result.data?.monitorIds).toEqual(expect.arrayContaining([1, 2]));
});
test("create a maintenance with invalid dates should return 400", async () => {
diff --git a/apps/server/src/routes/v1/pages/get.ts b/apps/server/src/routes/v1/pages/get.ts
index d1fd97a5c..73e3face5 100644
--- a/apps/server/src/routes/v1/pages/get.ts
+++ b/apps/server/src/routes/v1/pages/get.ts
@@ -1,6 +1,7 @@
import { createRoute } from "@hono/zod-openapi";
import { OpenStatusApiError, openApiErrorResponses } from "@/libs/errors";
+import { notEmpty } from "@/utils/not-empty";
import { and, eq } from "@openstatus/db";
import { db } from "@openstatus/db/src/db";
import { page } from "@openstatus/db/src/schema";
@@ -33,11 +34,12 @@ export function registerGetPage(api: typeof pagesApi) {
const workspaceId = c.get("workspace").id;
const { id } = c.req.valid("param");
- const _page = await db
- .select()
- .from(page)
- .where(and(eq(page.workspaceId, workspaceId), eq(page.id, Number(id))))
- .get();
+ const _page = await db.query.page.findFirst({
+ where: and(eq(page.workspaceId, workspaceId), eq(page.id, Number(id))),
+ with: {
+ pageComponents: true,
+ },
+ });
if (!_page) {
throw new OpenStatusApiError({
@@ -46,7 +48,16 @@ export function registerGetPage(api: typeof pagesApi) {
});
}
- const data = transformPageData(PageSchema.parse(_page));
+ const monitorIds = _page.pageComponents
+ .map((pc) => pc.monitorId)
+ .filter(notEmpty);
+
+ const data = transformPageData(
+ PageSchema.parse({
+ ..._page,
+ monitors: monitorIds.length > 0 ? monitorIds : undefined,
+ }),
+ );
return c.json(data, 200);
});
diff --git a/apps/server/src/routes/v1/pages/get_all.ts b/apps/server/src/routes/v1/pages/get_all.ts
index 68c83e7b0..47d884d54 100644
--- a/apps/server/src/routes/v1/pages/get_all.ts
+++ b/apps/server/src/routes/v1/pages/get_all.ts
@@ -1,6 +1,7 @@
import { createRoute } from "@hono/zod-openapi";
import { openApiErrorResponses } from "@/libs/errors";
+import { notEmpty } from "@/utils/not-empty";
import { db, eq } from "@openstatus/db";
import { page } from "@openstatus/db/src/schema";
import type { pagesApi } from "./index";
@@ -28,13 +29,25 @@ export function registerGetAllPages(api: typeof pagesApi) {
return api.openapi(getAllRoute, async (c) => {
const workspaceId = c.get("workspace").id;
- const _pages = await db
- .select()
- .from(page)
- .where(eq(page.workspaceId, workspaceId));
+ const _pages = await db.query.page.findMany({
+ where: eq(page.workspaceId, workspaceId),
+ with: {
+ pageComponents: true,
+ },
+ });
const data = PageSchema.array()
- .parse(_pages)
+ .parse(
+ _pages.map((p) => {
+ const monitorIds = p.pageComponents
+ .map((pc) => pc.monitorId)
+ .filter(notEmpty);
+ return {
+ ...p,
+ monitors: monitorIds.length > 0 ? monitorIds : undefined,
+ };
+ }),
+ )
.map((page) => transformPageData(page));
return c.json(data, 200);
diff --git a/apps/server/src/routes/v1/statusReports/get.test.ts b/apps/server/src/routes/v1/statusReports/get.test.ts
index 4ed511bdc..fcfdfa67f 100644
--- a/apps/server/src/routes/v1/statusReports/get.test.ts
+++ b/apps/server/src/routes/v1/statusReports/get.test.ts
@@ -17,6 +17,24 @@ test("return the status report", async () => {
expect(result.data?.monitorIds?.length).toBeGreaterThan(0);
});
+test("return the status report with correct monitorIds structure", async () => {
+ const res = await app.request("/v1/status_report/2", {
+ headers: {
+ "x-openstatus-key": "1",
+ },
+ });
+ const result = StatusReportSchema.safeParse(await res.json());
+
+ expect(res.status).toBe(200);
+ expect(result.success).toBe(true);
+ expect(result.data?.monitorIds).toBeDefined();
+ expect(Array.isArray(result.data?.monitorIds)).toBe(true);
+ // Ensure each monitorId is a number
+ for (const monitorId of result.data?.monitorIds || []) {
+ expect(typeof monitorId).toBe("number");
+ }
+});
+
test("no auth key should return 401", async () => {
const res = await app.request("/v1/status_report/2");
diff --git a/apps/server/src/routes/v1/statusReports/get.ts b/apps/server/src/routes/v1/statusReports/get.ts
index f8ecfab2f..2018053f8 100644
--- a/apps/server/src/routes/v1/statusReports/get.ts
+++ b/apps/server/src/routes/v1/statusReports/get.ts
@@ -4,6 +4,7 @@ import { and, db, eq } from "@openstatus/db";
import { statusReport } from "@openstatus/db/src/schema";
import { OpenStatusApiError, openApiErrorResponses } from "@/libs/errors";
+import { notEmpty } from "@/utils/not-empty";
import type { statusReportsApi } from "./index";
import { ParamsSchema, StatusReportSchema } from "./schema";
@@ -36,7 +37,7 @@ export function regsiterGetStatusReport(api: typeof statusReportsApi) {
const _statusUpdate = await db.query.statusReport.findFirst({
with: {
statusReportUpdates: true,
- monitorsToStatusReports: true,
+ statusReportsToPageComponents: { with: { pageComponent: true } },
},
where: and(
eq(statusReport.workspaceId, workspaceId),
@@ -51,7 +52,8 @@ export function regsiterGetStatusReport(api: typeof statusReportsApi) {
});
}
- const { statusReportUpdates, monitorsToStatusReports } = _statusUpdate;
+ const { statusReportUpdates, statusReportsToPageComponents } =
+ _statusUpdate;
// most recent report information
const { message, date } =
@@ -61,9 +63,9 @@ export function regsiterGetStatusReport(api: typeof statusReportsApi) {
..._statusUpdate,
message,
date,
- monitorIds: monitorsToStatusReports.length
- ? monitorsToStatusReports.map((monitor) => monitor.monitorId)
- : null,
+ monitorIds: statusReportsToPageComponents
+ .map((sr) => sr.pageComponent.monitorId)
+ .filter(notEmpty),
statusReportUpdateIds: statusReportUpdates.map((update) => update.id),
});
diff --git a/apps/server/src/routes/v1/statusReports/get_all.test.ts b/apps/server/src/routes/v1/statusReports/get_all.test.ts
index e647df7e2..77c81e801 100644
--- a/apps/server/src/routes/v1/statusReports/get_all.test.ts
+++ b/apps/server/src/routes/v1/statusReports/get_all.test.ts
@@ -18,6 +18,30 @@ test("return all status reports", async () => {
expect(result.data?.length).toBeGreaterThan(0);
});
+test("return all status reports with monitorIds", async () => {
+ const res = await app.request("/v1/status_report", {
+ method: "GET",
+ headers: {
+ "x-openstatus-key": "1",
+ },
+ });
+
+ const result = StatusReportSchema.array().safeParse(await res.json());
+
+ expect(res.status).toBe(200);
+ expect(result.success).toBe(true);
+ expect(result.data?.length).toBeGreaterThan(0);
+ // Each status report should have monitorIds defined
+ for (const statusReport of result.data || []) {
+ expect(statusReport.monitorIds).toBeDefined();
+ expect(Array.isArray(statusReport.monitorIds)).toBe(true);
+ // Ensure each monitorId is a number
+ for (const monitorId of statusReport.monitorIds || []) {
+ expect(typeof monitorId).toBe("number");
+ }
+ }
+});
+
test("return empty status reports", async () => {
const res = await app.request("/v1/status_report", {
method: "GET",
diff --git a/apps/server/src/routes/v1/statusReports/get_all.ts b/apps/server/src/routes/v1/statusReports/get_all.ts
index 533ea9e02..1e56bb1f8 100644
--- a/apps/server/src/routes/v1/statusReports/get_all.ts
+++ b/apps/server/src/routes/v1/statusReports/get_all.ts
@@ -4,6 +4,7 @@ import { db, eq } from "@openstatus/db";
import { statusReport } from "@openstatus/db/src/schema";
import { openApiErrorResponses } from "@/libs/errors";
+import { notEmpty } from "@/utils/not-empty";
import type { statusReportsApi } from "./index";
import { StatusReportSchema } from "./schema";
@@ -33,7 +34,7 @@ export function registerGetAllStatusReports(api: typeof statusReportsApi) {
const _statusReports = await db.query.statusReport.findMany({
with: {
statusReportUpdates: true,
- monitorsToStatusReports: true,
+ statusReportsToPageComponents: { with: { pageComponent: true } },
},
where: eq(statusReport.workspaceId, workspaceId),
});
@@ -42,7 +43,9 @@ export function registerGetAllStatusReports(api: typeof statusReportsApi) {
_statusReports.map((r) => ({
...r,
statusReportUpdateIds: r.statusReportUpdates.map((u) => u.id),
- monitorIds: r.monitorsToStatusReports.map((m) => m.monitorId),
+ monitorIds: r.statusReportsToPageComponents
+ .map((sr) => sr.pageComponent.monitorId)
+ .filter(notEmpty),
})),
);
diff --git a/apps/server/src/routes/v1/statusReports/post.test.ts b/apps/server/src/routes/v1/statusReports/post.test.ts
index 1edea396b..b419e024a 100644
--- a/apps/server/src/routes/v1/statusReports/post.test.ts
+++ b/apps/server/src/routes/v1/statusReports/post.test.ts
@@ -28,7 +28,86 @@ test("create a valid status report", async () => {
expect(res.status).toBe(200);
expect(result.success).toBe(true);
expect(result.data?.statusReportUpdateIds?.length).toBeGreaterThan(0);
- expect(result.data?.monitorIds?.length).toBeGreaterThan(0);
+ expect(result.data?.monitorIds?.length).toBe(1);
+ expect(result.data?.monitorIds).toEqual([1]);
+});
+
+test("create a status report with multiple monitorIds", async () => {
+ const date = new Date();
+ date.setMilliseconds(0);
+
+ const res = await app.request("/v1/status_report", {
+ method: "POST",
+ headers: {
+ "x-openstatus-key": "1",
+ "content-type": "application/json",
+ },
+ body: JSON.stringify({
+ status: "investigating",
+ title: "Multi-Monitor Status Report",
+ message: "Affecting multiple monitors",
+ monitorIds: [1, 2],
+ date: date.toISOString(),
+ pageId: 1,
+ }),
+ });
+
+ const result = StatusReportSchema.safeParse(await res.json());
+
+ expect(res.status).toBe(200);
+ expect(result.success).toBe(true);
+ expect(result.data?.monitorIds?.length).toBe(2);
+ expect(result.data?.monitorIds).toEqual(expect.arrayContaining([1, 2]));
+});
+
+test("create a status report without monitorIds", async () => {
+ const date = new Date();
+ date.setMilliseconds(0);
+
+ const res = await app.request("/v1/status_report", {
+ method: "POST",
+ headers: {
+ "x-openstatus-key": "1",
+ "content-type": "application/json",
+ },
+ body: JSON.stringify({
+ status: "investigating",
+ title: "General Status Report",
+ message: "No specific monitors affected",
+ date: date.toISOString(),
+ pageId: 1,
+ }),
+ });
+
+ const result = StatusReportSchema.safeParse(await res.json());
+
+ expect(res.status).toBe(200);
+ expect(result.success).toBe(true);
+ expect(result.data?.monitorIds).toBeDefined();
+ expect(Array.isArray(result.data?.monitorIds)).toBe(true);
+});
+
+test("create a status report with partial invalid monitorIds should return 400", async () => {
+ const date = new Date();
+ date.setMilliseconds(0);
+
+ const res = await app.request("/v1/status_report", {
+ method: "POST",
+ headers: {
+ "x-openstatus-key": "1",
+ "content-type": "application/json",
+ },
+ body: JSON.stringify({
+ status: "investigating",
+ title: "Partial Invalid Monitors",
+ message: "One valid, one invalid",
+ monitorIds: [1, 9999],
+ date: date.toISOString(),
+ pageId: 1,
+ }),
+ });
+
+ expect(res.status).toBe(400);
});
test("create a status report with invalid monitor should return 400", async () => {
diff --git a/packages/db/src/seed.mts b/packages/db/src/seed.mts
index 7053c3d1a..33a5da262 100644
--- a/packages/db/src/seed.mts
+++ b/packages/db/src/seed.mts
@@ -6,16 +6,19 @@ import {
incidentTable,
maintenance,
maintenancesToMonitors,
+ maintenancesToPageComponents,
monitor,
monitorsToPages,
monitorsToStatusReport,
notification,
notificationsToMonitors,
page,
+ pageComponent,
privateLocation,
privateLocationToMonitors,
statusReport,
statusReportUpdate,
+ statusReportsToPageComponents,
user,
usersToWorkspaces,
workspace,
@@ -168,6 +171,35 @@ async function main() {
.values({ monitorId: 1, pageId: 1 })
.onConflictDoNothing()
.run();
+
+ // Page Components - representing monitors on the status page
+ await db
+ .insert(pageComponent)
+ .values([
+ {
+ id: 1,
+ workspaceId: 1,
+ pageId: 1,
+ type: "monitor",
+ monitorId: 1,
+ name: "OpenStatus Monitor",
+ description: "Main website monitoring",
+ order: 0,
+ },
+ {
+ id: 2,
+ workspaceId: 1,
+ pageId: 1,
+ type: "monitor",
+ monitorId: 2,
+ name: "Google Monitor",
+ description: "Google.com monitoring",
+ order: 1,
+ },
+ ])
+ .onConflictDoNothing()
+ .run();
+
await db
.insert(notification)
.values({
@@ -359,6 +391,34 @@ async function main() {
.onConflictDoNothing()
.run();
+ // Link status reports to page components
+ await db
+ .insert(statusReportsToPageComponents)
+ .values([
+ {
+ statusReportId: 1,
+ pageComponentId: 1,
+ },
+ {
+ statusReportId: 2,
+ pageComponentId: 1,
+ },
+ ])
+ .onConflictDoNothing()
+ .run();
+
+ // Link maintenances to page components
+ await db
+ .insert(maintenancesToPageComponents)
+ .values([
+ {
+ maintenanceId: 1,
+ pageComponentId: 1,
+ },
+ ])
+ .onConflictDoNothing()
+ .run();
+
// Incidents - realistic past incidents that were resolved
const fifteenDaysAgo = new Date(Date.now() - 15 * 24 * 60 * 60 * 1000);
const fifteenDaysAgoPlus2Hours = new Date(