What's Changed

New Features

Feature Rollout: Added support for Feature Rollouts, a new experiment type combining Targeted Delivery simplicity with A/B test measurement capabilities. Feature Rollouts enable progressive rollouts with full impact analytics, metric tracking, and confidence intervals.

See Feature Rollout docs for more information.

• Add Feature Rollout support (#499) — @FarhanAnjum-opti

Enhancements

• Add event retry mechanism for improved delivery reliability (#475) — @esrakartalOpt
• Remove experiment type validation from config parsing (#500) — @FarhanAnjum-opti
• Cleanup flag base setup (local holdouts) (#507) — @Mat001

Bug Fixes

• Fix PollingConfigManager rejecting valid URL-only configuration (#497) — @FarhanAnjum-opti
• Fix finally block silently swallowing exceptions (#505) — @FarhanAnjum-opti
• Exclude CMAB from UserProfileService (#474) — @FarhanAnjum-opti

Maintenance

• Replace flake8 with ruff for linting (#492) — @FarhanAnjum-opti
• Internal updates to reduce risks (#498) — @FarhanAnjum-opti
• Prepare release for v5.5.0 (#508) — @FarhanAnjum-opti

Full Changelog

v5.4.0...v5.5.0

What's Changed

• [FSSDK-11572] Python: Update impression event handling and send notification for global holdout by @esrakartalOpt in #469
• [FSSDK-12094] Fix Python holdout implementation which related to FSC failures by @esrakartalOpt in #471
• [FSSDK-12094] chore: preparing for release v5.4.0 by @esrakartalOpt in #473

Full Changelog: 5.3.0...v5.4.0

What's Changed

• [FSSDK-11362] Fix CSRF security warning by @pvcraven in #448
• [FSSDK-11362] Import CSRFProtect from a better spot so prisma picks it up by @pvcraven in #450
• [FSSDK-11139] update: enable project config to track CMAB properties by @FarhanAnjum-opti in #451
• [FSSDK-11362] Try 3 to fix prisma scan issue with CSRF by @pvcraven in #452
• [FSSDK-11017] update: experiment_id and variation_id added to payloads by @FarhanAnjum-opti in #447
• [FSSDK-11157] update: add remove method in LRU Cache for CMAB service by @FarhanAnjum-opti in #454
• [FSSDK-11148] update: Implement CMAB Client by @FarhanAnjum-opti in #453
• [FSSDK-11166] update: implement CMAB service by @FarhanAnjum-opti in #455
• [FSSDK-11175] Update: Implement Decision Service methods to handle CMAB by @FarhanAnjum-opti in #457
• [FSSDK-11184] Update: Send CMAB uuid in impression events by @FarhanAnjum-opti in #458
• [FSSDK-11458] Python - Add SDK Multi-Region Support for Data Hosting by @esrakartalOpt in #459
• [FSSDK-11789] Maintenance: remove unused testapp folder from tests by @FarhanAnjum-opti in #461
• [FSSDK-11901] Fix concurrency bug in cmab service by @FarhanAnjum-opti in #462
• [FSSDK-11569][FSSDK-11570] Python: Holdout Project Config update by @esrakartalOpt in #464
• [FSSDK-11991] update: expose CMAB cache configuration options by @FarhanAnjum-opti in #463
• [FSSDK-12010] Expose cmab prediction endpoint in py sdk by @Mat001 in #466
• [FSSDK-11571] Python: Add holdout support and refactor decision logic in DefaultDecisionService by @esrakartalOpt in #467
• [FSSDK-11958] chore: Release v5.3.0 by @FarhanAnjum-opti in #468

New Contributors

• @esrakartalOpt made their first contribution in #459

Full Changelog: 5.2.0...5.3.0

What's Changed

• [FSSDK-10866] maintenance: Name all the different types of threads by @FarhanAnjum-opti in #443
• [FSSDK-11212] Update code to retry web API calls for fetching datafile and pushing events by @pvcraven in #445
• [FSSDK-11212] chore: Prepare for 5.2.0 release by @pvcraven in #446

New Contributors

• @pvcraven made their first contribution in #445

Full Changelog: 5.1.0...5.2.0

5.1.0

November 27th, 2024

Added support for batch processing in DecideAll and DecideForKeys, enabling more efficient handling of multiple decisions in the User Profile Service.(#440)

5.0.1

June 26th, 2024

We removed redundant dependencies pyOpenSSL and cryptography (#435, #436).

5.0.0

January 18th, 2024

New Features

The 5.0.0 release introduces a new primary feature, Advanced Audience Targeting enabled through integration with Optimizely Data Platform (ODP) (#395, #398, #402, #403, #405).

You can use ODP, a high-performance Customer Data Platform (CDP), to easily create complex real-time segments (RTS) using first-party and 50+ third-party data sources out of the box. You can create custom schemas that support the user attributes important for your business, and stitch together user behavior done on different devices to better understand and target your customers for personalized user experiences. ODP can be used as a single source of truth for these segments in any Optimizely or 3rd party tool.

With ODP accounts integrated into Optimizely projects, you can build audiences using segments pre-defined in ODP. The SDK will fetch the segments for given users and make decisions using the segments. For access to ODP audience targeting in your Feature Experimentation account, please contact your Optimizely Customer Success Manager.

This version includes the following changes:

• New API added to OptimizelyUserContext:

  • fetchQualifiedSegments(): this API will retrieve user segments from the ODP server. The fetched segments will be used for audience evaluation. The fetched data will be stored in the local cache to avoid repeated network delays.
  • When an OptimizelyUserContext is created, the SDK will automatically send an identify request to the ODP server to facilitate observing user activities.

• New APIs added to OptimizelyClient:

  • sendOdpEvent(): customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP.

For details, refer to our documentation pages:

• Advanced Audience Targeting
• Server SDK Support
• Initialize Python SDK
• OptimizelyUserContext Python SDK
• Advanced Audience Targeting segment qualification methods
• Send Optimizely Data Platform data using Advanced Audience Targeting

Logging

• Add warning to polling intervals below 30 seconds (#428)
• Add warning to duplicate experiment keys (#430)

Enhancements

• Added py.typed to enable external usage of mypy type annotations.

Breaking Changes

• Updated minimum supported Python version from 3.7 -> 3.8
• ODPManager in the SDK is enabled by default. Unless an ODP account is integrated into the Optimizely projects, most ODPManager functions will be ignored. If needed, ODPManager can be disabled when OptimizelyClient is instantiated.
• BaseConfigManager abstract class now requires a get_sdk_key method. (#413)
• PollingConfigManager requires either the sdk_key parameter or datafile containing an sdkKey. (#413)
• Asynchronous BatchEventProcessor is now the default event processor. (#378)

5.0.0-beta

Apr 28th, 2023

New Features

The 5.0.0-beta release introduces a new primary feature, Advanced Audience Targeting enabled through integration with Optimizely Data Platform (ODP) (#395, #398, #402, #403, #405).

You can use ODP, a high-performance Customer Data Platform (CDP), to easily create complex real-time segments (RTS) using first-party and 50+ third-party data sources out of the box. You can create custom schemas that support the user attributes important for your business, and stitch together user behavior done on different devices to better understand and target your customers for personalized user experiences. ODP can be used as a single source of truth for these segments in any Optimizely or 3rd party tool.

With ODP accounts integrated into Optimizely projects, you can build audiences using segments pre-defined in ODP. The SDK will fetch the segments for given users and make decisions using the segments. For access to ODP audience targeting in your Feature Experimentation account, please contact your Optimizely Customer Success Manager.

This version includes the following changes:

• New API added to OptimizelyUserContext:

  • fetchQualifiedSegments(): this API will retrieve user segments from the ODP server. The fetched segments will be used for audience evaluation. The fetched data will be stored in the local cache to avoid repeated network delays.
  • When an OptimizelyUserContext is created, the SDK will automatically send an identify request to the ODP server to facilitate observing user activities.

• New APIs added to OptimizelyClient:

  • sendOdpEvent(): customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP.

For details, refer to our documentation pages:

• Advanced Audience Targeting
• Server SDK Support
• Initialize Python SDK
• OptimizelyUserContext Python SDK
• Advanced Audience Targeting segment qualification methods
• Send Optimizely Data Platform data using Advanced Audience Targeting

Breaking Changes

• ODPManager in the SDK is enabled by default. Unless an ODP account is integrated into the Optimizely projects, most ODPManager functions will be ignored. If needed, ODPManager can be disabled when OptimizelyClient is instantiated.
• BaseConfigManager abstract class now requires a get_sdk_key method. (#413)
• PollingConfigManager requires either the sdk_key parameter or datafile containing an sdkKey. (#413)
• Asynchronous BatchEventProcessor is now the default event processor. (#378)

[4.1.1] - March 10th, 2023

We updated our README.md and other non-functional code to reflect that this SDK supports both Optimizely Feature Experimentation and Optimizely Full Stack. (#420)

[4.1.0] - July 7th, 2022

Bug Fixes

• Fix invalid datafile returned from ProjectConfig.to_datafile and OptimizelyConfig.get_datafile (#321, #384)