Wookashi.FeatureSwitcher.Client.Implementation
0.8.0
dotnet add package Wookashi.FeatureSwitcher.Client.Implementation --version 0.8.0
NuGet\Install-Package Wookashi.FeatureSwitcher.Client.Implementation -Version 0.8.0
<PackageReference Include="Wookashi.FeatureSwitcher.Client.Implementation" Version="0.8.0" />
<PackageVersion Include="Wookashi.FeatureSwitcher.Client.Implementation" Version="0.8.0" />
<PackageReference Include="Wookashi.FeatureSwitcher.Client.Implementation" />
paket add Wookashi.FeatureSwitcher.Client.Implementation --version 0.8.0
#r "nuget: Wookashi.FeatureSwitcher.Client.Implementation, 0.8.0"
#:package Wookashi.FeatureSwitcher.Client.Implementation@0.8.0
#addin nuget:?package=Wookashi.FeatureSwitcher.Client.Implementation&version=0.8.0
#tool nuget:?package=Wookashi.FeatureSwitcher.Client.Implementation&version=0.8.0
Feature Switcher Client
.NET client SDK for Feature Switcher - a distributed feature flag management system.
Installation
dotnet add package Wookashi.FeatureSwitcher.Client.Implementation
Quick Start with Dependency Injection
using Wookashi.FeatureSwitcher.Client.Implementation;
// Define your features and register with DI
var config = new FeatureSwitcherBasicClientConfiguration(
applicationName: "MyApp",
environmentName: "Production",
nodeAddress: new Uri("http://localhost:8081/"));
services.AddFeatureFlags(
config,
new List<IFeatureStateModel>
{
new FeatureStateModel("DarkMode", initialState: false),
new FeatureStateModel("NewCheckout", initialState: true),
});
Then inject IFeatureManager in your classes:
public class MyService
{
private readonly IFeatureManager _featureManager;
public MyService(IFeatureManager featureManager)
{
_featureManager = featureManager;
}
public async Task DoSomethingAsync()
{
if (await _featureManager.IsFeatureEnabledAsync("DarkMode"))
{
// Feature is enabled
}
}
}
Manual Initialization (without DI)
using Microsoft.Extensions.DependencyInjection;
using Wookashi.FeatureSwitcher.Client.Implementation;
// 1. Set up HttpClientFactory
var serviceProvider = new ServiceCollection().AddHttpClient().BuildServiceProvider();
var httpClientFactory = serviceProvider.GetRequiredService<IHttpClientFactory>();
// 2. Define your features
var features = new List<FeatureStateModel>
{
new("DarkMode", initialState: false),
new("NewCheckout", initialState: true),
};
// 3. Create and initialize
var featureManager = new FeatureManager(
applicationName: "MyApp",
environmentName: "Production",
nodeAddress: new Uri("http://localhost:8081/"),
features: features,
httpClientFactory: httpClientFactory);
await featureManager.RegisterFeaturesOnNodeAsync();
// 4. Check feature states
if (await featureManager.IsFeatureEnabledAsync("DarkMode"))
{
// Feature is enabled
}
Configuration
FeatureSwitcherBasicClientConfiguration parameters:
| Parameter | Description |
|---|---|
applicationName |
Unique identifier for your application |
environmentName |
Environment name (e.g., Development, Production) |
nodeAddress |
URI of the Feature Switcher Node service |
allowStartWithoutNode |
Optional. When true, the host starts even if the Node is unreachable during startup registration. Features serve their initialState until the Node becomes reachable. Defaults to false. |
AddFeatureFlags also takes the list of features to manage.
Lifecycle on the Node
Registration is append-only on the Node. New features are inserted; features missing from the payload are NOT deleted at registration time, so two services that accidentally share an applicationName cannot wipe each other's flags. Every registration and every state read bumps LastUsedAt on the feature and upserts today's row in the per-day usage counter.
A background sweep on the Node periodically marks features (and applications) whose LastUsedAt is older than the configured stale threshold (default 30 days) as PendingDeletion. Flags in PendingDeletion:
- Disappear from the normal
/applications/{app}/featureslisting - Are auto-restored if the client reads or re-registers them
- Can be permanently deleted by an admin through the Manager UI (with a 409-on-race guard so a stale dialog cannot delete a freshly-restored flag)
So from the client's perspective: flags removed from your application code disappear automatically after the threshold passes without any uses. Flags still actively read survive indefinitely without redeploys.
Resilience
The client caches feature states locally. If the Node service becomes unreachable, the client falls back to cached values, ensuring your application continues to function.
Tolerating an unreachable Node at startup
By default, AddFeatureFlags registers a hosted service that calls RegisterFeaturesOnNodeAsync on startup. If the Node is unreachable, registration throws NodeUnreachableException and the host fails to start.
Set allowStartWithoutNode: true on the configuration to let the application boot anyway. The failure is logged as a warning and features serve their initialState until subsequent IsFeatureEnabledAsync calls successfully reach the Node:
var config = new FeatureSwitcherBasicClientConfiguration(
applicationName: "MyApp",
environmentName: "Production",
nodeAddress: new Uri("http://localhost:8081/"),
allowStartWithoutNode: true);
services.AddFeatureFlags(config, features);
Only NodeUnreachableException is suppressed. EnvironmentMismatchException and RegistrationException (errors returned by a reachable Node) still abort startup because they indicate misconfiguration rather than a transient connectivity issue.
Documentation
For full documentation, visit the GitHub repository.
License
Licensed under the Wookashi.FeatureSwitcher Community License v1.0. See LICENSE.txt for details.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.7)
- System.Text.Json (>= 10.0.7)
- Wookashi.FeatureSwitcher.Client.Abstraction (>= 0.8.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.