featureflags

Documentation

Overview

Package featureflags provides feature flag management for Weblens.

Index

• Constants
• func SaveFlags(ctx context.Context, ffs Bundle) error
• type Bundle
  • func Default() Bundle
  • func GetFlags(ctx context.Context) (Bundle, error)
• type FlagKey

Constants

const FeatureFlagCollectionKey = "featureFlags"

FeatureFlagCollectionKey is the database collection name for feature flag document(s).

const FeatureFlagDocumentID = "ff"

FeatureFlagDocumentID is the ID of the main feature flag document.

Functions

func SaveFlags

func SaveFlags(ctx context.Context, ffs Bundle) error

SaveFlags saves the flags to the database and updates the cache.

Types

type Bundle

type Bundle struct {
	AllowRegistrations bool `bson:"auth.allow_registrations" json:"auth.allow_registrations"`
	EnableHDIR         bool `bson:"media.hdir_processing_enabled" json:"media.hdir_processing_enabled"`

} //	@name	Bundle

Bundle represents the application feature flag document.

func Default

func Default() Bundle

Default returns the default flags

func GetFlags

func GetFlags(ctx context.Context) (Bundle, error)

GetFlags retrieves the current flag set from cache or database.

type FlagKey

type FlagKey = string

FlagKey represents a feature flag key used to identify specific flags.

const (
	// AllowRegistrations controls whether new user registration is allowed.
	AllowRegistrations FlagKey = "auth.allow_registrations"
	// EnableHDIR controls whether HDIR (high-dynamic-range image rendering) is enabled.
	EnableHDIR FlagKey = "media.hdir_processing_enabled"
)

Feature Flag keys for Weblens settings.