8000 feat: notify about manual failed builds by mtojek · Pull Request #14419 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

feat: notify about manual failed builds #14419

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 16 commits into from
Aug 27, 2024
Merged

feat: notify about manual failed builds #14419

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
24e8c1b
Manual build failed
mtojek Aug 23, 2024
0782614
fix
mtojek Aug 23, 2024
2342d52
WIP
mtojek Aug 26, 2024
127aa47
simple test
mtojek Aug 26, 2024
e9737eb
fix
mtojek Aug 26, 2024
a13eb9e
Merge branch 'main' into 16-manual-build-failed
mtojek Aug 26, 2024
0d889b5
fix
mtojek Aug 26, 2024
015ec3c
double n
mtojek Aug 26, 2024
6a0b9f7
expose template version
mtojek Aug 26, 2024
f03cbc0
fix: logging
mtojek Aug 27, 2024
30f3809
build number
mtojek Aug 27, 2024
c2f038c
prepare
mtojek Aug 27, 2024
2381213
fmt
mtojek Aug 27, 2024
51b880c
fmt 8000
mtojek Aug 27, 2024
e4f6f29
test
mtojek Aug 27, 2024
53f6eab
comment
mtojek Aug 27, 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
expose template version
  • Loading branch information
@mtojek
mtojek committed Aug 26, 2024
commit 6a0b9f7eb6d9bf4807511cd559fefc0b3a3ab037
2 changes: 1 addition & 1 deletion coderd/database/migrations/000248_notifications_manual_build_failed.up.sql
View file
Open in desktop
8000
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
INSERT INTO notification_templates (id, name, title_template, body_template, "group", actions)
VALUES ('2faeee0f-26cb-4e96-821c-85ccb9f71513', 'Workspace Manual Build Failed', E'Workspace "{{.Labels.name}}" manual build failed',
E'Hi {{.UserName}},\n\nA manual build of the workspace **{{.Labels.name}}** using the template **{{.Labels.template_name}}** failed.\nThe workspace build was initiated by **{{.Labels.initiator}}**.',
E'Hi {{.UserName}},\n\nA manual build of the workspace **{{.Labels.name}}** using the template **{{.Labels.template_name}}** failed (version: **{{.Labels.template_version_name}}**).\nThe workspace build was initiated by **{{.Labels.initiator}}**.',
'Workspace Events', '[
{
"label": "View workspace",
Expand Down
1 change: 1 addition & 0 deletions coderd/notifications/notifications_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -822,6 +822,7 @@ func TestNotificationTemplatesCanRender(t *testing.T) {
Labels: map[string]string{
"name": "bobby-workspace",
"template_name": "bobby-template",
"template_version_name": "bobby-template-version",
"initiator": "joe",
"workspace_owner_username": "mrbobby",
},
Expand Down
9 changes: 8 additions & 1 deletion coderd/provisionerdserver/provisionerdserver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1130,6 +1130,12 @@ func (s *server) notifyWorkspaceManualBuildFailed(ctx context.Context, workspace
return
}

templateVersion, err := s.Database.GetTemplateVersionByID(ctx, build.TemplateVersionID)
if err != nil {
s.Logger.Error(ctx, "unable to fetch template version", slog.Error(err))
return
}

workspaceOwner, err := s.Database.GetUserByID(ctx, workspace.OwnerID)
if err != nil {
s.Logger.Error(ctx, "unable to fetch workspace owner", slog.Error(err))
Expand All @@ -1141,8 +1147,9 @@ func (s *server) notifyWorkspaceManualBuildFailed(ctx context.Context, workspace
map[string]string{
"name": workspace.Name,
"template_name": template.Name,
"template_version_name": templateVersion.Name,
"initiator": build.InitiatorByUsername,
"workspace_owner_username": workspaceOwner.Name,
"workspace_owner_username": workspaceOwner.Username,
}, "provisionerdserver",
// Associate this notification with all the related entities.
workspace.ID, workspace.OwnerID, workspace.TemplateID, workspace.OrganizationID,
Expand Down
17 changes: 11 additions & 6 deletions coderd/provisionerdserver/provisionerdserver_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1848,12 +1848,17 @@ func TestNotifications(t *testing.T) {

// then
require.Len(t, notifEnq.Sent, 1)
require.Equal(t, notifEnq.Sent[0].UserID, templateAdmin.ID)
require.Equal(t, notifEnq.Sent[0].TemplateID, notifications.TemplateWorkspaceManualBuildFailed)
require.Contains(t, notifEnq.Sent[0].Targets, template.ID)
require.Contains(t, notifEnq.Sent[0].Targets, workspace.ID)
require.Contains(t, notifEnq.Sent[0].Targets, workspace.OrganizationID)
require.Contains(t, notifEnq.Sent[0].Targets, user.ID)
assert.Equal(t, notifEnq.Sent[0].UserID, templateAdmin.ID)
assert.Equal(t, notifEnq.Sent[0].TemplateID, notifications.TemplateWorkspaceManualBuildFailed)
assert.Contains(t, notifEnq.Sent[0].Targets, template.ID)
assert.Contains(t, notifEnq.Sent[0].Targets, workspace.ID)
assert.Contains(t, notifEnq.Sent[0].Targets, workspace.OrganizationID)
assert.Contains(t, notifEnq.Sent[0].Targets, user.ID)
assert.Equal(t, workspace.Name, notifEnq.Sent[0].Labels["name"])
assert.Equal(t, template.Name, notifEnq.Sent[0].Labels["template_name"])
assert.Equal(t, version.Name, notifEnq.Sent[0].Labels["template_version_name"])
assert.Equal(t, user.Username, notifEnq.Sent[0].Labels["initiator"])
assert.Equal(t, user.Username, notifEnq.Sent[0].Labels["workspace_owner_username"])
Comment on lines +1855 to +1865
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like these assertions could be passed into the previous table-based test "Workspace build failed"?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a significant difference as here we expect notifications sent only to template admins, we don't care about workspace owners. I tried to squeeze this unit test as much as possible.

})
}

Expand Down
Loading
0