feat(coderd/notifications): provide additional context to workspace n…

…otifications
coder · dannykopping · Oct 9, 2024 · Oct 3, 2024 · Oct 5, 2024 · Oct 5, 2024
commit d8e00c28cd73d7feef10a2846ab29bc10f688750
diff --git a/coderd/database/migrations/000262_improve_notification_templates.up.sql b/coderd/database/migrations/000262_improve_notification_templates.up.sql
@@ -1,80 +1,103 @@
+-- https://github.com/coder/coder/issues/14893
+
+-- UserAccountSuspended
 UPDATE notification_templates
 SET
-	body_template = E'Hi {{.UserName}},\n\n' ||
+	body_template = E'Hi {{.UserName}},\n\n' || -- Add a \n
 		            E'User account **{{.Labels.suspended_account_name}}** has been suspended.\n\n' ||
+					-- Mention the real name of the user who suspended the account:
   	                E'The newly suspended account belongs to **{{.Labels.suspended_account_user_name}}** and was suspended by **{{.Labels.account_suspender_user_name}}**.'
 WHERE
 	id = 'b02ddd82-4733-4d02-a2d7-c36f3598997d';
 
+-- YourAccountSuspended
 UPDATE notification_templates
 SET
-	body_template = E'Hi {{.UserName}},\n\n' ||
+	body_template = E'Hi {{.UserName}},\n\n' || -- Add a \n
+					-- Mention who suspended the account:
 					E'Your account **{{.Labels.suspended_account_name}}** has been suspended by **{{.Labels.account_suspender_user_name}}**'
 WHERE
 	id = '6a2f0609-9b69-4d36-a989-9f5925b6cbff';
 
+-- UserAccountActivated
 UPDATE notification_templates
 SET
-	body_template = E'Hi {{.UserName}},\n\n' ||
+	body_template = E'Hi {{.UserName}},\n\n' || -- Add a \n
 	                E'User account **{{.Labels.activated_account_name}}** has been activated.\n\n' ||
+					-- Mention the real name of the user who activated the account:
 	                E'The newly activated account belongs to **{{.Labels.activated_account_user_name}}** and was activated by **{{.Labels.account_activator_user_name}}**.'
 WHERE
     id = '9f5af851-8408-4e73-a7a1-c6502ba46689';
 
+-- YourAccountActivated
 UPDATE notification_templates
 SET
-	body_template = E'Hi {{.UserName}},\n\n' ||
+	body_template = E'Hi {{.UserName}},\n\n' || -- Add a \n
+					-- Mention who activated the account:
 					E'Your account **{{.Labels.activated_account_name}}** has been activated by **{{.Labels.account_activator_user_name}}**.'
 WHERE
 	id = '1a6a6bea-ee0a-43e2-9e7c-eabdb53730e4';
 
+-- UserAccountCreated
 UPDATE notification_templates
 SET
     body_template = E'Hi {{.UserName}},\n\n' ||
 					E'New user account **{{.Labels.created_account_name}}** has been created.\n\n' ||
+					-- Mention the real name of the user who created the account:
 					E'This new user account was created for **{{.Labels.created_account_user_name}}** by **{{.Labels.account_creator}}**'
 WHERE
 	id = '4e19c0ac-94e1-4532-9515-d1801aa283b2';
 
+-- UserAccountDeleted
 UPDATE notification_templates
 SET
     body_template = E'Hi {{.UserName}},\n\n' ||
 					E'User account **{{.Labels.deleted_account_name}}** has been deleted.\n\n' ||
+					-- Mention the real name of the user who deleted the account:
 					E'The deleted account belonged to **{{.Labels.deleted_account_user_name}}** and was deleted by **{{.Labels.account_deleter_user_name}}**.'
 WHERE
 	id = 'f44d9314-ad03-4bc8-95d0-5cad491da6b6';
 
+-- TemplateDeleted
 UPDATE notification_templates
 SET
-	body_template = E'Hi {{.UserName}}\n\n' ||
+	body_template = E'Hi {{.UserName}}i,\n\n' || -- Add a comma
 					E'The template **{{.Labels.name}}** was deleted by **{{ .Labels.initiator }}**.\n\n' ||
-					E'The templates display name was **{{.Labels.display_name}}**.'
+					-- Mention template display name:
+					E'The template''s display name was **{{.Labels.display_name}}**.'
 WHERE
 	id = '29a09665-2a4c-403f-9648-54301670e7be';
 
+-- WorkspaceAutoUpdated
 UPDATE notification_templates
-SET body_template = E'Hi {{.UserName}}\n\n' ||
+SET body_template = E'Hi {{.UserName}},\n\n' || -- Add a comma and a \n
+					-- Add a \n:
                     E'Your workspace **{{.Labels.name}}** has been updated automatically to the latest template version ({{.Labels.template_version_name}}).\n\n' ||
                     E'Reason for update: **{{.Labels.template_version_message}}**'
 WHERE
 	id = 'c34a0c09-0704-4cac-bd1c-0c0146811c2b';
 
+-- WorkspaceAutoBuildFailed
 UPDATE notification_templates
 SET
-	body_template = E'Hi {{.UserName}}\n\n' ||
+	body_template = E'Hi {{.UserName}},\n\n' || -- Add a comma
+					-- Add a \n after:
 					E'Automatic build of your workspace **{{.Labels.name}}** failed.\n\n' ||
 					E'The specified reason was "**{{.Labels.reason}}**".'
 WHERE
 	id = '381df2a9-c0c0-4749-420f-80a9280c66f9';
 
