Update email templates (#616)

* Basic email redesign * Add BaseURL * Create email-styles.css * Create hermes-logo.png * Update templates * Fix doc-image URL * Replace CSS custom props * Use inline styles * CSS tweaks * Improve email templates * Tweak URLs * Margin and copy tweaks * Update internal/api/documents.go * go fmt --------- Co-authored-by: Josh Freda <[email protected]>
hashicorp-forge · Mar 6, 2024 · 958de13 · 958de13
1 parent 1d7658d
commit 958de13
Show file tree

Hide file tree

Showing 8 changed files with 1,266 additions and 55 deletions.
diff --git a/internal/api/v2/approvals.go b/internal/api/v2/approvals.go
@@ -550,13 +550,17 @@ func ApprovalsHandler(srv server.Server) http.Handler {
 					// Send email.
 					if err := email.SendDocumentApprovedEmail(
 						email.DocumentApprovedEmailData{
+							BaseURL:          srv.Config.BaseURL,
+							DocumentOwner:    doc.Owners[0],
 							DocumentApprover: approver,
 							DocumentNonApproverCount: len(doc.Approvers) -
 								len(doc.ApprovedBy),
 							DocumentShortName: doc.DocNumber,
 							DocumentTitle:     doc.Title,
 							DocumentType:      doc.DocType,
+							DocumentStatus:    doc.Status,
 							DocumentURL:       docURL,
+							Product:           doc.Product,
 						},
 						[]string{doc.Owners[0]},
 						srv.Config.Email.FromAddress,

diff --git a/internal/api/v2/documents.go b/internal/api/v2/documents.go
@@ -749,6 +749,9 @@ func DocumentHandler(srv server.Server) http.Handler {
 									DocumentShortName: doc.DocNumber,
 									DocumentTitle:     doc.Title,
 									DocumentURL:       docURL,
+									Product:           doc.Product,
+									DocumentType:      doc.DocType,
+									DocumentStatus:    doc.Status,
 								},
 								[]string{approverEmail},
 								srv.Config.Email.FromAddress,

diff --git a/internal/api/v2/reviews.go b/internal/api/v2/reviews.go
@@ -542,8 +542,11 @@ func ReviewsHandler(srv server.Server) http.Handler {
 								BaseURL:           srv.Config.BaseURL,
 								DocumentOwner:     doc.Owners[0],
 								DocumentShortName: doc.DocNumber,
+								DocumentType:      doc.DocType,
 								DocumentTitle:     doc.Title,
+								DocumentStatus:    doc.Status,
 								DocumentURL:       docURL,
+								Product:           doc.Product,
 							},
 							[]string{approverEmail},
 							srv.Config.Email.FromAddress,

diff --git a/internal/email/email.go b/internal/email/email.go
@@ -4,6 +4,7 @@ import (
 	"bytes"
 	"embed"
 	"fmt"
+	"strings"
 	"text/template"
 	"time"
 
@@ -20,21 +21,31 @@ type User struct {
 }
 
 type DocumentApprovedEmailData struct {
+	BaseURL                  string
+	CurrentYear              int
 	DocumentApprover         User
+	DocumentOwner            string
 	DocumentNonApproverCount int
 	DocumentShortName        string
 	DocumentTitle            string
+	DocumentStatus           string
+	DocumentStatusClass      string
 	DocumentType             string
 	DocumentURL              string
+	Product                  string
 }
 
 type ReviewRequestedEmailData struct {
-	BaseURL           string
-	CurrentYear       int
-	DocumentOwner     string
-	DocumentShortName string
-	DocumentTitle     string
-	DocumentURL       string
+	BaseURL             string
+	CurrentYear         int
+	DocumentOwner       string
+	DocumentShortName   string
+	DocumentTitle       string
+	DocumentType        string
+	DocumentStatus      string
+	DocumentStatusClass string
+	DocumentURL         string
+	Product             string
 }
 
 type SubscriberDocumentPublishedEmailData struct {
@@ -56,10 +67,14 @@ func SendDocumentApprovedEmail(
 ) error {
 	// Validate data.
 	if err := validation.ValidateStruct(&data,
+		validation.Field(&data.BaseURL, validation.Required),
 		validation.Field(&data.DocumentApprover, validation.Required),
 		validation.Field(&data.DocumentShortName, validation.Required),
 		validation.Field(&data.DocumentTitle, validation.Required),
 		validation.Field(&data.DocumentURL, validation.Required),
+		validation.Field(&data.Product, validation.Required),
+		validation.Field(&data.DocumentType, validation.Required),
+		validation.Field(&data.DocumentStatus, validation.Required),
 	); err != nil {
 		return fmt.Errorf("error validating email data: %w", err)
 	}
@@ -75,6 +90,13 @@ func SendDocumentApprovedEmail(
 	if err != nil {
 		return fmt.Errorf("error parsing template: %w", err)
 	}
+
+	// Set current year.
+	data.CurrentYear = time.Now().Year()
+
+	// Set status class.
+	data.DocumentStatusClass = dasherizeStatus(data.DocumentStatus)
+
 	if err := tmpl.Execute(&body, data); err != nil {
 		return fmt.Errorf("error executing template: %w", err)
 	}
@@ -111,6 +133,9 @@ func SendReviewRequestedEmail(
 		validation.Field(&d.DocumentOwner, validation.Required),
 		validation.Field(&d.DocumentTitle, validation.Required),
 		validation.Field(&d.DocumentURL, validation.Required),
+		validation.Field(&d.Product, validation.Required),
+		validation.Field(&d.DocumentStatus, validation.Required),
+		validation.Field(&d.DocumentType, validation.Required),
 	); err != nil {
 		return fmt.Errorf("error validating email data: %w", err)
 	}
@@ -124,6 +149,9 @@ func SendReviewRequestedEmail(
 	// Set current year.
 	d.CurrentYear = time.Now().Year()
 
+	// Set status class.
+	d.DocumentStatusClass = dasherizeStatus(d.DocumentStatus)
+
 	if err := tmpl.Execute(&body, d); err != nil {
 		return fmt.Errorf("error executing template: %w", err)
 	}
@@ -180,3 +208,7 @@ func SendSubscriberDocumentPublishedEmail(
 	)
 	return err
 }
+
+func dasherizeStatus(status string) string {
+	return strings.ReplaceAll(strings.ToLower(status), " ", "-")
+}