refactor(sdk): update logs and added test cases for feature rollout whitelisting

softvar · softvar · commit 3f3826332b93 · 2021-10-21T17:17:39.000+05:30
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Updated whitelisting logs for Feature Rollout campaign
+- Test cases added to verify whitelisting cases in Feature Rollout campaign
+
+## [1.23.1] - 2020-10-21
+
+### Changed
+
 - Refactored code to prevent multiple calls to get data from User Storage Service, if used.
 
 ## [1.23.0] - 2021-09-29
diff --git a/tests/api/test_is_feature_enabled.py b/tests/api/test_is_feature_enabled.py
@@ -17,6 +17,7 @@
 import json
 import random
 import mock
+import copy
 
 import vwo
 from ..data.settings_files import SETTINGS_FILES
@@ -87,6 +88,52 @@ def test_is_feature_enabled_FR_W_100(self):
         for test in USER_EXPECTATIONS.get("T_100_W_10_20_30_40"):
             self.assertIs(self.vwo.is_feature_enabled("FR_T_100_W_100", test["user"]), test["variation"] is not None)
 
+    def test_is_feature_enabled_FR_T_100_WW(self):
+        settings_file = copy.deepcopy(SETTINGS_FILES.get("FR_T_100_WW"))
+        vwo_instance = vwo.launch(json.dumps(settings_file), is_development_mode=True, log_level=TEST_LOG_LEVEL)
+
+        false_variation_targeting_variables = {"safari": "true"}
+        self.assertTrue(
+            vwo_instance.is_feature_enabled(
+                "FR_T_100_WW", "ashley", variation_targeting_variables=false_variation_targeting_variables
+            )
+        )
+
+        self.assertTrue(vwo_instance.is_feature_enabled("FR_T_100_WW", "ashley"))
+
+    def test_is_feature_enabled_FR_T_10_WW(self):
+        settings_file = copy.deepcopy(SETTINGS_FILES.get("FR_T_100_WW"))
+        settings_file["campaigns"][0]["percentTraffic"] = 10
+        vwo_instance = vwo.launch(json.dumps(settings_file), is_development_mode=True, log_level=TEST_LOG_LEVEL)
+
+        false_variation_targeting_variables = {"safari": "true"}
+        self.assertTrue(
+            vwo_instance.is_feature_enabled(
+                "FR_T_100_WW", "ashley", variation_targeting_variables=false_variation_targeting_variables
+            )
+        )
+
+        false_variation_targeting_variables = {"safari": "false"}
+        self.assertFalse(
+            vwo_instance.is_feature_enabled(
+                "FR_T_100_WW", "ashley", variation_targeting_variables=false_variation_targeting_variables
+            )
+        )
+
+    def test_is_feature_enabled_FR_T_0_WW(self):
+        settings_file = copy.deepcopy(SETTINGS_FILES.get("FR_T_100_WW"))
+        settings_file["campaigns"][0]["percentTraffic"] = 0
+        vwo_instance = vwo.launch(json.dumps(settings_file), is_development_mode=True, log_level=TEST_LOG_LEVEL)
+
+        false_variation_targeting_variables = {"safari": "true"}
+        self.assertTrue(
+            vwo_instance.is_feature_enabled(
+                "FR_T_100_WW", "ashley", variation_targeting_variables=false_variation_targeting_variables
+            )
+        )
+
+        self.assertFalse(vwo_instance.is_feature_enabled("FR_T_100_WW", "ashley"))
+
     def test_is_feature_enabled_FT_T_75_W_10_20_30_40(self):
         self.set_up("FT_T_75_W_10_20_30_40")
         feature_not_enabled_variations = ["Control"]
diff --git a/tests/data/settings_files.py b/tests/data/settings_files.py
@@ -348,6 +348,35 @@
         "accountId": 123456,
         "version": 2,
     },
