split_openfeature_provider_go

README

Split OpenFeature Provider for Go

Overview

This Provider is designed to allow the use of OpenFeature with Split, the platform for controlled rollouts, serving features to your users via the Split feature flag to manage your complete customer experience.

Compatibility

This SDK is compatible with Go 1.19 and higher.

Getting started

Below is a simple example that describes the instantiation of the Split Provider. Please see the OpenFeature Documentation for details on how to use the OpenFeature SDK.

import (
    "github.com/open-feature/go-sdk/pkg/openfeature"
    splitProvider "github.com/splitio/split-openfeature-provider-go"
)

provider, err := splitProvider.NewProviderSimple("YOUR_SDK_TYPE_API_KEY")
if err != nil {
    // Provider creation error
}
openfeature.SetProvider(provider)

If you are more familiar with Split or want access to other initialization options, you can provide a SplitClient to the constructor. See the Split Go SDK Documentation for more information.

import (
    "github.com/open-feature/go-sdk/pkg/openfeature"
    "github.com/splitio/go-client/v6/splitio/client"
    "github.com/splitio/go-client/v6/splitio/conf"
    splitProvider "github.com/splitio/split-openfeature-provider-go"
)

cfg := conf.Default()
factory, err := client.NewSplitFactory("YOUR_SDK_TYPE_API_KEY", cfg)
if err != nil {
    // SDK initialization error
}

splitClient := factory.Client()

err = splitClient.BlockUntilReady(10)
if err != nil {
    // SDK timeout error
}

provider, err := splitProvider.NewProvider(*splitClient)
if err != nil {
    // Provider creation error
}
openfeature.SetProvider(provider)

Use of OpenFeature with Split

After the initial setup you can use OpenFeature according to their documentation.

One important note is that the Split Provider requires a targeting key to be set. Often times this should be set when evaluating the value of a flag by setting an EvaluationContext which contains the targeting key. An example flag evaluation is

client := openfeature.NewClient("CLIENT_NAME");

evaluationContext := openfeature.NewEvaluationContext("TARGETING_KEY", nil)
boolValue := client.BooleanValue(nil, "boolFlag", false, evaluationContext)

If the same targeting key is used repeatedly, the evaluation context may be set at the client level

evaluationContext := openfeature.NewEvaluationContext("TARGETING_KEY", nil)
client.SetEvaluationContext(context)

or at the OpenFeatureAPI level

evaluationContext := openfeature.NewEvaluationContext("TARGETING_KEY", nil)
openfeature.SetEvaluationContext(context)

If the context was set at the client or api level, it is not required to provide it during flag evaluation.

Submitting issues

The Split team monitors all issues submitted to this issue tracker. We encourage you to use this issue tracker to submit any bug reports, feedback, and feature enhancements. We'll do our best to respond in a timely manner.

Contributing

Please see Contributors Guide to find all you need to submit a Pull Request (PR).

License

Licensed under the Apache License, Version 2.0. See: Apache License.

About Split

Split is the leading Feature Delivery Platform for engineering teams that want to confidently deploy features as fast as they can develop them. Split’s fine-grained management, real-time monitoring, and data-driven experimentation ensure that new features will improve the customer experience without breaking or degrading performance. Companies like Twilio, Salesforce, GoDaddy and WePay trust Split to power their feature delivery.

To learn more about Split, contact hello@split.io, or get started with feature flags for free at https://www.split.io/signup.

Split has built and maintains SDKs for:

• Java Github Docs
• Javascript Github Docs
• Node Github Docs
• .NET Github Docs
• Ruby Github Docs
• PHP Github Docs
• Python Github Docs
• GO Github Docs
• Android Github Docs
• iOS Github Docs

For a comprehensive list of open source projects visit our Github page.

Learn more about Split:

Visit split.io/product for an overview of Split, or visit our documentation at help.split.io for more detailed information.

Documentation

Index

• type SplitProvider
  • func NewProvider(splitClient client.SplitClient) (*SplitProvider, error)
  • func NewProviderSimple(apiKey string) (*SplitProvider, error)
  • func (provider *SplitProvider) BooleanEvaluation(ctx context.Context, flag string, defaultValue bool, ...) openfeature.BoolResolutionDetail
  • func (provider *SplitProvider) FloatEvaluation(ctx context.Context, flag string, defaultValue float64, ...) openfeature.FloatResolutionDetail
  • func (provider *SplitProvider) Hooks() []openfeature.Hook
  • func (provider *SplitProvider) IntEvaluation(ctx context.Context, flag string, defaultValue int64, ...) openfeature.IntResolutionDetail
  • func (provider *SplitProvider) Metadata() openfeature.Metadata
  • func (provider *SplitProvider) ObjectEvaluation(ctx context.Context, flag string, defaultValue interface{}, ...) openfeature.InterfaceResolutionDetail
  • func (provider *SplitProvider) StringEvaluation(ctx context.Context, flag string, defaultValue string, ...) openfeature.StringResolutionDetail

Types

type SplitProvider

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

func NewProvider

func NewProvider(splitClient client.SplitClient) (*SplitProvider, error)

func NewProviderSimple

func NewProviderSimple(apiKey string) (*SplitProvider, error)

func (*SplitProvider) BooleanEvaluation

func (provider *SplitProvider) BooleanEvaluation(ctx context.Context, flag string, defaultValue bool, evalCtx openfeature.FlattenedContext) openfeature.BoolResolutionDetail

func (*SplitProvider) FloatEvaluation

func (provider *SplitProvider) FloatEvaluation(ctx context.Context, flag string, defaultValue float64, evalCtx openfeature.FlattenedContext) openfeature.FloatResolutionDetail

func (*SplitProvider) Hooks

func (provider *SplitProvider) Hooks() []openfeature.Hook

func (*SplitProvider) IntEvaluation

func (provider *SplitProvider) IntEvaluation(ctx context.Context, flag string, defaultValue int64, evalCtx openfeature.FlattenedContext) openfeature.IntResolutionDetail

func (*SplitProvider) Metadata

func (provider *SplitProvider) Metadata() openfeature.Metadata

func (*SplitProvider) ObjectEvaluation

func (provider *SplitProvider) ObjectEvaluation(ctx context.Context, flag string, defaultValue interface{}, evalCtx openfeature.FlattenedContext) openfeature.InterfaceResolutionDetail

func (*SplitProvider) StringEvaluation

func (provider *SplitProvider) StringEvaluation(ctx context.Context, flag string, defaultValue string, evalCtx openfeature.FlattenedContext) openfeature.StringResolutionDetail