Toggly.FeatureManagement 2.0.1

.NET 5.0 .NET Core 3.1 .NET Standard 2.1
There is a newer version of this package available.
See the version list below for details.
dotnet add package Toggly.FeatureManagement --version 2.0.1
NuGet\Install-Package Toggly.FeatureManagement -Version 2.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Toggly.FeatureManagement" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Toggly.FeatureManagement --version 2.0.1
#r "nuget: Toggly.FeatureManagement, 2.0.1"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Toggly.FeatureManagement as a Cake Addin
#addin nuget:?package=Toggly.FeatureManagement&version=2.0.1

// Install Toggly.FeatureManagement as a Cake Tool
#tool nuget:?package=Toggly.FeatureManagement&version=2.0.1

ASP.NET Core Feature Flags with Toggly

Quality Gate Status Vulnerabilities Coverage CodeQL Nuget

Feature flags provide a way for ASP.NET Core applications to turn features on or off dynamically. Developers can use feature flags in simple use cases like conditional statements to more advanced scenarios like conditionally adding routes or MVC filters. Feature flags build on top of the .NET Core configuration system. Any .NET Core configuration provider is capable of acting as the back-bone for feature flags.

Here are some of the benefits of using this library:

  • Built on https://github.com/microsoft/FeatureManagement-Dotnet
  • A common convention for feature management
  • Feature Flag lifetime management
    • Configuration values can change in real-time, feature flags can be consistent across the entire request
  • Simple to Complex Scenarios Covered
    • Toggle on/off features through declarative configuration file
    • Dynamically evaluate state of feature based on call to server
  • API extensions for ASP.NET Core and MVC framework
    • Routing
    • Filters
    • Action Attributes

API Reference: https://go.microsoft.com/fwlink/?linkid=2091700

Feature Flags

Feature flags are composed of two parts, a name and a list of feature-filters that are used to turn the feature on.

Feature Filters

Feature filters define a scenario for when a feature should be enabled. When a feature is evaluated for whether it is on or off, its list of feature-filters are traversed until one of the filters decides the feature should be enabled. At this point the feature is considered enabled and traversal through the feature filters stops. If no feature filter indicates that the feature should be enabled, then it will be considered disabled.

As an example, a Microsoft Edge browser feature filter could be designed. This feature filter would activate any features it is attached to as long as an HTTP request is coming from Microsoft Edge.

Registration

The .NET Core TogglyFeatureProvider is used to retrieve the latest feature flag configuration from toggly.

Referencing

To make it easier to reference these feature flags in code, we recommend to define feature flag variables like below.

// Define feature flags in an enum
public enum MyFeatureFlags
{
    FeatureT,
    FeatureU,
    FeatureV
}

Service Registration

Feature flags rely on .NET Core dependency injection. We can register the feature management services using standard conventions.

using Microsoft.FeatureManagement;
using Microsoft.FeatureManagement.FeatureFilters;

public class Startup
{
  public void ConfigureServices(IServiceCollection services)
  {
      services.AddFeatureManagement()
              .AddFeatureFilter<PercentageFilter>()
              .AddFeatureFilter<TimeWindowFilter>();
  }
}

Adding the Toggly Feature Provider

Add a section to your configuration provider, ex: appsettings.json (or environment variables, key vault, etc)

"Toggly": {
    "AppKey": "[[toggly app key]]",
    "Environment": "Production",
    "BaseUrl": "https://app.toggly.io/"
  }

In your Startup.cs, register the Toggly Feature Provider

builder.Services.AddOptions();
builder.Services.Configure<TogglySettings>(builder.Configuration.GetSection("Toggly"));

builder.Services.AddSingleton<IFeatureDefinitionProvider, TogglyFeatureProvider>();

Consumption

The simplest use case for feature flags is to do a conditional check for whether a feature is enabled to take different paths in code. The uses cases grow from there as the feature flag API begins to offer extensions into ASP.NET Core.

Feature Check

The basic form of feature management is checking if a feature is enabled and then performing actions based on the result. This is done through the IFeatureManager's IsEnabledAsync method.

�
IFeatureManager featureManager;
�
if (await featureManager.IsEnabledAsync(nameof(MyFeatureFlags.FeatureU)))
{
    // Do something
}

Dependency Injection

When using the feature management library with MVC, the IFeatureManager can be obtained through dependency injection.

public class HomeController : Controller
{
    private readonly IFeatureManager _featureManager;
    
    public HomeController(IFeatureManager featureManager)
    {
        _featureManager = featureManager;
    }
}

Controllers and Actions

MVC controller and actions can require that a given feature, or one of any list of features, be enabled in order to execute. This can be done by using a FeatureGateAttribute, which can be found in the Microsoft.FeatureManagement.Mvc namespace.

[FeatureGate(MyFeatureFlags.FeatureX)]
public class HomeController : Controller
{
    �
}

The HomeController above is gated by "FeatureX". "FeatureX" must be enabled before any action the HomeController contains can be executed.

[FeatureGate(MyFeatureFlags.FeatureY)]
public IActionResult Index()
{
    return View();
}

The Index MVC action above requires "FeatureY" to be enabled before it can execute.

Disabled Action Handling

When an MVC controller or action is blocked because none of the features it specifies are enabled, a registered IDisabledFeaturesHandler will be invoked. By default, a minimalistic handler is registered which returns HTTP 404. This can be overridden using the IFeatureManagementBuilder when registering feature flags.

