retriever

Documentation

Index

• type CommonInitializableRetriever
• type InitializableRetriever
• type InitializableRetrieverLegacy
• type Manager
  • func NewManager(config ManagerConfig, retrievers []Retriever, cacheManager cache.Manager, ...) *Manager
  • func (m *Manager) ForceRefresh() bool
  • func (m *Manager) GetCacheRefreshDate() time.Time
  • func (m *Manager) GetFlag(flagKey string) (flag.Flag, error)
  • func (m *Manager) GetFlagsFromCache() (map[string]flag.Flag, error)
  • func (m *Manager) Init(ctx context.Context) error
  • func (m *Manager) Shutdown(ctx context.Context) error
  • func (m *Manager) StartPolling()
  • func (m *Manager) StopPolling()
• type ManagerConfig
• type Retriever
• type Status

Types

type CommonInitializableRetriever

type CommonInitializableRetriever interface {
	Retriever
	Shutdown(ctx context.Context) error
	Status() Status
}

CommonInitializableRetriever is the common interface for all versions of retrievers that can be initialized and shutdown.

type InitializableRetriever

type InitializableRetriever interface {
	CommonInitializableRetriever
	Init(ctx context.Context, logger *fflog.FFLogger) error
}

InitializableRetriever is an extended version of the retriever that can be initialized and shutdown.

type InitializableRetrieverLegacy

type InitializableRetrieverLegacy interface {
	CommonInitializableRetriever
	Init(ctx context.Context, logger *log.Logger) error
}

InitializableRetrieverLegacy is an extended version of the retriever that can be initialized and shutdown.

type Manager

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

Manager is a struct that managed the retrievers.

func NewManager

func NewManager(
	config ManagerConfig, retrievers []Retriever, cacheManager cache.Manager, logger *fflog.FFLogger) *Manager

NewManager create a new Manager.

func (*Manager) ForceRefresh

func (m *Manager) ForceRefresh() bool

func (*Manager) GetCacheRefreshDate

func (m *Manager) GetCacheRefreshDate() time.Time

GetCacheRefreshDate gives the last refresh date of the cache

func (*Manager) GetFlag

func (m *Manager) GetFlag(flagKey string) (flag.Flag, error)

GetFlag returns the flag from the cache with the current state when calling this method.

func (*Manager) GetFlagsFromCache

func (m *Manager) GetFlagsFromCache() (map[string]flag.Flag, error)

GetFlagsFromCache returns all the flags present in the cache with their current state when calling this method. If cache hasn't been initialized, an error reporting this is returned.

func (*Manager) Init

func (m *Manager) Init(ctx context.Context) error

Init the retrievers. This function will call the Init function of the retrievers that implements the InitializableRetriever interface.

func (*Manager) Shutdown

func (m *Manager) Shutdown(ctx context.Context) error

Shutdown the retrievers. This function will call the Shutdown function of the retrievers that implements the InitializableRetriever interface.

func (*Manager) StartPolling

func (m *Manager) StartPolling()

StartPolling is the daemon that refreshes the cache every X seconds.

func (*Manager) StopPolling

func (m *Manager) StopPolling()

StopPolling is the function to stop the background updater.

type ManagerConfig

type ManagerConfig struct {
	Ctx                             context.Context
	FileFormat                      string
	DisableNotifierOnInit           bool
	PersistentFlagConfigurationFile string
	StartWithRetrieverError         bool
	EnablePollingJitter             bool
	PollingInterval                 time.Duration
}

ManagerConfig is the configuration of the retriever manager.

type Retriever

type Retriever interface {
	// Retrieve function is supposed to load the file and to return a []byte of your flag configuration file.
	Retrieve(ctx context.Context) ([]byte, error)
}

Retriever is the interface to create a Retriever to load you flags.

type Status

type Status = string

Status is the status of the retriever. It can be used to check if the retriever is ready to be used. If not ready, we wi will not use it.

const (
	// RetrieverReady is the status when the retriever is ready to be used.
	RetrieverReady Status = "READY"
	// RetrieverNotReady is the status when the retriever is not ready yet to be used.
	RetrieverNotReady Status = "NOT_READY"
	// RetrieverError is the status when the retriever is in error.
	RetrieverError Status = "ERROR"
)