Skip to content

feat: notify about created user account #14010

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 26 commits into from
Jul 30, 2024
Merged

feat: notify about created user account #14010

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
c18ada0
feat: notify about created user account
mtojek Jul 25, 2024
1cc3adb
Merge branch 'main' into 17-account-notifs
mtojek Jul 26, 2024
ca2bdde
migrations
mtojek Jul 26, 2024
d6e8964
Username
mtojek Jul 26, 2024
2d74c4e
events
mtojek Jul 26, 2024
3c3b5af
fix
mtojek Jul 26, 2024
312d9fa
WIP
mtojek Jul 26, 2024
82ec37f
fix version
mtojek Jul 26, 2024
d7b2c73
simplify
mtojek Jul 29, 2024
b81bb6a
WIP
mtojek Jul 29, 2024
00275dd
fix: versions
mtojek Jul 29, 2024
e356ba8
test
mtojek Jul 29, 2024
6bc1d2d
fix test
mtojek Jul 29, 2024
67a5137
users notified
mtojek Jul 29, 2024
6431a0e
Merge branch 'main' into 17-account-notifs
mtojek Jul 29, 2024
42d9ba1
post merge
mtojek Jul 29, 2024
ecc7d30
fmt
mtojek Jul 29, 2024
b2dcb3b
skip notif
mtojek Jul 29, 2024
70e2d2c
Danny's feedback
mtojek Jul 30, 2024
8696b70
given when then
mtojek Jul 30, 2024
a92d059
Fix tests
mtojek Jul 30, 2024
b5b0d90
Skip notifications
mtojek Jul 30, 2024
2de1786
Merge branch 'main' into 17-account-notifs
mtojek Jul 30, 2024
b843232
fix: created_account_name
mtojek Jul 30, 2024
2a53a0b
api.Database -> tx
mtojek Jul 30, 2024
77c0c28
pq issue
mtojek Jul 30, 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
Danny's feedback
  • Loading branch information
@mtojek
mtojek committed Jul 30, 2024
commit 70e2d2c2311c1d48011c8832b4d4b03e67822c02
3 changes: 3 additions & 0 deletions coderd/notifications/events.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ 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")
)

// Account-related events.
var (
TemplateUserAccountCreated = uuid.MustParse("4e19c0ac-94e1-4532-9515-d1801aa283b2")
)
70 changes: 36 additions & 34 deletions coderd/users.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1277,45 +1277,47 @@ func (api *API) CreateUser(ctx context.Context, store database.Store, req Create
}
return nil
}, nil)
if err == nil && !req.SkipNotifications {
// Notify user admins
// Get all users with user admin permission including owners
var owners, userAdmins []database.GetUsersRow
var eg errgroup.Group
eg.Go(func() error {
var err error
owners, err = api.Database.GetUsers(ctx, database.GetUsersParams{
RbacRole: []string{codersdk.RoleOwner},
})
if err != nil {
return xerrors.Errorf("get owners: %w", err)
}
return nil
if err != nil || req.SkipNotifications {
return user, req.OrganizationID, err
}

// Notify user admins
// Get all users with user admin permission including owners
var owners, userAdmins []database.GetUsersRow
var eg errgroup.Group
eg.Go(func() error {
var err error
owners, err = api.Database.GetUsers(ctx, database.GetUsersParams{
RbacRole: []string{codersdk.RoleOwner},
})
eg.Go(func() error {
var err error
userAdmins, err = api.Database.GetUsers(ctx, database.GetUsersParams{
RbacRole: []string{codersdk.RoleUserAdmin},
})
if err != nil {
return xerrors.Errorf("get user admins: %w", err)
}
return nil
if err != nil {
return xerrors.Errorf("get owners: %w", err)
}
return nil
})
eg.Go(func() error {
var err error
userAdmins, err = api.Database.GetUsers(ctx, database.GetUsersParams{
RbacRole: []string{codersdk.RoleUserAdmin},
})
err := eg.Wait()
if err != nil {
return database.User{}, uuid.Nil, err
return xerrors.Errorf("get user admins: %w", err)
}
return nil
})
err = eg.Wait()
if err != nil {
return database.User{}, uuid.Nil, err
}

for _, u := range append(owners, userAdmins...) {
if _, err := api.NotificationsEnqueuer.Enqueue(ctx, u.ID, notifications.TemplateUserAccountCreated,
map[string]string{
"user_account_name": user.Username,
}, "api-users-create",
user.ID,
); err != nil {
api.Logger.Warn(ctx, "unable to notify about created user", slog.F("created_user", user.Name), slog.Error(err))
}
for _, u := range append(owners, userAdmins...) {
if _, err := api.NotificationsEnqueuer.Enqueue(ctx, u.ID, notifications.TemplateUserAccountCreated,
map[string]string{
"created_account_name": user.Username,
}, "api-users-create",
user.ID,
); err != nil {
api.Logger.Warn(ctx, "unable to notify about created user", slog.F("created_user", user.Username), slog.Error(err))
}
}
return user, req.OrganizationID, err
Expand Down
8 changes: 4 additions & 4 deletions coderd/users_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -626,7 +626,7 @@ func TestNotifyCreatedUser(t *testing.T) {
require.Equal(t, notifications.TemplateUserAccountCreated, notifyEnq.Sent[0].TemplateID)
require.Equal(t, firstUser.UserID, notifyEnq.Sent[0].UserID)
require.Contains(t, notifyEnq.Sent[0].Targets, user.ID)
require.Equal(t, user.Username, notifyEnq.Sent[0].Labels["user_account_name"])
require.Equal(t, user.Username, notifyEnq.Sent[0].Labels["created_account_name"])
})

t.Run("UserAdminNotified", func(t *testing.T) {
Expand Down Expand Up @@ -670,19 +670,19 @@ func TestNotifyCreatedUser(t *testing.T) {
require.Equal(t, notifications.TemplateUserAccountCreated, notifyEnq.Sent[0].TemplateID)
require.Equal(t, firstUser.UserID, notifyEnq.Sent[0].UserID)
require.Contains(t, notifyEnq.Sent[0].Targets, userAdmin.ID)
require.Equal(t, userAdmin.Username, notifyEnq.Sent[0].Labels["user_account_name"])
require.Equal(t, userAdmin.Username, notifyEnq.Sent[0].Labels["created_account_name"])

// "Member" account created, "owner" notified
require.Equal(t, notifications.TemplateUserAccountCreated, notifyEnq.Sent[1].TemplateID)
require.Equal(t, firstUser.UserID, notifyEnq.Sent[1].UserID)
require.Contains(t, notifyEnq.Sent[1].Targets, member.ID)
require.Equal(t, member.Username, notifyEnq.Sent[1].Labels["user_account_name"])
require.Equal(t, member.Username, notifyEnq.Sent[1].Labels["created_account_name"])

// "Member" account created, "user admin" notified
require.Equal(t, notifications.TemplateUserAccountCreated, notifyEnq.Sent[1].TemplateID)
require.Equal(t, userAdmin.ID, notifyEnq.Sent[2].UserID)
require.Contains(t, notifyEnq.Sent[2].Targets, member.ID)
require.Equal(t, member.Username, notifyEnq.Sent[2].Labels["user_account_name"])
require.Equal(t, member.Username, notifyEnq.Sent[2].Labels["created_account_name"])
})
}

Expand Down
Loading