Clarification on enqueue failure

dannykopping · dannykopping · commit bbcbcf2d63c7 · 2024-08-05T10:08:44.000+02:00
Test fix

Signed-off-by: Danny Kopping &lt;danny@coder.com&gt;
diff --git a/coderd/notifications/enqueuer.go b/coderd/notifications/enqueuer.go
@@ -83,6 +83,11 @@ func (s *StoreEnqueuer) Enqueue(ctx context.Context, userID, templateID uuid.UUI
 		CreatedBy:              createdBy,
 	})
 	if err != nil {
+		// We have a trigger on the notification_messages table named `inhibit_enqueue_if_disabled` which prevents messages
+		// from being enqueued if the user has disabled them via notification_preferences. The trigger will fail the insertion
+		// with the message "cannot enqueue message: user has disabled this notification".
+		//
+		// This is more efficient than fetching the user's preferences for each enqueue, and centralizes the business logic.
 		if strings.Contains(err.Error(), ErrCannotEnqueueDisabledNotification.Error()) {
 			return nil, ErrCannotEnqueueDisabledNotification
 		}
diff --git a/coderd/notifications/notifications_test.go b/coderd/notifications/notifications_test.go
@@ -886,8 +886,9 @@ func TestCustomNotificationMethod(t *testing.T) {
 	require.NoError(t, err)
 	require.EventuallyWithT(t, func(ct *assert.CollectT) {
 		msgs := mockSMTPSrv.MessagesAndPurge()
-		assert.Len(ct, msgs, 1)
-		assert.Contains(ct, msgs[0].MsgRequest(), fmt.Sprintf("Message-Id: %s", msgID))
+		if assert.Len(ct, msgs, 1) {
+			assert.Contains(ct, msgs[0].MsgRequest(), fmt.Sprintf("Message-Id: %s", msgID))
+		}
 	}, testutil.WaitLong, testutil.IntervalFast)
 }
 
