fix(coderd/notifications): improve TemplateDeleted notification wording

coder · SasSwart · Oct 15, 2024 · Oct 14, 2024 · Oct 15, 2024 · Oct 15, 2024
commit 89bed47afdd05ffba7ab45dbebdcb64c5cfde551
diff --git a/coderd/database/migrations/000264_manual_build_failed_notification_template.down.sql b/coderd/database/migrations/000264_manual_build_failed_notification_template.down.sql
@@ -7,3 +7,12 @@ SET
 					E'The workspace build was initiated by **{{.Labels.initiator}}**.'
 WHERE
 	id = '2faeee0f-26cb-4e96-821c-85ccb9f71513';
+
+UPDATE notification_templates
+SET
+	body_template = E'Hi {{.UserName}},\n\n' || -- Add a comma
+					E'The template **{{.Labels.name}}** was deleted by **{{ .Labels.initiator }}**.\n\n' ||
+					-- Mention template display name:
+					E'The template''s display name was **{{.Labels.display_name}}**.'
+WHERE
+	id = '29a09665-2a4c-403f-9648-54301670e7be';
diff --git a/coderd/database/migrations/000264_manual_build_failed_notification_template.up.sql b/coderd/database/migrations/000264_manual_build_failed_notification_template.up.sql
@@ -1,8 +1,16 @@
 UPDATE notification_templates
 SET
 	body_template = E'Hi {{.UserName}},\n\n' ||
-					-- Revert to a single label for the template name.:
+					-- Revert to a single label for the template name:
 					E'A manual build of the workspace **{{.Labels.name}}** using the template **{{.Labels.template_name}}** failed (version: **{{.Labels.template_version_name}}**).\n\n' ||
 					E'The workspace build was initiated by **{{.Labels.initiator}}**.'
 WHERE
 	id = '2faeee0f-26cb-4e96-821c-85ccb9f71513';
+
+UPDATE notification_templates
+SET
+	body_template = E'Hi {{.UserName}},\n\n' ||
+					-- Revert to a single label for the template name:
+					E'The template **{{.Labels.name}}** was deleted by **{{ .Labels.initiator }}**.\n\n'
+WHERE
+	id = '29a09665-2a4c-403f-9648-54301670e7be';
diff --git a/coderd/notifications/notifications_test.go b/coderd/notifications/notifications_test.go
@@ -870,9 +870,8 @@ func TestNotificationTemplates_Golden(t *testing.T) {
 				UserEmail:    "bobby@coder.com",
 				UserUsername: "bobby",
 				Labels: map[string]string{
-					"name":         "bobby-template",
-					"display_name": "Bobby's Template",
-					"initiator":    "rob",
+					"name":      "Bobby's Template",
+					"initiator": "rob",
 				},
 			},
 		},

diff --git a/coderd/notifications/testdata/rendered-templates/smtp/TemplateTemplateDeleted.html.golden b/coderd/notifications/testdata/rendered-templates/smtp/TemplateTemplateDeleted.html.golden
@@ -1,6 +1,6 @@
 From: system@coder.com
 To: bobby@coder.com
-Subject: Template "bobby-template" deleted
+Subject: Template "Bobby's Template" deleted
 Message-Id: 02ee4935-73be-4fa1-a290-ff9999026b13@blush-whale-48
 Date: Fri, 11 Oct 2024 09:03:06 +0000
 Content-Type: multipart/alternative;  boundary=bbe61b741255b6098bb6b3c1f41b885773df633cb18d2a3002b68e4bc9c4
@@ -12,9 +12,7 @@ Content-Type: text/plain; charset=UTF-8
 
 Hi Bobby,
 
-The template bobby-template was deleted by rob.
-
-The template's display name was Bobby's Template.
+The template Bobby's Template was deleted by rob.
 
 
 View templates: http://test.com/templates
@@ -29,7 +27,7 @@ Content-Type: text/html; charset=UTF-8
     <meta charset=3D"UTF-8" />
     <meta name=3D"viewport" content=3D"width=3Ddevice-width, initial-scale=
 =3D1.0" />
-    <title>Template "bobby-template" deleted</title>
+    <title>Template "Bobby's Template" deleted</title>
   </head>
   <body style=3D"margin: 0; padding: 0; font-family: -apple-system, system-=
 ui, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarel=
@@ -44,16 +42,13 @@ er Logo" style=3D"height: 40px;" />
       </div>
       <h1 style=3D"text-align: center; font-size: 24px; font-weight: 400; m=
 argin: 8px 0 32px; line-height: 1.5;">
