sync

Documentation

Overview

Package sync provides flag definition synchronization from parsed descriptors into PostgreSQL. Both pbflags-sync and pbflags-admin (standalone mode) use this package to write definitions to the database.

Index

• func CollectLaunches(configs map[string]*configfile.Config, configDir string, ...) (*launchCollection, error)
• func Compile(descriptorData []byte, configDir string) ([]byte, error)
• func FlagTypeString(ft pbflagsv1.FlagType) string
• type ConditionResult
  • func SyncConditions(ctx context.Context, conn *pgx.Conn, configDir string, descriptorData []byte, ...) (ConditionResult, error)
• type LoadResult
  • func LoadBundle(ctx context.Context, conn *pgx.Conn, bundleData []byte, sha string) (LoadResult, error)
• type Result
  • func SyncDefinitions(ctx context.Context, conn *pgx.Conn, defs []evaluator.FlagDef, ...) (Result, error)

Functions

func CollectLaunches

func CollectLaunches(
	configs map[string]*configfile.Config,
	configDir string,
	hashableDims map[string]bool,
	scopeDims map[string]map[string]bool,
	featureScopes map[string][]string,
) (*launchCollection, error)

collectLaunches gathers launch definitions and references from parsed configs and the launches/ subdirectory. Returns an error if validation fails (duplicate IDs, missing references, scope violations, non-UNIFORM dimensions, dimension not present in all affected scopes).

scopeDims maps scope name → set of available dimension names. featureScopes maps featureID → list of scope names. Both may be nil to skip scope-presence validation (e.g. when descriptors are not available).

func Compile

func Compile(descriptorData []byte, configDir string) ([]byte, error)

Compile reads proto descriptors and YAML config files, compiles everything, and returns a serialized CompiledBundle protobuf.

func FlagTypeString

func FlagTypeString(ft pbflagsv1.FlagType) string

FlagTypeString converts a FlagType enum to the string stored in the DB, stripping the "FLAG_TYPE_" prefix (e.g. FLAG_TYPE_BOOL -> "BOOL").

Types

type ConditionResult

type ConditionResult struct {
	FlagsUpdated int
	Warnings     []string
}

ConditionResult reports what the condition sync did.

func SyncConditions

func SyncConditions(
	ctx context.Context,
	conn *pgx.Conn,
	configDir string,
	descriptorData []byte,
	defs []evaluator.FlagDef,
	logger *slog.Logger,
	sha string,
) (ConditionResult, error)

SyncConditions compiles YAML config files from configDir and writes conditions, dimension_metadata, and cel_version to the flags table.

type LoadResult

type LoadResult struct {
	Features          int
	FlagsUpserted     int
	FlagsArchived     int
	ConditionsUpdated int
}

LoadResult reports what the bundle load did.

func LoadBundle

func LoadBundle(ctx context.Context, conn *pgx.Conn, bundleData []byte, sha string) (LoadResult, error)

LoadBundle deserializes a CompiledBundle and writes it to the database. No proto descriptors or CEL compiler needed — all compilation was done at compile time.

type Result

type Result struct {
	Features      int
	FlagsUpserted int
	FlagsArchived int
}

Result reports what the sync did.

func SyncDefinitions

func SyncDefinitions(ctx context.Context, conn *pgx.Conn, defs []evaluator.FlagDef, logger *slog.Logger) (Result, error)

SyncDefinitions writes the given flag definitions to the database in a single transaction. It upserts features and flags, and archives flags that are no longer present in the descriptor. Runtime state (state, value) is never modified.