abtesting

Documentation

Index

• Variables
• type ABService
• type Config
• type Service
  • func NewService(log *zap.Logger, config Config) *Service
  • func (s *Service) GetABValues(ctx context.Context, user console.User) (values map[string]interface{}, err error)
  • func (s *Service) SendHit(ctx context.Context, user console.User, action string)

Variables

var Error = errs.Class("consoleapi ab testing error")

Error - console ab testing error type.

Types

type ABService

type ABService interface {
	// GetABValues gets AB test values for a specific user. It returns a default value on error.
	GetABValues(ctx context.Context, user console.User) (values map[string]interface{}, err error)
	// SendHit sends an "action" event to flagship.
	SendHit(ctx context.Context, user console.User, action string)
}

ABService is an interface for AB test methods.

type Config

type Config struct {
	Enabled        bool   `help:"whether or not AB testing is enabled" default:"false"`
	APIKey         string `help:"the Flagship API key"`
	EnvId          string `help:"the Flagship environment ID"`
	FlagshipURL    string `help:"the Flagship API URL" default:"https://decision.flagship.io/v2"`
	HitTrackingURL string `help:"the Flagship environment ID" default:"https://ariane.abtasty.com"`
}

Config contains configurations for the AB testing service.

type Service

type Service struct {
	Config Config
	// contains filtered or unexported fields
}

Service is a service that exposes all ab testing functionality.

func NewService

func NewService(log *zap.Logger, config Config) *Service

NewService is a constructor for AB service.

func (*Service) GetABValues

func (s *Service) GetABValues(ctx context.Context, user console.User) (values map[string]interface{}, err error)

GetABValues gets AB test values for a specific user.

func (*Service) SendHit

func (s *Service) SendHit(ctx context.Context, user console.User, action string)

SendHit sends an "action" event to flagship.