Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 2.21 KB

v5_MIGRATION_GUIDE.md

File metadata and controls

46 lines (27 loc) · 2.21 KB
Raw

Migrating to Unleash-Client-Dotnet 5.0.0

This guide highlights the key changes you should be aware of when upgrading to v5.0.0 of the Unleash client.

Custom strategy changes

Custom strategies no longer provide the option to access the constraints in their interface. The method bool IsEnabled(Dictionary<string, string> parameters, UnleashContext context, IEnumerable<Constraint> constraints) no longer exists. Other than that, custom strategies remain unchanged.

Direct access to feature toggles

Direct access to the feature toggle objects through UnleashClient.FeatureToggles has been removed. All classes related to the internal representation of feature toggles are no longer publicly accessible in the SDK.

The SDK now provides a UnleashClient.ListKnownToggles method, which returns a list of feature toggle names, their type, and the project they're bound to.

The client also no longer provides access to listing the variants bound to a feature flag through UnleashClient.GetVariants. We determined that this was exposing internal abstractions that should remain within the SDK. However, if you have a strong use case for this, please open an issue.

Bootstrapping changes

Due to the changes in the previous section, bootstrapping classes are now required to return a String instead of a FeatureToggleCollection. The string should be a JSON string representing the response returned from your Unleash instance's api/client/features endpoint. In practice, that means if you previously had a Read method in your bootstrapping class like so:


public ToggleCollection Read()
{
    var json = settings.FileSystem.ReadAllText(filePath);
    return settings.JsonSerializer.Deserialize<ToggleCollection>(json);
}

You can simplify it to:


public string Read()
{
    return settings.FileSystem.ReadAllText(filePath);
}

Custom serializers

In v4.x and before, the SDK provided the option of mounting a custom JSON serializer. This option has been removed in v5.x; the SDK now relies on System.Text.Json with no option to override it. If you previously provided a custom serializer to access System.Text.Json, it's now safe to remove it.

If you use NewtonSoft you don't have to make any changes.