Skip to content

Open-source status page, incident response and uptime monitoring

feat: page-components status report emails (#1786)

Maximilian Kaskecabde9198691
diff --git a/apps/server/src/routes/v1/maintenances/post.ts b/apps/server/src/routes/v1/maintenances/post.ts
index 85144457e..2f36939a5 100644
--- a/apps/server/src/routes/v1/maintenances/post.ts
+++ b/apps/server/src/routes/v1/maintenances/post.ts
@@ -98,7 +98,7 @@ export function registerPostMaintenance(api: typeof maintenancesApi) {
});
}
- const _maintenance = await db.transaction(async (tx) => {
+ const _newMaintenance = await db.transaction(async (tx) => {
const newMaintenance = await tx
.insert(maintenance)
.values({
@@ -129,13 +129,13 @@ export function registerPostMaintenance(api: typeof maintenancesApi) {
return newMaintenance;
});
- if (limits["status-subscribers"] && _maintenance.pageId) {
+ if (limits["status-subscribers"] && _newMaintenance.pageId) {
const subscribers = await db
.select()
.from(pageSubscriber)
.where(
and(
- eq(pageSubscriber.pageId, _maintenance.pageId),
+ eq(pageSubscriber.pageId, _newMaintenance.pageId),
isNotNull(pageSubscriber.acceptedAt),
),
)
@@ -143,18 +143,29 @@ export function registerPostMaintenance(api: typeof maintenancesApi) {
const _page = await db.query.page.findFirst({
where: and(
- eq(page.id, _maintenance.pageId),
+ eq(page.id, _newMaintenance.pageId),
eq(page.workspaceId, workspaceId),
),
+ });
+
+ const _maintenance = await db.query.maintenance.findFirst({
+ where: eq(maintenance.id, _newMaintenance.id),
with: {
- monitorsToPages: {
+ maintenancesToPageComponents: {
with: {
- monitor: true,
+ pageComponent: true,
},
},
},
});
+ if (!_maintenance) {
+ throw new OpenStatusApiError({
+ code: "INTERNAL_SERVER_ERROR",
+ message: "Maintenance not found",
+ });
+ }
+
const validSubscribers = subscribers.filter(
(s): s is typeof s & { token: string } =>
s.token !== null &&
@@ -174,15 +185,15 @@ export function registerPostMaintenance(api: typeof maintenancesApi) {
status: "maintenance",
message: _maintenance.message,
date: _maintenance.from.toISOString(),
- monitors: _page.monitorsToPages.map(
- (i) => i.monitor.externalName || i.monitor.name,
+ pageComponents: _maintenance.maintenancesToPageComponents.map(
+ (i) => i.pageComponent.name,
),
});
}
}
const data = MaintenanceSchema.parse({
- ..._maintenance,
+ ..._newMaintenance,
monitorIds: input.monitorIds,
});
diff --git a/apps/server/src/routes/v1/statusReportUpdates/post.ts b/apps/server/src/routes/v1/statusReportUpdates/post.ts
index 9323a9299..a7aae0124 100644
--- a/apps/server/src/routes/v1/statusReportUpdates/post.ts
+++ b/apps/server/src/routes/v1/statusReportUpdates/post.ts
@@ -58,9 +58,9 @@ export function registerPostStatusReportUpdate(
eq(statusReport.workspaceId, workspaceId),
),
with: {
- monitorsToStatusReports: {
+ statusReportsToPageComponents: {
with: {
- monitor: true,
+ pageComponent: true,
},
},
},
@@ -134,8 +134,8 @@ export function registerPostStatusReportUpdate(
status: _statusReportUpdate.status,
message: _statusReportUpdate.message,
date: _statusReportUpdate.date.toISOString(),
- monitors: _statusReport.monitorsToStatusReports.map(
- (i) => i.monitor.externalName || i.monitor.name,
+ pageComponents: _statusReport.statusReportsToPageComponents.map(
+ (i) => i.pageComponent.name,
),
});
}
diff --git a/apps/server/src/routes/v1/statusReports/post.ts b/apps/server/src/routes/v1/statusReports/post.ts
index 4a97ba8fc..d9706de0c 100644
--- a/apps/server/src/routes/v1/statusReports/post.ts
+++ b/apps/server/src/routes/v1/statusReports/post.ts
@@ -179,6 +179,9 @@ export function registerPostStatusReport(api: typeof statusReportsApi) {
monitorsToStatusReports: {
with: { monitor: true },
},
+ statusReportsToPageComponents: {
+ with: { pageComponent: true },
+ },
},
});
@@ -208,8 +211,8 @@ export function registerPostStatusReport(api: typeof statusReportsApi) {
status: _newStatusReportUpdate.status,
message: _newStatusReportUpdate.message,
date: _newStatusReportUpdate.date.toISOString(),
- monitors: _statusReport.monitorsToStatusReports.map(
- (i) => i.monitor.externalName || i.monitor.name,
+ pageComponents: _statusReport.statusReportsToPageComponents.map(
+ (i) => i.pageComponent.name,
),
});
}
diff --git a/apps/server/src/routes/v1/statusReports/update/post.ts b/apps/server/src/routes/v1/statusReports/update/post.ts
index 97c0455ba..e946b4e50 100644
--- a/apps/server/src/routes/v1/statusReports/update/post.ts
+++ b/apps/server/src/routes/v1/statusReports/update/post.ts
@@ -86,13 +86,13 @@ export function registerStatusReportUpdateRoutes(api: typeof statusReportsApi) {
.returning()
.get();
- if (limits.notifications && _statusReport.pageId) {
+ if (limits["status-subscribers"] && _statusReport.pageId) {
const _statusReportWithRelations = await db.query.statusReport.findFirst({
where: eq(statusReport.id, Number(id)),
with: {
- monitorsToStatusReports: {
+ statusReportsToPageComponents: {
with: {
- monitor: true,
+ pageComponent: true,
},
},
page: true,
@@ -129,9 +129,10 @@ export function registerStatusReportUpdateRoutes(api: typeof statusReportsApi) {
status: _statusReportUpdate.status,
message: _statusReportUpdate.message,
date: _statusReportUpdate.date.toISOString(),
- monitors: _statusReportWithRelations.monitorsToStatusReports.map(
- (monitor) => monitor.monitor.externalName || monitor.monitor.name,
- ),
+ pageComponents:
+ _statusReportWithRelations.statusReportsToPageComponents.map(
+ (i) => i.pageComponent.name,
+ ),
});
}
}
diff --git a/packages/api/src/router/email/index.ts b/packages/api/src/router/email/index.ts
index 4d6038f66..b75038525 100644
--- a/packages/api/src/router/email/index.ts
+++ b/packages/api/src/router/email/index.ts
@@ -32,9 +32,9 @@ export const emailRouter = createTRPCRouter({
with: {
statusReport: {
with: {
- monitorsToStatusReports: {
+ statusReportsToPageComponents: {
with: {
- monitor: true,
+ pageComponent: true,
},
},
page: {
@@ -82,9 +82,9 @@ export const emailRouter = createTRPCRouter({
status: _statusReportUpdate.status,
message: _statusReportUpdate.message,
date: new Date(_statusReportUpdate.date).toISOString(),
- monitors:
- _statusReportUpdate.statusReport.monitorsToStatusReports.map(
- (i) => i.monitor.externalName || i.monitor.name,
+ pageComponents:
+ _statusReportUpdate.statusReport.statusReportsToPageComponents.map(
+ (i) => i.pageComponent.name,
),
});
}
@@ -101,9 +101,9 @@ export const emailRouter = createTRPCRouter({
eq(maintenance.workspaceId, opts.ctx.workspace.id),
),
with: {
- maintenancesToMonitors: {
+ maintenancesToPageComponents: {
with: {
- monitor: true,
+ pageComponent: true,
},
},
page: {
@@ -138,8 +138,8 @@ export const emailRouter = createTRPCRouter({
status: "maintenance",
message: _maintenance.message,
date: new Date(_maintenance.from).toISOString(),
- monitors: _maintenance.maintenancesToMonitors.map(
- (i) => i.monitor.externalName || i.monitor.name,
+ pageComponents: _maintenance.maintenancesToPageComponents.map(
+ (i) => i.pageComponent.name,
),
});
}
diff --git a/packages/emails/emails/status-report.tsx b/packages/emails/emails/status-report.tsx
index 8a82e04e9..a02d158af 100644
--- a/packages/emails/emails/status-report.tsx
+++ b/packages/emails/emails/status-report.tsx
@@ -30,7 +30,7 @@ export const StatusReportSchema = z.object({
date: z.string(),
message: z.string(),
reportTitle: z.string(),
- monitors: z.array(z.string()),
+ pageComponents: z.array(z.string()),
unsubscribeUrl: z.string().url().optional(),
});
@@ -59,7 +59,7 @@ function StatusReportEmail({
message,
reportTitle,
pageTitle,
- monitors,
+ pageComponents,
unsubscribeUrl,
}: StatusReportProps) {
return (
@@ -105,7 +105,7 @@ function StatusReportEmail({
</Column>
<Column style={{ textAlign: "right" }}>
<Text style={{ flexWrap: "wrap", wordWrap: "break-word" }}>
- {monitors.length > 0 ? monitors.join(", ") : "N/A"}
+ {pageComponents.length > 0 ? pageComponents.join(", ") : "N/A"}
</Text>
</Column>
</Row>
@@ -160,7 +160,7 @@ StatusReportEmail.PreviewProps = {
We'll post another update by **19:00 UTC** today or sooner if critical developments occur. We apologize for the inconvenience and appreciate your patience as we restore full cache functionality.
`,
- monitors: ["OpenStatus API", "OpenStatus Webhook"],
+ pageComponents: ["OpenStatus API", "OpenStatus Webhook"],
unsubscribeUrl:
"https://status.openstatus.dev/unsubscribe/550e8400-e29b-41d4-a716-446655440000",
};