/
base_standard_manager.go
115 lines (98 loc) · 3.59 KB
/
base_standard_manager.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
package manager
import (
"context"
"encoding/json"
"errors"
"strings"
"github.com/go-playground/validator"
"github.com/gojek/turing/engines/experiment/pkg/request"
)
// BaseStandardExperimentManager provides dummy implementations for the optional
// StandardExperimentManager methods and can be composed into other concrete
// implementations of the interface to provide the base behavior.
type BaseStandardExperimentManager struct {
validate *validator.Validate
info Engine
}
func (em *BaseStandardExperimentManager) GetEngineInfo() (Engine, error) {
return em.info, nil
}
func (*BaseStandardExperimentManager) IsCacheEnabled() (bool, error) {
return true, nil
}
func (*BaseStandardExperimentManager) ListClients() ([]Client, error) {
return []Client{}, nil
}
func (*BaseStandardExperimentManager) ListExperiments() ([]Experiment, error) {
return []Experiment{}, nil
}
func (*BaseStandardExperimentManager) ListExperimentsForClient(Client) ([]Experiment, error) {
return []Experiment{}, nil
}
func (*BaseStandardExperimentManager) ListVariablesForClient(Client) ([]Variable, error) {
return []Variable{}, nil
}
func (*BaseStandardExperimentManager) ListVariablesForExperiments([]Experiment) (map[string][]Variable, error) {
return make(map[string][]Variable), nil
}
func (em *BaseStandardExperimentManager) ValidateExperimentConfig(cfg json.RawMessage) error {
engineCfg := em.info.StandardExperimentManagerConfig
if engineCfg == nil {
return errors.New("Missing Standard Engine configuration")
}
var experimentCfg TuringExperimentConfig
if err := json.Unmarshal(cfg, &experimentCfg); err != nil {
return err
}
if engineCfg.ExperimentSelectionEnabled {
// Check that there is at least 1 experiment
if len(experimentCfg.Experiments) < 1 {
return errors.New("Expected at least 1 experiment in the configuration")
}
// If Client Selection is enabled, check that the ClientID in each experiment matches the
// client info passed in
if engineCfg.ClientSelectionEnabled {
for _, e := range experimentCfg.Experiments {
if e.ClientID != experimentCfg.Client.ID {
return errors.New("Client information does not match with the experiment")
}
}
}
}
return em.validate.StructFilteredCtx(context.Background(), experimentCfg, func(ns []byte) bool {
// Determine the fields for validation
validateFields := []string{"TuringExperimentConfig.Variables"}
if engineCfg.ClientSelectionEnabled {
validateFields = append(validateFields, "TuringExperimentConfig.Client")
}
if engineCfg.ExperimentSelectionEnabled {
validateFields = append(validateFields, "TuringExperimentConfig.Experiments")
}
// If the field's fully qualified name starts with the name of any of the chosen fields,
// do not filter it from validation (return false will pick up the field for validation).
for _, field := range validateFields {
if strings.HasPrefix(string(ns), field) {
return false
}
}
return true
})
}
// NewBaseStandardExperimentManager is a constructor for the base experiment manager
func NewBaseStandardExperimentManager(info Engine) *BaseStandardExperimentManager {
return &BaseStandardExperimentManager{
info: info,
validate: newExperimentConfigValidator(),
}
}
// newExperimentConfigValidator returns a default validator for the TuringExperimentConfig
func newExperimentConfigValidator() *validator.Validate {
v := validator.New()
// Field Source validation for expected values
_ = v.RegisterValidation("field-src", func(fl validator.FieldLevel) bool {
stringSrc := fl.Field().String()
_, err := request.GetFieldSource(stringSrc)
return err == nil
})
return v
}