Splitio.OpenFeature.Provider 2.0.0

Split OpenFeature Provider for .NET

Overview

This Provider is designed to allow the use of OpenFeature with Harness Feature Management & Experimentation, 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 .NET 6.0 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.

using OpenFeature;
using Splitio.OpenFeature;

Dictionary<string, object> initialContext = new Dictionary<string, object>();
var config = new ConfigurationOptions
{
    Logger = new CustomLogger()
};
initialContext.Add("ConfigOptions", config);
initialContext.Add("SdkKey", "SPLIT SDK API KEY");
initialContext.Add("ReadyBlockTime", 5000);

Api api = OpenFeature.Api.Instance;

api.setProviderAsync(new Provider(initialContext));

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

using OpenFeature;
using Splitio.OpenFeature;
using Splitio.Services.Client.Classes

Api api = OpenFeature.Api.Instance;

var config = new ConfigurationOptions
{
   Ready = 10000
};
var splitClient = new SplitFactory("YOUR_API_KEY", config).Client();
Dictionary<string, object> initialContext = new Dictionary<string, object>();
initialContext.Add("SplitClient", splitClient);
api.SetProviderAsync(new Provider(initialContext));

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

var context = EvaluationContext.Builder().Set("targetingKey", "randomKey").Build();
var result = await client.GetBooleanValueAsync("boolFlag", false, context);

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

var context = EvaluationContext.Builder().Set("targetingKey", "randomKey").Build();
client.SetContext(context)

or at the OpenFeatureAPI level

var context = EvaluationContext.Builder().Set("targetingKey", "randomKey").Build();
api.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.