ldhooks

type EvaluationSeries ¶

type EvaluationSeries interface {
	// BeforeEvaluation is called during the execution of a variation Method before the flag value has been determined.
	// The Method returns EvaluationSeriesData that will be passed to the next stage in the evaluation
	// series.
	//
	// The EvaluationSeriesData returned should always contain the previous data as well as any new data which is
	// required for subsequent stage execution.
	BeforeEvaluation(
		ctx context.Context,
		seriesContext EvaluationSeriesContext,
		data EvaluationSeriesData,
	) (EvaluationSeriesData, error)

	// AfterEvaluation is called during the execution of the variation Method after the flag value has been determined.
	// The Method returns EvaluationSeriesData that will be passed to the next stage in the evaluation
	// series.
	//
	// The EvaluationSeriesData returned should always contain the previous data as well as any new data which is
	// required for subsequent stage execution.
	AfterEvaluation(ctx context.Context,
		seriesContext EvaluationSeriesContext,
		data EvaluationSeriesData,
		detail ldreason.EvaluationDetail,
	) (EvaluationSeriesData, error)
}

The EvaluationSeries is composed of stages, methods that are called during the evaluation of flags.

type EvaluationSeriesContext ¶

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

EvaluationSeriesContext contains contextual information for the execution of stages in the evaluation series.

func NewEvaluationSeriesContext(
	flagKey string,
	evalContext ldcontext.Context,
	defaultValue ldvalue.Value,
	method string,
	environmentID ldvalue.OptionalString,
) EvaluationSeriesContext

func (c EvaluationSeriesContext) Context() ldcontext.Context

func (c EvaluationSeriesContext) DefaultValue() ldvalue.Value

func (c EvaluationSeriesContext) EnvironmentID() ldvalue.OptionalString

func (c EvaluationSeriesContext) FlagKey() string

func (c EvaluationSeriesContext) Method() string

type EvaluationSeriesData ¶

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

EvaluationSeriesData is an immutable data type used for passing implementation-specific data between stages in the evaluation series.

func EmptyEvaluationSeriesData() EvaluationSeriesData

func (b EvaluationSeriesData) AsAnyMap() map[string]any

func (b EvaluationSeriesData) Get(key string) (value any, ok bool)

type EvaluationSeriesDataBuilder ¶

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

EvaluationSeriesDataBuilder should be used by hook implementers to append data

func NewEvaluationSeriesBuilder(data EvaluationSeriesData) *EvaluationSeriesDataBuilder

func(h MyHook) BeforeEvaluation(seriesContext EvaluationSeriesContext,
	data EvaluationSeriesData) EvaluationSeriesData {
	// Some hook functionality.
	return NewEvaluationSeriesBuilder(data).Set("my-key", myValue).Build()
}

func (b *EvaluationSeriesDataBuilder) Build() EvaluationSeriesData

func (b *EvaluationSeriesDataBuilder) Merge(newValues map[string]any) *EvaluationSeriesDataBuilder

func (b *EvaluationSeriesDataBuilder) Set(key string, value any) *EvaluationSeriesDataBuilder

type Hook ¶

type Hook interface {
	Metadata() Metadata
	EvaluationSeries
	TrackSeries
}

A Hook is used to extend the functionality of the SDK.

In order to avoid implementing unused methods, as well as easing maintenance of compatibility, implementors should compose the `Unimplemented`.

type MyHook struct {
  ldhooks.Unimplemented
}

type HookMetadataOption ¶

type HookMetadataOption func(hook *Metadata)

HookMetadataOption represents a functional means of setting additional, optional, attributes of the Metadata.

type Metadata ¶

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

Metadata contains information about a specific hook implementation.

func NewMetadata(name string, opts ...HookMetadataOption) Metadata

func (m Metadata) Name() string

type TrackSeries ¶ added in v7.12.0

type TrackSeries interface {
	// AfterTrack is called during the execution of a track Method.
	AfterTrack(
		ctx context.Context,
		seriesContext TrackSeriesContext,
	) error
}

The TrackSeries is composed of stages, methods that are called during the tracking of events.

type TrackSeriesContext ¶ added in v7.12.0

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

TrackSeriesContext contains contextual information for the execution of stages in the evaluation series.

func NewTrackSeriesContext(
	context ldcontext.Context,
	key string,
	metricValue *float64,
	data ldvalue.Value,
	environmentID ldvalue.OptionalString,
) TrackSeriesContext

func (c TrackSeriesContext) Context() ldcontext.Context

func (c TrackSeriesContext) Data() ldvalue.Value

func (c TrackSeriesContext) EnvironmentID() ldvalue.OptionalString

func (c TrackSeriesContext) Key() string

func (c TrackSeriesContext) MetricValue() *float64

type Unimplemented ¶

type Unimplemented struct {
}

Unimplemented implements all Hook methods with empty functions. Hook implementors should use this to avoid having to implement empty methods and to ease updates when the Hook interface is extended.

type MyHook struct {
  ldhooks.Unimplemented
}

The hook should implement at least one stage/handler as well as the Metadata function.

func (h Unimplemented) AfterEvaluation(
	_ context.Context,
	_ EvaluationSeriesContext,
	data EvaluationSeriesData,
	_ ldreason.EvaluationDetail,
) (EvaluationSeriesData, error)

func (h Unimplemented) AfterTrack(
	_ context.Context,
	_ TrackSeriesContext,
) error

func (h Unimplemented) BeforeEvaluation(
	_ context.Context,
	_ EvaluationSeriesContext,
	data EvaluationSeriesData,
) (EvaluationSeriesData, error)