Release 3.3.0

3.3.0

October 1st, 2019

New Features:

• Introduced EventProcessor interface with BatchEventProcessor implementation.
• Introduced LogEvent notification.
• Added BatchEventProcessor as the default implementation within the OptimizelyFactory class.

Deprecated

• LogEvent was deprecated from TrackNotification and ActivateNotification notifications in favor of explicit LogEvent notification.

Release 3.2.1

3.2.1

August 19th, 2019

New Features:

• Add clear deprecation path from factory builder method.
• Make Optimizely#withDatafile public.

Release 3.4.0-beta

3.4.0-beta

July 24th, 2019

New Features:

• Introduced EventProcessor interface with BatchEventProcessor implementation.
• Introduced LogEvent notification.
• Added BatchEventProcessor as the default implementation within the OptimizelyFactory class.

Deprecated

• LogEvent was deprecated from TrackNotification and ActivateNotification notifications in favor of explicit LogEvent notification.

Release 3.2.0

3.2.0

June 26th, 2019

New Features:

• Added support for automatic datafile management via HttpProjectConfigManager:
  • The HttpProjectConfigManager
    is part of the core-httpclient-impl package and is an implementation of the abstract
    PollingProjectConfigManager class.
  • Users must first build the HttpProjectConfigManager with an SDK key and then and provide that instance to the Optimizely.Builder.
  • An initial datafile can be provided to the HttpProjectConfigManager to bootstrap before making http requests for the hosted datafile.
  • Requests for the datafile are made in a separate thread and are scheduled with fixed delay.
  • Configuration updates can be subscribed to via the Optimizely#addUpdateConfigNotificationHandler or by subscribing to
    the NotificationCenter built with the HttpProjectConfigManager.
• Added AsyncEventHandler.Builder to be consistent with other Optimizely resources.
• The OptimizelyFactory
  was included in the core-httpclient-impl package and provides basic methods for instantiating the Optimizely SDK with a minimal number of parameters.
• Default configuration options for HttpProjectConfigManager and AsyncEventHandler can be overwritten using Java system properties, environment variables or via an optimizely.properties file
  to avoid hard coding the configuration options.

Deprecated

• Optimizely.builder(String, EventHandler) was deprecated in favor of pure builder methods withConfigManager and withEventHandler.

Release 3.2.0-alpha

3.2.0-alpha

May 23rd, 2019

New Features:

• Added support for automatic datafile management via HttpProjectConfigManager:
  • The HttpProjectConfigManager
    is part of the core-httpclient-impl package and is an implementation of the abstract
    PollingProjectConfigManager class.
  • Users must first build the HttpProjectConfigManager with an SDK key and then and provide that instance to the Optimizely.Builder.
  • An initial datafile can be provided to the HttpProjectConfigManager to bootstrap before making http requests for the hosted datafile.
  • Requests for the datafile are made in a separate thread and are scheduled with fixed delay.
  • Configuration updates can be subscribed to via the Optimizely#addUpdateConfigNotificationHandler or by subscribing to
    the NotificationCenter built with the HttpProjectConfigManager.
• Added AsyncEventHandler.Builder to be consistent with other Optimizely resources.
• The OptimizelyFactory
  was included in the core-httpclient-impl package and provides basic methods for instantiating the Optimizely SDK with a minimal number of parameters.
• Default configuration options for HttpProjectConfigManager and AsyncEventHandler can be overwritten using Java system properties, environment variables or via an optimizely.properties file
  to avoid hard coding the configuration options.

Deprecated

• Optimizely.builder(String, EventHandler) was deprecated in favor of pure builder methods withConfigManager and withEventHandler.

Release 3.1.0

3.1.0

May 6th, 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.
• 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 and addNotificationListener APIs on NotificationCenter.

Release 3.0.1

3.0.1

April 23, 2019

This is a simple fix so that older versions of org.json can still parse the datafile.

Bug Fix

We use org.json.JSONArray. Older versions do not support the iterator. In order to ensure that the datafile is still parsable if you use a older version, we changed to use the get method instead of the iterator.
(#283)

Release 3.0.0

3.0.0

February 13, 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 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:
  • 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) 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 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.
• 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.
• Support for graceful shutdown in the default, async event dispatcher.

Breaking Changes:

• Java 7 is no longer supported.
• 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 ActivateNotificationListener and TrackNotificationListener interfaces now receive user attributes as Map<String, ?> instead of Map<String, String>.

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.
• Support for empty user IDs. (#220)
• Sourceclear flagged jackson-databind 2.9.4 fixed in 2.9.8 (#260)
• Fix the quick-start app to create a unique user for every impression/conversion in a run. (#257)

Release 2.1.4

Release 2.1.4

December 6th, 2018

Bug Fixes

• fix/wrap in try catch for getting build version in static init which might crash (#241)

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.
• Refactor EventDispatcher to handle graceful shutdown via a call to AsyncEventHandler.shutdownAndAwaitTermination.

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 isue in Optimizely Andriod SDK.
• allow single root node for audience.conditions, typedAudience.conditions, and Experiment.audienceCombinations.