Skip to content

Open-source status page, incident response and uptime monitoring

refactor: server-side test notifications (#2020)

Maximilian Kaske8d733c6f96cf
diff --git a/apps/dashboard/src/components/forms/notifications/form-discord.tsx b/apps/dashboard/src/components/forms/notifications/form-discord.tsx
index c00152b4b..7652af024 100644
--- a/apps/dashboard/src/components/forms/notifications/form-discord.tsx
+++ b/apps/dashboard/src/components/forms/notifications/form-discord.tsx
@@ -16,13 +16,14 @@ import {
FormCardSeparator,
} from "@/components/forms/form-card";
import { useFormSheetDirty } from "@/components/forms/form-sheet";
-import { config } from "@/data/notifications.client";
+import { useTRPC } from "@/lib/trpc/client";
import { zodResolver } from "@hookform/resolvers/zod";
import { Button } from "@openstatus/ui/components/ui/button";
import { Form } from "@openstatus/ui/components/ui/form";
import { Input } from "@openstatus/ui/components/ui/input";
import { Label } from "@openstatus/ui/components/ui/label";
import { cn } from "@openstatus/ui/lib/utils";
+import { useMutation } from "@tanstack/react-query";
import { isTRPCClientError } from "@trpc/client";
import React, { useTransition } from "react";
import { useForm } from "react-hook-form";
@@ -60,6 +61,11 @@ export function FormDiscord({
});
const [isPending, startTransition] = useTransition();
const { setIsDirty } = useFormSheetDirty();
+ const trpc = useTRPC();
+
+ const sendTestMutation = useMutation(
+ trpc.notification.sendTest.mutationOptions(),
+ );
const formIsDirty = form.formState.isDirty;
React.useEffect(() => {
@@ -96,7 +102,12 @@ export function FormDiscord({
try {
const provider = form.getValues("provider");
const data = form.getValues("data");
- const promise = config[provider].sendTest(data);
+ const promise = sendTestMutation.mutateAsync({
+ provider,
+ data: {
+ discord: data,
+ },
+ });
toast.promise(promise, {
loading: "Sending test...",
success: "Test sent",
diff --git a/apps/dashboard/src/components/forms/notifications/form-ntfy.tsx b/apps/dashboard/src/components/forms/notifications/form-ntfy.tsx
index ef81eb2a6..80eba4f78 100644
--- a/apps/dashboard/src/components/forms/notifications/form-ntfy.tsx
+++ b/apps/dashboard/src/components/forms/notifications/form-ntfy.tsx
@@ -15,13 +15,14 @@ import {
FormCardSeparator,
} from "@/components/forms/form-card";
import { useFormSheetDirty } from "@/components/forms/form-sheet";
-import { config } from "@/data/notifications.client";
+import { useTRPC } from "@/lib/trpc/client";
import { zodResolver } from "@hookform/resolvers/zod";
import { Button } from "@openstatus/ui/components/ui/button";
import { Form } from "@openstatus/ui/components/ui/form";
import { Input } from "@openstatus/ui/components/ui/input";
import { Label } from "@openstatus/ui/components/ui/label";
import { cn } from "@openstatus/ui/lib/utils";
+import { useMutation } from "@tanstack/react-query";
import { isTRPCClientError } from "@trpc/client";
import React, { useTransition } from "react";
import { useForm } from "react-hook-form";
@@ -63,6 +64,11 @@ export function FormNtfy({
});
const [isPending, startTransition] = useTransition();
const { setIsDirty } = useFormSheetDirty();
+ const trpc = useTRPC();
+
+ const sendTestMutation = useMutation(
+ trpc.notification.sendTest.mutationOptions(),
+ );
const formIsDirty = form.formState.isDirty;
React.useEffect(() => {
@@ -99,13 +105,12 @@ export function FormNtfy({
try {
const provider = form.getValues("provider");
const data = form.getValues("data");
- const promise = config[provider].sendTest(
- data as unknown as {
- topic: string;
- serverUrl?: string;
- token?: string;
+ const promise = sendTestMutation.mutateAsync({
+ provider,
+ data: {
+ ntfy: data,
},
- );
+ });
toast.promise(promise, {
loading: "Sending test...",
success: "Test sent",
diff --git a/apps/dashboard/src/components/forms/notifications/form-opsgenie.tsx b/apps/dashboard/src/components/forms/notifications/form-opsgenie.tsx
index 8155877ce..cbf42b69c 100644
--- a/apps/dashboard/src/components/forms/notifications/form-opsgenie.tsx
+++ b/apps/dashboard/src/components/forms/notifications/form-opsgenie.tsx
@@ -14,7 +14,7 @@ import {
FormCardContent,
FormCardSeparator,
} from "@/components/forms/form-card";
-import { config } from "@/data/notifications.client";
+import { useTRPC } from "@/lib/trpc/client";
import { zodResolver } from "@hookform/resolvers/zod";
import { Button } from "@openstatus/ui/components/ui/button";
import { Form } from "@openstatus/ui/components/ui/form";
@@ -28,6 +28,7 @@ import {
SelectValue,
} from "@openstatus/ui/components/ui/select";
import { cn } from "@openstatus/ui/lib/utils";
+import { useMutation } from "@tanstack/react-query";
import { isTRPCClientError } from "@trpc/client";
import { useTransition } from "react";
import { useForm } from "react-hook-form";
@@ -67,6 +68,11 @@ export function FormOpsGenie({
},
});
const [isPending, startTransition] = useTransition();
+ const trpc = useTRPC();
+
+ const sendTestMutation = useMutation(
+ trpc.notification.sendTest.mutationOptions(),
+ );
function submitAction(values: FormValues) {
if (isPending) return;
@@ -98,12 +104,12 @@ export function FormOpsGenie({
try {
const provider = form.getValues("provider");
const data = form.getValues("data");
- const promise = config[provider].sendTest(
- data as unknown as {
- apiKey: string;
- region: "eu" | "us";
+ const promise = sendTestMutation.mutateAsync({
+ provider,
+ data: {
+ opsgenie: data,
},
- );
+ });
toast.promise(promise, {
loading: "Sending test...",
success: "Test sent",
diff --git a/apps/dashboard/src/components/forms/notifications/form-pagerduty.tsx b/apps/dashboard/src/components/forms/notifications/form-pagerduty.tsx
index 8bed98b67..d95e702cc 100644
--- a/apps/dashboard/src/components/forms/notifications/form-pagerduty.tsx
+++ b/apps/dashboard/src/components/forms/notifications/form-pagerduty.tsx
@@ -15,7 +15,7 @@ import {
FormCardSeparator,
} from "@/components/forms/form-card";
import { useFormSheetDirty } from "@/components/forms/form-sheet";
-import { config } from "@/data/notifications.client";
+import { useTRPC } from "@/lib/trpc/client";
import { zodResolver } from "@hookform/resolvers/zod";
import { PagerDutySchema } from "@openstatus/notification-pagerduty";
import { Button } from "@openstatus/ui/components/ui/button";
@@ -23,6 +23,7 @@ import { Form } from "@openstatus/ui/components/ui/form";
import { Input } from "@openstatus/ui/components/ui/input";
import { Label } from "@openstatus/ui/components/ui/label";
import { cn } from "@openstatus/ui/lib/utils";
+import { useMutation } from "@tanstack/react-query";
import { isTRPCClientError } from "@trpc/client";
import { parseAsString, useQueryState } from "nuqs";
import React, { useEffect, useTransition } from "react";
@@ -63,6 +64,11 @@ export function FormPagerDuty({
});
const [isPending, startTransition] = useTransition();
const { setIsDirty } = useFormSheetDirty();
+ const trpc = useTRPC();
+
+ const sendTestMutation = useMutation(
+ trpc.notification.sendTest.mutationOptions(),
+ );
const formIsDirty = form.formState.isDirty;
React.useEffect(() => {
@@ -114,13 +120,11 @@ export function FormPagerDuty({
toast.error("No PagerDuty configuration found");
return;
}
- const validation = PagerDutySchema.safeParse(JSON.parse(data));
- if (!validation.success) {
- toast.error("Invalid PagerDuty configuration");
- return;
- }
- const promise = config[provider].sendTest({
- integrationKey: validation.data.integration_keys[0].integration_key,
+ const promise = sendTestMutation.mutateAsync({
+ provider,
+ data: {
+ pagerduty: data,
+ },
});
toast.promise(promise, {
loading: "Sending test...",
diff --git a/apps/dashboard/src/components/forms/notifications/form-slack.tsx b/apps/dashboard/src/components/forms/notifications/form-slack.tsx
index 07693c908..736c0386b 100644
--- a/apps/dashboard/src/components/forms/notifications/form-slack.tsx
+++ b/apps/dashboard/src/components/forms/notifications/form-slack.tsx
@@ -16,13 +16,14 @@ import {
FormCardSeparator,
} from "@/components/forms/form-card";
import { useFormSheetDirty } from "@/components/forms/form-sheet";
-import { config } from "@/data/notifications.client";
+import { useTRPC } from "@/lib/trpc/client";
import { zodResolver } from "@hookform/resolvers/zod";
import { Button } from "@openstatus/ui/components/ui/button";
import { Form } from "@openstatus/ui/components/ui/form";
import { Input } from "@openstatus/ui/components/ui/input";
import { Label } from "@openstatus/ui/components/ui/label";
import { cn } from "@openstatus/ui/lib/utils";
+import { useMutation } from "@tanstack/react-query";
import { isTRPCClientError } from "@trpc/client";
import React, { useTransition } from "react";
import { useForm } from "react-hook-form";
@@ -60,6 +61,11 @@ export function FormSlack({
});
const [isPending, startTransition] = useTransition();
const { setIsDirty } = useFormSheetDirty();
+ const trpc = useTRPC();
+
+ const sendTestMutation = useMutation(
+ trpc.notification.sendTest.mutationOptions(),
+ );
const formIsDirty = form.formState.isDirty;
React.useEffect(() => {
@@ -96,7 +102,12 @@ export function FormSlack({
try {
const provider = form.getValues("provider");
const data = form.getValues("data");
- const promise = config[provider].sendTest(data);
+ const promise = sendTestMutation.mutateAsync({
+ provider,
+ data: {
+ slack: data,
+ },
+ });
toast.promise(promise, {
loading: "Sending test...",
success: "Test sent",
diff --git a/apps/dashboard/src/components/forms/notifications/form-webhook.tsx b/apps/dashboard/src/components/forms/notifications/form-webhook.tsx
index 6caabed05..4e2d75095 100644
--- a/apps/dashboard/src/components/forms/notifications/form-webhook.tsx
+++ b/apps/dashboard/src/components/forms/notifications/form-webhook.tsx
@@ -16,13 +16,14 @@ import {
FormCardSeparator,
} from "@/components/forms/form-card";
import { useFormSheetDirty } from "@/components/forms/form-sheet";
-import { config } from "@/data/notifications.client";
+import { useTRPC } from "@/lib/trpc/client";
import { zodResolver } from "@hookform/resolvers/zod";
import { Button } from "@openstatus/ui/components/ui/button";
import { Form } from "@openstatus/ui/components/ui/form";
import { Input } from "@openstatus/ui/components/ui/input";
import { Label } from "@openstatus/ui/components/ui/label";
import { cn } from "@openstatus/ui/lib/utils";
+import { useMutation } from "@tanstack/react-query";
import { isTRPCClientError } from "@trpc/client";
import React, { useTransition } from "react";
import { useForm } from "react-hook-form";
@@ -63,6 +64,11 @@ export function FormWebhook({
});
const [isPending, startTransition] = useTransition();
const { setIsDirty } = useFormSheetDirty();
+ const trpc = useTRPC();
+
+ const sendTestMutation = useMutation(
+ trpc.notification.sendTest.mutationOptions(),
+ );
const formIsDirty = form.formState.isDirty;
React.useEffect(() => {
@@ -98,12 +104,24 @@ export function FormWebhook({
startTransition(async () => {
try {
const provider = form.getValues("provider");
- const data = form.getValues("data.endpoint");
- toast.promise(config[provider].sendTest({ url: data }), {
+ const endpoint = form.getValues("data.endpoint");
+ const promise = sendTestMutation.mutateAsync({
+ provider,
+ data: {
+ webhook: { endpoint },
+ },
+ });
+ toast.promise(promise, {
loading: "Sending test...",
success: "Test sent",
- error: "Failed to send test",
+ error: (error) => {
+ if (error instanceof Error) {
+ return error.message;
+ }
+ return "Failed to send test";
+ },
});
+ await promise;
} catch (error) {
console.error(error);
}
diff --git a/apps/dashboard/src/data/notifications.client.ts b/apps/dashboard/src/data/notifications.client.ts
index 30184ee0e..171cc35aa 100644
--- a/apps/dashboard/src/data/notifications.client.ts
+++ b/apps/dashboard/src/data/notifications.client.ts
@@ -20,15 +20,6 @@ import {
import { OpsGenieIcon } from "@openstatus/icons";
import { PagerDutyIcon } from "@openstatus/icons";
import { SlackIcon } from "@openstatus/icons";
-import { sendTestDiscordMessage as sendTestDiscord } from "@openstatus/notification-discord";
-import { sendTest as sendTestGrafanaOncall } from "@openstatus/notification-grafana-oncall";
-import { sendTest as sendTestNtfy } from "@openstatus/notification-ntfy";
-import { sendTest as sendTestOpsGenie } from "@openstatus/notification-opsgenie";
-import { sendTest as sendTestPagerDuty } from "@openstatus/notification-pagerduty";
-import { sendTestSlackMessage as sendTestSlack } from "@openstatus/notification-slack";
-import { sendTest as sendTestTelegram } from "@openstatus/notification-telegram";
-import { sendTest as sendWhatsAppTest } from "@openstatus/notification-twillio-whatsapp";
-import { sendTest as sendTestWebhook } from "@openstatus/notification-webhook";
import {
BellIcon,
Cog,
@@ -71,75 +62,61 @@ export const config = {
icon: SlackIcon,
label: "Slack",
form: FormSlack,
- sendTest: sendTestSlack,
},
discord: {
icon: DiscordIcon,
label: "Discord",
form: FormDiscord,
- sendTest: sendTestDiscord,
},
email: {
icon: Mail,
label: "Email",
form: FormEmail,
- // TODO: add sendTest
- sendTest: undefined,
},
sms: {
icon: MessageCircle,
label: "SMS",
form: FormSms,
- // TODO: add sendTest
- sendTest: undefined,
},
webhook: {
icon: Webhook,
label: "Webhook",
form: FormWebhook,
- sendTest: sendTestWebhook,
},
opsgenie: {
icon: OpsGenieIcon,
label: "OpsGenie",
form: FormOpsGenie,
- sendTest: sendTestOpsGenie,
},
"google-chat": {
icon: GoogleIcon,
label: "Google Chat",
form: FormGoogleChat,
- sendTest: sendTestWebhook,
},
"grafana-oncall": {
icon: GrafanaIcon,
label: "Grafana OnCall",
form: FormGrafanaOncall,
- sendTest: sendTestGrafanaOncall,
},
pagerduty: {
icon: PagerDutyIcon,
label: "PagerDuty",
form: FormPagerDuty,
- sendTest: sendTestPagerDuty,
},
ntfy: {
icon: BellIcon, // TODO: add svg icon
label: "Ntfy",
form: FormNtfy,
- sendTest: sendTestNtfy,
},
telegram: {
icon: TelegramIcon,
label: "Telegram",
form: FormTelegram,
- sendTest: sendTestTelegram,
},
whatsapp: {
icon: WhatsappIcon,
label: "WhatsApp",
form: FormWhatsApp,
- sendTest: sendWhatsAppTest,
},
};
diff --git a/packages/api/package.json b/packages/api/package.json
index bc1774d82..aa22b6662 100644
--- a/packages/api/package.json
+++ b/packages/api/package.json
@@ -16,10 +16,16 @@
"@openstatus/error": "workspace:*",
"@openstatus/locales": "workspace:*",
"@openstatus/importers": "workspace:*",
+ "@openstatus/notification-discord": "workspace:*",
"@openstatus/notification-google-chat": "workspace:*",
"@openstatus/notification-grafana-oncall": "workspace:*",
+ "@openstatus/notification-ntfy": "workspace:*",
+ "@openstatus/notification-opsgenie": "workspace:*",
+ "@openstatus/notification-pagerduty": "workspace:*",
+ "@openstatus/notification-slack": "workspace:*",
"@openstatus/notification-telegram": "workspace:*",
"@openstatus/notification-twillio-whatsapp": "workspace:*",
+ "@openstatus/notification-webhook": "workspace:*",
"@openstatus/regions": "workspace:*",
"@openstatus/tinybird": "workspace:*",
"@openstatus/upstash": "workspace:*",
diff --git a/packages/api/src/router/notification.ts b/packages/api/src/router/notification.ts
index 67ae3d506..0381f8f86 100644
--- a/packages/api/src/router/notification.ts
+++ b/packages/api/src/router/notification.ts
@@ -4,24 +4,39 @@ import { z } from "zod";
import { and, count, eq, inArray } from "@openstatus/db";
import {
NotificationDataSchema,
+ discordDataSchema,
googleChatDataSchema,
grafanaOncallDataSchema,
monitor,
notification,
notificationProvider,
notificationsToMonitors,
+ ntfyDataSchema,
+ opsgenieDataSchema,
+ pagerdutyDataSchema,
selectMonitorSchema,
selectNotificationSchema,
+ slackDataSchema,
telegramDataSchema,
+ webhookDataSchema,
whatsappDataSchema,
} from "@openstatus/db/src/schema";
import { Events } from "@openstatus/analytics";
import { SchemaError } from "@openstatus/error";
+import { sendTestDiscordMessage as sendDiscordTest } from "@openstatus/notification-discord";
import { sendTest as sendGoogleChatTest } from "@openstatus/notification-google-chat";
import { sendTest as sendGrafanaTest } from "@openstatus/notification-grafana-oncall";
+import { sendTest as sendNtfyTest } from "@openstatus/notification-ntfy";
+import { sendTest as sendOpsGenieTest } from "@openstatus/notification-opsgenie";
+import {
+ PagerDutySchema,
+ sendTest as sendPagerDutyTest,
+} from "@openstatus/notification-pagerduty";
+import { sendTestSlackMessage as sendSlackTest } from "@openstatus/notification-slack";
import { sendTest as sendTelegramTest } from "@openstatus/notification-telegram";
import { sendTest as sendWhatsAppTest } from "@openstatus/notification-twillio-whatsapp";
+import { sendTest as sendWebhookTest } from "@openstatus/notification-webhook";
import { redis } from "@openstatus/upstash";
import { nanoid } from "nanoid";
@@ -324,6 +339,108 @@ export const notificationRouter = createTRPCRouter({
await sendGrafanaTest(_data.data["grafana-oncall"]);
return;
}
+ if (opts.input.provider === "discord") {
+ const _data = discordDataSchema.safeParse(opts.input.data);
+ if (!_data.success) {
+ throw new TRPCError({
+ code: "BAD_REQUEST",
+ message: SchemaError.fromZod(_data.error, opts.input).message,
+ });
+ }
+
+ await sendDiscordTest(_data.data.discord);
+ return;
+ }
+ if (opts.input.provider === "slack") {
+ const _data = slackDataSchema.safeParse(opts.input.data);
+ if (!_data.success) {
+ throw new TRPCError({
+ code: "BAD_REQUEST",
+ message: SchemaError.fromZod(_data.error, opts.input).message,
+ });
+ }
+
+ await sendSlackTest(_data.data.slack);
+ return;
+ }
+ if (opts.input.provider === "webhook") {
+ const _data = webhookDataSchema.safeParse(opts.input.data);
+ if (!_data.success) {
+ throw new TRPCError({
+ code: "BAD_REQUEST",
+ message: SchemaError.fromZod(_data.error, opts.input).message,
+ });
+ }
+
+ await sendWebhookTest({
+ url: _data.data.webhook.endpoint,
+ headers: _data.data.webhook.headers,
+ });
+ return;
+ }
+ if (opts.input.provider === "opsgenie") {
+ const _data = opsgenieDataSchema.safeParse(opts.input.data);
+ if (!_data.success) {
+ throw new TRPCError({
+ code: "BAD_REQUEST",
+ message: SchemaError.fromZod(_data.error, opts.input).message,
+ });
+ }
+
+ await sendOpsGenieTest(_data.data.opsgenie);
+ return;
+ }
+ if (opts.input.provider === "ntfy") {
+ const _data = ntfyDataSchema.safeParse(opts.input.data);
+ if (!_data.success) {
+ throw new TRPCError({
+ code: "BAD_REQUEST",
+ message: SchemaError.fromZod(_data.error, opts.input).message,
+ });
+ }
+
+ await sendNtfyTest(_data.data.ntfy);
+ return;
+ }
+ if (opts.input.provider === "pagerduty") {
+ const _data = pagerdutyDataSchema.safeParse(opts.input.data);
+ if (!_data.success) {
+ throw new TRPCError({
+ code: "BAD_REQUEST",
+ message: SchemaError.fromZod(_data.error, opts.input).message,
+ });
+ }
+
+ let rawPagerduty: unknown;
+ try {
+ rawPagerduty = JSON.parse(_data.data.pagerduty);
+ } catch {
+ throw new TRPCError({
+ code: "BAD_REQUEST",
+ message: "Invalid PagerDuty configuration: malformed JSON",
+ });
+ }
+
+ const parsed = PagerDutySchema.safeParse(rawPagerduty);
+ if (!parsed.success) {
+ throw new TRPCError({
+ code: "BAD_REQUEST",
+ message: "Invalid PagerDuty configuration",
+ });
+ }
+
+ if (parsed.data.integration_keys.length === 0) {
+ throw new TRPCError({
+ code: "BAD_REQUEST",
+ message: "No PagerDuty integration key provided",
+ });
+ }
+
+ await sendPagerDutyTest({
+ integrationKey: parsed.data.integration_keys[0].integration_key,
+ });
+ return;
+ }
throw new TRPCError({
code: "BAD_REQUEST",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index eb4ee229d..c8662ef59 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -1231,18 +1231,36 @@ importers:
'@openstatus/locales':
specifier: workspace:*
version: link:../locales
+ '@openstatus/notification-discord':
+ specifier: workspace:*
+ version: link:../notifications/discord
'@openstatus/notification-google-chat':
specifier: workspace:*
version: link:../notifications/google-chat
'@openstatus/notification-grafana-oncall':
specifier: workspace:*
version: link:../notifications/grafana-oncall
+ '@openstatus/notification-ntfy':
+ specifier: workspace:*
+ version: link:../notifications/ntfy
+ '@openstatus/notification-opsgenie':
+ specifier: workspace:*
+ version: link:../notifications/opsgenie
+ '@openstatus/notification-pagerduty':
+ specifier: workspace:*
+ version: link:../notifications/pagerduty
+ '@openstatus/notification-slack':
+ specifier: workspace:*
+ version: link:../notifications/slack
'@openstatus/notification-telegram':
specifier: workspace:*
version: link:../notifications/telegram
'@openstatus/notification-twillio-whatsapp':
specifier: workspace:*
version: link:../notifications/twillio-whatsapp
+ '@openstatus/notification-webhook':
+ specifier: workspace:*
+ version: link:../notifications/webhook
'@openstatus/regions':
specifier: workspace:*
version: link:../regions