feat: turn off notification via email

joobisb · joobisb · commit 85688120722f · 2024-09-01T23:37:38.000+05:30
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?unsubscribe={{ .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
@@ -123,7 +123,8 @@ func (s *StoreEnqueuer) buildPayload(metadata database.FetchNewMessageMetadataRo
 	payload := types.MessagePayload{
 		Version: "1.0",
 
-		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,13 +7,12 @@ package types
 type MessagePayload struct {
 	Version string `json:"_version"`
 
-	NotificationName string `json:"notification_name"`
-
-	UserID       string `json:"user_id"`
-	UserEmail    string `json:"user_email"`
-	UserName     string `json:"user_name"`
-	UserUsername string `json:"user_username"`
-
-	Actions []TemplateAction  `json:"actions"`
-	Labels  map[string]string `json:"labels"`
+	NotificationName       string            `json:"notification_name"`
+	NotificationTemplateID string            `json:"notification_template_id"`
+	UserID                 string            `json:"user_id"`
+	UserEmail              string            `json:"user_email"`
+	UserName               string            `json:"user_name"`
+	UserUsername           string            `json:"user_username"`
+	Actions                []TemplateAction  `json:"actions"`
+	Labels                 map[string]string `json:"labels"`
 }
diff --git a/site/src/pages/UserSettingsPage/NotificationsPage/NotificationsPage.tsx b/site/src/pages/UserSettingsPage/NotificationsPage/NotificationsPage.tsx
@@ -18,7 +18,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 +28,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 +62,27 @@ export const NotificationsPage: FC = () => {
 	const updatePreferences = useMutation(
 		updateUserNotificationPreferences(user.id, queryClient),
 	);
+	const [searchParams] = useSearchParams();
+	const unsubscribeTemplateId = searchParams.get("unsubscribe");
+
+	useEffect(() => {
+		if (unsubscribeTemplateId) {
+			handleUnsubscribe(unsubscribeTemplateId);
+		}
+	}, [unsubscribeTemplateId]);
+
+	const handleUnsubscribe = async (templateId: string) => {
+		await updatePreferences.mutateAsync({
+			template_disabled_map: {
+				[templateId]: true,
+			},
+		});
+		displaySuccess("Notification preferences updated");
+		queryClient.invalidateQueries(
+			userNotificationPreferences(user.id).queryKey,
+		);
+	};
+
 	const ready =
 		disabledPreferences.data && templatesByGroup.data && dispatchMethods.data;
 
