igodwin/notifier
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Enhance notification APIs with HTML email support, CC/BCC, and structured logging

Browse Source 
Add comprehensive improvements across REST and gRPC APIs:
  - Add structured logging for all notification operations
  - Implement HTML email support with multipart/alternative MIME
  - Add CC and BCC recipient support for email notifications
  - Add GetNotifiers endpoint to query available notifier configurations
  - Support configurable From name in SMTP configuration
  - Auto-detect content type (text vs HTML) in notification bodies
  - Improve error handling and validation across all endpoints

  🤖 Generated with [Claude Code](https://claude.com/claude-code)

  Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Ivan Godwin
2025-10-22 23:31:32 -07:00
parent 8229944149
commit 35b6c8aed3
12 changed files with 444 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/rest/handlers.go
+46 -1
View File
@@ -8,17 +8,20 @@ import (
"github.com/gorilla/mux"
"github.com/igodwin/notifier/internal/domain"
"github.com/igodwin/notifier/internal/logging"
)
// Handler handles REST API requests
type Handler struct {
service domain.NotificationService
logger *logging.Logger
}
// NewHandler creates a new REST handler
func NewHandler(service domain.NotificationService) *Handler {
func NewHandler(service domain.NotificationService, logger *logging.Logger) *Handler {
return &Handler{
service: service,
logger: logger,
}
}
@@ -26,12 +29,14 @@ func NewHandler(service domain.NotificationService) *Handler {
func (h *Handler) SendNotification(w http.ResponseWriter, r *http.Request) {
var req SendNotificationRequest
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
h.logger.Errorf("REST: Failed to decode request body - error=%v", err)
respondError(w, http.StatusBadRequest, "invalid request body", err)
return
}
// Validate request
if err := req.Validate(); err != nil {
h.logger.Errorf("REST: Request validation failed - error=%v", err)
respondError(w, http.StatusBadRequest, "validation failed", err)
return
}
@@ -39,13 +44,23 @@ func (h *Handler) SendNotification(w http.ResponseWriter, r *http.Request) {
// Convert to domain notification
notification := req.ToNotification()
// Log incoming request
h.logger.Infof("REST: Received notification request - type=%s, account=%s, recipients=%d, subject=%s",
notification.Type, notification.Account, len(notification.Recipients), notification.Subject)
// Send notification
result, err := h.service.Send(r.Context(), notification)
if err != nil {
h.logger.Errorf("REST: Failed to send notification - type=%s, account=%s, error=%v",
notification.Type, notification.Account, err)
respondError(w, http.StatusInternalServerError, "failed to send notification", err)
return
}
// Log success
h.logger.Infof("REST: Notification queued successfully - id=%s, type=%s, recipients=%d",
result.NotificationID, notification.Type, len(notification.Recipients))
respondJSON(w, http.StatusAccepted, SendNotificationResponse{
Result: NotificationResultFromDomain(result),
})
@@ -55,14 +70,18 @@ func (h *Handler) SendNotification(w http.ResponseWriter, r *http.Request) {
func (h *Handler) SendBatchNotifications(w http.ResponseWriter, r *http.Request) {
var req SendBatchNotificationsRequest
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
h.logger.Errorf("REST: Failed to decode batch request body - error=%v", err)
respondError(w, http.StatusBadRequest, "invalid request body", err)
return
}
h.logger.Infof("REST: Received batch notification request - count=%d", len(req.Notifications))
// Validate and convert to domain notifications
notifications := make([]*domain.Notification, 0, len(req.Notifications))
for _, notifReq := range req.Notifications {
if err := notifReq.Validate(); err != nil {
h.logger.Errorf("REST: Batch request validation failed - error=%v", err)
respondError(w, http.StatusBadRequest, "validation failed", err)
return
}
@@ -72,10 +91,22 @@ func (h *Handler) SendBatchNotifications(w http.ResponseWriter, r *http.Request)
// Send batch
results, err := h.service.SendBatch(r.Context(), notifications)
if err != nil {
h.logger.Errorf("REST: Failed to send batch notifications - error=%v", err)
respondError(w, http.StatusInternalServerError, "failed to send batch notifications", err)
return
}
// Count successes
successCount := 0
for _, result := range results {
if result.Success {
successCount++
}
}
h.logger.Infof("REST: Batch notification completed - total=%d, successful=%d, failed=%d",
len(notifications), successCount, len(notifications)-successCount)
// Convert results
apiResults := make([]NotificationResult, 0, len(results))
for _, result := range results {
@@ -166,6 +197,20 @@ func (h *Handler) GetStats(w http.ResponseWriter, r *http.Request) {
respondJSON(w, http.StatusOK, stats)
}
// GetNotifiers handles GET /api/v1/notifiers
func (h *Handler) GetNotifiers(w http.ResponseWriter, r *http.Request) {
h.logger.Infof("REST: Received request for available notifiers")
notifiers, err := h.service.GetNotifiers(r.Context())
if err != nil {
h.logger.Errorf("REST: Failed to get notifiers - error=%v", err)
respondError(w, http.StatusInternalServerError, "failed to get notifiers", err)
return
}
respondJSON(w, http.StatusOK, notifiers)
}
// HealthCheck handles GET /health
func (h *Handler) HealthCheck(w http.ResponseWriter, r *http.Request) {
respondJSON(w, http.StatusOK, map[string]interface{}{
api/rest/router.go
+6 -2
View File
@@ -5,11 +5,12 @@ import (
"github.com/gorilla/mux"
"github.com/igodwin/notifier/internal/domain"
"github.com/igodwin/notifier/internal/logging"
)
// NewRouter creates a new HTTP router with all routes configured
func NewRouter(service domain.NotificationService) *mux.Router {
handler := NewHandler(service)
func NewRouter(service domain.NotificationService, logger *logging.Logger) *mux.Router {
handler := NewHandler(service, logger)
router := mux.NewRouter()
// API v1 routes
@@ -26,6 +27,9 @@ func NewRouter(service domain.NotificationService) *mux.Router {
// Stats route
v1.HandleFunc("/stats", handler.GetStats).Methods(http.MethodGet)
// Notifiers route
v1.HandleFunc("/notifiers", handler.GetNotifiers).Methods(http.MethodGet)
// Health check route
router.HandleFunc("/health", handler.HealthCheck).Methods(http.MethodGet)
api/rest/types.go
+23 -2
View File
@@ -15,7 +15,10 @@ type SendNotificationRequest struct {
Priority int `json:"priority,omitempty"`
Subject string `json:"subject"`
Body string `json:"body"`
ContentType string `json:"content_type,omitempty"` // "text" or "html" - auto-detected if not specified
Recipients []string `json:"recipients"`
CC []string `json:"cc,omitempty"` // Carbon copy recipients (email only)
BCC []string `json:"bcc,omitempty"` // Blind carbon copy recipients (email only)
Metadata map[string]interface{} `json:"metadata,omitempty"`
ScheduledFor *time.Time `json:"scheduled_for,omitempty"`
MaxRetries int `json:"max_retries,omitempty"`
@@ -27,8 +30,11 @@ func (r *SendNotificationRequest) Validate() error {
return fmt.Errorf("type is required")
}
if len(r.Recipients) == 0 {
return fmt.Errorf("at least one recipient is required")
// For email, allow BCC-only (at least one recipient in To, CC, or BCC)
// For other types, require Recipients
totalRecipients := len(r.Recipients) + len(r.CC) + len(r.BCC)
if totalRecipients == 0 {
return fmt.Errorf("at least one recipient is required (recipients, cc, or bcc)")
}
if r.Body == "" {
@@ -45,6 +51,12 @@ func (r *SendNotificationRequest) ToNotification() *domain.Notification {
maxRetries = 3 // Default
}
// Convert content type, defaulting to text
contentType := domain.ContentType(r.ContentType)
if contentType == "" {
contentType = domain.ContentTypeText
}
return &domain.Notification{
ID: uuid.New().String(),
Type: domain.NotificationType(r.Type),
@@ -53,7 +65,10 @@ func (r *SendNotificationRequest) ToNotification() *domain.Notification {
Status: domain.StatusPending,
Subject: r.Subject,
Body: r.Body,
ContentType: contentType,
Recipients: r.Recipients,
CC: r.CC,
BCC: r.BCC,
Metadata: r.Metadata,
CreatedAt: time.Now(),
ScheduledFor: r.ScheduledFor,
@@ -86,7 +101,10 @@ type Notification struct {
Status string `json:"status"`
Subject string `json:"subject"`
Body string `json:"body"`
ContentType string `json:"content_type,omitempty"`
Recipients []string `json:"recipients"`
CC []string `json:"cc,omitempty"`
BCC []string `json:"bcc,omitempty"`
Metadata map[string]interface{} `json:"metadata,omitempty"`
CreatedAt time.Time `json:"created_at"`
ScheduledFor *time.Time `json:"scheduled_for,omitempty"`
@@ -106,7 +124,10 @@ func NotificationFromDomain(n *domain.Notification) Notification {
Status: string(n.Status),
Subject: n.Subject,
Body: n.Body,
ContentType: string(n.ContentType),
Recipients: n.Recipients,
CC: n.CC,
BCC: n.BCC,
Metadata: n.Metadata,
CreatedAt: n.CreatedAt,
ScheduledFor: n.ScheduledFor,