App Config Provider Bug Fix (#44012)

* Fix Refresh bug

* Update CHANGELOG.md

* Update sdk/appconfiguration/azure-appconfiguration-provider/CHANGELOG.md

Co-authored-by: Copilot <[email protected]>

* Update assets.json

---------

Co-authored-by: Copilot <[email protected]>

Author: mrm9084

sdk/appconfiguration/azure-appconfiguration-provider/CHANGELOG.md

@@ -1,14 +1,10 @@
 # Release History
 
-## 2.3.1 (Unreleased)
-
-### Features Added
-
-### Breaking Changes
+## 2.3.1 (2025-11-13)
 
 ### Bugs Fixed
 
-### Other Changes
+* Fixed a bug where calling the refresh method would always trigger it.
 
 ## 2.3.0 (2025-11-12)
 

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_18bb5889fc"
+  "Tag": "python/appconfiguration/azure-appconfiguration-provider_32bd63579a"
 }

sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/_client_manager.py

@@ -197,16 +197,21 @@ def get_updated_watched_settings(
         :rtype: Union[Dict[Tuple[str, str], str], None]
         """
         updated_watched_settings = dict(watched_settings)
+        trigger_refresh = False
         for (key, label), etag in watched_settings.items():
             changed, updated_watched_setting = self._check_configuration_setting(
                 key=key, label=label, etag=etag, headers=headers, **kwargs
             )
             if changed and updated_watched_setting is not None:
                 updated_watched_settings[(key, label)] = updated_watched_setting.etag
+                trigger_refresh = True
             elif changed:
                 # The key was deleted
                 updated_watched_settings[(key, label)] = None
-        return updated_watched_settings
+                trigger_refresh = True
+        if trigger_refresh:
+            return updated_watched_settings
+        return {}
 
     @distributed_trace
     def try_check_feature_flags(

sdk/appconfiguration/azure-appconfiguration-provider/azure/appconfiguration/provider/aio/_async_client_manager.py

@@ -199,16 +199,21 @@ async def get_updated_watched_settings(
         :rtype: Union[Dict[Tuple[str, str], str], None]
         """
         updated_watched_settings = dict(watched_settings)
+        trigger_refresh = False
         for (key, label), etag in watched_settings.items():
             changed, updated_watched_setting = await self._check_configuration_setting(
                 key=key, label=label, etag=etag, headers=headers, **kwargs
             )
             if changed and updated_watched_setting is not None:
                 updated_watched_settings[(key, label)] = updated_watched_setting.etag
+                trigger_refresh = True
             elif changed:
                 # The key was deleted
                 updated_watched_settings[(key, label)] = None
-        return updated_watched_settings
+                trigger_refresh = True
+        if trigger_refresh:
+            return updated_watched_settings
+        return {}
 
     @distributed_trace
     async def try_check_feature_flags(

sdk/appconfiguration/azure-appconfiguration-provider/tests/aio/key_vault/test_async_secret_refresh.py

@@ -83,7 +83,7 @@ async def test_secret_refresh_with_updated_values(
             keyvault_secret_url=appconfiguration_keyvault_secret_url,
             keyvault_secret_url2=appconfiguration_keyvault_secret_url2,
             on_refresh_success=mock_callback,
-            refresh_on=[WatchKey("secret")],
+            refresh_on=[WatchKey("secret", "prod")],
             refresh_interval=1,
             secret_refresh_interval=1,  # Using a short interval for testing
         )

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

@@ -8,6 +8,7 @@
 import pytest
 import sys
 
+from azure.appconfiguration import ConfigurationSetting
 from azure.appconfiguration.provider import WatchKey
 from devtools_testutils.aio import recorded_by_proxy_async
 from async_preparers import app_config_decorator_async
@@ -90,6 +91,57 @@ async def test_refresh(self, appconfiguration_endpoint_string, appconfiguration_
                 assert client["refresh_message"] == "original value"
                 assert mock_callback.call_count == 2
 
+        # method: refresh
+        @app_config_decorator_async
+        @recorded_by_proxy_async
+        @pytest.mark.skipif(sys.version_info < (3, 8), reason="Python 3.7 does not support AsyncMock")
+        @pytest.mark.asyncio
+        async def test_no_refresh(self, appconfiguration_endpoint_string, appconfiguration_keyvault_secret_url):
+
+            appconfig_client = self.create_aad_sdk_client(appconfiguration_endpoint_string)
+
+            watch_key = ConfigurationSetting(key="watch key", value="0")
+            await appconfig_client.set_configuration_setting(watch_key)
+
+            mock_callback = Mock()
+            async with await self.create_client(
+                endpoint=appconfiguration_endpoint_string,
+                keyvault_secret_url=appconfiguration_keyvault_secret_url,
+                refresh_on=[WatchKey("watch key")],
+                refresh_interval=1,
+                on_refresh_success=mock_callback,
+                feature_flag_enabled=True,
+                feature_flag_refresh_enabled=True,
+            ) as client:
+                assert client["refresh_message"] == "original value"
+                assert client["my_json"]["key"] == "value"
+                assert FEATURE_MANAGEMENT_KEY in client
+                assert has_feature_flag(client, "Alpha")
+
+                setting = await appconfig_client.get_configuration_setting(key="refresh_message")
+                setting.value = "updated value"
+                await appconfig_client.set_configuration_setting(setting)
+
+                # Waiting for the refresh interval to pass
+                time.sleep(2)
+
+                await client.refresh()
+                # No Change the Watch Key wasn't updated
+                assert client["refresh_message"] == "original value"
+                assert has_feature_flag(client, "Alpha", False)
+                assert mock_callback.call_count == 0
+
+                watch_key.value = "1"
+                await appconfig_client.set_configuration_setting(watch_key)
+
+                # Waiting for the refresh interval to pass
+                time.sleep(2)
+
+                await client.refresh()
+                assert client["refresh_message"] == "updated value"
+                assert has_feature_flag(client, "Alpha", False)
+                assert mock_callback.call_count == 1
+
         # method: refresh
         @app_config_decorator_async
         @recorded_by_proxy_async

sdk/appconfiguration/azure-appconfiguration-provider/tests/key_vault/test_secret_refresh.py

@@ -75,7 +75,7 @@ def test_secret_refresh_with_updated_values(
             keyvault_secret_url=appconfiguration_keyvault_secret_url,
             keyvault_secret_url2=appconfiguration_keyvault_secret_url2,
             on_refresh_success=mock_callback,
-            refresh_on=[WatchKey("secret")],
+            refresh_on=[WatchKey("secret", "prod")],
             refresh_interval=1,
             secret_refresh_interval=1,  # Using a short interval for testing
         )

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

@@ -9,7 +9,7 @@
 from azure.appconfiguration.provider import WatchKey
 from devtools_testutils import recorded_by_proxy
 from preparers import app_config_decorator_aad
-from testcase import AppConfigTestCase, has_feature_flag
+from testcase import AppConfigTestCase, ConfigurationSetting, has_feature_flag
 from test_constants import FEATURE_MANAGEMENT_KEY
 
 
@@ -81,6 +81,54 @@ def test_refresh(self, appconfiguration_endpoint_string, appconfiguration_keyvau
         assert client["refresh_message"] == "original value"
         assert mock_callback.call_count == 2
 
+    @recorded_by_proxy
+    @app_config_decorator_aad
+    def test_no_refresh(self, appconfiguration_endpoint_string, appconfiguration_keyvault_secret_url):
+
+        appconfig_client = self.create_aad_sdk_client(appconfiguration_endpoint_string)
+
+        watch_key = ConfigurationSetting(key="watch key", value="0")
+        appconfig_client.set_configuration_setting(watch_key)
+
+        mock_callback = Mock()
+        client = self.create_client(
+            endpoint=appconfiguration_endpoint_string,
+            keyvault_secret_url=appconfiguration_keyvault_secret_url,
+            refresh_on=[WatchKey("watch key")],
+            refresh_interval=1,
+            on_refresh_success=mock_callback,
+            feature_flag_enabled=True,
+            feature_flag_refresh_enabled=True,
+        )
+        assert client["refresh_message"] == "original value"
+        assert client["my_json"]["key"] == "value"
+        assert FEATURE_MANAGEMENT_KEY in client
+        assert has_feature_flag(client, "Alpha")
+
+        setting = appconfig_client.get_configuration_setting(key="refresh_message")
+        setting.value = "updated value"
+        appconfig_client.set_configuration_setting(setting)
+
+        # Waiting for the refresh interval to pass
+        time.sleep(2)
+
+        client.refresh()
+        # No Change the Watch Key wasn't updated
+        assert client["refresh_message"] == "original value"
+        assert has_feature_flag(client, "Alpha", False)
+        assert mock_callback.call_count == 0
+
+        watch_key.value = "1"
+        appconfig_client.set_configuration_setting(watch_key)
+
+        # Waiting for the refresh interval to pass
+        time.sleep(2)
+
+        client.refresh()
+        assert client["refresh_message"] == "updated value"
+        assert has_feature_flag(client, "Alpha", False)
+        assert mock_callback.call_count == 1
+
     # method: refresh
     @recorded_by_proxy
     @app_config_decorator_aad