Notify all template admins

coder · BrunoQuaresma · Aug 14, 2024 · Aug 12, 2024 · Aug 13, 2024 · Aug 13, 2024
commit 1f7046cdd8d5d0ac7c84dea5d77aae2a5dda1a2d
diff --git a/coderd/notifications/events.go b/coderd/notifications/events.go
@@ -12,11 +12,15 @@ var (
 	TemplateWorkspaceDormant           = uuid.MustParse("0ea69165-ec14-4314-91f1-69566ac3c5a0")
 	TemplateWorkspaceAutoUpdated       = uuid.MustParse("c34a0c09-0704-4cac-bd1c-0c0146811c2b")
 	TemplateWorkspaceMarkedForDeletion = uuid.MustParse("51ce2fdf-c9ca-4be1-8d70-628674f9bc42")
-	TemplateTemplateDeleted            = uuid.MustParse("29a09665-2a4c-403f-9648-54301670e7be")
 )
 
 // Account-related events.
 var (
 	TemplateUserAccountCreated = uuid.MustParse("4e19c0ac-94e1-4532-9515-d1801aa283b2")
 	TemplateUserAccountDeleted = uuid.MustParse("f44d9314-ad03-4bc8-95d0-5cad491da6b6")
 )
+
+// Template-related events.
+var (
+	TemplateTemplateDeleted = uuid.MustParse("29a09665-2a4c-403f-9648-54301670e7be")
+)
diff --git a/coderd/templates.go b/coderd/templates.go
@@ -107,15 +107,28 @@
 		return
 	}
 
-	api.notifyTemplateDeleted(ctx, template, apiKey.UserID)
+	admins, err := findTemplateAdmins(ctx, api.Database)
+	if err != nil {
+		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Internal error fetching template admins.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+	for _, admin := range admins {
+		if admin.ID == apiKey.UserID {
+			continue
+		}
+		api.notifyTemplateDeleted(ctx, template, apiKey.UserID, admin.ID)
+	}
 
 	httpapi.Write(ctx, rw, http.StatusOK, codersdk.Response{
 		Message: "Template has been deleted!",
 	})
 }
 
-func (api *API) notifyTemplateDeleted(ctx context.Context, template database.Template, initiatorID uuid.UUID) {
-	if template.CreatedBy == initiatorID {
+func (api *API) notifyTemplateDeleted(ctx context.Context, template database.Template, initiatorID uuid.UUID, receiverID uuid.UUID) {
+	if initiatorID == receiverID {
 		return
 	}
 
@@ -125,7 +138,7 @@
 		return
 	}
 
-	if _, err := api.NotificationsEnqueuer.Enqueue(ctx, template.CreatedBy, notifications.TemplateTemplateDeleted,
+	if _, err := api.NotificationsEnqueuer.Enqueue(ctx, receiverID, notifications.TemplateTemplateDeleted,
 		map[string]string{
 			"name":      template.Name,
 			"initiator": initiator.Username,
@@ -133,7 +146,7 @@
 		// Associate this notification with all the related entities.
 		template.ID, template.OrganizationID,
 	); err != nil {
 		api.Logger.Warn(ctx, "failed to notify of template deletion", slog.F("deleted_template", template.ID), slog.Error(err))
 	}
 }

@@ -979,3 +992,22 @@
 		MaxPortShareLevel:    maxPortShareLevel,
 	}
 }
+
+// findTemplateAdmins fetches all users with template admin permission including owners.
+func findTemplateAdmins(ctx context.Context, store database.Store) ([]database.GetUsersRow, error) {
+	// Notice: we can't scrape the user information in parallel as pq
+	// fails with: unexpected describe rows response: 'D'
+	owners, err := store.GetUsers(ctx, database.GetUsersParams{
+		RbacRole: []string{codersdk.RoleOwner},
+	})
+	if err != nil {
+		return nil, xerrors.Errorf("get owners: %w", err)
+	}
+	templateAdmins, err := store.GetUsers(ctx, database.GetUsersParams{
+		RbacRole: []string{codersdk.RoleTemplateAdmin},
+	})
+	if err != nil {
+		return nil, xerrors.Errorf("get template admins: %w", err)
+	}
+	return append(owners, templateAdmins...), nil
+}
diff --git a/coderd/templates_test.go b/coderd/templates_test.go
@@ -1328,65 +1328,56 @@ func TestTemplateMetrics(t *testing.T) {
 	)
 }
 
