diff --git a/CHANGELOG.md b/CHANGELOG.md index 1bc793ac8..223e6a402 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,57 @@ # Optimizely Android X SDK Changelog +## 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) 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. + +### 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` and `TrackNotificationListener` interfaces now receive user attributes as `Map` instead of `Map`. +* 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`, and `getVariableString` 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`. +* Support for empty user IDs. +* SourceClear flagged jackson-databind 2.9.4 fixed in 2.9.8 + +## 2.1.4 +February 8th, 2019 + +This is a patch release. + +### Bug Fixes +* fix 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. + +## 2.1.3 +December 6th, 2018 + +### Bug Fixes +The attributes map is now copied to ensure there is no concurrency issues. + ## 3.0.0-RC2 November 20th, 2018 @@ -41,10 +93,6 @@ release. he 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`. * Update to use Java 1.7 ([#208](https://github.com/optimizely/java-sdk/pull/208)) - -### Bug Fixes -The attributes map is now copied to ensure there is no concurrency issues. - ## 2.1.2 November 8, 2018 diff --git a/android-sdk/src/androidTest/java/com/optimizely/ab/android/sdk/OptimizelyClientTest.java b/android-sdk/src/androidTest/java/com/optimizely/ab/android/sdk/OptimizelyClientTest.java index fdf0ab13a..a70b45f64 100644 --- a/android-sdk/src/androidTest/java/com/optimizely/ab/android/sdk/OptimizelyClientTest.java +++ b/android-sdk/src/androidTest/java/com/optimizely/ab/android/sdk/OptimizelyClientTest.java @@ -410,10 +410,7 @@ public void testGoodForcedTrack() { // id of var_2 // the new event backend accepts both camel case and snake case // https://logx.optimizely.com/v1/events - assertTrue(logEvent.getBody().contains("\"variationId\":\"8505434669\"") || - logEvent.getBody().contains("\"variation_id\":\"8505434669\"")); - - verify(config).getForcedVariation(FEATURE_ANDROID_EXPERIMENT_KEY, GENERIC_USER_ID); + assertTrue(logEvent.getBody().contains("\"enrich_decisions\":true")); Variation v = optimizelyClient.getForcedVariation(FEATURE_ANDROID_EXPERIMENT_KEY, GENERIC_USER_ID); assertEquals(v.getKey(), "var_2"); @@ -479,7 +476,7 @@ public void onTrack(@Nonnull String eventKey, @Nonnull String userId, @Nonnull M assertEquals(true, numberOfCalls[0]); } else { - assertEquals(false, numberOfCalls[0]); + assertEquals(true, numberOfCalls[0]); } verifyZeroInteractions(logger); @@ -493,7 +490,6 @@ public void testGoodTrackBucketing() { Experiment experiment = optimizelyClient.getProjectConfig().getExperimentsForEventKey("test_event").get(0); attributes.put(BUCKETING_ATTRIBUTE, bucketingId); optimizelyClient.track("test_event", "userId", attributes); - verify(bucketer).bucket(experiment, bucketingId); verifyZeroInteractions(logger); } @@ -553,11 +549,9 @@ public void testGoodForcedTrackAttribute() { // the new event backend accepts both camel case and snake case // https://logx.optimizely.com/v1/events // id of var_2 - assertTrue(logEvent.getBody().contains("\"variationId\":\"8505434669\"") || + assertTrue(logEvent.getBody().contains("\"enrich_decisions\":true") || logEvent.getBody().contains("\"variation_id\":\"8505434669\"")); - verify(config).getForcedVariation(FEATURE_ANDROID_EXPERIMENT_KEY, GENERIC_USER_ID); - Variation v = optimizelyClient.getForcedVariation(FEATURE_ANDROID_EXPERIMENT_KEY, GENERIC_USER_ID); assertEquals(v.getKey(), "var_2"); @@ -585,8 +579,6 @@ public void testGoodTrackAttribute() { verifyZeroInteractions(logger); - verify(config).getForcedVariation(FEATURE_ANDROID_EXPERIMENT_KEY, GENERIC_USER_ID); - Variation v = optimizelyClient.getForcedVariation(FEATURE_ANDROID_EXPERIMENT_KEY, GENERIC_USER_ID); assertEquals(v.getKey(), "var_2"); @@ -659,10 +651,7 @@ public void testGoodForcedTrackEventVal() { // the new event backend accepts both camel case and snake case // https://logx.optimizely.com/v1/events // id of var_2 - assertTrue(logEvent.getBody().contains("\"variationId\":\"8505434669\"") || - logEvent.getBody().contains("\"variation_id\":\"8505434669\"")); - - verify(config).getForcedVariation(FEATURE_ANDROID_EXPERIMENT_KEY, GENERIC_USER_ID); + assertTrue(logEvent.getBody().contains("\"enrich_decisions\":true")); Variation v = optimizelyClient.getForcedVariation(FEATURE_ANDROID_EXPERIMENT_KEY, GENERIC_USER_ID); assertEquals(v.getKey(), "var_2"); @@ -761,10 +750,7 @@ public void testGoodForcedTrackAttributeEventVal() { // the new event backend accepts both camel case and snake case // https://logx.optimizely.com/v1/events // id of var_2 - assertTrue(logEvent.getBody().contains("\"variationId\":\"8505434669\"") || - logEvent.getBody().contains("\"variation_id\":\"8505434669\"")); - - verify(config).getForcedVariation(FEATURE_ANDROID_EXPERIMENT_KEY, GENERIC_USER_ID); + assertTrue(logEvent.getBody().contains("\"enrich_decisions\":true")); Variation v = optimizelyClient.getForcedVariation(FEATURE_ANDROID_EXPERIMENT_KEY, GENERIC_USER_ID); assertEquals(v.getKey(), "var_2"); @@ -853,13 +839,10 @@ public void testForcedTrackWithEventTags() { // the new event backend accepts both camel case and snake case // https://logx.optimizely.com/v1/events // id of var_2 - assertTrue(logEvent.getBody().contains("\"variationId\":\"8505434669\"") || - logEvent.getBody().contains("\"variation_id\":\"8505434669\"")); + assertTrue(logEvent.getBody().contains("\"enrich_decisions\":true")); verifyZeroInteractions(logger); - verify(config).getForcedVariation(FEATURE_ANDROID_EXPERIMENT_KEY, GENERIC_USER_ID); - Variation v = optimizelyClient.getForcedVariation(FEATURE_ANDROID_EXPERIMENT_KEY, GENERIC_USER_ID); assertEquals(v.getKey(), "var_2"); diff --git a/build.gradle b/build.gradle index ca9ae4406..df7186065 100644 --- a/build.gradle +++ b/build.gradle @@ -53,7 +53,7 @@ ext { build_tools_version = "28.0.3" min_sdk_version = 14 target_sdk_version = 28 - java_core_ver = "3.0.0-RC2" + java_core_ver = "3.0.0" android_logger_ver = "1.3.6" support_annotations_ver = "24.2.1" junit_ver = "4.12"