Updating for allowing RequiredMinimumPollIntervalInSeconds property to be supplied at the time of setup

Signed-off-by: Ash.Wani <[email protected]>

Author: wani-guanxi

src/OpenFeature.Contrib.Providers.AwsAppConfig/AppConfigProvider.cs

@@ -19,21 +19,24 @@ public class AppConfigProvider : FeatureProvider
         private readonly string _applicationName;
 
         // The environment (e.g., prod, dev, staging) in AWS AppConfig
-        private readonly string _environmentName;        
+        private readonly string _environmentName;
+
+        private readonly int _minimumPollIntervalInSeconds;
 
         /// <summary>
         /// Returns metadata about the provider
         /// </summary>
         /// <returns>Metadata object containing provider information</returns>
         public override Metadata GetMetadata() => new Metadata("AWS AppConfig Provider");
-        
+
         /// <summary>
         /// Constructor for AwsAppConfigProvider
         /// </summary>
         /// <param name="retrievalApi">The AWS AppConfig retrieval API</param>
         /// <param name="applicationName">The name of the application in AWS AppConfig</param>
-        /// <param name="environmentName">The environment (e.g., prod, dev, staging) in AWS AppConfig</param>        
-        public AppConfigProvider(IRetrievalApi retrievalApi, string applicationName, string environmentName)
+        /// <param name="environmentName">The environment (e.g., prod, dev, staging) in AWS AppConfig</param>
+        /// <param name="minimumPollIntervalInSeconds">Client cannot call GetLatest more frequently than every specified seconds. Range 15-86400.</param>        
+        public AppConfigProvider(IRetrievalApi retrievalApi, string applicationName, string environmentName, int minimumPollIntervalInSeconds = 15)
         {
             // Application name, environment name and configuration profile ID is needed for connecting to AWS Appconfig.
             // If any of these are missing, an exception will be thrown.
@@ -46,7 +49,8 @@ public AppConfigProvider(IRetrievalApi retrievalApi, string applicationName, str
 
             _appConfigRetrievalApi = retrievalApi;
             _applicationName = applicationName;
-            _environmentName = environmentName;            
+            _environmentName = environmentName;
+            _minimumPollIntervalInSeconds = minimumPollIntervalInSeconds;           
         }
 
         /// <summary>
@@ -175,7 +179,7 @@ private async Task<Value> ResolveFeatureFlagValue(string flagKey, Value defaultV
         /// and returns it in its raw string format. The returned string is expected to be
         /// in JSON format that can be parsed into feature flag configurations.
         /// </remarks>
-        /// <exception cref="AmazonAppConfigException">Thrown when there is an error retrieving the configuration from AWS AppConfig.</exception>
+        /// <exception cref="AmazonAppConfigDataException">Thrown when there is an error retrieving the configuration from AWS AppConfig.</exception>
         private async Task<string> GetFeatureFlagsResponseJson(string configurationProfileId, EvaluationContext context = null)
         {
             var response = await GetFeatureFlagsStreamAsync(configurationProfileId, context);
@@ -198,6 +202,7 @@ private async Task<GetLatestConfigurationResponse> GetFeatureFlagsStreamAsync(st
             {
                 ApplicationIdentifier = _applicationName,
                 EnvironmentIdentifier = _environmentName,
+                RequiredMinimumPollIntervalInSeconds = _minimumPollIntervalInSeconds,
                 ConfigurationProfileIdentifier = configurationProfileId
             };
 

src/OpenFeature.Contrib.Providers.AwsAppConfig/AppConfigRetrievalApi.cs

@@ -178,7 +178,8 @@ private async Task<string> GetSessionToken(FeatureFlagProfile profile)
                 {
                     ApplicationIdentifier = profile.ApplicationIdentifier,
                     EnvironmentIdentifier = profile.EnvironmentIdentifier,
-                    ConfigurationProfileIdentifier = profile.ConfigurationProfileIdentifier
+                    ConfigurationProfileIdentifier = profile.ConfigurationProfileIdentifier,
+                    RequiredMinimumPollIntervalInSeconds = profile.RequiredMinimumPollIntervalInSeconds
                 };
 
                 var sessionResponse = await _appConfigDataClient.StartConfigurationSessionAsync(request);

src/OpenFeature.Contrib.Providers.AwsAppConfig/FeatureFlagProfile.cs

@@ -19,6 +19,18 @@ public class FeatureFlagProfile
         /// </summary>
         public string EnvironmentIdentifier { get; set; }
 
+        /// <summary>
+        /// Gets or sets the minimum polling interval in seconds for AWS AppConfig.
+        /// This value determines the minimum time that must elapse between configuration refresh attempts.
+        /// The default value set here is 15 seconds, which aligns with AWS AppConfig's minimum supported interval.
+        /// Range 15 to 86400 seconds.
+        /// </summary>
+        /// <remarks>
+        /// AWS AppConfig enforces a minimum interval of 15 seconds between configuration refresh attempts.
+        /// Setting a value lower than 15 seconds may result in throttling by the service.
+        /// </remarks>
+        public int RequiredMinimumPollIntervalInSeconds {get; set;} = 15;
+
         /// <summary>
         /// Gets or sets the AWS AppConfig configuration profile identifier.
         /// This identifies the specific configuration profile containing the feature flags.

src/OpenFeature.Contrib.Providers.AwsAppConfig/README.md

@@ -47,12 +47,16 @@ This package maintains the aforementioned structure by supplying values in two d
 
 **Stage 1: Setup**
 
-During this stage, the Application and Environment are provided at the initiation of the project. It is expected that these two values remain constant throughout the application's lifetime. If a change is necessary, a restart of the application will be required.
+During this stage, the Application and Environment are provided at the initiation of the project. It is expected that these two values remain static during the application's lifetime. If a change is necessary, a restart of the application will be required.
+
+Additionally, at this point Required Minimum Polling Interval in seconds can also be configured by supplying integer value of seconds you would like to set. Default is 15 seconds and maximum allowed by AWS id 86400 seconds.
 
 **Stage 2: Fetching Value**
 
 In this stage, to retrieve the AWS AppConfig feature flag, the key should be supplied in the format `configurationProfileId:flagKey[:attributeKey]`. If the AttributeKey is not included, all attributes will be returned as a structured object.
 
+## Important information about the implementation
+As per AWS AppConfig documentation, the recommended way to access AWS AppConfig is by using 
 
 ## Usage
 
@@ -89,11 +93,12 @@ namespace OpenFeatureTestApp
 
             // Replace these values with your AWS AppConfig settings
             const string application = "YourApplication";
-            const string environment = "YourEnvironment";            
+            const string environment = "YourEnvironment";
+            const int pollingIntervalSeconds = 60; // default is 15            
 
             await Api.Instance.SetProviderAsync(
-                new AppConfigProvider(appConfigRetrievalApi, application, environment)
-            );            
+                new AppConfigProvider(appConfigRetrievalApi, application, environment, pollingIntervalSeconds)
+            );
         }
     }
 }

test/OpenFeature.Contrib.Providers.AwsAppConfig.Test/AppCOnfigRetrievalApiTests.cs renamed to test/OpenFeature.Contrib.Providers.AwsAppConfig.Test/AppConfigRetrievalApiTests.cs

@@ -1,14 +1,12 @@
 using Xunit;
 using Moq;
 using System;
-using OpenFeature.Model;
 using Amazon.AppConfigData;
 using Amazon.AppConfigData.Model;
 using System.Text;
 using OpenFeature.Contrib.Providers.AwsAppConfig;
 using System.Threading;
 using System.Threading.Tasks;
-using System.Collections.Generic;
 using System.IO;
 using Microsoft.Extensions.Caching.Memory;
 public class AppConfigRetrievalApiTests