experiments

Documentation

Index

• type Name
  • func (x Name) Enabled(set *Set) bool
  • func (x Name) Valid() bool
• type Set
  • func NewSet(fromAppFile []Name, environ []string) (*Set, error)
  • func (s *Set) List() []Name
• type UnknownExperimentError
  • func (e *UnknownExperimentError) Error() string

Types

type Name

type Name string

const (

	// LocalSecretsOverride is an experiment to allow for secrets
	// to be overridden with values from a ".secrets.local" file.
	LocalSecretsOverride Name = "local-secrets-override"

	// Metrics is an experiment to enable metrics.
	Metrics Name = "metrics"
)

func (Name) Enabled

func (x Name) Enabled(set *Set) bool

Enabled returns true if this experiment enabled in the given set

func (Name) Valid

func (x Name) Valid() bool

Valid reports whether the given name is a known experiment.

type Set

type Set struct {
	// contains filtered or unexported fields
}

func NewSet

func NewSet(fromAppFile []Name, environ []string) (*Set, error)

NewSet creates an experiment set which represents the enabled experiments within a particular run of Encore.

All errors reported by NewSet are due to unknown experiment names. The error type is of type *UnknownExperimentError.

func (*Set) List

func (s *Set) List() []Name

type UnknownExperimentError

type UnknownExperimentError struct {
	Name Name
}

UnknownExperimentError is an error returned when an app tries to use an experiment that is not known to the current version of Encore.

func (*UnknownExperimentError) Error

func (e *UnknownExperimentError) Error() string