refactor: rules_context to context

Author: heitorlessa

aws_lambda_powertools/utilities/feature_toggles/configuration_store.py

@@ -38,13 +38,13 @@ def _match_by_action(self, action: str, condition_value: Any, context_value: Any
             self._logger.error(f"caught exception while matching action, action={action}, exception={str(exc)}")
             return False
 
-    def _is_rule_matched(self, feature_name: str, rule: Dict[str, Any], rules_context: Dict[str, Any]) -> bool:
+    def _is_rule_matched(self, feature_name: str, rule: Dict[str, Any], context: Dict[str, Any]) -> bool:
         rule_name = rule.get(schema.RULE_NAME_KEY, "")
         rule_default_value = rule.get(schema.RULE_DEFAULT_VALUE)
         conditions = cast(List[Dict], rule.get(schema.CONDITIONS_KEY))
 
         for condition in conditions:
-            context_value = rules_context.get(str(condition.get(schema.CONDITION_KEY)))
+            context_value = context.get(str(condition.get(schema.CONDITION_KEY)))
             if not self._match_by_action(
                 condition.get(schema.CONDITION_ACTION, ""),
                 condition.get(schema.CONDITION_VALUE),
@@ -68,13 +68,13 @@ def _handle_rules(
         self,
         *,
         feature_name: str,
-        rules_context: Dict[str, Any],
+        context: Dict[str, Any],
         feature_default_value: bool,
         rules: List[Dict[str, Any]],
     ) -> bool:
         for rule in rules:
             rule_default_value = rule.get(schema.RULE_DEFAULT_VALUE)
-            if self._is_rule_matched(feature_name, rule, rules_context):
+            if self._is_rule_matched(feature_name, rule, context):
                 return bool(rule_default_value)
             # no rule matched, return default value of feature
             logger.debug(
@@ -104,7 +104,7 @@ def get_configuration(self) -> Dict[str, Any]:
         return config
 
     def get_feature_toggle(
-        self, *, feature_name: str, rules_context: Optional[Dict[str, Any]] = None, value_if_missing: bool
+        self, *, feature_name: str, context: Optional[Dict[str, Any]] = None, value_if_missing: bool
     ) -> bool:
         """Get a feature toggle boolean value. Value is calculated according to a set of rules and conditions.
 
@@ -114,7 +114,7 @@ def get_feature_toggle(
         ----------
         feature_name: str
             feature name that you wish to fetch
-        rules_context: Optional[Dict[str, Any]]
+        context: Optional[Dict[str, Any]]
             dict of attributes that you would like to match the rules
             against, can be {'tenant_id: 'X', 'username':' 'Y', 'region': 'Z'} etc.
         value_if_missing: bool
@@ -132,8 +132,8 @@ def get_feature_toggle(
                the defined feature
             3. feature exists and a rule matches -> rule_default_value of rule is returned
         """
-        if rules_context is None:
-            rules_context = {}
+        if context is None:
+            context = {}
 
         try:
             toggles_dict: Dict[str, Any] = self.get_configuration()
@@ -164,18 +164,18 @@ def get_feature_toggle(
         )
         return self._handle_rules(
             feature_name=feature_name,
-            rules_context=rules_context,
+            context=context,
             feature_default_value=bool(feature_default_value),
             rules=cast(List, rules_list),
         )
 
-    def get_all_enabled_feature_toggles(self, *, rules_context: Optional[Dict[str, Any]] = None) -> List[str]:
+    def get_all_enabled_feature_toggles(self, *, context: Optional[Dict[str, Any]] = None) -> List[str]:
         """Get all enabled feature toggles while also taking into account rule_context
         (when a feature has defined rules)
 
         Parameters
         ----------
-        rules_context: Optional[Dict[str, Any]]
+        context: Optional[Dict[str, Any]]
             dict of attributes that you would like to match the rules
             against, can be `{'tenant_id: 'X', 'username':' 'Y', 'region': 'Z'}` etc.
 
@@ -185,8 +185,8 @@ def get_all_enabled_feature_toggles(self, *, rules_context: Optional[Dict[str, A
             a list of all features name that are enabled by also taking into account
             rule_context (when a feature has defined rules)
         """
-        if rules_context is None:
-            rules_context = {}
+        if context is None:
+            context = {}
 
         try:
             toggles_dict: Dict[str, Any] = self.get_configuration()
@@ -206,7 +206,7 @@ def get_all_enabled_feature_toggles(self, *, rules_context: Optional[Dict[str, A
                 ret_list.append(feature_name)
             elif self._handle_rules(
                 feature_name=feature_name,
-                rules_context=rules_context,
+                context=context,
                 feature_default_value=feature_default_value,
                 rules=rules_list,
             ):

docs/utilities/feature_flags.md

@@ -56,24 +56,15 @@ By default, this utility provides AWS AppConfig as a configuration store. As suc
 
 > NOTE: Share example on how customers can unit test their feature flags
 
-## TODO
-
-* Review param names and UX
-	- Deep dive on naming - ConfigurationStore vs SchemaFetcher vs Schema
-	- How can we make it easier to get started
-* Getting started
-  	- Sample Infrastructure
-  	- Quickest way to start --- defaults, built-ins
-* Advanced section
-  	- Bring your own
-
 ## Changes
 
 Potential changes to be validated when docs are in a better shape
 
-- [ ] `rules_context` to `context`
+- [x] ~~`rules_context` to `context`~~
 - [ ] `ConfigurationStore` to `FeatureFlags`
 - [ ] `SchemaFetcher` 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)
-- [ ]
+- [ ] Review why we're testing a private method(`is_rule_matched`)
+
+**Q: Why is `get_configuration()` public?**

tests/functional/feature_toggles/test_feature_toggles.py

@@ -43,7 +43,7 @@ def init_fetcher_side_effect(mocker, config: Config, side_effect) -> AppConfigFe
 
 
 # this test checks that we get correct value of feature that exists in the schema.
-# we also don't send an empty rules_context dict in this case
+# we also don't send an empty context dict in this case
 def test_toggles_rule_does_not_match(mocker, config):
     expected_value = True
     mocked_app_config_schema = {
@@ -68,7 +68,7 @@ def test_toggles_rule_does_not_match(mocker, config):
     }
 
     conf_store = init_configuration_store(mocker, mocked_app_config_schema, config)
-    toggle = conf_store.get_feature_toggle(feature_name="my_feature", rules_context={}, value_if_missing=False)
+    toggle = conf_store.get_feature_toggle(feature_name="my_feature", context={}, value_if_missing=False)
     assert toggle == expected_value
 
 
@@ -79,18 +79,18 @@ def test_toggles_no_conditions_feature_does_not_exist(mocker, config):
     mocked_app_config_schema = {"features": {"my_fake_feature": {"feature_default_value": True}}}
 
     conf_store = init_configuration_store(mocker, mocked_app_config_schema, config)
-    toggle = conf_store.get_feature_toggle(feature_name="my_feature", rules_context={}, value_if_missing=expected_value)
+    toggle = conf_store.get_feature_toggle(feature_name="my_feature", context={}, value_if_missing=expected_value)
     assert toggle == expected_value
 
 
-# check that feature match works when they are no rules and we send rules_context.
+# check that feature match works when they are no rules and we send context.
 # default value is False but the feature has a True default_value.
 def test_toggles_no_rules(mocker, config):
     expected_value = True
     mocked_app_config_schema = {"features": {"my_feature": {"feature_default_value": expected_value}}}
     conf_store = init_configuration_store(mocker, mocked_app_config_schema, config)
     toggle = conf_store.get_feature_toggle(
-        feature_name="my_feature", rules_context={"tenant_id": "6", "username": "a"}, value_if_missing=False
+        feature_name="my_feature", context={"tenant_id": "6", "username": "a"}, value_if_missing=False
     )
     assert toggle == expected_value
 
@@ -120,9 +120,7 @@ def test_toggles_conditions_no_match(mocker, config):
     }
     conf_store = init_configuration_store(mocker, mocked_app_config_schema, config)
     toggle = conf_store.get_feature_toggle(
-        feature_name="my_feature",
-        rules_context={"tenant_id": "6", "username": "a"},  # rule will not match
-        value_if_missing=False,
+        feature_name="my_feature", context={"tenant_id": "6", "username": "a"}, value_if_missing=False
     )
     assert toggle == expected_value
 
@@ -160,7 +158,7 @@ def test_toggles_conditions_rule_match_equal_multiple_conditions(mocker, config)
     conf_store = init_configuration_store(mocker, mocked_app_config_schema, config)
     toggle = conf_store.get_feature_toggle(
         feature_name="my_feature",
-        rules_context={
+        context={
             "tenant_id": tenant_id_val,
             "username": username_val,
         },
@@ -201,7 +199,7 @@ def test_toggles_conditions_no_rule_match_equal_multiple_conditions(mocker, conf
     }
     conf_store = init_configuration_store(mocker, mocked_app_config_schema, config)
     toggle = conf_store.get_feature_toggle(
-        feature_name="my_feature", rules_context={"tenant_id": "6", "username": "a"}, value_if_missing=False
+        feature_name="my_feature", context={"tenant_id": "6", "username": "a"}, value_if_missing=False
     )
     assert toggle == expected_val
 
@@ -262,29 +260,23 @@ def test_toggles_conditions_rule_match_multiple_actions_multiple_rules_multiple_
     conf_store = init_configuration_store(mocker, mocked_app_config_schema, config)
     # match first rule
     toggle = conf_store.get_feature_toggle(
-        feature_name="my_feature",
-        rules_context={"tenant_id": "6", "username": "abcd"},
-        value_if_missing=False,
+        feature_name="my_feature", context={"tenant_id": "6", "username": "abcd"}, value_if_missing=False
     )
     assert toggle == expected_value_first_check
     # match second rule
     toggle = conf_store.get_feature_toggle(
-        feature_name="my_feature",
-        rules_context={"tenant_id": "4446", "username": "az"},
-        value_if_missing=False,
+        feature_name="my_feature", context={"tenant_id": "4446", "username": "az"}, value_if_missing=False
     )
     assert toggle == expected_value_second_check
     # match no rule
     toggle = conf_store.get_feature_toggle(
-        feature_name="my_feature",
-        rules_context={"tenant_id": "11114446", "username": "ab"},
-        value_if_missing=False,
+        feature_name="my_feature", context={"tenant_id": "11114446", "username": "ab"}, value_if_missing=False
     )
     assert toggle == expected_value_third_check
     # feature doesn't exist
     toggle = conf_store.get_feature_toggle(
         feature_name="my_fake_feature",
-        rules_context={"tenant_id": "11114446", "username": "ab"},
+        context={"tenant_id": "11114446", "username": "ab"},
         value_if_missing=expected_value_fourth_case,
     )
     assert toggle == expected_value_fourth_case
@@ -315,9 +307,7 @@ def test_toggles_match_rule_with_contains_action(mocker, config):
     }
     conf_store = init_configuration_store(mocker, mocked_app_config_schema, config)
     toggle = conf_store.get_feature_toggle(
-        feature_name="my_feature",
-        rules_context={"tenant_id": "6", "username": "a"},  # rule will match
-        value_if_missing=False,
+        feature_name="my_feature", context={"tenant_id": "6", "username": "a"}, value_if_missing=False
     )
     assert toggle == expected_value
 
@@ -346,9 +336,7 @@ def test_toggles_no_match_rule_with_contains_action(mocker, config):
     }
     conf_store = init_configuration_store(mocker, mocked_app_config_schema, config)
     toggle = conf_store.get_feature_toggle(
-        feature_name="my_feature",
-        rules_context={"tenant_id": "6", "username": "a"},  # rule will not match
-        value_if_missing=False,
+        feature_name="my_feature", context={"tenant_id": "6", "username": "a"}, value_if_missing=False
     )
     assert toggle == expected_value
 
@@ -379,9 +367,7 @@ def test_multiple_features_enabled(mocker, config):
         },
     }
     conf_store = init_configuration_store(mocker, mocked_app_config_schema, config)
-    enabled_list: List[str] = conf_store.get_all_enabled_feature_toggles(
-        rules_context={"tenant_id": "6", "username": "a"}
-    )
+    enabled_list: List[str] = conf_store.get_all_enabled_feature_toggles(context={"tenant_id": "6", "username": "a"})
     assert enabled_list == expected_value
 
 
@@ -430,9 +416,7 @@ def test_multiple_features_only_some_enabled(mocker, config):
         },
     }
     conf_store = init_configuration_store(mocker, mocked_app_config_schema, config)
-    enabled_list: List[str] = conf_store.get_all_enabled_feature_toggles(
-        rules_context={"tenant_id": "6", "username": "a"}
-    )
+    enabled_list: List[str] = conf_store.get_all_enabled_feature_toggles(context={"tenant_id": "6", "username": "a"})
     assert enabled_list == expected_value
 
 
@@ -454,7 +438,7 @@ def test_get_all_enabled_feature_toggles_handles_error(mocker, config):
     conf_store = ConfigurationStore(schema_fetcher)
 
     # WHEN calling get_all_enabled_feature_toggles
-    toggles = conf_store.get_all_enabled_feature_toggles(rules_context=None)
+    toggles = conf_store.get_all_enabled_feature_toggles(context=None)
 
     # THEN handle the error and return an empty list
     assert toggles == []