Skip to content

feat: add notification for suspended/activated account #14367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 20 commits into from
Aug 22, 2024
Merged

feat: add notification for suspended/activated account #14367

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
000a917
migrations
mtojek Aug 20, 2024
62cf15f
notify
mtojek Aug 20, 2024
323680c
fix
mtojek Aug 20, 2024
bbfb296
TestNotifyUserSuspended
mtojek Aug 21, 2024
e1b6c28
TestNotifyUserReactivate
mtojek Aug 21, 2024
9ef46de
Merge branch 'main' into 17-suspended-reactivated
mtojek Aug 21, 2024
c7783ac
post merge
mtojek Aug 21, 2024
55e4e13
fix escape
mtojek Aug 21, 2024
38bca28
TestNotificationTemplatesCanRender
mtojek Aug 21, 2024
37add7d
links and events
mtojek Aug 22, 2024
baf1a95
notifyEnq
mtojek Aug 22, 2024
a674476
findUserAdmins
mtojek Aug 22, 2024
96611b1
notifyUserStatusChanged
mtojek Aug 22, 2024
fabba3c
go build
mtojek Aug 22, 2024
e72bf2a
your and admin
mtojek Aug 22, 2024
80b227a
tests
mtojek Aug 22, 2024
d27bc78
refactor
mtojek Aug 22, 2024
a9d8fb6
Merge branch 'main' into 17-suspended-reactivated
mtojek Aug 22, 2024
b789a53
247
mtojek Aug 22, 2024
9931bbf
Danny's review
mtojek Aug 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
notifyUserStatusChanged
  • Loading branch information
@mtojek
mtojek committed Aug 22, 2024
commit 96611b1f630c0c0fc5df3df28fbdf82071ae5a3b
72 changes: 38 additions & 34 deletions coderd/users.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -859,47 +859,15 @@
}
aReq.New = targetUser

// Notify about the change of user status
var key string
var templateID uuid.UUID
switch status {
case database.UserStatusSuspended:
key = "suspended_account_name"
templateID = notifications.TemplateUserAccountSuspended
case database.UserStatusActive:
key = "activated_account_name"
templateID = notifications.TemplateUserAccountActivated
default:
api.Logger.Error(ctx, "unable to notify admins as the user's status is unsupported", slog.F("username", user.Username), slog.F("user_status", string(status)))

httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Message: "Internal error preparing notifications",
})
}

// Fetch all users with user admin permissions
userAdmins, err := findUserAdmins(ctx, api.Database)
err = api.notifyUserStatusChanged()

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (macos-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (macos-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (macos-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (macos-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (macos-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (macos-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (macos-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (macos-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (macos-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (macos-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / lint 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / lint 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / lint 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-e2e 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-e2e-enterprise 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-race 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-race 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-race 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-race 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-race 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-race 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-race 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-race 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-race 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-race 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (ubuntu-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (ubuntu-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (ubuntu-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (ubuntu-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (ubuntu-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (ubuntu-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (ubuntu-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (ubuntu-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (ubuntu-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (ubuntu-latest) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg-16 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg-16 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg-16 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg-16 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg-16 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg-16 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg-16 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg-16 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg-16 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go-pg-16 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (windows-2022) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (windows-2022) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (windows-2022) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (windows-2022) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (windows-2022) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (windows-2022) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (windows-2022) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (windows-2022) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (windows-2022) 

not enough arguments in call to api.notifyUserStatusChanged

Check failure on line 862 in coderd/users.go

View workflow job for this annotation

GitHub Actions / test-go (windows-2022) 

not enough arguments in call to api.notifyUserStatusChanged
if err != nil {
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Message: "Internal error fetching user admins",
Message: "Internal error notifying about changed user status.",
Detail: err.Error(),
})
return
}

// Send notifications to user admins and affected user
for _, u := range append(userAdmins, database.GetUsersRow{ID: user.ID}) {
if _, err := api.NotificationsEnqueuer.Enqueue(ctx, u.ID, templateID,
map[string]string{
key: user.Username,
}, "api-put-user-status",
user.ID,
); err != nil {
api.Logger.Warn(ctx, "unable to notify about changed user's status", slog.F("affected_user", user.Username), slog.Error(err))
}
}

// Finish: build final response
organizations, err := userOrganizationIDs(ctx, api, user)
if err != nil {
httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
Expand All @@ -912,6 +880,42 @@
}
}

func (api *API) notifyUserStatusChanged(ctx context.Context, user database.User, status database.UserStatus) error {
// Notify about the change of user status
var key string
var templateID uuid.UUID
switch status {
case database.UserStatusSuspended:
key = "suspended_account_name"
templateID = notifications.TemplateUserAccountSuspended
case database.UserStatusActive:
key = "activated_account_name"
templateID = notifications.TemplateUserAccountActivated
default:
api.Logger.Error(ctx, "user status is not supported", slog.F("username", user.Username), slog.F("user_status", string(status)))
return xerrors.Errorf("unable to notify admins as the user's status is unsupported")
}

// Fetch all users with user admin permissions
userAdmins, err := findUserAdmins(ctx, api.Database)
if err != nil {
return xerrors.Errorf("unable to find user admins: %w", err)
}

// Send notifications to user admins and affected user
for _, u := range append(userAdmins, database.GetUsersRow{ID: user.ID}) {
if _, err := api.NotificationsEnqueuer.Enqueue(ctx, u.ID, templateID,
map[string]string{
key: user.Username,
}, "api-put-user-status",
user.ID,
); err != nil {
api.Logger.Warn(ctx, "unable to notify about changed user's status", slog.F("affected_user", user.Username), slog.Error(err))
}
}
return nil
}

// @Summary Update user appearance settings
// @ID update-user-appearance-settings
// @Security CoderSessionToken
Expand Down
Loading