entity

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 21, 2022 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// TotalBucketNum represents how many buckets we can use to determine the consistent hashing
	// distribution and rollout
	TotalBucketNum uint = 1000

	// PercentMultiplier implies that the multiplier between percentage (100) and TotalBucketNum
	PercentMultiplier uint = TotalBucketNum / uint(100)
)
View Source 
const SegmentDefaultRank = uint(999)

SegmentDefaultRank is the default rank when we create the segment

Variables

View Source 
var AutoMigrateTables = []interface{}{
	Flag{},
	Constraint{},
	Distribution{},
	FlagSnapshot{},
	Segment{},
	User{},
	Variant{},
	Tag{},
	FlagEntityType{},
}

AutoMigrateTables stores the entity tables that we can auto migrate in gorm

View Source 
var OperatorToExprMap = map[string]string{
	models.ConstraintOperatorEQ:          "==",
	models.ConstraintOperatorNEQ:         "!=",
	models.ConstraintOperatorLT:          "<",
	models.ConstraintOperatorLTE:         "<=",
	models.ConstraintOperatorGT:          ">",
	models.ConstraintOperatorGTE:         ">=",
	models.ConstraintOperatorEREG:        "=~",
	models.ConstraintOperatorNEREG:       "!~",
	models.ConstraintOperatorIN:          "IN",
	models.ConstraintOperatorNOTIN:       "NOT IN",
	models.ConstraintOperatorCONTAINS:    "CONTAINS",
	models.ConstraintOperatorNOTCONTAINS: "NOT CONTAINS",
}

OperatorToExprMap maps from the swagger model operator to condition operator

Functions

func CreateFlagEntityType 

func CreateFlagEntityType(db *gorm.DB, key string) error

CreateFlagEntityType creates the FlagEntityType if not exists

func CreateFlagKey 

func CreateFlagKey(key string) (string, error)

CreateFlagKey creates the key based on the given key

func GetDB 

func GetDB() *gorm.DB

GetDB gets the db singleton

func NewSQLiteDB 

func NewSQLiteDB(filePath string) *gorm.DB

NewSQLiteDB creates a new sqlite db useful for backup exports and unit tests

func NewTestDB 

func NewTestDB() *gorm.DB

NewTestDB creates a new test db

func PopulateTestDB 

func PopulateTestDB(flag Flag) *gorm.DB

PopulateTestDB seeds the test db

func PreloadConstraintsDistribution 

func PreloadConstraintsDistribution(db *gorm.DB) *gorm.DB

PreloadConstraintsDistribution preloads constraints and distributions for segment

func PreloadFlagTags 

func PreloadFlagTags(db *gorm.DB) *gorm.DB

Preloads just the tags

func PreloadSegmentsVariantsTags 

func PreloadSegmentsVariantsTags(db *gorm.DB) *gorm.DB

PreloadSegmentsVariantsTags preloads segments, variants and tags for flag

func SaveFlagSnapshot 

func SaveFlagSnapshot(db *gorm.DB, flagID uint, updatedBy string)

SaveFlagSnapshot saves the Flag Snapshot

Types

type Attachment 

type Attachment map[string]interface{}

Attachment supports dynamic configuration in variant

func (*Attachment) Scan 

func (a *Attachment) Scan(value interface{}) error

Scan implements scanner interface

func (Attachment) Value 

func (a Attachment) Value() (driver.Value, error)

Value implements valuer interface

type Constraint 

type Constraint struct {
	gorm.Model

	SegmentID uint `gorm:"index:idx_constraint_segmentid"`
	Property  string
	Operator  string
	Value     string `gorm:"type:text"`
}

Constraint is the unit of constraints

func (*Constraint) ToExpr 

func (c *Constraint) ToExpr() (conditions.Expr, error)

ToExpr transfer the constraint to conditions.Expr for evaluation

func (*Constraint) Validate 

func (c *Constraint) Validate() error

Validate validates Constraint

type ConstraintArray 

type ConstraintArray []Constraint

ConstraintArray is an array of Constraint

func (ConstraintArray) ToExpr 

func (cs ConstraintArray) ToExpr() (conditions.Expr, error)

ToExpr maps ConstraintArray to expr by joining 'AND'

type Distribution 

type Distribution struct {
	gorm.Model
	SegmentID  uint `gorm:"index:idx_distribution_segmentid"`
	VariantID  uint `gorm:"index:idx_distribution_variantid"`
	VariantKey string

	Percent uint   // Percent is an uint from 0 to 100, percent is always derived from Bitmap
	Bitmap  string `gorm:"type:text" json:"-"`
}

Distribution is the struct represents distribution under segment and links to variant

type DistributionArray 

type DistributionArray struct {
	VariantIDs          []uint
	PercentsAccumulated []int // useful for binary search to find the rollout variant
}

DistributionArray is useful for faster evalution

func (DistributionArray) Rollout 

func (d DistributionArray) Rollout(entityID string, salt string, rolloutPercent uint) (variantID *uint, msg string)

Rollout rolls out the entity based on the rolloutPercent

type DistributionDebugLog 

type DistributionDebugLog struct {
	BucketNum         uint
	DistributionArray DistributionArray
	VariantID         uint
	RolloutPercent    uint
}

DistributionDebugLog is useful for making debug logs

type EvalContext 

