App Configuration Provider - Refresh Async

sdk/appconfiguration/azure-appconfiguration-provider/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "python",
   "TagPrefix": "python/appconfiguration/azure-appconfiguration-provider",
-  "Tag": "python/appconfiguration/azure-appconfiguration-provider_7138010c10"
+  "Tag": "python/appconfiguration/azure-appconfiguration-provider_39244029c7"
 }

sdk/appconfiguration/azure-appconfiguration-provider/tests/asynctestcase.py

@@ -22,12 +22,20 @@ async def create_aad_client(
         trim_prefixes=[],
         selects={SettingSelector(key_filter="*", label_filter="\0")},
         keyvault_secret_url=None,
+        refresh_on=None,
+        refresh_interval=30,
     ):
         cred = self.get_credential(AzureAppConfigurationClient, is_async=True)
+
         client = AzureAppConfigurationClient(appconfiguration_endpoint_string, cred)
         await setup_configs(client, keyvault_secret_url)
         return await load(
-            credential=cred, endpoint=appconfiguration_endpoint_string, trim_prefixes=trim_prefixes, selects=selects
+            credential=cred,
+            endpoint=appconfiguration_endpoint_string,
+            trim_prefixes=trim_prefixes,
+            selects=selects,
+            refresh_on=refresh_on,
+            refresh_interval=refresh_interval,
         )
 
     async def create_client(
@@ -36,11 +44,17 @@ async def create_client(
         trim_prefixes=[],
         selects={SettingSelector(key_filter="*", label_filter="\0")},
         keyvault_secret_url=None,
+        refresh_on=None,
+        refresh_interval=30,
     ):
         client = AzureAppConfigurationClient.from_connection_string(appconfiguration_connection_string)
         await setup_configs(client, keyvault_secret_url)
         return await load(
-            connection_string=appconfiguration_connection_string, trim_prefixes=trim_prefixes, selects=selects
+            connection_string=appconfiguration_connection_string,
+            trim_prefixes=trim_prefixes,
+            selects=selects,
+            refresh_on=refresh_on,
+            refresh_interval=refresh_interval,
         )
 
 

sdk/appconfiguration/azure-appconfiguration-provider/tests/conftest.py

@@ -33,5 +33,7 @@ def add_sanitizers(test_proxy):
         value="https://fake-key-vault.vault.azure.net/",
         target=os.environ.get("APPCONFIGURATION_KEY_VAULT_REFERENCE", "https://fake-key-vault.vault.azure.net/"),
     )
+
+    add_general_regex_sanitizer(value="api-version=1970-01-01", regex="api-version=.+")
     set_custom_default_matcher(ignored_headers="x-ms-content-sha256")
     add_oauth_response_sanitizer()

sdk/appconfiguration/azure-appconfiguration-provider/tests/test_async_provider.py

