Configuration Setting Mapping (#42795)

* Config Map

* configuration_mapper

* fixing formatting

* bug fix + tests

* Updating docstrings + formatting

* Update assets.json

* updated tests

* Update test_async_provider.py

* Update _azureappconfigurationproviderasync.py

Author: mrm9084

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

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

@@ -103,6 +103,9 @@ def load(  # pylint: disable=docstring-keyword-should-match-keyword-only
     :keyword load_balancing_enabled: Optional flag to enable or disable the load balancing of replica endpoints. Default
      is False.
     :paramtype load_balancing_enabled: bool
+    :keyword configuration_mapper: Optional function to map configuration settings. Enables transformation of
+    configurations before they are added to the provider.
+    :paramtype configuration_mapper: Optional[Callable[[ConfigurationSetting], None]]
     """
 
 
@@ -166,6 +169,9 @@ def load(  # pylint: disable=docstring-keyword-should-match-keyword-only
     :keyword load_balancing_enabled: Optional flag to enable or disable the load balancing of replica endpoints. Default
      is False.
     :paramtype load_balancing_enabled: bool
+    :keyword configuration_mapper: Optional function to map configuration settings. Enables transformation of
+    configurations before they are added to the provider.
+    :paramtype configuration_mapper: Optional[Callable[[ConfigurationSetting], None]]
     """
 
 
@@ -318,6 +324,7 @@ def __init__(self, **kwargs: Any) -> None:
         self._secret_clients: Dict[str, SecretClient] = {}
         self._on_refresh_success: Optional[Callable] = kwargs.pop("on_refresh_success", None)
         self._on_refresh_error: Optional[Callable[[Exception], None]] = kwargs.pop("on_refresh_error", None)
+        self._configuration_mapper: Optional[Callable] = kwargs.pop("configuration_mapper", None)
 
     def _attempt_refresh(self, client: ConfigurationClient, replica_count: int, is_failover_request: bool, **kwargs):
         settings_refreshed = False
@@ -516,6 +523,9 @@ def _process_configurations(self, configuration_settings: List[ConfigurationSett
         configuration_settings_processed = {}
         feature_flags_processed = []
         for settings in configuration_settings:
+            if self._configuration_mapper:
+                # If a map function is provided, use it to process the configuration setting
+                self._configuration_mapper(settings)
             if isinstance(settings, FeatureFlagConfigurationSetting):
                 # Feature flags are not processed like other settings
                 feature_flag_value = self._process_feature_flag(settings)

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

@@ -109,6 +109,9 @@ async def load(  # pylint: disable=docstring-keyword-should-match-keyword-only
     :keyword load_balancing_enabled: Optional flag to enable or disable the load balancing of replica endpoints. Default
      is False.
     :paramtype load_balancing_enabled: bool
+    :keyword configuration_mapper: Optional function to map configuration settings. Enables transformation of
+    configurations before they are added to the provider.
+    :paramtype configuration_mapper: Optional[Callable[[ConfigurationSetting], Awaitable[None]]]
     """
 
 
@@ -172,6 +175,9 @@ async def load(  # pylint: disable=docstring-keyword-should-match-keyword-only
     :keyword load_balancing_enabled: Optional flag to enable or disable the load balancing of replica endpoints. Default
      is False.
     :paramtype load_balancing_enabled: bool
+    :keyword configuration_mapper: Optional function to map configuration settings. Enables transformation of
+    configurations before they are added to the provider.
+    :paramtype configuration_mapper: Optional[Callable[[ConfigurationSetting], Awaitable[None]]]
     """
 
 
@@ -334,6 +340,9 @@ def __init__(self, **kwargs: Any) -> None:
         self._on_refresh_error: Optional[Union[Callable[[Exception], Awaitable[None]], None]] = kwargs.pop(
             "on_refresh_error", None
         )
+        self._configuration_mapper: Optional[Callable[[ConfigurationSetting], Awaitable[None]]] = kwargs.pop(
+            "configuration_mapper", None
+        )
 
     async def _attempt_refresh(
         self, client: ConfigurationClient, replica_count: int, is_failover_request: bool, **kwargs
@@ -538,6 +547,8 @@ async def _process_configurations(self, configuration_settings: List[Configurati
         configuration_settings_processed = {}
         feature_flags_processed = []
         for settings in configuration_settings:
+            if self._configuration_mapper:
+                await self._configuration_mapper(settings)
             if isinstance(settings, FeatureFlagConfigurationSetting):
                 # Feature flags are not processed like other settings
                 feature_flag_value = self._process_feature_flag(settings)

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

@@ -234,6 +234,64 @@ async def test_provider_tag_filters(self, appconfiguration_connection_string, ap
             assert has_feature_flag(client, "TaggedFeatureFlag")
             assert "message" not in client
 
+    # method: load
+    @app_config_decorator_async
+    @recorded_by_proxy_async
+    async def test_configuration_mapper(self, appconfiguration_connection_string, appconfiguration_keyvault_secret_url):
+        async def test_mapper(setting):
+            if setting.key == "message":
+                setting.value = "mapped"
+
+        async with await self.create_client(
+            connection_string=appconfiguration_connection_string,
+            keyvault_secret_url=appconfiguration_keyvault_secret_url,
+            configuration_mapper=test_mapper,
+        ) as client:
+            assert client["message"] == "mapped"
+            assert client["refresh_message"] == "original value"
+
+    # method: load
+    @app_config_decorator_async
+    @recorded_by_proxy_async
+    async def test_configuration_mapper_with_trimming(
+        self, appconfiguration_connection_string, appconfiguration_keyvault_secret_url
+    ):
+        async def test_mapper(setting):
+            if setting.key == "message":
+                setting.value = "mapped"
+
+        async with await self.create_client(
+            connection_string=appconfiguration_connection_string,
+            keyvault_secret_url=appconfiguration_keyvault_secret_url,
+            configuration_mapper=test_mapper,
+            trim_prefixes=["refresh_"],
+        ) as client:
+            # Because our processing happens after mapping and refresh_message is alphabetically after message the override
+            # value isn't used, as the mapped value is overridden by the first value.
+            assert client["message"] == "original value"
+            assert "refresh_message" not in client
+
+    # method: load
+    @app_config_decorator_async
+    @recorded_by_proxy_async
+    async def test_configuration_mapper_with_feature_flags(
+        self, appconfiguration_connection_string, appconfiguration_keyvault_secret_url
+    ):
+        async def test_mapper(setting):
+            if setting.key == ".appconfig.featureflag/Alpha":
+                setting.content_type = "application/json"
+
+        async with await self.create_client(
+            connection_string=appconfiguration_connection_string,
+            keyvault_secret_url=appconfiguration_keyvault_secret_url,
+            feature_flag_enabled=True,
+            configuration_mapper=test_mapper,
+            trim_prefixes=[".appconfig.featureflag/"],
+        ) as client:
+            # Feature Flags aren't modified by configuration mappers
+            assert "Alpha" not in client
+            assert client["feature_management"]["feature_flags"][0]["id"] == "Alpha"
+
 
 async def secret_resolver(secret_id):
     return "Resolver Value"

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

@@ -296,6 +296,66 @@ def test_provider_special_chars_tag_filters(
         assert "only_second_tag" not in client
         assert "complex_tag" in client
 
+    # method: load
+    @recorded_by_proxy
+    @app_config_decorator
+    def test_configuration_mapper(self, appconfiguration_connection_string, appconfiguration_keyvault_secret_url):
+        def test_mapper(setting):
+            if setting.key == "message":
+                setting.value = "mapped"
+
+        client = self.create_client(
+            connection_string=appconfiguration_connection_string,
+            keyvault_secret_url=appconfiguration_keyvault_secret_url,
+            feature_flag_enabled=True,
+            configuration_mapper=test_mapper,
+        )
+        assert client["message"] == "mapped"
+        assert client["refresh_message"] == "original value"
+
+    # method: load
+    @recorded_by_proxy
+    @app_config_decorator
+    def test_configuration_mapper_with_trimming(
+        self, appconfiguration_connection_string, appconfiguration_keyvault_secret_url
+    ):
+        def test_mapper(setting):
+            if setting.key == "message":
+                setting.value = "mapped"
+
+        client = self.create_client(
+            connection_string=appconfiguration_connection_string,
+            keyvault_secret_url=appconfiguration_keyvault_secret_url,
+            configuration_mapper=test_mapper,
+            trim_prefixes=["refresh_"],
+        )
+
+        # Because our processing happens after mapping and refresh_message is alphabetically after message the override
+        # value isn't used, as the mapped value is overridden by the first value.
+        assert client["message"] == "original value"
+        assert "refresh_message" not in client
+
+    # method: load
+    @recorded_by_proxy
+    @app_config_decorator
+    def test_configuration_mapper_with_feature_flags(
+        self, appconfiguration_connection_string, appconfiguration_keyvault_secret_url
+    ):
+        def test_mapper(setting):
+            if setting.key == ".appconfig.featureflag/Alpha":
+                setting.content_type = "application/json"
+
+        client = self.create_client(
+            connection_string=appconfiguration_connection_string,
+            keyvault_secret_url=appconfiguration_keyvault_secret_url,
+            feature_flag_enabled=True,
+            configuration_mapper=test_mapper,
+            trim_prefixes=[".appconfig.featureflag/"],
+        )
+        # Feature Flags aren't modified by configuration mappers
+        assert "Alpha" not in client
+        assert client["feature_management"]["feature_flags"][0]["id"] == "Alpha"
+
 
 def secret_resolver(secret_id):
     return "Resolver Value"