Open platform to collect and prioritize feedback
Add BatchSend to both SMTP and Mailgun packages (#261)
Guilherme Oenningac07cf0af91a
diff --git a/app/handlers/signup.go b/app/handlers/signup.goindex 9eaa295a5..1bf1af26a 100644--- a/app/handlers/signup.go+++ b/app/handlers/signup.go@@ -4,6 +4,8 @@ import ("net/http""time"+ "github.com/getfider/fider/app/tasks"+"strings""github.com/getfider/fider/app"@@ -71,13 +73,7 @@ func CreateTenant() web.HandlerFunc {return c.Failure(err)}- _, err = c.Services().Emailer.Send("Fider", user.Email, "signup_email", web.Map{- "baseURL": c.TenantBaseURL(tenant),- "verificationKey": input.Model.VerificationKey,- })- if err != nil {- return c.Failure(err)- }+ c.Enqueue(tasks.SendSignUpEmail(input.Model, c.TenantBaseURL(tenant)))}if socialSignUp {diff --git a/app/models/feedback.go b/app/models/feedback.goindex 9fd451398..fb139e2e5 100644--- a/app/models/feedback.go+++ b/app/models/feedback.go@@ -169,7 +169,6 @@ var (DefaultEnabledUserRoles: []Role{RoleAdministrator,RoleCollaborator,- RoleVisitor,},}//NotificationEventChangeStatus is triggered when a new idea has its status changeddiff --git a/app/pkg/email/email.go b/app/pkg/email/email.goindex 21881b07b..2d15c3eb2 100644--- a/app/pkg/email/email.go+++ b/app/pkg/email/email.go@@ -2,8 +2,8 @@ package emailimport ("bytes"- "fmt""html/template"+ "regexp""strings""github.com/getfider/fider/app/pkg/env"@@ -13,8 +13,6 @@ var cache = make(map[string]*template.Template, 0)// Message represents what is sent by e-mailtype Message struct {- To string- From stringSubject stringBody string}@@ -44,24 +42,60 @@ func RenderMessage(templateName string, params map[string]interface{}) *Message// NoReply is the default 'from' addressvar NoReply = env.MustGet("NOREPLY_EMAIL")+// Recipient contains details of who is receiving the e-mail+type Recipient struct {+ Name string+ Address string+ Params map[string]interface{}+}++// NewRecipient creates a new Recipient+func NewRecipient(address string, params map[string]interface{}) Recipient {+ return Recipient{+ Address: address,+ Params: params,+ }+}++var whitelist = env.GetEnvOrDefault("EMAIL_WHITELIST", "")+var whitelistRegex = regexp.MustCompile(whitelist)++// SetWhitelist can be used to change e-mail whitelist during rutime+func SetWhitelist(s string) {+ whitelist = s+ whitelistRegex = regexp.MustCompile(whitelist)+}++// CanSendTo returns true if Fider is allowed to send e-mail to given address+func CanSendTo(address string) bool {+ if whitelist == "" {+ return true+ }+ return whitelistRegex.MatchString(address)+}+// Sender is used to send e-mailstype Sender interface {- Send(from, to, templateName string, params map[string]interface{}) (*Message, error)+ Send(templateName, from string, to Recipient) error+ BatchSend(templateName, from string, to []Recipient) error}-//NoopSender does not send e-mails+// NoopSender does not send e-mailstype NoopSender struct {}-//NewNoopSender creates a new NoopSender+// NewNoopSender creates a new NoopSenderfunc NewNoopSender() *NoopSender {return &NoopSender{}}-//Send an e-mail-func (s *NoopSender) Send(from, to, templateName string, params map[string]interface{}) (*Message, error) {- msg := RenderMessage(templateName, params)- msg.To = to- msg.From = fmt.Sprintf("%s <%s>", from, NoReply)- return msg, nil+// Send an e-mail+func (s *NoopSender) Send(templateName, from string, to Recipient) error {+ return nil++}++// BatchSend an e-mail to multiple recipients+func (s *NoopSender) BatchSend(templateName, from string, to []Recipient) error {+ return nil}diff --git a/app/pkg/email/email_test.go b/app/pkg/email/email_test.goindex 9d3dbba82..252398a1b 100644--- a/app/pkg/email/email_test.go+++ b/app/pkg/email/email_test.go@@ -18,3 +18,31 @@ func TestRenderMessage(t *testing.T) {Expect(message.Subject).To(Equal("Message to: Fider"))Expect(message.Body).To(Equal("Hello World Fider!"))}++func TestEmailWhitelist_Valid(t *testing.T) {+ RegisterTestingT(t)++ email.SetWhitelist("(^[email protected]$)|(^darthvader\\.fider(\\+.*)?@gmail\\.com$)")++ for _, address := range []string{+ "[email protected]",+ "[email protected]",+ "[email protected]",+ "[email protected]",+ "[email protected]",+ "[email protected]",+ } {+ Expect(email.CanSendTo(address)).To(BeTrue())+ }++ for _, address := range []string{+ "[email protected]",+ "@fider.io",+ "[email protected]",+ "[email protected]",+ "[email protected]",+ "[email protected]",+ } {+ Expect(email.CanSendTo(address)).To(BeFalse())+ }+}diff --git a/app/pkg/email/mailgun/mailgun.go b/app/pkg/email/mailgun/mailgun.goindex 9cb7f82c4..8bc3e40a0 100644--- a/app/pkg/email/mailgun/mailgun.go+++ b/app/pkg/email/mailgun/mailgun.go@@ -1,6 +1,7 @@package mailgunimport (+ "encoding/json""fmt""net/http""net/url"@@ -25,33 +26,80 @@ func NewSender(logger log.Logger, domain, apiKey string) *Sender {}//Send an e-mail-func (s *Sender) Send(from, to, templateName string, params map[string]interface{}) (*email.Message, error) {- s.logger.Debugf("Sending e-mail to %s with template %s and params %s.", to, templateName, params)+func (s *Sender) Send(templateName, from string, to email.Recipient) error {+ return s.BatchSend(templateName, from, []email.Recipient{to})+}++// BatchSend an e-mail to multiple recipients+func (s *Sender) BatchSend(templateName, from string, to []email.Recipient) error {+ if len(to) == 0 {+ return nil+ }++ isBatch := len(to) > 1- message := email.RenderMessage(templateName, params)- message.From = fmt.Sprintf("%s <%s>", from, email.NoReply)- message.To = to+ var message *email.Message+ if isBatch {+ // Replace Go's templates var with Mailgun's template vars+ mgParams := make(map[string]interface{}, len(to[0].Params))+ for k := range to[0].Params {+ mgParams[k] = fmt.Sprintf("%%recipient.%s%%", k)+ }+ message = email.RenderMessage(templateName, mgParams)+ } else {+ message = email.RenderMessage(templateName, to[0].Params)+ }form := url.Values{}- form.Add("from", message.From)- form.Add("to", message.To)+ form.Add("from", fmt.Sprintf("%s <%s>", from, email.NoReply))form.Add("subject", message.Subject)form.Add("html", message.Body)+ // Set Mailgun's var based on each recipient's variables+ recipientVariables := make(map[string]map[string]interface{}, 0)+ for _, r := range to {+ if email.CanSendTo(r.Address) {+ form.Add("to", r.Address)+ recipientVariables[r.Address] = r.Params+ } else {+ s.logger.Warnf("Skipping e-mail to %s due to whitelist.", r.Address)+ }+ }++ // If we skipped all recipients due to whitelist, just return+ if len(recipientVariables) == 0 {+ return nil+ }++ if isBatch {+ json, err := json.Marshal(recipientVariables)+ if err != nil {+ return err+ }++ form.Add("recipient-variables", string(json))+ }++ if isBatch {+ s.logger.Debugf("Sending e-mail to %d recipients with template %s.", len(recipientVariables), templateName)+ } else {+ s.logger.Debugf("Sending e-mail to %s with template %s.", to[0].Address, templateName)+ }+url := fmt.Sprintf(baseURL, s.domain)request, err := http.NewRequest("POST", url, strings.NewReader(form.Encode()))if err != nil {- return nil, err+ return err}request.SetBasicAuth("api", s.apiKey)request.Header.Set("Content-Type", "application/x-www-form-urlencoded")resp, err := http.DefaultClient.Do(request)- if err == nil {- s.logger.Debugf("E-mail sent with response code %d.", resp.StatusCode)- return message, nil+ if err != nil {+ s.logger.Errorf("Failed to send e-mail")+ return err}- s.logger.Errorf("Failed to send e-mail")- return nil, err+ s.logger.Debugf("E-mail sent with response code %d.", resp.StatusCode)+ return nil}diff --git a/app/pkg/email/smtp/smtp.go b/app/pkg/email/smtp/smtp.goindex e02ee7f3e..08b20512b 100644--- a/app/pkg/email/smtp/smtp.go+++ b/app/pkg/email/smtp/smtp.go@@ -23,15 +23,18 @@ func NewSender(logger log.Logger, host, port, username, password string) *Sender}//Send an e-mail-func (s *Sender) Send(from, to, templateName string, params map[string]interface{}) (*email.Message, error) {- s.logger.Debugf("Sending e-mail to %s with template %s and params %s.", to, templateName, params)+func (s *Sender) Send(templateName, from string, to email.Recipient) error {+ if !email.CanSendTo(to.Address) {+ s.logger.Warnf("Skipping e-mail to %s due to whitelist.", to.Address)+ return nil+ }++ s.logger.Debugf("Sending e-mail to %s with template %s and params %s.", to.Address, templateName, to.Params)- message := email.RenderMessage(templateName, params)- message.From = fmt.Sprintf("%s <%s>", from, email.NoReply)- message.To = to+ message := email.RenderMessage(templateName, to.Params)headers := make(map[string]string)- headers["From"] = message.From- headers["To"] = message.To+ headers["From"] = fmt.Sprintf("%s <%s>", from, email.NoReply)+ headers["To"] = to.Addressheaders["Subject"] = message.Subjectheaders["MIME-version"] = "1.0"headers["Content-Type"] = "text/html; charset=\"UTF-8\""@@ -44,11 +47,21 @@ func (s *Sender) Send(from, to, templateName string, params map[string]interfaceservername := fmt.Sprintf("%s:%s", s.host, s.port)auth := gosmtp.PlainAuth("", s.username, s.password, s.host)- err := gosmtp.SendMail(servername, auth, email.NoReply, []string{to}, []byte(body))- if err == nil {- s.logger.Debugf("E-mail sent.")- return message, nil+ err := gosmtp.SendMail(servername, auth, email.NoReply, []string{to.Address}, []byte(body))+ if err != nil {+ s.logger.Errorf("Failed to send e-mail")+ return err+ }+ s.logger.Debugf("E-mail sent.")+ return nil+}++// BatchSend an e-mail to multiple recipients+func (s *Sender) BatchSend(templateName, from string, to []email.Recipient) error {+ for _, r := range to {+ if err := s.Send(templateName, from, r); err != nil {+ return err+ }}- s.logger.Errorf("Failed to send e-mail")- return nil, err+ return nil}diff --git a/app/storage/inmemory/idea.go b/app/storage/inmemory/idea.goindex 2779186a8..a8a7eab28 100644--- a/app/storage/inmemory/idea.go+++ b/app/storage/inmemory/idea.go@@ -233,7 +233,7 @@ func (s *IdeaStorage) RemoveSubscriber(number, userID int) error {func (s *IdeaStorage) GetActiveSubscribers(number int, channel models.NotificationChannel, event models.NotificationEvent) ([]*models.User, error) {idea, err := s.GetByNumber(number)if err != nil {- return make([]*models.User, 0), err+ return nil, err}subscribers, ok := s.ideaSubscribers[idea.ID]if ok {diff --git a/app/storage/postgres/subscription_test.go b/app/storage/postgres/subscription_test.goindex 1b3d148be..11052d50c 100644--- a/app/storage/postgres/subscription_test.go+++ b/app/storage/postgres/subscription_test.go@@ -23,9 +23,8 @@ func TestSubscription_NoSettings(t *testing.T) {subscribers, err = ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelWeb, models.NotificationEventNewComment)Expect(err).To(BeNil())- Expect(len(subscribers)).To(Equal(2))+ Expect(len(subscribers)).To(Equal(1))Expect(subscribers[0].ID).To(Equal(jonSnow.ID))- Expect(subscribers[1].ID).To(Equal(aryaStark.ID))subscribers, err = ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelWeb, models.NotificationEventChangeStatus)Expect(err).To(BeNil())@@ -74,9 +73,8 @@ func TestSubscription_AdminSubmitted(t *testing.T) {subscribers, err = ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelWeb, models.NotificationEventNewComment)Expect(err).To(BeNil())- Expect(len(subscribers)).To(Equal(2))+ Expect(len(subscribers)).To(Equal(1))Expect(subscribers[0].ID).To(Equal(jonSnow.ID))- Expect(subscribers[1].ID).To(Equal(aryaStark.ID))subscribers, err = ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelWeb, models.NotificationEventChangeStatus)Expect(err).To(BeNil())diff --git a/app/tasks/tasks.go b/app/tasks/tasks.goindex 6dd83603f..64b241c06 100644--- a/app/tasks/tasks.go+++ b/app/tasks/tasks.go@@ -1,7 +1,11 @@package tasksimport (+ "fmt"+ "html/template"+"github.com/getfider/fider/app/models"+ "github.com/getfider/fider/app/pkg/email""github.com/getfider/fider/app/pkg/web""github.com/getfider/fider/app/pkg/worker")@@ -10,15 +14,28 @@ func describe(name string, job worker.Job) worker.Task {return worker.Task{Name: name, Job: job}}+func link(baseURL, path string, args ...interface{}) template.HTML {+ return template.HTML(fmt.Sprintf("<a href='%[1]s%[2]s'>%[1]s%[2]s</a>", baseURL, fmt.Sprintf(path, args...)))+}++//SendSignUpEmail is used to send the sign up email to requestor+func SendSignUpEmail(model *models.CreateTenant, baseURL string) worker.Task {+ return describe("Send sign up e-mail", func(c *worker.Context) error {+ to := email.NewRecipient(model.Email, web.Map{+ "link": link(baseURL, "/signup/verify?k=%s", model.VerificationKey),+ })+ return c.Services().Emailer.Send("signup_email", "Fider", to)+ })+}+//SendSignInEmail is used to send the sign in email to requestorfunc SendSignInEmail(model *models.SignInByEmail, baseURL string) worker.Task {return describe("Send sign in e-mail", func(c *worker.Context) error {- _, err := c.Services().Emailer.Send(c.Tenant().Name, model.Email, "signin_email", web.Map{- "tenantName": c.Tenant().Name,- "baseURL": baseURL,- "verificationKey": model.VerificationKey,+ to := email.NewRecipient(model.Email, web.Map{+ "tenantName": c.Tenant().Name,+ "link": link(baseURL, "/signin/verify?k=%s", model.VerificationKey),})- return err+ return c.Services().Emailer.Send("signin_email", c.Tenant().Name, to)})}@@ -29,13 +46,13 @@ func SendChangeEmailConfirmation(model *models.ChangeUserEmail, baseURL string)if previous == "" {previous = "(empty)"}- _, err := c.Services().Emailer.Send(c.Tenant().Name, model.Email, "change_emailaddress_email", web.Map{- "name": c.User().Name,- "oldEmail": previous,- "newEmail": model.Email,- "baseURL": baseURL,- "verificationKey": model.VerificationKey,++ to := email.NewRecipient(model.Email, web.Map{+ "name": c.User().Name,+ "oldEmail": previous,+ "newEmail": model.Email,+ "link": link(baseURL, "/change-email/verify?k=%s", model.VerificationKey),})- return err+ return c.Services().Emailer.Send("change_emailaddress_email", c.Tenant().Name, to)})}diff --git a/app/tasks/tasks_test.go b/app/tasks/tasks_test.goindex 6b5266db9..1f9f6a8b9 100644--- a/app/tasks/tasks_test.go+++ b/app/tasks/tasks_test.go@@ -10,6 +10,17 @@ import (. "github.com/onsi/gomega")+func TestSendSignUpEmailTask(t *testing.T) {+ RegisterTestingT(t)++ worker, _ := mock.NewWorker()+ task := tasks.SendSignUpEmail(&models.CreateTenant{}, "http://anywhere.com")+ err := worker.+ AsUser(mock.JonSnow).+ Execute(task)+ Expect(err).To(BeNil())+}+func TestSendSignInEmailTask(t *testing.T) {RegisterTestingT(t)diff --git a/tests/lib/mailgun/index.ts b/tests/lib/mailgun/index.tsindex 60c3b6075..5a4acecd8 100644--- a/tests/lib/mailgun/index.ts+++ b/tests/lib/mailgun/index.ts@@ -29,7 +29,7 @@ export const mailgun = {do {count++;- const url = `https://api.mailgun.net/v3/${process.env.MAILGUN_DOMAIN}/events?to=${to}&event=accepted&limit=1&ascending=no`;+ const url = `https://api.mailgun.net/v3/${process.env.MAILGUN_DOMAIN}/events?to=${to}&event=delivered&limit=1&ascending=no`;const events = await httpGet(url);if (events.items.length > 0 && events.items[0].message.headers.to === to) {messageUrl = events.items[0].storage.url;diff --git a/views/templates/change_emailaddress_email.tpl b/views/templates/change_emailaddress_email.tplindex e921a6033..76471ea5b 100644--- a/views/templates/change_emailaddress_email.tpl+++ b/views/templates/change_emailaddress_email.tpl@@ -6,6 +6,6 @@ Looks like you have requested to change your e-mail from {{ .oldEmail }} to {{ .<br />Click the link below to confirm this operation.<br /><br />-<a href='{{ .baseURL }}/change-email/verify?k={{ .verificationKey }}'>{{ .baseURL }}/change-email/verify?k={{ .verificationKey }}</a>+{{ .link }}<br /><br /><span style="color:#b3b3b1;font-size:11px">This link will expire in 24 hours and can only be used once.</span>\ No newline at end of filediff --git a/views/templates/signin_email.tpl b/views/templates/signin_email.tplindex d3f9fa775..59ca3171d 100644--- a/views/templates/signin_email.tpl+++ b/views/templates/signin_email.tpl@@ -2,6 +2,6 @@ subject: Sign in to {{ .tenantName }}body:Click the link below to sign in.<br /><br />-<a href='{{ .baseURL }}/signin/verify?k={{ .verificationKey }}'>{{ .baseURL }}/signin/verify?k={{ .verificationKey }}</a>+{{ .link }}<br /><br /><span style="color:#b3b3b1;font-size:11px">This link will expire in 15 minutes and can only be used once.</span>\ No newline at end of filediff --git a/views/templates/signup_email.tpl b/views/templates/signup_email.tplindex 7e8d7147b..7f0fec690 100644--- a/views/templates/signup_email.tpl+++ b/views/templates/signup_email.tpl@@ -2,6 +2,6 @@ subject: Confirm your new Fider instancebody:Click the link below to confirm your new Fider instance.<br /><br />-<a href='{{ .baseURL }}/signup/verify?k={{ .verificationKey }}'>{{ .baseURL }}/signup/verify?k={{ .verificationKey }}</a>+{{ .link }}<br /><br /><span style="color:#b3b3b1;font-size:11px">This link will expire in 48 hours and can only be used once.</span>\ No newline at end of file