Skip to content
Open
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
2c42d1f
Add OpenFeature.DependencyInjection.Abstractions project
arttonoyan Sep 29, 2025
4d69c6f
Refactor OpenFeature for DI and provider abstraction
arttonoyan Oct 4, 2025
7e26ba1
Refactor AddProvider API for simplicity and consistency
arttonoyan Oct 4, 2025
1edb0c9
Refactor FeatureLifecycleManager initialization
arttonoyan Oct 4, 2025
6cfaeb7
Refactor tests to use OpenFeatureProviderOptions
arttonoyan Oct 4, 2025
dbdb9b5
Merge branch 'main' into feature/di-abstractions-builder-api-587
arttonoyan Oct 5, 2025
acade51
Merge branch 'main' into feature/di-abstractions-builder-api-587
arttonoyan Oct 9, 2025
10203f3
Merge branch 'main' into feature/di-abstractions-builder-api-587
arttonoyan Oct 20, 2025
3d680f3
Removev ID property
arttonoyan Oct 27, 2025
f9a6781
Merge branch 'feature/di-abstractions-builder-api-587' of https://git…
arttonoyan Oct 27, 2025
4b1237a
Update src/OpenFeature.Hosting/Internal/FeatureLifecycleManager.cs
arttonoyan Nov 5, 2025
04ea063
Update src/OpenFeature.Hosting/Internal/FeatureLifecycleManager.cs
arttonoyan Nov 5, 2025
f521321
Refactor OpenFeatureOptions to OpenFeatureProviderOptions
arttonoyan Nov 5, 2025
08cdb69
Refactor Dependency Injection Abstractions
arttonoyan Nov 6, 2025
9884603
chore: Merge dev into current branch and resolve merge conflicts
arttonoyan Nov 6, 2025
e5e9af6
Merge branch 'main' into feature/di-abstractions-builder-api-587
arttonoyan Nov 6, 2025
e5bc0ca
Merge branch 'main' into feature/di-abstractions-builder-api-587
arttonoyan Nov 6, 2025
d0de7ee
Remove inheritdoc from FeatureLifecycleManager
arttonoyan Nov 6, 2025
0d7e439
Merge branch 'feature/di-abstractions-builder-api-587' of https://git…
arttonoyan Nov 6, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions OpenFeature.slnx
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
<Project Path="samples/AspNetCore/Samples.AspNetCore.csproj" />
</Folder>
<Folder Name="/src/">
<Project Path="src/OpenFeature.DependencyInjection.Abstractions/OpenFeature.DependencyInjection.Abstractions.csproj" />
<Project Path="src/OpenFeature.DependencyInjection/OpenFeature.DependencyInjection.csproj" />
<Project Path="src/OpenFeature.Hosting/OpenFeature.Hosting.csproj" />
<Project Path="src/OpenFeature.Providers.MultiProvider/OpenFeature.Providers.MultiProvider.csproj" />
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace OpenFeature.Hosting.Diagnostics;
namespace OpenFeature.DependencyInjection.Abstractions.Diagnostics;

/// <summary>
/// Contains identifiers for experimental features and diagnostics in the OpenFeature framework.
Expand All @@ -22,7 +22,7 @@ namespace OpenFeature.Hosting.Diagnostics;
/// - "001" - Unique identifier for a specific feature.
/// </code>
/// </example>
internal static class FeatureCodes
public static class FeatureCodes
{
/// <summary>
/// Identifier for the experimental Dependency Injection features within the OpenFeature framework.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFrameworks>netstandard2.0;net8.0;net9.0;net462</TargetFrameworks>
<RootNamespace>OpenFeature.DependencyInjection.Abstractions</RootNamespace>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Should we have these abstractions in their own namespace? Would it be more accessible to have them in say just the OpenFeature namespace?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kylejuliandev Great question - thanks for calling it out.
I’d keep these in their own namespace for now. OpenFeature.DependencyInjection.Abstractions targets provider authors (integrating new providers), not typical app consumers. Keeping it separate avoids cluttering the root OpenFeature namespace and lets us evolve DI-specific types independently.
Of course, I’m open to discussion about this.

Copy link
Member

@askpt askpt Oct 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer the @arttonoyan. This is a very specific Abstraction layer.

I am wondering if we should keep in a OpenFeature.Abstractions instead. This would be a "library" of just OpenFeature related abstractions like "hooks", "provider"... I am happy to keep OpenFeature.DependencyInjection.Abstractions if the rest of the team agrees.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@askpt @kylejuliandev

Proposal
Rename the package to OpenFeature.Providers.DependencyInjection. This name better reflects scope. It is intuitive for provider authors who want to add DI integration.

Follow-up idea
In a separate discussion, consider extracting common provider contracts into OpenFeature.Providers.Abstractions. We would then have two clear packages. OpenFeature.Providers.Abstractions, and OpenFeature.Providers.DependencyInjection.

Why this helps

