feat(api): highlight webhook email payload

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 48f6d946-ae22-4440-b7a1-44e939419b11

Author: AchoArnold

api/pkg/emails/hermes_notification_email_factory.go

@@ -2,6 +2,7 @@ package emails
 
 import (
 	"fmt"
+	"strings"
 	"time"
 
 	"github.com/NdoleStudio/httpsms/pkg/events"
@@ -76,6 +77,8 @@ func (factory *hermesNotificationEmailFactory) DiscordSendFailed(user *entities.
 }
 
 func (factory *hermesNotificationEmailFactory) WebhookSendFailed(user *entities.User, payload *events.WebhookSendFailedPayload) (*Email, error) {
+	formattedPayload, formattedPayloadHTML := formatEventPayload(payload.EventPayload)
+
 	email := hermes.Email{
 		Body: hermes.Body{
 			Title: "Hello",
@@ -89,7 +92,11 @@ func (factory *hermesNotificationEmailFactory) WebhookSendFailed(user *entities.
 				{Key: "Phone Number", Value: factory.formatPhoneNumber(payload.Owner)},
 				{Key: "HTTP Response Code", Value: factory.formatHTTPResponseCode(payload.HTTPResponseStatusCode)},
 				{Key: "Error Message / HTTP Response", Value: payload.ErrorMessage},
-				{Key: "Event Payload", Value: payload.EventPayload},
+				{
+					Key:         "Event Payload",
+					Value:       formattedPayload,
+					UnsafeValue: formattedPayloadHTML,
+				},
 			},
 			Actions: []hermes.Action{
 				{
@@ -118,6 +125,7 @@ func (factory *hermesNotificationEmailFactory) WebhookSendFailed(user *entities.
 	if err != nil {
 		return nil, stacktrace.Propagate(err, "cannot generate text email")
 	}
+	text = formatWebhookSendFailedTextPayload(text, formattedPayload)
 
 	return &Email{
 		ToEmail: user.Email,
@@ -127,6 +135,26 @@ func (factory *hermesNotificationEmailFactory) WebhookSendFailed(user *entities.
 	}, nil
 }
 
+func formatWebhookSendFailedTextPayload(text string, formattedPayload string) string {
+	const (
+		eventPayloadPrefix = "* Event Payload: "
+		nextSectionPrefix  = "\n\nUsually this error happens"
+	)
+
+	start := strings.Index(text, eventPayloadPrefix)
+	if start == -1 {
+		return text
+	}
+
+	end := strings.Index(text[start:], nextSectionPrefix)
+	if end == -1 {
+		return text
+	}
+
+	end += start
+	return text[:start] + eventPayloadPrefix + formattedPayload + text[end:]
+}
+
 func (factory *hermesNotificationEmailFactory) MessageExpired(user *entities.User, payload *events.MessageSendExpiredPayload) (*Email, error) {
 	email := hermes.Email{
 		Body: hermes.Body{

api/pkg/emails/hermes_notification_email_factory_test.go

@@ -0,0 +1,76 @@
+package emails
+
+import (
+	"strings"
+	"testing"
+
+	"github.com/NdoleStudio/httpsms/pkg/entities"
+	"github.com/NdoleStudio/httpsms/pkg/events"
+	"github.com/google/uuid"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func testNotificationEmailFactory() NotificationEmailFactory {
+	return NewHermesNotificationEmailFactory(&HermesGeneratorConfig{
+		AppURL:     "https://httpsms.com",
+		AppName:    "httpSMS",
+		AppLogoURL: "https://httpsms.com/logo.png",
+	})
+}
+
+func TestWebhookSendFailedFormatsOnlyEventPayload(t *testing.T) {
+	statusCode := 500
+	factory := testNotificationEmailFactory()
+	user := &entities.User{
+		Email:    "name@email.com",
+		Timezone: "UTC",
+	}
+	payload := &events.WebhookSendFailedPayload{
+		WebhookID:              uuid.New(),
+		WebhookURL:             "https://example.com/webhooks",
+		Owner:                  "+237612345678",
+		EventID:                "event-id",
+		EventType:              "message.phone.received",
+		EventPayload:           `{"message":"hello","retry":false}`,
+		HTTPResponseStatusCode: &statusCode,
+		ErrorMessage:           "plain failure response",
+	}
+
+	email, err := factory.WebhookSendFailed(user, payload)
+	require.NoError(t, err)
+
+	assert.Equal(t, "name@email.com", email.ToEmail)
+	assert.Equal(t, "📢 We could not forward a webhook event to your server", email.Subject)
+	assert.Contains(t, email.HTML, `<pre style=`)
+	assert.Equal(t, 1, strings.Count(email.HTML, `<pre style=`))
+	assert.Contains(t, email.HTML, `&#34;message&#34;`)
+	assert.Contains(t, email.HTML, `plain failure response`)
+	assert.Contains(t, email.Text, `"message": "hello"`)
+	assert.Contains(t, email.Text, `"retry": false`)
+	assert.NotContains(t, email.Text, "<pre")
+}
+
+func TestWebhookSendFailedPreservesNonJSONEventPayload(t *testing.T) {
+	factory := testNotificationEmailFactory()
+	user := &entities.User{
+		Email:    "name@email.com",
+		Timezone: "UTC",
+	}
+	payload := &events.WebhookSendFailedPayload{
+		WebhookID:    uuid.New(),
+		WebhookURL:   "https://example.com/webhooks",
+		Owner:        "+237612345678",
+		EventID:      "event-id",
+		EventType:    "message.phone.received",
+		EventPayload: "line one\n  line two",
+		ErrorMessage: "plain failure response",
+	}
+
+	email, err := factory.WebhookSendFailed(user, payload)
+	require.NoError(t, err)
+
+	assert.Contains(t, email.HTML, "line one\n  line two")
+	assert.NotContains(t, email.HTML, `<span style="color:`)
+	assert.Contains(t, email.Text, "line one\n  line two")
+}