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

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:
2025-10-22 23:31:32 -07:00
parent 8229944149
commit 35b6c8aed3
12 changed files with 444 additions and 39 deletions
+107 -9
View File
@@ -4,8 +4,10 @@ import (
"context" "context"
"fmt" "fmt"
"github.com/google/uuid"
pb "github.com/igodwin/notifier/api/grpc/pb" pb "github.com/igodwin/notifier/api/grpc/pb"
"github.com/igodwin/notifier/internal/domain" "github.com/igodwin/notifier/internal/domain"
"github.com/igodwin/notifier/internal/logging"
"google.golang.org/protobuf/types/known/timestamppb" "google.golang.org/protobuf/types/known/timestamppb"
) )
@@ -13,12 +15,14 @@ import (
type NotifierHandler struct { type NotifierHandler struct {
pb.UnimplementedNotifierServiceServer pb.UnimplementedNotifierServiceServer
service domain.NotificationService service domain.NotificationService
logger *logging.Logger
} }
// NewNotifierHandler creates a new gRPC handler // NewNotifierHandler creates a new gRPC handler
func NewNotifierHandler(svc domain.NotificationService) *NotifierHandler { func NewNotifierHandler(svc domain.NotificationService, logger *logging.Logger) *NotifierHandler {
return &NotifierHandler{ return &NotifierHandler{
service: svc, service: svc,
logger: logger,
} }
} }
@@ -36,19 +40,36 @@ func (h *NotifierHandler) HealthCheck(ctx context.Context, req *pb.HealthCheckRe
// SendNotification sends a single notification // SendNotification sends a single notification
func (h *NotifierHandler) SendNotification(ctx context.Context, req *pb.SendNotificationRequest) (*pb.SendNotificationResponse, error) { func (h *NotifierHandler) SendNotification(ctx context.Context, req *pb.SendNotificationRequest) (*pb.SendNotificationResponse, error) {
// Log incoming request
h.logger.Infof("gRPC: Received notification request - type=%s, account=%s, recipients=%d, subject=%s",
req.Type, req.Account, len(req.Recipients), req.Subject)
// Convert proto notification type to domain type // Convert proto notification type to domain type
notifType := convertProtoTypeToDomain(req.Type) notifType := convertProtoTypeToDomain(req.Type)
// Set default max retries if not specified
maxRetries := int(req.MaxRetries)
if maxRetries == 0 {
maxRetries = 3 // Default
}
// Convert content type, defaulting to text
contentType := convertProtoContentTypeToDomain(req.ContentType)
// Build notification // Build notification
notification := &domain.Notification{ notification := &domain.Notification{
Type: notifType, ID: uuid.New().String(),
Account: req.Account, Type: notifType,
Priority: domain.Priority(req.Priority), Account: req.Account,
Subject: req.Subject, Priority: domain.Priority(req.Priority),
Body: req.Body, Subject: req.Subject,
Recipients: req.Recipients, Body: req.Body,
Metadata: convertStringMapToInterface(req.Metadata), ContentType: contentType,
MaxRetries: int(req.MaxRetries), Recipients: req.Recipients,
CC: req.Cc,
BCC: req.Bcc,
Metadata: convertStringMapToInterface(req.Metadata),
MaxRetries: maxRetries,
} }
if req.ScheduledFor != nil { if req.ScheduledFor != nil {
@@ -59,6 +80,8 @@ func (h *NotifierHandler) SendNotification(ctx context.Context, req *pb.SendNoti
// Send notification // Send notification
result, err := h.service.Send(ctx, notification) result, err := h.service.Send(ctx, notification)
if err != nil { if err != nil {
h.logger.Errorf("gRPC: Failed to send notification - type=%s, account=%s, error=%v",
req.Type, req.Account, err)
return &pb.SendNotificationResponse{ return &pb.SendNotificationResponse{
Result: &pb.NotificationResult{ Result: &pb.NotificationResult{
Success: false, Success: false,
@@ -67,6 +90,10 @@ func (h *NotifierHandler) SendNotification(ctx context.Context, req *pb.SendNoti
}, nil }, nil
} }
// Log success
h.logger.Infof("gRPC: Notification queued successfully - id=%s, type=%s, recipients=%d",
result.NotificationID, req.Type, len(req.Recipients))
// Convert result to proto // Convert result to proto
return &pb.SendNotificationResponse{ return &pb.SendNotificationResponse{
Result: &pb.NotificationResult{ Result: &pb.NotificationResult{
@@ -80,7 +107,10 @@ func (h *NotifierHandler) SendNotification(ctx context.Context, req *pb.SendNoti
// SendBatchNotifications sends multiple notifications // SendBatchNotifications sends multiple notifications
func (h *NotifierHandler) SendBatchNotifications(ctx context.Context, req *pb.SendBatchNotificationsRequest) (*pb.SendBatchNotificationsResponse, error) { func (h *NotifierHandler) SendBatchNotifications(ctx context.Context, req *pb.SendBatchNotificationsRequest) (*pb.SendBatchNotificationsResponse, error) {
h.logger.Infof("gRPC: Received batch notification request - count=%d", len(req.Notifications))
var results []*pb.NotificationResult var results []*pb.NotificationResult
successCount := 0
for _, notifReq := range req.Notifications { for _, notifReq := range req.Notifications {
resp, err := h.SendNotification(ctx, notifReq) resp, err := h.SendNotification(ctx, notifReq)
@@ -91,9 +121,15 @@ func (h *NotifierHandler) SendBatchNotifications(ctx context.Context, req *pb.Se
}) })
} else { } else {
results = append(results, resp.Result) results = append(results, resp.Result)
if resp.Result.Success {
successCount++
}
} }
} }
h.logger.Infof("gRPC: Batch notification completed - total=%d, successful=%d, failed=%d",
len(req.Notifications), successCount, len(req.Notifications)-successCount)
return &pb.SendBatchNotificationsResponse{ return &pb.SendBatchNotificationsResponse{
Results: results, Results: results,
}, nil }, nil
@@ -187,6 +223,31 @@ func (h *NotifierHandler) GetStats(ctx context.Context, req *pb.GetStatsRequest)
}, nil }, nil
} }
// GetNotifiers returns information about available notifiers
func (h *NotifierHandler) GetNotifiers(ctx context.Context, req *pb.GetNotifiersRequest) (*pb.GetNotifiersResponse, error) {
h.logger.Infof("gRPC: Received request for available notifiers")
notifiers, err := h.service.GetNotifiers(ctx)
if err != nil {
h.logger.Errorf("gRPC: Failed to get notifiers - error=%v", err)
return nil, err
}
// Convert domain notifiers to proto notifiers
protoNotifiers := make([]*pb.NotifierInfo, 0, len(notifiers.Notifiers))
for _, notifier := range notifiers.Notifiers {
protoNotifiers = append(protoNotifiers, &pb.NotifierInfo{
Type: convertDomainTypeToProto(notifier.Type),
Accounts: notifier.Accounts,
DefaultAccount: notifier.DefaultAccount,
})
}
return &pb.GetNotifiersResponse{
Notifiers: protoNotifiers,
}, nil
}
// Helper functions to convert between proto and domain types // Helper functions to convert between proto and domain types
// convertStringMapToInterface converts proto's map[string]string to domain's map[string]interface{} // convertStringMapToInterface converts proto's map[string]string to domain's map[string]interface{}
@@ -230,6 +291,43 @@ func convertProtoTypeToDomain(protoType pb.NotificationType) domain.Notification
} }
} }
func convertDomainTypeToProto(domainType domain.NotificationType) pb.NotificationType {
switch domainType {
case domain.TypeEmail:
return pb.NotificationType_NOTIFICATION_TYPE_EMAIL
case domain.TypeSlack:
return pb.NotificationType_NOTIFICATION_TYPE_SLACK
case domain.TypeNtfy:
return pb.NotificationType_NOTIFICATION_TYPE_NTFY
case domain.TypeStdout:
return pb.NotificationType_NOTIFICATION_TYPE_STDOUT
default:
return pb.NotificationType_NOTIFICATION_TYPE_UNSPECIFIED
}
}
func convertProtoContentTypeToDomain(protoType pb.ContentType) domain.ContentType {
switch protoType {
case pb.ContentType_CONTENT_TYPE_HTML:
return domain.ContentTypeHTML
case pb.ContentType_CONTENT_TYPE_TEXT:
return domain.ContentTypeText
default:
return domain.ContentTypeText // Default to text
}
}
func convertDomainContentTypeToProto(domainType domain.ContentType) pb.ContentType {
switch domainType {
case domain.ContentTypeHTML:
return pb.ContentType_CONTENT_TYPE_HTML
case domain.ContentTypeText:
return pb.ContentType_CONTENT_TYPE_TEXT
default:
return pb.ContentType_CONTENT_TYPE_TEXT
}
}
func convertDomainToProtoType(domainType domain.NotificationType) pb.NotificationType { func convertDomainToProtoType(domainType domain.NotificationType) pb.NotificationType {
switch domainType { switch domainType {
case domain.TypeEmail: case domain.TypeEmail:
+31
View File
@@ -29,6 +29,9 @@ service NotifierService {
// GetStats returns notification statistics // GetStats returns notification statistics
rpc GetStats(GetStatsRequest) returns (GetStatsResponse); rpc GetStats(GetStatsRequest) returns (GetStatsResponse);
// GetNotifiers returns information about available notifiers
rpc GetNotifiers(GetNotifiersRequest) returns (GetNotifiersResponse);
// HealthCheck verifies the service is operational // HealthCheck verifies the service is operational
rpc HealthCheck(HealthCheckRequest) returns (HealthCheckResponse); rpc HealthCheck(HealthCheckRequest) returns (HealthCheckResponse);
} }
@@ -51,6 +54,13 @@ enum Priority {
PRIORITY_CRITICAL = 4; PRIORITY_CRITICAL = 4;
} }
// ContentType defines the format of the notification body
enum ContentType {
CONTENT_TYPE_UNSPECIFIED = 0;
CONTENT_TYPE_TEXT = 1;
CONTENT_TYPE_HTML = 2;
}
// NotificationStatus represents the state of a notification // NotificationStatus represents the state of a notification
enum NotificationStatus { enum NotificationStatus {
NOTIFICATION_STATUS_UNSPECIFIED = 0; NOTIFICATION_STATUS_UNSPECIFIED = 0;
@@ -71,7 +81,10 @@ message Notification {
NotificationStatus status = 5; NotificationStatus status = 5;
string subject = 6; string subject = 6;
string body = 7; string body = 7;
ContentType content_type = 18; // Format of the body (text or html)
repeated string recipients = 8; repeated string recipients = 8;
repeated string cc = 16; // Carbon copy recipients (email only)
repeated string bcc = 17; // Blind carbon copy recipients (email only)
map<string, string> metadata = 9; map<string, string> metadata = 9;
google.protobuf.Timestamp created_at = 10; google.protobuf.Timestamp created_at = 10;
google.protobuf.Timestamp scheduled_for = 11; google.protobuf.Timestamp scheduled_for = 11;
@@ -98,7 +111,10 @@ message SendNotificationRequest {
Priority priority = 3; Priority priority = 3;
string subject = 4; string subject = 4;
string body = 5; string body = 5;
ContentType content_type = 12; // Format of the body (text or html) - auto-detected if not specified
repeated string recipients = 6; repeated string recipients = 6;
repeated string cc = 10; // Carbon copy recipients (email only)
repeated string bcc = 11; // Blind carbon copy recipients (email only)
map<string, string> metadata = 7; map<string, string> metadata = 7;
google.protobuf.Timestamp scheduled_for = 8; google.protobuf.Timestamp scheduled_for = 8;
int32 max_retries = 9; int32 max_retries = 9;
@@ -187,6 +203,21 @@ message GetStatsResponse {
double average_latency_ms = 7; double average_latency_ms = 7;
} }
// GetNotifiersRequest requests available notifiers
message GetNotifiersRequest {}
// NotifierInfo contains information about a configured notifier type
message NotifierInfo {
NotificationType type = 1;
repeated string accounts = 2;
string default_account = 3;
}
// GetNotifiersResponse returns available notifiers
message GetNotifiersResponse {
repeated NotifierInfo notifiers = 1;
}
// HealthCheckRequest requests health status // HealthCheckRequest requests health status
message HealthCheckRequest {} message HealthCheckRequest {}
+46 -1
View File
@@ -8,17 +8,20 @@ import (
"github.com/gorilla/mux" "github.com/gorilla/mux"
"github.com/igodwin/notifier/internal/domain" "github.com/igodwin/notifier/internal/domain"
"github.com/igodwin/notifier/internal/logging"
) )
// Handler handles REST API requests // Handler handles REST API requests
type Handler struct { type Handler struct {
service domain.NotificationService service domain.NotificationService
logger *logging.Logger
} }
// NewHandler creates a new REST handler // NewHandler creates a new REST handler
func NewHandler(service domain.NotificationService) *Handler { func NewHandler(service domain.NotificationService, logger *logging.Logger) *Handler {
return &Handler{ return &Handler{
service: service, service: service,
logger: logger,
} }
} }
@@ -26,12 +29,14 @@ func NewHandler(service domain.NotificationService) *Handler {
func (h *Handler) SendNotification(w http.ResponseWriter, r *http.Request) { func (h *Handler) SendNotification(w http.ResponseWriter, r *http.Request) {
var req SendNotificationRequest var req SendNotificationRequest
if err := json.NewDecoder(r.Body).Decode(&req); err != nil { 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) respondError(w, http.StatusBadRequest, "invalid request body", err)
return return
} }
// Validate request // Validate request
if err := req.Validate(); err != nil { if err := req.Validate(); err != nil {
h.logger.Errorf("REST: Request validation failed - error=%v", err)
respondError(w, http.StatusBadRequest, "validation failed", err) respondError(w, http.StatusBadRequest, "validation failed", err)
return return
} }
@@ -39,13 +44,23 @@ func (h *Handler) SendNotification(w http.ResponseWriter, r *http.Request) {
// Convert to domain notification // Convert to domain notification
notification := req.ToNotification() 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 // Send notification
result, err := h.service.Send(r.Context(), notification) result, err := h.service.Send(r.Context(), notification)
if err != nil { 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) respondError(w, http.StatusInternalServerError, "failed to send notification", err)
return 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{ respondJSON(w, http.StatusAccepted, SendNotificationResponse{
Result: NotificationResultFromDomain(result), 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) { func (h *Handler) SendBatchNotifications(w http.ResponseWriter, r *http.Request) {
var req SendBatchNotificationsRequest var req SendBatchNotificationsRequest
if err := json.NewDecoder(r.Body).Decode(&req); err != nil { 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) respondError(w, http.StatusBadRequest, "invalid request body", err)
return return
} }
h.logger.Infof("REST: Received batch notification request - count=%d", len(req.Notifications))
// Validate and convert to domain notifications // Validate and convert to domain notifications
notifications := make([]*domain.Notification, 0, len(req.Notifications)) notifications := make([]*domain.Notification, 0, len(req.Notifications))
for _, notifReq := range req.Notifications { for _, notifReq := range req.Notifications {
if err := notifReq.Validate(); err != nil { if err := notifReq.Validate(); err != nil {
h.logger.Errorf("REST: Batch request validation failed - error=%v", err)
respondError(w, http.StatusBadRequest, "validation failed", err) respondError(w, http.StatusBadRequest, "validation failed", err)
return return
} }
@@ -72,10 +91,22 @@ func (h *Handler) SendBatchNotifications(w http.ResponseWriter, r *http.Request)
// Send batch // Send batch
results, err := h.service.SendBatch(r.Context(), notifications) results, err := h.service.SendBatch(r.Context(), notifications)
if err != nil { 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) respondError(w, http.StatusInternalServerError, "failed to send batch notifications", err)
return 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 // Convert results
apiResults := make([]NotificationResult, 0, len(results)) apiResults := make([]NotificationResult, 0, len(results))
for _, result := range results { for _, result := range results {
@@ -166,6 +197,20 @@ func (h *Handler) GetStats(w http.ResponseWriter, r *http.Request) {
respondJSON(w, http.StatusOK, stats) 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 // HealthCheck handles GET /health
func (h *Handler) HealthCheck(w http.ResponseWriter, r *http.Request) { func (h *Handler) HealthCheck(w http.ResponseWriter, r *http.Request) {
respondJSON(w, http.StatusOK, map[string]interface{}{ respondJSON(w, http.StatusOK, map[string]interface{}{
+6 -2
View File
@@ -5,11 +5,12 @@ import (
"github.com/gorilla/mux" "github.com/gorilla/mux"
"github.com/igodwin/notifier/internal/domain" "github.com/igodwin/notifier/internal/domain"
"github.com/igodwin/notifier/internal/logging"
) )
// NewRouter creates a new HTTP router with all routes configured // NewRouter creates a new HTTP router with all routes configured
func NewRouter(service domain.NotificationService) *mux.Router { func NewRouter(service domain.NotificationService, logger *logging.Logger) *mux.Router {
handler := NewHandler(service) handler := NewHandler(service, logger)
router := mux.NewRouter() router := mux.NewRouter()
// API v1 routes // API v1 routes
@@ -26,6 +27,9 @@ func NewRouter(service domain.NotificationService) *mux.Router {
// Stats route // Stats route
v1.HandleFunc("/stats", handler.GetStats).Methods(http.MethodGet) v1.HandleFunc("/stats", handler.GetStats).Methods(http.MethodGet)
// Notifiers route
v1.HandleFunc("/notifiers", handler.GetNotifiers).Methods(http.MethodGet)
// Health check route // Health check route
router.HandleFunc("/health", handler.HealthCheck).Methods(http.MethodGet) router.HandleFunc("/health", handler.HealthCheck).Methods(http.MethodGet)
+23 -2
View File
@@ -15,7 +15,10 @@ type SendNotificationRequest struct {
Priority int `json:"priority,omitempty"` Priority int `json:"priority,omitempty"`
Subject string `json:"subject"` Subject string `json:"subject"`
Body string `json:"body"` Body string `json:"body"`
ContentType string `json:"content_type,omitempty"` // "text" or "html" - auto-detected if not specified
Recipients []string `json:"recipients"` 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"` Metadata map[string]interface{} `json:"metadata,omitempty"`
ScheduledFor *time.Time `json:"scheduled_for,omitempty"` ScheduledFor *time.Time `json:"scheduled_for,omitempty"`
MaxRetries int `json:"max_retries,omitempty"` MaxRetries int `json:"max_retries,omitempty"`
@@ -27,8 +30,11 @@ func (r *SendNotificationRequest) Validate() error {
return fmt.Errorf("type is required") return fmt.Errorf("type is required")
} }
if len(r.Recipients) == 0 { // For email, allow BCC-only (at least one recipient in To, CC, or BCC)
return fmt.Errorf("at least one recipient is required") // 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 == "" { if r.Body == "" {
@@ -45,6 +51,12 @@ func (r *SendNotificationRequest) ToNotification() *domain.Notification {
maxRetries = 3 // Default maxRetries = 3 // Default
} }
// Convert content type, defaulting to text
contentType := domain.ContentType(r.ContentType)
if contentType == "" {
contentType = domain.ContentTypeText
}
return &domain.Notification{ return &domain.Notification{
ID: uuid.New().String(), ID: uuid.New().String(),
Type: domain.NotificationType(r.Type), Type: domain.NotificationType(r.Type),
@@ -53,7 +65,10 @@ func (r *SendNotificationRequest) ToNotification() *domain.Notification {
Status: domain.StatusPending, Status: domain.StatusPending,
Subject: r.Subject, Subject: r.Subject,
Body: r.Body, Body: r.Body,
ContentType: contentType,
Recipients: r.Recipients, Recipients: r.Recipients,
CC: r.CC,
BCC: r.BCC,
Metadata: r.Metadata, Metadata: r.Metadata,
CreatedAt: time.Now(), CreatedAt: time.Now(),
ScheduledFor: r.ScheduledFor, ScheduledFor: r.ScheduledFor,
@@ -86,7 +101,10 @@ type Notification struct {
Status string `json:"status"` Status string `json:"status"`
Subject string `json:"subject"` Subject string `json:"subject"`
Body string `json:"body"` Body string `json:"body"`
ContentType string `json:"content_type,omitempty"`
Recipients []string `json:"recipients"` Recipients []string `json:"recipients"`
CC []string `json:"cc,omitempty"`
BCC []string `json:"bcc,omitempty"`
Metadata map[string]interface{} `json:"metadata,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"`
CreatedAt time.Time `json:"created_at"` CreatedAt time.Time `json:"created_at"`
ScheduledFor *time.Time `json:"scheduled_for,omitempty"` ScheduledFor *time.Time `json:"scheduled_for,omitempty"`
@@ -106,7 +124,10 @@ func NotificationFromDomain(n *domain.Notification) Notification {
Status: string(n.Status), Status: string(n.Status),
Subject: n.Subject, Subject: n.Subject,
Body: n.Body, Body: n.Body,
ContentType: string(n.ContentType),
Recipients: n.Recipients, Recipients: n.Recipients,
CC: n.CC,
BCC: n.BCC,
Metadata: n.Metadata, Metadata: n.Metadata,
CreatedAt: n.CreatedAt, CreatedAt: n.CreatedAt,
ScheduledFor: n.ScheduledFor, ScheduledFor: n.ScheduledFor,
+3 -3
View File
@@ -97,7 +97,7 @@ func main() {
logger.Infof("Supported notification types: %v", factory.SupportedTypes()) logger.Infof("Supported notification types: %v", factory.SupportedTypes())
// Create notification service (pass config as account resolver) // Create notification service (pass config as account resolver)
svc := service.NewNotificationService(factory, q, cfg.Queue.WorkerCount, cfg) svc := service.NewNotificationService(factory, q, cfg.Queue.WorkerCount, cfg, logger)
// Start workers // Start workers
if err := svc.Start(ctx); err != nil { if err := svc.Start(ctx); err != nil {
@@ -228,7 +228,7 @@ func startGRPCServer(ctx context.Context, wg *sync.WaitGroup, cfg *config.Config
grpcServer := grpc.NewServer() grpcServer := grpc.NewServer()
// Create and register gRPC handler // Create and register gRPC handler
grpcHandler := grpcapi.NewNotifierHandler(svc) grpcHandler := grpcapi.NewNotifierHandler(svc, logger)
pb.RegisterNotifierServiceServer(grpcServer, grpcHandler) pb.RegisterNotifierServiceServer(grpcServer, grpcHandler)
// Enable reflection for tools like grpcurl // Enable reflection for tools like grpcurl
@@ -248,7 +248,7 @@ func startGRPCServer(ctx context.Context, wg *sync.WaitGroup, cfg *config.Config
} }
func startRESTServer(ctx context.Context, wg *sync.WaitGroup, cfg *config.Config, svc domain.NotificationService, logger *logging.Logger) *http.Server { func startRESTServer(ctx context.Context, wg *sync.WaitGroup, cfg *config.Config, svc domain.NotificationService, logger *logging.Logger) *http.Server {
router := rest.NewRouter(svc) router := rest.NewRouter(svc, logger)
addr := fmt.Sprintf("%s:%d", cfg.Server.Host, cfg.Server.RESTPort) addr := fmt.Sprintf("%s:%d", cfg.Server.Host, cfg.Server.RESTPort)
server := &http.Server{ server := &http.Server{
+8 -7
View File
@@ -268,13 +268,14 @@ func (c *Config) Sanitize() map[string]interface{} {
smtpAccounts := make(map[string]interface{}) smtpAccounts := make(map[string]interface{})
for name, cfg := range c.Notifiers.SMTP { for name, cfg := range c.Notifiers.SMTP {
smtpAccounts[name] = map[string]interface{}{ smtpAccounts[name] = map[string]interface{}{
"host": cfg.Host, "host": cfg.Host,
"port": cfg.Port, "port": cfg.Port,
"username": cfg.Username, "username": cfg.Username,
"password": "***REDACTED***", "password": "***REDACTED***",
"from": cfg.From, "from": cfg.From,
"use_tls": cfg.UseTLS, "from_name": cfg.FromName,
"default": cfg.Default, "use_tls": cfg.UseTLS,
"default": cfg.Default,
} }
} }
notifiers["smtp"] = smtpAccounts notifiers["smtp"] = smtpAccounts
+19
View File
@@ -24,6 +24,14 @@ const (
TypeStdout NotificationType = "stdout" TypeStdout NotificationType = "stdout"
) )
// ContentType defines the format of the notification body
type ContentType string
const (
ContentTypeText ContentType = "text"
ContentTypeHTML ContentType = "html"
)
// NotificationStatus represents the current state of a notification // NotificationStatus represents the current state of a notification
type NotificationStatus string type NotificationStatus string
@@ -60,9 +68,20 @@ type Notification struct {
// Body is the main content of the notification // Body is the main content of the notification
Body string `json:"body"` Body string `json:"body"`
// ContentType specifies the format of the body (text or html)
// Defaults to "text" if not specified. HTML is auto-detected if body starts with < or contains HTML tags.
ContentType ContentType `json:"content_type,omitempty"`
// Recipients contains the target addresses (email, slack channel, ntfy topic, etc.) // Recipients contains the target addresses (email, slack channel, ntfy topic, etc.)
// For email: these are the "To" recipients
Recipients []string `json:"recipients"` Recipients []string `json:"recipients"`
// CC contains carbon copy recipients (email only, optional)
CC []string `json:"cc,omitempty"`
// BCC contains blind carbon copy recipients (email only, optional)
BCC []string `json:"bcc,omitempty"`
// Metadata contains additional provider-specific data // Metadata contains additional provider-specific data
Metadata map[string]interface{} `json:"metadata,omitempty"` Metadata map[string]interface{} `json:"metadata,omitempty"`
+15
View File
@@ -57,6 +57,9 @@ type NotificationService interface {
// GetStats returns notification statistics // GetStats returns notification statistics
GetStats(ctx context.Context) (*NotificationStats, error) GetStats(ctx context.Context) (*NotificationStats, error)
// GetNotifiers returns information about available notifiers
GetNotifiers(ctx context.Context) (*NotifiersResponse, error)
} }
// NotificationStats contains statistics about notification processing // NotificationStats contains statistics about notification processing
@@ -69,3 +72,15 @@ type NotificationStats struct {
ByStatus map[string]int64 `json:"by_status"` ByStatus map[string]int64 `json:"by_status"`
AverageLatency float64 `json:"average_latency_ms"` AverageLatency float64 `json:"average_latency_ms"`
} }
// NotifierInfo contains information about a configured notifier type
type NotifierInfo struct {
Type NotificationType `json:"type"`
Accounts []string `json:"accounts"`
DefaultAccount string `json:"default_account"`
}
// NotifiersResponse contains the list of available notifiers
type NotifiersResponse struct {
Notifiers []NotifierInfo `json:"notifiers"`
}
+17 -5
View File
@@ -72,14 +72,16 @@ func (f *Factory) SupportedTypes() []domain.NotificationType {
typeMap := make(map[domain.NotificationType]bool) typeMap := make(map[domain.NotificationType]bool)
for key := range f.notifiers { for key := range f.notifiers {
// Extract the type from the key (type:account) // Extract the type from the key (type:account or just type)
var notifType domain.NotificationType var notifType domain.NotificationType
if n, err := fmt.Sscanf(key, "%s:", &notifType); err == nil && n > 0 { if colonIdx := findColon(key); colonIdx >= 0 {
typeMap[notifType] = true // Key format: "type:account"
notifType = domain.NotificationType(key[:colonIdx])
} else { } else {
// Backward compatibility: key might just be the type // Key format: just "type" (backward compatibility)
typeMap[domain.NotificationType(key)] = true notifType = domain.NotificationType(key)
} }
typeMap[notifType] = true
} }
types := make([]domain.NotificationType, 0, len(typeMap)) types := make([]domain.NotificationType, 0, len(typeMap))
@@ -90,6 +92,16 @@ func (f *Factory) SupportedTypes() []domain.NotificationType {
return types return types
} }
// findColon finds the index of ':' in a string, returns -1 if not found
func findColon(s string) int {
for i, c := range s {
if c == ':' {
return i
}
}
return -1
}
// GetAccounts returns all registered accounts for a given notification type // GetAccounts returns all registered accounts for a given notification type
func (f *Factory) GetAccounts(notificationType domain.NotificationType) []string { func (f *Factory) GetAccounts(notificationType domain.NotificationType) []string {
f.mu.RLock() f.mu.RLock()
+130 -9
View File
@@ -2,8 +2,12 @@ package notifier
import ( import (
"context" "context"
"crypto/rand"
"encoding/hex"
"fmt" "fmt"
"html"
"net/smtp" "net/smtp"
"regexp"
"strings" "strings"
"time" "time"
@@ -17,6 +21,7 @@ type SMTPConfig struct {
Username string `mapstructure:"username"` Username string `mapstructure:"username"`
Password string `mapstructure:"password"` Password string `mapstructure:"password"`
From string `mapstructure:"from"` From string `mapstructure:"from"`
FromName string `mapstructure:"from_name"` // Optional display name for From header
UseTLS bool `mapstructure:"use_tls"` UseTLS bool `mapstructure:"use_tls"`
Default bool `mapstructure:"default"` // Mark this instance as default Default bool `mapstructure:"default"` // Mark this instance as default
} }
@@ -63,8 +68,14 @@ func (s *SMTPNotifier) Send(ctx context.Context, notification *domain.Notificati
return nil, err return nil, err
} }
// Collect all recipients (To, CC, BCC) for validation
allRecipients := make([]string, 0, len(notification.Recipients)+len(notification.CC)+len(notification.BCC))
allRecipients = append(allRecipients, notification.Recipients...)
allRecipients = append(allRecipients, notification.CC...)
allRecipients = append(allRecipients, notification.BCC...)
// Validate email recipients // Validate email recipients
for _, recipient := range notification.Recipients { for _, recipient := range allRecipients {
if !strings.Contains(recipient, "@") { if !strings.Contains(recipient, "@") {
return &domain.NotificationResult{ return &domain.NotificationResult{
NotificationID: notification.ID, NotificationID: notification.ID,
@@ -82,7 +93,8 @@ func (s *SMTPNotifier) Send(ctx context.Context, notification *domain.Notificati
addr := fmt.Sprintf("%s:%d", s.config.Host, s.config.Port) addr := fmt.Sprintf("%s:%d", s.config.Host, s.config.Port)
auth := smtp.PlainAuth("", s.config.Username, s.config.Password, s.config.Host) auth := smtp.PlainAuth("", s.config.Username, s.config.Password, s.config.Host)
err := smtp.SendMail(addr, auth, s.config.From, notification.Recipients, []byte(message)) // smtp.SendMail needs all recipients (To, CC, BCC) for actual delivery
err := smtp.SendMail(addr, auth, s.config.From, allRecipients, []byte(message))
if err != nil { if err != nil {
return &domain.NotificationResult{ return &domain.NotificationResult{
NotificationID: notification.ID, NotificationID: notification.ID,
@@ -109,21 +121,130 @@ func (s *SMTPNotifier) Send(ctx context.Context, notification *domain.Notificati
func (s *SMTPNotifier) buildMessage(notification *domain.Notification) string { func (s *SMTPNotifier) buildMessage(notification *domain.Notification) string {
var builder strings.Builder var builder strings.Builder
builder.WriteString(fmt.Sprintf("From: %s\r\n", s.config.From)) // Format From header with optional display name
builder.WriteString(fmt.Sprintf("To: %s\r\n", strings.Join(notification.Recipients, ", "))) fromHeader := s.config.From
if s.config.FromName != "" {
fromHeader = fmt.Sprintf("%s <%s>", s.config.FromName, s.config.From)
}
builder.WriteString(fmt.Sprintf("From: %s\r\n", fromHeader))
// Add To header (optional if only BCC is specified)
if len(notification.Recipients) > 0 {
builder.WriteString(fmt.Sprintf("To: %s\r\n", strings.Join(notification.Recipients, ", ")))
}
// Add CC header (optional)
if len(notification.CC) > 0 {
builder.WriteString(fmt.Sprintf("Cc: %s\r\n", strings.Join(notification.CC, ", ")))
}
// Note: BCC is intentionally NOT included in headers (that's the point of BCC!)
builder.WriteString(fmt.Sprintf("Subject: %s\r\n", notification.Subject)) builder.WriteString(fmt.Sprintf("Subject: %s\r\n", notification.Subject))
builder.WriteString("MIME-Version: 1.0\r\n") builder.WriteString("MIME-Version: 1.0\r\n")
builder.WriteString("Content-Type: text/plain; charset=UTF-8\r\n")
builder.WriteString("\r\n") // Auto-detect HTML if content type not set
builder.WriteString(notification.Body) contentType := notification.ContentType
if contentType == "" {
contentType = detectContentType(notification.Body)
}
// Build message based on content type
if contentType == domain.ContentTypeHTML {
// Send multipart/alternative with both text and HTML
s.buildMultipartMessage(&builder, notification)
} else {
// Send plain text only
builder.WriteString("Content-Type: text/plain; charset=UTF-8\r\n")
builder.WriteString("\r\n")
builder.WriteString(notification.Body)
}
return builder.String() return builder.String()
} }
// buildMultipartMessage builds a multipart/alternative email with both text and HTML versions
func (s *SMTPNotifier) buildMultipartMessage(builder *strings.Builder, notification *domain.Notification) {
// Generate a unique boundary
boundary := generateBoundary()
builder.WriteString(fmt.Sprintf("Content-Type: multipart/alternative; boundary=\"%s\"\r\n", boundary))
builder.WriteString("\r\n")
// Plain text version (auto-generated from HTML)
builder.WriteString(fmt.Sprintf("--%s\r\n", boundary))
builder.WriteString("Content-Type: text/plain; charset=UTF-8\r\n")
builder.WriteString("Content-Transfer-Encoding: 7bit\r\n")
builder.WriteString("\r\n")
builder.WriteString(htmlToPlainText(notification.Body))
builder.WriteString("\r\n\r\n")
// HTML version
builder.WriteString(fmt.Sprintf("--%s\r\n", boundary))
builder.WriteString("Content-Type: text/html; charset=UTF-8\r\n")
builder.WriteString("Content-Transfer-Encoding: 7bit\r\n")
builder.WriteString("\r\n")
builder.WriteString(notification.Body)
builder.WriteString("\r\n\r\n")
// End boundary
builder.WriteString(fmt.Sprintf("--%s--\r\n", boundary))
}
// detectContentType auto-detects if the body is HTML
func detectContentType(body string) domain.ContentType {
trimmed := strings.TrimSpace(body)
// Check for common HTML indicators
if strings.HasPrefix(trimmed, "<") ||
strings.Contains(trimmed, "<html") ||
strings.Contains(trimmed, "<!DOCTYPE") ||
strings.Contains(trimmed, "<p>") ||
strings.Contains(trimmed, "<div>") ||
strings.Contains(trimmed, "<br>") {
return domain.ContentTypeHTML
}
return domain.ContentTypeText
}
// generateBoundary generates a unique boundary string for multipart emails
func generateBoundary() string {
buf := make([]byte, 16)
rand.Read(buf)
return "boundary_" + hex.EncodeToString(buf)
}
// htmlToPlainText converts HTML to plain text (simple implementation)
func htmlToPlainText(htmlContent string) string {
// Remove HTML tags
re := regexp.MustCompile(`<[^>]*>`)
text := re.ReplaceAllString(htmlContent, "")
// Decode HTML entities
text = html.UnescapeString(text)
// Clean up whitespace
text = strings.ReplaceAll(text, "\r\n", "\n")
text = regexp.MustCompile(`\n{3,}`).ReplaceAllString(text, "\n\n")
text = strings.TrimSpace(text)
return text
}
// Validate checks if the notification is valid for SMTP // Validate checks if the notification is valid for SMTP
func (s *SMTPNotifier) Validate(notification *domain.Notification) error { func (s *SMTPNotifier) Validate(notification *domain.Notification) error {
if err := s.BaseNotifier.Validate(notification); err != nil { if notification == nil {
return err return fmt.Errorf("notification is nil")
}
// For email, we need at least one recipient (To, CC, or BCC)
totalRecipients := len(notification.Recipients) + len(notification.CC) + len(notification.BCC)
if totalRecipients == 0 {
return fmt.Errorf("email has no recipients (To, CC, or BCC required)")
}
if notification.Type != s.Type() {
return fmt.Errorf("notification type mismatch: expected %s, got %s", s.Type(), notification.Type)
} }
if notification.Subject == "" { if notification.Subject == "" {
+39 -1
View File
@@ -7,6 +7,7 @@ import (
"time" "time"
"github.com/igodwin/notifier/internal/domain" "github.com/igodwin/notifier/internal/domain"
"github.com/igodwin/notifier/internal/logging"
) )
// AccountResolver is an interface for resolving default accounts // AccountResolver is an interface for resolving default accounts
@@ -24,10 +25,11 @@ type NotificationService struct {
workerCount int workerCount int
stopChan chan struct{} stopChan chan struct{}
wg sync.WaitGroup wg sync.WaitGroup
logger *logging.Logger
} }
// NewNotificationService creates a new notification service // NewNotificationService creates a new notification service
func NewNotificationService(factory domain.NotifierFactory, queue domain.Queue, workerCount int, accountResolver AccountResolver) *NotificationService { func NewNotificationService(factory domain.NotifierFactory, queue domain.Queue, workerCount int, accountResolver AccountResolver, logger *logging.Logger) *NotificationService {
if workerCount <= 0 { if workerCount <= 0 {
workerCount = 10 workerCount = 10
} }
@@ -39,6 +41,7 @@ func NewNotificationService(factory domain.NotifierFactory, queue domain.Queue,
notifications: make(map[string]*domain.Notification), notifications: make(map[string]*domain.Notification),
workerCount: workerCount, workerCount: workerCount,
stopChan: make(chan struct{}), stopChan: make(chan struct{}),
logger: logger,
} }
} }
@@ -97,6 +100,9 @@ func (s *NotificationService) worker(ctx context.Context, id int) {
func (s *NotificationService) processNotification(ctx context.Context, msg *domain.QueueMessage) { func (s *NotificationService) processNotification(ctx context.Context, msg *domain.QueueMessage) {
notification := msg.Notification notification := msg.Notification
s.logger.Debugf("Processing notification - id=%s, type=%s, recipients=%d",
notification.ID, notification.Type, len(notification.Recipients))
// Resolve account if not specified // Resolve account if not specified
account := notification.Account account := notification.Account
if account == "" && s.accountResolver != nil { if account == "" && s.accountResolver != nil {
@@ -106,6 +112,8 @@ func (s *NotificationService) processNotification(ctx context.Context, msg *doma
// Get the appropriate notifier // Get the appropriate notifier
notifier, err := s.factory.Create(notification.Type, account) notifier, err := s.factory.Create(notification.Type, account)
if err != nil { if err != nil {
s.logger.Errorf("Failed to create notifier - id=%s, type=%s, account=%s, error=%v",
notification.ID, notification.Type, account, err)
notification.Status = domain.StatusFailed notification.Status = domain.StatusFailed
notification.LastError = fmt.Sprintf("failed to create notifier: %v", err) notification.LastError = fmt.Sprintf("failed to create notifier: %v", err)
s.queue.Nack(ctx, msg.ID, false) s.queue.Nack(ctx, msg.ID, false)
@@ -125,9 +133,13 @@ func (s *NotificationService) processNotification(ctx context.Context, msg *doma
// Check if we should retry // Check if we should retry
if notification.RetryCount < notification.MaxRetries { if notification.RetryCount < notification.MaxRetries {
notification.Status = domain.StatusRetrying notification.Status = domain.StatusRetrying
s.logger.Warnf("Notification send failed, will retry - id=%s, type=%s, account=%s, attempt=%d/%d, error=%s",
notification.ID, notification.Type, account, notification.RetryCount, notification.MaxRetries, notification.LastError)
s.queue.Nack(ctx, msg.ID, true) // Requeue s.queue.Nack(ctx, msg.ID, true) // Requeue
} else { } else {
notification.Status = domain.StatusFailed notification.Status = domain.StatusFailed
s.logger.Errorf("Notification send failed permanently - id=%s, type=%s, account=%s, recipients=%v, attempts=%d, error=%s",
notification.ID, notification.Type, account, notification.Recipients, notification.RetryCount, notification.LastError)
s.queue.Nack(ctx, msg.ID, false) // Don't requeue s.queue.Nack(ctx, msg.ID, false) // Don't requeue
} }
} else { } else {
@@ -135,6 +147,8 @@ func (s *NotificationService) processNotification(ctx context.Context, msg *doma
now := time.Now() now := time.Now()
notification.SentAt = &now notification.SentAt = &now
s.queue.Ack(ctx, msg.ID) s.queue.Ack(ctx, msg.ID)
s.logger.Infof("Notification sent successfully - id=%s, type=%s, account=%s, recipients=%v",
notification.ID, notification.Type, account, notification.Recipients)
} }
s.updateNotification(notification) s.updateNotification(notification)
@@ -302,6 +316,30 @@ func (s *NotificationService) GetStats(ctx context.Context) (*domain.Notificatio
return stats, nil return stats, nil
} }
// GetNotifiers returns information about available notifiers
func (s *NotificationService) GetNotifiers(ctx context.Context) (*domain.NotifiersResponse, error) {
supportedTypes := s.factory.SupportedTypes()
notifiers := make([]domain.NotifierInfo, 0, len(supportedTypes))
for _, notifType := range supportedTypes {
accounts := s.factory.GetAccounts(notifType)
defaultAccount := ""
if s.accountResolver != nil {
defaultAccount = s.accountResolver.GetDefaultAccount(notifType)
}
notifiers = append(notifiers, domain.NotifierInfo{
Type: notifType,
Accounts: accounts,
DefaultAccount: defaultAccount,
})
}
return &domain.NotifiersResponse{
Notifiers: notifiers,
}, nil
}
// storeNotification stores a notification in memory // storeNotification stores a notification in memory
func (s *NotificationService) storeNotification(notification *domain.Notification) { func (s *NotificationService) storeNotification(notification *domain.Notification) {
s.mu.Lock() s.mu.Lock()