feat(notification): move logo_url and app_name logic to helpers functions

defelmnq · defelmnq · commit 1b1a4c413d4b · 2024-10-16T14:15:52.000+02:00
diff --git a/cli/server.go b/cli/server.go
@@ -1309,6 +1309,30 @@ func templateHelpers(options *coderd.Options) map[string]any {
 	return map[string]any{
 		"base_url":     func() string { return options.AccessURL.String() },
 		"current_year": func() string { return strconv.Itoa(time.Now().Year()) },
+		"logo_url": func() string {
+			logoURL, err := options.Database.GetLogoURL(context.Background())
+			if err != nil {
+				if errors.Is(err, sql.ErrNoRows) {
+					return notifications.NotificationsDefaultLogoURL
+				}
+
+				return ""
+			}
+
+			return logoURL
+		},
+		"app_name": func() string {
+			appName, err := options.Database.GetApplicationName(context.Background())
+			if err != nil {
+				if errors.Is(err, sql.ErrNoRows) {
+					return notifications.NotificationsDefaultAppName
+				}
+
+				return ""
+			}
+
+			return appName
+		},
 	}
 }
 
diff --git a/coderd/notifications/dispatch/smtp/html.gotmpl b/coderd/notifications/dispatch/smtp/html.gotmpl
@@ -8,7 +8,10 @@
   <body style="margin: 0; padding: 0; font-family: -apple-system, system-ui, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif; color: #020617; background: #f8fafc;">
     <div style="max-width: 600px; margin: 20px auto; padding: 60px; border: 1px solid #e2e8f0; border-radius: 8px; background-color: #fff; text-align: left; font-size: 14px; line-height: 1.5;">
       <div style="text-align: center;">
-        <img src="{{ .Labels._logo_url }}" alt="Company Logo" style="height: 40px;" />
+        <img src="{{ logo_url }}" alt="Company Logo" style="height: 40px;" />
+        <h1 style="text-align: center; font-size: 36px; font-weight: 400; margin: 8px 0 32px; line-height: 1.5;">
+          {{ app_name }}
+        </h1>
       </div>
       <h1 style="text-align: center; font-size: 24px; font-weight: 400; margin: 8px 0 32px; line-height: 1.5;">
         {{ .Labels._subject }}
diff --git a/coderd/notifications/dispatch/smtp_test.go b/coderd/notifications/dispatch/smtp_test.go
@@ -445,6 +445,8 @@ func TestSMTP(t *testing.T) {
 			helpers := map[string]any{
 				"base_url":     func() string { return "http://test.com" },
 				"current_year": func() string { return "2024" },
+				"logo_url":     func() string { return "https://logo.company" },
+				"app_name":     func() string { return "TestCompany" },
 			}
 			handler := dispatch.NewSMTPHandler(tc.cfg, helpers, logger.Named("smtp"))
 
diff --git a/coderd/notifications/notifications_test.go b/coderd/notifications/notifications_test.go
@@ -241,9 +241,8 @@ func TestWebhookDispatch(t *testing.T) {
 
 	// WHEN: a notification is enqueued (including arbitrary labels)
 	input := map[string]string{
-		"a":         "b",
-		"c":         "d",
-		"_logo_url": notifications.NotificationsDefaultLogoURL,
+		"a": "b",
+		"c": "d",
 	}
 	msgID, err := enq.Enqueue(ctx, user.ID, notifications.TemplateWorkspaceDeleted, input, "test")
 	require.NoError(t, err)
diff --git a/coderd/notifications/notifier.go b/coderd/notifications/notifier.go
@@ -2,9 +2,7 @@ package notifications
 
 import (
 	"context"
-	"database/sql"
 	"encoding/json"
-	"errors"
 	"sync"
 	"text/template"
 
@@ -26,6 +24,7 @@ import (
 
 const (
 	NotificationsDefaultLogoURL = "https://coder.com/coder-logo-horizontal.png"
+	NotificationsDefaultAppName = "Coder"
 )
 
 // notifier is a consumer of the notifications_messages queue. It dequeues messages from that table and processes them
@@ -229,18 +228,6 @@ func (n *notifier) prepare(ctx context.Context, msg database.AcquireNotification
 		return nil, xerrors.Errorf("failed to resolve handler %q", msg.Method)
 	}
 
-	logoURL, err := n.store.GetLogoURL(ctx)
-	if err != nil && !errors.Is(err, sql.ErrNoRows) {
-		n.log.Error(ctx, "failed fetching logo url", slog.Error(err))
-	}
-
-	if logoURL == "" {
-		//nolint:ineffassign // define to default value if unable to fetch one from db
-		logoURL = NotificationsDefaultLogoURL
-	}
-
-	payload.Labels["_logo_url"] = logoURL
-
 	var title, body string
 	if title, err = render.GoTemplate(msg.TitleTemplate, payload, n.helpers); err != nil {
 		return nil, xerrors.Errorf("render title: %w", err)
diff --git a/coderd/notifications/utils_test.go b/coderd/notifications/utils_test.go
@@ -39,6 +39,8 @@ func defaultHelpers() map[string]any {
 	return map[string]any{
 		"base_url":     func() string { return "http://test.com" },
 		"current_year": func() string { return "2024" },
+		"logo_url":     func() string { return "https://logo.company" },
+		"app_name":     func() string { return "TestCompany" },
 	}
 }
 

Original file line number	Diff line number	Diff line change
`@@ -445,6 +445,8 @@ func TestSMTP(t *testing.T) {`
`445`	`445`	`helpers := map[string]any{`
`446`	`446`	`"base_url": func() string { return "http://test.com" },`
`447`	`447`	`"current_year": func() string { return "2024" },`
	`448`	`+ "logo_url": func() string { return "https://logo.company" },`
	`449`	`+ "app_name": func() string { return "TestCompany" },`
`448`	`450`	`}`
`449`	`451`	`handler := dispatch.NewSMTPHandler(tc.cfg, helpers, logger.Named("smtp"))`
`450`	`452`
Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,8 @@ func defaultHelpers() map[string]any {`
`39`	`39`	`return map[string]any{`
`40`	`40`	`"base_url": func() string { return "http://test.com" },`
`41`	`41`	`"current_year": func() string { return "2024" },`
	`42`	`+ "logo_url": func() string { return "https://logo.company" },`
	`43`	`+ "app_name": func() string { return "TestCompany" },`
`42`	`44`	`}`
`43`	`45`	`}`
`44`	`46`