Skip to content

CHANGELOG.md

Latest commit

 

History

History
519 lines (336 loc) · 18.1 KB

CHANGELOG.md

File metadata and controls

519 lines (336 loc) · 18.1 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.68.2] - 2025-11-06

Fixed

  • The backoff factor used for all retry attempts has been increased from 1 to 3. This means that the wait time between consecutive retry attempts will now increase more rapidly, allowing for more time between each retry. This helps to reduce repeated rapid requests to the server in case of failures and improves overall stability when transient errors occur.

[1.68.1] - 2024-01-12

Added

  • Support for Redis user storage

[1.66.1] - 2023-12-20

Added

  • Added custom property in activate()

[1.66.0] - 2023-11-22

Fixed

  • Fixed issue with Advanced implementation of MEG

[1.64.0] - 2023-10-10

Fixed

  • Issue with multiple trigger goals and goals with where condition not getting triggered multiple times if user storage connected

[1.62.0] - 2023-10-10

Fixed

  • When a same user becomes part of multiple similar campaigns they should get different variations

[1.60.1] - 2023-10-09

Fixed

  • Send environment key for event arch accounts

[1.60.0] - 2023-09-28

Added

  • Check for user storage if campaign has MAB enabled

[1.58.0] - 2023-09-07

Added

  • Support for user IP Address and browser user agent to help with bot elimination, IP specific opt out and more options for post segmentation

[1.55.0] - 2023-07-14

Changed

  • Modified the revenueProp logic to read from eventProperties for Data360 enabled accounts
  • Updated the code to check for existence of eventProperties and access the revenueProp property accordingly

[1.50.1] - 2023-06-26

Changed

  • Changed the test cases for MEG new implementation

[1.50.0] - 2023-06-26

Changed

  • Update bucketing logic so that variation remains unchanged even after changing campaign traffic distribution. Note: it will not cater the case when user was not part of campaign earlier but started becoming part of campaign after changing the campaign traffic distribution and vice versa.

[1.46.1] - 2023-06-08

Changed

  • Print settings-file in the error log in case of get_and_update_settings_file API fails to fetch correct settings

[1.46.0] - 2023-06-06

Added

  • Added new Mutually Exclusive Group implementation with Priority Campaigns and Traffic Allocation

[1.36.0] - 2023-06-01

Changed

  • Fixed bucket_value going outside permissible limits in some edge cases while bucketing a user into campaign having percent-traffic not equals to 100

[1.35.1] - 2023-05-31

Added

  • Added stacktrace to exception handling in generic_util

[1.35.0] - 2023-05-08

Changed

  • Refactored Event Batching to handle high concurrent load(impressions being sent to VWO)

[1.34.1] - 2023-05-05

Changed

  • Added retry_strategy in requests connection. Also, added more error logs in case of HTTP Connection error.

[1.34.0] - 2023-05-04

Changed

  • Added debugging information in the error-log when batch-event call is getting failed

[1.33.0] - 2022-03-01

