From 79e9244dc9977c6ec6adc78631c0485efa9f60af Mon Sep 17 00:00:00 2001 From: Florian Orben Date: Fri, 13 Nov 2015 22:56:41 +0100 Subject: allow to toggle features in backend --- store/sql_preference_store.go | 47 +++++++++++++++++++++++++++++++++++++++++++ store/sql_store.go | 2 ++ store/store.go | 3 ++- 3 files changed, 51 insertions(+), 1 deletion(-) (limited to 'store') diff --git a/store/sql_preference_store.go b/store/sql_preference_store.go index 8454abcbd..63561a509 100644 --- a/store/sql_preference_store.go +++ b/store/sql_preference_store.go @@ -4,6 +4,7 @@ package store import ( + l4g "code.google.com/p/log4go" "github.com/go-gorp/gorp" "github.com/mattermost/platform/model" "github.com/mattermost/platform/utils" @@ -13,6 +14,10 @@ type SqlPreferenceStore struct { *SqlStore } +const ( + FEATURE_TOGGLE_PREFIX = "feature_enabled_" +) + func NewSqlPreferenceStore(sqlStore *SqlStore) PreferenceStore { s := &SqlPreferenceStore{sqlStore} @@ -36,6 +41,23 @@ func (s SqlPreferenceStore) CreateIndexesIfNotExists() { s.CreateIndexIfNotExists("idx_preferences_name", "Preferences", "Name") } +func (s SqlPreferenceStore) DeleteUnusedFeatures() { + l4g.Debug("Deleting any unused pre-release features") + + sql := `DELETE + FROM Preferences + WHERE + Category = :Category + AND Value = :Value + AND Name LIKE '` + FEATURE_TOGGLE_PREFIX + `%'` + + queryParams := map[string]string{ + "Category": "advanced_settings", + "Value": "false", + } + s.GetMaster().Exec(sql, queryParams) +} + func (s SqlPreferenceStore) Save(preferences *model.Preferences) StoreChannel { storeChannel := make(StoreChannel) @@ -257,3 +279,28 @@ func (s SqlPreferenceStore) PermanentDeleteByUser(userId string) StoreChannel { return storeChannel } + +func (s SqlPreferenceStore) FeatureToggle(feature, userId string) StoreChannel { + storeChannel := make(StoreChannel) + + go func() { + result := StoreResult{} + if value, err := s.GetReplica().SelectStr(`SELECT + value + FROM + Preferences + WHERE + UserId = :UserId + AND Category = :Category + AND Name = :Name`, map[string]interface{}{"UserId": userId, "Category": "advanced_settings", "Name": FEATURE_TOGGLE_PREFIX + feature}); err != nil { + result.Err = model.NewAppError("SqlPreferenceStore.featureToggle", "We encountered an error while finding a pre release feature preference", err.Error()) + } else { + result.Data = value == "true" + } + + storeChannel <- result + close(storeChannel) + }() + + return storeChannel +} diff --git a/store/sql_store.go b/store/sql_store.go index f348db10b..d17a3e8c3 100644 --- a/store/sql_store.go +++ b/store/sql_store.go @@ -148,6 +148,8 @@ func NewSqlStore() Store { sqlStore.webhook.(*SqlWebhookStore).CreateIndexesIfNotExists() sqlStore.preference.(*SqlPreferenceStore).CreateIndexesIfNotExists() + sqlStore.preference.(*SqlPreferenceStore).DeleteUnusedFeatures() + if model.IsPreviousVersion(schemaVersion) || isSchemaVersion07 || isSchemaVersion10 { sqlStore.system.Update(&model.System{Name: "Version", Value: model.CurrentVersion}) l4g.Warn("The database schema has been upgraded to version " + model.CurrentVersion) diff --git a/store/store.go b/store/store.go index 338ae186f..36d991a15 100644 --- a/store/store.go +++ b/store/store.go @@ -186,4 +186,5 @@ type PreferenceStore interface { GetCategory(userId string, category string) StoreChannel GetAll(userId string) StoreChannel PermanentDeleteByUser(userId string) StoreChannel -} + FeatureToggle(feature, userId string) StoreChannel +} \ No newline at end of file -- cgit v1.2.3-1-g7c22 From 82f86f7050a803fd5ffb7872d9773bcff0fa6b8c Mon Sep 17 00:00:00 2001 From: Florian Orben Date: Thu, 19 Nov 2015 17:54:01 +0100 Subject: go fmt --- store/store.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'store') diff --git a/store/store.go b/store/store.go index 36d991a15..ef7dcde3a 100644 --- a/store/store.go +++ b/store/store.go @@ -187,4 +187,4 @@ type PreferenceStore interface { GetAll(userId string) StoreChannel PermanentDeleteByUser(userId string) StoreChannel FeatureToggle(feature, userId string) StoreChannel -} \ No newline at end of file +} -- cgit v1.2.3-1-g7c22 From 192b606bc6da20b1148b14116de0a234814615c9 Mon Sep 17 00:00:00 2001 From: Florian Orben Date: Fri, 27 Nov 2015 02:20:06 +0100 Subject: add unit tests --- store/sql_preference_store.go | 4 +-- store/sql_preference_store_test.go | 63 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 65 insertions(+), 2 deletions(-) (limited to 'store') diff --git a/store/sql_preference_store.go b/store/sql_preference_store.go index 63561a509..09546c872 100644 --- a/store/sql_preference_store.go +++ b/store/sql_preference_store.go @@ -52,7 +52,7 @@ func (s SqlPreferenceStore) DeleteUnusedFeatures() { AND Name LIKE '` + FEATURE_TOGGLE_PREFIX + `%'` queryParams := map[string]string{ - "Category": "advanced_settings", + "Category": model.PREFERENCE_CATEGORY_ADVANCED_SETTINGS, "Value": "false", } s.GetMaster().Exec(sql, queryParams) @@ -292,7 +292,7 @@ func (s SqlPreferenceStore) FeatureToggle(feature, userId string) StoreChannel { WHERE UserId = :UserId AND Category = :Category - AND Name = :Name`, map[string]interface{}{"UserId": userId, "Category": "advanced_settings", "Name": FEATURE_TOGGLE_PREFIX + feature}); err != nil { + AND Name = :Name`, map[string]interface{}{"UserId": userId, "Category": model.PREFERENCE_CATEGORY_ADVANCED_SETTINGS, "Name": FEATURE_TOGGLE_PREFIX + feature}); err != nil { result.Err = model.NewAppError("SqlPreferenceStore.featureToggle", "We encountered an error while finding a pre release feature preference", err.Error()) } else { result.Data = value == "true" diff --git a/store/sql_preference_store_test.go b/store/sql_preference_store_test.go index 77da71fd6..5aed7dba3 100644 --- a/store/sql_preference_store_test.go +++ b/store/sql_preference_store_test.go @@ -232,3 +232,66 @@ func TestPreferenceDelete(t *testing.T) { t.Fatal(result.Err) } } + +func TestDeleteUnusedFeatures(t *testing.T) { + Setup() + + userId1 := model.NewId() + userId2 := model.NewId() + category := model.PREFERENCE_CATEGORY_ADVANCED_SETTINGS + feature1 := "feature1" + feature2 := "feature2" + + features := model.Preferences{ + { + UserId: userId1, + Category: category, + Name: FEATURE_TOGGLE_PREFIX + feature1, + Value: "true", + }, + { + UserId: userId2, + Category: category, + Name: FEATURE_TOGGLE_PREFIX + feature1, + Value: "false", + }, + { + UserId: userId1, + Category: category, + Name: FEATURE_TOGGLE_PREFIX + feature2, + Value: "false", + }, + { + UserId: userId2, + Category: category, + Name: FEATURE_TOGGLE_PREFIX + feature2, + Value: "true", + }, + } + + Must(store.Preference().Save(&features)) + + store.(*SqlStore).preference.(*SqlPreferenceStore).DeleteUnusedFeatures() + + //make sure features with value "false" have actually been deleted from the database + if val, err := store.(*SqlStore).preference.(*SqlPreferenceStore).GetReplica().SelectInt(`SELECT COUNT(*) + FROM Preferences + WHERE Category = :Category + AND Value = :Val + AND Name LIKE '`+FEATURE_TOGGLE_PREFIX+`%'`, map[string]interface{}{"Category": model.PREFERENCE_CATEGORY_ADVANCED_SETTINGS, "Val": "false"}); err != nil { + t.Fatal(err) + } else if val != 0 { + t.Fatalf("Found %d features with value 'false', expected all to be deleted", val) + } + // + // make sure features with value "true" remain saved + if val, err := store.(*SqlStore).preference.(*SqlPreferenceStore).GetReplica().SelectInt(`SELECT COUNT(*) + FROM Preferences + WHERE Category = :Category + AND Value = :Val + AND Name LIKE '`+FEATURE_TOGGLE_PREFIX+`%'`, map[string]interface{}{"Category": model.PREFERENCE_CATEGORY_ADVANCED_SETTINGS, "Val": "true"}); err != nil { + t.Fatal(err) + } else if val == 0 { + t.Fatalf("Found %d features with value 'true', expected to find at least %d features", val, 2) + } +} -- cgit v1.2.3-1-g7c22 From 61a35066b64085d264fbd049e2a57f70125ca65a Mon Sep 17 00:00:00 2001 From: Florian Orben Date: Fri, 27 Nov 2015 23:16:56 +0100 Subject: rename 'featureToggle' to 'isFeatureEnable' and move definition of available prerelease-features to constants.jsx --- store/sql_preference_store.go | 4 ++-- store/store.go | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) (limited to 'store') diff --git a/store/sql_preference_store.go b/store/sql_preference_store.go index 09546c872..f73dad3ac 100644 --- a/store/sql_preference_store.go +++ b/store/sql_preference_store.go @@ -280,7 +280,7 @@ func (s SqlPreferenceStore) PermanentDeleteByUser(userId string) StoreChannel { return storeChannel } -func (s SqlPreferenceStore) FeatureToggle(feature, userId string) StoreChannel { +func (s SqlPreferenceStore) IsFeatureEnabled(feature, userId string) StoreChannel { storeChannel := make(StoreChannel) go func() { @@ -293,7 +293,7 @@ func (s SqlPreferenceStore) FeatureToggle(feature, userId string) StoreChannel { UserId = :UserId AND Category = :Category AND Name = :Name`, map[string]interface{}{"UserId": userId, "Category": model.PREFERENCE_CATEGORY_ADVANCED_SETTINGS, "Name": FEATURE_TOGGLE_PREFIX + feature}); err != nil { - result.Err = model.NewAppError("SqlPreferenceStore.featureToggle", "We encountered an error while finding a pre release feature preference", err.Error()) + result.Err = model.NewAppError("SqlPreferenceStore.IsFeatureEnabled", "We encountered an error while finding a pre release feature preference", err.Error()) } else { result.Data = value == "true" } diff --git a/store/store.go b/store/store.go index ef7dcde3a..0695ea27f 100644 --- a/store/store.go +++ b/store/store.go @@ -186,5 +186,5 @@ type PreferenceStore interface { GetCategory(userId string, category string) StoreChannel GetAll(userId string) StoreChannel PermanentDeleteByUser(userId string) StoreChannel - FeatureToggle(feature, userId string) StoreChannel + IsFeatureEnabled(feature, userId string) StoreChannel } -- cgit v1.2.3-1-g7c22 From c50144de0475da2c5865cb4246f63d285aa452c4 Mon Sep 17 00:00:00 2001 From: Florian Orben Date: Fri, 27 Nov 2015 23:17:26 +0100 Subject: add missing unit test --- store/sql_preference_store_test.go | 72 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) (limited to 'store') diff --git a/store/sql_preference_store_test.go b/store/sql_preference_store_test.go index 5aed7dba3..6f8f44f47 100644 --- a/store/sql_preference_store_test.go +++ b/store/sql_preference_store_test.go @@ -233,6 +233,78 @@ func TestPreferenceDelete(t *testing.T) { } } +func TestIsFeatureEnabled(t *testing.T) { + Setup() + + feature1 := "testFeat1" + feature2 := "testFeat2" + feature3 := "testFeat3" + + userId := model.NewId() + category := model.PREFERENCE_CATEGORY_ADVANCED_SETTINGS + + features := model.Preferences{ + { + UserId: userId, + Category: category, + Name: FEATURE_TOGGLE_PREFIX + feature1, + Value: "true", + }, + { + UserId: userId, + Category: category, + Name: model.NewId(), + Value: "false", + }, + { + UserId: userId, + Category: model.NewId(), + Name: FEATURE_TOGGLE_PREFIX + feature1, + Value: "false", + }, + { + UserId: model.NewId(), + Category: category, + Name: FEATURE_TOGGLE_PREFIX + feature2, + Value: "false", + }, + { + UserId: model.NewId(), + Category: category, + Name: FEATURE_TOGGLE_PREFIX + feature3, + Value: "foobar", + }, + } + + Must(store.Preference().Save(&features)) + + if result := <-store.Preference().IsFeatureEnabled(feature1, userId); result.Err != nil { + t.Fatal(result.Err) + } else if data := result.Data.(bool); data != true { + t.Fatalf("got incorrect setting for feature1, %v=%v", true, data) + } + + if result := <-store.Preference().IsFeatureEnabled(feature2, userId); result.Err != nil { + t.Fatal(result.Err) + } else if data := result.Data.(bool); data != false { + t.Fatalf("got incorrect setting for feature2, %v=%v", false, data) + } + + // make sure we get false if something different than "true" or "false" has been saved to database + if result := <-store.Preference().IsFeatureEnabled(feature3, userId); result.Err != nil { + t.Fatal(result.Err) + } else if data := result.Data.(bool); data != false { + t.Fatalf("got incorrect setting for feature3, %v=%v", false, data) + } + + // make sure false is returned if a non-existent feature is queried + if result := <-store.Preference().IsFeatureEnabled("someOtherFeature", userId); result.Err != nil { + t.Fatal(result.Err) + } else if data := result.Data.(bool); data != false { + t.Fatalf("got incorrect setting for non-existent feature 'someOtherFeature', %v=%v", false, data) + } +} + func TestDeleteUnusedFeatures(t *testing.T) { Setup() -- cgit v1.2.3-1-g7c22