rename default value

Author: Ran Isenberg

aws_lambda_powertools/utilities/feature_toggles/configuration_store.py

@@ -12,10 +12,10 @@
 TRANSFORM_TYPE = "json"
 FEATURES_KEY = "features"
 RULES_KEY = "rules"
-DEFAULT_VAL_KEY = "default_value"
+DEFAULT_VAL_KEY = "feature_default_value"
 RESTRICTIONS_KEY = "restrictions"
 RULE_NAME_KEY = "name"
-RULE_DEFAULT_VALUE = "default_value"
+RULE_DEFAULT_VALUE = "rule_default_value"
 RESTRICTION_KEY = "key"
 RESTRICTION_VALUE = "value"
 RESTRICTION_ACTION = "action"
@@ -73,7 +73,7 @@ def _handle_rules(
         *,
         feature_name: str,
         rules_context: Dict[str, Any],
-        default_value: bool,
+        feature_default_value: bool,
         rules: List[Dict[str, Any]],
     ) -> bool:
         for rule in rules:
@@ -88,21 +88,21 @@ def _handle_rules(
                     restriction.get(RESTRICTION_ACTION), restriction.get(RESTRICTION_VALUE), context_value
                 ):
                     logger.debug(
-                        f"rule did not match action, rule_name={rule_name}, default_value={rule_default_value}, feature_name={feature_name}, context_value={str(context_value)}"  # noqa: E501
+                        f"rule did not match action, rule_name={rule_name}, rule_default_value={rule_default_value}, feature_name={feature_name}, context_value={str(context_value)}"  # noqa: E501
                     )
                     is_match = False  # rules doesn't match restriction
                     break
             # if we got here, all restrictions match
             if is_match:
                 logger.debug(
-                    f"rule matched, rule_name={rule_name}, default_value={rule_default_value}, feature_name={feature_name}"  # noqa: E501
+                    f"rule matched, rule_name={rule_name}, rule_default_value={rule_default_value}, feature_name={feature_name}"  # noqa: E501
                 )
                 return rule_default_value
         # no rule matched, return default value of feature
         logger.debug(
-            f"no rule matched, returning default value of feature, default_value={default_value}, feature_name={feature_name}"  # noqa: E501
+            f"no rule matched, returning default value of feature, feature_default_value={feature_default_value}, feature_name={feature_name}"  # noqa: E501
         )
