update

Author: zhiyuanliang-ms

src/Microsoft.Extensions.Configuration.AzureAppConfiguration/AzureAppConfigurationHealthCheck.cs

@@ -8,10 +8,7 @@
 
 namespace Microsoft.Extensions.Configuration.AzureAppConfiguration
 {
-    /// <summary>
-    /// Health check for Azure App Configuration.
-    /// </summary>
-    public sealed class AzureAppConfigurationHealthCheck : IHealthCheck
+    internal class AzureAppConfigurationHealthCheck : IConfigurationHealthCheck
     {
         private AzureAppConfigurationProvider _provider = null;
 
@@ -20,9 +17,6 @@ internal void SetProvider(AzureAppConfigurationProvider provider)
             _provider = provider ?? throw new ArgumentNullException(nameof(provider));
         }
 
-        /// <summary>
-        /// Checks the health of the Azure App Configuration provider.
-        /// </summary>
         public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default)
         {
             if (_provider == null)

src/Microsoft.Extensions.Configuration.AzureAppConfiguration/AzureAppConfigurationOptions.cs

@@ -33,17 +33,13 @@ public class AzureAppConfigurationOptions
         private List<Func<ConfigurationSetting, ValueTask<ConfigurationSetting>>> _mappers = new List<Func<ConfigurationSetting, ValueTask<ConfigurationSetting>>>();
         private List<KeyValueSelector> _selectors;
         private IConfigurationRefresher _refresher = new AzureAppConfigurationRefresher();
+        private IConfigurationHealthCheck _healthCheck = new AzureAppConfigurationHealthCheck();
         private bool _selectCalled = false;
 
         // The following set is sorted in descending order.
         // Since multiple prefixes could start with the same characters, we need to trim the longest prefix first.
         private SortedSet<string> _keyPrefixes = new SortedSet<string>(Comparer<string>.Create((k1, k2) => -string.Compare(k1, k2, StringComparison.OrdinalIgnoreCase)));
 
-        /// <summary>
-        /// Health check for Azure App Configuration.
-        /// </summary>
-        public AzureAppConfigurationHealthCheck HealthCheck { get; set; } = new AzureAppConfigurationHealthCheck();
-
         /// <summary>
         /// Flag to indicate whether replica discovery is enabled.
         /// </summary>
@@ -464,6 +460,15 @@ public IConfigurationRefresher GetRefresher()
             return _refresher;
         }
 
+        /// <summary>
+        /// Get an instance of <see cref="IConfigurationHealthCheck"/> that can be used to do health checks for the configuration provider.
+        /// </summary>
+        /// <returns>An instance of <see cref="IConfigurationHealthCheck"/>.</returns>
+        public IConfigurationHealthCheck GetHealthCheck()
+        {
+            return _healthCheck;
+        }
+
         /// <summary>
         /// Configures the Azure App Configuration provider to use the provided Key Vault configuration to resolve key vault references.
         /// </summary>

src/Microsoft.Extensions.Configuration.AzureAppConfiguration/AzureAppConfigurationProvider.cs

@@ -119,10 +119,8 @@ public AzureAppConfigurationProvider(IConfigurationClientManager configClientMan
             bool hasWatchers = watchers.Any();
             TimeSpan minWatcherRefreshInterval = hasWatchers ? watchers.Min(w => w.RefreshInterval) : TimeSpan.MaxValue;
 
-            if (options.HealthCheck != null)
-            {
-                options.HealthCheck.SetProvider(this);
-            }
+            var healthCheck = (AzureAppConfigurationHealthCheck)_options.GetHealthCheck();
+            healthCheck.SetProvider(this);
 
             if (options.RegisterAllEnabled)
             {

src/Microsoft.Extensions.Configuration.AzureAppConfiguration/IConfigurationHealthCheck.cs

@@ -0,0 +1,14 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+//
+using Microsoft.Extensions.Diagnostics.HealthChecks;
+
+namespace Microsoft.Extensions.Configuration.AzureAppConfiguration
+{
+    /// <summary>
+    /// An interface for Azure App Configuration health check.
+    /// </summary>
+    public interface IConfigurationHealthCheck : IHealthCheck
+    {
+    }
+}

tests/Tests.AzureAppConfiguration/HealthCheckTest.cs

@@ -36,11 +36,9 @@ public class HealthCheckTest
         };
 
         [Fact]
-        public async Task HealthCheckTests_ReturnsUnhealthyWhenInitialLoadIsNotCompleted()
+        public async Task HealthCheckTests_ReturnsHealthyWhenInitialLoadIsCompleted()
         {
-            var healthCheck = new AzureAppConfigurationHealthCheck();
-            HealthCheckResult result = await healthCheck.CheckHealthAsync(new HealthCheckContext());
-            Assert.Equal(HealthStatus.Unhealthy, result.Status);
+            IHealthCheck healthCheck = null;
 
             var mockResponse = new Mock<Response>();
             var mockClient = new Mock<ConfigurationClient>(MockBehavior.Strict);
@@ -52,20 +50,20 @@ public async Task HealthCheckTests_ReturnsUnhealthyWhenInitialLoadIsNotCompleted
                 .AddAzureAppConfiguration(options =>
                 {
                     options.ClientManager = TestHelpers.CreateMockedConfigurationClientManager(mockClient.Object);
-                    options.HealthCheck = healthCheck;
+                    healthCheck = options.GetHealthCheck();
                 })
                 .Build();
 
             Assert.True(config["TestKey1"] == "TestValue1");
-            result = await healthCheck.CheckHealthAsync(new HealthCheckContext());
+            var result = await healthCheck.CheckHealthAsync(new HealthCheckContext());
             Assert.Equal(HealthStatus.Healthy, result.Status);
         }
 
         [Fact]
         public async Task HealthCheckTests_ReturnsUnhealthyWhenRefreshFailed()
         {
             IConfigurationRefresher refresher = null;
-            var healthCheck = new AzureAppConfigurationHealthCheck();
+            IHealthCheck healthCheck = null;
             var mockResponse = new Mock<Response>();
             var mockClient = new Mock<ConfigurationClient>(MockBehavior.Strict);
 
@@ -80,18 +78,18 @@ public async Task HealthCheckTests_ReturnsUnhealthyWhenRefreshFailed()
                 {
                     options.ClientManager = TestHelpers.CreateMockedConfigurationClientManager(mockClient.Object);
                     options.MinBackoffDuration = TimeSpan.FromSeconds(2);
-                    options.HealthCheck = healthCheck;
                     options.ConfigurationSettingPageIterator = new MockConfigurationSettingPageIterator();
                     options.ConfigureRefresh(refreshOptions =>
                     {
                         refreshOptions.RegisterAll()
                             .SetRefreshInterval(TimeSpan.FromSeconds(1));
                     });
                     refresher = options.GetRefresher();
+                    healthCheck = options.GetHealthCheck();
                 })
                 .Build();
 
-            HealthCheckResult result = await healthCheck.CheckHealthAsync(new HealthCheckContext());
+            var result = await healthCheck.CheckHealthAsync(new HealthCheckContext());
             Assert.Equal(HealthStatus.Healthy, result.Status);
 
             // Wait for the refresh interval to expire