+    "FR_T_100_WW": {
+        "sdkKey": "someuniquestuff1234567",
+        "groups": {},
+        "campaignGroups": {},
+        "campaigns": [
+            {
+                "goals": [],
+                "variations": [
+                    {
+                        "id": "1",
+                        "name": "Control",
+                        "weight": 100,
+                        "segments": {"or": [{"custom_variable": {"safari": "true"}}]},
+                    }
+                ],
+                "variables": [{"id": 2, "key": "BOOLEAN_VARIABLE", "type": "boolean", "value": True}],
+                "id": 29,
+                "percentTraffic": 100,
+                "isForcedVariationEnabled": True,
+                "key": "FR_T_100_WW",
+                "name": "Campaign-24",
+                "status": "RUNNING",
+                "type": "FEATURE_ROLLOUT",
+                "segments": {},
+            }
+        ],
+        "accountId": 123456,
+        "version": 2,
+    },
     "FR_WRONG_VARIABLE_TYPE": {
         "sdkKey": "someuniquestuff1234567",
         "campaigns": [
diff --git a/vwo/constants/constants.py b/vwo/constants/constants.py
@@ -106,6 +106,11 @@ class PUSH_API:
 PY_VARIABLE_TYPES = {"string": str, "integer": int, "double": float, "boolean": bool, "json": dict}
 
 
+class SEGMENTATION_TYPES:
+    WHITELISTING = "whitelisting"
+    PRE_SEGMENTATION = "pre_segmentation"
+
+
 # For exposing log levels to vwo_instance
 class LOG_LEVELS:
     DEBUG = logging.DEBUG
diff --git a/vwo/core/variation_decider.py b/vwo/core/variation_decider.py
@@ -133,16 +133,6 @@ def get_variation(self, user_id, campaign, **kwargs):  # noqa: C901
         # Evaluate whitelisting at first
         targeted_variation = self.find_targeted_variation(user_id, campaign, variation_targeting_variables)
         if targeted_variation:
-            self.logger.log(
-                LogLevelEnum.INFO,
-                LogMessageEnum.INFO_MESSAGES.GOT_VARIATION_FOR_USER.format(
-                    file=FILE,
-                    variation_name=targeted_variation.get("name"),
-                    user_id=user_id,
-                    campaign_key=campaign.get("key"),
-                    campaign_type=campaign.get("type"),
-                ),
-            )
 
             decision.update({"from_user_storage_service": False, "is_user_whitelisted": True})
             if campaign.get("type") == constants.CAMPAIGN_TYPES.FEATURE_ROLLOUT:
@@ -435,18 +425,23 @@ def find_targeted_variation(self, user_id, campaign, variation_targeting_variabl
                     constants.MAX_TRAFFIC_VALUE,
                 )
                 targeted_variation = self.bucketer.get_allocated_item(white_listed_variations_list, bucket_value)
-            variation_status = "and variation {variation_name} is assigned"
+            variation_status = (
+                "and variation {variation_name} is assigned"
+                if campaign.get("type") != constants.CAMPAIGN_TYPES.FEATURE_ROLLOUT
+                else ""
+            )
             self.logger.log(
                 LogLevelEnum.INFO,
                 LogMessageEnum.INFO_MESSAGES.SEGMENTATION_STATUS.format(
                     file=FILE,
                     campaign_key=campaign.get("key"),
                     user_id=user_id,
+                    campaign_type=campaign.get("type"),
                     variables=variation_targeting_variables,
                     variation_status=variation_status.format(
                         variation_name=targeted_variation.get("name") if targeted_variation else None
                     ),
-                    segmentation_type="whitelisting",
+                    segmentation_type=constants.SEGMENTATION_TYPES.WHITELISTING,
                     status=ResultStatus.PASSED if targeted_variation is not None else ResultStatus.FAILED,
                 ),
                 disable_logs,
@@ -488,7 +483,7 @@ def evaluate_pre_segmentation(self, user_id, campaign, custom_variables, disable
                         file=FILE,
                         user_id=user_id,
                         campaign_key=campaign.get("key"),
-                        segmentation_type="pre_segmentation",
+                        segmentation_type=constants.SEGMENTATION_TYPES.PRE_SEGMENTATION,
                     ),
                     disable_logs,
                 )
@@ -501,9 +496,10 @@ def evaluate_pre_segmentation(self, user_id, campaign, custom_variables, disable
                         file=FILE,
                         user_id=user_id,
                         campaign_key=campaign.get("key"),
+                        campaign_type=campaign.get("type"),
                         variables=custom_variables,
                         variation_status="",
-                        segmentation_type="pre_segmentation",
+                        segmentation_type=constants.SEGMENTATION_TYPES.PRE_SEGMENTATION,
                         status=ResultStatus.PASSED if result else ResultStatus.FAILED,
                     ),
                     disable_logs,
@@ -571,7 +567,10 @@ def _get_white_listed_variations_list(self, user_id, campaign, variation_targeti
             self.logger.log(
                 LogLevelEnum.DEBUG,
                 LogMessageEnum.DEBUG_MESSAGES.NO_VARIABLES.format(
-                    file=FILE, user_id=user_id, campaign_key=campaign.get("key"), segmentation_type="whitelisting"
+                    file=FILE,
+                    user_id=user_id,
+                    campaign_key=campaign.get("key"),
+                    segmentation_type=constants.SEGMENTATION_TYPES.WHITELISTING,
                 ),
                 disable_logs,
             )
@@ -590,7 +589,9 @@ def _get_white_listed_variations_list(self, user_id, campaign, variation_targeti
                         user_id=user_id,
                         variation_name=variation.get("name"),
                         campaign_key=campaign.get("key"),
-                        variation_status="for variation %s" % variation.get("name"),
+                        variation_status="for variation %s" % variation.get("name")
+                        if campaign.get("type") != constants.CAMPAIGN_TYPES.FEATURE_ROLLOUT
+                        else "",
                     ),
                     disable_logs,
                 )
@@ -604,9 +605,11 @@ def _get_white_listed_variations_list(self, user_id, campaign, variation_targeti
                             user_id=user_id,
                             status="passed" if result else "failed",
                             variables=variation_targeting_variables,
-                            variation_status="for variation %s" % variation.get("name"),
+                            variation_status="for variation %s" % variation.get("name")
+                            if campaign.get("type") != constants.CAMPAIGN_TYPES.FEATURE_ROLLOUT
+                            else "and becomes part of the rollout",
                             campaign_key=campaign.get("key"),
-                            segmentation_type="white_listing",
+                            segmentation_type=constants.SEGMENTATION_TYPES.WHITELISTING,
                         ),
                         disable_logs,
                     )
@@ -740,10 +743,12 @@ def _get_bucketed_variation(self, user_id, campaign, decision, goal_data):
             LogLevelEnum.INFO,
             LogMessageEnum.INFO_MESSAGES.GOT_VARIATION_FOR_USER.format(
                 file=FILE,
-                variation_name=variation.get("name"),
                 user_id=user_id,
                 campaign_key=campaign.get("key"),
                 campaign_type=campaign.get("type"),
+                variation_status="got variation_name:%s" % variation.get("name")
+                if campaign.get("type") != constants.CAMPAIGN_TYPES.FEATURE_ROLLOUT
+                else "becomes part of rollout",
             ),
         )
 
