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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wingify-fme-python-sdk
-Version: 1.50.0
+Version: 1.60.0
 Summary: Wingify Feature Management and Experimentation SDK for Python
 Home-page: https://github.com/wingify/vwo-fme-python-sdk
 Author: Wingify
@@ -168,9 +168,30 @@ context = {
     'user_agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36',
     'ip_address': '1.1.1.1',
     'session_id': 1697123456  # Optional: Custom session ID for web client integration
+    'platformVariables': {
+        # Reference example only:.
+        # In production, fetch campaign assignments using script run in frontend and pass that object to backend as webTestingCampaigns.
+        'webTestingCampaigns': '{"122":"1","130":"2"}'
+    },
+    'session_id': 1697123456  # Optional: Custom session ID for web client integration
 }
 ```
 
+## Web testing pre-segmentation
+
+Server-side flag decisions can align with **Web Testing** (browser) experiments. **Campaign assignments are typically read on the frontend** (for example, VWO cookies) and sent to your server; pass them in `platformVariables.webTestingCampaigns` as a map of **campaign ID -> variation ID** (strings), or as a **JSON string** of that object.
+
+Pre-segment rules in the VWO dashboard can use the **`campaignVariation`** operator:
+
+| Operand pattern | Meaning |
+| --------------- | ------- |
+| `C` | User is in campaign `C` (any variation). |
+| `!C` | User is **not** in campaign `C`. |
+| `C_V` | User is in campaign `C` with variation `V`. |
+| `C_!V` | User is in campaign `C` and assigned variation is **not** `V`. |
+
+Rollout rules evaluate pre-segments from the **first variation** only; AB/testing rules use **campaign-level** segments.
+
 ## Session Management
 
 The SDK provides automatic session management capabilities to enable seamless integration with VWO's web client testing campaigns. Session IDs are automatically generated and managed to connect server-side feature flag decisions with client-side user sessions.

{wingify_fme_python_sdk-1.50.0 → wingify_fme_python_sdk-1.60.0}/README.md

@@ -141,9 +141,30 @@ context = {
     'user_agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36',
     'ip_address': '1.1.1.1',
     'session_id': 1697123456  # Optional: Custom session ID for web client integration
+    'platformVariables': {
+        # Reference example only:.
+        # In production, fetch campaign assignments using script run in frontend and pass that object to backend as webTestingCampaigns.
+        'webTestingCampaigns': '{"122":"1","130":"2"}'
+    },
+    'session_id': 1697123456  # Optional: Custom session ID for web client integration
 }
 ```
 
+## Web testing pre-segmentation
+
+Server-side flag decisions can align with **Web Testing** (browser) experiments. **Campaign assignments are typically read on the frontend** (for example, VWO cookies) and sent to your server; pass them in `platformVariables.webTestingCampaigns` as a map of **campaign ID -> variation ID** (strings), or as a **JSON string** of that object.
+
+Pre-segment rules in the VWO dashboard can use the **`campaignVariation`** operator:
+
+| Operand pattern | Meaning |
+| --------------- | ------- |
+| `C` | User is in campaign `C` (any variation). |
+| `!C` | User is **not** in campaign `C`. |
+| `C_V` | User is in campaign `C` with variation `V`. |
+| `C_!V` | User is in campaign `C` and assigned variation is **not** `V`. |
+
+Rollout rules evaluate pre-segments from the **first variation** only; AB/testing rules use **campaign-level** segments.
+
 ## Session Management
 
 The SDK provides automatic session management capabilities to enable seamless integration with VWO's web client testing campaigns. Session IDs are automatically generated and managed to connect server-side feature flag decisions with client-side user sessions.

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

@@ -46,7 +46,7 @@ _BRAND_METADATA = {
     },
 }
 
-_brand = _BRAND_METADATA.get(SDK_BRAND, _BRAND_METADATA["vwo"])
+_brand = _BRAND_METADATA.get(SDK_BRAND, _BRAND_METADATA["wingify"])
 
 _all_packages = find_packages(exclude=["tests"])
 # Both wheels ship wingify (core) + vwo (legacy facade). Customers import one or the other.
