Release 3.1.5

3.1.5

October 7th, 2020

Bug Fixes

• Explicitly add secondary dependencies into podspecs to fix Xcode 12 build issue. (#457)

Release 3.1.4

3.1.4

September 23rd, 2020

Bug Fixes

• Fix a bucketing error at traffic allocation boundaries. (#449)
• Fix get_variation input validation. (#441)

Release 3.1.3

3.1.3

August 8th, 2019

This release renames some protocols in OPTLYJSONModel to avoid potential name conflicts with JSONModel in client apps.

New Features

• No new features for this patch release.

Bug Fixes:

• This fix changes the protocol names of potential conflicts (Ignore -> OPTLYIgnore, Index -> OPTLYIndex) in OPTLYJSONModel and removes deprecated ConvertOnDemand.

Release 3.1.2

3.1.2

July 15th, 2019

This includes a fix of a minor bug that OPTLYClient may be initialized redundantly. It also embeds copies of Optimizely X.509 certificates for optional TLS certificate pinning support.

New Features

• Copies of root X.509 certificates are included in OptimizelySDKCore framework bundle (for optional TLS certificate pinning).

Bug Fixes:

• OPTLYClient initialization is changed from [[OPTLYClient new] initWithBuilder:] to [[OPTLYClient alloc] initWithBuilder:] to avoid redundant initialization.

Release 3.1.1

3.1.1

May 21st, 2019

This includes a fix that if an event is dispatched while the app is in the background, the event dispatcher attempts to get an ephemeral session configuration which throws an exception. We catch and log the exception returning nil which causes a nil session and no task is run. The event will be sent again when the next event is queued.

New Features

• No new features for this patch release.

Bug Fixes:

• NSURLSession ephemeral session creation may throw an exception while the app is in the background.
  This fix wraps the ephemeral session creation with a try catch and logs an error. (#417)

Release 3.1.0

3.1.0

May 16th, 2019

New Features:

• Introduced Decision notification listener to be able to record:
• Variation assignments for users activated in an experiment.
• Feature access for users.
• Feature variable value for users.

Bug Fixes:

• Feature variable APIs return default variable value when featureEnabled property is false. (#390)

Deprecated

• Activate notification listener is deprecated as of this release. Recommendation is to use the new Decision notification listener. Activate notification listener will be removed in the next major release.

Release 3.0.2

3.0.2

February 27th, 2019

This release removes type casting in Swift to NSObject in user attributes

New Features

• No new features for this patch release.

Bug Fixes:

• Change all instances of attributes and eventTags from NSDictionary<NSString*,NSObject*> to NSDictionary<NSString*,id>

Release 3.0.1

3.0.1

February 26th, 2019

This includes a fix for a build error observed with some development settings

New Features

• No new features for this patch release.

Bug Fixes:

• Type cast id to NSObject* to fix a build error with some development settings

Release 3.0.0

3.0.0

February 14th, 2019

The 3.0 release improves event tracking and supports additional audience targeting functionality.

New Features:

• Event tracking (#359):
  • The Track method now dispatches its conversion event unconditionally, without first determining whether the user is targeted by a known experiment that uses the event. This may increase outbound network traffic.
  • In Optimizely results, conversion events sent by 3.0 SDKs don't explicitly name the experiments and variations that are currently targeted to the user. Instead, conversions are automatically attributed to variations that the user has previously seen, as long as those variations were served via 3.0 SDKs or by other clients capable of automatic attribution, and as long as our backend actually received the impression events for those variations.
  • Altogether, this allows you to track conversion events and attribute them to variations even when you don't know all of a user's attribute values, and even if the user's attribute values or the experiment's configuration have changed such that the user is no longer affected by the experiment. As a result, you may observe an increase in the conversion rate for previously-instrumented events. If that is undesirable, you can reset the results of previously-running experiments after upgrading to the 3.0 SDK.
  • This will also allow you to attribute events to variations from other Optimizely projects in your account, even though those experiments don't appear in the same datafile.
  • Note that for results segmentation in Optimizely results, the user attribute values from one event are automatically applied to all other events in the same session, as long as the events in question were actually received by our backend. This behavior was already in place and is not affected by the 3.0 release.
• Support for all types of attribute values, not just strings (#309).
  • All values are passed through to notification listeners.
  • Strings, booleans, and valid numbers are passed to the event dispatcher and can be used for Optimizely results segmentation. A valid number is a finite number in the inclusive range [-2⁵³, 2⁵³].
  • Strings, booleans, and valid numbers are relevant for audience conditions.
• Support for additional matchers in audience conditions (#337):
  • An exists matcher that passes if the user has a non-null value for the targeted user attribute and fails otherwise.
  • A substring matcher that resolves if the user has a string value for the targeted attribute.
  • gt (greater than) and lt (less than) matchers that resolve if the user has a valid number value for the targeted attribute. A valid number is a finite number in the inclusive range [-2⁵³, 2⁵³].
  • The original (exact) matcher can now be used to target booleans and valid numbers, not just strings.
• Support for A/B tests, feature tests, and feature rollouts whose audiences are combined using "and" and "not" operators, not just the "or" operator.
• Datafile-version compatibility check: The SDK will remain uninitialized (i.e., will gracefully fail to activate experiments and features) if given a datafile version greater than 4.
• Updated Pull Request template and commit message guidelines.
• Support for empty bucketing IDs when evaluating feature rollouts (#367).

Breaking Changes:

• Conversion events sent by 3.0 SDKs don't explicitly name the experiments and variations that are currently targeted to the user, so these events are unattributed in raw events data export. You must use the new results export to determine the variations to which events have been attributed.
• Previously, notification listeners were only given string-valued user attributes because only strings could be passed into various method calls. That is no longer the case. The ActivateListener and TrackListener interfaces now receive user attributes as NSDictionary<NSString *, NSObject *> * _Nullable instead of NSDictionary<NSString *,NSString *> * _Nonnull.
• The Localytics integration now relies on the user profile service to attribute events to the user's variations.
• Drops support for the variableBoolean, variableDouble, variableInteger, and variableString APIs. Please migrate to the Feature Management APIs which were introduced in the 2.x releases.

Bug Fixes:

• Experiments and features can no longer activate when a negatively targeted attribute has a missing, null, or malformed value.
  • Audience conditions (except for the new exists matcher) no longer resolve to false when they fail to find an legitimate value for the targeted user attribute. The result remains null (unknown). Therefore, an audience that negates such a condition (using the "not" operator) can no longer resolve to true unless there is an unrelated branch in the condition tree that itself resolves to true (#355).
  • Support for empty user IDs (#356).
• Updated JSONModel definitions (#329).

Release 2.1.6

2.1.6

January 25th, 2019

This includes a fix for revenue and metrics. Numbers 0 and 1 were evaluated as false and true causing us to drop them from the event.

New Features

• No new features for this patch release.

Bug Fixes:

• Check for BOOL type but allow number values 0 and 1 in revenue and metrics to go to results.
• Only remove old variation assignments from the user profile service when there are >= 100 persisted assignments.