memory

Documentation

Index

• Variables
• type RootConfigRepoMetadata
• type SerializableTypes
  • func BuildDynamicTypeRegistryFromBufImage(image []byte) (*SerializableTypes, error)
  • func RegisterDynamicTypes(files *protoregistry.Files) (*SerializableTypes, error)
  • func (st *SerializableTypes) AddFileDescriptor(fd protoreflect.FileDescriptor, checkNotExists bool) error
• type Store
  • func NewBackendStore(ctx context.Context, apiKey, url, ownerName, repoName string, ...) (Store, error)
  • func NewGitStore(ctx context.Context, apiKey, url, ownerName, repoName, path string, ...) (Store, error)
  • func NewStaticStore(featureBytes map[string]map[string][]byte) (Store, error)

Variables

var (
	ErrConfigNotFound       error = fmt.Errorf("config not found")
	ErrCycleDependentConfig error = fmt.Errorf("cycle in config dependency")
)

Types

type RootConfigRepoMetadata

type RootConfigRepoMetadata struct {
	// This version refers to the version of the metadata.
	Version          string   `json:"version,omitempty" yaml:"version,omitempty"`
	Namespaces       []string `json:"namespaces,omitempty" yaml:"namespaces,omitempty"`
	ProtoDirectory   string   `json:"protoDir,omitempty" yaml:"protoDir,omitempty"`
	UseExternalTypes bool     `json:"externalTypes,omitempty" yaml:"externalTypes,omitempty"`
}

type SerializableTypes

type SerializableTypes struct {
	Types             *protoregistry.Types
	FileDescriptorSet *descriptorpb.FileDescriptorSet
}

func BuildDynamicTypeRegistryFromBufImage

func BuildDynamicTypeRegistryFromBufImage(image []byte) (*SerializableTypes, error)

func RegisterDynamicTypes

func RegisterDynamicTypes(files *protoregistry.Files) (*SerializableTypes, error)

func (*SerializableTypes) AddFileDescriptor

func (st *SerializableTypes) AddFileDescriptor(fd protoreflect.FileDescriptor, checkNotExists bool) error

type Store

type Store interface {
	Evaluate(key string, namespace string, lekkoContext map[string]interface{}, dest proto.Message) error
	EvaluateAny(key string, namespace string, lekkoContext map[string]interface{}) (protoreflect.ProtoMessage, error)
	Close(ctx context.Context) error
}

func NewBackendStore

func NewBackendStore(
	ctx context.Context,
	apiKey, url, ownerName, repoName string,
	client *http.Client,
	updateInterval time.Duration,
	serverPort int32,
	sdkVersion string,
) (Store, error)

Constructs an in-memory store that fetches configs from lekko's backend.

func NewGitStore

func NewGitStore(
	ctx context.Context,
	apiKey, url, ownerName, repoName, path string,
	client *http.Client,
	port int32,
	sdkVersion string,
) (Store, error)

Constructs an in-memory store that fetches configs from a local git repo at the given path. If api key is empty, the store runs in local (offline) mode, and does not communicate with Lekko.

func NewStaticStore

func NewStaticStore(featureBytes map[string]map[string][]byte) (Store, error)