OpenFeature.Providers.Unleash 0.1.1

Unleash .NET Provider

The Unleash provider allows you to use Unleash with the OpenFeature .NET SDK.

.Net SDK usage

Requirements

• open-feature/dotnet-sdk v2.x
• Unleash .NET SDK v6.x

Install dependencies

The first thing we will do is install the OpenFeature SDK and the Unleash Feature Flag provider.

.NET Cli

dotnet add package OpenFeature.Providers.Unleash

Package Manager

NuGet\Install-Package OpenFeature.Providers.Unleash

Package Reference

<PackageReference Include="OpenFeature.Providers.Unleash" />

Packet cli

paket add OpenFeature.Providers.Unleash

Cake

// Install OpenFeature.Providers.Unleash as a Cake Addin
#addin nuget:?package=OpenFeature.Providers.Unleash

// Install OpenFeature.Providers.Unleash as a Cake Tool
#tool nuget:?package=OpenFeature.Providers.Unleash

Using the Unleash Provider with the OpenFeature SDK

using OpenFeature;
using OpenFeature.Providers.Unleash;
using Unleash;

var settings = new UnleashSettings
{
    AppName = "my-app",
    UnleashApi = new Uri("http://localhost:4242/api/"),
    CustomHttpHeaders = new Dictionary<string, string>
    {
        { "Authorization", "*:development.your-api-token" }
    }
};

var provider = new UnleashProvider(settings);

// Set the provider for the OpenFeature SDK
await Api.Instance.SetProviderAsync(provider);

// Get an OpenFeature client
var client = Api.Instance.GetClient();

// Boolean evaluation (uses IsEnabled)
var enabled = await client.GetBooleanValueAsync("my-feature", false);

// String evaluation (uses variant payload)
var value = await client.GetStringValueAsync("my-variant-flag", "default");

// Integer evaluation (parses variant payload)
var count = await client.GetIntegerValueAsync("my-int-flag", 0);

// Double evaluation (parses variant payload)
var rate = await client.GetDoubleValueAsync("my-double-flag", 0.0);

EvaluationContext and Unleash Context relationship

The provider maps OpenFeature EvaluationContext fields to UnleashContext:

Variant payload type metadata

When evaluating variants (string, integer, double, structure), the provider exposes the Unleash payload type field (e.g., "string", "number", "json", "csv") as payload-type in the resolution details flag metadata.

Events

The provider emits ProviderConfigurationChanged events when Unleash fires TogglesUpdatedEvent (i.e., when toggle state is refreshed from the server).

Known issues and limitations

• The provider does not accept an external IUnleash instance because lifecycle events (ReadyEvent, ErrorEvent, TogglesUpdatedEvent) can only be subscribed during client construction.