coder · DanielleMaywood · Jan 13, 2025 · Jan 10, 2025 · Jan 10, 2025 · Jan 10, 2025
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000284_allow_disabling_notification_templates_by_default.down.sql b/coderd/database/migrations/000284_allow_disabling_notification_templates_by_default.down.sql
@@ -0,0 +1,18 @@
+ALTER TABLE notification_templates DROP COLUMN enabled_by_default;
+
+CREATE OR REPLACE FUNCTION inhibit_enqueue_if_disabled()
+	RETURNS TRIGGER AS
+$$
+BEGIN
+	-- Fail the insertion if the user has disabled this notification.
+	IF EXISTS (SELECT 1
+			   FROM notification_preferences
+			   WHERE disabled = TRUE
+				 AND user_id = NEW.user_id
+				 AND notification_template_id = NEW.notification_template_id) THEN
+		RAISE EXCEPTION 'cannot enqueue message: user has disabled this notification';
+	END IF;
+
+	RETURN NEW;
+END;
+$$ LANGUAGE plpgsql;
diff --git a/coderd/database/migrations/000284_allow_disabling_notification_templates_by_default.up.sql b/coderd/database/migrations/000284_allow_disabling_notification_templates_by_default.up.sql
@@ -0,0 +1,29 @@
+ALTER TABLE notification_templates ADD COLUMN enabled_by_default boolean DEFAULT TRUE NOT NULL;
+
+CREATE OR REPLACE FUNCTION inhibit_enqueue_if_disabled()
+	RETURNS TRIGGER AS
+$$
+BEGIN
+	-- Fail the insertion if one of the following:
+	--  * the user has disabled this notification.
+	--  * the notification template is disabled by default and hasn't
+	--    been explicitly enabled by the user.
+	IF EXISTS (
+		SELECT 1 FROM notification_templates
+		LEFT JOIN notification_preferences
+			ON  notification_preferences.notification_template_id = notification_templates.id
+			AND notification_preferences.user_id = NEW.user_id
+		WHERE notification_templates.id = NEW.notification_template_id AND (
+			-- Case 1: The user has explicitly disabled this template
+			notification_preferences.disabled = TRUE
+			OR
+			-- Case 2: The template is disabled by default AND the user hasn't enabled it
+			(notification_templates.enabled_by_default = FALSE AND notification_preferences.notification_template_id IS NULL)
+		)
+	) THEN
+		RAISE EXCEPTION 'cannot enqueue message: notification is not enabled';
+	END IF;
+
+	RETURN NEW;
+END;
+$$ LANGUAGE plpgsql;
diff --git a/...s/000285_disable_workspace_created_and_manually_updated_notifications_by_default.down.sql b/...s/000285_disable_workspace_created_and_manually_updated_notifications_by_default.down.sql
@@ -0,0 +1,9 @@
+-- Enable 'workspace created' notification by default
+UPDATE notification_templates
+SET enabled_by_default = TRUE
+WHERE id = '281fdf73-c6d6-4cbb-8ff5-888baf8a2fff';
+
+-- Enable 'workspace manually updated' notification by default
+UPDATE notification_templates
+SET enabled_by_default = TRUE
+WHERE id = 'd089fe7b-d5c5-4c0c-aaf5-689859f7d392';
diff --git a/...ons/000285_disable_workspace_created_and_manually_updated_notifications_by_default.up.sql b/...ons/000285_disable_workspace_created_and_manually_updated_notifications_by_default.up.sql
@@ -0,0 +1,9 @@
+-- Disable 'workspace created' notification by default
+UPDATE notification_templates
+SET enabled_by_default = FALSE
+WHERE id = '281fdf73-c6d6-4cbb-8ff5-888baf8a2fff';
+
+-- Disable 'workspace manually updated' notification by default
+UPDATE notification_templates
+SET enabled_by_default = FALSE
+WHERE id = 'd089fe7b-d5c5-4c0c-aaf5-689859f7d392';
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/notifications.go b/coderd/notifications.go
@@ -271,14 +271,15 @@ func (api *API) putUserNotificationPreferences(rw http.ResponseWriter, r *http.R
 func convertNotificationTemplates(in []database.NotificationTemplate) (out []codersdk.NotificationTemplate) {
 	for _, tmpl := range in {
 		out = append(out, codersdk.NotificationTemplate{
-			ID:            tmpl.ID,
-			Name:          tmpl.Name,
-			TitleTemplate: tmpl.TitleTemplate,
-			BodyTemplate:  tmpl.BodyTemplate,
-			Actions:       string(tmpl.Actions),
-			Group:         tmpl.Group.String,
-			Method:        string(tmpl.Method.NotificationMethod),
-			Kind:          string(tmpl.Kind),
+			ID:               tmpl.ID,
+			Name:             tmpl.Name,
+			TitleTemplate:    tmpl.TitleTemplate,
+			BodyTemplate:     tmpl.BodyTemplate,
+			Actions:          string(tmpl.Actions),
+			Group:            tmpl.Group.String,
+			Method:           string(tmpl.Method.NotificationMethod),
+			Kind:             string(tmpl.Kind),
+			EnabledByDefault: tmpl.EnabledByDefault,
 		})
 	}
 

diff --git a/coderd/notifications/enqueuer.go b/coderd/notifications/enqueuer.go
@@ -20,7 +20,7 @@ import (
 )
 
 var (
-	ErrCannotEnqueueDisabledNotification = xerrors.New("user has disabled this notification")
+	ErrCannotEnqueueDisabledNotification = xerrors.New("notification is not enabled")
 	ErrDuplicate                         = xerrors.New("duplicate notification")
 )
 

diff --git a/coderd/notifications/notifications_test.go b/coderd/notifications/notifications_test.go
@@ -1106,6 +1106,20 @@ func TestNotificationTemplates_Golden(t *testing.T) {
 							r.Name = tc.payload.UserName
 						},
 					)
+
+					// With the introduction of notifications that can be disabled
+					// by default, we want to make sure the user preferences have
+					// the notification enabled.
+					_, err := adminClient.UpdateUserNotificationPreferences(
+						context.Background(),
+						user.ID,
+						codersdk.UpdateUserNotificationPreferences{
+							TemplateDisabledMap: map[string]bool{
+								tc.id.String(): false,
+							},
+						})
+					require.NoError(t, err)
+
 					return &db, &api.Logger, &user
 				}()
 