public interface IDisabledFeaturesHandler
{
    Task HandleDisabledFeature(IEnumerable<string> features, ActionExecutingContext context);
}

View

In MVC views <feature> tags can be used to conditionally render content based on whether a feature is enabled or not.

<feature name=@nameof(MyFeatureFlags.FeatureX)>
  <p>This can only be seen if 'FeatureX' is enabled.</p>
</feature>

The <feature> tag requires a tag helper to work. This can be done by adding the feature management tag helper to the ViewImports.cshtml file.

@addTagHelper *, Microsoft.FeatureManagement.AspNetCore

MVC Filters

MVC action filters can be set up to conditionally execute based on the state of a feature. This is done by registering MVC filters in a feature aware manner. The feature management pipeline supports async MVC Action filters, which implement IAsyncActionFilter.

services.AddMvc(o => 
{
    o.Filters.AddForFeature<SomeMvcFilter>(nameof(MyFeatureFlags.FeatureV));
});

The code above adds an MVC filter named SomeMvcFilter. This filter is only triggered within the MVC pipeline if the feature it specifies, "FeatureV", is enabled.

Application building

The feature management library can be used to add application branches and middleware that execute conditionally based on feature state.

app.UseMiddlewareForFeature<ThirdPartyMiddleware>(nameof(MyFeatureFlags.FeatureU));

With the above call, the application adds a middleware component that only appears in the request pipeline if the feature "FeatureU" is enabled. If the feature is enabled/disabled during runtime, the middleware pipeline can be changed dynamically.

This builds off the more generic capability to branch the entire application based on a feature.

app.UseForFeature(featureName, appBuilder => 
{
    appBuilder.UseMiddleware<T>();
});

Missing Feature Filters

If a feature is configured to be enabled for a specific feature filter and that feature filter hasn't been registered, then an exception will be thrown when the feature is evaluated. The exception can be disabled by using the feature management options.

services.Configure<FeatureManagementOptions>(options =>
{
    options.IgnoreMissingFeatureFilters = true;
});

Using HttpContext

Feature filters can evaluate whether a feature should be enabled based off the properties of an HTTP Request. This is performed by inspecting the HTTP Context. A feature filter can get a reference to the HTTP Context by obtaining an IHttpContextAccessor through dependency injection.

public class BrowserFilter : IFeatureFilter
{
    private readonly IHttpContextAccessor _httpContextAccessor;

    public BrowserFilter(IHttpContextAccessor httpContextAccessor)
    {
        _httpContextAccessor = httpContextAccessor ?? throw new ArgumentNullException(nameof(httpContextAccessor));
    }
}

The IHttpContextAccessor must be added to the dependency injection container on startup for it to be available. It can be registered in the IServiceCollection using the following method.

public void ConfigureServices(IServiceCollection services)
{
    �
    services.TryAddSingleton<IHttpContextAccessor, HttpContextAccessor>();
    �
}

Providing a Context For Feature Evaluation

In console applications there is no ambient context such as HttpContext that feature filters can acquire and utilize to check if a feature should be on or off. In this case, applications need to provide an object representing a context into the feature management system for use by feature filters. This is done by using IFeatureManager.IsEnabledAsync<TContext>(string featureName, TContext appContext). The appContext object that is provided to the feature manager can be used by feature filters to evaluate the state of a feature.

MyAppContext context = new MyAppContext
{
    AccountId = current.Id;
}

if (await featureManager.IsEnabledAsync(feature, context))
{
�
}
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.1
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Toggly.FeatureManagement:

Package Downloads
Toggly.FeatureManagement.Storage.RavenDB

Package Description

Toggly.FeatureManagement.Web

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.1.19 63 11/29/2022
2.1.18 132 11/27/2022
2.1.17 76 11/27/2022
2.1.16 145 11/14/2022
2.1.15 1,878 8/19/2022
2.1.14 543 8/7/2022
2.1.13 321 8/7/2022
2.1.12 316 8/5/2022
2.1.11 853 7/22/2022
2.1.10 396 7/21/2022
2.1.9 511 7/14/2022
2.1.8 345 7/14/2022
2.1.7 366 7/7/2022
2.1.6 432 7/6/2022
2.1.5 481 6/20/2022
2.1.4 341 6/20/2022
2.1.3 342 6/19/2022
2.1.2 356 6/16/2022
2.1.1 350 6/16/2022
2.1.0 442 6/15/2022
2.0.2 405 6/9/2022
2.0.1 387 6/7/2022
2.0.0 352 6/5/2022
1.9.3 1,874 5/7/2022
1.9.2 464 5/4/2022
1.9.1 416 5/3/2022
1.9.0 399 5/3/2022
1.8.0 301 4/26/2022
1.7.3 313 4/24/2022
1.7.2 286 4/24/2022
1.7.1 279 4/24/2022
1.7.0 288 4/24/2022
1.6.5 238 4/23/2022
1.6.4 231 4/22/2022
1.6.3 1,056 3/30/2022
1.6.2 255 3/28/2022
1.6.1 232 3/27/2022
1.5.0 968 1/30/2022
1.4.1 254 1/16/2022
1.4.0 169 1/15/2022
1.3.0 173 1/14/2022
1.2.0 235 12/26/2021
1.1.0 192 12/22/2021
0.1.0 81 11/27/2022