Skip to content

Open-source status page, incident response and uptime monitoring

refactor: maintenances to monitors page components (#1827)

Maximilian Kaske3b16b93f476b
diff --git a/apps/server/src/routes/v1/__test__/sync.test.ts b/apps/server/src/routes/v1/__test__/sync.test.ts
index 01b6bcb6e..692653d1f 100644
--- a/apps/server/src/routes/v1/__test__/sync.test.ts
+++ b/apps/server/src/routes/v1/__test__/sync.test.ts
@@ -154,7 +154,7 @@ describe("API Sync: POST /v1/maintenance - maintenance_to_page_component", () =>
}
});
- test("creating maintenance with monitors syncs to maintenance_to_page_component", async () => {
+ test("creating maintenance with monitors creates maintenance_to_page_component and reverse syncs to maintenance_to_monitor", async () => {
const from = new Date();
const to = new Date(from.getTime() + 3600000);
@@ -179,7 +179,26 @@ describe("API Sync: POST /v1/maintenance - maintenance_to_page_component", () =>
const data = await res.json();
createdMaintenanceId = data.id;
- // Verify maintenance_to_monitor was created
+ // Verify maintenance_to_page_component was created FIRST (primary source)
+ const component = await db.query.pageComponent.findFirst({
+ where: and(
+ eq(pageComponent.monitorId, testMonitorId),
+ eq(pageComponent.pageId, testPageId),
+ ),
+ });
+
+ expect(component).toBeDefined();
+
+ const maintenanceToComponent =
+ await db.query.maintenancesToPageComponents.findFirst({
+ where: and(
+ eq(maintenancesToPageComponents.maintenanceId, createdMaintenanceId),
+ eq(maintenancesToPageComponents.pageComponentId, component?.id),
+ ),
+ });
+ expect(maintenanceToComponent).toBeDefined();
+
+ // Verify maintenance_to_monitor was reverse synced (for backward compatibility)
const maintenanceToMonitor =
await db.query.maintenancesToMonitors.findFirst({
where: and(
@@ -188,28 +207,6 @@ describe("API Sync: POST /v1/maintenance - maintenance_to_page_component", () =>
),
});
expect(maintenanceToMonitor).toBeDefined();
-
- // Verify maintenance_to_page_component was synced
- const component = await db.query.pageComponent.findFirst({
- where: and(
- eq(pageComponent.monitorId, testMonitorId),
- eq(pageComponent.pageId, testPageId),
- ),
- });
-
- if (component) {
- const maintenanceToComponent =
- await db.query.maintenancesToPageComponents.findFirst({
- where: and(
- eq(
- maintenancesToPageComponents.maintenanceId,
- createdMaintenanceId,
- ),
- eq(maintenancesToPageComponents.pageComponentId, component.id),
- ),
- });
- expect(maintenanceToComponent).toBeDefined();
- }
});
});
@@ -274,7 +271,7 @@ describe("API Sync: PUT /v1/maintenance - maintenance_to_page_component updates"
}
});
- test("removing monitors from maintenance syncs delete to maintenance_to_page_component", async () => {
+ test("removing monitors from maintenance deletes from maintenance_to_page_component and reverse syncs delete to maintenance_to_monitor", async () => {
const res = await app.request(`/v1/maintenance/${testMaintenanceId}`, {
method: "PUT",
headers: {
@@ -288,17 +285,7 @@ describe("API Sync: PUT /v1/maintenance - maintenance_to_page_component updates"
expect(res.status).toBe(200);
- // Verify maintenance_to_monitor was deleted
- const maintenanceToMonitor =
- await db.query.maintenancesToMonitors.findFirst({
- where: and(
- eq(maintenancesToMonitors.maintenanceId, testMaintenanceId),
- eq(maintenancesToMonitors.monitorId, testMonitorId),
- ),
- });
- expect(maintenanceToMonitor).toBeUndefined();
-
- // Verify maintenance_to_page_component was also deleted
+ // Verify maintenance_to_page_component was deleted FIRST (primary source)
const maintenanceToComponent =
await db.query.maintenancesToPageComponents.findFirst({
where: eq(
@@ -307,6 +294,16 @@ describe("API Sync: PUT /v1/maintenance - maintenance_to_page_component updates"
),
});
expect(maintenanceToComponent).toBeUndefined();
+
+ // Verify maintenance_to_monitor was reverse synced (deleted for backward compatibility)
+ const maintenanceToMonitor =
+ await db.query.maintenancesToMonitors.findFirst({
+ where: and(
+ eq(maintenancesToMonitors.maintenanceId, testMaintenanceId),
+ eq(maintenancesToMonitors.monitorId, testMonitorId),
+ ),
+ });
+ expect(maintenanceToMonitor).toBeUndefined();
});
});
diff --git a/apps/server/src/routes/v1/maintenances/post.ts b/apps/server/src/routes/v1/maintenances/post.ts
index 47e75bc3c..a054bb07f 100644
--- a/apps/server/src/routes/v1/maintenances/post.ts
+++ b/apps/server/src/routes/v1/maintenances/post.ts
@@ -10,13 +10,14 @@ import {
inArray,
isNotNull,
isNull,
- syncMaintenanceToMonitorInsertMany,
+ syncMaintenanceToPageComponentInsertMany,
} from "@openstatus/db";
import { monitor, page, pageSubscriber } from "@openstatus/db/src/schema";
+import { maintenance } from "@openstatus/db/src/schema/maintenances";
import {
- maintenance,
- maintenancesToMonitors,
-} from "@openstatus/db/src/schema/maintenances";
+ maintenancesToPageComponents,
+ pageComponent,
+} from "@openstatus/db/src/schema/page_components";
import { EmailClient } from "@openstatus/emails";
import type { maintenancesApi } from "./index";
import { MaintenanceSchema } from "./schema";
@@ -108,22 +109,38 @@ export function registerPostMaintenance(api: typeof maintenancesApi) {
.returning()
.get();
- if (monitorIds?.length) {
- await tx
- .insert(maintenancesToMonitors)
- .values(
- input.monitorIds.map((monitorId) => ({
- maintenanceId: newMaintenance.id,
- monitorId,
- })),
+ if (monitorIds?.length && newMaintenance.pageId) {
+ // Get page components for the given monitors and page
+ const pageComponents = await tx
+ .select({ id: pageComponent.id })
+ .from(pageComponent)
+ .where(
+ and(
+ inArray(pageComponent.monitorId, monitorIds),
+ eq(pageComponent.pageId, newMaintenance.pageId),
+ ),
)
- .run();
- // Sync to page components
- await syncMaintenanceToMonitorInsertMany(
- tx,
- newMaintenance.id,
- input.monitorIds,
- );
+ .all();
+
+ if (pageComponents.length > 0) {
+ // Insert to maintenancesToPageComponents FIRST (new primary source)
+ await tx
+ .insert(maintenancesToPageComponents)
+ .values(
+ pageComponents.map((pc) => ({
+ maintenanceId: newMaintenance.id,
+ pageComponentId: pc.id,
+ })),
+ )
+ .run();
+
+ // Reverse sync to maintenancesToMonitors (for backward compatibility)
+ await syncMaintenanceToPageComponentInsertMany(
+ tx,
+ newMaintenance.id,
+ pageComponents.map((pc) => pc.id),
+ );
+ }
}
return newMaintenance;
diff --git a/apps/server/src/routes/v1/maintenances/put.ts b/apps/server/src/routes/v1/maintenances/put.ts
index cbf36fc20..9130dcfe1 100644
--- a/apps/server/src/routes/v1/maintenances/put.ts
+++ b/apps/server/src/routes/v1/maintenances/put.ts
@@ -8,14 +8,15 @@ import {
eq,
inArray,
isNull,
- syncMaintenanceToMonitorDeleteByMaintenance,
- syncMaintenanceToMonitorInsertMany,
+ syncMaintenanceToPageComponentDeleteByMaintenance,
+ syncMaintenanceToPageComponentInsertMany,
} from "@openstatus/db";
import { monitor, page } from "@openstatus/db/src/schema";
+import { maintenance } from "@openstatus/db/src/schema/maintenances";
import {
- maintenance,
- maintenancesToMonitors,
-} from "@openstatus/db/src/schema/maintenances";
+ maintenancesToPageComponents,
+ pageComponent,
+} from "@openstatus/db/src/schema/page_components";
import type { maintenancesApi } from "./index";
import { MaintenanceSchema, ParamsSchema } from "./schema";
@@ -131,27 +132,48 @@ export function registerPutMaintenance(api: typeof maintenancesApi) {
.get();
if (monitorIds) {
- // Delete existing monitor associations
+ // Delete from maintenancesToPageComponents FIRST (new primary source)
await tx
- .delete(maintenancesToMonitors)
- .where(eq(maintenancesToMonitors.maintenanceId, Number(id)))
+ .delete(maintenancesToPageComponents)
+ .where(eq(maintenancesToPageComponents.maintenanceId, Number(id)))
.run();
- // Sync delete to page components
- await syncMaintenanceToMonitorDeleteByMaintenance(tx, Number(id));
-
- // Add new monitor associations
- if (monitorIds.length > 0) {
- await tx
- .insert(maintenancesToMonitors)
- .values(
- monitorIds.map((monitorId) => ({
- maintenanceId: Number(id),
- monitorId,
- })),
+
+ // Reverse sync delete to maintenancesToMonitors (for backward compatibility)
+ await syncMaintenanceToPageComponentDeleteByMaintenance(tx, Number(id));
+
+ // Add new associations
+ if (monitorIds.length > 0 && updated.pageId) {
+ // Get page components for the new monitors
+ const pageComponents = await tx
+ .select({ id: pageComponent.id })
+ .from(pageComponent)
+ .where(
+ and(
+ inArray(pageComponent.monitorId, monitorIds),
+ eq(pageComponent.pageId, updated.pageId),
+ ),
)
- .run();
- // Sync to page components
- await syncMaintenanceToMonitorInsertMany(tx, Number(id), monitorIds);
+ .all();
+
+ if (pageComponents.length > 0) {
+ // Insert to maintenancesToPageComponents FIRST
+ await tx
+ .insert(maintenancesToPageComponents)
+ .values(
+ pageComponents.map((pc) => ({
+ maintenanceId: Number(id),
+ pageComponentId: pc.id,
+ })),
+ )
+ .run();
+
+ // Reverse sync to maintenancesToMonitors
+ await syncMaintenanceToPageComponentInsertMany(
+ tx,
+ Number(id),
+ pageComponents.map((pc) => pc.id),
+ );
+ }
}
}
diff --git a/apps/web/src/app/api/checker/cron/_cron.ts b/apps/web/src/app/api/checker/cron/_cron.ts
index 19a159530..bb0c57565 100644
--- a/apps/web/src/app/api/checker/cron/_cron.ts
+++ b/apps/web/src/app/api/checker/cron/_cron.ts
@@ -3,16 +3,19 @@ import type { google } from "@google-cloud/tasks/build/protos/protos";
import type { NextRequest } from "next/server";
import { z } from "zod";
-import { and, db, eq, gte, lte, notInArray } from "@openstatus/db";
+import { and, db, eq, gte, isNotNull, lte, notInArray } from "@openstatus/db";
import type { MonitorStatus } from "@openstatus/db/src/schema";
import {
maintenance,
- maintenancesToMonitors,
monitor,
monitorStatusTable,
selectMonitorSchema,
selectMonitorStatusSchema,
} from "@openstatus/db/src/schema";
+import {
+ maintenancesToPageComponents,
+ pageComponent,
+} from "@openstatus/db/src/schema/page_components";
import { env } from "@/env";
import type { Region } from "@openstatus/db/src/schema/constants";
@@ -65,12 +68,17 @@ export const cron = async ({
.as("currentMaintenance");
const currentMaintenanceMonitors = db
- .select({ id: maintenancesToMonitors.monitorId })
- .from(maintenancesToMonitors)
+ .select({ id: pageComponent.monitorId })
+ .from(maintenancesToPageComponents)
.innerJoin(
currentMaintenance,
- eq(maintenancesToMonitors.maintenanceId, currentMaintenance.id),
- );
+ eq(maintenancesToPageComponents.maintenanceId, currentMaintenance.id),
+ )
+ .innerJoin(
+ pageComponent,
+ eq(maintenancesToPageComponents.pageComponentId, pageComponent.id),
+ )
+ .where(isNotNull(pageComponent.monitorId));
const result = await db
.select()
diff --git a/apps/workflows/src/cron/checker.ts b/apps/workflows/src/cron/checker.ts
index 2b54200e2..3b253d642 100644
--- a/apps/workflows/src/cron/checker.ts
+++ b/apps/workflows/src/cron/checker.ts
@@ -2,17 +2,20 @@ import { CloudTasksClient } from "@google-cloud/tasks";
import type { google } from "@google-cloud/tasks/build/protos/protos";
import { z } from "zod";
-import { and, eq, gte, lte, notInArray } from "@openstatus/db";
+import { and, eq, gte, isNotNull, lte, notInArray } from "@openstatus/db";
import {
type MonitorStatus,
maintenance,
- maintenancesToMonitors,
monitor,
monitorStatusTable,
selectMonitorSchema,
selectMonitorStatusSchema,
} from "@openstatus/db/src/schema";
import type { Region } from "@openstatus/db/src/schema/constants";
+import {
+ maintenancesToPageComponents,
+ pageComponent,
+} from "@openstatus/db/src/schema/page_components";
import { regionDict } from "@openstatus/regions";
import { db } from "../lib/db";
@@ -74,12 +77,17 @@ export async function sendCheckerTasks(
.as("currentMaintenance");
const currentMaintenanceMonitors = db
- .select({ id: maintenancesToMonitors.monitorId })
- .from(maintenancesToMonitors)
+ .select({ id: pageComponent.monitorId })
+ .from(maintenancesToPageComponents)
.innerJoin(
currentMaintenance,
- eq(maintenancesToMonitors.maintenanceId, currentMaintenance.id),
- );
+ eq(maintenancesToPageComponents.maintenanceId, currentMaintenance.id),
+ )
+ .innerJoin(
+ pageComponent,
+ eq(maintenancesToPageComponents.pageComponentId, pageComponent.id),
+ )
+ .where(isNotNull(pageComponent.monitorId));
const result = await db
.select()