Merge pull request #7 from cruxstack/dev

feat: add sendgrid as an email provider

Author: sgtoj

README.md

@@ -139,6 +139,13 @@ with the following shape:
     "dstAddress": "user@example.org",
     "providers": {
       // email provider specific data
+      "sendgrid": {
+        "subject": "Test Email from Example.org",
+        "templateId": "your-sendgrid-template-id",
+        "templateData": {
+          "code": "123456"
+        }
+      },
       "ses": {
         "templateId": "your-ses-template-id",
         "templateData": {

internal/config/config.go

@@ -20,9 +20,10 @@ type Config struct {
 	DebugMode                          bool
 	DebugDataPath                      string
 	SendGridApiHost                    string
+	SendGridEmailVerificationApiKey    string
 	SendGridEmailVerificationEnabled   bool
 	SendGridEmailVerificationAllowlist []string
-	SendGridApiKey                     string
+	SendGridEmailSendApiKey            string
 }
 
 func New() (*Config, error) {
@@ -37,13 +38,14 @@ func New() (*Config, error) {
 		AWSConfig:                          &awscfg,
 		AppKmsKeyId:                        os.Getenv("APP_KMS_KEY_ID"),
 		AppLogLevel:                        log.InfoLevel,
-		AppEmailProvider:                   "ses",
+		AppEmailProvider:                   os.Getenv("APP_EMAIL_PROVIDER"),
 		AppEmailSenderPolicyPath:           os.Getenv("APP_EMAIL_SENDER_POLICY_PATH"),
 		AppSendEnabled:                     true,
-		SendGridApiKey:                     os.Getenv("APP_SENDGRID_API_KEY"),
 		SendGridApiHost:                    os.Getenv("APP_SENDGRID_API_HOST"),
+		SendGridEmailVerificationApiKey:    os.Getenv("APP_SENDGRID_EMAIL_VERIFICATION_API_KEY"),
 		SendGridEmailVerificationAllowlist: []string{},
 		SendGridEmailVerificationEnabled:   os.Getenv("APP_SENDGRID_EMAIL_VERIFICATION_ENABLED") == "true",
+		SendGridEmailSendApiKey:            os.Getenv("APP_SENDGRID_EMAIL_SEND_API_KEY"),
 	}
 
 	// disable send if debug mode by default
@@ -56,6 +58,11 @@ func New() (*Config, error) {
 		cfg.AppLogLevel = logLevel
 	}
 
+	if cfg.AppEmailProvider == "" || (cfg.AppEmailProvider != "ses" && cfg.AppEmailProvider != "sendgrid") {
+		log.Warn("fallback to ses for email provider because of unknown provider", "provider", cfg.AppEmailProvider)
+		cfg.AppEmailProvider = "ses"
+	}
+
 	allowlistStr := strings.TrimSpace(os.Getenv("APP_SENDGRID_EMAIL_VERIFICATION_ALLOWLIST"))
 	if allowlistStr != "" {
 		allowlist := strings.Split(allowlistStr, ",")
@@ -75,5 +82,10 @@ func New() (*Config, error) {
 		log.Warn("KMS_KEY_ID env is deprecated; use APP_KMS_KEY_ID")
 	}
 
+	if cfg.SendGridEmailVerificationApiKey == "" && os.Getenv("APP_SENDGRID_API_KEY") != "" {
+		cfg.SendGridEmailVerificationApiKey = os.Getenv("APP_SENDGRID_API_KEY")
+		log.Warn("APP_SENDGRID_API_KEY env is deprecated; use APP_SENDGRID_EMAIL_VERIFICATION_API_KEY")
+	}
+
 	return &cfg, nil
 }

internal/providers/provider.go

@@ -3,6 +3,7 @@ package providers
 import (
 	"context"
 	"fmt"
+	"net/mail"
 
 	"github.com/cruxstack/cognito-custom-message-sender-go/internal/config"
 	"github.com/cruxstack/cognito-custom-message-sender-go/internal/types"
@@ -15,7 +16,10 @@ type Provider interface {
 
 func NewProvider(cfg *config.Config) (Provider, error) {
 	var p Provider
+
 	switch cfg.AppEmailProvider {
+	case "sendgrid":
+		p = NewSendGridProvider(cfg)
 	case "ses":
 		p = NewSESProvider(cfg)
 	default:
@@ -34,3 +38,11 @@ func MergeTemplateData(base, additional map[string]any) map[string]any {
 	}
 	return base
 }
+
+func ParseNameAddr(s string) (string, string) {
+	addr, err := mail.ParseAddress(s)
+	if err != nil || addr == nil {
+		return "", s
+	}
+	return addr.Name, addr.Address
+}

internal/providers/sendgrid.go

@@ -0,0 +1,72 @@
+package providers
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/charmbracelet/log"
+	"github.com/cruxstack/cognito-custom-message-sender-go/internal/config"
+	"github.com/cruxstack/cognito-custom-message-sender-go/internal/types"
+	"github.com/sendgrid/sendgrid-go"
+	"github.com/sendgrid/sendgrid-go/helpers/mail"
+)
+
+type SendGridProvider struct {
+	Client sendgrid.Client
+	APIKey string
+	DryRun bool
+}
+
+func NewSendGridProvider(cfg *config.Config) *SendGridProvider {
+	return &SendGridProvider{
+		Client: *sendgrid.NewSendClient(cfg.SendGridEmailSendApiKey),
+		DryRun: !cfg.AppSendEnabled,
+	}
+}
+
+func (p *SendGridProvider) Name() string {
+	return "sendgrid"
+}
+
+func (p *SendGridProvider) Send(ctx context.Context, d *types.EmailData) error {
+	d.Providers.SendGrid.TemplateData = MergeTemplateData(d.Providers.SendGrid.TemplateData, map[string]any{"code": d.VerificationCode})
+
+	srcName, srcAddr := ParseNameAddr(d.SourceAddress)
+	_, dstAddr := ParseNameAddr(d.DestinationAddress)
+
+	if p.DryRun {
+		return p.SendDryRun(ctx, d)
+	}
+
+	msg := mail.NewV3Mail()
+	msg.SetFrom(mail.NewEmail(srcName, srcAddr))
+	msg.SetTemplateID(d.Providers.SendGrid.TemplateID)
+
+	data := mail.NewPersonalization()
+	data.AddTos(mail.NewEmail("", dstAddr))
+	for k, v := range d.Providers.SendGrid.TemplateData {
+		data.SetDynamicTemplateData(k, v)
+	}
+	msg.AddPersonalizations(data)
+
+	resp, err := p.Client.Send(msg)
+	if err != nil {
+		return fmt.Errorf("sendgrid api error: %w", err)
+	}
+	if resp.StatusCode < 200 || resp.StatusCode >= 300 {
+		return fmt.Errorf("sendgrid send failed: status=%d body=%s", resp.StatusCode, resp.Body)
+	}
+
+	return nil
+}
+
+func (p *SendGridProvider) SendDryRun(ctx context.Context, d *types.EmailData) error {
+	log.Debug("[DRY-RUN] SendGrid Send",
+		"templateId", d.Providers.SendGrid.TemplateID,
+		"templateData", d.Providers.SendGrid.TemplateData,
+		"srcAddress", d.SourceAddress,
+		"dstAddress", d.DestinationAddress,
+		"data.len", len(d.TemplateData),
+	)
+	return nil
+}

internal/providers/ses.go

@@ -61,8 +61,8 @@ func (p *SESProvider) SendDryRun(ctx context.Context, d *types.EmailData) error
 	}
 
 	log.Debug(
-		"[DRY-RUN] SES SendTemplateEmail:",
-		"templateID", d.Providers.SES.TemplateID,
+		"[DRY-RUN] SES Send:",
+		"templateId", d.Providers.SES.TemplateID,
 		"templateData", string(dataJSON),
 		"srcAddress", d.SourceAddress,
 		"dstAddress", d.DestinationAddress,

internal/sender/sender.go

@@ -133,12 +133,16 @@ func (s *Sender) ParseEmailData(data *types.EmailData) (*types.EmailData, error)
 	if data.Providers == nil {
 		data.Providers = &types.EmailProviderMap{}
 	}
-	if data.Providers.SES == nil {
+	if s.Config.AppEmailProvider == "ses" && data.Providers.SES == nil {
 		data.Providers.SES = &types.EmailProviderData{
 			TemplateID:   data.TemplateID,
 			TemplateData: data.TemplateData,
 		}
 	}
 
+	if s.Config.AppEmailProvider == "sendgrid" && data.Providers.SendGrid == nil {
+		return nil, fmt.Errorf("email provider is sendgrid but email data does not include data for sendgrid provider")
+	}
+
 	return data, nil
 }

internal/types/types.go

@@ -10,7 +10,8 @@ type EmailData struct {
 }
 
 type EmailProviderMap struct {
-	SES *EmailProviderData `json:"ses,omitempty"`
+	SendGrid *EmailProviderData `json:"sendgrid,omitempty"`
+	SES      *EmailProviderData `json:"ses,omitempty"`
 }
 
 type EmailProviderData struct {

internal/verifier/sendgrid.go

@@ -97,6 +97,6 @@ func NewSendGridVerifier(cfg *config.Config) (*SendGridEmailVerifier, error) {
 	return &SendGridEmailVerifier{
 		Allowlist: cfg.SendGridEmailVerificationAllowlist,
 		APIHost:   cfg.SendGridApiHost,
-		APIKey:    cfg.SendGridApiKey,
+		APIKey:    cfg.SendGridEmailVerificationApiKey,
 	}, nil
 }