feat: added default polling option

Author: Abhi591

CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.7.0] - 2025-04-11
+
+### Added
+
+- Added support for polling intervals to periodically fetch and update settings:
+  - If `poll_interval` is set in options (must be >= 1000 milliseconds), that interval will be used
+  - If `poll_interval` is configured in VWO application settings, that will be used
+  - If neither is set, defaults to 10 minute polling interval
+
 ## [1.6.0] - 2025-04-04
 
 ### Added

README.md

@@ -154,7 +154,13 @@ vwo_client.set_attribute('attribute_key', 'attribute_value', context)
 
 ### Polling Interval Adjustment
 
-The `poll_interval` is an optional parameter that allows the SDK to automatically fetch and update settings from the VWO server at specified intervals. Setting this parameter ensures your application always uses the latest configuration.
+The `poll_interval` is an optional parameter that allows the SDK to automatically fetch and update settings from the VWO server at specified intervals. The polling interval can be configured in three ways:
+
+1. Set via SDK options: If `poll_interval` is specified in the initialization options (must be >= 1000 milliseconds), that interval will be used
+2. VWO Application Settings: If configured in your VWO application settings, that interval will be used
+3. Default Fallback: If neither of the above is set, a 10 minute (600,000 milliseconds) polling interval is used
+
+Setting this parameter ensures your application always uses the latest configuration by periodically checking for and applying any updates.
 
 ```python
 options = {

setup.py

@@ -121,7 +121,7 @@ def run(self):
 
 setup(
     name="vwo-fme-python-sdk",
-    version="1.6.0",
+    version="1.7.0",
     description="VWO Feature Management and Experimentation SDK for Python",
     long_description=long_description,
     long_description_content_type="text/markdown",

vwo/constants/Constants.py

@@ -17,7 +17,7 @@ class Constants:
     # Mock package_file equivalent
     package_file = {
         "name": "vwo-fme-python-sdk",  # Replace with actual package name
-        "version": "1.6.0",  # Replace with actual package version
+        "version": "1.7.0",  # Replace with actual package version
     }
 
     # Constants
@@ -44,6 +44,7 @@ class Constants:
     SETTINGS = "settings"
     SETTINGS_EXPIRY = 10000000
     SETTINGS_TIMEOUT = 50000
+    POLLING_INTERVAL = 600000
 
     HOST_NAME = "dev.visualwebsiteoptimizer.com"  # TODO: change as needed
     SETTINGS_ENDPOINT = "/server-side/v2-settings"

vwo/models/settings/settings_model.py

@@ -13,25 +13,26 @@
 # limitations under the License.
 
 
-
-
 from typing import List, Dict, Optional
 from ..campaign.campaign_model import CampaignModel
 from ..campaign.feature_model import FeatureModel
 from ...utils.model_utils import _parse_campaign, _parse_feature
 import json
+from ...constants.Constants import Constants
+
 
 class SettingsModel:
     def __init__(self, data: Dict):
         # Parse and set attributes
-        self._features = [_parse_feature(f) for f in data['features']]
-        self._account_id = data['accountId']
-        self._groups = data.get('groups', {})
-        self._campaign_groups = data.get('campaignGroups', {})
-        self._campaigns = [_parse_campaign(c) for c in data['campaigns']]
-        self._sdk_key = data['sdkKey']
-        self._version = data['version']
-        self._collection_prefix = data.get('collectionPrefix', None)
+        self._features = [_parse_feature(f) for f in data["features"]]
+        self._account_id = data["accountId"]
+        self._groups = data.get("groups", {})
+        self._campaign_groups = data.get("campaignGroups", {})
+        self._campaigns = [_parse_campaign(c) for c in data["campaigns"]]
+        self._sdk_key = data["sdkKey"]
+        self._version = data["version"]
+        self._collection_prefix = data.get("collectionPrefix", None)
+        self._poll_interval = data.get("pollInterval", Constants.POLLING_INTERVAL)
 
     # Getter methods for accessing private attributes
     def get_features(self) -> List[FeatureModel]:
@@ -81,4 +82,10 @@ def set_version(self, value: int):
         self._version = value
 
     def set_collection_prefix(self, value: Optional[str]):
-        self._collection_prefix = value
+        self._collection_prefix = value
+
+    def set_poll_interval(self, value: int):
+        self._poll_interval = value
+
+    def get_poll_interval(self) -> int:
+        return self._poll_interval

vwo/resources/debug-messages.json

@@ -1,6 +1,7 @@
 {
     "API_CALLED": "API - {apiName} called",
     "SERVICE_INITIALIZED": "VWO {service} initialized while creating an instance of SDK",
+    "USING_POLL_INTERVAL_FROM_SETTINGS": "key: poll_interval not found or invalid. Using poll_interval from {source} ({pollInterval})",
 
     "EXPERIMENTS_EVALUATION_WHEN_ROLLOUT_PASSED": "Rollout rule got passed for user {userId}. Hence, evaluating experiments",
     "EXPERIMENTS_EVALUATION_WHEN_NO_ROLLOUT_PRESENT": "No Rollout rules present for the feature. Hence, checking experiment rules",

vwo/vwo_builder.py

@@ -27,6 +27,7 @@
 )
 from .utils.settings_util import set_settings_and_add_campaigns_to_rules
 from .packages.storage.storage import Storage
+from .constants.Constants import Constants
 
 
 class VWOBuilder:
@@ -38,6 +39,7 @@ def __init__(self, options):
         self.log_manager = None
         self.original_settings = None
         self.is_settings_fetch_in_progress = False
+        self.is_valid_poll_interval_passed_from_init = False
         self.vwo_instance = None
 
     def set_network_manager(self):
@@ -131,13 +133,13 @@ def get_random_user_id(self):
             )
 
     def init_polling(self):
-        if not self.options.get("poll_interval"):
-            return self
-
         poll_interval = self.options.get("poll_interval")
         if poll_interval and isinstance(poll_interval, int) and poll_interval >= 1000:
-            self.check_and_poll(poll_interval)
-        else:
+            # this is to check if the poll_interval passed in options is valid
+            self.is_valid_poll_interval_passed_from_init = True
+            self.check_and_poll()
+        elif poll_interval:
+            # only log error if poll_interval is present in options
             LogManager.get_instance().error(
                 error_messages.get("INIT_OPTIONS_INVALID").format(
                     key="poll_interval", correctType="int >= 1000"
@@ -147,23 +149,48 @@ def init_polling(self):
 
     def build(self, settings):
         self.vwo_instance = VWOClient(settings, self.options)
+
+        # if poll_interval is not present in options, set it to the pollInterval from settings
+        self.update_poll_interval_and_check_and_poll(settings)
         return self.vwo_instance
 
-    def check_and_poll(self, poll_interval):
+    def update_poll_interval_and_check_and_poll(
+        self, settings, should_check_and_poll=True
+    ):
+        # only update the poll_interval if it poll_interval is not valid or not present in options
+        if not self.is_valid_poll_interval_passed_from_init:
+            poll_interval = settings.get("pollInterval", Constants.POLLING_INTERVAL)
+            LogManager.get_instance().debug(
+                debug_messages.get("USING_POLL_INTERVAL_FROM_SETTINGS").format(
+                    source="settings" if settings.get("pollInterval") else "default",
+                    pollInterval=poll_interval,
+                )
+            )
+            self.options["poll_interval"] = poll_interval
+
+        # should_check_and_poll will be true only when we are updating the poll_interval first time from self.build method
+        # if we are updating the poll_interval already running polling, we don't need to check and poll again
+        if should_check_and_poll and not self.is_valid_poll_interval_passed_from_init:
+            self.check_and_poll()
+
+    def check_and_poll(self):
         def poll():
             try:
                 latest_settings = self.get_settings(True)
-                if json.dumps(latest_settings, sort_keys=True) != json.dumps(
-                    self.original_settings, sort_keys=True
-                ):
+                if latest_settings and json.dumps(
+                    latest_settings, sort_keys=True
+                ) != json.dumps(self.original_settings, sort_keys=True):
                     self.original_settings = latest_settings
                     LogManager.get_instance().info(
                         info_messages.get("POLLING_SET_SETTINGS")
                     )
                     set_settings_and_add_campaigns_to_rules(
                         latest_settings, self.vwo_instance
                     )
-                else:
+                    # reinitialize the poll_interval value if there is a change in settings
+                    # this is to ensure that we use the updated poll_interval value
+                    self.update_poll_interval_and_check_and_poll(latest_settings, False)
+                elif latest_settings:
                     LogManager.get_instance().info(
                         info_messages.get("POLLING_NO_CHANGE_IN_SETTINGS")
                     )
@@ -174,8 +201,8 @@ def poll():
             finally:
                 # Reschedule the poll function to be called again after the interval
                 threading.Timer(
-                    poll_interval / 1000, poll
+                    self.options["poll_interval"] / 1000, poll
                 ).start()  # Timer expects seconds, so convert milliseconds
 
         # start the polling after given interval
-        threading.Timer(poll_interval / 1000, poll).start()
+        threading.Timer(self.options["poll_interval"] / 1000, poll).start()