From 2a41843a5c3de1f4579cae85fe12d8c94314cf2a Mon Sep 17 00:00:00 2001
From: Gilles De Mey <gilles.de.mey@gmail.com>
Date: Fri, 12 May 2023 17:45:03 +0200
Subject: [PATCH] Alerting: Omit "description" and "summary" from default email
 template annotations (#68122) (#68189)

* Alerting: Omit "description" and "summary" from default email template annotations (#68122)

(cherry picked from commit 720b5b3b6515c72f98c957b2f2c9bbc4aedec7e5)

Co-authored-by: Matthew Jacobson <matthew.jacobson@grafana.com>
---
 .../partials/alerting/instance_details.mjml   | 111 +++++-------------
 pkg/services/ngalert/notifier/email_test.go   |   8 +-
 public/emails/ng_alert_notification.html      |  88 ++++----------
 3 files changed, 61 insertions(+), 146 deletions(-)

diff --git a/emails/templates/partials/alerting/instance_details.mjml b/emails/templates/partials/alerting/instance_details.mjml
index 26a4bbd7856..458124dd974 100644
--- a/emails/templates/partials/alerting/instance_details.mjml
+++ b/emails/templates/partials/alerting/instance_details.mjml
@@ -1,71 +1,47 @@
 <!-- Image from external service -->
-<mj-raw>
-  {{ if .ImageURL }}
-</mj-raw>
+<mj-raw>{{ if .ImageURL }}</mj-raw>
 <mj-section padding="0">
   <mj-column border-bottom="1px solid #2f3037">
     <mj-image href="{{ .ImageURL }}" src="{{ .ImageURL }}" padding="0" />
   </mj-column>
 </mj-section>
-<mj-raw>
-  {{ end }}
-</mj-raw>
+<mj-raw>{{ end }}</mj-raw>
 
 <!-- Embedded Image -->
-<mj-raw>
-  {{ if .EmbeddedImage }}
-</mj-raw>
+<mj-raw>{{ if .EmbeddedImage }}</mj-raw>
 <mj-section padding="0">
   <mj-column border-bottom="1px solid #2f3037">
     <mj-image src="cid:{{ .EmbeddedImage }}" padding="0" />
   </mj-column>
 </mj-section>
-<mj-raw>
-  {{ end }}
-</mj-raw>
+<mj-raw>{{ end }}</mj-raw>
 
 <mj-section padding="0" text-align="left">
   <mj-column>
     <!-- Summary -->
-    <mj-raw>
-      {{ if .Annotations.summary }}
-    </mj-raw>
+    <mj-raw>{{ if .Annotations.summary }}</mj-raw>
     <mj-text>
       <strong>Summary</strong>
     </mj-text>
-    <mj-text>
-      {{- .Annotations.summary -}}
-    </mj-text>
-    <mj-raw>
-      {{ end }}
-    </mj-raw>
+    <mj-text> {{- .Annotations.summary -}} </mj-text>
+    <mj-raw>{{ end }}</mj-raw>
 
     <!-- Description -->
-    <mj-raw>
-      {{ if .Annotations.description }}
-    </mj-raw>
+    <mj-raw>{{ if .Annotations.description }}</mj-raw>
     <mj-text>
       <strong>Description</strong>
     </mj-text>
     <mj-text>
-      <mj-raw>
-        {{ range $line := (splitList "\n" .Annotations.description) }}
-      </mj-raw>
+      <mj-raw>{{ range $line := (splitList "\n" .Annotations.description) }}</mj-raw>
       {{ $line }}<br />
-      <mj-raw>
-        {{ end }}
-      </mj-raw>
+      <mj-raw>{{ end }}</mj-raw>
     </mj-text>
-    <mj-raw>
-      {{ end }}
-    </mj-raw>
+    <mj-raw>{{ end }}</mj-raw>
   </mj-column>
 </mj-section>
 
 <!-- Values -->
-<mj-raw>
-  {{ if .Values }}
-</mj-raw>
+<mj-raw>{{ if .Values }}</mj-raw>
 <mj-section padding="0" text-align="left">
   <mj-column>
     <mj-text>
@@ -76,80 +52,56 @@
 <mj-section padding="0 25px" text-align="left">
   <mj-column padding="10px" background-color="#111217" border="1px solid #2f3037">
     <mj-text>
-      <mj-raw>
-        {{ range $refID, $value := .Values }}
-      </mj-raw>
+      <mj-raw>{{ range $refID, $value := .Values }}</mj-raw>
       {{ $refID }}={{ $value }}&nbsp;
-      <mj-raw>
-        {{ end }}
-      </mj-raw>
+      <mj-raw>{{ end }}</mj-raw>
     </mj-text>
   </mj-column>
 </mj-section>
-<mj-raw>
-  {{ end }}
-</mj-raw>
+<mj-raw>{{ end }}</mj-raw>
 
 <!-- Labels and annotations -->
 <mj-section>
   <mj-column>
     <!-- Labels -->
-    <mj-raw>
-      {{ if .Labels.SortedPairs }}
-    </mj-raw>
+    <mj-raw>{{ if .Labels.SortedPairs }}</mj-raw>
     <mj-text>
       <strong>Labels</strong>
     </mj-text>
 
     <mj-table color="white">
-      <mj-raw>
-        {{ range .Labels.SortedPairs }}
-      </mj-raw>
+      <mj-raw>{{ range .Labels.SortedPairs }}</mj-raw>
       <tr>
         <td>
           <strong>{{ .Name }}</strong>
         </td>
-        <td>
-          {{ .Value }}
-        </td>
+        <td>{{ .Value }}</td>
       </tr>
-      <mj-raw>
-        {{ end }}
-      </mj-raw>
+      <mj-raw>{{ end }}</mj-raw>
     </mj-table>
 
-    <mj-raw>
-      {{ end }}
-    </mj-raw>
+    <mj-raw>{{ end }}</mj-raw>
 
-    <!-- Annotations -->
-    <mj-raw>
-      {{ if .Annotations.SortedPairs }}
-    </mj-raw>
+    <!-- Annotations, we exclude "description" and "summary" because those have their own dedicated section -->
+    <mj-raw>{{ if (without .Annotations.SortedPairs.Names "description" "summary") }}</mj-raw>
     <mj-text>
       <strong>Annotations</strong>
     </mj-text>
 
     <mj-table color="white">
-      <mj-raw>
-        {{ range .Annotations.SortedPairs }}
-      </mj-raw>
+      <mj-raw>{{ range .Annotations.SortedPairs }}</mj-raw>
+      <mj-raw>{{ if and (ne .Name "description") (ne .Name "summary") }}</mj-raw>
       <tr>
         <td>
           <strong>{{ .Name }}</strong>
         </td>
-        <td>
-          {{ .Value }}
-        </td>
+        <td>{{ .Value }}</td>
       </tr>
-      <mj-raw>
-        {{ end }}
-      </mj-raw>
+      <mj-raw>{{ end }}</mj-raw>
+      <mj-raw>{{ end }}</mj-raw>
     </mj-table>
 
-    <mj-raw>
-      {{ end }}
-    </mj-raw>
+    <mj-raw>{{ end }}</mj-raw>
   </mj-column>
 </mj-section>
 
@@ -178,9 +130,7 @@
   <mj-raw>{{ end }}</mj-raw>
   <mj-raw>{{ if .PanelURL }}</mj-raw>
   <mj-column>
-    <mj-button align="center" href="{{ .PanelURL }}" padding="0" inner-padding="5px 12px">
-      View panel
-    </mj-button>
+    <mj-button align="center" href="{{ .PanelURL }}" padding="0" inner-padding="5px 12px"> View panel </mj-button>
   </mj-column>
   <mj-raw>{{ end }}</mj-raw>
 </mj-section>
@@ -189,7 +139,8 @@
 <mj-section border-top="1px solid #2f3037" padding="5px 0">
   <mj-column>
     <mj-text color="#91929e">
-      Observed <strong>{{ ago .StartsAt }}</strong> before this notification was delivered, at <strong>{{ .StartsAt }}</strong>
+      Observed <strong>{{ ago .StartsAt }}</strong> before this notification was delivered, at
+      <strong>{{ .StartsAt }}</strong>
     </mj-text>
   </mj-column>
 </mj-section>
diff --git a/pkg/services/ngalert/notifier/email_test.go b/pkg/services/ngalert/notifier/email_test.go
index 7bcd66a10a2..6bbae47a275 100644
--- a/pkg/services/ngalert/notifier/email_test.go
+++ b/pkg/services/ngalert/notifier/email_test.go
@@ -112,11 +112,11 @@ func TestEmailNotifierIntegration(t *testing.T) {
 			expSnippets: []string{
 				"2 firing instances",
 				"<strong>severity</strong>",
-				"warning\n",
-				"critical\n",
+				"warning",
+				"critical",
 				"<strong>alertname</strong>",
-				"FiringTwo\n",
-				"FiringOne\n",
+				"FiringTwo",
+				"FiringOne",
 				"<a href=\"http://fix.me\"",
 				"<a href=\"http://localhost/base/d/abc",
 				"<a href=\"http://localhost/base/d/abc?viewPanel=5",
diff --git a/public/emails/ng_alert_notification.html b/public/emails/ng_alert_notification.html
index 92e98369e9b..3dcf73630d8 100644
--- a/public/emails/ng_alert_notification.html
+++ b/public/emails/ng_alert_notification.html
@@ -470,13 +470,9 @@
                               <tr>
                                 <td align="left" style="font-size:0px;padding:10px 25px;word-break:break-word;">
                                   <div style="font-family:Ubuntu, Helvetica, Arial, sans-serif;font-size:13px;line-height:1.5;text-align:left;color:#FFFFFF;">
-                                    <mj-raw>
-                                      {{ range $line := (splitList "\n" .Annotations.description) }}
-                                    </mj-raw>
+                                    <mj-raw>{{ range $line := (splitList "\n" .Annotations.description) }}</mj-raw>
                                     {{ $line }}<br>
-                                    <mj-raw>
-                                      {{ end }}
-                                    </mj-raw>
+                                    <mj-raw>{{ end }}</mj-raw>
                                   </div>
                                 </td>
                               </tr>
@@ -533,12 +529,8 @@
                                       <tr>
                                         <td align="left" style="font-size:0px;padding:10px 25px;word-break:break-word;">
                                           <div style="font-family:Ubuntu, Helvetica, Arial, sans-serif;font-size:13px;line-height:1.5;text-align:left;color:#FFFFFF;">
-                                            <mj-raw>
-                                              {{ range $refID, $value := .Values }}
-                                            </mj-raw>
-                                            {{ $refID }}={{ $value }}&nbsp; <mj-raw>
-                                              {{ end }}
-                                            </mj-raw>
+                                            <mj-raw>{{ range $refID, $value := .Values }}</mj-raw>
+                                            {{ $refID }}={{ $value }}&nbsp; <mj-raw>{{ end }}</mj-raw>
                                           </div>
                                         </td>
                                       </tr>
@@ -576,24 +568,18 @@
                               <tr>
                                 <td align="left" style="font-size:0px;padding:10px 25px;word-break:break-word;">
                                   <table cellpadding="0" cellspacing="0" width="100%" border="0" style="color:white;font-family:Ubuntu, Helvetica, Arial, sans-serif;font-size:13px;line-height:22px;table-layout:auto;width:100%;border:none;">
-                                    <mj-raw>
-                                      {{ range .Labels.SortedPairs }}
-                                    </mj-raw>
+                                    <mj-raw>{{ range .Labels.SortedPairs }}</mj-raw>
                                     <tr>
                                       <td>
                                         <strong>{{ .Name }}</strong>
                                       </td>
-                                      <td>
-                                        {{ .Value }}
-                                      </td>
+                                      <td>{{ .Value }}</td>
                                     </tr>
-                                    <mj-raw>
-                                      {{ end }}
-                                    </mj-raw>
+                                    <mj-raw>{{ end }}</mj-raw>
                                   </table>
                                 </td>
                               </tr>
-                              {{ end }}{{ if .Annotations.SortedPairs }}
+                              {{ end }}{{ if (without .Annotations.SortedPairs.Names "description" "summary") }}
                               <tr>
                                 <td align="left" style="font-size:0px;padding:10px 25px;word-break:break-word;">
                                   <div style="font-family:Ubuntu, Helvetica, Arial, sans-serif;font-size:13px;line-height:1.5;text-align:left;color:#FFFFFF;"><strong>Annotations</strong></div>
@@ -602,20 +588,16 @@
                               <tr>
                                 <td align="left" style="font-size:0px;padding:10px 25px;word-break:break-word;">
                                   <table cellpadding="0" cellspacing="0" width="100%" border="0" style="color:white;font-family:Ubuntu, Helvetica, Arial, sans-serif;font-size:13px;line-height:22px;table-layout:auto;width:100%;border:none;">
-                                    <mj-raw>
-                                      {{ range .Annotations.SortedPairs }}
-                                    </mj-raw>
+                                    <mj-raw>{{ range .Annotations.SortedPairs }}</mj-raw>
+                                    <mj-raw>{{ if and (ne .Name "description") (ne .Name "summary") }}</mj-raw>
                                     <tr>
                                       <td>
                                         <strong>{{ .Name }}</strong>
                                       </td>
-                                      <td>
-                                        {{ .Value }}
-                                      </td>
+                                      <td>{{ .Value }}</td>
                                     </tr>
-                                    <mj-raw>
-                                      {{ end }}
-                                    </mj-raw>
+                                    <mj-raw>{{ end }}</mj-raw>
+                                    <mj-raw>{{ end }}</mj-raw>
                                   </table>
                                 </td>
                               </tr>
@@ -979,13 +961,9 @@
                               <tr>
                                 <td align="left" style="font-size:0px;padding:10px 25px;word-break:break-word;">
                                   <div style="font-family:Ubuntu, Helvetica, Arial, sans-serif;font-size:13px;line-height:1.5;text-align:left;color:#FFFFFF;">
-                                    <mj-raw>
-                                      {{ range $line := (splitList "\n" .Annotations.description) }}
-                                    </mj-raw>
+                                    <mj-raw>{{ range $line := (splitList "\n" .Annotations.description) }}</mj-raw>
                                     {{ $line }}<br>
-                                    <mj-raw>
-                                      {{ end }}
-                                    </mj-raw>
+                                    <mj-raw>{{ end }}</mj-raw>
                                   </div>
                                 </td>
                               </tr>
@@ -1042,12 +1020,8 @@
                                       <tr>
                                         <td align="left" style="font-size:0px;padding:10px 25px;word-break:break-word;">
                                           <div style="font-family:Ubuntu, Helvetica, Arial, sans-serif;font-size:13px;line-height:1.5;text-align:left;color:#FFFFFF;">
-                                            <mj-raw>
-                                              {{ range $refID, $value := .Values }}
-                                            </mj-raw>
-                                            {{ $refID }}={{ $value }}&nbsp; <mj-raw>
-                                              {{ end }}
-                                            </mj-raw>
+                                            <mj-raw>{{ range $refID, $value := .Values }}</mj-raw>
+                                            {{ $refID }}={{ $value }}&nbsp; <mj-raw>{{ end }}</mj-raw>
                                           </div>
                                         </td>
                                       </tr>
@@ -1085,24 +1059,18 @@
                               <tr>
                                 <td align="left" style="font-size:0px;padding:10px 25px;word-break:break-word;">
                                   <table cellpadding="0" cellspacing="0" width="100%" border="0" style="color:white;font-family:Ubuntu, Helvetica, Arial, sans-serif;font-size:13px;line-height:22px;table-layout:auto;width:100%;border:none;">
-                                    <mj-raw>
-                                      {{ range .Labels.SortedPairs }}
-                                    </mj-raw>
+                                    <mj-raw>{{ range .Labels.SortedPairs }}</mj-raw>
                                     <tr>
                                       <td>
                                         <strong>{{ .Name }}</strong>
                                       </td>
-                                      <td>
-                                        {{ .Value }}
-                                      </td>
+                                      <td>{{ .Value }}</td>
                                     </tr>
-                                    <mj-raw>
-                                      {{ end }}
-                                    </mj-raw>
+                                    <mj-raw>{{ end }}</mj-raw>
                                   </table>
                                 </td>
                               </tr>
-                              {{ end }}{{ if .Annotations.SortedPairs }}
+                              {{ end }}{{ if (without .Annotations.SortedPairs.Names "description" "summary") }}
                               <tr>
                                 <td align="left" style="font-size:0px;padding:10px 25px;word-break:break-word;">
                                   <div style="font-family:Ubuntu, Helvetica, Arial, sans-serif;font-size:13px;line-height:1.5;text-align:left;color:#FFFFFF;"><strong>Annotations</strong></div>
@@ -1111,20 +1079,16 @@
                               <tr>
                                 <td align="left" style="font-size:0px;padding:10px 25px;word-break:break-word;">
                                   <table cellpadding="0" cellspacing="0" width="100%" border="0" style="color:white;font-family:Ubuntu, Helvetica, Arial, sans-serif;font-size:13px;line-height:22px;table-layout:auto;width:100%;border:none;">
-                                    <mj-raw>
-                                      {{ range .Annotations.SortedPairs }}
-                                    </mj-raw>
+                                    <mj-raw>{{ range .Annotations.SortedPairs }}</mj-raw>
+                                    <mj-raw>{{ if and (ne .Name "description") (ne .Name "summary") }}</mj-raw>
                                     <tr>
                                       <td>
                                         <strong>{{ .Name }}</strong>
                                       </td>
-                                      <td>
-                                        {{ .Value }}
-                                      </td>
+                                      <td>{{ .Value }}</td>
                                     </tr>
-                                    <mj-raw>
-                                      {{ end }}
-                                    </mj-raw>
+                                    <mj-raw>{{ end }}</mj-raw>
+                                    <mj-raw>{{ end }}</mj-raw>
                                   </table>
                                 </td>
                               </tr>