diff --git a/vwo/enums/log_message_enum.py b/vwo/enums/log_message_enum.py
@@ -67,7 +67,7 @@ class INFO_MESSAGES:
         GOT_STORED_VARIATION = "({file}): [API_NAME] Got stored variation:{variation_name} of campaign_key:{campaign_key} for user_id:{user_id} from UserStorage"
         NO_VARIATION_ALLOCATED = "({file}): [API_NAME] user_id:{user_id} of campaign_key:{campaign_key} type: {campaign_type} did not get any variation"
         USER_ELIGIBILITY_FOR_CAMPAIGN = "({file}): [API_NAME] Is user_id:{user_id} part of campaign? {is_user_part}"
-        GOT_VARIATION_FOR_USER = "({file}): [API_NAME] user_id:{user_id} for campaign_key:{campaign_key} type: {campaign_type} got variation_name:{variation_name}"
+        GOT_VARIATION_FOR_USER = "({file}): [API_NAME] user_id:{user_id} for campaign_key:{campaign_key} type: {campaign_type} {variation_status}"
         USER_GOT_NO_VARIATION = "({file}): [API_NAME] user_id:{user_id} for campaign_key:{campaign_key} type: {campaign_type} did not allot any variation"
         IMPRESSION_SUCCESS = "({file}): [API_NAME] Impression event - {end_point} was successfully received by VWO"
         IMPRESSION_SUCCESS_QUEUE = "({file}): [API_NAME] Impression event - {end_point} was successfully pushed in queue, current queue length : {queue_length}, queue summary: {queue_metadata}"
@@ -89,7 +89,7 @@ class INFO_MESSAGES:
 
         VARIABLE_FOUND = "({file}): [API_NAME] Value for variable:{variable_key} of campaign_key:{campaign_key} and campaign type: {campaign_type} is:{variable_value} for user:{user_id}"
 
-        SEGMENTATION_STATUS = "({file}): [API_NAME] user_id:{user_id} of campaign_key:{campaign_key} with variables: {variables} {status} {segmentation_type} {variation_status}"
+        SEGMENTATION_STATUS = "({file}): [API_NAME] user_id:{user_id} of campaign_key:{campaign_key} type: {campaign_type} with variables: {variables} {status} {segmentation_type} {variation_status}"
 
         GOAL_ALREADY_TRACKED = "({file}): [API_NAME] Goal:{goal_identifier} of Campaign:{campaign_key} for User ID:{user_id} has already been tracked earlier. Skipping now."
         USER_ALREADY_TRACKED = "({file}): [API_NAME] User ID:{user_id} for Campaign:{campaign_key} has already been tracked earlier for '{api_method}' API. Skipping now"
