[MM-32390] Config logic refactor (#17578)

* Replace config generator

* Cleanup

* Some renaming and docs additions to add clarity

* Cleanup logging related methods

* Cleanup emitter

* Fix TestDefaultsGenerator

* Move feature flags synchronization logic out of config package

* Remove unnecessary util functions

* Simplify load/set logic

* Refine semantics and add some test to cover them

* Remove unnecessary deep copies

* Improve logic further

* Fix license header

* Review file store tests

* Fix test

* Fix test

* Avoid additional write during initialization

* More consistent naming

* Update app/feature_flags.go

Co-authored-by: Christopher Speller <crspeller@gmail.com>

* Update config/store.go

Co-authored-by: Christopher Speller <crspeller@gmail.com>

* Update config/store.go

Co-authored-by: Christopher Speller <crspeller@gmail.com>

* Update config/store.go

Co-authored-by: Ibrahim Serdar Acikgoz <serdaracikgoz86@gmail.com>

* Move FF synchronizer to its own package

* Remove unidiomatic use of sync.Once

* Add some comments

* Rename function

* More comment

Co-authored-by: Christopher Speller <crspeller@gmail.com>
Co-authored-by: Ibrahim Serdar Acikgoz <serdaracikgoz86@gmail.com>
Этот коммит содержится в:
Claudio Costa
2021-05-19 13:30:26 +02:00
коммит произвёл GitHub
родитель b810a40062
Коммит 3681cd3688
37 изменённых файлов: 819 добавлений и 668 удалений

Просмотреть файл

@@ -1,7 +1,7 @@
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
package config_test
package config
import (
"bytes"
@@ -16,7 +16,6 @@ import (
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/mattermost/mattermost-server/v5/config"
"github.com/mattermost/mattermost-server/v5/model"
)
@@ -35,11 +34,11 @@ func setupConfigDatabase(t *testing.T, cfg *model.Config, files map[string][]byt
os.Clearenv()
truncateTables(t)
cfgData, err := config.MarshalConfig(cfg)
cfgData, err := marshalConfig(cfg)
require.NoError(t, err)
db := sqlx.NewDb(mainHelper.GetSQLStore().GetMaster().Db, *mainHelper.GetSQLSettings().DriverName)
err = config.InitializeConfigurationsTable(db)
err = initializeConfigurationsTable(db)
require.NoError(t, err)
id := model.NewId()
@@ -115,14 +114,14 @@ func assertDatabaseNotEqualsConfig(t *testing.T, expectedCfg *model.Config) {
assert.NotEqual(t, expectedCfg, actualCfg)
}
func newTestDatabaseStore(customDefaults *model.Config) (*config.Store, error) {
func newTestDatabaseStore(customDefaults *model.Config) (*Store, error) {
sqlSettings := mainHelper.GetSQLSettings()
dss, err := config.NewDatabaseStore(getDsn(*sqlSettings.DriverName, *sqlSettings.DataSource))
dss, err := NewDatabaseStore(getDsn(*sqlSettings.DriverName, *sqlSettings.DataSource))
if err != nil {
return nil, err
}
cStore, err := config.NewStoreFromBacking(dss, customDefaults, false)
cStore, err := NewStoreFromBacking(dss, customDefaults, false)
if err != nil {
return nil, err
}
@@ -211,20 +210,20 @@ func TestDatabaseStoreNew(t *testing.T) {
})
t.Run("invalid url", func(t *testing.T) {
_, err := config.NewDatabaseStore("")
_, err := NewDatabaseStore("")
require.Error(t, err)
_, err = config.NewDatabaseStore("mysql")
_, err = NewDatabaseStore("mysql")
require.Error(t, err)
})
t.Run("unsupported scheme", func(t *testing.T) {
_, err := config.NewDatabaseStore("invalid")
_, err := NewDatabaseStore("invalid")
require.Error(t, err)
})
t.Run("unsupported scheme with valid data source", func(t *testing.T) {
_, err := config.NewDatabaseStore(fmt.Sprintf("invalid://%s", *sqlSettings.DataSource))
_, err := NewDatabaseStore(fmt.Sprintf("invalid://%s", *sqlSettings.DataSource))
require.Error(t, err)
})
}
@@ -452,7 +451,7 @@ func TestDatabaseStoreSet(t *testing.T) {
defer ds.Close()
newCfg := &model.Config{}
newCfg.LdapSettings.BindPassword = sToP(model.FAKE_SETTING)
newCfg.LdapSettings.BindPassword = model.NewString(model.FAKE_SETTING)
_, err = ds.Set(newCfg)
require.NoError(t, err)
@@ -469,7 +468,7 @@ func TestDatabaseStoreSet(t *testing.T) {
defer ds.Close()
newCfg := &model.Config{}
newCfg.ServiceSettings.SiteURL = sToP("invalid")
newCfg.ServiceSettings.SiteURL = model.NewString("invalid")
_, err = ds.Set(newCfg)
if assert.Error(t, err) {
@@ -508,7 +507,7 @@ func TestDatabaseStoreSet(t *testing.T) {
newCfg := &model.Config{
ServiceSettings: model.ServiceSettings{
SiteURL: sToP("http://new"),
SiteURL: model.NewString("http://new"),
},
}
@@ -528,7 +527,7 @@ func TestDatabaseStoreSet(t *testing.T) {
newCfg := &model.Config{
ServiceSettings: model.ServiceSettings{
SiteURL: sToP("http://new"),
SiteURL: model.NewString("http://new"),
},
}
@@ -554,7 +553,7 @@ func TestDatabaseStoreSet(t *testing.T) {
_, err = db.Exec("DROP TABLE Configurations")
require.NoError(t, err)
newCfg := &model.Config{}
newCfg := minimalConfig
_, err = ds.Set(newCfg)
require.Error(t, err)
@@ -574,9 +573,9 @@ func TestDatabaseStoreSet(t *testing.T) {
require.NoError(t, err)
defer ds.Close()
longSiteURL := fmt.Sprintf("http://%s", strings.Repeat("a", config.MaxWriteLength))
longSiteURL := fmt.Sprintf("http://%s", strings.Repeat("a", MaxWriteLength))
newCfg := emptyConfig.Clone()
newCfg.ServiceSettings.SiteURL = sToP(longSiteURL)
newCfg.ServiceSettings.SiteURL = model.NewString(longSiteURL)
_, err = ds.Set(newCfg)
require.Error(t, err)
@@ -597,7 +596,7 @@ func TestDatabaseStoreSet(t *testing.T) {
}
ds.AddListener(callback)
newCfg := &model.Config{}
newCfg := minimalConfig
_, err = ds.Set(newCfg)
require.NoError(t, err)
@@ -616,7 +615,7 @@ func TestDatabaseStoreSet(t *testing.T) {
require.NoError(t, err)
defer ds.Close()
ds.PersistFeatures(false)
ds.SetReadOnlyFF(true)
_, err = ds.Set(minimalConfig)
require.NoError(t, err)
@@ -632,7 +631,7 @@ func TestDatabaseStoreSet(t *testing.T) {
require.NoError(t, err)
defer ds.Close()
ds.PersistFeatures(true)
ds.SetReadOnlyFF(false)
_, err = ds.Set(minimalConfig)
require.NoError(t, err)
@@ -828,7 +827,7 @@ func TestDatabaseStoreLoad(t *testing.T) {
require.NoError(t, err)
defer ds.Close()
cfgData, err := config.MarshalConfig(invalidConfig)
cfgData, err := marshalConfig(invalidConfig)
require.NoError(t, err)
sqlSettings := mainHelper.GetSQLSettings()
@@ -862,7 +861,7 @@ func TestDatabaseStoreLoad(t *testing.T) {
assert.Equal(t, "http://trailingslash", *ds.Get().ServiceSettings.SiteURL)
})
t.Run("listeners notifed", func(t *testing.T) {
t.Run("listeners notifed on change", func(t *testing.T) {
_, tearDown := setupConfigDatabase(t, emptyConfig, nil)
defer tearDown()
@@ -876,10 +875,16 @@ func TestDatabaseStoreLoad(t *testing.T) {
}
ds.AddListener(callback)
newCfg := minimalConfig.Clone()
dbStore, ok := ds.backingStore.(*DatabaseStore)
require.True(t, ok)
err = dbStore.persist(newCfg)
require.NoError(t, err)
err = ds.Load()
require.NoError(t, err)
require.True(t, wasCalled(called, 5*time.Second), "callback should have been called when config loaded")
require.True(t, wasCalled(called, 5*time.Second), "callback should have been called when config changed on load")
})
}
@@ -950,7 +955,7 @@ func TestDatabaseSetFile(t *testing.T) {
if *mainHelper.Settings.DriverName == "postgres" {
t.Skip("No limit for postgres")
}
longFile := bytes.Repeat([]byte("a"), config.MaxWriteLength)
longFile := bytes.Repeat([]byte("a"), MaxWriteLength)
err := ds.SetFile("toolong", longFile)
require.NoError(t, err)
@@ -960,7 +965,7 @@ func TestDatabaseSetFile(t *testing.T) {
if *mainHelper.Settings.DriverName == "postgres" {
t.Skip("No limit for postgres")
}
longFile := bytes.Repeat([]byte("a"), config.MaxWriteLength+1)
longFile := bytes.Repeat([]byte("a"), MaxWriteLength+1)
err := ds.SetFile("toolong", longFile)
if assert.Error(t, err) {