type EvalContext struct {
	EntityID      string
	EntityType    string
	EntityContext map[string]interface{}

	EnableDebug bool
}

EvalContext represents the context we can evaluate and log

type EvalDebugLog 

type EvalDebugLog struct {
	SegmentDebugLogs []SegmentDebugLog
	Msg              string
}

EvalDebugLog is the debugging log of evaluation

type EvalResult 

type EvalResult struct {
	FlagID      uint
	SegmentID   uint
	VariantID   uint
	EvalContext EvalContext
	Timestamp   time.Time

	EvalDebugLog *EvalDebugLog
}

EvalResult represents the result of the evaluation

type Flag 

type Flag struct {
	gorm.Model

	Key         string `gorm:"type:varchar(64);uniqueIndex:idx_flag_key"`
	Description string `gorm:"type:text"`
	CreatedBy   string
	UpdatedBy   string
	Enabled     bool
	Segments    []Segment
	Variants    []Variant
	Tags        []Tag `gorm:"many2many:flags_tags;"`
	SnapshotID  uint
	Notes       string `gorm:"type:text"`

	DataRecordsEnabled bool
	EntityType         string

	FlagEvaluation FlagEvaluation `gorm:"-" json:"-"`
}

Flag is the unit of flags

func GenFixtureFlag 

func GenFixtureFlag() Flag

GenFixtureFlag is a fixture

func (*Flag) Preload 

func (f *Flag) Preload(db *gorm.DB) error

Preload preloads the segments, variants and tags into flags

func (*Flag) PreloadTags 

func (f *Flag) PreloadTags(db *gorm.DB) error

PreloadTags preloads the tags into flags

func (*Flag) PrepareEvaluation 

func (f *Flag) PrepareEvaluation() error

PrepareEvaluation prepares the information for evaluation

type FlagEntityType 

type FlagEntityType struct {
	gorm.Model
	Key string `gorm:"type:varchar(64);uniqueIndex:flag_entity_type_key"`
}

FlagEntityType is the entity_type that will overwrite into evaluation logs.

type FlagEvaluation 

type FlagEvaluation struct {
	VariantsMap map[uint]*Variant
}

FlagEvaluation is a struct that holds the necessary info for evaluation

type FlagSnapshot 

type FlagSnapshot struct {
	gorm.Model
	FlagID    uint `gorm:"index:idx_flagsnapshot_flagid"`
	UpdatedBy string
	Flag      []byte `gorm:"type:text"`
}

FlagSnapshot is the snapshot of a flag Any change of the flag will create a new snapshot

type Logger 

type Logger struct {
	LogLevel                  gorm_logger.LogLevel
	SlowThreshold             time.Duration
	IgnoreRecordNotFoundError bool
}

func (*Logger) Error 

func (l *Logger) Error(ctx context.Context, s string, args ...interface{})

func (*Logger) Info 

func (l *Logger) Info(ctx context.Context, s string, args ...interface{})

func (*Logger) LogMode 

func (l *Logger) LogMode(level gorm_logger.LogLevel) gorm_logger.Interface

func (*Logger) Trace 

func (l *Logger) Trace(ctx context.Context, begin time.Time, fc func() (string, int64), err error)

func (*Logger) Warn 

func (l *Logger) Warn(ctx context.Context, s string, args ...interface{})

type Segment 

type Segment struct {
	gorm.Model
	FlagID         uint   `gorm:"index:idx_segment_flagid"`
	Description    string `gorm:"type:text"`
	Rank           uint
	RolloutPercent uint
	Constraints    ConstraintArray
	Distributions  []Distribution

	// Purely for evaluation
	SegmentEvaluation SegmentEvaluation `gorm:"-" json:"-"`
}

Segment is the unit of segmentation

func GenFixtureSegment 

func GenFixtureSegment() Segment

GenFixtureSegment is a fixture

func (*Segment) Preload 

func (s *Segment) Preload(db *gorm.DB) error

Preload preloads the segment

func (*Segment) PrepareEvaluation 

func (s *Segment) PrepareEvaluation() error

PrepareEvaluation prepares the segment for evaluation by parsing constraints and denormalize distributions

type SegmentDebugLog 

type SegmentDebugLog struct {
	SegmentID uint
	Msg       string
}

SegmentDebugLog is the segmebnt level of debugging logs

type SegmentEvaluation 

type SegmentEvaluation struct {
	ConditionsExpr    conditions.Expr
	DistributionArray DistributionArray
}

SegmentEvaluation is a struct that holds the necessary info for evaluation

type Tag 

type Tag struct {
	gorm.Model

	Value string  `gorm:"type:varchar(64);uniqueIndex:idx_tag_value"`
	Flags []*Flag `gorm:"many2many:flags_tags;"`
}

Tag is a descriptive identifier given to ease searchability

type User 

type User struct {
	gorm.Model
	Email      string `gorm:"type:text"`
	UserId     string `gorm:"type:text"`
	Customer   string `gorm:"type:text"`
	CustomerId string `gorm:"type:text"`
}

User represents the User struct

type Variant 

type Variant struct {
	gorm.Model
	FlagID     uint `gorm:"index:idx_variant_flagid"`
	Key        string
	Attachment Attachment `gorm:"type:text"`
}

Variant is the struct that represent the experience/variant of the evaluation entity

func (*Variant) Validate 

func (v *Variant) Validate() error

Validate validates the Variant

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.