-func TestTemplateNotifications(t *testing.T) {
+func TestNotifyDeletedTemplate(t *testing.T) {
 	t.Parallel()
 
-	t.Run("Delete", func(t *testing.T) {
+	t.Run("OnlyNotifyOwnersAndTemplateAdmins", func(t *testing.T) {
 		t.Parallel()
 
-		t.Run("InitiatorNotTemplateAdmin", func(t *testing.T) {
-			t.Parallel()
-
-			var (
-				notifyEnq = &testutil.FakeNotificationsEnqueuer{}
-				client    = coderdtest.New(t, &coderdtest.Options{
-					IncludeProvisionerDaemon: true,
-					NotificationsEnqueuer:    notifyEnq,
-				})
-				user               = coderdtest.CreateFirstUser(t, client)
-				version            = coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
-				_                  = coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID)
-				template           = coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
-				initiatorClient, _ = coderdtest.CreateAnotherUser(t, client, user.OrganizationID, rbac.RoleOwner())
-				ctx                = testutil.Context(t, testutil.WaitLong)
-			)
-
-			// When: initiator is not the template admin
-			err := initiatorClient.DeleteTemplate(ctx, template.ID)
-			require.NoError(t, err)
-
-			// Then: the template admin should receive a notification
-			require.Len(t, notifyEnq.Sent, 1)
-			require.Equal(t, notifyEnq.Sent[0].TemplateID, notifications.TemplateTemplateDeleted)
-			require.Equal(t, notifyEnq.Sent[0].UserID, template.CreatedByID)
-			require.Contains(t, notifyEnq.Sent[0].Targets, template.ID)
-			require.Contains(t, notifyEnq.Sent[0].Targets, template.OrganizationID)
-			require.Contains(t, notifyEnq.Sent[0].Labels["name"], template.Name)
-			require.Contains(t, notifyEnq.Sent[0].Labels["initiator"], coderdtest.FirstUserParams.Username)
-		})
+		var (
+			notifyEnq = &testutil.FakeNotificationsEnqueuer{}
+			client    = coderdtest.New(t, &coderdtest.Options{
+				IncludeProvisionerDaemon: true,
+				NotificationsEnqueuer:    notifyEnq,
+			})
+			firstUser = coderdtest.CreateFirstUser(t, client)
+			version   = coderdtest.CreateTemplateVersion(t, client, firstUser.OrganizationID, nil)
+			_         = coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID)
+			template  = coderdtest.CreateTemplate(t, client, firstUser.OrganizationID, version.ID)
+			ctx       = testutil.Context(t, testutil.WaitLong)
+		)
 
-		t.Run("InitiatorIsTemplateAdmin", func(t *testing.T) {
-			t.Parallel()
+		_, anotherOwner := coderdtest.CreateAnotherUser(t, client, firstUser.OrganizationID, rbac.RoleOwner())
+		_, tmplAdmin := coderdtest.CreateAnotherUser(t, client, firstUser.OrganizationID, rbac.RoleTemplateAdmin())
+		coderdtest.CreateAnotherUser(t, client, firstUser.OrganizationID, rbac.RoleMember())
 
-			var (
-				notifyEnq = &testutil.FakeNotificationsEnqueuer{}
-				client    = coderdtest.New(t, &coderdtest.Options{
-					IncludeProvisionerDaemon: true,
-					NotificationsEnqueuer:    notifyEnq,
-				})
-				user     = coderdtest.CreateFirstUser(t, client)
-				version  = coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
-				_        = coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID)
-				template = coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
-				ctx      = testutil.Context(t, testutil.WaitLong)
-			)
-
-			// When: initiator is the template admin
-			err := client.DeleteTemplate(ctx, template.ID)
-			require.NoError(t, err)
+		// When: template is deleted
+		err := client.DeleteTemplate(ctx, template.ID)
+		require.NoError(t, err)
 
-			// Then: the template admin should not receive a notification
-			require.Len(t, notifyEnq.Sent, 0)
-		})
+		// Then: the template owners and template admins should receive the notification
+		shouldBeNotified := []uuid.UUID{anotherOwner.ID, tmplAdmin.ID}
+		var deleteTemplateNotifications []*testutil.Notification
+		for _, n := range notifyEnq.Sent {
+			if n.TemplateID == notifications.TemplateTemplateDeleted {
+				deleteTemplateNotifications = append(deleteTemplateNotifications, n)
+			}
+		}
+		require.Len(t, deleteTemplateNotifications, len(shouldBeNotified))
+
+		for _, userID := range shouldBeNotified {
+			var notification *testutil.Notification
+			for _, n := range deleteTemplateNotifications {
+				if n.UserID == userID {
+					notification = n
+					break
+				}
+			}
+			require.NotNil(t, notification)
+			require.Contains(t, notification.Targets, template.ID)
+			require.Contains(t, notification.Targets, template.OrganizationID)
+			require.Equal(t, notification.Labels["name"], template.Name)
+			require.Equal(t, notification.Labels["initiator"], coderdtest.FirstUserParams.Username)
+		}
 	})
 }