+-- WorkspaceDeleted
 UPDATE notification_templates
 SET
-	body_template = E'Hi {{.UserName}},\n\n' ||
+	body_template = E'Hi {{.UserName}},\n\n' || -- Add a comma
+					-- Add a \n after:
 					E'Your workspace **{{.Labels.name}}** was deleted.\n\n' ||
 					E'The specified reason was "**{{.Labels.reason}}{{ if .Labels.initiator }} ({{ .Labels.initiator }}){{end}}**".'
 WHERE
 	id = 'f517da0b-cdc9-410f-ab89-a86107c420ed';
 
+-- WorkspaceDormant
 UPDATE notification_templates
 SET
 	body_template = E'Hi {{.UserName}}\n\n,' || -- add comma
@@ -84,6 +107,7 @@ SET
 WHERE
 	id = '0ea69165-ec14-4314-91f1-69566ac3c5a0';
 
+-- WorkspaceMarkedForDeletion
 UPDATE notification_templates
 SET
 	body_template = E'Hi {{.UserName}}\n\n,' || -- add comma
@@ -92,10 +116,13 @@ SET
 WHERE
 	id = '51ce2fdf-c9ca-4be1-8d70-628674f9bc42';
 
+-- WorkspaceManualBuildFailed
 UPDATE notification_templates
 SET
     body_template = E'Hi {{.UserName}},\n\n' ||
 					E'A manual build of the workspace **{{.Labels.name}}** using the template **{{.Labels.template_name}}** failed (version: **{{.Labels.template_version_name}}**).\n\n' ||
+					-- Mention template display name:
+					E'The template''s display name was **{{.Labels.template_display_name}}**.' ||
 					E'The workspace build was initiated by **{{.Labels.initiator}}**.'
 WHERE
 	id = '2faeee0f-26cb-4e96-821c-85ccb9f71513';
diff --git a/coderd/notifications/notifications_test.go b/coderd/notifications/notifications_test.go
@@ -846,6 +846,7 @@ func TestNotificationTemplates_Golden(t *testing.T) {
 				Labels: map[string]string{
 					"name":                     "bobby-workspace",
 					"template_name":            "bobby-template",
+					"template_display_name":    "William's Template",
 					"template_version_name":    "bobby-template-version",
 					"initiator":                "joe",
 					"workspace_owner_username": "mrbobby",

diff --git a/coderd/notifications/testdata/rendered-templates/TemplateTemplateDeleted-body.md.golden b/coderd/notifications/testdata/rendered-templates/TemplateTemplateDeleted-body.md.golden
@@ -1,5 +1,5 @@
-Hi Bobby
+Hi Bobbyi,
 
 The template **bobby-template** was deleted by **rob**.
 
-The templates display name was **Bobby's Template**.
+The template's display name was **Bobby's Template**.
diff --git a/coderd/notifications/testdata/rendered-templates/TemplateWorkspaceAutoUpdated-body.md.golden b/coderd/notifications/testdata/rendered-templates/TemplateWorkspaceAutoUpdated-body.md.golden
@@ -1,4 +1,4 @@
-Hi Bobby
+Hi Bobby,
 
 Your workspace **bobby-workspace** has been updated automatically to the latest template version (1.0).
 

diff --git a/...notifications/testdata/rendered-templates/TemplateWorkspaceAutobuildFailed-body.md.golden b/...notifications/testdata/rendered-templates/TemplateWorkspaceAutobuildFailed-body.md.golden
@@ -1,4 +1,4 @@
-Hi Bobby
+Hi Bobby,
 
 Automatic build of your workspace **bobby-workspace** failed.
 

diff --git a/...tifications/testdata/rendered-templates/TemplateWorkspaceManualBuildFailed-body.md.golden b/...tifications/testdata/rendered-templates/TemplateWorkspaceManualBuildFailed-body.md.golden
@@ -2,4 +2,4 @@ Hi Bobby,
 
 A manual build of the workspace **bobby-workspace** using the template **bobby-template** failed (version: **bobby-template-version**).
 
-The workspace build was initiated by **joe**.
+The template's display name was **William's Template**.The workspace build was initiated by **joe**.
diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -1128,6 +1128,7 @@ func (s *server) notifyWorkspaceManualBuildFailed(ctx context.Context, workspace
 			map[string]string{
 				"name":                     workspace.Name,
 				"template_name":            template.Name,
+				"template_display_name":    template.DisplayName,
 				"template_version_name":    templateVersion.Name,
 				"initiator":                build.InitiatorByUsername,
 				"workspace_owner_username": workspaceOwner.Username,

diff --git a/coderd/provisionerdserver/provisionerdserver_test.go b/coderd/provisionerdserver/provisionerdserver_test.go
@@ -1860,6 +1860,7 @@ func TestNotifications(t *testing.T) {
 		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, template.DisplayName, notifEnq.Sent[0].Labels["template_display_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"])
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,4 @@ Hi Bobby,

		A manual build of the workspace bobby-workspace using the template bobby-template failed (version: bobby-template-version).

		The workspace build was initiated by joe.
		The template's display name was William's Template.The workspace build was initiated by joe.