release

type Environment struct {
	ID   string `ext:"ID" json:"id"`
	Name string `json:"name"`
}

type EnvironmentStorage interface {
	frameless.Creator
	frameless.Finder
	frameless.Updater
	frameless.Deleter
	frameless.CreatorPublisher
	frameless.UpdaterPublisher
	frameless.DeleterPublisher
	FindByAlias(ctx context.Context, idOrName string, env *Environment) (bool, error)
}

type Flag struct {
	ID   string `ext:"ID" json:"id,omitempty"`
	Name string `json:"name"`
}

type FlagEntries = iterators.Interface

type FlagStorage interface {
	frameless.Creator
	frameless.Finder
	frameless.Updater
	frameless.Deleter
	frameless.CreatorPublisher
	frameless.UpdaterPublisher
	frameless.DeleterPublisher
	FindByName(ctx context.Context, name string) (*Flag, error)
	FindByNames(ctx context.Context, names ...string) FlagEntries
}

type Pilot struct {
	// ID represent the fact that this object will be persistent in the Subject
	ID string `ext:"ID",json:"id"`
	// FlagID is the reference ID that can tell where this user record belongs to.
	FlagID string `json:"flag_id"`
	// EnvironmentID is the ID of the environment where the pilot should be enrolled
	EnvironmentID string `json:"env_id"`
	// PublicID is the unique id that connects the entry to the caller services,
	// with this service and able to use A-B/Percentage or Pilot based testings.
	PublicID string `json:"public_id"`
	// IsParticipating states that whether the pilot for the given flag in a given environment is enrolled, or blacklisted.
	IsParticipating bool `json:"is_participating"`
}

type PilotEntries = iterators.Interface

type PilotStorage interface {
	frameless.Creator
	frameless.Finder
	frameless.Updater
	frameless.Deleter
	frameless.CreatorPublisher
	frameless.UpdaterPublisher
	frameless.DeleterPublisher
	FindByFlagEnvPublicID(ctx context.Context, flagID, envID interface{}, publicID string) (*Pilot, error)
	FindByFlag(ctx context.Context, flag Flag) PilotEntries
	FindByPublicID(ctx context.Context, publicID string) PilotEntries
}

type PseudoRandPercentageAlgorithms struct{}

type Rollout struct {
	ID string `ext:"ID"`
	// FlagID is the release flag id to which the rolloutBase belongs
	FlagID string
	// EnvironmentID is the deployment environment id
	EnvironmentID string
	// Plan holds the composited rule set about the pilot participation decision logic.
	Plan RolloutPlan
}

type RolloutDecisionAND struct {
	Left  RolloutPlan `json:"left"`
	Right RolloutPlan `json:"right"`
}

type RolloutDecisionByAPI struct {
	// URL allow you to do rolloutBase based on custom domain needs such as target groups,
	// which decision logic is available trough an API endpoint call
	URL *url.URL `json:"url"`
}

type RolloutDecisionByGlobal struct {
	State bool `json:"state"`
}

type RolloutDecisionByPercentage struct {
	// PseudoRandPercentageAlgorithm specifies the algorithm that is expected to be used in the percentage calculation.
	// Currently it is only supports FNV1a64 and "func"
	PseudoRandPercentageAlgorithm string `json:"algo"`
	// PseudoRandPercentageFunc is a dependency that can be used if the Algorithm is not defined or defined to func.
	// Ideal for testing.
	PseudoRandPercentageFunc func(id string, seedSalt int64) (int, error) `json:"-"`
	// Seed allows you to configure the randomness for the percentage based pilot enrollment selection.
	// This value could have been neglected by using the flag name as random seed,
	// but that would reduce the flexibility for edge cases where you want
	// to use a similar pilot group as a successful flag rolloutBase before.
	Seed int64 `json:"seed"`
	// Percentage allows you to define how many of your user base should be enrolled pseudo randomly.
	Percentage int `json:"percentage"`
}

type RolloutDecisionNOT struct {
	Definition RolloutPlan `json:"def"`
}

type RolloutDecisionOR struct {
	Left  RolloutPlan `json:"left"`
	Right RolloutPlan `json:"right"`
}

type RolloutEntries = iterators.Interface

type RolloutManager struct{ Storage Storage }

type RolloutPlan interface {
	IsParticipating(ctx context.Context, pilotExternalID string) (bool, error)
	Validate() error
}

type RolloutPlanView struct {
	Plan RolloutPlan `json:"plan"`
}

type RolloutStorage interface {
	frameless.Creator
	frameless.Finder
	frameless.Updater
	frameless.Deleter
	frameless.CreatorPublisher
	frameless.UpdaterPublisher
	frameless.DeleterPublisher
	FindByFlagEnvironment(context.Context, Flag, Environment, *Rollout) (bool, error)
}

type Storage interface {
	frameless.OnePhaseCommitProtocol
	ReleaseFlag(context.Context) FlagStorage
	ReleasePilot(context.Context) PilotStorage
	ReleaseRollout(context.Context) RolloutStorage
	ReleaseEnvironment(context.Context) EnvironmentStorage
}