Open platform to collect and prioritize feedback
Add subscribers and automatically subscribe on new idea, vote and new comment (#260)
Guilherme Oenningc2e1940df782
diff --git a/app/models/feedback.go b/app/models/feedback.goindex 57724394c..9fd451398 100644--- a/app/models/feedback.go+++ b/app/models/feedback.go@@ -130,3 +130,55 @@ var (//IdeaDuplicate is used when the idea has already been posted beforeIdeaDuplicate = 5)++var (+ //SubscriberInactive means that the user cancelled the subscription+ SubscriberInactive = 0+ //SubscriberActive means that the subscription is active+ SubscriberActive = 1+)++//NotificationChannel represents the medium that the notification is sent+type NotificationChannel int++var (+ //NotificationChannelWeb is a in-app notification+ NotificationChannelWeb NotificationChannel = 1+ //NotificationChannelEmail is an e-mail notification+ NotificationChannelEmail NotificationChannel = 2+)++//NotificationEvent represents all possible notification events+type NotificationEvent struct {+ UserSettingsKeyName string+ DefaultEnabledUserRoles []Role+}++var (+ //NotificationEventNewIdea is triggered when a new idea is posted+ NotificationEventNewIdea = NotificationEvent{+ UserSettingsKeyName: "event_notification_new_idea",+ DefaultEnabledUserRoles: []Role{+ RoleAdministrator,+ RoleCollaborator,+ },+ }+ //NotificationEventNewComment is triggered when a new comment is posted+ NotificationEventNewComment = NotificationEvent{+ UserSettingsKeyName: "event_notification_new_comment",+ DefaultEnabledUserRoles: []Role{+ RoleAdministrator,+ RoleCollaborator,+ RoleVisitor,+ },+ }+ //NotificationEventChangeStatus is triggered when a new idea has its status changed+ NotificationEventChangeStatus = NotificationEvent{+ UserSettingsKeyName: "event_notification_change_status",+ DefaultEnabledUserRoles: []Role{+ RoleAdministrator,+ RoleCollaborator,+ RoleVisitor,+ },+ }+)diff --git a/app/storage/inmemory/idea.go b/app/storage/inmemory/idea.goindex 218f8bf83..2779186a8 100644--- a/app/storage/inmemory/idea.go+++ b/app/storage/inmemory/idea.go@@ -1,6 +1,7 @@package inmemoryimport (+ "fmt""time""github.com/gosimple/slug"@@ -14,6 +15,7 @@ type IdeaStorage struct {lastID intideas []*models.IdeaideasSupportedBy map[int][]int+ ideaSubscribers map[int][]inttenant *models.Tenantuser *models.User}@@ -23,6 +25,7 @@ func NewIdeaStorage() *IdeaStorage {return &IdeaStorage{ideas: make([]*models.Idea, 0),ideasSupportedBy: make(map[int][]int, 0),+ ideaSubscribers: make(map[int][]int, 0),}}@@ -199,3 +202,49 @@ func (s *IdeaStorage) MarkAsDuplicate(number, originalNumber, userID int) errorfunc (s *IdeaStorage) SupportedBy(userID int) ([]int, error) {return s.ideasSupportedBy[userID], nil}++// AddSubscriber adds user to the idea list of subscribers+func (s *IdeaStorage) AddSubscriber(number, userID int) error {+ idea, err := s.GetByNumber(number)+ if err != nil {+ return err+ }+ s.ideaSubscribers[idea.ID] = append(s.ideaSubscribers[idea.ID], userID)+ return nil+}++// RemoveSubscriber removes user from idea list of subscribers+func (s *IdeaStorage) RemoveSubscriber(number, userID int) error {+ idea, err := s.GetByNumber(number)+ if err != nil {+ return err+ }++ for i, id := range s.ideaSubscribers[idea.ID] {+ if id == userID {+ s.ideaSubscribers[idea.ID] = append(s.ideasSupportedBy[idea.ID][:i], s.ideasSupportedBy[idea.ID][i+1:]...)+ break+ }+ }+ return nil+}++// GetActiveSubscribers based on input and settings+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+ }+ subscribers, ok := s.ideaSubscribers[idea.ID]+ if ok {+ users := make([]*models.User, len(subscribers))+ for i, id := range subscribers {+ users[i] = &models.User{+ ID: id,+ Name: fmt.Sprintf("User %d", id),+ Email: fmt.Sprintf("user%[email protected]", id),+ }+ }+ }+ return make([]*models.User, 0), nil+}diff --git a/app/storage/inmemory/user.go b/app/storage/inmemory/user.goindex 7a705f27d..4c6349980 100644--- a/app/storage/inmemory/user.go+++ b/app/storage/inmemory/user.go@@ -111,3 +111,8 @@ func (s *UserStorage) ChangeEmail(userID int, email string) error {func (s *UserStorage) GetAll() ([]*models.User, error) {return s.users, nil}++// UpdateSettings of given user+func (s *UserStorage) UpdateSettings(userID int, settings map[string]string) error {+ return nil+}diff --git a/app/storage/postgres/idea.go b/app/storage/postgres/idea.goindex 37f2f5abd..dda4dec9f 100644--- a/app/storage/postgres/idea.go+++ b/app/storage/postgres/idea.go@@ -11,6 +11,7 @@ import ("github.com/getfider/fider/app/models""github.com/getfider/fider/app/pkg/dbx""github.com/gosimple/slug"+ "github.com/lib/pq")type dbIdea struct {@@ -319,7 +320,16 @@ func (s *IdeaStorage) Add(title, description string, userID int) (*models.Idea,return nil, err}- return s.GetByID(id)+ idea, err := s.GetByID(id)+ if err != nil {+ return nil, err+ }++ if err := s.internalAddSubscriber(idea.Number, userID, false); err != nil {+ return nil, err+ }++ return idea, nil}// AddComment places a new comment on an idea@@ -336,6 +346,10 @@ func (s *IdeaStorage) AddComment(number int, content string, userID int) (int, ereturn 0, err}+ if err := s.internalAddSubscriber(number, userID, false); err != nil {+ return 0, err+ }+return id, nil}@@ -363,7 +377,13 @@ func (s *IdeaStorage) AddSupporter(number, userID int) error {return err}- return s.trx.Execute(`INSERT INTO idea_supporters (user_id, idea_id, created_on) VALUES ($1, $2, $3)`, userID, idea.ID, time.Now())+ if err := s.trx.Execute(+ `INSERT INTO idea_supporters (user_id, idea_id, created_on) VALUES ($1, $2, $3) ON CONFLICT DO NOTHING`,+ userID, idea.ID, time.Now()); err != nil {+ return err+ }++ return s.internalAddSubscriber(number, userID, false)}// RemoveSupporter removes user from idea list of supporters@@ -393,6 +413,79 @@ func (s *IdeaStorage) RemoveSupporter(number, userID int) error {return s.trx.Execute(`DELETE FROM idea_supporters WHERE user_id = $1 AND idea_id = $2`, userID, idea.ID)}+// AddSubscriber adds user to the idea list of subscribers+func (s *IdeaStorage) AddSubscriber(number, userID int) error {+ return s.internalAddSubscriber(number, userID, true)+}++func (s *IdeaStorage) internalAddSubscriber(number, userID int, force bool) error {+ idea, err := s.GetByNumber(number)+ if err != nil {+ return err+ }++ conflict := " DO NOTHING"+ if force {+ conflict = "(user_id, idea_id) DO UPDATE SET status = $4, updated_on = $3"+ }++ return s.trx.Execute(fmt.Sprintf(`+ INSERT INTO idea_subscribers (user_id, idea_id, created_on, updated_on, status)+ VALUES ($1, $2, $3, $3, $4) ON CONFLICT %s`, conflict),+ userID, idea.ID, time.Now(), models.SubscriberActive,+ )+}++// RemoveSubscriber removes user from idea list of subscribers+func (s *IdeaStorage) RemoveSubscriber(number, userID int) error {+ idea, err := s.GetByNumber(number)+ if err != nil {+ return err+ }++ return s.trx.Execute(`+ INSERT INTO idea_subscribers (user_id, idea_id, created_on, updated_on, status)+ VALUES ($1, $2, $3, $3, 0) ON CONFLICT (user_id, idea_id)+ DO UPDATE SET status = 0, updated_on = $3`,+ userID, idea.ID, time.Now(),+ )+}++// GetActiveSubscribers based on input and settings+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+ }++ var users []*dbUser+ err = s.trx.Select(&users, `+ SELECT u.id, u.name, u.email, u.tenant_id, u.role+ FROM users u+ LEFT JOIN idea_subscribers sub+ ON sub.user_id = u.id+ AND sub.idea_id = $1+ LEFT JOIN user_settings set+ ON set.user_id = u.id+ AND set.key = $3+ WHERE u.tenant_id = $4+ AND (sub.status IS NULL OR sub.status = $2)+ AND (+ (set.value IS NULL AND u.role = ANY($5))+ OR CAST(set.value AS integer) & $6 > 0+ )+ `, idea.ID, models.SubscriberActive, event.UserSettingsKeyName, s.tenant.ID, pq.Array(event.DefaultEnabledUserRoles), channel)+ if err != nil {+ return nil, err+ }++ var result = make([]*models.User, len(users))+ for i, user := range users {+ result[i] = user.toModel()+ }+ return result, nil+}+// SetResponse changes current idea responsefunc (s *IdeaStorage) SetResponse(number int, text string, userID, status int) error {if status == models.IdeaDuplicate {diff --git a/app/storage/postgres/subscription_test.go b/app/storage/postgres/subscription_test.gonew file mode 100644index 000000000..1b3d148be--- /dev/null+++ b/app/storage/postgres/subscription_test.go@@ -0,0 +1,183 @@+package postgres_test++import (+ "strconv"+ "testing"++ "github.com/getfider/fider/app/models"++ . "github.com/onsi/gomega"+)++func TestSubscription_NoSettings(t *testing.T) {+ SetupDatabaseTest(t)+ defer TeardownDatabaseTest()++ ideas.SetCurrentTenant(demoTenant)+ idea1, _ := ideas.Add("Idea #1", "Description #1", aryaStark.ID)++ subscribers, err := ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelWeb, models.NotificationEventNewIdea)+ Expect(err).To(BeNil())+ Expect(len(subscribers)).To(Equal(1))+ Expect(subscribers[0].ID).To(Equal(jonSnow.ID))++ subscribers, err = ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelWeb, models.NotificationEventNewComment)+ Expect(err).To(BeNil())+ Expect(len(subscribers)).To(Equal(2))+ 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())+ Expect(len(subscribers)).To(Equal(2))+ Expect(subscribers[0].ID).To(Equal(jonSnow.ID))+ Expect(subscribers[1].ID).To(Equal(aryaStark.ID))+}++func TestSubscription_RemoveSubscriber(t *testing.T) {+ SetupDatabaseTest(t)+ defer TeardownDatabaseTest()++ ideas.SetCurrentTenant(demoTenant)+ idea1, _ := ideas.Add("Idea #1", "Description #1", aryaStark.ID)+ err := ideas.RemoveSubscriber(idea1.Number, aryaStark.ID)+ Expect(err).To(BeNil())++ subscribers, err := ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelWeb, models.NotificationEventNewIdea)+ Expect(err).To(BeNil())+ Expect(len(subscribers)).To(Equal(1))+ Expect(subscribers[0].ID).To(Equal(jonSnow.ID))++ subscribers, err = ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelWeb, models.NotificationEventNewComment)+ Expect(err).To(BeNil())+ Expect(len(subscribers)).To(Equal(1))+ Expect(subscribers[0].ID).To(Equal(jonSnow.ID))++ subscribers, err = ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelWeb, models.NotificationEventChangeStatus)+ Expect(err).To(BeNil())+ Expect(len(subscribers)).To(Equal(1))+ Expect(subscribers[0].ID).To(Equal(jonSnow.ID))+}++func TestSubscription_AdminSubmitted(t *testing.T) {+ SetupDatabaseTest(t)+ defer TeardownDatabaseTest()++ ideas.SetCurrentTenant(demoTenant)++ idea1, _ := ideas.Add("Idea #1", "Description #1", jonSnow.ID)++ subscribers, err := ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelWeb, models.NotificationEventNewIdea)+ Expect(err).To(BeNil())+ Expect(len(subscribers)).To(Equal(1))+ Expect(subscribers[0].ID).To(Equal(jonSnow.ID))++ subscribers, err = ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelWeb, models.NotificationEventNewComment)+ Expect(err).To(BeNil())+ Expect(len(subscribers)).To(Equal(2))+ 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())+ Expect(len(subscribers)).To(Equal(2))+ Expect(subscribers[0].ID).To(Equal(jonSnow.ID))+ Expect(subscribers[1].ID).To(Equal(aryaStark.ID))+}++func TestSubscription_DisabledEmail(t *testing.T) {+ SetupDatabaseTest(t)+ defer TeardownDatabaseTest()++ ideas.SetCurrentTenant(demoTenant)+ err := users.UpdateSettings(aryaStark.ID, map[string]string{+ models.NotificationEventNewComment.UserSettingsKeyName: strconv.Itoa(int(models.NotificationChannelWeb)),+ })+ Expect(err).To(BeNil())++ idea1, _ := ideas.Add("Idea #1", "Description #1", aryaStark.ID)++ subscribers, err := ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelWeb, models.NotificationEventNewComment)+ Expect(err).To(BeNil())+ Expect(len(subscribers)).To(Equal(2))+ Expect(subscribers[0].ID).To(Equal(jonSnow.ID))+ Expect(subscribers[1].ID).To(Equal(aryaStark.ID))++ subscribers, err = ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelEmail, models.NotificationEventNewComment)+ Expect(err).To(BeNil())+ Expect(len(subscribers)).To(Equal(1))+ Expect(subscribers[0].ID).To(Equal(jonSnow.ID))++ subscribers, err = ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelWeb, models.NotificationEventChangeStatus)+ Expect(err).To(BeNil())+ Expect(len(subscribers)).To(Equal(2))+ Expect(subscribers[0].ID).To(Equal(jonSnow.ID))+ Expect(subscribers[1].ID).To(Equal(aryaStark.ID))+}++func TestSubscription_VisitorEnabledNewIdea(t *testing.T) {+ SetupDatabaseTest(t)+ defer TeardownDatabaseTest()++ ideas.SetCurrentTenant(demoTenant)+ err := users.UpdateSettings(aryaStark.ID, map[string]string{+ models.NotificationEventNewIdea.UserSettingsKeyName: strconv.Itoa(int(models.NotificationChannelEmail | models.NotificationChannelWeb)),+ })+ Expect(err).To(BeNil())++ idea1, _ := ideas.Add("Idea #1", "Description #1", jonSnow.ID)++ subscribers, err := ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelWeb, models.NotificationEventNewIdea)+ Expect(err).To(BeNil())+ Expect(len(subscribers)).To(Equal(2))+ Expect(subscribers[0].ID).To(Equal(jonSnow.ID))+ Expect(subscribers[1].ID).To(Equal(aryaStark.ID))++ subscribers, err = ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelEmail, models.NotificationEventNewIdea)+ Expect(err).To(BeNil())+ Expect(len(subscribers)).To(Equal(2))+ Expect(subscribers[0].ID).To(Equal(jonSnow.ID))+ Expect(subscribers[1].ID).To(Equal(aryaStark.ID))+}++func TestSubscription_DisabledEverything(t *testing.T) {+ SetupDatabaseTest(t)+ defer TeardownDatabaseTest()++ ideas.SetCurrentTenant(demoTenant)+ disableAll := map[string]string{+ models.NotificationEventNewIdea.UserSettingsKeyName: "0",+ models.NotificationEventNewComment.UserSettingsKeyName: "0",+ models.NotificationEventChangeStatus.UserSettingsKeyName: "0",+ }+ err := users.UpdateSettings(jonSnow.ID, disableAll)+ Expect(err).To(BeNil())+ err = users.UpdateSettings(aryaStark.ID, disableAll)+ Expect(err).To(BeNil())++ idea1, _ := ideas.Add("Idea #1", "Description #1", jonSnow.ID)++ subscribers, err := ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelWeb, models.NotificationEventNewIdea)+ Expect(err).To(BeNil())+ Expect(len(subscribers)).To(Equal(0))++ subscribers, err = ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelWeb, models.NotificationEventNewComment)+ Expect(err).To(BeNil())+ Expect(len(subscribers)).To(Equal(0))++ subscribers, err = ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelWeb, models.NotificationEventChangeStatus)+ Expect(err).To(BeNil())+ Expect(len(subscribers)).To(Equal(0))++ subscribers, err = ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelEmail, models.NotificationEventNewIdea)+ Expect(err).To(BeNil())+ Expect(len(subscribers)).To(Equal(0))++ subscribers, err = ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelEmail, models.NotificationEventNewComment)+ Expect(err).To(BeNil())+ Expect(len(subscribers)).To(Equal(0))++ subscribers, err = ideas.GetActiveSubscribers(idea1.Number, models.NotificationChannelEmail, models.NotificationEventChangeStatus)+ Expect(err).To(BeNil())+ Expect(len(subscribers)).To(Equal(0))+}diff --git a/app/storage/postgres/user.go b/app/storage/postgres/user.goindex 9a6a7fdf0..322fc832c 100644--- a/app/storage/postgres/user.go+++ b/app/storage/postgres/user.go@@ -115,12 +115,31 @@ func (s *UserStorage) RegisterProvider(userID int, provider *models.UserProviderreturn s.trx.Execute(cmd, userID, provider.Name, provider.UID, time.Now())}-// Update user settings+// Update user profilefunc (s *UserStorage) Update(userID int, settings *models.UpdateUserSettings) error {cmd := "UPDATE users SET name = $2 WHERE id = $1"return s.trx.Execute(cmd, userID, settings.Name)}+// UpdateSettings of given user+func (s *UserStorage) UpdateSettings(userID int, settings map[string]string) error {+ if settings != nil && len(settings) > 0 {+ query := `+ INSERT INTO user_settings (user_id, key, value)+ VALUES ($1, $2, $3) ON CONFLICT (user_id, key) DO UPDATE SET value = $3+ `++ for key, value := range settings {+ err := s.trx.Execute(query, userID, key, value)+ if err != nil {+ return err+ }+ }+ }++ return nil+}+// ChangeRole of given userfunc (s *UserStorage) ChangeRole(userID int, role models.Role) error {cmd := "UPDATE users SET role = $3 WHERE id = $1 AND tenant_id = $2"diff --git a/app/storage/storage.go b/app/storage/storage.goindex eb6c17a86..01dd6041e 100644--- a/app/storage/storage.go+++ b/app/storage/storage.go@@ -26,6 +26,9 @@ type Idea interface {AddComment(number int, content string, userID int) (int, error)AddSupporter(number, userID int) errorRemoveSupporter(number, userID int) error+ AddSubscriber(number, userID int) error+ RemoveSubscriber(number, userID int) error+ GetActiveSubscribers(number int, channel models.NotificationChannel, event models.NotificationEvent) ([]*models.User, error)SetResponse(number int, text string, userID, status int) errorMarkAsDuplicate(number, originalNumber, userID int) errorSupportedBy(userID int) ([]int, error)@@ -43,6 +46,7 @@ type User interface {ChangeEmail(userID int, email string) errorChangeRole(userID int, role models.Role) errorGetAll() ([]*models.User, error)+ UpdateSettings(userID int, settings map[string]string) error}// Tenant contains read and write operations for tenantsdiff --git a/migrations/201802061858_create_notification_tables.up.sql b/migrations/201802061858_create_notification_tables.up.sqlnew file mode 100644index 000000000..efa480e0e--- /dev/null+++ b/migrations/201802061858_create_notification_tables.up.sql@@ -0,0 +1,20 @@+create table if not exists idea_subscribers (+ user_id int not null,+ idea_id int not null,+ created_on timestamptz not null default now(),+ updated_on timestamptz not null default now(),+ status smallint not null,+ primary key (user_id, idea_id),+ foreign key (idea_id) references ideas(id),+ foreign key (user_id) references users(id)+);++create table if not exists user_settings (+ id serial primary key,+ user_id int not null,+ key varchar(100) not null,+ value varchar(100) null,+ foreign key (user_id) references users(id)+);++create unique index user_settings_uq_key on user_settings (user_id, key);\ No newline at end of filediff --git a/migrations/201802071816_seed_subscribers_table.up.sql b/migrations/201802071816_seed_subscribers_table.up.sqlnew file mode 100644index 000000000..337e452f7--- /dev/null+++ b/migrations/201802071816_seed_subscribers_table.up.sql@@ -0,0 +1,8 @@+INSERT INTO idea_subscribers (user_id, idea_id, created_on, updated_on, status)+SELECT user_id, idea_id, created_on, created_on, 1 FROM idea_supporters ON CONFLICT DO NOTHING;++INSERT INTO idea_subscribers (user_id, idea_id, created_on, updated_on, status)+SELECT user_id, id, created_on, created_on, 1 FROM ideas ON CONFLICT DO NOTHING;++INSERT INTO idea_subscribers (user_id, idea_id, created_on, updated_on, status)+SELECT user_id, idea_id, created_on, created_on, 1 FROM comments ON CONFLICT DO NOTHING;\ No newline at end of file