chore: begin impl of test notification

coder · DanielleMaywood · Feb 19, 2025 · Feb 11, 2025 · Feb 13, 2025 · Feb 18, 2025
commit 53d69757c4ab215c6293e266fb4aa4386360739c
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -1370,6 +1370,7 @@ func New(options *Options) *API {
 				r.Get("/system", api.systemNotificationTemplates)
 			})
 			r.Get("/dispatch-methods", api.notificationDispatchMethods)
+			r.Post("/test", api.postTestNotification)
 		})
 		r.Route("/tailnet", func(r chi.Router) {
 			r.Use(apiKeyMiddleware)

diff --git a/coderd/database/migrations/000291_test_notification.down.sql b/coderd/database/migrations/000291_test_notification.down.sql
@@ -0,0 +1 @@
+DELETE FROM notification_templates WHERE id = 'c425f63e-716a-4bf4-ae24-78348f706c3f';
diff --git a/coderd/database/migrations/000291_test_notification.up.sql b/coderd/database/migrations/000291_test_notification.up.sql
@@ -0,0 +1,11 @@
+INSERT INTO notification_templates
+	(id, name, title_template, body_template, "group", actions)
+VALUES (
+	'c425f63e-716a-4bf4-ae24-78348f706c3f',
+	'Test Notification',
+	E'A test notification',
+	E'Hi {{.UserName}},\n\n'||
+		E'This is a test notification.',
+	'Notification Events',
+	'[]'::jsonb
+);
diff --git a/coderd/notifications.go b/coderd/notifications.go
@@ -11,8 +11,10 @@ import (
 
 	"github.com/coder/coder/v2/coderd/audit"
 	"github.com/coder/coder/v2/coderd/database"
+	"github.com/coder/coder/v2/coderd/database/dbauthz"
 	"github.com/coder/coder/v2/coderd/httpapi"
 	"github.com/coder/coder/v2/coderd/httpmw"
+	"github.com/coder/coder/v2/coderd/notifications"
 	"github.com/coder/coder/v2/coderd/rbac"
 	"github.com/coder/coder/v2/codersdk"
 )
@@ -163,6 +165,42 @@ func (api *API) notificationDispatchMethods(rw http.ResponseWriter, r *http.Requ
 	})
 }
 
+// @Summary Send a test notification
+// @ID post-test-notification
+// @Security CoderSessionToken
+// @Tags Notifications
+// @Success 200
+// @Router /notifications/test [post]
+func (api *API) postTestNotification(rw http.ResponseWriter, r *http.Request) {
+	var (
+		ctx = r.Context()
+		key = httpmw.APIKey(r)
+	)
+
+	if _, err := api.NotificationsEnqueuer.EnqueueWithData(
+		//nolint:gocritic // We need to be notifier to send the notification.
+		dbauthz.AsNotifier(ctx),
+		key.UserID,
+		notifications.TemplateTestNotification,
+		map[string]string{},
+		map[string]any{
+			// TODO: This is maybe not the best idea, but we want to avoid
+			// the notification de-duplication logic.
+			"timestamp": api.Clock.Now(),
+		},
+		"send-test-notification",
+	); err != nil {
+		api.Logger.Error(ctx, "send notification", slog.Error(err))
+		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Failed to send test notification",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	httpapi.Write(ctx, rw, http.StatusOK, nil)
+}
+
 // @Summary Get user notification preferences
 // @ID get-user-notification-preferences
 // @Security CoderSessionToken

diff --git a/coderd/notifications/events.go b/coderd/notifications/events.go
@@ -39,3 +39,8 @@ var (
 
 	TemplateWorkspaceBuildsFailedReport = uuid.MustParse("34a20db2-e9cc-4a93-b0e4-8569699d7a00")
 )
+
+// Notification-related events.
+var (
+	TemplateTestNotification = uuid.MustParse("c425f63e-716a-4bf4-ae24-78348f706c3f")
+)
diff --git a/site/src/api/api.ts b/site/src/api/api.ts
@@ -2286,6 +2286,10 @@ class ApiMethods {
 		return res.data;
 	};
 
+	postTestNotification = async () => {
+		await this.axios.post<void>("/api/v2/notifications/test");
+	};
+
 	updateNotificationTemplateMethod = async (
 		templateId: string,
 		req: TypesGen.UpdateNotificationTemplateMethod,

diff --git a/site/src/api/queries/notifications.ts b/site/src/api/queries/notifications.ts
@@ -98,6 +98,16 @@ export const notificationDispatchMethods = () => {
 	};
 };
 
+export const notificationTestKey = ["notifications", "test"];
+
+export const sendTestNotification = (queryClient: QueryClient) => {
+	return {
+		mutationFn: async () => {
+			await API.postTestNotification();
+		},
+	} satisfies UseMutationOptions;
+};
+
 export const updateNotificationTemplateMethod = (
 	templateId: string,
 	queryClient: QueryClient,

diff --git a/site/src/pages/DeploymentSettingsPage/NotificationsPage/NotificationsPage.tsx b/site/src/pages/DeploymentSettingsPage/NotificationsPage/NotificationsPage.tsx
@@ -2,6 +2,7 @@ import type { Interpolation, Theme } from "@emotion/react";
 import {
 	notificationDispatchMethods,
 	selectTemplatesByGroup,
+	sendTestNotification,
 	systemNotificationTemplates,
 } from "api/queries/notifications";
 import { Loader } from "components/Loader/Loader";
@@ -12,11 +13,13 @@ import { castNotificationMethod } from "modules/notifications/utils";
 import { Section } from "pages/UserSettingsPage/Section";
 import type { FC } from "react";
 import { Helmet } from "react-helmet-async";
-import { useQueries } from "react-query";
+import { useMutation, useQueries, useQueryClient } from "react-query";
 import { deploymentGroupHasParent } from "utils/deployOptions";
 import { pageTitle } from "utils/page";
 import OptionsTable from "../OptionsTable";
 import { NotificationEvents } from "./NotificationEvents";
+import { Stack } from "components/Stack/Stack";
+import { Button } from "components/Button/Button";
 
 export const NotificationsPage: FC = () => {
 	const { deploymentConfig } = useDeploymentSettings();
@@ -33,6 +36,8 @@ export const NotificationsPage: FC = () => {
 		key: "tab",
 		defaultValue: "events",
 	});
+	const queryClient = useQueryClient();
+	const sendNotification = useMutation(sendTestNotification(queryClient));
 
 	const ready = !!(templatesByGroup.data && dispatchMethods.data);
 	return (
@@ -71,11 +76,22 @@ export const NotificationsPage: FC = () => {
 								)}
 							/>
 						) : (
-							<OptionsTable
-								options={deploymentConfig.options.filter((o) =>
-									deploymentGroupHasParent(o.group, "Notifications"),
-								)}
-							/>
+							<Stack>
+								<Button
+									className="w-fit"
+									onClick={async () => {
+										await sendNotification.mutateAsync();
+									}}
+								>
+									Send test notification
+								</Button>
+
+								<OptionsTable
+									options={deploymentConfig.options.filter((o) =>
+										deploymentGroupHasParent(o.group, "Notifications"),
+									)}
+								/>
+							</Stack>
 						)
 					) : (
 						<Loader />
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		DELETE FROM notification_templates WHERE id = 'c425f63e-716a-4bf4-ae24-78348f706c3f';