feat: add notification preferences database & audit support (#14100)

coderd/notifications_test.go

@@ -5,19 +5,34 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/require"
+	"golang.org/x/exp/slices"
+
+	"github.com/coder/serpent"
 
 	"github.com/coder/coder/v2/coderd/coderdtest"
+	"github.com/coder/coder/v2/coderd/database"
+	"github.com/coder/coder/v2/coderd/notifications"
 	"github.com/coder/coder/v2/codersdk"
 	"github.com/coder/coder/v2/testutil"
 )
 
+func createOpts(t *testing.T) *coderdtest.Options {
+	t.Helper()
+
+	dt := coderdtest.DeploymentValues(t)
+	dt.Experiments = []string{string(codersdk.ExperimentNotifications)}
+	return &coderdtest.Options{
+		DeploymentValues: dt,
+	}
+}
+
 func TestUpdateNotificationsSettings(t *testing.T) {
 	t.Parallel()
 
 	t.Run("Permissions denied", func(t *testing.T) {
 		t.Parallel()
 
-		api := coderdtest.New(t, nil)
+		api := coderdtest.New(t, createOpts(t))
 		firstUser := coderdtest.CreateFirstUser(t, api)
 		anotherClient, _ := coderdtest.CreateAnotherUser(t, api, firstUser.OrganizationID)
 
@@ -41,7 +56,7 @@ func TestUpdateNotificationsSettings(t *testing.T) {
 	t.Run("Settings modified", func(t *testing.T) {
 		t.Parallel()
 
-		client := coderdtest.New(t, nil)
+		client := coderdtest.New(t, createOpts(t))
 		_ = coderdtest.CreateFirstUser(t, client)
 
 		// given
@@ -65,7 +80,7 @@ func TestUpdateNotificationsSettings(t *testing.T) {
 		t.Parallel()
 
 		// Empty state: notifications Settings are undefined now (default).
-		client := coderdtest.New(t, nil)
+		client := coderdtest.New(t, createOpts(t))
 		_ = coderdtest.CreateFirstUser(t, client)
 		ctx := testutil.Context(t, testutil.WaitShort)
 
@@ -93,3 +108,213 @@ func TestUpdateNotificationsSettings(t *testing.T) {
 		require.Equal(t, expected.NotifierPaused, actual.NotifierPaused)
 	})
 }
+
+func TestNotificationPreferences(t *testing.T) {
+	t.Parallel()
+
+	t.Run("Initial state", func(t *testing.T) {
+		t.Parallel()
+
+		ctx := testutil.Context(t, testutil.WaitLong)
+		api := coderdtest.New(t, createOpts(t))
+		firstUser := coderdtest.CreateFirstUser(t, api)
+
+		// Given: a member in its initial state.
+		memberClient, member := coderdtest.CreateAnotherUser(t, api, firstUser.OrganizationID)
+
+		// When: calling the API.
+		prefs, err := memberClient.GetUserNotificationPreferences(ctx, member.ID)
+		require.NoError(t, err)
+
+		// Then: no preferences will be returned.
+		require.Len(t, prefs, 0)
+	})
+
+	t.Run("Insufficient permissions", func(t *testing.T) {
+		t.Parallel()
+
+		ctx := testutil.Context(t, testutil.WaitLong)
+		api := coderdtest.New(t, createOpts(t))
+		firstUser := coderdtest.CreateFirstUser(t, api)
+
+		// Given: 2 members.
+		_, member1 := coderdtest.CreateAnotherUser(t, api, firstUser.OrganizationID)
+		member2Client, _ := coderdtest.CreateAnotherUser(t, api, firstUser.OrganizationID)
+
+		// When: attempting to retrieve the preferences of another member.
+		_, err := member2Client.GetUserNotificationPreferences(ctx, member1.ID)
+
+		// Then: the API should reject the request.
+		var sdkError *codersdk.Error
+		require.Error(t, err)
+		require.ErrorAsf(t, err, &sdkError, "error should be of type *codersdk.Error")
+		// NOTE: ExtractUserParam gets in the way here, and returns a 400 Bad Request instead of a 403 Forbidden.
+		// This is not ideal, and we should probably change this behavior.
+		require.Equal(t, http.StatusBadRequest, sdkError.StatusCode())
+	})
+
+	t.Run("Admin may read any users' preferences", func(t *testing.T) {
+		t.Parallel()
+
+		ctx := testutil.Context(t, testutil.WaitLong)
+		api := coderdtest.New(t, createOpts(t))
+		firstUser := coderdtest.CreateFirstUser(t, api)
+
+		// Given: a member.
+		_, member := coderdtest.CreateAnotherUser(t, api, firstUser.OrganizationID)
+
+		// When: attempting to retrieve the preferences of another member as an admin.
+		prefs, err := api.GetUserNotificationPreferences(ctx, member.ID)
+
+		// Then: the API should not reject the request.
+		require.NoError(t, err)
+		require.Len(t, prefs, 0)
+	})
+
+	t.Run("Admin may update any users' preferences", func(t *testing.T) {
+		t.Parallel()
+
+		ctx := testutil.Context(t, testutil.WaitLong)
+		api := coderdtest.New(t, createOpts(t))
+		firstUser := coderdtest.CreateFirstUser(t, api)
+
+		// Given: a member.
+		memberClient, member := coderdtest.CreateAnotherUser(t, api, firstUser.OrganizationID)
+
+		// When: attempting to modify and subsequently retrieve the preferences of another member as an admin.
+		prefs, err := api.UpdateUserNotificationPreferences(ctx, member.ID, codersdk.UpdateUserNotificationPreferences{
+			TemplateDisabledMap: map[string]bool{
+				notifications.TemplateWorkspaceMarkedForDeletion.String(): true,
+			},
+		})
+
+		// Then: the request should succeed and the user should be able to query their own preferences to see the same result.
+		require.NoError(t, err)
+		require.Len(t, prefs, 1)
+
+		memberPrefs, err := memberClient.GetUserNotificationPreferences(ctx, member.ID)
+		require.NoError(t, err)
+		require.Len(t, memberPrefs, 1)
+		require.Equal(t, prefs[0].NotificationTemplateID, memberPrefs[0].NotificationTemplateID)
+		require.Equal(t, prefs[0].Disabled, memberPrefs[0].Disabled)
+	})
+
+	t.Run("Add preferences", func(t *testing.T) {
+		t.Parallel()
+
+		ctx := testutil.Context(t, testutil.WaitLong)
+		api := coderdtest.New(t, createOpts(t))
+		firstUser := coderdtest.CreateFirstUser(t, api)
+
+		// Given: a member with no preferences.
+		memberClient, member := coderdtest.CreateAnotherUser(t, api, firstUser.OrganizationID)
+		prefs, err := memberClient.GetUserNotificationPreferences(ctx, member.ID)
+		require.NoError(t, err)
+		require.Len(t, prefs, 0)
+
+		// When: attempting to add new preferences.
+		template := notifications.TemplateWorkspaceDeleted
+		prefs, err = memberClient.UpdateUserNotificationPreferences(ctx, member.ID, codersdk.UpdateUserNotificationPreferences{
+			TemplateDisabledMap: map[string]bool{
+				template.String(): true,
+			},
+		})
+
+		// Then: the returning preferences should be set as expected.
+		require.NoError(t, err)
+		require.Len(t, prefs, 1)
+		require.Equal(t, prefs[0].NotificationTemplateID, template)
+		require.True(t, prefs[0].Disabled)
+	})
+
+	t.Run("Modify preferences", func(t *testing.T) {
+		t.Parallel()
+
+		ctx := testutil.Context(t, testutil.WaitLong)
+		api := coderdtest.New(t, createOpts(t))
+		firstUser := coderdtest.CreateFirstUser(t, api)
+
+		// Given: a member with preferences.
+		memberClient, member := coderdtest.CreateAnotherUser(t, api, firstUser.OrganizationID)
+		prefs, err := memberClient.UpdateUserNotificationPreferences(ctx, member.ID, codersdk.UpdateUserNotificationPreferences{
+			TemplateDisabledMap: map[string]bool{
+				notifications.TemplateWorkspaceDeleted.String(): true,
+				notifications.TemplateWorkspaceDormant.String(): true,
+			},
+		})
+		require.NoError(t, err)
+		require.Len(t, prefs, 2)
+
+		// When: attempting to modify their preferences.
+		prefs, err = memberClient.UpdateUserNotificationPreferences(ctx, member.ID, codersdk.UpdateUserNotificationPreferences{
+			TemplateDisabledMap: map[string]bool{
+				notifications.TemplateWorkspaceDeleted.String(): true,
+				notifications.TemplateWorkspaceDormant.String(): false, // <--- this one was changed
+			},
+		})
+		require.NoError(t, err)
+		require.Len(t, prefs, 2)
+
+		// Then: the modified preferences should be set as expected.
+		var found bool
+		for _, p := range prefs {
+			switch p.NotificationTemplateID {
+			case notifications.TemplateWorkspaceDormant:
+				found = true
+				require.False(t, p.Disabled)
+			case notifications.TemplateWorkspaceDeleted:
+				require.True(t, p.Disabled)
+			}
+		}
+		require.True(t, found, "dormant notification preference was not found")
+	})
+}
+
+func TestNotificationDispatchMethods(t *testing.T) {
+	t.Parallel()
+
+	defaultOpts := createOpts(t)
+	webhookOpts := createOpts(t)
+	webhookOpts.DeploymentValues.Notifications.Method = serpent.String(database.NotificationMethodWebhook)
+
+	tests := []struct {
+		name            string
+		opts            *coderdtest.Options
+		expectedDefault string
+	}{
+		{
+			name:            "default",
+			opts:            defaultOpts,
+			expectedDefault: string(database.NotificationMethodSmtp),
+		},
+		{
+			name:            "non-default",
+			opts:            webhookOpts,
+			expectedDefault: string(database.NotificationMethodWebhook),
+		},
+	}
+
+	var allMethods []string
+	for _, nm := range database.AllNotificationMethodValues() {
+		allMethods = append(allMethods, string(nm))
+	}
+	slices.Sort(allMethods)
+
+	// nolint:paralleltest // Not since Go v1.22.
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			t.Parallel()
+
+			ctx := testutil.Context(t, testutil.WaitShort)
+			api := coderdtest.New(t, tc.opts)
+			_ = coderdtest.CreateFirstUser(t, api)
+
+			resp, err := api.GetNotificationDispatchMethods(ctx)
+			require.NoError(t, err)
+
+			slices.Sort(resp.AvailableNotificationMethods)
+			require.EqualValues(t, resp.AvailableNotificationMethods, allMethods)
+			require.Equal(t, tc.expectedDefault, resp.DefaultNotificationMethod)
+		})
+	}
+}