From 18d3ed86404b2e2d3de83250e4e569fd2cbb1e41 Mon Sep 17 00:00:00 2001 From: Thomas Zurkan Date: Wed, 13 Feb 2019 11:42:37 -0800 Subject: [PATCH 1/6] prepare for 3.0 --- CHANGELOG.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 14d9c28f9..7a6723344 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,39 @@ # Optimizely Java X SDK Changelog +## 3.0.0 +February 11, 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 number 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 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. +* 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. +* 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`. +### 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. +* Wrap the buffer reader in try...catch. + ## 2.1.4 December 6th, 2018 From 73460842b132ca955ab6998d81e877a92cd0f708 Mon Sep 17 00:00:00 2001 From: Thomas Zurkan Date: Wed, 13 Feb 2019 11:55:14 -0800 Subject: [PATCH 2/6] fix date --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7a6723344..e81ff5934 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,7 @@ # Optimizely Java X SDK Changelog ## 3.0.0 -February 11, 2019 +February 13, 2019 The 3.0 release improves event tracking and supports additional audience targeting functionality. ### New Features: From 3b7de1b9a160a74df0b7071a95e1501633866be3 Mon Sep 17 00:00:00 2001 From: Thomas Zurkan Date: Wed, 13 Feb 2019 12:14:30 -0800 Subject: [PATCH 3/6] add bug fixes and formatting to change log --- CHANGELOG.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e81ff5934..397c60a9f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,11 @@ # Optimizely Java X SDK Changelog ## 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. @@ -25,14 +27,18 @@ The 3.0 release improves event tracking and supports additional audience targeti * 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. * 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`. + ### 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. -* Wrap the buffer reader in try...catch. +* Wrap buffer reader for version info. There can be a condition where the buffer reader fails to create for the version resource. +* Sourceclear flagged jackson-databind 2.9.4 fixed in 2.9.8 +* Fix the quick-start app to create a unique user for every impression/conversion ## 2.1.4 From 315beb93b461aef58440758b393cee4e6615678d Mon Sep 17 00:00:00 2001 From: Thomas Zurkan Date: Wed, 13 Feb 2019 12:39:01 -0800 Subject: [PATCH 4/6] add indent --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 397c60a9f..14e040657 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -34,7 +34,7 @@ The 3.0 release improves event tracking and supports additional audience targeti ### 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`. + * 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. * Wrap buffer reader for version info. There can be a condition where the buffer reader fails to create for the version resource. * Sourceclear flagged jackson-databind 2.9.4 fixed in 2.9.8 From eb6e7817dc1734e2bc9bc6df2a088f134294ce53 Mon Sep 17 00:00:00 2001 From: Thomas Zurkan Date: Wed, 13 Feb 2019 13:01:44 -0800 Subject: [PATCH 5/6] nikhal feedback --- CHANGELOG.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 14e040657..927d6dce6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,19 +8,19 @@ The 3.0 release improves event tracking and supports additional audience targeti ### 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. + * 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 number in the inclusive range [-2⁵³, 2⁵³]. + * 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 number in the inclusive range [-2⁵³, 2⁵³]. + * `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. From d8e199573d3316e605979fef389286c5d24d8f94 Mon Sep 17 00:00:00 2001 From: Thomas Zurkan Date: Wed, 13 Feb 2019 14:12:47 -0800 Subject: [PATCH 6/6] add link to pr for bug fix --- CHANGELOG.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 927d6dce6..b32c5558e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -35,10 +35,9 @@ The 3.0 release improves event tracking and supports additional audience targeti ### 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. -* Wrap buffer reader for version info. There can be a condition where the buffer reader fails to create for the version resource. -* Sourceclear flagged jackson-databind 2.9.4 fixed in 2.9.8 -* Fix the quick-start app to create a unique user for every impression/conversion +* Support for empty user IDs. ([#220](https://github.com/optimizely/java-sdk/pull/220)) +* Sourceclear flagged jackson-databind 2.9.4 fixed in 2.9.8 ([#260](https://github.com/optimizely/java-sdk/pull/260)) +* Fix the quick-start app to create a unique user for every impression/conversion in a run. ([#257](https://github.com/optimizely/java-sdk/pull/257)) ## 2.1.4