@@ -143,7 +143,7 @@ class PostDevelopCommand(develop):
 
 setup(
     name=_brand["name"],
-    version="1.50.0",
+    version="1.60.0",
     description=_brand["description"],
     long_description=long_description,
     long_description_content_type="text/markdown",

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

@@ -36,6 +36,7 @@ from ..utils.decision_util import evaluate_traffic_and_get_variation
 from ..utils.impression_util import (
     send_impression_for_variation_shown_batch,
     send_impression_for_variation_shown,
+    create_and_send_impression_for_usage_tracking,
 )
 from ..models.user.get_flag import GetFlag
 from ..services.storage_service import StorageService
@@ -76,6 +77,9 @@ class GetFlagApi:
         :param hook_manager: The hook manager to execute hooks.
         """
 
+        # Flag for usage tracking - false if no variation shown call is sent
+        is_variation_shown_fired = False
+
         feature = get_feature_from_key(settings, feature_key)
         is_enabled = False
         variables = []
@@ -173,6 +177,15 @@ class GetFlagApi:
                                 )
                         else:
                             send_impression_for_variation_shown_batch(holdout_payloads, account_id=settings.get_account_id(), sdk_key=settings.get_sdk_key())
+                        
+                        # if impression is fired for any of the holdouts, set is_variation_shown_fired to True
+                        if holdout_payloads and len(holdout_payloads) > 0:
+                            is_variation_shown_fired = True
+
+                        # Case: User is already part of a holdout (stored decision).
+                        if settings.get_is_tracking_usage_enabled() and not is_variation_shown_fired:
+                            create_and_send_impression_for_usage_tracking(settings, feature_key, context)
+
                         # Return a disabled flag as user is in persistent holdout
                         return GetFlag(is_enabled=False, variables=[], session_id=context.get_session_id(), uuid=context.get_vwo_uuid())
         if stored_data and stored_data.get("experimentVariationId"):
@@ -194,7 +207,19 @@ class GetFlagApi:
                     )
                     decision["isUserPartOfCampaign"] = True
                     # send network calls for holdouts that are newly added in settings and are not present in storage
-                    send_network_calls_for_not_in_holdouts(settings, feature, context, decision, stored_data, storage_service)
+                    # Calculate the initial size of not_in_holdout_id
+                    initial_size = len(stored_data.get("notInHoldoutId") or []) if stored_data else 0
+                    # send network calls for not_in_holdout_id
+                    updated_not_in_holdouts = send_network_calls_for_not_in_holdouts(settings, feature, context, decision, stored_data, storage_service)
+                    # if variationShown event is fired, set is_variation_shown_fired to True - Optimization for newly added holdouts
+                    if updated_not_in_holdouts and len(updated_not_in_holdouts) > initial_size:
+                        is_variation_shown_fired = True
+
+                    # Case: Feature found in storage
+                    # Send usage tracking for cached experiment decision if usage tracking is enabled
+                    if settings.get_is_tracking_usage_enabled() and not is_variation_shown_fired:
+                        create_and_send_impression_for_usage_tracking(settings, feature_key, context)
+
                     return GetFlag(is_enabled=True, variables=variation.get_variables(), session_id=context.get_session_id(), uuid=context.get_vwo_uuid())
         elif (
             stored_data
@@ -217,7 +242,10 @@ class GetFlagApi:
                 decision["isUserPartOfCampaign"] = True
                 # network calls for holdouts that are newly added in settings and are not present in storage
                 # and return the updated not in holdout ids
+                initial_size = len(stored_data.get("notInHoldoutId") or []) if stored_data else 0
                 updated_not_in_holdout_ids = send_network_calls_for_not_in_holdouts(settings, feature, context, decision, stored_data, storage_service)
+                if updated_not_in_holdout_ids and len(updated_not_in_holdout_ids) > initial_size:
+                    is_variation_shown_fired = True
                 # push the updated not in holdout ids to the notInHoldoutIds array
                 notInHoldoutIds.extend(updated_not_in_holdout_ids)
 
@@ -236,6 +264,12 @@ class GetFlagApi:
         if feature is None:
             LogManager.get_instance().error_log("FEATURE_NOT_FOUND", data={"featureKey": feature_key}, debug_data = debug_event_props)
             is_enabled = False
+
+            # Case: Feature not found
+            # If usage tracking is enabled, send usage tracking impression
+            if settings.get_is_tracking_usage_enabled() and not is_variation_shown_fired:
+                create_and_send_impression_for_usage_tracking(settings, feature_key, context)
+
             return GetFlag(is_enabled=is_enabled, variables=variables, session_id=context.get_session_id(), uuid=context.get_vwo_uuid())
         
         if context.get_session_id() is None:
@@ -315,6 +349,9 @@ class GetFlagApi:
                 else:
                     batchPayload.extend(holdout_payloads)
 
+                if holdout_payloads and len(holdout_payloads) > 0:
+                    is_variation_shown_fired = True
+
         roll_out_rules = get_specific_rules_based_on_type(
             feature, CampaignTypeEnum.ROLLOUT.value
         )
@@ -390,9 +427,13 @@ class GetFlagApi:
                         and payload is not None
                         and len(payload) > 0
                     ):
+                        # set is_variation_shown_fired to true as the rollout impression is sent
+                        is_variation_shown_fired = True
                         send_impression_for_variation_shown(payload, context)
                     else:
                         if payload is not None and len(payload) > 0:
+                            # set is_variation_shown_fired to true as the rollout impression is sent
+                            is_variation_shown_fired = True
                             batchPayload.append(payload)
 
         if not roll_out_rules:
@@ -435,9 +476,15 @@ class GetFlagApi:
                             and payload is not None
                             and len(payload) > 0
                         ):
+                            # set is_variation_shown_fired to true as the experiment impression is sent (for whitelisted user)
+                            # this prevents sending usage tracking impression for the experiment campaign when checked at the bottom
+                            is_variation_shown_fired = True
                             send_impression_for_variation_shown(payload, context)
                         else:
                             if payload is not None and len(payload) > 0:
+                                # set is_variation_shown_fired to true as the experiment impression is sent (for whitelisted user)
+                                # this prevents sending usage tracking impression for the experiment campaign when checked at the bottom
+                                is_variation_shown_fired = True
                                 batchPayload.append(payload)
                         
                         is_enabled = True
@@ -481,9 +528,13 @@ class GetFlagApi:
                         and payload is not None
                         and len(payload) > 0
                     ):
+                        # set is_variation_shown_fired to true as the experiment impression is sent.
+                        is_variation_shown_fired = True
                         send_impression_for_variation_shown(payload, context)
                     else:
                         if payload is not None and len(payload) > 0:
+                            # set is_variation_shown_fired to true as the experiment impression is sent.
+                            is_variation_shown_fired = True
                             batchPayload.append(payload)
 
         if is_enabled:
@@ -545,9 +596,13 @@ class GetFlagApi:
                 and payload is not None
                 and len(payload) > 0
             ):
+                # set is_variation_shown_fired to true as the impact analysis impression is sent.
+                is_variation_shown_fired = True
                 send_impression_for_variation_shown(payload, context)
             else:
                 if payload is not None and len(payload) > 0:
+                    # set is_variation_shown_fired to true as the impact analysis impression is sent.
+                    is_variation_shown_fired = True
                     batchPayload.append(payload)
 
         if not SettingsManager.get_instance().is_gateway_service_provided:
@@ -555,6 +610,11 @@ class GetFlagApi:
                 batchPayload, settings.get_account_id(), settings.get_sdk_key()
             )
 
+        # Send usage tracking call when no primary variationShown event was dispatched.
+        # If a primary event was fired, the server already has the usage tracking signal.
+        if settings.get_is_tracking_usage_enabled() and not is_variation_shown_fired:
+            create_and_send_impression_for_usage_tracking(settings, feature_key, context)
+
         return GetFlag(is_enabled=is_enabled, variables=variables, session_id=context.get_session_id(), uuid=context.get_vwo_uuid())
 
     def _update_integrations_decision_object(

{wingify_fme_python_sdk-1.50.0 → wingify_fme_python_sdk-1.60.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.50.0",
+        "version": "1.60.0",
     }
 
     SDK_VERSION = sdk_meta["version"]

{wingify_fme_python_sdk-1.50.0 → wingify_fme_python_sdk-1.60.0}/wingify/enums/event_enum.py

@@ -23,3 +23,4 @@ class EventEnum(Enum):
     SDK_INIT_EVENT = "vwo_fmeSdkInit"
     USAGE_STATS = "vwo_sdkUsageStats"
     DEBUGGER_EVENT = "vwo_sdkDebug"
+    TRACK_USAGE = "vwo_feTrackUsage"

{wingify_fme_python_sdk-1.50.0 → wingify_fme_python_sdk-1.60.0}/wingify/models/settings/settings_model.py

@@ -36,6 +36,7 @@ class SettingsModel:
         self._poll_interval = data.get("pollInterval", Constants.POLLING_INTERVAL)
         self._is_web_connectivity_enabled = data.get("isWebConnectivityEnabled", True)
         self._holdouts = [HoldoutModel(h) for h in data.get("holdouts", [])]
+        self._is_tracking_usage_enabled = data.get("isMAU", False)
 
     # Getter methods for accessing private attributes
     def get_features(self) -> List[FeatureModel]:
@@ -100,4 +101,10 @@ class SettingsModel:
         self._holdouts = value
 
     def get_holdouts(self) -> List[HoldoutModel]:
-        return self._holdouts if isinstance(self._holdouts, list) else []
+        return self._holdouts if isinstance(self._holdouts, list) else []
+
+    def get_is_tracking_usage_enabled(self) -> bool:
+        return self._is_tracking_usage_enabled
+
+    def set_is_tracking_usage_enabled(self, value: bool):
+        self._is_tracking_usage_enabled = value

{wingify_fme_python_sdk-1.50.0 → wingify_fme_python_sdk-1.60.0}/wingify/models/user/context_model.py

@@ -14,7 +14,8 @@
 
 
 from .context_vwo_model import ContextVWOModel
-from typing import Dict, List
+from typing import Any, Dict, List, Optional
+from ...utils.data_type_util import is_object
 from ...utils.uuid_util import get_uuid
 from ...services.settings_manager import SettingsManager
 from ...utils.function_util import get_current_unix_timestamp
@@ -33,6 +34,11 @@ class ContextModel:
         self._vwo = ContextVWOModel(vwo_context_data) if vwo_context_data else None
         self.post_segmentation_variables = context.get("post_segmentation_variables", [])
         self.bucketingSeed = context.get("bucketingSeed")
+        self.platform_variables: Optional[Dict[str, Any]] = (
+            dict(context.get("platform_variables"))
+            if is_object(context.get("platform_variables"))
+            else None
+        )
         self.session_id = context.get("session_id", None)
         if self.session_id is None:
             self.session_id = get_current_unix_timestamp()
@@ -96,4 +102,12 @@ class ContextModel:
         self.session_id = session_id
     
     def get_bucketing_seed(self) -> str:
-        return self.bucketingSeed
+        return self.bucketingSeed
+    
+    def get_platform_variables(self) -> Optional[Dict[str, Any]]:
+        return self.platform_variables
+
+    def set_platform_variables(self, platform_variables: Optional[Dict[str, Any]]) -> None:
+        self.platform_variables = (
+            dict(platform_variables) if is_object(platform_variables) else None
+        )

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

@@ -24,6 +24,10 @@ from ....models.user.context_model import ContextModel
 from ....utils.gateway_service_util import get_query_params, get_from_gateway_service
 from ....constants.Constants import Constants
 from ....enums.api_enum import ApiEnum
+from ..utils.web_testing_segment_util import (
+    dsl_contains_campaign_variation_node,
+    is_web_testing_campaigns_absent_or_null,
+)
 
 
 class SegmentationManager:
@@ -115,4 +119,11 @@ class SegmentationManager:
         :param properties: The properties to validate against.
         :return: True if segmentation is valid, otherwise False.
         """
+        # if the dsl contains a campaign variation node, then we need to check if the campaign variation is valid
+        if dsl_contains_campaign_variation_node(dsl):
+            evaluation_context = getattr(self.evaluator, "context", None)
+            if evaluation_context is None or is_web_testing_campaigns_absent_or_null(
+                evaluation_context
+            ):
+                return False
         return self.evaluator.is_segmentation_valid(dsl, properties)

{wingify_fme_python_sdk-1.50.0 → wingify_fme_python_sdk-1.60.0}/wingify/packages/segmentation_evaluator/enums/segment_operator_value_enum.py

@@ -34,3 +34,4 @@ class SegmentOperatorValueEnum(Enum):
     IP = "ip_address"
     BROWSER_VERSION = "browser_version"
     OS_VERSION = "os_version"
+    WEB_CAMPAIGN_VARIATION = "campaignVariation"

{wingify_fme_python_sdk-1.50.0 → wingify_fme_python_sdk-1.60.0}/wingify/packages/segmentation_evaluator/evaluators/segment_evaluator.py

@@ -68,6 +68,10 @@ class SegmentEvaluator:
             return SegmentOperandEvaluator().evaluate_string_operand_dsl(
                 sub_dsl, self.context, SegmentOperatorValueEnum.OS_VERSION.value
             )
+        elif operator == SegmentOperatorValueEnum.WEB_CAMPAIGN_VARIATION.value:
+            return SegmentOperandEvaluator().evaluate_campaign_variation_dsl(
+                sub_dsl, self.context
+            )
         else:
             return False
 

{wingify_fme_python_sdk-1.50.0 → wingify_fme_python_sdk-1.60.0}/wingify/packages/segmentation_evaluator/evaluators/segment_operand_evaluator.py

@@ -16,6 +16,11 @@
 import re
 from typing import Dict, Any
 from ..utils.segment_util import get_key_value, match_with_regex
+from ..utils.web_testing_segment_util import (
+    coerce_campaign_variation_operand_to_str,
+    parse_web_testing_campaigns_from_context,
+    evaluate_web_testing_campaign_variation,
+)
 from ..enums.segment_operand_regex_enum import SegmentOperandRegexEnum
 from ..enums.segment_operand_value_enum import SegmentOperandValueEnum
 from ..enums.segment_operator_value_enum import SegmentOperatorValueEnum
@@ -84,6 +89,25 @@ class SegmentOperandEvaluator:
                 operand_type, processed_values["operand_value"], tag_value
             )
 
+    def evaluate_campaign_variation_dsl(
+        self, dsl_operand_value: Any, context: ContextModel
+    ) -> bool:
+        """
+        Evaluates a campaignVariation DSL operand against the user's web testing campaign assignments.
+
+        :param dsl_operand_value: The raw operand value from the DSL (e.g. "123_1", "!123", 100).
+        :param context: The context object containing platform_variables.web_testing_campaigns.
+        :return: True if the segment condition is satisfied, otherwise False.
+        """
+        operand_str = coerce_campaign_variation_operand_to_str(dsl_operand_value)
+        if operand_str is None:
+            return False
+
+        operand_str = operand_str.strip()
+        campaigns_map = parse_web_testing_campaigns_from_context(context)
+        result, _invalid = evaluate_web_testing_campaign_variation(operand_str, campaigns_map)
+        return result
+
     def evaluate_user_dsl(self, dsl_operand_value, properties):
         """
         Evaluates a user DSL expression to check if a user ID is in a specified List.