wingify-fme-python-sdk 1.60.0__tar.gz → 1.61.0__tar.gz

{wingify_fme_python_sdk-1.60.0/wingify_fme_python_sdk.egg-info → wingify_fme_python_sdk-1.61.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wingify-fme-python-sdk
-Version: 1.60.0
+Version: 1.61.0
 Summary: Wingify Feature Management and Experimentation SDK for Python
 Home-page: https://github.com/wingify/vwo-fme-python-sdk
 Author: Wingify

{wingify_fme_python_sdk-1.60.0 → wingify_fme_python_sdk-1.61.0}/setup.py

@@ -143,7 +143,7 @@ class PostDevelopCommand(develop):
 
 setup(
     name=_brand["name"],
-    version="1.60.0",
+    version="1.61.0",
     description=_brand["description"],
     long_description=long_description,
     long_description_content_type="text/markdown",

{wingify_fme_python_sdk-1.60.0 → wingify_fme_python_sdk-1.61.0}/wingify/api/get_flag_api.py

@@ -41,7 +41,11 @@ from ..utils.impression_util import (
 from ..models.user.get_flag import GetFlag
 from ..services.storage_service import StorageService
 from ..decorators.storage_decorator import StorageDecorator
-from ..utils.campaign_util import get_variation_from_campaign_key
+from ..utils.campaign_util import (
+    get_experiment_key,
+    get_rollout_key,
+    get_variation_from_campaign_key,
+)
 from ..enums.debug_category_enum import DebugCategoryEnum
 from ..packages.logger.enums.log_level_enum import LogLevelEnum
 from ..constants.Constants import Constants
@@ -392,7 +396,7 @@ class GetFlagApi:
 
                     self._evaluated_feature_map[feature_key] = {
                         "rolloutId": rule.get_id(),
-                        "rolloutKey": rule.get_key(),
+                        "rolloutKey": get_rollout_key(rule, feature_key),
                         "rolloutVariationId": (
                             rule.get_variations()[0].get_id()
                             if rule.get_variations()
@@ -493,7 +497,9 @@ class GetFlagApi:
                         self._passed_rules_information.update(
                             {
                                 "experimentId": rule.get_id(),
-                                "experimentKey": rule.get_key(),
+                                "experimentKey": get_experiment_key(
+                                    rule, feature.get_key()
+                                ),
                                 "experimentVariationId": whitelisted_object[
                                     "variationId"
                                 ],
@@ -627,7 +633,9 @@ class GetFlagApi:
             self._passed_rules_information.update(
                 {
                     "rolloutId": campaign.get_id(),
-                    "rolloutKey": campaign.get_key(),
+                    "rolloutKey": get_rollout_key(
+                        campaign, decision.get("featureKey")
+                    ),
                     "rolloutVariationId": variation.get_id(),
                 }
             )
@@ -635,7 +643,9 @@ class GetFlagApi:
             self._passed_rules_information.update(
                 {
                     "experimentId": campaign.get_id(),
-                    "experimentKey": campaign.get_key(),
+                    "experimentKey": get_experiment_key(
+                        campaign, decision.get("featureKey")
+                    ),
                     "experimentVariationId": variation.get_id(),
                 }
             )

{wingify_fme_python_sdk-1.60.0 → wingify_fme_python_sdk-1.61.0}/wingify/constants/Constants.py

@@ -17,7 +17,7 @@ class Constants:
     # TODO: read from setup.py
     sdk_meta = {
         "name": "vwo-fme-python-sdk",
-        "version": "1.60.0",
+        "version": "1.61.0",
     }
 
     SDK_VERSION = sdk_meta["version"]

{wingify_fme_python_sdk-1.60.0 → wingify_fme_python_sdk-1.61.0}/wingify/packages/segmentation_evaluator/core/segmentation_manager.py

@@ -85,14 +85,25 @@ class SegmentationManager:
 
         # Check if any holdout requires gateway service
         holdouts = settings.get_holdouts() or []
-        is_gateway_service_required_for_holdouts = len(list(filter(lambda holdout: holdout.get_is_gateway_service_required(), holdouts))) > 0
-        # Call gateway service if required for segmentation OR if gateway service is provided and user agent is available
+        is_gateway_service_required_for_holdouts = len(
+            list(
+                filter(
+                    lambda holdout: holdout.get_is_gateway_service_required(), holdouts
+                )
+            )
+        ) > 0
+        is_segmentation_gateway_required = (
+            feature.get_is_gateway_service_required()
+            or is_gateway_service_required_for_holdouts
+        )
+        # Call get-user-details only when gateway_service is configured and
+        # segmentation (feature or holdout) requires gateway data.
+        # proxy_url alone must never trigger a gateway call.
         should_call_gateway_service = (
-            (feature.get_is_gateway_service_required() and not SettingsManager.get_instance().is_on_platform_host()) or
-            (not SettingsManager.get_instance().is_on_platform_host() and
-             (context.get_user_agent() or context.get_ip_address()))
-        ) or is_gateway_service_required_for_holdouts
-        
+            SettingsManager.get_instance().is_gateway_service_provided
+            and is_segmentation_gateway_required
+        )
+
         if should_call_gateway_service and context.get_vwo() is None:
             query_params = {}
             if not context.get_user_agent() and not context.get_ip_address():

{wingify_fme_python_sdk-1.60.0 → wingify_fme_python_sdk-1.61.0}/wingify/resources/error-messages.json

@@ -12,13 +12,15 @@
     "UPDATING_CLIENT_INSTANCE_FAILED_WHEN_WEBHOOK_TRIGGERED": "Failed to fetch settings. {brand} client instance couldn't be updated. API:{apiName} called having isViaWebhook:{isViaWebhook}. Error: {err}",
   
     "EXECUTION_FAILED": "API - {apiName} failed to execute. Error:{err}",
+    "INTEGRATIONS_CALLBACK_FAILED": "Error while executing integrations_callback: Error: {err}",
     "INVALID_PARAM": "Key:{key} passed to API:{apiName} is not of valid type. Got type:{type}, should be:{correctType}",
     "INVALID_CONTEXT_PASSED": "Context should be of type:object and must contain a mandatory key: id, which is User ID",
+    "INVALID_CONTEXT_USER_ID": "user_id under context must be a string value",
     "INVALID_BUCKETING_SEED": "Invalid bucketingSeed passed, since it can only be a valid string. Removing it from context so that userId is used for decisioning.",
   
     "FEATURE_NOT_FOUND": "Feature not found for the key:{featureKey}",
     "FEATURE_NOT_FOUND_WITH_ID": "Feature not found for the id:{featureId}",
-    "EVENT_NOT_FOUND": "Event:{eventName} not found in any of the features' metrics",
+    "EVENT_NOT_FOUND": "Event:{eventName} not found in any of the features' metrics, please ensure event API name is being used correctly",
   
     "ERROR_READING_STORED_DATA_IN_STORAGE": "Error reading data from storage. Error:{err}",
     "ERROR_STORING_DATA_IN_STORAGE": "Key:{featureKey} is not valid. Unable to store data into storage",

{wingify_fme_python_sdk-1.60.0 → wingify_fme_python_sdk-1.61.0}/wingify/services/hooks_manager.py

@@ -14,6 +14,7 @@
 
 
 from typing import Callable, Dict, Any, Optional
+from ..packages.logger.core.log_manager import LogManager
 
 
 class HooksManager:
@@ -36,7 +37,15 @@ class HooksManager:
         :param properties: A dictionary of properties to pass to the callback.
         """
         if self.is_callback_function and self.callback:
-            self.callback(properties)
+            try:
+                self.callback(properties)
+            except Exception as err:
+                LogManager.get_instance().error_log(
+                    "INTEGRATIONS_CALLBACK_FAILED",
+                    data={"err": str(err)},
+                    debug_data={"an": properties.get("api")},
+                    should_send_log_to_vwo=False,
+                )
 
     def set(self, properties: Dict[str, Any]) -> None:
         """

{wingify_fme_python_sdk-1.60.0 → wingify_fme_python_sdk-1.61.0}/wingify/utils/campaign_util.py

@@ -27,6 +27,69 @@ import math
 from ..models.user.context_model import ContextModel
 
 
+def _resolve_feature_rule_key(
+    campaign: CampaignModel, feature_key: Optional[str] = None
+) -> Optional[str]:
+    """
+    Resolves ``{featureKey}_{ruleKey}`` when rules share a parent campaign key.
+
+    Args:
+        campaign (CampaignModel): The campaign containing the rule key.
+        feature_key (Optional[str]): Feature key; inferred from campaign key if omitted.
+
+    Returns:
+        Optional[str]: Resolved rule key, or ``None`` if rule key is missing.
+    """
+    if not campaign.get_rule_key():
+        return None
+    resolved_feature_key = feature_key
+    if not resolved_feature_key and campaign.get_key():
+        resolved_feature_key = campaign.get_key().rsplit("_", 1)[0]
+    if resolved_feature_key:
+        return f"{resolved_feature_key}_{campaign.get_rule_key()}"
+    return None
+
+
+def get_experiment_key(
+    campaign: CampaignModel, feature_key: Optional[str] = None
+) -> str:
+    """
+    Returns the experiment key for integrations callbacks and storage.
+
+    Args:
+        campaign (CampaignModel): The campaign to resolve the key for.
+        feature_key (Optional[str]): Feature key for personalize rules.
+
+    Returns:
+        str: ``{featureKey}_{ruleKey}`` for personalize rules; otherwise campaign key.
+    """
+    if campaign.get_type() == CampaignTypeEnum.PERSONALIZE.value:
+        rule_key = _resolve_feature_rule_key(campaign, feature_key)
+        if rule_key:
+            return rule_key
+    return campaign.get_key()
+
+
+def get_rollout_key(
+    campaign: CampaignModel, feature_key: Optional[str] = None
+) -> str:
+    """
+    Returns the rollout key for integrations callbacks and storage.
+
+    Args:
+        campaign (CampaignModel): The campaign to resolve the key for.
+        feature_key (Optional[str]): Feature key for rollout rules.
+
+    Returns:
+        str: ``{featureKey}_{ruleKey}`` for rollout rules; otherwise campaign key.
+    """
+    if campaign.get_type() == CampaignTypeEnum.ROLLOUT.value:
+        rule_key = _resolve_feature_rule_key(campaign, feature_key)
+        if rule_key:
+            return rule_key
+    return campaign.get_key()
+
+
 def set_variation_allocation(campaign: CampaignModel) -> None:
     """
     Allocates traffic ranges to variations within a campaign.
@@ -176,6 +239,24 @@ def get_variation_from_campaign_key(
         if variation:
             return variation
 
+    for feature in settings.get_features() or []:
+        feature_key = feature.get_key()
+        for linked_campaign in feature.get_rules_linked_campaign() or []:
+            if (
+                get_experiment_key(linked_campaign, feature_key) == campaign_key
+                or get_rollout_key(linked_campaign, feature_key) == campaign_key
+            ):
+                variation = next(
+                    (
+                        v
+                        for v in linked_campaign.get_variations()
+                        if v.get_id() == variation_id
+                    ),
+                    None,
+                )
+                if variation:
+                    return variation
+
     return None
 
 

{wingify_fme_python_sdk-1.60.0 → wingify_fme_python_sdk-1.61.0}/wingify/utils/meg_util.py

@@ -29,6 +29,8 @@ from ..utils.campaign_util import (
     get_bucketing_seed,
     get_campaign_ids_from_feature_key,
     get_campaigns_by_group_id,
+    get_experiment_key,
+    get_rollout_key,
     get_feature_keys_from_campaign_ids,
     set_campaign_allocation,
     get_variation_from_campaign_key,
@@ -207,7 +209,7 @@ def _is_rollout_rule_for_feature_passed(
                 if isinstance(variation, VariationModel) and not None:
                     evaluated_feature_map[feature.get_key()] = {
                         "rolloutId": rule.get_id(),
-                        "rolloutKey": rule.get_key(),
+                        "rolloutKey": get_rollout_key(rule, feature.get_key()),
                         "rolloutVariationId": rule.get_variations()[0].get_id(),
                     }
                     return True
@@ -241,7 +243,8 @@ def _get_eligible_campaigns(
             )
 
             if stored_data and stored_data.get("experimentVariationId"):
-                if stored_data.get("experimentKey") == campaign.get_key():
+                campaign_experiment_key = get_experiment_key(campaign, feature_key)
+                if stored_data.get("experimentKey") == campaign_experiment_key:
                     variation = get_variation_from_campaign_key(
                         settings,
                         stored_data["experimentKey"],
@@ -261,7 +264,8 @@ def _get_eligible_campaigns(
                             )
                         )
                         if not any(
-                            item.get_key() == campaign.get_key()
+                            get_experiment_key(item, feature_key)
+                            == campaign_experiment_key
                             for item in eligible_campaigns_with_storage
                         ):
                             eligible_campaigns_with_storage.append(
@@ -428,7 +432,7 @@ def _normalize_weights_and_find_winning_campaign(
                 "featureKey": Constants.VWO_META_MEG_KEY + str(group_id),
                 "context": context,
                 "experimentId": winner_campaign.get_id(),
-                "experimentKey": winner_campaign.get_key(),
+                "experimentKey": get_experiment_key(winner_campaign),
                 "experimentVariationId": (
                     winner_campaign.get_variations()[0].get_id()
                     if winner_campaign.get_type() == CampaignTypeEnum.PERSONALIZE.value
@@ -538,7 +542,7 @@ def _get_campaign_using_advanced_algo(
                 "featureKey": Constants.VWO_META_MEG_KEY + str(group_id),
                 "context": context,
                 "experimentId": winner_campaign.get_id(),
-                "experimentKey": winner_campaign.get_key(),
+                "experimentKey": get_experiment_key(winner_campaign),
                 "experimentVariationId": (
                     winner_campaign.get_variations()[0].get_id()
                     if winner_campaign.get_type() == CampaignTypeEnum.PERSONALIZE.value

{wingify_fme_python_sdk-1.60.0 → wingify_fme_python_sdk-1.61.0}/wingify/utils/rule_evaluation_util.py

@@ -19,6 +19,7 @@ from ..models.campaign.feature_model import FeatureModel
 from ..models.user.context_model import ContextModel
 from ..utils.data_type_util import is_object
 from ..utils.decision_util import check_whitelisting_and_pre_seg
+from ..utils.campaign_util import get_experiment_key
 from ..services.storage_service import StorageService
 from ..utils.network_util import get_track_user_payload_data
 from typing import Dict
@@ -74,7 +75,7 @@ def evaluate_rule(
         decision.update(
             {
                 "experimentId": campaign.get_id(),
-                "experimentKey": campaign.get_key(),
+                "experimentKey": get_experiment_key(campaign, feature.get_key()),
                 "experimentVariationId": whitelisted_object["variationId"],
             }
         )

{wingify_fme_python_sdk-1.60.0 → wingify_fme_python_sdk-1.61.0}/wingify/wingify_client.py

@@ -87,6 +87,7 @@ class WingifyClient:
             LogManager.get_instance().debug(
                 debug_messages.get("API_CALLED").format(apiName=api_name)
             )
+            self._validate_context(context, api_name)
             # get uuid from context
             uuid = self._get_uuid_from_context(context, api_name)
         except Exception as err:
@@ -118,13 +119,6 @@ class WingifyClient:
                 )
                 raise ValueError("Invalid Settings")
 
-            # Validate user ID is present in context
-            if not context or "id" not in context:
-                LogManager.get_instance().error(
-                    error_messages.get("INVALID_CONTEXT_PASSED")
-                )
-                raise ValueError("Invalid context")
-
             context_copy = context.copy()
             context_copy["uuid"] = uuid
             if "bucketingSeed" in context:
@@ -207,13 +201,8 @@ class WingifyClient:
                 )
                 raise ValueError("Invalid Settings")
 
-            # Validate user ID is present in context
-            if not context or "id" not in context:
-                LogManager.get_instance().error(
-                    error_messages.get("INVALID_CONTEXT_PASSED")
-                )
-                raise ValueError("Invalid context")
-            
+            self._validate_context(context, api_name)
+
             context_copy = context.copy()
             context_copy["uuid"] = self._get_uuid_from_context(context, api_name)
             context_model = ContextModel(context_copy)
@@ -343,12 +332,8 @@ class WingifyClient:
                 )
                 raise ValueError("Invalid Settings")
 
-            if not user_context or "id" not in user_context:
-                LogManager.get_instance().error(
-                    error_messages.get("INVALID_CONTEXT_PASSED")
-                )
-                raise ValueError("Invalid context")
-            
+            self._validate_context(user_context, api_name)
+
             context_copy = user_context.copy()
             context_copy["uuid"] = self._get_uuid_from_context(user_context, api_name)
             context_model = ContextModel(context_copy)
@@ -491,6 +476,25 @@ class WingifyClient:
             LogManager.get_instance().error_log("EXECUTION_FAILED", data={"apiName": api_name, "err": str(err)}, debug_data={"an": ApiEnum.SET_ALIAS.value})
             return False
     
+    def _validate_context(self, context: Dict, api_name: str) -> None:
+        """
+        Validates that context contains a string user ID.
+
+        :param context: The context object passed to an API.
+        :param api_name: The name of the API calling this method.
+        """
+        if not context or not is_object(context) or "id" not in context:
+            LogManager.get_instance().error(
+                error_messages.get("INVALID_CONTEXT_PASSED")
+            )
+            raise ValueError("Invalid context")
+
+        if not isinstance(context.get("id"), str):
+            LogManager.get_instance().error(
+                error_messages.get("INVALID_CONTEXT_USER_ID")
+            )
+            raise ValueError("user_id under context must be a string value")
+
     def _get_uuid_from_context(self, context: Dict, api_name: str) -> str:
         """
         Gets the UUID from the context.

{wingify_fme_python_sdk-1.60.0 → wingify_fme_python_sdk-1.61.0/wingify_fme_python_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wingify-fme-python-sdk
-Version: 1.60.0
+Version: 1.61.0
 Summary: Wingify Feature Management and Experimentation SDK for Python
 Home-page: https://github.com/wingify/vwo-fme-python-sdk
 Author: Wingify