Skip to content

Latest commit

 

History

History
221 lines (148 loc) · 11.2 KB

CHANGELOG.md

File metadata and controls

221 lines (148 loc) · 11.2 KB
Raw

Optimizely Swift SDK Changelog

3.10.0

January 6, 2022

New Features

  • Add a set of new APIs for overriding and managing user-level flag, experiment and delivery rule decisions. These methods can be used for QA and automated testing purposes. They are an extension of the OptimizelyUserContext interface (#431, #442, #443):

    • setForcedDecision
    • getForcedDecision
    • removeForcedDecision
    • removeAllForcedDecisions

    For details, refer to our documentation pages: OptimizelyUserContext and Forced Decision methods.

  • Add reachability checking for datafile fetch and event dispatching (#439).

3.9.0

September 15, 2021

New Features

Deprecated

  • OptimizelyFeature.experimentsMap of OptimizelyConfig is deprecated as of this release. Please use OptimizelyFeature.experimentRules and OptimizelyFeature.deliveryRules. (#418)

3.8.1

August 6, 2021

Bug Fixes

  • Remove lazy initializations for thread safety. (#422)

3.8.0

June 2, 2021

New Features

  • Fix to support multiple clients (sdkKeys). (#401, #402, #405, #406, #407, #408, #409, #410)

    • Full thread-safety for additional concurrency requirements
    • No resource conflicts for multiple sdkKeys support

Bug Fixes

  • BUILD_LIBRARY_FOR_DISTRIBUTION is turned on to support ABI when clients build own binaries and share within the team. (#403)

3.7.1

April 14, 2021

New Features

  • DatafileHandler can be customized and set when OptimizelyClient is instantiated. (#384)
  • Add watchOS Compatibility. (#390)

Bug Fixes

  • Clean up build and lint warnings. (#397)

3.7.0

February 23, 2021

New Features

  • Introducing a new primary interface for retrieving feature flag status, configuration and associated experiment decisions for users (#373, #386). The new OptimizelyUserContext class is instantiated with createUserContext and exposes the following APIs to get OptimizelyDecision:

    • setAttribute
    • decide
    • decideAll
    • decideForKeys
    • trackEvent

  • For details, refer to our documentation page: https://docs.developers.optimizely.com/full-stack/v4.0/docs/swift-sdk.

Bug Fixes

  • Fix a synchronization bug with logger injection (the binder is being updated every inject), which caused rare app crashes. (#387)

3.6.1

November 19, 2020

New Features

  • Add "enabled" field to decision metadata structure. (#376)

3.6.0

November 4, 2020

New Features

  • Add support for upcoming application-controlled introduction of tracking for non-experiment Flag decisions. (#370)

3.5.0

October 2, 2020

New Features

  • Add versioning that follows semantic version types and tests. (#333)

Bug Fixes

  • Fixing log messages for Targeted Rollouts and feature variable evaluation. (#337)

3.4.1

September 22, 2020

Bug Fixes

  • Fix a bucketing error at traffic allocation boundaries. (#365)
  • Update DataStore directory on macOS. (#355)

3.4.0

July 9, 2020

New Features

  • Add support for JSON feature variables. (#315, #317, #318)
  • Add macOS Compatibility. (#332)

Bug Fixes

  • Add more audience evaluation logs. (#336)

3.3.2

May 21, 2020

Bug Fixes

  • Fix a decision bug for multi-rule rollouts (#323)
  • Fix to forward resourceTimeout to datafileHandler (#320)

3.3.1

March 30, 2020

Bug Fixes

  • When a datafile download for initialization returns connection errors, the SDK fails to initialize. This is fixed to continue initialization with a cached datafile. (#308)
  • Events are not stored persistently in the tvOS devices. (#310, #311)

3.3.0

March 11, 2020

This release includes an enhancement of SDK initialization API to enable SDK updated on cached datafile change. It also fixes known bugs.

New Features

  • Add an option for synchronous initialization to enable SDK immediately updated when a new datafile is cached. Unless this feature is enabled, by default, the cached datafile will be used only when the SDK re-starts in the next session. Note that this option is for synchronous initialization only. (#297)

     // enable SDK update when a new datafile is cached
 optimizelyClient.start(datafile: data, doUpdateConfigOnNewDatafile: true)
 
 // by default, this feature is disabled
 optimizelyClient.start(datafile: data)

Bug Fixes

  • When a synchronously-initialized SDK enables background datafile polling and its datafile was changed in the server, the new datafile is cached but SDK is not dynamically updated. (#297)
  • When background datafile polling is enabled and app goes to background and comes back to foreground after some delays, datafile fetching is called multiple times back-to-back. (#301)
  • NotificationCenter can cause crashes when multiple threads add/call listeners simultaneously. (#304)

3.2.1

January 16, 2020

Bug Fixes

  • Swift Package Manager (SPM) spec changed to iOS10+/tvOS10+

3.2.0

January 15, 2020

This release includes a new API to access project configuration data and other feature enhancements. It also fixes known bugs.

New Features

  • OptimizelyConfig (#274):
  • Add LogEvent Notification (#263):
    • Register an event listener with addLogEventNotificationListener()
    • The lister will be called when events are dispatched to the server.
  • Turn on "Allow app extensions only" flag in build settings (#277)

Bug Fixes

  • When timerInterval is set to a negative value, EventDispatcher is changed to use the default interval value for batching (instead of disabling batch). Batching is disabled when the timerInterval is set to zero. (#268)

Breaking Changes

  • Upgrade required platforms from iOS9+/tvOS9+ to iOS10+/tvOS10+ (#284)

3.1.0

July 31, 2019

This release is the GA launch of the Swift SDK. It is a pure Swift implementation which takes complete advantage of language features and performance. It supports Objective-C applications as well.

This modernized version of the SDK is meant to replace the Objective-C SDK.

New Features

In addition to all features and APIs support of the Objective-C SDK, this new SDK also adds the following new features:

  • By default the datafile handler does updates every 10 minutes when the application is in the foreground. To disable this, set the periodicUpdateInterval to zero. If you do allow for polling, the project will update automatically when a new datafile change is received.
  • On top of the above functionality, the developer may register for a datafile change notification. This notification will be called anytime a new datafile is downloaded to cache and is used to reinitialize the optimizely client automatically.
  • The event handler batches events and will run every minute in the foreground to send events. If there are no events in the queue it will not reschedule.

Bug Fixes

Breaking Changes

3.1.0-beta

May 30, 2019

This is the initial release of the Swift SDK. It is a pure Swift implementation which takes complete advantage of language features and performance. It supports Objective-C applications as well. It uses Swift 4.2 but we will be upgrading to 5.0 soon.

This modernized version of the SDK is meant to replace the Objective-C SDK.

New Features

  • By default the datafile handler does updates every 10 minutes when the application is in the foreground. To disable this, set the periodicUpdateInterval to zero. If you do allow for polling, the project will update automatically when a new datafile change is received.
  • On top of the above functionality, the developer may register for a datafile change notification. This notification will be called anytime a new datafile is downloaded to cache and is used to reinitialize the optimizely client automatically.
  • The event handler batches events and will run every minute in the foreground to send events. If there are no events in the queue it will not reschedule.

Bug Fixes

Breaking Changes