refactor(feature-flags): optimize UX and maintenance

aws_lambda_powertools/utilities/feature_flags/__init__.py

@@ -0,0 +1,16 @@
+"""Advanced feature toggles utility
+"""
+from .appconfig import AppConfigStore
+from .base import StoreProvider
+from .exceptions import ConfigurationError
+from .feature_flags import FeatureFlags
+from .schema import RuleAction, SchemaValidator
+
+__all__ = [
+    "ConfigurationError",
+    "FeatureFlags",
+    "RuleAction",
+    "SchemaValidator",
+    "AppConfigStore",
+    "StoreProvider",
+]

aws_lambda_powertools/utilities/feature_toggles/appconfig_fetcher.py → aws_lambda_powertools/utilities/feature_flags/appconfig.py

@@ -5,21 +5,20 @@
 
 from aws_lambda_powertools.utilities.parameters import AppConfigProvider, GetParameterError, TransformParameterError
 
+from .base import StoreProvider
 from .exceptions import ConfigurationError
-from .schema_fetcher import SchemaFetcher
 
 logger = logging.getLogger(__name__)
 
-
 TRANSFORM_TYPE = "json"
 
 
-class AppConfigFetcher(SchemaFetcher):
+class AppConfigStore(StoreProvider):
     def __init__(
         self,
         environment: str,
-        service: str,
-        configuration_name: str,
+        application: str,
+        name: str,
         cache_seconds: int,
         config: Optional[Config] = None,
     ):
@@ -28,19 +27,19 @@ def __init__(
         Parameters
         ----------
         environment: str
-            what appconfig environment to use 'dev/test' etc.
-        service: str
-            what service name to use from the supplied environment
-        configuration_name: str
-            what configuration to take from the environment & service combination
+            Appconfig environment, e.g. 'dev/test' etc.
+        application: str
+            AppConfig application name, e.g. 'powertools'
+        name: str
+            AppConfig configuration name e.g. `my_conf`
         cache_seconds: int
             cache expiration time, how often to call AppConfig to fetch latest configuration
         config: Optional[Config]
             boto3 client configuration
         """
-        super().__init__(configuration_name, cache_seconds)
+        super().__init__(name, cache_seconds)
         self._logger = logger
-        self._conf_store = AppConfigProvider(environment=environment, application=service, config=config)
+        self._conf_store = AppConfigProvider(environment=environment, application=application, config=config)
 
     def get_json_configuration(self) -> Dict[str, Any]:
         """Get configuration string from AWs AppConfig and return the parsed JSON dictionary
@@ -60,12 +59,10 @@ def get_json_configuration(self) -> Dict[str, Any]:
             return cast(
                 dict,
                 self._conf_store.get(
-                    name=self.configuration_name,
+                    name=self.name,
                     transform=TRANSFORM_TYPE,
                     max_age=self._cache_seconds,
                 ),
             )
         except (GetParameterError, TransformParameterError) as exc:
-            error_str = f"unable to get AWS AppConfig configuration file, exception={str(exc)}"
-            self._logger.error(error_str)
-            raise ConfigurationError(error_str)
+            raise ConfigurationError("Unable to get AWS AppConfig configuration file") from exc

aws_lambda_powertools/utilities/feature_toggles/schema_fetcher.py → aws_lambda_powertools/utilities/feature_flags/base.py

@@ -2,14 +2,14 @@
 from typing import Any, Dict
 
 
-class SchemaFetcher(ABC):
+class StoreProvider(ABC):
     def __init__(self, configuration_name: str, cache_seconds: int):
-        self.configuration_name = configuration_name
+        self.name = configuration_name
         self._cache_seconds = cache_seconds
 
     @abstractmethod
     def get_json_configuration(self) -> Dict[str, Any]:
-        """Get configuration string from any configuration storing service and return the parsed JSON dictionary
+        """Get configuration string from any configuration storing application and return the parsed JSON dictionary
 
         Raises
         ------
@@ -22,3 +22,9 @@ def get_json_configuration(self) -> Dict[str, Any]:
             parsed JSON dictionary
         """
         return NotImplemented  # pragma: no cover
+
+
+class BaseValidator(ABC):
+    @abstractmethod
+    def validate(self):
+        return NotImplemented  # pragma: no cover