Files
mostlymatter/config/feature_flags.go
Christopher Speller 1aadd36644 MM-28859 Add feature flag managment system using split.io and remove viper. (#15954)
* Add feature flag managment system using split.io and remove viper.

* Fixing tests.

* Attempt to fix postgres tests.

* Fix watch filepath for advanced logging.

* Review fixes.

* Some error wrapping.

* Remove unessisary store interface.

* Desanitize SplitKey

* Simplify.

* Review feedback.

* Rename split mlog adatper to split logger.

* fsInner

* Style.

* Restore oldcfg test.

* Downgrading non-actionable feature flag errors to warnings.

Co-authored-by: Mattermod <mattermod@users.noreply.github.com>
2020-10-29 15:54:39 -07:00

100 строки
3.0 KiB
Go

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
package config
import (
"math"
"reflect"
"github.com/mattermost/mattermost-server/v5/mlog"
"github.com/mattermost/mattermost-server/v5/model"
"github.com/pkg/errors"
"github.com/splitio/go-client/v6/splitio/client"
"github.com/splitio/go-client/v6/splitio/conf"
)
type FeatureFlagSyncParams struct {
ServerID string
SplitKey string
SyncIntervalSeconds int
Log *mlog.Logger
}
type FeatureFlagSynchronizer struct {
FeatureFlagSyncParams
client *client.SplitClient
stop chan struct{}
stopped chan struct{}
}
var featureNames = getStructFields(model.FeatureFlags{})
func NewFeatureFlagSynchronizer(params FeatureFlagSyncParams) (*FeatureFlagSynchronizer, error) {
cfg := conf.Default()
if params.Log != nil {
cfg.Logger = &splitLogger{wrappedLog: params.Log.With(mlog.String("service", "split"))}
} else {
cfg.LoggerConfig.LogLevel = math.MinInt32
}
factory, err := client.NewSplitFactory(params.SplitKey, cfg)
if err != nil {
return nil, errors.Wrap(err, "unable to create split factory")
}
return &FeatureFlagSynchronizer{
FeatureFlagSyncParams: params,
client: factory.Client(),
stop: make(chan struct{}),
stopped: make(chan struct{}),
}, nil
}
// ensureReady blocks until the syncronizer is ready to update feature flag values
func (f *FeatureFlagSynchronizer) EnsureReady() error {
if err := f.client.BlockUntilReady(10); err != nil {
return errors.Wrap(err, "split.io client could not initalize")
}
return nil
}
func (f *FeatureFlagSynchronizer) UpdateFeatureFlagValues(base model.FeatureFlags) model.FeatureFlags {
featuresMap := f.client.Treatments(f.ServerID, featureNames, nil)
ffm := featureFlagsFromMap(featuresMap, base)
return ffm
}
func (f *FeatureFlagSynchronizer) Close() {
f.client.Destroy()
}
// featureFlagsFromMap sets the feature flags from a map[string]string.
// It starts with baseFeatureFlags and only sets values that are
// given by the upstream management system.
// Makes the assumption that all feature flags are strings for now.
func featureFlagsFromMap(featuresMap map[string]string, baseFeatureFlags model.FeatureFlags) model.FeatureFlags {
refStruct := reflect.ValueOf(&baseFeatureFlags).Elem()
for fieldName, fieldValue := range featuresMap {
refField := refStruct.FieldByName(fieldName)
// "control" is returned by split.io if the treatment is not found, in this case we should use the default value.
if !refField.IsValid() || !refField.CanSet() || fieldValue == "control" {
continue
}
refField.Set(reflect.ValueOf(fieldValue))
}
return baseFeatureFlags
}
func getStructFields(s interface{}) []string {
structType := reflect.TypeOf(s)
fieldNames := make([]string, 0, structType.NumField())
for i := 0; i < structType.NumField(); i++ {
fieldNames = append(fieldNames, structType.Field(i).Name)
}
return fieldNames
}