refactor: rename ConfigurationStore, SchemaFetcher

Author: heitorlessa

aws_lambda_powertools/utilities/feature_toggles/__init__.py

@@ -1,16 +1,16 @@
 """Advanced feature toggles utility
 """
-from .appconfig_fetcher import AppConfigFetcher
-from .configuration_store import ConfigurationStore
+from .appconfig import AppConfigStore
+from .base import StoreProvider
 from .exceptions import ConfigurationError
+from .feature_flags import FeatureFlags
 from .schema import ACTION, SchemaValidator
-from .schema_fetcher import SchemaFetcher
 
 __all__ = [
     "ConfigurationError",
-    "ConfigurationStore",
+    "FeatureFlags",
     "ACTION",
     "SchemaValidator",
-    "AppConfigFetcher",
-    "SchemaFetcher",
+    "AppConfigStore",
+    "StoreProvider",
 ]

aws_lambda_powertools/utilities/feature_toggles/appconfig_fetcher.py renamed to aws_lambda_powertools/utilities/feature_toggles/appconfig.py

@@ -5,16 +5,16 @@
 
 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,

aws_lambda_powertools/utilities/feature_toggles/schema_fetcher.py renamed to aws_lambda_powertools/utilities/feature_toggles/base.py

@@ -2,7 +2,7 @@
 from typing import Any, Dict
 
 
-class SchemaFetcher(ABC):
+class StoreProvider(ABC):
     def __init__(self, configuration_name: str, cache_seconds: int):
         self.name = configuration_name
         self._cache_seconds = cache_seconds

aws_lambda_powertools/utilities/feature_toggles/configuration_store.py renamed to aws_lambda_powertools/utilities/feature_toggles/feature_flags.py

@@ -2,19 +2,19 @@
 from typing import Any, Dict, List, Optional, cast
 
 from . import schema
+from .base import StoreProvider
 from .exceptions import ConfigurationError
-from .schema_fetcher import SchemaFetcher
 
 logger = logging.getLogger(__name__)
 
 
-class ConfigurationStore:
-    def __init__(self, schema_fetcher: SchemaFetcher):
+class FeatureFlags:
+    def __init__(self, schema_fetcher: StoreProvider):
         """constructor
 
         Parameters
         ----------
-        schema_fetcher: SchemaFetcher
+        schema_fetcher: StoreProvider
             A schema JSON fetcher, can be AWS AppConfig, Hashicorp Consul etc.
         """
         self._logger = logger

docs/utilities/feature_flags.md

@@ -61,10 +61,10 @@ By default, this utility provides AWS AppConfig as a configuration store. As suc
 Potential changes to be validated when docs are in a better shape
 
 - [x] ~~`rules_context` to `context`~~
-- [ ] `ConfigurationStore` to `FeatureFlags`
-- [ ] `SchemaFetcher` to `StoreProvider`
+- [x] `ConfigurationStore` to `FeatureFlags`
+- [x] `StoreProvider` to `StoreProvider`
 - [ ] Use `base.py` for interfaces for consistency (e.g. Metrics, Tracer, etc.)
-- [ ] Some docstrings and logger refer to AWS AppConfig only (outdated given SchemaFetcher)
+- [ ] Some docstrings and logger refer to AWS AppConfig only (outdated given StoreProvider)
 - [ ] Review why we're testing a private method(`is_rule_matched`)
 - [x] AppConfig construct parameter names for consistency (e.g. `configuration_name` -> `name`, `service` -> `application`)
 - [ ] Review `get_configuration`, `get_json_configuration`

tests/functional/feature_toggles/test_feature_toggles.py

@@ -4,8 +4,8 @@
 from botocore.config import Config
 
 from aws_lambda_powertools.utilities.feature_toggles import ConfigurationError, schema
-from aws_lambda_powertools.utilities.feature_toggles.appconfig_fetcher import AppConfigFetcher
-from aws_lambda_powertools.utilities.feature_toggles.configuration_store import ConfigurationStore
+from aws_lambda_powertools.utilities.feature_toggles.appconfig import AppConfigStore
+from aws_lambda_powertools.utilities.feature_toggles.feature_flags import FeatureFlags
 from aws_lambda_powertools.utilities.feature_toggles.schema import ACTION
 from aws_lambda_powertools.utilities.parameters import GetParameterError
 
@@ -15,25 +15,25 @@ def config():
     return Config(region_name="us-east-1")
 
 
-def init_configuration_store(mocker, mock_schema: Dict, config: Config) -> ConfigurationStore:
+def init_configuration_store(mocker, mock_schema: Dict, config: Config) -> FeatureFlags:
     mocked_get_conf = mocker.patch("aws_lambda_powertools.utilities.parameters.AppConfigProvider.get")
     mocked_get_conf.return_value = mock_schema
 
-    app_conf_fetcher = AppConfigFetcher(
+    app_conf_fetcher = AppConfigStore(
         environment="test_env",
         application="test_app",
         name="test_conf_name",
         cache_seconds=600,
         config=config,
     )
-    conf_store: ConfigurationStore = ConfigurationStore(schema_fetcher=app_conf_fetcher)
+    conf_store: FeatureFlags = FeatureFlags(schema_fetcher=app_conf_fetcher)
     return conf_store
 
 
-def init_fetcher_side_effect(mocker, config: Config, side_effect) -> AppConfigFetcher:
+def init_fetcher_side_effect(mocker, config: Config, side_effect) -> AppConfigStore:
     mocked_get_conf = mocker.patch("aws_lambda_powertools.utilities.parameters.AppConfigProvider.get")
     mocked_get_conf.side_effect = side_effect
-    return AppConfigFetcher(
+    return AppConfigStore(
         environment="env",
         application="application",
         name="conf",
@@ -423,7 +423,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
     schema_fetcher = init_fetcher_side_effect(mocker, config, GetParameterError())
-    conf_store = ConfigurationStore(schema_fetcher)
+    conf_store = FeatureFlags(schema_fetcher)
 
     # WHEN calling get_feature_toggle
     toggle = conf_store.get_feature_toggle(feature_name="Foo", value_if_missing=False)
@@ -435,7 +435,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
     schema_fetcher = init_fetcher_side_effect(mocker, config, GetParameterError())
-    conf_store = ConfigurationStore(schema_fetcher)
+    conf_store = FeatureFlags(schema_fetcher)
 
     # WHEN calling get_all_enabled_feature_toggles
     toggles = conf_store.get_all_enabled_feature_toggles(context=None)