refactor: AppConfig params to match Parameters

Author: heitorlessa

aws_lambda_powertools/utilities/feature_toggles/appconfig_fetcher.py

@@ -18,8 +18,8 @@ class AppConfigFetcher(SchemaFetcher):
     def __init__(
         self,
         environment: str,
-        service: str,
-        configuration_name: str,
+        application: str,
+        name: str,
         cache_seconds: int,
         config: Optional[Config] = None,
     ):
@@ -28,19 +28,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,7 +60,7 @@ 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,
                 ),

aws_lambda_powertools/utilities/feature_toggles/schema_fetcher.py

@@ -4,12 +4,12 @@
 
 class SchemaFetcher(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
         ------

docs/utilities/feature_flags.md

@@ -66,5 +66,6 @@ Potential changes to be validated when docs are in a better shape
 - [ ] Use `base.py` for interfaces for consistency (e.g. Metrics, Tracer, etc.)
 - [ ] Some docstrings and logger refer to AWS AppConfig only (outdated given SchemaFetcher)
 - [ ] Review why we're testing a private method(`is_rule_matched`)
-
-**Q: Why is `get_configuration()` public?**
+- [x] AppConfig construct parameter names for consistency (e.g. `configuration_name` -> `name`, `service` -> `application`)
+- [ ] Review `get_configuration`, `get_json_configuration`
+- [ ] Review `get_feature` in favour of `get_feature_toggle`

tests/functional/feature_toggles/test_feature_toggles.py

@@ -21,8 +21,8 @@ def init_configuration_store(mocker, mock_schema: Dict, config: Config) -> Confi
 
     app_conf_fetcher = AppConfigFetcher(
         environment="test_env",
-        service="test_app",
-        configuration_name="test_conf_name",
+        application="test_app",
+        name="test_conf_name",
         cache_seconds=600,
         config=config,
     )
@@ -35,8 +35,8 @@ def init_fetcher_side_effect(mocker, config: Config, side_effect) -> AppConfigFe
     mocked_get_conf.side_effect = side_effect
     return AppConfigFetcher(
         environment="env",
-        service="service",
-        configuration_name="conf",
+        application="application",
+        name="conf",
         cache_seconds=1,
         config=config,
     )