chore: rewrite ood notification

coder · DanielleMaywood · Feb 17, 2025 · Jan 24, 2025 · Jan 30, 2025 · Jan 30, 2025
commit 944fdb51e5864e147451e41006e08118876a46e1
diff --git a/.../000288_oom_and_ood_notification.down.sql → .../000289_oom_and_ood_notification.down.sql b/.../000288_oom_and_ood_notification.down.sql → .../000289_oom_and_ood_notification.down.sql
diff --git a/...ns/000288_oom_and_ood_notification.up.sql → ...ns/000289_oom_and_ood_notification.up.sql b/...ns/000288_oom_and_ood_notification.up.sql → ...ns/000289_oom_and_ood_notification.up.sql
@@ -20,9 +20,16 @@ INSERT INTO notification_templates
 VALUES (
 	'f047f6a3-5713-40f7-85aa-0394cce9fa3a',
 	'Workspace Out Of Disk',
-	E'Your workspace "{{.Labels.workspace}}" is low on disk',
+	E'Your workspace "{{.Labels.workspace}}" is low on volume space',
 	E'Hi {{.UserName}},\n\n'||
-		E'Your workspace **{{.Labels.workspace}}** has reached the usage threshold set at **{{.Labels.threshold}}** for volume `{{.Labels.volume}}`.',
+		E'{{ if eq (len .Data.volumes) 1 }}{{ $volume := index .Data.volumes 0 }}'||
+			E'Volume **`{{$volume.path}}`** is over {{$volume.threshold}} full in workspace **{{.Labels.workspace}}**.'||
+		E'{{ else }}'||
+			E'The following volumes are nearly full in workspace **{{.Labels.workspace}}**\n\n'||
+			E'{{ range $volume := .Data.volumes }}'||
+				E'- **`{{$volume.path}}`** is over {{$volume.threshold}} full\n'||
+			E'{{ end }}'||
+		E'{{ end }}',
 	'Workspace Events',
 	'[
 		{

diff --git a/coderd/notifications/notifications_test.go b/coderd/notifications/notifications_test.go
@@ -1078,16 +1078,50 @@ func TestNotificationTemplates_Golden(t *testing.T) {
 			},
 		},
 		{
-			name: "TemplateWorkspaceOutOfDisk",
+			name: "TemplateWorkspaceOutOfDisk/SingleVolume",
 			id:   notifications.TemplateWorkspaceOutOfDisk,
 			payload: types.MessagePayload{
 				UserName:     "Bobby",
 				UserEmail:    "bobby@coder.com",
 				UserUsername: "bobby",
 				Labels: map[string]string{
 					"workspace": "bobby-workspace",
-					"threshold": "90%",
-					"volume":    "/home/coder",
+				},
+				Data: map[string]any{
+					"volumes": []map[string]any{
+						{
+							"path":      "/home/coder",
+							"threshold": "90%",
+						},
+					},
+				},
+			},
+		},
+		{
+			name: "TemplateWorkspaceOutOfDisk/MultipleVolumes",
+			id:   notifications.TemplateWorkspaceOutOfDisk,
+			payload: types.MessagePayload{
+				UserName:     "Bobby",
+				UserEmail:    "bobby@coder.com",
+				UserUsername: "bobby",
+				Labels: map[string]string{
+					"workspace": "bobby-workspace",
+				},
+				Data: map[string]any{
+					"volumes": []map[string]any{
+						{
+							"path":      "/home/coder",
+							"threshold": "90%",
+						},
+						{
+							"path":      "/dev/coder",
+							"threshold": "80%",
+						},
+						{
+							"path":      "/etc/coder",
+							"threshold": "95%",
+						},
+					},
 				},
 			},
 		},
@@ -1099,7 +1133,8 @@ func TestNotificationTemplates_Golden(t *testing.T) {
 	for _, name := range allTemplates {
 		var found bool
 		for _, tc := range tests {
-			if tc.name == name {
+			tcName, _, _ := strings.Cut(tc.name, "/")
+			if tcName == name {
 				found = true
 			}
 		}

diff --git a/coderd/notifications/testdata/rendered-templates/smtp/TemplateWorkspaceOutOfDisk.html.golden b/coderd/notifications/testdata/rendered-templates/smtp/TemplateWorkspaceOutOfDisk.html.golden
@@ -1,6 +1,6 @@
 From: system@coder.com
 To: bobby@coder.com
-Subject: Your workspace "bobby-workspace" is low on disk
+Subject: Your workspace "bobby-workspace" is low on volume space
 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,8 +12,7 @@ Content-Type: text/plain; charset=UTF-8
 
 Hi Bobby,
 
-Your workspace bobby-workspace has reached the usage threshold set at 90% f=
-or volume /home/coder.
+Volume /home/coder is over 90% full in workspace bobby-workspace.
 
 
 View workspace: http://test.com/@bobby/bobby-workspace
@@ -28,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>Your workspace "bobby-workspace" is low on disk</title>
+    <title>Your workspace "bobby-workspace" is low on volume space</title>
   </head>
   <body style=3D"margin: 0; padding: 0; font-family: -apple-system, system-=
 ui, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarel=
@@ -43,14 +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;">
-        Your workspace "bobby-workspace" is low on disk
+        Your workspace "bobby-workspace" is low on volume space
       </h1>
       <div style=3D"line-height: 1.5;">
         <p>Hi Bobby,</p>
 
-<p>Your workspace <strong>bobby-workspace</strong> has reached the usage th=
-reshold set at <strong>90%</strong> for volume <code>/home/coder</code>.</p=
->
+<p>Volume <strong><code>/home/coder</code></strong> is over 90% full in wor=
+kspace <strong>bobby-workspace</strong>.</p>
       </div>
       <div style=3D"text-align: center; margin-top: 32px;">
        =20

diff --git a/.../notifications/testdata/rendered-templates/webhook/TemplateWorkspaceOutOfDisk.json.golden b/.../notifications/testdata/rendered-templates/webhook/TemplateWorkspaceOutOfDisk.json.golden
@@ -16,14 +16,19 @@
       }
     ],
     "labels": {
-      "threshold": "90%",
-      "volume": "/home/coder",
       "workspace": "bobby-workspace"
     },
-    "data": null
+    "data": {
+      "volumes": [
+        {
+          "path": "/home/coder",
+          "threshold": "90%"
+        }
+      ]
+    }
   },
-  "title": "Your workspace \"bobby-workspace\" is low on disk",
-  "title_markdown": "Your workspace \"bobby-workspace\" is low on disk",
-  "body": "Hi Bobby,\n\nYour workspace bobby-workspace has reached the usage threshold set at 90% for volume /home/coder.",
-  "body_markdown": "Hi Bobby,\n\nYour workspace **bobby-workspace** has reached the usage threshold set at **90%** for volume `/home/coder`."
+  "title": "Your workspace \"bobby-workspace\" is low on volume space",
+  "title_markdown": "Your workspace \"bobby-workspace\" is low on volume space",
+  "body": "Hi Bobby,\n\nVolume /home/coder is over 90% full in workspace bobby-workspace.",
+  "body_markdown": "Hi Bobby,\n\nVolume **`/home/coder`** is over 90% full in workspace **bobby-workspace**."
 }