coder · BrunoQuaresma · Sep 11, 2024 · Sep 1, 2024 · Sep 1, 2024 · Sep 3, 2024
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/notifications.sql b/coderd/database/queries/notifications.sql
@@ -1,6 +1,7 @@
 -- name: FetchNewMessageMetadata :one
 -- This is used to build up the notification_message's JSON payload.
 SELECT nt.name                                                    AS notification_name,
+       nt.id                                                      AS notification_template_id,
        nt.actions                                                 AS actions,
        nt.method                                                  AS custom_method,
        u.id                                                       AS user_id,

diff --git a/coderd/notifications/dispatch/smtp/html.gotmpl b/coderd/notifications/dispatch/smtp/html.gotmpl
@@ -26,6 +26,7 @@
       <div style="border-top: 1px solid #e2e8f0; color: #475569; font-size: 12px; margin-top: 64px; padding-top: 24px; line-height: 1.6;">
         <p>&copy;&nbsp;{{ current_year }}&nbsp;Coder. All rights reserved&nbsp;-&nbsp;<a href="{{ base_url }}" style="color: #2563eb; text-decoration: none;">{{ base_url }}</a></p>
         <p><a href="{{ base_url }}/settings/notifications" style="color: #2563eb; text-decoration: none;">Click here to manage your notification settings</a></p>
+        <p><a href="{{ base_url }}/settings/notifications?disabled={{ .NotificationTemplateID }}" style="color: #2563eb; text-decoration: none;">Stop receiving emails like this</a></p>
       </div>
     </div>
   </body>

diff --git a/coderd/notifications/enqueuer.go b/coderd/notifications/enqueuer.go
@@ -121,9 +121,10 @@ func (s *StoreEnqueuer) Enqueue(ctx context.Context, userID, templateID uuid.UUI
 // actions which can be taken by the recipient.
 func (s *StoreEnqueuer) buildPayload(metadata database.FetchNewMessageMetadataRow, labels map[string]string) (*types.MessagePayload, error) {
 	payload := types.MessagePayload{
-		Version: "1.0",
+		Version: "1.1",
 
-		NotificationName: metadata.NotificationName,
+		NotificationName:       metadata.NotificationName,
+		NotificationTemplateID: metadata.NotificationTemplateID.String(),
 
 		UserID:       metadata.UserID.String(),
 		UserEmail:    metadata.UserEmail,

diff --git a/coderd/notifications/render/gotmpl_test.go b/coderd/notifications/render/gotmpl_test.go
@@ -56,6 +56,15 @@ func TestGoTemplate(t *testing.T) {
 				"url": "https://mocked-server-address/@johndoe/my-workspace"
 			}]`,
 		},
+		{
+			name: "render notification template ID",
+			in:   `{{ .NotificationTemplateID }}`,
+			payload: types.MessagePayload{
+				NotificationTemplateID: "4e19c0ac-94e1-4532-9515-d1801aa283b2",
+			},
+			expectedOutput: "4e19c0ac-94e1-4532-9515-d1801aa283b2",
+			expectedErr:    nil,
+		},
 	}
 
 	for _, tc := range tests {

diff --git a/coderd/notifications/types/payload.go b/coderd/notifications/types/payload.go
@@ -7,7 +7,8 @@ package types
 type MessagePayload struct {
 	Version string `json:"_version"`
 
-	NotificationName string `json:"notification_name"`
+	NotificationName       string `json:"notification_name"`
+	NotificationTemplateID string `json:"notification_template_id"`
 
 	UserID       string `json:"user_id"`
 	UserEmail    string `json:"user_email"`

diff --git a/site/src/api/queries/notifications.ts b/site/src/api/queries/notifications.ts
@@ -5,6 +5,7 @@ import type {
 	UpdateNotificationTemplateMethod,
 	UpdateUserNotificationPreferences,
 } from "api/typesGenerated";
+import { displayError, displaySuccess } from "components/GlobalSnackbar/utils";
 import type { QueryClient, UseMutationOptions } from "react-query";
 
 export const userNotificationPreferencesKey = (userId: string) => [
@@ -136,3 +137,40 @@ export const updateNotificationTemplateMethod = (
 		UpdateNotificationTemplateMethod
 	>;
 };
+
+export const disableNotification = (
+	userId: string,
+	queryClient: QueryClient,
+) => {
+	return {
+		mutationFn: async (templateId: string) => {
+			const result = await API.putUserNotificationPreferences(userId, {
+				template_disabled_map: {
+					[templateId]: true,
+				},
+			});
+
+			// Invalidate the user notification preferences query
+			queryClient.invalidateQueries(userNotificationPreferencesKey(userId));
+
+			return result;
+		},
+		onSuccess: (_, templateId) => {
+			const allTemplates = queryClient.getQueryData<NotificationTemplate[]>(
+				systemNotificationTemplatesKey,
+			);
+			const template = allTemplates?.find((t) => t.id === templateId);
+
+			if (template) {
+				displaySuccess(`${template.name} notification has been disabled`);
+			} else {
+				displaySuccess("Notification has been disabled");
+			}
+		},
+		onError: () => {
+			displayError(
+				"An error occurred when attempting to disable the requested notification",
+			);
+		},
+	} satisfies UseMutationOptions<NotificationPreference[], unknown, string>;
+};
diff --git a/site/src/pages/UserSettingsPage/NotificationsPage/NotificationsPage.tsx b/site/src/pages/UserSettingsPage/NotificationsPage/NotificationsPage.tsx
@@ -8,6 +8,7 @@ import ListItemText, { listItemTextClasses } from "@mui/material/ListItemText";
 import Switch from "@mui/material/Switch";
 import Tooltip from "@mui/material/Tooltip";
 import {
+	disableNotification,
 	notificationDispatchMethods,
 	selectTemplatesByGroup,
 	systemNotificationTemplates,
@@ -18,7 +19,7 @@ import type {
 	NotificationPreference,
 	NotificationTemplate,
 } from "api/typesGenerated";
-import { displaySuccess } from "components/GlobalSnackbar/utils";
+import { displayError, displaySuccess } from "components/GlobalSnackbar/utils";
 import { Loader } from "components/Loader/Loader";
 import { Stack } from "components/Stack/Stack";
 import { useAuthenticated } from "contexts/auth/RequireAuth";
@@ -28,8 +29,10 @@ import {
 	methodLabels,
 } from "modules/notifications/utils";
 import { type FC, Fragment } from "react";
+import { useEffect } from "react";
 import { Helmet } from "react-helmet-async";
 import { useMutation, useQueries, useQueryClient } from "react-query";
+import { useSearchParams } from "react-router-dom";
 import { pageTitle } from "utils/page";
 import { Section } from "../Section";
 
@@ -60,6 +63,23 @@ export const NotificationsPage: FC = () => {
 	const updatePreferences = useMutation(
 		updateUserNotificationPreferences(user.id, queryClient),
 	);
+	const disableMutation = useMutation(
+		disableNotification(user.id, queryClient),
+	);
+	const [searchParams] = useSearchParams();
+	const disabledId = searchParams.get("disabled");
+
+	useEffect(() => {
+		if (disabledId && templatesByGroup.isSuccess && templatesByGroup.data) {
+			disableMutation.mutate(disabledId);
+		}
+	}, [
+		disabledId,
+		templatesByGroup.isSuccess,
+		templatesByGroup.data,
+		disableMutation,
+	]);
+
 	const ready =
 		disabledPreferences.data && templatesByGroup.data && dispatchMethods.data;