refactor: rename ConfigurationError to ConfigurationStoreError, impro catch

Author: heitorlessa

aws_lambda_powertools/utilities/feature_flags/__init__.py

@@ -2,12 +2,12 @@
 """
 from .appconfig import AppConfigStore
 from .base import StoreProvider
-from .exceptions import ConfigurationError
+from .exceptions import ConfigurationStoreError
 from .feature_flags import FeatureFlags
 from .schema import RuleAction, SchemaValidator
 
 __all__ = [
-    "ConfigurationError",
+    "ConfigurationStoreError",
     "FeatureFlags",
     "RuleAction",
     "SchemaValidator",

aws_lambda_powertools/utilities/feature_flags/appconfig.py

@@ -7,7 +7,7 @@
 
 from ...shared import jmespath_utils
 from .base import StoreProvider
-from .exceptions import ConfigurationError
+from .exceptions import ConfigurationStoreError
 
 logger = logging.getLogger(__name__)
 
@@ -59,7 +59,7 @@ def get_configuration(self) -> Dict[str, Any]:
 
         Raises
         ------
-        ConfigurationError
+        ConfigurationStoreError
             Any validation error or AppConfig error that can occur
 
         Returns
@@ -82,4 +82,4 @@ def get_configuration(self) -> Dict[str, Any]:
 
             return cast(dict, config)
         except (GetParameterError, TransformParameterError) as exc:
-            raise ConfigurationError("Unable to get AWS AppConfig configuration file") from exc
+            raise ConfigurationStoreError("Unable to get AWS AppConfig configuration file") from exc

aws_lambda_powertools/utilities/feature_flags/base.py

@@ -9,7 +9,7 @@ def get_configuration(self) -> Dict[str, Any]:
 
         Raises
         ------
-        ConfigurationError
+        ConfigurationStoreError
             Any error that can occur during schema fetch or JSON parse
 
         Returns

aws_lambda_powertools/utilities/feature_flags/exceptions.py

@@ -1,4 +1,4 @@
-class ConfigurationError(Exception):
+class ConfigurationStoreError(Exception):
     """When a configuration store raises an exception on config retrieval or parsing"""
 
 

aws_lambda_powertools/utilities/feature_flags/feature_flags.py

@@ -3,7 +3,7 @@
 
 from . import schema
 from .base import StoreProvider
-from .exceptions import ConfigurationError
+from .exceptions import ConfigurationStoreError
 
 logger = logging.getLogger(__name__)
 
@@ -103,8 +103,8 @@ def get_configuration(self) -> Union[Dict[str, Dict], Dict]:
 
         Raises
         ------
-        ConfigurationError
-            Any validation error
+        ConfigurationStoreError
+            Any propagated error from store
         SchemaValidationError
             When schema doesn't conform with feature flag schema
 
@@ -140,7 +140,10 @@ def get_configuration(self) -> Union[Dict[str, Dict], Dict]:
         """
         # parse result conf as JSON, keep in cache for max age defined in store
         logger.debug(f"Fetching schema from registered store, store={self._store}")
-        config = self._store.get_configuration()
+        try:
+            config = self._store.get_configuration()
+        except Exception as err:
+            raise ConfigurationStoreError("Unable to fetch schema from registered store") from err
 
         validator = schema.SchemaValidator(schema=config)
         validator.validate()
@@ -183,7 +186,7 @@ def evaluate(self, *, name: str, context: Optional[Dict[str, Any]] = None, defau
 
         try:
             features = self.get_configuration()
-        except ConfigurationError as err:
+        except ConfigurationStoreError as err:
             logger.debug(f"Failed to fetch feature flags from store, returning default provided, reason={err}")
             return default
 
@@ -234,7 +237,7 @@ def get_enabled_features(self, *, context: Optional[Dict[str, Any]] = None) -> L
 
         try:
             features: Dict[str, Any] = self.get_configuration()
-        except ConfigurationError as err:
+        except ConfigurationStoreError as err:
             logger.debug(f"Failed to fetch feature flags from store, returning empty list, reason={err}")
             return features_enabled
 

tests/functional/feature_toggles/test_feature_toggles.py

@@ -3,7 +3,7 @@
 import pytest
 from botocore.config import Config
 
-from aws_lambda_powertools.utilities.feature_flags import ConfigurationError, schema
+from aws_lambda_powertools.utilities.feature_flags import ConfigurationStoreError, schema
 from aws_lambda_powertools.utilities.feature_flags.appconfig import AppConfigStore
 from aws_lambda_powertools.utilities.feature_flags.feature_flags import FeatureFlags
 from aws_lambda_powertools.utilities.feature_flags.schema import RuleAction
@@ -387,7 +387,7 @@ def test_multiple_features_only_some_enabled(mocker, config):
 
 
 def test_get_feature_toggle_handles_error(mocker, config):
-    # GIVEN a schema fetch that raises a ConfigurationError
+    # GIVEN a schema fetch that raises a ConfigurationStoreError
     schema_fetcher = init_fetcher_side_effect(mocker, config, GetParameterError())
     feature_flags = FeatureFlags(schema_fetcher)
 
@@ -399,7 +399,7 @@ def test_get_feature_toggle_handles_error(mocker, config):
 
 
 def test_get_all_enabled_feature_toggles_handles_error(mocker, config):
-    # GIVEN a schema fetch that raises a ConfigurationError
+    # GIVEN a schema fetch that raises a ConfigurationStoreError
     schema_fetcher = init_fetcher_side_effect(mocker, config, GetParameterError())
     feature_flags = FeatureFlags(schema_fetcher)
 
@@ -415,10 +415,10 @@ def test_app_config_get_parameter_err(mocker, config):
     app_conf_fetcher = init_fetcher_side_effect(mocker, config, GetParameterError())
 
     # WHEN calling get_configuration
-    with pytest.raises(ConfigurationError) as err:
+    with pytest.raises(ConfigurationStoreError) as err:
         app_conf_fetcher.get_configuration()
 
-    # THEN raise ConfigurationError error
+    # THEN raise ConfigurationStoreError error
     assert "AWS AppConfig configuration" in str(err.value)