Skip to content

Open-source status page, incident response and uptime monitoring

πŸ’Œ improve email (#440)

Thibault Le Ouayc44918dee852
diff --git a/apps/server/package.json b/apps/server/package.json
index ce14b2ab9..eaea2ad8a 100644
--- a/apps/server/package.json
+++ b/apps/server/package.json
@@ -20,6 +20,7 @@
"@openstatus/plans": "workspace:*",
"@openstatus/tinybird": "workspace:*",
"@openstatus/upstash": "workspace:*",
+ "@openstatus/utils": "workspace:*",
"@t3-oss/env-core": "0.7.1",
"@unkey/api": "0.11.0",
"hono": "3.9.1",
diff --git a/apps/server/src/checker/alerting.test.ts b/apps/server/src/checker/alerting.test.ts
index 0798f84b3..ce79429ec 100644
--- a/apps/server/src/checker/alerting.test.ts
+++ b/apps/server/src/checker/alerting.test.ts
@@ -2,7 +2,7 @@ import { expect, mock, test } from "bun:test";
import { triggerAlerting } from "./alerting";
-test("should send email notification", async () => {
+test.todo("should send email notification", async () => {
const fn = mock(() => {});
mock.module("./utils.ts", () => {
return {
@@ -11,6 +11,6 @@ test("should send email notification", async () => {
},
};
});
- await triggerAlerting({ monitorId: "1" });
+ await triggerAlerting({ monitorId: "1", region: "ams", statusCode: 400 });
expect(fn).toHaveBeenCalled();
});
diff --git a/apps/server/src/checker/alerting.ts b/apps/server/src/checker/alerting.ts
index 14a9a8889..87a47d42a 100644
--- a/apps/server/src/checker/alerting.ts
+++ b/apps/server/src/checker/alerting.ts
@@ -4,23 +4,20 @@ import {
selectMonitorSchema,
selectNotificationSchema,
} from "@openstatus/db/src/schema";
+import type { flyRegions } from "@openstatus/utils";
+import { flyRegionsDict } from "@openstatus/utils";
-import { publishPingRetryPolicy } from "./checker";
-import type { Payload } from "./schema";
import { providerToFunction } from "./utils";
-export async function catchTooManyRetry(payload: Payload) {
- await publishPingRetryPolicy({ payload, latency: -1, statusCode: 500 });
- if (payload?.status !== "error") {
- await triggerAlerting({ monitorId: payload.monitorId });
- await updateMonitorStatus({
- monitorId: payload.monitorId,
- status: "error",
- });
- }
-}
-
-export const triggerAlerting = async ({ monitorId }: { monitorId: string }) => {
+export const triggerAlerting = async ({
+ monitorId,
+ region,
+ statusCode,
+}: {
+ monitorId: string;
+ region: keyof typeof flyRegionsDict;
+ statusCode: number;
+}) => {
console.log(`triggerAlerting for ${monitorId}`);
const notifications = await db
.select()
@@ -40,6 +37,8 @@ export const triggerAlerting = async ({ monitorId }: { monitorId: string }) => {
await providerToFunction[notif.notification.provider]({
monitor,
notification: selectNotificationSchema.parse(notif.notification),
+ region: flyRegionsDict[region].location,
+ statusCode,
});
}
};
diff --git a/apps/server/src/checker/checker.ts b/apps/server/src/checker/checker.ts
index 335faa572..4ac9a825c 100644
--- a/apps/server/src/checker/checker.ts
+++ b/apps/server/src/checker/checker.ts
@@ -1,3 +1,4 @@
+import { env } from "../env";
import { triggerAlerting, updateMonitorStatus } from "./alerting";
import type { PublishPingType } from "./ping";
import { pingEndpoint, publishPing } from "./ping";
@@ -78,7 +79,11 @@ const run = async (data: Payload, retry?: number | undefined) => {
monitorId: data.monitorId,
status: "error",
});
- await triggerAlerting({ monitorId: data.monitorId });
+ await triggerAlerting({
+ monitorId: data.monitorId,
+ region: env.FLY_REGION,
+ statusCode: res?.status || 0,
+ });
}
}
}
diff --git a/apps/server/src/checker/index.ts b/apps/server/src/checker/index.ts
index 9da02d8a8..96c1ee405 100644
--- a/apps/server/src/checker/index.ts
+++ b/apps/server/src/checker/index.ts
@@ -34,7 +34,6 @@ checkerRoute.post("/checker", async (c) => {
`catchTooManyRetry for ${JSON.stringify(result.data)}
)}`,
);
- // catchTooManyRetry(result.data);
return c.text("Ok", 200); // finish the task
}
diff --git a/apps/server/src/checker/utils.ts b/apps/server/src/checker/utils.ts
index 86b245763..eee5c7a89 100644
--- a/apps/server/src/checker/utils.ts
+++ b/apps/server/src/checker/utils.ts
@@ -6,13 +6,18 @@ import type {
import { sendDiscordMessage } from "@openstatus/notification-discord";
import { send as sendEmail } from "@openstatus/notification-emails";
import { sendSlackMessage } from "@openstatus/notification-slack";
+import type { flyRegionsDict } from "@openstatus/utils";
type SendNotification = ({
monitor,
notification,
+ region,
+ statusCode,
}: {
monitor: Monitor;
notification: Notification;
+ region: keyof typeof flyRegionsDict;
+ statusCode: number;
}) => Promise<void>;
export const providerToFunction = {
diff --git a/apps/server/src/env.ts b/apps/server/src/env.ts
index c2c7b3850..15d5eec10 100644
--- a/apps/server/src/env.ts
+++ b/apps/server/src/env.ts
@@ -1,6 +1,8 @@
import { createEnv } from "@t3-oss/env-core";
import { z } from "zod";
+import { flyRegions } from "@openstatus/utils";
+
export const env = createEnv({
server: {
UNKEY_API_ID: z.string().min(1),
@@ -8,7 +10,7 @@ export const env = createEnv({
TINY_BIRD_API_KEY: z.string().min(1),
UPSTASH_REDIS_REST_URL: z.string().min(1),
UPSTASH_REDIS_REST_TOKEN: z.string().min(1),
- FLY_REGION: z.string(),
+ FLY_REGION: z.enum(flyRegions),
CRON_SECRET: z.string(),
},
diff --git a/apps/web/package.json b/apps/web/package.json
index ce5b5e44e..96f2c649c 100644
--- a/apps/web/package.json
+++ b/apps/web/package.json
@@ -18,14 +18,15 @@
"@openstatus/api": "workspace:*",
"@openstatus/db": "workspace:*",
"@openstatus/emails": "workspace:*",
- "@openstatus/notification-emails": "workspace:*",
"@openstatus/notification-discord": "workspace:*",
+ "@openstatus/notification-emails": "workspace:*",
"@openstatus/notification-slack": "workspace:*",
"@openstatus/plans": "workspace:*",
"@openstatus/react": "workspace:*",
"@openstatus/tinybird": "workspace:*",
"@openstatus/ui": "workspace:*",
"@openstatus/upstash": "workspace:*",
+ "@openstatus/utils": "workspace:*",
"@openstatus/vercel": "workspace:*",
"@sentry/integrations": "7.73.0",
"@sentry/nextjs": "7.73.0",
diff --git a/apps/web/src/app/api/checker/regions/_checker.ts b/apps/web/src/app/api/checker/regions/_checker.ts
index fac60f084..4b08a8847 100644
--- a/apps/web/src/app/api/checker/regions/_checker.ts
+++ b/apps/web/src/app/api/checker/regions/_checker.ts
@@ -16,7 +16,6 @@ import {
import { env } from "@/env";
import type { Payload } from "../schema";
import { payloadSchema } from "../schema";
-import { providerToFunction } from "../utils";
export const monitorSchema = tbIngestPingResponse.pick({
url: true,
@@ -147,10 +146,10 @@ const triggerAlerting = async ({ monitorId }: { monitorId: string }) => {
.where(eq(schema.monitor.id, Number(monitorId)))
.all();
for (const notif of notifications) {
- await providerToFunction[notif.notification.provider]({
- monitor: selectMonitorSchema.parse(notif.monitor),
- notification: selectNotificationSchema.parse(notif.notification),
- });
+ // await providerToFunction[notif.notification.provider]({
+ // monitor: selectMonitorSchema.parse(notif.monitor),
+ // notification: selectNotificationSchema.parse(notif.notification),
+ // });
}
};
diff --git a/apps/web/src/app/api/checker/utils.ts b/apps/web/src/app/api/checker/utils.ts
index 4df098430..050e8b3f4 100644
--- a/apps/web/src/app/api/checker/utils.ts
+++ b/apps/web/src/app/api/checker/utils.ts
@@ -7,16 +7,16 @@ import { sendDiscordMessage } from "@openstatus/notification-discord";
import { send as sendEmail } from "@openstatus/notification-emails";
import { sendSlackMessage } from "@openstatus/notification-slack";
-type sendNotificationType = ({
- monitor,
- notification,
-}: {
- monitor: Monitor;
- notification: Notification;
-}) => Promise<void>;
+// type sendNotificationType = ({
+// monitor,
+// notification,
+// }: {
+// monitor: Monitor;
+// notification: Notification;
+// }) => Promise<void>;
-export const providerToFunction = {
- email: sendEmail,
- slack: sendSlackMessage,
- discord: sendDiscordMessage,
-} satisfies Record<NotificationProvider, sendNotificationType>;
+// export const providerToFunction = {
+// email: sendEmail,
+// slack: sendSlackMessage,
+// discord: sendDiscordMessage,
+// } satisfies Record<NotificationProvider, sendNotificationType>;
diff --git a/apps/web/src/app/layout.tsx b/apps/web/src/app/layout.tsx
index 9d9b00309..b60da1f00 100644
--- a/apps/web/src/app/layout.tsx
+++ b/apps/web/src/app/layout.tsx
@@ -3,7 +3,6 @@ import "@/styles/globals.css";
import type { Metadata } from "next";
import { Inter } from "next/font/google";
import LocalFont from "next/font/local";
-import { ClerkProvider } from "@clerk/nextjs";
import PlausibleProvider from "next-plausible";
import { Toaster } from "@openstatus/ui";
diff --git a/apps/web/src/components/content/timeline.tsx b/apps/web/src/components/content/timeline.tsx
index a3a96429f..30d71f3dc 100644
--- a/apps/web/src/components/content/timeline.tsx
+++ b/apps/web/src/components/content/timeline.tsx
@@ -1,5 +1,3 @@
-import Image from "next/image";
-
import { formatDate } from "@/lib/utils";
interface TimelineProps {
diff --git a/apps/web/src/components/dashboard/container.tsx b/apps/web/src/components/dashboard/container.tsx
index fe836a638..2e6147660 100644
--- a/apps/web/src/components/dashboard/container.tsx
+++ b/apps/web/src/components/dashboard/container.tsx
@@ -2,7 +2,6 @@ import {
Card,
CardContent,
CardDescription,
- CardFooter,
CardHeader,
CardTitle,
Skeleton,
diff --git a/apps/web/src/components/data-table/columns.tsx b/apps/web/src/components/data-table/columns.tsx
index 9a1141953..4ea51df57 100644
--- a/apps/web/src/components/data-table/columns.tsx
+++ b/apps/web/src/components/data-table/columns.tsx
@@ -4,8 +4,8 @@ import type { ColumnDef } from "@tanstack/react-table";
import { format } from "date-fns";
import type { Ping } from "@openstatus/tinybird";
+import { regionsDict } from "@openstatus/utils";
-import { regionsDict } from "@/data/regions-dictionary";
import { DataTableColumnHeader } from "./data-table-column-header";
import { DataTableStatusBadge } from "./data-table-status-badge";
diff --git a/apps/web/src/components/data-table/data-table-toolbar.tsx b/apps/web/src/components/data-table/data-table-toolbar.tsx
index 8adfe414f..fef0d51ab 100644
--- a/apps/web/src/components/data-table/data-table-toolbar.tsx
+++ b/apps/web/src/components/data-table/data-table-toolbar.tsx
@@ -4,12 +4,10 @@ import type { Table } from "@tanstack/react-table";
import { X } from "lucide-react";
import { Button } from "@openstatus/ui";
+import { flyRegionsDict } from "@openstatus/utils";
import { codesDict } from "@/data/code-dictionary";
-import { flyRegionsDict } from "@/data/regions-dictionary";
-import { DataTableDateRangePicker } from "./data-table-date-ranger-picker";
import { DataTableFacetedFilter } from "./data-table-faceted-filter";
-import { DataTableFilterInput } from "./data-table-filter-input";
interface DataTableToolbarProps<TData> {
table: Table<TData>;
diff --git a/apps/web/src/components/data-table/status-page/columns.tsx b/apps/web/src/components/data-table/status-page/columns.tsx
index d4a206b59..b50af2521 100644
--- a/apps/web/src/components/data-table/status-page/columns.tsx
+++ b/apps/web/src/components/data-table/status-page/columns.tsx
@@ -7,7 +7,6 @@ import * as z from "zod";
import type { Page } from "@openstatus/db/src/schema";
import { Badge } from "@openstatus/ui";
-import { formatDate } from "@/lib/utils";
import { DataTableRowActions } from "./data-table-row-actions";
// TODO: add total number of monitors
diff --git a/apps/web/src/components/domains/domain-configuration.tsx b/apps/web/src/components/domains/domain-configuration.tsx
index 49e744410..8ea1d053a 100644
--- a/apps/web/src/components/domains/domain-configuration.tsx
+++ b/apps/web/src/components/domains/domain-configuration.tsx
@@ -1,11 +1,5 @@
"use client";
-import { useEffect, useState, useTransition } from "react";
-
-import type {
- DomainResponse,
- DomainVerificationStatusProps,
-} from "@openstatus/api/src/router/domain";
import { Tabs, TabsContent, TabsList, TabsTrigger } from "@openstatus/ui";
import { useDomainStatus } from "@/hooks/use-domain-status";
diff --git a/apps/web/src/components/forms/monitor-form.tsx b/apps/web/src/components/forms/monitor-form.tsx
index a569eabe1..4b0e83dea 100644
--- a/apps/web/src/components/forms/monitor-form.tsx
+++ b/apps/web/src/components/forms/monitor-form.tsx
@@ -60,10 +60,10 @@ import {
TooltipProvider,
TooltipTrigger,
} from "@openstatus/ui";
+import { flyRegionsDict } from "@openstatus/utils";
import { LoadingAnimation } from "@/components/loading-animation";
import { FailedPingAlertConfirmation } from "@/components/modals/failed-ping-alert-confirmation";
-import { flyRegionsDict } from "@/data/regions-dictionary";
import { useToastAction } from "@/hooks/use-toast-action";
import useUpdateSearchParams from "@/hooks/use-update-search-params";
import { cn } from "@/lib/utils";
diff --git a/apps/web/src/components/incidents/affected-monitors.tsx b/apps/web/src/components/incidents/affected-monitors.tsx
index 4619da0d6..987d2a2cb 100644
--- a/apps/web/src/components/incidents/affected-monitors.tsx
+++ b/apps/web/src/components/incidents/affected-monitors.tsx
@@ -11,7 +11,7 @@ export function AffectedMonitors({
return (
<ul role="list" className="flex gap-2">
{monitors.length > 0 ? (
- monitors.map(({ name, url }, i) => (
+ monitors.map(({ name }, i) => (
<li key={i} className="text-xs">
<Badge variant="secondary">{name}</Badge>
</li>
diff --git a/apps/web/src/components/marketing/cards.tsx b/apps/web/src/components/marketing/cards.tsx
index ea7976b9a..42c163801 100644
--- a/apps/web/src/components/marketing/cards.tsx
+++ b/apps/web/src/components/marketing/cards.tsx
@@ -1,6 +1,4 @@
-import Link from "next/link";
-
-import { Badge, Button } from "@openstatus/ui";
+import { Badge } from "@openstatus/ui";
import type { Feature, SpecialFeature } from "@/config/features";
import { Shell } from "../dashboard/shell";
diff --git a/apps/web/src/components/marketing/stats.tsx b/apps/web/src/components/marketing/stats.tsx
index db5d0cbc0..7f05c4d3c 100644
--- a/apps/web/src/components/marketing/stats.tsx
+++ b/apps/web/src/components/marketing/stats.tsx
@@ -1,7 +1,8 @@
import { Shell } from "@/components/dashboard/shell";
import { getHomeStatsData } from "@/lib/tb";
import { numberFormatter } from "@/lib/utils";
-import { api } from "@/trpc/server";
+
+// import { api } from "@/trpc/server";
export async function Stats() {
const tbTotalStats = await getHomeStatsData({});
diff --git a/apps/web/src/components/modals/notification-dialog.tsx b/apps/web/src/components/modals/notification-dialog.tsx
index 21d35dfe6..e76e4f41b 100644
--- a/apps/web/src/components/modals/notification-dialog.tsx
+++ b/apps/web/src/components/modals/notification-dialog.tsx
@@ -14,11 +14,7 @@ import {
import { NotificationForm } from "@/components/forms/notification-form";
-export const NotificationDialog = ({
- workspaceSlug,
-}: {
- workspaceSlug: string;
-}) => {
+export const NotificationDialog = ({}: { workspaceSlug: string }) => {
const [open, setOpen] = useState(false);
return (
<Dialog open={open} onOpenChange={(val) => setOpen(val)}>
diff --git a/packages/notifications/discord/src/index.ts b/packages/notifications/discord/src/index.ts
index 299220d1a..982d4ed13 100644
--- a/packages/notifications/discord/src/index.ts
+++ b/packages/notifications/discord/src/index.ts
@@ -18,9 +18,13 @@ const postToWebhook = async (content: string, webhookUrl: string) => {
export const sendDiscordMessage = async ({
monitor,
notification,
+ region,
+ statusCode,
}: {
monitor: Monitor;
notification: Notification;
+ statusCode: number;
+ region: string;
}) => {
const notificationData = JSON.parse(notification.data);
const { discord: webhookUrl } = notificationData; // webhook url
@@ -30,7 +34,7 @@ export const sendDiscordMessage = async ({
await postToWebhook(
`Your monitor ${name} is down 🚨
- Your monitor with url ${monitor.url} is down.`,
+ Your monitor with url ${monitor.url} is down in ${region} with status code ${statusCode}.`,
webhookUrl,
);
} catch (err) {
diff --git a/packages/notifications/email/src/index.ts b/packages/notifications/email/src/index.ts
index 426c48033..0a3898163 100644
--- a/packages/notifications/email/src/index.ts
+++ b/packages/notifications/email/src/index.ts
@@ -6,9 +6,13 @@ import { EmailConfigurationSchema } from "./schema/config";
export const send = async ({
monitor,
notification,
+ region,
+ statusCode,
}: {
monitor: Monitor;
notification: Notification;
+ statusCode: number;
+ region: string;
}) => {
// FIXME:
const config = EmailConfigurationSchema.parse(JSON.parse(notification.data));
@@ -25,7 +29,7 @@ export const send = async ({
from: "Notifications <[email protected]>",
subject: `Your monitor ${monitor.name} is down 🚨`,
- html: `Hey, <br/> Your monitor ${monitor.name} is down. <br/> <br/> OpenStatus`,
+ html: `<p>Hi,<br><br>Your monitor ${monitor.name} is down in ${region}. </p><p>URL : ${monitor.url}</p><p>Status Code: ${statusCode}</p><p>OpenStatus πŸ“ </p>`,
}),
});
diff --git a/packages/notifications/slack/src/index.ts b/packages/notifications/slack/src/index.ts
index 400f1d233..3e6dd8bbd 100644
--- a/packages/notifications/slack/src/index.ts
+++ b/packages/notifications/slack/src/index.ts
@@ -15,9 +15,13 @@ const postToWebhook = async (body: any, webhookUrl: string) => {
export const sendSlackMessage = async ({
monitor,
notification,
+ region,
+ statusCode,
}: {
monitor: Monitor;
notification: Notification;
+ statusCode: number;
+ region: string;
}) => {
const notificationData = JSON.parse(notification.data);
const { slack: webhookUrl } = notificationData; // webhook url
@@ -31,7 +35,7 @@ export const sendSlackMessage = async ({
type: "section",
text: {
type: "mrkdwn",
- text: `Your monitor <${monitor.url}/|${name}> is down 🚨 \n\n Powered by <https://www.openstatus.dev/|OpenStatus>.`,
+ text: `Your monitor <${monitor.url}/|${name}> is down in ${region} with status code ${statusCode} 🚨 \n\n Powered by <https://www.openstatus.dev/|OpenStatus>.`,
},
accessory: {
type: "button",
diff --git a/apps/web/src/data/regions-dictionary.ts b/packages/utils/index.ts
similarity index 89%
rename from apps/web/src/data/regions-dictionary.ts
rename to packages/utils/index.ts
index d4190fc4c..71ef19586 100644
--- a/apps/web/src/data/regions-dictionary.ts
+++ b/packages/utils/index.ts
@@ -137,4 +137,27 @@ export const flyRegionsDict = {
},
} as const;
+export const vercelRegions = [
+ "arn1",
+ "bom1",
+ "cdg1",
+ "cle1",
+ "cpt1",
+ "dub1",
+ "fra1",
+ "gru1",
+ "hkg1",
+ "hnd1",
+ "iad1",
+ "icn1",
+ "kix1",
+ "lhr1",
+ "pdx1",
+ "sfo1",
+ "sin1",
+ "syd1",
+] as const;
+
+export const flyRegions = ["ams", "iad", "hkg", "jnb", "syd", "gru"] as const;
+
export const regionsDict = { ...vercelRegionsDict, ...flyRegionsDict } as const;
diff --git a/packages/utils/package.json b/packages/utils/package.json
new file mode 100644
index 000000000..2c4b9bad8
--- /dev/null
+++ b/packages/utils/package.json
@@ -0,0 +1,15 @@
+{
+ "name": "@openstatus/utils",
+ "version": "1.0.0",
+ "description": "",
+ "main": "index.ts",
+ "scripts": {},
+ "dependencies": {},
+ "devDependencies": {
+ "@openstatus/tsconfig": "workspace:*",
+ "typescript": "5.2.2"
+ },
+ "keywords": [],
+ "author": "",
+ "license": "ISC"
+}
diff --git a/packages/utils/tsconfig.json b/packages/utils/tsconfig.json
new file mode 100644
index 000000000..aed15c74a
--- /dev/null
+++ b/packages/utils/tsconfig.json
@@ -0,0 +1,4 @@
+{
+ "extends": "@openstatus/tsconfig/base.json",
+ "include": ["src", "*.ts"]
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 2e3c377e9..23c37629f 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -64,6 +64,9 @@ importers:
'@openstatus/upstash':
specifier: workspace:*
version: link:../../packages/upstash
+ '@openstatus/utils':
+ specifier: workspace:*
+ version: link:../../packages/utils
'@t3-oss/env-core':
specifier: 0.7.1
@@ -143,6 +146,9 @@ importers:
'@openstatus/upstash':
specifier: workspace:*
version: link:../../packages/upstash
+ '@openstatus/utils':
+ specifier: workspace:*
+ version: link:../../packages/utils
'@openstatus/vercel':
specifier: workspace:*
version: link:../../packages/integrations/vercel
@@ -863,6 +869,15 @@ importers:
specifier: 5.2.2
version: 5.2.2
+ packages/utils:
+ devDependencies:
+ '@openstatus/tsconfig':
+ specifier: workspace:*
+ version: link:../tsconfig
+ typescript:
+ specifier: 5.2.2
+ version: 5.2.2
+
packages:
/@aashutoshrathi/[email protected]: