eval

Documentation

Index

• Constants
• type AnyValue
  • func NewAnyValue(value interface{}, variant string, reason string, flagKey string) AnyValue
• type Evaluators
• type Flag
• type Flags
  • func (f Flags) Merge(logger *logger.Logger, source string, ff Flags) (Flags, map[string]interface{})
• type IEvaluator
• type JSONEvaluator
  • func NewJSONEvaluator(logger *logger.Logger) *JSONEvaluator
  • func (je *JSONEvaluator) GetState() (string, error)
  • func (je *JSONEvaluator) ResolveAllValues(reqID string, context *structpb.Struct) []AnyValue
  • func (je *JSONEvaluator) ResolveBooleanValue(reqID string, flagKey string, context *structpb.Struct) (value bool, variant string, reason string, err error)
  • func (je *JSONEvaluator) ResolveFloatValue(reqID string, flagKey string, context *structpb.Struct) (value float64, variant string, reason string, err error)
  • func (je *JSONEvaluator) ResolveIntValue(reqID string, flagKey string, context *structpb.Struct) (value int64, variant string, reason string, err error)
  • func (je *JSONEvaluator) ResolveObjectValue(reqID string, flagKey string, context *structpb.Struct) (value map[string]any, variant string, reason string, err error)
  • func (je *JSONEvaluator) ResolveStringValue(reqID string, flagKey string, context *structpb.Struct) (value string, variant string, reason string, err error)
  • func (je *JSONEvaluator) SetState(source string, state string) (map[string]interface{}, error)
• type StateChangeNotification
• type StateChangeNotificationType

Constants

const (
	Disabled = "DISABLED"
)

Types

type AnyValue

type AnyValue struct {
	Value   interface{}
	Variant string
	Reason  string
	FlagKey string
}

func NewAnyValue

func NewAnyValue(value interface{}, variant string, reason string, flagKey string) AnyValue

type Evaluators

type Evaluators struct {
	Evaluators map[string]json.RawMessage `json:"$evaluators"`
}

type Flag

type Flag struct {
	State          string          `json:"state"`
	DefaultVariant string          `json:"defaultVariant"`
	Variants       map[string]any  `json:"variants"`
	Targeting      json.RawMessage `json:"targeting,omitempty"`
	Source         string          `json:"source"`
}

type Flags

type Flags struct {
	Flags map[string]Flag `json:"flags"`
}

func (Flags) Merge

func (f Flags) Merge(logger *logger.Logger, source string, ff Flags) (Flags, map[string]interface{})

type IEvaluator

type IEvaluator interface {
	GetState() (string, error)
	SetState(source string, state string) (map[string]interface{}, error)

	ResolveBooleanValue(
		reqID string,
		flagKey string,
		context *structpb.Struct) (value bool, variant string, reason string, err error)
	ResolveStringValue(
		reqID string,
		flagKey string,
		context *structpb.Struct) (value string, variant string, reason string, err error)
	ResolveIntValue(
		reqID string,
		flagKey string,
		context *structpb.Struct) (value int64, variant string, reason string, err error)
	ResolveFloatValue(
		reqID string,
		flagKey string,
		context *structpb.Struct) (value float64, variant string, reason string, err error)
	ResolveObjectValue(
		reqID string,
		flagKey string,
		context *structpb.Struct) (value map[string]any, variant string, reason string, err error)
	ResolveAllValues(
		reqID string,
		context *structpb.Struct) (values []AnyValue)
}

IEvaluator implementations store the state of the flags, do parsing and validation of the flag state and evaluate flags in response to handlers.

type JSONEvaluator

type JSONEvaluator struct {
	Logger *logger.Logger
	// contains filtered or unexported fields
}

func NewJSONEvaluator

func NewJSONEvaluator(logger *logger.Logger) *JSONEvaluator

func (*JSONEvaluator) GetState

func (je *JSONEvaluator) GetState() (string, error)

func (*JSONEvaluator) ResolveAllValues

func (je *JSONEvaluator) ResolveAllValues(reqID string, context *structpb.Struct) []AnyValue

func (*JSONEvaluator) ResolveBooleanValue

func (je *JSONEvaluator) ResolveBooleanValue(reqID string, flagKey string, context *structpb.Struct) (
	value bool,
	variant string,
	reason string,
	err error,
)

func (*JSONEvaluator) ResolveFloatValue

func (je *JSONEvaluator) ResolveFloatValue(reqID string, flagKey string, context *structpb.Struct) (
	value float64,
	variant string,
	reason string,
	err error,
)

func (*JSONEvaluator) ResolveIntValue

func (je *JSONEvaluator) ResolveIntValue(reqID string, flagKey string, context *structpb.Struct) (
	value int64,
	variant string,
	reason string,
	err error,
)

func (*JSONEvaluator) ResolveObjectValue

func (je *JSONEvaluator) ResolveObjectValue(reqID string, flagKey string, context *structpb.Struct) (
	value map[string]any,
	variant string,
	reason string,
	err error,
)

func (*JSONEvaluator) ResolveStringValue

func (je *JSONEvaluator) ResolveStringValue(reqID string, flagKey string, context *structpb.Struct) (
	value string,
	variant string,
	reason string,
	err error,
)

func (*JSONEvaluator) SetState

func (je *JSONEvaluator) SetState(source string, state string) (map[string]interface{}, error)

type StateChangeNotification

type StateChangeNotification struct {
	Type    StateChangeNotificationType `json:"type"`
	Source  string                      `json:"source"`
	FlagKey string                      `json:"flagKey"`
}

type StateChangeNotificationType

type StateChangeNotificationType string

const (
	NotificationDelete StateChangeNotificationType = "delete"
	NotificationCreate StateChangeNotificationType = "write"
	NotificationUpdate StateChangeNotificationType = "update"
)