@@ -22,7 +22,7 @@ async def test_provider_creation(self, appconfiguration_connection_string, appco
             assert client["my_json"]["key"] == "value"
             assert (
                 client["FeatureManagementFeatureFlags"]["Alpha"]
-                == '{"enabled": false, "conditions": {"client_filters": []}}'
+                == '{"id": "Alpha", "enabled": false, "conditions": {"client_filters": []}}'
             )
 
     # method: provider_trim_prefixes
@@ -43,7 +43,7 @@ async def test_provider_trim_prefixes(
             assert "test.trimmed" not in client
             assert (
                 client["FeatureManagementFeatureFlags"]["Alpha"]
-                == '{"enabled": false, "conditions": {"client_filters": []}}'
+                == '{"id": "Alpha", "enabled": false, "conditions": {"client_filters": []}}'
             )
 
     # method: provider_selectors

sdk/appconfiguration/azure-appconfiguration-provider/tests/test_async_provider_aad.py

@@ -23,7 +23,7 @@ async def test_provider_creation_aad(self, appconfiguration_endpoint_string, app
             assert client["my_json"]["key"] == "value"
             assert (
                 client["FeatureManagementFeatureFlags"]["Alpha"]
-                == '{"enabled": false, "conditions": {"client_filters": []}}'
+                == '{"id": "Alpha", "enabled": false, "conditions": {"client_filters": []}}'
             )
 
     # method: provider_trim_prefixes
@@ -42,7 +42,7 @@ async def test_provider_trim_prefixes(self, appconfiguration_endpoint_string, ap
             assert "test.trimmed" not in client
             assert (
                 client["FeatureManagementFeatureFlags"]["Alpha"]
-                == '{"enabled": false, "conditions": {"client_filters": []}}'
+                == '{"id": "Alpha", "enabled": false, "conditions": {"client_filters": []}}'
             )
 
     # method: provider_selectors

sdk/appconfiguration/azure-appconfiguration-provider/tests/test_async_provider_refresh.py

@@ -0,0 +1,102 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import time
+import unittest
+from azure.appconfiguration.provider import SettingSelector, SentinelKey
+from azure.appconfiguration.provider.aio import load
+from devtools_testutils.aio import recorded_by_proxy_async
+from azure.appconfiguration.aio import AzureAppConfigurationClient
+from async_preparers import app_config_decorator_async
+from asynctestcase import AppConfigTestCase
+
+
+class TestAppConfigurationProvider(AppConfigTestCase, unittest.TestCase):
+    # method: refresh
+    @app_config_decorator_async
+    @recorded_by_proxy_async
+    async def test_refresh(self, appconfiguration_endpoint_string, appconfiguration_keyvault_secret_url):
+        async with await self.create_aad_client(
+            appconfiguration_endpoint_string,
+            keyvault_secret_url=appconfiguration_keyvault_secret_url,
+            refresh_on=[SentinelKey("refresh_message")],
+            refresh_interval=1,
+        ) as client:
+            assert client["refresh_message"] == "original value"
+            assert client["my_json"]["key"] == "value"
+            assert (
+                client["FeatureManagementFeatureFlags"]["Alpha"]
+                == '{"id": "Alpha", "enabled": false, "conditions": {"client_filters": []}}'
+            )
+            setting = await client._client.get_configuration_setting(key="refresh_message")
+            setting.value = "updated value"
+            await client._client.set_configuration_setting(setting)
+
+            # Waiting for the refresh interval to pass
+            time.sleep(2)
+
+            await client.refresh()
+            assert client["refresh_message"] == "updated value"
+
+            setting.value = "original value"
+            await client._client.set_configuration_setting(setting)
+
+            # Waiting for the refresh interval to pass
+            time.sleep(2)
+
+            await client.refresh()
+            assert client["refresh_message"] == "original value"
+
+            setting.value = "updated value 2"
+            await client._client.set_configuration_setting(setting)
+
+            # Not waiting for the refresh interval to pass
+            await client.refresh()
+            assert client["refresh_message"] == "original value"
+
+            setting.value = "original value"
+            await client._client.set_configuration_setting(setting)
+
+            await client.refresh()
+            assert client["refresh_message"] == "original value"
+
+    # method: refresh
+    @app_config_decorator_async
+    @recorded_by_proxy_async
+    async def test_empty_refresh(self, appconfiguration_endpoint_string, appconfiguration_keyvault_secret_url):
+        async with await self.create_aad_client(
+            appconfiguration_endpoint_string, keyvault_secret_url=appconfiguration_keyvault_secret_url
+        ) as client:
+            assert client["refresh_message"] == "original value"
+            assert client["non_refreshed_message"] == "Static"
+            assert client["my_json"]["key"] == "value"
+            assert (
+                client["FeatureManagementFeatureFlags"]["Alpha"]
+                == '{"id": "Alpha", "enabled": false, "conditions": {"client_filters": []}}'
+            )
+            setting = await client._client.get_configuration_setting(key="refresh_message")
+            setting.value = "updated value"
+            await client._client.set_configuration_setting(setting)
+            static_setting = await client._client.get_configuration_setting(key="non_refreshed_message")
+            static_setting.value = "updated static"
+            await client._client.set_configuration_setting(static_setting)
+
+            # Waiting for the refresh interval to pass
+            time.sleep(2)
+
+            await client.refresh()
+            assert client["refresh_message"] == "original value"
+            assert client["non_refreshed_message"] == "Static"
+
+            setting.value = "original value"
+            await client._client.set_configuration_setting(setting)
+            static_setting.value = "Static"
+            await client._client.set_configuration_setting(static_setting)
+
+    def my_callback(self):
+        assert True
+
+    def my_callback_on_fail(self):
+        assert False

sdk/appconfiguration/azure-appconfiguration-provider/tests/test_provider.py

@@ -21,7 +21,7 @@ def test_provider_creation(self, appconfiguration_connection_string, appconfigur
         assert client["my_json"]["key"] == "value"
         assert (
             client["FeatureManagementFeatureFlags"]["Alpha"]
-            == '{"enabled": false, "conditions": {"client_filters": []}}'
+            == '{"id": "Alpha", "enabled": false, "conditions": {"client_filters": []}}'
         )
 
     # method: provider_trim_prefixes
@@ -40,7 +40,7 @@ def test_provider_trim_prefixes(self, appconfiguration_connection_string, appcon
         assert "test.trimmed" not in client
         assert (
             client["FeatureManagementFeatureFlags"]["Alpha"]
-            == '{"enabled": false, "conditions": {"client_filters": []}}'
+            == '{"id": "Alpha", "enabled": false, "conditions": {"client_filters": []}}'
         )
 
     # method: provider_selectors

sdk/appconfiguration/azure-appconfiguration-provider/tests/test_provider_aad.py

@@ -21,7 +21,7 @@ def test_provider_creation_aad(self, appconfiguration_endpoint_string, appconfig
         assert client["my_json"]["key"] == "value"
         assert (
             client["FeatureManagementFeatureFlags"]["Alpha"]
-            == '{"enabled": false, "conditions": {"client_filters": []}}'
+            == '{"id": "Alpha", "enabled": false, "conditions": {"client_filters": []}}'
         )
 
     # method: provider_trim_prefixes
@@ -40,7 +40,7 @@ def test_provider_trim_prefixes(self, appconfiguration_endpoint_string, appconfi
         assert "test.trimmed" not in client
         assert (
             client["FeatureManagementFeatureFlags"]["Alpha"]
-            == '{"enabled": false, "conditions": {"client_filters": []}}'
+            == '{"id": "Alpha", "enabled": false, "conditions": {"client_filters": []}}'
         )
 
     # method: provider_selectors

sdk/appconfiguration/azure-appconfiguration-provider/tests/test_provider_refresh.py

@@ -27,7 +27,7 @@ def test_refresh(self, appconfiguration_endpoint_string, appconfiguration_keyvau
         assert client["my_json"]["key"] == "value"
         assert (
             client["FeatureManagementFeatureFlags"]["Alpha"]
-            == '{"enabled": false, "conditions": {"client_filters": []}}'
+            == '{"id": "Alpha", "enabled": false, "conditions": {"client_filters": []}}'
         )
         setting = client._client.get_configuration_setting(key="refresh_message")
         setting.value = "updated value"
@@ -73,7 +73,7 @@ def test_empty_refresh(self, appconfiguration_endpoint_string, appconfiguration_
         assert client["my_json"]["key"] == "value"
         assert (
             client["FeatureManagementFeatureFlags"]["Alpha"]
-            == '{"enabled": false, "conditions": {"client_filters": []}}'
+            == '{"id": "Alpha", "enabled": false, "conditions": {"client_filters": []}}'
         )
         setting = client._client.get_configuration_setting(key="refresh_message")
         setting.value = "updated value"