feat!: Add support for provider shutdown and status. (#158)

Signed-off-by: Ryan Lamb <[email protected]>
Co-authored-by: Todd Baert <[email protected]>

README.md

@@ -72,7 +72,7 @@ dotnet add package OpenFeature
 public async Task Example()
         {
             // Register your feature flag provider
-            Api.Instance.SetProvider(new InMemoryProvider());
+            await Api.Instance.SetProvider(new InMemoryProvider());
 
             // Create a new client
             FeatureClient client = Api.Instance.GetClient();
@@ -97,7 +97,7 @@ public async Task Example()
 | ✅     | [Logging](#logging)             | Integrate with popular logging packages.                                                                                           |
 | ✅     | [Named clients](#named-clients) | Utilize multiple providers in a single application.                                                                                |
 | ❌     | [Eventing](#eventing)           | React to state changes in the provider or flag management system.                                                                  |
-| ❌     | [Shutdown](#shutdown)           | Gracefully clean up a provider during application shutdown.                                                                        |
+| ✅    | [Shutdown](#shutdown)           | Gracefully clean up a provider during application shutdown.                                                                        |
 | ✅     | [Extending](#extending)         | Extend OpenFeature with custom providers and hooks.                                                                                |
 
 <sub>Implemented: ✅ | In-progress: ⚠️ | Not implemented yet: ❌</sub>
@@ -112,7 +112,7 @@ If the provider you're looking for hasn't been created yet, see the [develop a p
 Once you've added a provider as a dependency, it can be registered with OpenFeature like this:
 
 ```csharp
-Api.Instance.SetProvider(new MyProvider());
+await Api.Instance.SetProvider(new MyProvider());
 ```
 
 In some situations, it may be beneficial to register multiple providers in the same application.
@@ -179,9 +179,9 @@ If a name has no associated provider, the global provider is used.
 
 ```csharp
 // registering the default provider
-Api.Instance.SetProvider(new LocalProvider());
+await Api.Instance.SetProvider(new LocalProvider());
 // registering a named provider
-Api.Instance.SetProvider("clientForCache", new CachedProvider());
+await Api.Instance.SetProvider("clientForCache", new CachedProvider());
 
 // a client backed by default provider
  FeatureClient clientDefault = Api.Instance.GetClient();
@@ -196,7 +196,12 @@ Events are currently not supported by the .NET SDK. Progress on this feature can
 
 ### Shutdown
 
-A shutdown handler is not yet available in the .NET SDK. Progress on this feature can be tracked [here](https://github.com/open-feature/dotnet-sdk/issues/126).
+The OpenFeature API provides a close function to perform a cleanup of all registered providers. This should only be called when your application is in the process of shutting down.
+
+```csharp
+// Shut down all providers
+await Api.Instance.Shutdown();
+```
 
 ## Extending
 

src/OpenFeature/Api.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading;
+using System.Threading.Tasks;
 using Microsoft.Extensions.Logging;
 using OpenFeature.Model;
 
@@ -15,14 +16,12 @@ namespace OpenFeature
     public sealed class Api
     {
         private EvaluationContext _evaluationContext = EvaluationContext.Empty;
-        private FeatureProvider _defaultProvider = new NoOpFeatureProvider();
-        private readonly ConcurrentDictionary<string, FeatureProvider> _featureProviders =
-            new ConcurrentDictionary<string, FeatureProvider>();
+        private readonly ProviderRepository _repository = new ProviderRepository();
         private readonly ConcurrentStack<Hook> _hooks = new ConcurrentStack<Hook>();
 
         /// The reader/writer locks are not disposed because the singleton instance should never be disposed.
         private readonly ReaderWriterLockSlim _evaluationContextLock = new ReaderWriterLockSlim();
-        private readonly ReaderWriterLockSlim _featureProviderLock = new ReaderWriterLockSlim();
+
 
         /// <summary>
         /// Singleton instance of Api
@@ -36,31 +35,26 @@ static Api() { }
         private Api() { }
 
         /// <summary>
-        /// Sets the feature provider
+        /// Sets the feature provider. In order to wait for the provider to be set, and initialization to complete,
+        /// await the returned task.
         /// </summary>
+        /// <remarks>The provider cannot be set to null. Attempting to set the provider to null has no effect.</remarks>
         /// <param name="featureProvider">Implementation of <see cref="FeatureProvider"/></param>
-        public void SetProvider(FeatureProvider featureProvider)
+        public async Task SetProvider(FeatureProvider featureProvider)
         {
-            this._featureProviderLock.EnterWriteLock();
-            try
-            {
-                this._defaultProvider = featureProvider ?? this._defaultProvider;
-            }
-            finally
-            {
-                this._featureProviderLock.ExitWriteLock();
-            }
+            await this._repository.SetProvider(featureProvider, this.GetContext()).ConfigureAwait(false);
         }
 
+
         /// <summary>
-        /// Sets the feature provider to given clientName
+        /// Sets the feature provider to given clientName. In order to wait for the provider to be set, and
+        /// initialization to complete, await the returned task.
         /// </summary>
         /// <param name="clientName">Name of client</param>
         /// <param name="featureProvider">Implementation of <see cref="FeatureProvider"/></param>
-        public void SetProvider(string clientName, FeatureProvider featureProvider)
+        public async Task SetProvider(string clientName, FeatureProvider featureProvider)
         {
-            this._featureProviders.AddOrUpdate(clientName, featureProvider,
-                (key, current) => featureProvider);
+            await this._repository.SetProvider(clientName, featureProvider, this.GetContext()).ConfigureAwait(false);
         }
 
         /// <summary>
@@ -76,15 +70,7 @@ public void SetProvider(string clientName, FeatureProvider featureProvider)
         /// <returns><see cref="FeatureProvider"/></returns>
         public FeatureProvider GetProvider()
         {
-            this._featureProviderLock.EnterReadLock();
-            try
-            {
-                return this._defaultProvider;
-            }
-            finally
-            {
-                this._featureProviderLock.ExitReadLock();
-            }
+            return this._repository.GetProvider();
         }
 
         /// <summary>
@@ -95,17 +81,9 @@ public FeatureProvider GetProvider()
         /// have a corresponding provider the default provider will be returned</returns>
         public FeatureProvider GetProvider(string clientName)
         {
-            if (string.IsNullOrEmpty(clientName))
-            {
-                return this.GetProvider();
-            }
-
-            return this._featureProviders.TryGetValue(clientName, out var featureProvider)
-                ? featureProvider
-                : this.GetProvider();
+            return this._repository.GetProvider(clientName);
         }
 
-
         /// <summary>
         /// Gets providers metadata
         /// <para>
@@ -210,5 +188,19 @@ public EvaluationContext GetContext()
                 this._evaluationContextLock.ExitReadLock();
             }
         }
+
+        /// <summary>
+        /// <para>
+        /// Shut down and reset the current status of OpenFeature API.
+        /// </para>
+        /// <para>
+        /// This call cleans up all active providers and attempts to shut down internal event handling mechanisms.
+        /// Once shut down is complete, API is reset and ready to use again.
+        /// </para>
+        /// </summary>
+        public async Task Shutdown()
+        {
+            await this._repository.Shutdown().ConfigureAwait(false);
+        }
     }
 }

src/OpenFeature/Constant/ProviderStatus.cs

@@ -0,0 +1,31 @@
+using System.ComponentModel;
+
+namespace OpenFeature.Constant
+{
+    /// <summary>
+    /// The state of the provider.
+    /// </summary>
+    /// <seealso href="https://github.com/open-feature/spec/blob/main/specification/sections/02-providers.md#requirement-242" />
+    public enum ProviderStatus
+    {
+        /// <summary>
+        /// The provider has not been initialized and cannot yet evaluate flags.
+        /// </summary>
+        [Description("NOT_READY")] NotReady,
+
+        /// <summary>
+        /// The provider is ready to resolve flags.
+        /// </summary>
+        [Description("READY")] Ready,
+
+        /// <summary>
+        /// The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
+        /// </summary>
+        [Description("STALE")] Stale,
+
+        /// <summary>
+        /// The provider is in an error state and unable to evaluate flags.
+        /// </summary>
+        [Description("ERROR")] Error
+    }
+}

src/OpenFeature/FeatureProvider.cs

@@ -1,5 +1,6 @@
 using System.Collections.Immutable;
 using System.Threading.Tasks;
+using OpenFeature.Constant;
 using OpenFeature.Model;
 
 namespace OpenFeature
@@ -79,5 +80,53 @@ public abstract Task<ResolutionDetails<double>> ResolveDoubleValue(string flagKe
         /// <returns><see cref="ResolutionDetails{T}"/></returns>
         public abstract Task<ResolutionDetails<Value>> ResolveStructureValue(string flagKey, Value defaultValue,
             EvaluationContext context = null);
+
+        /// <summary>
+        /// Get the status of the provider.
+        /// </summary>
+        /// <returns>The current <see cref="ProviderStatus"/></returns>
+        /// <remarks>
+        /// If a provider does not override this method, then its status will be assumed to be
+        /// <see cref="ProviderStatus.Ready"/>. If a provider implements this method, and supports initialization,
+        /// then it should start in the <see cref="ProviderStatus.NotReady"/>status . If the status is
+        /// <see cref="ProviderStatus.NotReady"/>, then the Api will call the <see cref="Initialize" /> when the
+        /// provider is set.
+        /// </remarks>
+        public virtual ProviderStatus GetStatus() => ProviderStatus.Ready;
+
+        /// <summary>
+        /// <para>
+        /// This method is called before a provider is used to evaluate flags. Providers can overwrite this method,
+        /// if they have special initialization needed prior being called for flag evaluation.
+        /// </para>
+        /// </summary>
+        /// <param name="context"><see cref="EvaluationContext"/></param>
+        /// <returns>A task that completes when the initialization process is complete.</returns>
+        /// <remarks>
+        /// <para>
+        /// A provider which supports initialization should override this method as well as
+        /// <see cref="FeatureProvider.GetStatus"/>.
+        /// </para>
+        /// <para>
+        /// The provider should return <see cref="ProviderStatus.Ready"/> or <see cref="ProviderStatus.Error"/> from
+        /// the <see cref="GetStatus"/> method after initialization is complete.
+        /// </para>
+        /// </remarks>
+        public virtual Task Initialize(EvaluationContext context)
+        {
+            // Intentionally left blank.
+            return Task.CompletedTask;
+        }
+
+        /// <summary>
+        /// This method is called when a new provider is about to be used to evaluate flags, or the SDK is shut down.
+        /// Providers can overwrite this method, if they have special shutdown actions needed.
+        /// </summary>
+        /// <returns>A task that completes when the shutdown process is complete.</returns>
+        public virtual Task Shutdown()
+        {
+            // Intentionally left blank.
+            return Task.CompletedTask;
+        }
     }
 }