-        Template "bobby-template" deleted
+        Template "Bobby's Template" deleted
       </h1>
       <div style=3D"line-height: 1.5;">
         <p>Hi Bobby,</p>
 
-<p>The template <strong>bobby-template</strong> was deleted by <strong>rob<=
-/strong>.</p>
-
-<p>The template&rsquo;s display name was <strong>Bobby&rsquo;s Template</st=
-rong>.</p>
+<p>The template <strong>Bobby&rsquo;s Template</strong> was deleted by <str=
+ong>rob</strong>.</p>
       </div>
       <div style=3D"text-align: center; margin-top: 32px;">
        =20

diff --git a/coderd/notifications/testdata/rendered-templates/webhook/TemplateTemplateDeleted.json.golden b/coderd/notifications/testdata/rendered-templates/webhook/TemplateTemplateDeleted.json.golden
@@ -16,14 +16,13 @@
       }
     ],
     "labels": {
-      "display_name": "Bobby's Template",
       "initiator": "rob",
-      "name": "bobby-template"
+      "name": "Bobby's Template"
     },
     "data": null
   },
-  "title": "Template \"bobby-template\" deleted",
-  "title_markdown": "Template \"bobby-template\" deleted",
-  "body": "Hi Bobby,\n\nThe template bobby-template was deleted by rob.\n\nThe template's display name was Bobby's Template.",
-  "body_markdown": "Hi Bobby,\n\nThe template **bobby-template** was deleted by **rob**.\n\nThe template's display name was **Bobby's Template**."
+  "title": "Template \"Bobby's Template\" deleted",
+  "title_markdown": "Template \"Bobby's Template\" deleted",
+  "body": "Hi Bobby,\n\nThe template Bobby's Template was deleted by rob.",
+  "body_markdown": "Hi Bobby,\n\nThe template **Bobby's Template** was deleted by **rob**.\n\n"
 }
diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -1124,17 +1124,18 @@ func (s *server) notifyWorkspaceManualBuildFailed(ctx context.Context, workspace
 	}
 
 	for _, templateAdmin := range templateAdmins {
+		templateNameLabel := template.DisplayName
+		if templateNameLabel == "" {
+			templateNameLabel = template.Name
+		}
 		labels := map[string]string{
 			"name":                     workspace.Name,
-			"template_name":            template.DisplayName,
+			"template_name":            templateNameLabel,
 			"template_version_name":    templateVersion.Name,
 			"initiator":                build.InitiatorByUsername,
 			"workspace_owner_username": workspaceOwner.Username,
 			"workspace_build_number":   strconv.Itoa(int(build.BuildNumber)),
 		}
-		if template.DisplayName == "" {
-			labels["template_name"] = template.Name
-		}
 		if _, err := s.NotificationsEnqueuer.Enqueue(ctx, templateAdmin.ID, notifications.TemplateWorkspaceManualBuildFailed,
 			labels, "provisionerdserver",
 			// Associate this notification with all the related entities.

diff --git a/coderd/templates.go b/coderd/templates.go
@@ -135,11 +135,15 @@ func (api *API) notifyTemplateDeleted(ctx context.Context, template database.Tem
 		return
 	}
 
+	templateNameLabel := template.DisplayName
+	if templateNameLabel == "" {
+		templateNameLabel = template.Name
+	}
+
 	if _, err := api.NotificationsEnqueuer.Enqueue(ctx, receiverID, notifications.TemplateTemplateDeleted,
 		map[string]string{
-			"name":         template.Name,
-			"display_name": template.DisplayName,
-			"initiator":    initiator.Username,
+			"name":      templateNameLabel,
+			"initiator": initiator.Username,
 		}, "api-templates-delete",
 		// Associate this notification with all the related entities.
 		template.ID, template.OrganizationID,

diff --git a/coderd/templates_test.go b/coderd/templates_test.go
@@ -1456,8 +1456,7 @@ func TestTemplateNotifications(t *testing.T) {
 				require.Contains(t, notifiedUsers, n.UserID)
 				require.Contains(t, n.Targets, template.ID)
 				require.Contains(t, n.Targets, template.OrganizationID)
-				require.Equal(t, n.Labels["name"], template.Name)
-				require.Equal(t, n.Labels["display_name"], template.DisplayName)
+				require.Equal(t, n.Labels["name"], template.DisplayName)
 				require.Equal(t, n.Labels["initiator"], coderdtest.FirstUserParams.Username)
 			}
 		})