Open platform to collect and prioritize feedback
feature: automatic email notification supression
goenningccd362c8e682
diff --git a/app/cmd/server.go b/app/cmd/server.goindex d55c94639..918a80771 100644--- a/app/cmd/server.go+++ b/app/cmd/server.go@@ -56,6 +56,7 @@ func RunServer() int {func startJobs(ctx context.Context) {c := cron.New()_ = c.AddJob(jobs.NewJob(ctx, "PurgeExpiredNotificationsJob", jobs.PurgeExpiredNotificationsJobHandler{}))+ _ = c.AddJob(jobs.NewJob(ctx, "EmailSupressionJob", jobs.EmailSupressionJobHandler{}))c.Start()}diff --git a/app/jobs/email_supression_job.go b/app/jobs/email_supression_job.gonew file mode 100644index 000000000..e58a6d7a3--- /dev/null+++ b/app/jobs/email_supression_job.go@@ -0,0 +1,45 @@+package jobs++import (+ "context"+ "time"++ "github.com/getfider/fider/app/models/cmd"+ "github.com/getfider/fider/app/models/dto"+ "github.com/getfider/fider/app/models/query"+ "github.com/getfider/fider/app/pkg/bus"+ "github.com/getfider/fider/app/pkg/errors"+ "github.com/getfider/fider/app/pkg/log"+)++type EmailSupressionJobHandler struct {+}++func (e EmailSupressionJobHandler) Schedule() string {+ return "0 5 * * * *" // every hour at minute 5+}++func (e EmailSupressionJobHandler) Run(ctx context.Context) error {+ twoDaysAgo := time.Now().AddDate(0, 0, -2)++ q := &query.FetchRecentSupressions{+ StartTime: twoDaysAgo,+ }++ if err := bus.Dispatch(ctx, q); err != nil {+ return errors.Wrap(err, "failed to fetch recent supressions")+ }++ c := &cmd.SupressEmail{+ EmailAddresses: q.EmailAddresses,+ }+ if err := bus.Dispatch(ctx, c); err != nil {+ return errors.Wrap(err, "failed to supress emails")+ }++ log.Debugf(ctx, "@{Count} account(s) marked with supressed email", dto.Props{+ "Count": c.NumOfSupressedEmailAddresses,+ })++ return nil+}diff --git a/app/jobs/job.go b/app/jobs/job.goindex 0871c7927..377b5e83b 100644--- a/app/jobs/job.go+++ b/app/jobs/job.go@@ -4,6 +4,7 @@ import ("context""time"+ "github.com/getfider/fider/app""github.com/getfider/fider/app/models/dto""github.com/getfider/fider/app/pkg/dbx""github.com/getfider/fider/app/pkg/env"@@ -42,6 +43,14 @@ func (j fiderJob) Run() {log.PropertyKeyTag: "JOBS",})+ trx, err := dbx.BeginTx(ctx)+ if err != nil {+ log.Error(ctx, errors.Wrap(err, "failed to open transaction while acquiring advisory lock"))+ return+ }++ ctx = context.WithValue(ctx, app.TransactionCtxKey, trx)+defer func() {if r := recover(); r != nil {log.Error(ctx, errors.Panicked(r))@@ -53,7 +62,7 @@ func (j fiderJob) Run() {"JobName": j.Name,})- locked, unlock := dbx.TryLock(ctx, j.Name)+ locked, unlock := dbx.TryLock(ctx, trx, j.Name)if !locked {log.Debugf(ctx, "Job '@{JobName}' skipped, could not acquire lock", dto.Props{"JobName": j.Name,diff --git a/app/models/cmd/notification.go b/app/models/cmd/notification.goindex baf7cf3f3..b65918605 100644--- a/app/models/cmd/notification.go+++ b/app/models/cmd/notification.go@@ -32,3 +32,10 @@ type RemoveSubscriber struct {Post *entity.PostUser *entity.User}++type SupressEmail struct {+ EmailAddresses []string++ //Output+ NumOfSupressedEmailAddresses int+}diff --git a/app/pkg/dbx/lock.go b/app/pkg/dbx/lock.goindex 5fca86606..2a0f4d57e 100644--- a/app/pkg/dbx/lock.go+++ b/app/pkg/dbx/lock.go@@ -16,13 +16,7 @@ func hash(s string) uint32 {// Try to obtain an advisory lock// returns true and an unlock function if lock was aquired-func TryLock(ctx context.Context, key string) (bool, func()) {- trx, err := BeginTx(ctx)- if err != nil {- log.Error(ctx, errors.Wrap(err, "failed to open transaction while acquiring advisory lock"))- return false, nil- }-+func TryLock(ctx context.Context, trx *Trx, key string) (bool, func()) {var locked boolif err := trx.Scalar(&locked, "SELECT pg_try_advisory_xact_lock($1)", hash(key)); err != nil {log.Error(ctx, errors.Wrap(err, "failed to acquire advisory lock"))diff --git a/app/pkg/dbx/lock_test.go b/app/pkg/dbx/lock_test.goindex 7f371270e..c7893767d 100644--- a/app/pkg/dbx/lock_test.go+++ b/app/pkg/dbx/lock_test.go@@ -11,9 +11,13 @@ import (func TestTryLock_MultipleProcesses_SameKey(t *testing.T) {RegisterT(t)ctx := context.Background()+ trx1, _ := dbx.BeginTx(context.Background())+ locked1, unlock1 := dbx.TryLock(ctx, trx1, "KEY_1")+ defer trx1.MustRollback()- locked1, unlock1 := dbx.TryLock(ctx, "KEY_1")- locked2, unlock2 := dbx.TryLock(ctx, "KEY_1")+ trx2, _ := dbx.BeginTx(context.Background())+ locked2, unlock2 := dbx.TryLock(ctx, trx2, "KEY_1")+ defer trx2.MustRollback()Expect(locked1).IsTrue()Expect(unlock1).IsNotNil()@@ -22,7 +26,7 @@ func TestTryLock_MultipleProcesses_SameKey(t *testing.T) {unlock1()- locked2, unlock2 = dbx.TryLock(ctx, "KEY_1")+ locked2, unlock2 = dbx.TryLock(ctx, trx2, "KEY_1")Expect(locked2).IsTrue()Expect(unlock2).IsNotNil()@@ -33,8 +37,13 @@ func TestTryLock_MultipleProcesses_DifferentKey(t *testing.T) {RegisterT(t)ctx := context.Background()- locked1, unlock1 := dbx.TryLock(ctx, "KEY_1")- locked2, unlock2 := dbx.TryLock(ctx, "KEY_2")+ trx1, _ := dbx.BeginTx(context.Background())+ locked1, unlock1 := dbx.TryLock(ctx, trx1, "KEY_1")+ defer trx1.MustRollback()++ trx2, _ := dbx.BeginTx(context.Background())+ locked2, unlock2 := dbx.TryLock(ctx, trx2, "KEY_2")+ defer trx2.MustRollback()Expect(locked1).IsTrue()Expect(unlock1).IsNotNil()diff --git a/app/services/sqlstore/postgres/notification.go b/app/services/sqlstore/postgres/notification.goindex 30d178175..cac4414f8 100644--- a/app/services/sqlstore/postgres/notification.go+++ b/app/services/sqlstore/postgres/notification.go@@ -3,6 +3,7 @@ package postgresimport ("context""fmt"+ "strings""time""github.com/getfider/fider/app/models/cmd"@@ -181,8 +182,15 @@ func getActiveSubscribers(ctx context.Context, q *query.GetActiveSubscribers) ererr error)+ // When searching for email subscrivers, skip users with email supressed+ supressionCondition := ""+ if q.Channel == enum.NotificationChannelEmail {+ supressionCondition = "AND u.email_supressed_at IS NULL"+ }++ // If the event doesn't require a subscription, notify everyoneif len(q.Event.RequiresSubscriptionUserRoles) == 0 {- err = trx.Select(&users, `+ err = trx.Select(&users, fmt.Sprintf(`SELECT DISTINCT u.id, u.name, u.email, u.tenant_id, u.role, u.statusFROM users uLEFT JOIN user_settings set@@ -191,11 +199,12 @@ func getActiveSubscribers(ctx context.Context, q *query.GetActiveSubscribers) erAND set.key = $1WHERE u.tenant_id = $2AND u.status = $5+ %sAND ((set.value IS NULL AND u.role = ANY($3))OR CAST(set.value AS integer) & $4 > 0)- ORDER by u.id`,+ ORDER by u.id`, supressionCondition),q.Event.UserSettingsKeyName,tenant.ID,pq.Array(q.Event.DefaultEnabledUserRoles),@@ -203,7 +212,8 @@ func getActiveSubscribers(ctx context.Context, q *query.GetActiveSubscribers) erenum.UserActive,)} else {- err = trx.Select(&users, `+ // If the event requires a subscription, notify only those who subscribed+ err = trx.Select(&users, fmt.Sprintf(`SELECT DISTINCT u.id, u.name, u.email, u.tenant_id, u.role, u.statusFROM users uLEFT JOIN post_subscribers sub@@ -216,12 +226,13 @@ func getActiveSubscribers(ctx context.Context, q *query.GetActiveSubscribers) erAND set.tenant_id = u.tenant_idWHERE u.tenant_id = $4AND u.status = $8+ %sAND ( sub.status = $2 OR (sub.status IS NULL AND NOT u.role = ANY($7)) )AND ((set.value IS NULL AND u.role = ANY($5))OR CAST(set.value AS integer) & $6 > 0)- ORDER by u.id`,+ ORDER by u.id`, supressionCondition),q.Number,enum.SubscriberActive,q.Event.UserSettingsKeyName,@@ -261,3 +272,15 @@ func internalAddSubscriber(trx *dbx.Trx, post *entity.Post, tenant *entity.Tenan}return nil}++func supressEmail(ctx context.Context, c *cmd.SupressEmail) error {+ return using(ctx, func(trx *dbx.Trx, tenant *entity.Tenant, user *entity.User) error {+ cmd := "UPDATE users SET email_supressed_at = $1 WHERE email = ANY($2) AND email_supressed_at IS NULL"+ rowsCount, err := trx.Execute(cmd, time.Now(), pq.Array(c.EmailAddresses))+ if err != nil {+ return errors.Wrap(err, "failed to update supress email: %s", strings.Join(c.EmailAddresses, ","))+ }+ c.NumOfSupressedEmailAddresses = int(rowsCount)+ return nil+ })+}diff --git a/app/services/sqlstore/postgres/notifications_test.go b/app/services/sqlstore/postgres/notifications_test.goindex cd59b1775..b37fa92a2 100644--- a/app/services/sqlstore/postgres/notifications_test.go+++ b/app/services/sqlstore/postgres/notifications_test.go@@ -178,6 +178,7 @@ func TestNotificationStorage_PurgeExpiredNotifications(t *testing.T) {trx.MustCommit()purgeCommand := &cmd.PurgeExpiredNotifications{}- bus.Publish(context.Background(), purgeCommand)+ err = bus.Dispatch(context.Background(), purgeCommand)+ Expect(err).IsNil()Expect(purgeCommand.NumOfDeletedNotifications).Equals(2)}diff --git a/app/services/sqlstore/postgres/postgres.go b/app/services/sqlstore/postgres/postgres.goindex 7d4095087..898078e10 100644--- a/app/services/sqlstore/postgres/postgres.go+++ b/app/services/sqlstore/postgres/postgres.go@@ -41,6 +41,7 @@ func (s Service) Init() {bus.AddHandler(addNewNotification)bus.AddHandler(addSubscriber)bus.AddHandler(removeSubscriber)+ bus.AddHandler(supressEmail)bus.AddHandler(getActiveSubscribers)bus.AddHandler(getTagBySlug)diff --git a/app/services/sqlstore/postgres/subscription_test.go b/app/services/sqlstore/postgres/subscription_test.goindex bea2a6f45..632281596 100644--- a/app/services/sqlstore/postgres/subscription_test.go+++ b/app/services/sqlstore/postgres/subscription_test.go@@ -315,3 +315,40 @@ func TestSubscription_SubscribedToDifferentPost(t *testing.T) {Expect(q.Result).HasLen(1)Expect(q.Result[0].ID).Equals(jonSnow.ID)}++func TestSubscription_EmailSupressed(t *testing.T) {+ SetupDatabaseTest(t)+ defer TeardownDatabaseTest()++ // Enable email notifications for new comments+ err := bus.Dispatch(aryaStarkCtx, &cmd.UpdateCurrentUserSettings{+ Settings: map[string]string{+ enum.NotificationEventNewComment.UserSettingsKeyName: strconv.Itoa(int(enum.NotificationChannelEmail)),+ },+ })+ Expect(err).IsNil()++ newPost1 := &cmd.AddNewPost{Title: "Post #1", Description: "Description #1"}+ err = bus.Dispatch(aryaStarkCtx, newPost1)+ Expect(err).IsNil()++ err = bus.Dispatch(aryaStarkCtx, &cmd.AddSubscriber{Post: newPost1.Result, User: aryaStark})+ Expect(err).IsNil()++ q := &query.GetActiveSubscribers{Number: newPost1.Result.Number, Channel: enum.NotificationChannelEmail, Event: enum.NotificationEventNewComment}+ err = bus.Dispatch(aryaStarkCtx, q)+ Expect(err).IsNil()+ Expect(q.Result).HasLen(2)+ Expect(q.Result[0].ID).Equals(jonSnow.ID)+ Expect(q.Result[1].ID).Equals(aryaStark.ID)++ //Supress the email and verify that AryaStark is not an active subscriber anymore+ err = bus.Dispatch(aryaStarkCtx, &cmd.SupressEmail{EmailAddresses: []string{aryaStark.Email}})+ Expect(err).IsNil()++ q = &query.GetActiveSubscribers{Number: newPost1.Result.Number, Channel: enum.NotificationChannelEmail, Event: enum.NotificationEventNewComment}+ err = bus.Dispatch(aryaStarkCtx, q)+ Expect(err).IsNil()+ Expect(q.Result).HasLen(1)+ Expect(q.Result[0].ID).Equals(jonSnow.ID)+}diff --git a/app/services/sqlstore/postgres/user.go b/app/services/sqlstore/postgres/user.goindex 8f836eab5..80866038a 100644--- a/app/services/sqlstore/postgres/user.go+++ b/app/services/sqlstore/postgres/user.go@@ -214,7 +214,7 @@ func changeUserRole(ctx context.Context, c *cmd.ChangeUserRole) error {func changeUserEmail(ctx context.Context, c *cmd.ChangeUserEmail) error {return using(ctx, func(trx *dbx.Trx, tenant *entity.Tenant, user *entity.User) error {- cmd := "UPDATE users SET email = $3 WHERE id = $1 AND tenant_id = $2"+ cmd := "UPDATE users SET email = $3, email_supressed_at = NULL WHERE id = $1 AND tenant_id = $2"_, err := trx.Execute(cmd, c.UserID, tenant.ID, strings.ToLower(c.Email))if err != nil {return errors.Wrap(err, "failed to update user's email")diff --git a/migrations/202198052023_email_supressed_at.sql b/migrations/202198052023_email_supressed_at.sqlnew file mode 100644index 000000000..e0e087fbf--- /dev/null+++ b/migrations/202198052023_email_supressed_at.sql@@ -0,0 +1 @@+ALTER TABLE users ADD email_supressed_at TIMESTAMPTZ NULL;\ No newline at end of file