-        return default_value
+        return feature_default_value
 
     def get_configuration(self) -> Dict[str, Any]:
         """Get configuration string from AWs AppConfig and returned the parsed JSON dictionary
@@ -130,24 +130,24 @@ def get_configuration(self) -> Dict[str, Any]:
             raise ConfigurationException(error_str)
         return schema
 
-    def get_feature_toggle(self, *, feature_name: str, rules_context: Dict[str, Any], default_value: bool) -> bool:
+    def get_feature_toggle(self, *, feature_name: str, rules_context: Dict[str, Any], value_if_missing: bool) -> bool:
         """get a feature toggle boolean value. Value is calculated according to a set of rules and conditions.
            see below for explanation.
 
         Args:
             feature_name (str): feature name that you wish to fetch
             rules_context (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.
-            default_value (bool): this will be the returned value in case the feature toggle doesn't exist in the schema
+            value_if_missing (bool): this will be the returned value in case the feature toggle doesn't exist in the schema
                                   or there has been an error while fetching the configuration from appconfig
 
         Returns:
             bool: calculated feature toggle value. several possibilities:
                 1. if the feature doesn't appear in the schema or there has been an error fetching the
-                   configuration -> error log would appear and default_value is returned
-                2. feature exists and has no rules or no rules have matched -> return default_value of
+                   configuration -> warning log would appear and value_if_missing is returned
+                2. feature exists and has no rules or no rules have matched -> return feature_default_value of
                    the defined feature
-                3. feature exists and a rule matches -> default_value of rule is returned
+                3. feature exists and a rule matches -> rule_default_value of rule is returned
         """
         try:
             toggles_dict: Dict[str, Any] = self.get_configuration()
@@ -158,22 +158,22 @@ def get_feature_toggle(self, *, feature_name: str, rules_context: Dict[str, Any]
         feature: Dict[str, Dict] = toggles_dict.get(FEATURES_KEY, {}).get(feature_name, None)
         if feature is None:
             logger.warning(
-                f"feature does not appear in configuration, using provided default value, feature_name={feature_name}, default_value={default_value}"  # noqa: E501
+                f"feature does not appear in configuration, using provided default value, feature_name={feature_name}, value_if_missing={value_if_missing}"  # noqa: E501
             )
-            return default_value
+            return value_if_missing
 
         rules_list = feature.get(RULES_KEY, [])
-        default_value = feature.get(DEFAULT_VAL_KEY)
+        feature_default_value = feature.get(DEFAULT_VAL_KEY)
         if not rules_list:
             # not rules but has a value
             logger.debug(
-                f"no rules found, returning feature default value, feature_name={feature_name}, default_value={default_value}"  # noqa: E501
+                f"no rules found, returning feature default value, feature_name={feature_name}, default_value={feature_default_value}"  # noqa: E501
             )
-            return default_value
+            return feature_default_value
         # look for first rule match
         logger.debug(
-            f"looking for rule match,  feature_name={feature_name}, default_value={default_value}"
+            f"looking for rule match,  feature_name={feature_name}, feature_default_value={feature_default_value}"
         )  # noqa: E501
         return self._handle_rules(
-            feature_name=feature_name, rules_context=rules_context, default_value=default_value, rules=rules_list
+            feature_name=feature_name, rules_context=rules_context, feature_default_value=feature_default_value, rules=rules_list
         )

tests/functional/feature_toggles/test_feature_toggles.py

@@ -32,11 +32,11 @@ def test_toggles_rule_does_not_match(mocker, config):
         "log_level": "DEBUG",
         "features": {
             "my_feature": {
-                "default_value": expected_value,
+                "feature_default_value": expected_value,
                 "rules": [
                     {
                         "name": "tenant id equals 345345435",
-                        "default_value": "False",
+                        "rule_default_value": "False",
                         "restrictions": [
                             {
                                 "action": ACTION.EQUALS.value,
@@ -51,29 +51,29 @@ 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={}, default_value=False)
+    toggle = conf_store.get_feature_toggle(feature_name="my_feature", rules_context={}, value_if_missing=False)
     assert str(toggle) == expected_value
 
 
 # this test checks that if you try to get a feature that doesn't exist in the schema,
 # you get the default value of False that was sent to the get_feature_toggle API
 def test_toggles_no_restrictions_feature_does_not_exist(mocker, config):
     expected_value = False
-    mocked_app_config_schema = {"log_level": "DEBUG", "features": {"my_fake_feature": {"default_value": "True"}}}
+    mocked_app_config_schema = {"log_level": "DEBUG", "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={}, default_value=expected_value)
+    toggle = conf_store.get_feature_toggle(feature_name="my_feature", rules_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.
 # 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 = {"log_level": "DEBUG", "features": {"my_feature": {"default_value": expected_value}}}
+    mocked_app_config_schema = {"log_level": "DEBUG", "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"}, default_value=False
+        feature_name="my_feature", rules_context={"tenant_id": "6", "username": "a"}, value_if_missing=False
     )
     assert str(toggle) == expected_value
 
@@ -85,11 +85,11 @@ def test_toggles_restrictions_no_match(mocker, config):
         "log_level": "DEBUG",
         "features": {
             "my_feature": {
-                "default_value": expected_value,
+                "feature_default_value": expected_value,
                 "rules": [
                     {
                         "name": "tenant id equals 345345435",
-                        "default_value": "False",
+                        "rule_default_value": "False",
                         "restrictions": [
                             {
                                 "action": ACTION.EQUALS.value,
@@ -106,7 +106,7 @@ def test_toggles_restrictions_no_match(mocker, config):
     toggle = conf_store.get_feature_toggle(
         feature_name="my_feature",
         rules_context={"tenant_id": "6", "username": "a"},  # rule will not match
-        default_value=False,
+        value_if_missing=False,
     )
     assert str(toggle) == expected_value
 
@@ -120,11 +120,11 @@ def test_toggles_restrictions_rule_match_equal_multiple_restrictions(mocker, con
         "log_level": "DEBUG",
         "features": {
             "my_feature": {
-                "default_value": "True",
+                "feature_default_value": "True",
                 "rules": [
                     {
                         "name": "tenant id equals 6 and username is a",
-                        "default_value": expected_value,
+                        "rule_default_value": expected_value,
                         "restrictions": [
                             {
                                 "action": ACTION.EQUALS.value,  # this rule will match, it has multiple restrictions
@@ -149,7 +149,7 @@ def test_toggles_restrictions_rule_match_equal_multiple_restrictions(mocker, con
             "tenant_id": tenant_id_val,
             "username": username_val,
         },
-        default_value=True,
+        value_if_missing=True,
     )
     assert str(toggle) == expected_value
 
@@ -163,11 +163,11 @@ def test_toggles_restrictions_no_rule_match_equal_multiple_restrictions(mocker,
         "log_level": "DEBUG",
         "features": {
             "my_feature": {
-                "default_value": expected_val,
+                "feature_default_value": expected_val,
                 "rules": [
                     {
                         "name": "tenant id equals 645654 and username is a",  # rule will not match
-                        "default_value": "False",
+                        "rule_default_value": "False",
                         "restrictions": [
                             {
                                 "action": ACTION.EQUALS.value,
@@ -187,7 +187,7 @@ def test_toggles_restrictions_no_rule_match_equal_multiple_restrictions(mocker,
     }
     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"}, default_value=False
+        feature_name="my_feature", rules_context={"tenant_id": "6", "username": "a"}, value_if_missing=False
     )
     assert str(toggle) == expected_val
 
@@ -202,11 +202,11 @@ def test_toggles_restrictions_rule_match_multiple_actions_multiple_rules_multipl
         "log_level": "DEBUG",
         "features": {
             "my_feature": {
-                "default_value": expected_value_third_check,
+                "feature_default_value": expected_value_third_check,
                 "rules": [
                     {
                         "name": "tenant id equals 6 and username startswith a",
-                        "default_value": expected_value_first_check,
+                        "rule_default_value": expected_value_first_check,
                         "restrictions": [
                             {
                                 "action": ACTION.EQUALS.value,
@@ -222,7 +222,7 @@ def test_toggles_restrictions_rule_match_multiple_actions_multiple_rules_multipl
                     },
                     {
                         "name": "tenant id equals 4446 and username startswith a and endswith z",
-                        "default_value": expected_value_second_check,
+                        "rule_default_value": expected_value_second_check,
                         "restrictions": [
                             {
                                 "action": ACTION.EQUALS.value,
@@ -251,28 +251,28 @@ def test_toggles_restrictions_rule_match_multiple_actions_multiple_rules_multipl
     toggle = conf_store.get_feature_toggle(
         feature_name="my_feature",
         rules_context={"tenant_id": "6", "username": "abcd"},
-        default_value=False,
+        value_if_missing=False,
     )
     assert str(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"},
-        default_value=False,
+        value_if_missing=False,
     )
     assert str(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"},
-        default_value=False,
+        value_if_missing=False,
     )
     assert str(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"},
-        default_value=expected_value_fourth_case,
+        value_if_missing=expected_value_fourth_case,
     )
     assert toggle == expected_value_fourth_case
 
@@ -284,11 +284,11 @@ def test_toggles_match_rule_with_contains_action(mocker, config):
         "log_level": "DEBUG",
         "features": {
             "my_feature": {
-                "default_value": expected_value,
+                "feature_default_value": expected_value,
                 "rules": [
                     {
                         "name": "tenant id equals 345345435",
-                        "default_value": True,
+                        "rule_default_value": True,
                         "restrictions": [
                             {
                                 "action": ACTION.CONTAINS.value,
@@ -305,7 +305,7 @@ def test_toggles_match_rule_with_contains_action(mocker, config):
     toggle = conf_store.get_feature_toggle(
         feature_name="my_feature",
         rules_context={"tenant_id": "6", "username": "a"},  # rule will match
-        default_value=False,
+        value_if_missing=False,
     )
     assert toggle == expected_value
 
@@ -316,11 +316,11 @@ def test_toggles_no_match_rule_with_contains_action(mocker, config):
         "log_level": "DEBUG",
         "features": {
             "my_feature": {
-                "default_value": expected_value,
+                "feature_default_value": expected_value,
                 "rules": [
                     {
                         "name": "tenant id equals 345345435",
-                        "default_value": True,
+                        "rule_default_value": True,
                         "restrictions": [
                             {
                                 "action": ACTION.CONTAINS.value,
@@ -337,6 +337,6 @@ def test_toggles_no_match_rule_with_contains_action(mocker, config):
     toggle = conf_store.get_feature_toggle(
         feature_name="my_feature",
         rules_context={"tenant_id": "6", "username": "a"},  # rule will not match
-        default_value=False,
+        value_if_missing=False,
     )
     assert toggle == expected_value