  • Clear separation. abstractions live in one place, DI glue in another.
  • Thinner provider packages. they depend on Abstractions, optionally on the DI helpers.
  • Cleaner dependency graph. no DI references inside core contracts.
  • Easier discovery on NuGet. consistent OpenFeature.Providers.* naming.

cc: @beeme1mr

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That seems reasonable to me. What would be the proposed release strategy and impact? I believe the DI package is still marked as experimental, so breaking changes are allowed, but we should try and make it as straightforward for users to migrate. Also, I'd hope that we could remove the experimental badge shortly after making this change.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right now our main pain point is coupling. The current abstractions package depends on the OpenFeature SDK because it includes the OpenFeatureProvider abstraction. This means any SDK release. even when it has no provider changes. forces us to bump the abstractions package. Then every provider sees a new version and feels compelled to upgrade. even though nothing changed for providers. Providers should only react to provider related changes.

Decoupling fixes this. If we move provider contracts into OpenFeature.Providers.Abstractions. we isolate them from SDK churn. The DI helpers stay in OpenFeature.Providers.DependencyInjection. Result. cleaner dependency graph. fewer unnecessary upgrades. thinner provider packages. and clearer ownership of changes.

I realize this is a significant change, and it needs attentive and careful attention. If the direction sounds reasonable, I can open a PR to rename the DI package, then draft a proposal for the abstractions split.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds reasonable to me. We've been looking into something similar (minus the DI part) in Java. FYI @chrfwow @toddbaert

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great. I’ll proceed and rename the package to OpenFeature.Providers.DependencyInjection in this PR.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@arttonoyan @beeme1mr @kylejuliandev: I think this is a great discussion.

I would propose for 2.9 to create:

  • OpenFeature.Providers.DependencyInjection (this PR)

For 2.10:

  • OpenFeature.Providers.Abstractions
  • OpenFeature.Hooks.Abstractions

The story that is happening in Providers, is also true for the Hooks.

</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" />
<PackageReference Include="Microsoft.Extensions.Options" />
</ItemGroup>

<ItemGroup>
<InternalsVisibleTo Include="OpenFeature.Hosting.Tests" />
<InternalsVisibleTo Include="DynamicProxyGenAssembly2" />
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\OpenFeature\OpenFeature.csproj" />
</ItemGroup>

</Project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
using Microsoft.Extensions.DependencyInjection;

namespace OpenFeature.DependencyInjection.Abstractions;

/// <summary>
/// Describes a <see cref="OpenFeatureProviderBuilder"/> backed by an <see cref="IServiceCollection"/>.
/// </summary>
public abstract class OpenFeatureProviderBuilder(IServiceCollection services)
{
/// <summary> The services being configured. </summary>
public IServiceCollection Services { get; } = services;

/// <summary>
/// Gets a value indicating whether a default provider has been registered.
/// </summary>
public bool HasDefaultProvider { get; internal set; }

/// <summary>
/// Gets the count of domain-bound providers that have been registered.
/// This count does not include the default provider.
/// </summary>
public int DomainBoundProviderRegistrationCount { get; internal set; }

/// <summary>
/// Indicates whether the policy has been configured.
/// </summary>
public bool IsPolicyConfigured { get; internal set; }

/// <summary>
/// Validates the current configuration, ensuring that a policy is set when multiple providers are registered
/// or when a default provider is registered alongside another provider.
/// </summary>
/// <exception cref="InvalidOperationException">
/// Thrown if multiple providers are registered without a policy, or if both a default provider
/// and an additional provider are registered without a policy configuration.
/// </exception>
public void Validate()
{
if (IsPolicyConfigured)
{
return;
}

if (DomainBoundProviderRegistrationCount > 1)
{
throw new InvalidOperationException("Multiple providers have been registered, but no policy has been configured.");
}

if (HasDefaultProvider && DomainBoundProviderRegistrationCount == 1)
{
throw new InvalidOperationException("A default provider and an additional provider have been registered without a policy configuration.");
}
}

/// <summary>
/// Adds an IFeatureClient to the container. If <paramref name="name"/> is supplied,
/// registers a domain-bound client; otherwise registers a global client. If an evaluation context is
/// configured, it is applied at resolve-time.
/// </summary>
/// <returns>The current <see cref="OpenFeatureProviderBuilder"/>.</returns>
internal protected abstract OpenFeatureProviderBuilder TryAddClient(string? name = null);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection.Extensions;
using OpenFeature.DependencyInjection.Abstractions;

namespace OpenFeature;

/// <summary>
/// Contains extension methods for the <see cref="OpenFeatureProviderBuilder"/> class.
/// </summary>
#if NET8_0_OR_GREATER
[System.Diagnostics.CodeAnalysis.Experimental(DependencyInjection.Abstractions.Diagnostics.FeatureCodes.NewDi)]
#endif
public static partial class OpenFeatureProviderBuilderExtensions
{
/// <summary>
/// Adds a feature provider using a factory method without additional configuration options.
/// This method adds the feature provider as a transient service and sets it as the default provider within the application.
/// </summary>
/// <param name="builder">The <see cref="OpenFeatureProviderBuilder"/> used to configure feature flags.</param>
/// <param name="implementationFactory">
/// A factory method that creates and returns a <see cref="FeatureProvider"/>
/// instance based on the provided service provider.
/// </param>
/// <returns>The updated <see cref="OpenFeatureProviderBuilder"/> instance with the default feature provider set and configured.</returns>
/// <exception cref="ArgumentNullException">Thrown if the <paramref name="builder"/> is null, as a valid builder is required to add and configure providers.</exception>
public static OpenFeatureProviderBuilder AddProvider(this OpenFeatureProviderBuilder builder, Func<IServiceProvider, FeatureProvider> implementationFactory)
=> AddProvider<OpenFeatureProviderOptions>(builder, implementationFactory, null);

/// <summary>
/// Adds a feature provider using a factory method to create the provider instance and optionally configures its settings.
/// This method adds the feature provider as a transient service and sets it as the default provider within the application.
/// </summary>
/// <typeparam name="TOptions"> Type derived from <see cref="OpenFeatureProviderBuilder"/> used to configure the feature provider.</typeparam>
/// <param name="builder">The <see cref="OpenFeatureProviderBuilder"/> used to configure feature flags.</param>
/// <param name="implementationFactory">
/// A factory method that creates and returns a <see cref="FeatureProvider"/>
/// instance based on the provided service provider.
/// </param>
/// <param name="configureOptions">An optional delegate to configure the provider-specific options.</param>
/// <returns>The updated <see cref="OpenFeatureProviderBuilder"/> instance with the default feature provider set and configured.</returns>
/// <exception cref="ArgumentNullException">Thrown if the <paramref name="builder"/> is null, as a valid builder is required to add and configure providers.</exception>
public static OpenFeatureProviderBuilder AddProvider<TOptions>(this OpenFeatureProviderBuilder builder, Func<IServiceProvider, FeatureProvider> implementationFactory, Action<TOptions>? configureOptions)
where TOptions : OpenFeatureProviderOptions
{
if (builder == null) throw new ArgumentNullException(nameof(builder));

builder.HasDefaultProvider = true;
builder.Services.PostConfigure<TOptions>(options => options.AddDefaultProviderName());
if (configureOptions != null)
{
builder.Services.Configure(configureOptions);
}

builder.Services.TryAddTransient(implementationFactory);
builder.TryAddClient();
return builder;
}

/// <summary>
/// Adds a feature provider for a specific domain using provided options and a configuration builder.
/// </summary>
/// <typeparam name="TOptions"> Type derived from <see cref="OpenFeatureProviderBuilder"/> used to configure the feature provider.</typeparam>
/// <param name="builder">The <see cref="OpenFeatureProviderBuilder"/> used to configure feature flags.</param>
/// <param name="domain">The unique name of the provider.</param>
/// <param name="implementationFactory">
/// A factory method that creates a feature provider instance.
/// It adds the provider as a transient service unless it is already added.
/// </param>
/// <param name="configureOptions">An optional delegate to configure the provider-specific options.</param>
/// <returns>The updated <see cref="OpenFeatureProviderBuilder"/> instance with the new feature provider configured.</returns>
/// <exception cref="ArgumentNullException">
/// Thrown if either <paramref name="builder"/> or <paramref name="domain"/> is null or if the <paramref name="domain"/> is empty.
/// </exception>
public static OpenFeatureProviderBuilder AddProvider<TOptions>(this OpenFeatureProviderBuilder builder, string domain, Func<IServiceProvider, string, FeatureProvider> implementationFactory, Action<TOptions>? configureOptions)
where TOptions : OpenFeatureProviderOptions
{
if (builder == null) throw new ArgumentNullException(nameof(builder));

builder.DomainBoundProviderRegistrationCount++;

builder.Services.PostConfigure<TOptions>(options => options.AddProviderName(domain));
if (configureOptions != null)
{
builder.Services.Configure(domain, configureOptions);
}

builder.Services.TryAddKeyedTransient(domain, (provider, key) =>
{
if (key == null)
{
throw new ArgumentNullException(nameof(key));
}
return implementationFactory(provider, key.ToString()!);
});

builder.TryAddClient(domain);
return builder;
}

/// <summary>
/// Adds a feature provider for a specified domain using the default options.
/// This method configures a feature provider without custom options, delegating to the more generic AddProvider method.
/// </summary>
/// <param name="builder">The <see cref="OpenFeatureProviderBuilder"/> used to configure feature flags.</param>
/// <param name="domain">The unique name of the provider.</param>
/// <param name="implementationFactory">
/// A factory method that creates a feature provider instance.
/// It adds the provider as a transient service unless it is already added.
/// </param>
/// <returns>The updated <see cref="OpenFeatureProviderBuilder"/> instance with the new feature provider configured.</returns>
/// <exception cref="ArgumentNullException">
/// Thrown if either <paramref name="builder"/> or <paramref name="domain"/> is null or if the <paramref name="domain"/> is empty.
/// </exception>
public static OpenFeatureProviderBuilder AddProvider(this OpenFeatureProviderBuilder builder, string domain, Func<IServiceProvider, string, FeatureProvider> implementationFactory)
=> AddProvider<OpenFeatureProviderOptions>(builder, domain, implementationFactory, configureOptions: null);

/// <summary>
/// Configures policy name options for OpenFeature using the specified options type.
/// </summary>
/// <typeparam name="TOptions">The type of options used to configure <see cref="OpenFeatureProviderOptions"/>.</typeparam>
/// <param name="builder">The <see cref="OpenFeatureProviderBuilder"/> instance.</param>
/// <param name="configureOptions">A delegate to configure <typeparamref name="TOptions"/>.</param>
/// <returns>The configured <see cref="OpenFeatureProviderBuilder"/> instance.</returns>
/// <exception cref="ArgumentNullException">Thrown when the <paramref name="builder"/> or <paramref name="configureOptions"/> is null.</exception>
public static OpenFeatureProviderBuilder AddPolicyName<TOptions>(this OpenFeatureProviderBuilder builder, Action<TOptions> configureOptions)
where TOptions : PolicyNameOptions
{
if (builder == null) throw new ArgumentNullException(nameof(builder));
if (configureOptions == null) throw new ArgumentNullException(nameof(configureOptions));

builder.IsPolicyConfigured = true;

builder.Services.Configure(configureOptions);
return builder;
}

/// <summary>
/// Configures the default policy name options for OpenFeature.
/// </summary>
/// <param name="builder">The <see cref="OpenFeatureProviderBuilder"/> instance.</param>
/// <param name="configureOptions">A delegate to configure <see cref="OpenFeatureProviderBuilder"/>.</param>
/// <returns>The configured <see cref="OpenFeatureProviderBuilder"/> instance.</returns>
public static OpenFeatureProviderBuilder AddPolicyName(this OpenFeatureProviderBuilder builder, Action<PolicyNameOptions> configureOptions)
=> AddPolicyName<PolicyNameOptions>(builder, configureOptions);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
using System.Collections.ObjectModel;

namespace OpenFeature.DependencyInjection.Abstractions;

/// <summary>
/// Provider-focused options for configuring OpenFeature integrations.
/// Contains only contracts and metadata that integrations may need.
/// </summary>
public class OpenFeatureProviderOptions
{
private readonly HashSet<string> _providerNames = [];

/// <summary>
/// Determines if a default provider has been registered.
/// </summary>
public bool HasDefaultProvider { get; private set; }

/// <summary>
/// The <see cref="Type"/> of the configured feature provider, if any.
/// Typically set by higher-level configuration.
/// </summary>
public Type FeatureProviderType { get; protected internal set; } = null!;

/// <summary>
/// Gets a read-only list of registered provider names.
/// </summary>
public IReadOnlyCollection<string> ProviderNames
{
get
{
lock (_providerNames)
{
return new ReadOnlyCollection<string>([.. _providerNames]);
}
}
}

/// <summary>
/// Registers the default provider name if no specific name is provided.
/// Sets <see cref="HasDefaultProvider"/> to true.
/// </summary>
internal void AddDefaultProviderName() => AddProviderName(null);

/// <summary>
/// Registers a new feature provider name. This operation is thread-safe.
/// </summary>
/// <param name="name">The name of the feature provider to register. Registers as default if null.</param>
internal void AddProviderName(string? name)
{
if (string.IsNullOrWhiteSpace(name))
{
HasDefaultProvider = true;
return;
}

lock (_providerNames)
{
_providerNames.Add(name!);
}
}
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace OpenFeature.Hosting;
namespace OpenFeature.DependencyInjection.Abstractions;

/// <summary>
/// Options to configure the default feature client name.
Expand Down
17 changes: 16 additions & 1 deletion src/OpenFeature.Hosting/Internal/FeatureLifecycleManager.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using OpenFeature.DependencyInjection.Abstractions;

namespace OpenFeature.Hosting.Internal;

Expand All @@ -22,7 +23,14 @@ public async ValueTask EnsureInitializedAsync(CancellationToken cancellationToke
{
this.LogStartingInitializationOfFeatureProvider();

var options = _serviceProvider.GetRequiredService<IOptions<OpenFeatureOptions>>().Value;
await InitializeProvidersAsync(cancellationToken).ConfigureAwait(false);
InitializeHooks();
InitializeHandlers();
}

private async Task InitializeProvidersAsync(CancellationToken cancellationToken)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cancellationToken seems to not be used here.

{
var options = _serviceProvider.GetRequiredService<IOptions<OpenFeatureProviderOptions>>().Value;
if (options.HasDefaultProvider)
{
var featureProvider = _serviceProvider.GetRequiredService<FeatureProvider>();
Expand All @@ -34,7 +42,11 @@ public async ValueTask EnsureInitializedAsync(CancellationToken cancellationToke
var featureProvider = _serviceProvider.GetRequiredKeyedService<FeatureProvider>(name);
await _featureApi.SetProviderAsync(name, featureProvider).ConfigureAwait(false);
}
}

private void InitializeHooks()
{
var options = _serviceProvider.GetRequiredService<IOptions<OpenFeatureOptions>>().Value;
var hooks = new List<Hook>();
foreach (var hookName in options.HookNames)
{
Expand All @@ -43,7 +55,10 @@ public async ValueTask EnsureInitializedAsync(CancellationToken cancellationToke
}

_featureApi.AddHooks(hooks);
}

private void InitializeHandlers()
{
var handlers = _serviceProvider.GetServices<EventHandlerDelegateWrapper>();
foreach (var handler in handlers)
{
Expand Down
1 change: 1 addition & 0 deletions src/OpenFeature.Hosting/OpenFeature.Hosting.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\OpenFeature.DependencyInjection.Abstractions\OpenFeature.DependencyInjection.Abstractions.csproj" />
<ProjectReference Include="..\OpenFeature\OpenFeature.csproj" />
</ItemGroup>

Expand Down
Loading