Changed

  • Updated pyrsistent for latest python versions[

[1.32.0] - 2022-22-09

Added

  • Added support for handling the below operators in targeting and whitelisting i.e.
    • Greater than
    • Greater than equal to
    • Less than
    • Less than equal to

[1.31.0] - 2022-25-03

Changed

  • Update requirements.txt and make jsonschema requirement less restrictive[

[1.30.0] - 2022-11-01

Changed

  • Tracking data for the Data Residency enabled VWO accounts will be sent to the configured location
  • Update year in all the copyright and liense headers

[1.28.0] - 2022-11-01

Changed

  • In case you want to opt out of tracking by VWO, simply call the set_opt_out API. This will exclude all the users from any kind of tracking by VWO. This is useful when you just want to make the VWO SDK ineffective without actually removing the associated code.

    set_opt_out API will also remove unwanted memory footprint by destructing all the instance variables. Calling any other API after this will not be effective i.e. no decision-making or impression would be made to VWO.

    vwo_client_instance.set_opt_out()

    If you want to opt-in again for tracking by VWO SDK, reinitialize the SDK with the latest settings.

origin/master

[1.25.0] - 2021-12-20

Added

  • Support for pushing multiple custom dimensions at once. Earlier, you had to call push API multiple times for tracking multiple custom dimensions as follows:

    vwo_client_instance.push("browser", "chrome", user_id)
vwo_client_instance.push("price", "20", user_id)

    Now, you can pass a dictionary

    custom_dimension_map = {
  "tag_key_1": "tag_value_1",
  "tag_key_2": "tag_value_2",
  "tag_key_3": "tag_value_3"
}

# using named parameters/kwargs
vwo_client_instance.push(custom_dimension_map = custom_dimension_map, user_id = user_id)

# or positional parameters
vwo_client_instance.push({"tag_key_1": "tag_value_1"}, "user_id")

    Multiple tracking calls would be initiated in this case.

Changed

  • If Events Architecture is enabled for your VWO account, all the tracking calls being initiated from SDK would now be POST instead of GET and there would be single endpoint i.e. /events/t. This is done in order to bring events support and building advancded capabilities in future.

  • For events architecture accounts, tracking same goal across multiple campaigns will not send multiple tracking calls. Instead one single POST call would be made to track the same goal across multiple different campaigns running on the same environment.

  • Multiple custome dimension can be pushed via push API. For events architecture enabled account, only one single tracking call would be made to track multiple custom dimensions.

    custom_dimension_map = {
  "tag_key_1": "tag_value_1",
  "tag_key_2": "tag_value_2",
  "tag_key_3": "tag_value_3"
}

# using named parameters/kwargs
vwo_client_instance.push(custom_dimension_map = custom_dimension_map, user_id = user_id)

# or positional parameters
vwo_client_instance.push({"tag_key_1": "tag_value_1"}, "user_id")

[1.23.2] - 2020-10-21

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

Changed

  • Remove shouldTrackReturningVisitor option as FullStack campaigns show unique visitors and conversions count. Duplicate visitors/conversions tracking calls would not be made if User Storage Service is used.

[1.22.0] - 2021-09-29

Changed

  • Use Campaign ID along with User ID for bucketing a user in a campaign. This will ensure that a particular user gets different variation for different campaigns having similar settings i.e. same campaign-traffic, number of variations, and variation traffic.

[1.20.0] - 2021-08-12

Added

  • Introducing support for Mutually Exclusive Campaigns. By creating Mutually Exclusive Groups in VWO Application, you can group multiple FullStack A/B campaigns together that are mutually exclusive. SDK will ensure that visitors do not overlap in multiple running mutually exclusive campaigns and the same visitor does not see the unrelated campaign variations. This eliminates the interaction effects that multiple campaigns could have with each other. You simply need to configure the group in the VWO application and the SDK will take care what to be shown to the visitor when you will call the activate API for a given user and a campaign.

[1.19.0] - 2021-08-06

Changed

  • Sending visitor tracking call for Feature Rollout campaign when is_feature_enabled API is used. This will help in visualizing the overall traffic for the respective campaign's report in the VWO application.

[1.18.0] - 2021-07-12

Added

  • Feature Rollout and Feature Test campaigns now supports JSON type variable which can be created inside VWO Application. This will help in storing grouped and structured data.

[1.17.2] - 2021-06-10

Changed

  • Update name of usage metrics keys. Start sending _l flag to notify VWO server whether to log or not.

[1.17.1] - 2021-05-27

Changed

  • campaign_name will be available in integrations callback, if callback is defined.
  • Environment Key will be passed in event-batching network call to VWO to view environment specific campaign reports.

[1.17.0] - 2021-05-18

Added

  • Campaign name will be available in settings and hence, changed settings-schema validations.

[1.14.0] - 2021-04-29

Added

  • Sending stats which are used for launching the SDK like storage service, logger, and integrations, etc. in tracking calls(track-user and batch-event). This is solely for debugging purpose. We are only sending whether a particular key is used not the actual value of the key.

Changed

  • Removed sending user-id, that is provided in the various APIs, in the tracking calls to VWO server as it might contain sensitive PII data.
  • SDK Key will not be logged in any log message, for example, tracking call logs.

[1.13.0] - 2021-03-16

Added

  • Exposed lifecycle hook events. This feature allows sending VWO data to third party integrations.

Changed

  • Introduced integrations param in launch API to enable receiving hooks for the third party integrations.
class Integrations(object):
    def __init__(self):
        pass

    def callback(self, properties):
        print(properties)

vwo_instance = vwo.launch(settings_file, integrations=Integrations())

[1.12.0] - 2021-03-16

Changed

  • If User Storage Service is provided, do not track same visitor multiple times.

You can pass should_track_returning_user as True in case you prefer to track duplicate visitors.

vwo_client_instance.activate(campaign_key, user_id, should_track_returning_user=True)

Or, you can also pass should_track_returning_user at the time of instantiating VWO SDK client. This will avoid passing the flag in different API calls.

vwo_client_instance = vwo.launch(
    settings_file=settings_file,
    user_storage_service = user_storage_service,
    should_track_returning_user=True
)

If should_track_returning_user param is passed at the time of instantiating the SDK as well as in the API options as mentioned above, then the API options value will be considered.

  • If User Storage Service is provided, campaign activation is mandatory before tracking any goal, getting variation of a campaign, and getting value of the feature's variable.

Correct Usage

vwo_client_instance.activate(campaign_key, user_id, custom_variables = custom_variables, variation_targeting_variables = variation_targeting_variables)
vwo_client_instance.track(campaign_key, user_id, goal_identifier, custom_variables = custom_variables, variation_targeting_variables = variation_targeting_variables)

Wrong Usage

# Calling track API before activate API
# This will not track goal as campaign has not been activated yet.
vwo_client_instance.track(campaign_key, user_id, goal_identifier, custom_variables = custom_variables, variation_targeting_variables = variation_targeting_variables)

# After calling track API
vwo_client_instance.activate(campaign_key, user_id, custom_variables = custom_variables, variation_targeting_variables = variation_targeting_variables)

[1.11.0] - 2021-02-20

Added

  • Added support for batching of events sent to VWO server
  • Intoduced batch_events config in launch API for setting when to send bulk events
  • Added flush_events API to manually flush the batch events queue when batch_events config is passed. Note: batch_events config i.e. events_per_request and request_time_interval won't be considered while manually flushing
  • If request_time_interval is passed, it will only set the timer when the first event will arrive
  • If request_time_interval is provided, after flushing of events, new interval will be registered when the first event will arrive
def flush_callback(err, events):
  print(err)
  print(events)

settings_file = vwo.get_settings_file(account_id, sdk_key)
vwo_client_instance = vwo.launch(
    settings_file=settings_file,
    batch_events={
        'events_per_request': 1000, # specify the number of events
         'request_time_interval': 10000, # specify the time limit fordraining the events (in seconds)
        'flush_callback': flush_callback # optional callback to execute when queue events are flushed
    }
)

# (optional): Manually flush the batch events queue to send impressions to VWO server.
vwo_client_instance.flush_events(mode='sync'); // two modes are available sync and async

[1.10.0] - 2021-02-15

Added

  • Webhooks support
  • Introduced get_and_update_settings_file API to fetch and update settings-file in case of webhook-trigger

[1.8.2] - 2021-02-10

Changed

  • Changed copyright header year from 2020 to 2021
  • Added long_description_content_type in setup.py so that long_description can be rendered properly on PyPI.

[1.8.1] - 2020-05-19

Added

  • Introduced launch API to initialize the VWO instance
  • Integrated black formatter and doc_checker pre-push hook for development

Before

from vwo import VWO
vwo_client_instance = VWO(settings_file)

After

from vwo import launch
vwo_client_instance = launch(settings_file)

[1.8.0] - 2020-04-29

Changed

  • Update track API to handle duplicate and unique conversions and corresponding changes in VWO init method
  • Update track API to track a goal globally across campaigns with the same goal_identifier and corresponding changes in VWO init method
# it will track goal having `goal_identifier` of campaign having `campaign_key` for the user having `user_id` as id.
vwo_client_instance.track(campaign_key, user_id, goal_identifier)
# it will track goal having `goal_identifier` of campaigns having `campaign_key1` and `campaign_key2` for the user having `user_id` as id.
vwo_client_instance.track([campaign_key1, campaign_key2], user_id, goal_identifier)
# it will track goal having `goal_identifier` of all the campaigns
vwo_client_instance.track(None, user_id, goal_identifier)

[1.6.3] - 2020-02-03

Changed

  • Updated year in Apache-2.0 Copyright header in all source, tests and scripts files.

[1.6.2] - 2020-01-27

Changed

  • Fixed test case data files to remove ambiguity while running test cases in python 3.5

[1.6.0] - 2020-01-15

Breaking Changes

To prevent ordered arguments and increasing use-cases, we are moving all optional arguments to be passed via kwargs.

  • customVariables argument in APIs: activate, get_variation, track, is_feature_enabled, and get_feature_variable_value will now be passed via kwargs.
  • revenueValue parameter in track API via kwargs

Before

# activae API
vwo_client_instance.activate(campaign_key, user_id)
# getVariation API
vwo_client_instance.get_variation(campaign_key, user_id)
# track API
vwo_client_instance.track(campaign_key, user_id, goalIdentifier, revenueValue)
# isFeatureEnabled API
vwo_client_instance.is_feature_enabled(campaign_key, user_id)
# getFeatureVariableValue API
vwo_client_instance.get_feature_variable_value(campaign_key, variableKey, user_id)

After

custom_variables = {}
variation_targeting_variables = {}

# activae API
vwo_client_instance.activate(campaign_key, user_id, custom_variables = custom_variables, variation_targeting_variables = variation_targeting_variables)
# getVariation API
vwo_client_instance.get_variation(campaign_key, user_id, custom_variables = custom_variables, variation_targeting_variables = variation_targeting_variables)
# track API
vwo_client_instance.track(campaign_key, user_id, goalIdentifier, revenue_value = revenue_value, custom_variables = custom_variables, variation_targeting_variables = variation_targeting_variables)
# isFeatureEnabled API
vwo_client_instance.is_feature_enabled(campaign_key, user_id, custom_variables = custom_variables, variation_targeting_variables = variation_targeting_variables)
# getFeatureVariableValue API
vwo_client_instance.get_feature_variable_value(campaign_key, variableKey, user_id, custom_variables = custom_variables, variation_targeting_variables = variation_targeting_variables)

Added

Forced Variation capabilites

  • Introduced Forced Variation to force certain users into specific variation. Forcing can be based on User IDs or custom variables defined.

Changed

  • All existing APIs to handle variation-targeting-variables as an option for forcing variation
  • Code refactored to support Whitelisting.

[1.5.0] - 2019-11-29

Added

Pre and Post segmentation capabilites

  • Introduced new Segmentation service to evaluate whether user is eligible for campaign based on campaign pre-segmentation conditions and passed custom-variables

Changed

  • All existing APIs to handle custom-variables for tageting audience
  • Code refactored to support campaign tageting and post segmentation

[1.4.1] - 2019-11-28

Changed

  • Fix case when no call was made when Control was returned for feature-test in isFeatureEnabled API and feature is not enabled for it.

[1.4.0] - 2019-11-28

Added

Feature Rollout and Feature Test capabilities

  • Introduced two new APIs i.e. isFeatureEnabled and getFeatureVariableValue

Changed

  • Existing APIs to handle new type of campaigns i.e. feature-rollout and feature-test
  • Code refactored to support feature-rollout and feature-test capabilites

[1.3.0] - 2019-11-21

Changed

  • Change MIT License to Apache-2.0
  • Added apache copyright-header in each file
  • Add NOTICE.txt file complying with Apache LICENSE
  • Give attribution to the third-party libraries being used and mention StackOverflow

[1.2.0] - 2019-10-15

Changed

  • Fix reusing Singleton class instance by creating new instance on re-initialization of SDK

[1.0.0] - 2019-10-15

Added

  • First release with Server-side A/B capabilities