@@ -1275,6 +1289,20 @@ func TestNotificationTemplates_Golden(t *testing.T) {
 							r.Name = tc.payload.UserName
 						},
 					)
+
+					// With the introduction of notifications that can be disabled
+					// by default, we want to make sure the user preferences have
+					// the notification enabled.
+					_, err := adminClient.UpdateUserNotificationPreferences(
+						context.Background(),
+						user.ID,
+						codersdk.UpdateUserNotificationPreferences{
+							TemplateDisabledMap: map[string]bool{
+								tc.id.String(): false,
+							},
+						})
+					require.NoError(t, err)
+
 					return &db, &api.Logger, &user
 				}()
 
@@ -1410,6 +1438,30 @@ func normalizeGoldenWebhook(content []byte) []byte {
 	return content
 }
 
+func TestDisabledByDefaultBeforeEnqueue(t *testing.T) {
+	t.Parallel()
+
+	if !dbtestutil.WillUsePostgres() {
+		t.Skip("This test requires postgres; it is testing business-logic implemented in the database")
+	}
+
+	// nolint:gocritic // Unit test.
+	ctx := dbauthz.AsNotifier(testutil.Context(t, testutil.WaitSuperLong))
+	store, _ := dbtestutil.NewDB(t)
+	logger := testutil.Logger(t)
+
+	cfg := defaultNotificationsConfig(database.NotificationMethodSmtp)
+	enq, err := notifications.NewStoreEnqueuer(cfg, store, defaultHelpers(), logger.Named("enqueuer"), quartz.NewReal())
+	require.NoError(t, err)
+	user := createSampleUser(t, store)
+
+	// We want to try enqueuing a notification on a template that is disabled
+	// by default. We expect this to fail.
+	templateID := notifications.TemplateWorkspaceManuallyUpdated
+	_, err = enq.Enqueue(ctx, user.ID, templateID, map[string]string{}, "test")
+	require.ErrorIs(t, err, notifications.ErrCannotEnqueueDisabledNotification, "enqueuing did not fail with expected error")
+}
+
 // TestDisabledBeforeEnqueue ensures that notifications cannot be enqueued once a user has disabled that notification template
 func TestDisabledBeforeEnqueue(t *testing.T) {
 	t.Parallel()

diff --git a/codersdk/notifications.go b/codersdk/notifications.go
@@ -17,14 +17,15 @@ type NotificationsSettings struct {
 }
 
 type NotificationTemplate struct {
-	ID            uuid.UUID `json:"id" format:"uuid"`
-	Name          string    `json:"name"`
-	TitleTemplate string    `json:"title_template"`
-	BodyTemplate  string    `json:"body_template"`
-	Actions       string    `json:"actions" format:""`
-	Group         string    `json:"group"`
-	Method        string    `json:"method"`
-	Kind          string    `json:"kind"`
+	ID               uuid.UUID `json:"id" format:"uuid"`
+	Name             string    `json:"name"`
+	TitleTemplate    string    `json:"title_template"`
+	BodyTemplate     string    `json:"body_template"`
+	Actions          string    `json:"actions" format:""`
+	Group            string    `json:"group"`
+	Method           string    `json:"method"`
+	Kind             string    `json:"kind"`
+	EnabledByDefault bool      `json:"enabled_by_default"`
 }
 
 type NotificationMethodsResponse struct {
-Original file line number
+Diff line change
@@ Expand Up / @@ -20,7 +20,7 @@ import ( @@
     )
     var (
-    	ErrCannotEnqueueDisabledNotification = xerrors.New("user has disabled this notification")
+    	ErrCannotEnqueueDisabledNotification = xerrors.New("notification is not enabled")
     	ErrDuplicate                         = xerrors.New("duplicate notification")
     )
@@ Expand Down @@