Releases: optimizely/android-sdk
Release 3.3.0
3.3.0
October 31st, 2019
This minor release includes event processing with batching. It uses the Optimizely java sdk version 3.3.2.
New Features:
- Introduced
EventProcessor
interface withBatchEventProcessor
implementation. - Introduced
LogEvent
notification. - Added
BatchEventProcessor
as the default implementation within theOptimizelyFactory
class.
Deprecated
LogEvent
was deprecated fromTrackNotification
andActivateNotification
notifications in favor of explicitLogEvent
notification.
Release 3.2.1
3.2.1
August 29th 2019
This is a patch release which includes the following:
Bug Fixes:
- Make the initialize method with a flag to download to cache public from protected. In the other initialize methods, we always download to cache. #PR301
Release 3.2.0
3.2.0
August 21st 2019
This minor release updates the SDK to use the Optimizely Java SDK 3.2.1 which includes the following:
New Features:
- The default datafile manager now supports the Java SDK ProjectConfigManager
- The default datafile manager with polling enabled will pickup new ProjectConfigs without needing to re-initialize.
- You can register for Datafile change notifications.
Bug Fixes:
- Potential bug fix for ANRs where a service is started but there is a bad network connection. #PR295
Deprecated
- DatafileHandler interface has been deprecated. In the future we will start using the ProjectConfigManager from the Java SDK mentioned above.
Release 3.1.1
3.1.1
July 23rd, 2019
Bug Fixes:
- SourceClear flagged jackson-databind 2.9.8 fixed in 2.9.9.1
Release 3.1.0
3.1.0
May 13th, 2019
This minor release updates the SDK to use the Optimizely Java SDK 3.1.0 which includes the following:
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.
- Added APIs to be able to conveniently add Decision notification handler (
addDecisionNotificationHandler
) and Track notification handler (addTrackNotificationHandler
).
Bug Fixes:
- Feature variable APIs return default variable value when featureEnabled property is false. (#274)
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.
addActivateNotificationListener
,addTrackNotificationListener
andaddNotificationListener
APIs onNotificationCenter
.
Release 3.0.1
3.0.1
April 23, 2019
This patch release fixes some git hub issues mentioned below.
Bug Fixes
- The Logger security exception is handled a little more cleanly for logging. (#270)
- There was the possibility to start too many intents for event handling. (#268)
- The proguard rules have been cleaned up and tested. (#266)
- This also includes using Optimizely Java SDK 3.0.1. The Java SDK patch allows for using the Optimizely Android aar with older versions of org.json which are included in the android framework.
Release 3.0.0
3.0.0
February 14, 2019
The 3.0 release improves event tracking and supports additional audience targeting functionality.
New Features:
- Event tracking:
- 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 are automatically attributed to variations that the user has previously seen, as long as our backend has 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.
- 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 float, double, integer, or long in the inclusive range [-2⁵³, 2⁵³].
- Strings, booleans, and valid numbers are relevant for audience conditions.
- Support for additional matchers in audience conditions:
- 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) andlt
(less than) matchers that resolve if the user has a valid number value for the targeted attribute. A valid number is a finite float, double, integer, or long in the inclusive range [-2⁵³, 2⁵³].- The original (
exact
) matcher can now be used to target booleans and valid numbers, not just strings.
- An
- 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.
- When given an invalid datafile, the Optimizely client object now instantiates into a no-op state instead of throwing a
ConfigParseException
. This matches the behavior of the other Optimizely SDKs.
Breaking Changes:
- Java 7 is no longer supported.
- 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
ActivateNotificationListener
andTrackNotificationListener
interfaces now receive user attributes asMap<String, ?>
instead ofMap<String, String>
. - The Localytics integration now relies on the user profile service to attribute events to the user's variations.
- Drops support for the
getVariableBoolean
,getVariableDouble
,getVariableInteger
, andgetVariableString
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 tofalse
when they fail to find an legitimate value for the targeted user attribute. The result remainsnull
(unknown). Therefore, an audience that negates such a condition (using the"not"
operator) can no longer resolve totrue
unless there is an unrelated branch in the condition tree that itself resolves totrue
.
- Audience conditions (except for the new
- Support for empty user IDs.
- SourceClear flagged jackson-databind 2.9.4 fixed in 2.9.8
Release 2.1.4
2.1.4
Februrary 8th, 2019
This is a patch release.
Bug Fixes
- Fix for User Profile Service. Don't trim the user profile service unless there are over 100 experiments in a users UPS. This will be configurable in the future.
Release 2.1.3
2.1.3
December 6th, 2018
This is a patch release.
Bug Fixes
- upgrade to Optimizely Java SDK 2.1.4
- fix/wrap in try catch for getting build version in static init which might crash (#241)
Release 3.0.0-RC2
3.0.0-RC2
November 20th, 2018
This is the release candidate for the 3.0 SDK, which includes a number of improvements to audience targeting along with a few bug fixes.
New Features
- Support for number-valued and boolean-valued attributes. (#213)
- Support for audiences with new match conditions for attribute values, including “substring” and “exists” matches for strings; “greater than”, “less than”, exact, and “exists” matches for numbers; and “exact”, and “exists” matches for booleans.
- Built-in datafile version compatibility checks so that SDKs will not initialize with a newer datafile it is not compatible with. (#209)
- Audience combinations within an experiment are unofficially supported in this release.
Breaking Changes
- Previously, notification listeners filtered non-string attribute values from the data passed to registered listeners. To support our growing list of supported attribute values, we’ve changed this behavior. Notification listeners will now post any value type passed as an attribute. Therefore, the interface of the notification listeners has changed to accept a
Map<String, ?>
. - Update to use Java 1.7 (#208)
Bug Fixes
- refactor: Performance improvements for JacksonConfigParser (#209)
- refactor: typeAudience.combinations will not be string encoded like audience.combinations. To handle this we created a new parsing type TypedAudience.
- fix for exact match when dealing with integers and doubles. Created a new Numeric match type.
- make a copy of attributes passed in to avoid any concurrency problems. Addresses GitHub issue in Optimizely Andriod SDK.
- allow single root node for audience.conditions, typedAudience.conditions, and Experiment.audienceCombinations.