Skip to content

Latest commit

 

History

History
172 lines (152 loc) · 13.2 KB

CHANGELOG.md

File metadata and controls

172 lines (152 loc) · 13.2 KB
Raw

Changelog

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

3.1.0 - 2024-02-29

Features

  • Added support for additional Data API servers across the world for even faster network requests.
  • Increased limit for requests to Data API: rate limits
  • Added get_visitor_warehouse_audience method to retrieve all data associated with a visitor's warehouse audiences and adds it to the visitor.

3.0.0 - 2024-01-25

Breaking changes

  • You should no longer create a new KameleoonClient instance explicitly. To get an instance of KameleoonClient, call KameleoonClientFactory.create instead.
  • A new KameleoonClient instance does not await full initialization anymore. Instead, new wait_init and wait_init_async methods allow you to check whether the client has been successfully initialized before executing other operations.
  • Renamed get_feature_all_variables method to get_feature_variation_variables
  • Removed all deprecated methods and errors related to experiments:
    • Methods:
      • trigger_experiment
      • get_variation_associated_data
      • get_experiment_list
      • get_experiment_list_for_visitor
    • Error types:
      • ExperimentConfigurationNotFound
      • NotTargeted
      • NotAllocated
      • SiteCodeDisabled
  • Removed additional deprecated methods:
    • obtain_visitor_code
    • obtain_variation_associated_data
    • obtain_experiment_list
    • obtain_feature_variable
    • obtain_feature_list
    • obtain_feature_all_variables
    • retrieve_data_from_remote_source
  • Changed KameleoonClientConfig (previously named KameleoonClientConfiguration):
    • Renamed KameleoonClientConfiguration to KameleoonClientConfig
    • Added required parameters client_id and client_secret (ConfigCredentialsInvalid is raised unless client_id and client_secret are specified and non-empty)
    • Removed visitor_data_maximum_size parameter
    • Added session_duration_minute parameter
    • Added top_level_domain parameter
    • Renamed actions_configuration_refresh_interval parameter to refresh_interval_minute
    • Renamed default_timeout parameter to default_timeout_millisecond
  • Changed data:
    • Browser:
      • Changed browser_type, version fields to read-only
    • Conversion:
      • Changed goal_id, revenue, negative fields to read-only
    • CustomData:
      • Changed id field to read-only
      • Changed the data type of the id field to int
      • Removed the deprecated value constructor parameter
    • Device:
      • Changed device_type field to read-only
    • PageView:
      • Changed url, title, referrers fields to read-only
    • UserAgent:
      • Changed value field to read-only
      • Removed get_value method
  • Changed the cookies parameter type in get_visitor_code to Dict[str, Morsel[str]].
  • Changed errors:
    • Added new exception FeatureEnvironmentDisabled indicating that the feature flag is disabled for certain environments. The following methods can throw the new exception:
    • Added SiteCodeIsEmpty exception, which the KameleoonClientFactory.create method raises if the specified site code parameter is empty.
    • Renamed error types:
      • ConfigurationNotFoundException to ConfigFileNotFound
      • CredentialsNotFoundException to ConfigCredentialsInvalid
      • VisitorCodeNotValid to VisitorCodeInvalid
      • FeatureConfigurationNotFound to FeatureNotFound
      • VariationConfigurationNotFound to FeatureVariationNotFound
      • KameleoonException to KameleoonError

Features

2.4.0 - 2023-09-14

Features

Bug fixes

  • Fixed an issue where the SDK wouldn't send tracking data if multi-threading was enabled.

2.3.0 - 2023-08-14

Features

2.2.0 - 2023-04-25

Features

  • Added a new method:
  • Renaming of methods:
  • The method obtain_feature_variable has been updated to only accept a str type for the feature_key argument. Previously, it accepted both str and int types as a Union[str, int] argument, but this functionality is now deprecated.
  • Added possibility for CustomData to use variable argument list of values

2.1.0 - 2023-02-02

2.0.0 - 2022-10-21

  • Added update campaigns and feature flag configurations instantaneously with Real-Time Streaming Architecture: Documentation or Product Updates
  • Added a new method on_update_configuration to handle events when configuration data is updated in real time.
  • Significantly improved configuration load time
  • Fixed an issue which can be a reason if crash during initialization.
  • Added support for Experiment & Exclusive Campaign conditions. Related to trigger_experiment
  • Added method to obtain a list of feature flags: obtain_feature_list
  • Added method to obtain a list of experiments: obtain_experiment_list
  • client_id and client_secret is deprecated and not required anymore.
  • Added method to obtain all variables for feature flag: obtain_feature_all_variables
  • Added KameleoonData Device data. Possible values are: PHONE, TABLET, DESKTOP.
  • Removed KameleoonData Interest
  • Added support of is among the values operator for Custom Data

1.0.9 - 2022-08-16

1.0.8 - 2022-08-08

  • Added multi_threading parameter to work in multi-threading environment. By default SDK works in a single thread to avoid GIL's performance issues.

1.0.7 - 2022-07-26

  • Removed extra logging

1.0.6 - 2022-07-05

  • Updated package's dependencies

1.0.5 - 2022-06-23

1.0.4 - 2022-06-14

  • Fixed issue when add_data accepts only first one parameter and ignores others

1.0.3 - 2022-04-12

1.0.2 - 2022-02-15

1.0.1 - 2022-01-13

1.0.0 - 2021-10-19

  • Added WSGI middleware