|
1 | 1 | # Optimizely Android X SDK Changelog |
2 | | -### 1.5.0 |
| 2 | +## 1.6.1 |
| 3 | +April 25, 2018 |
| 4 | + |
| 5 | +- Release 1.6.1 |
| 6 | + |
| 7 | +This is a patch release for 1.6.0 and 1.5.1 Optimizely SDKs. |
| 8 | + |
| 9 | +### Bug Fixes |
| 10 | +* Fix for the following issue: |
| 11 | +https://issuetracker.google.com/issues/63622293 |
| 12 | +Our github issue is [here](https://github.com/optimizely/android-sdk/issues/194). |
| 13 | +The JobWorkService was probably destroyed but we didn't cancel the |
| 14 | +processor. It causes an exception in dequeueWork in our JobWorkService. |
| 15 | +We wrapped the dequeueWork with a try/catch and are also now cancelling the background task in onDestroy. |
| 16 | + |
| 17 | +* Fix for possible error when loading logger via dagger (fall back logger provided). |
| 18 | + |
| 19 | +## 2.0.0-beta1 |
| 20 | + |
| 21 | +March 29th, 2018 |
| 22 | + |
| 23 | +This major release of the Optimizely SDK introduces APIs for Feature Management. It also introduces some breaking changes listed below. |
| 24 | + |
| 25 | +### New Features |
| 26 | +* Introduces the `isFeatureEnabled` API to determine whether to show a feature to a user or not. |
| 27 | +``` |
| 28 | +Boolean enabled = optimizelyClient.isFeatureEnabled("my_feature_key", "user_1", userAttributes); |
| 29 | +``` |
| 30 | + |
| 31 | +* You can also get all the enabled features for the user by calling the following method which returns a list of strings representing the feature keys: |
| 32 | +``` |
| 33 | +ArrayList<String> enabledFeatures = optimizelyClient.getEnabledFeatures("user_1", userAttributes); |
| 34 | +``` |
| 35 | + |
| 36 | +* Introduces Feature Variables to configure or parameterize your feature. There are four variable types: `Integer`, `String`, `Double`, `Boolean`. |
| 37 | +``` |
| 38 | +String stringVariable = optimizelyClient.getFeatureVariableString("my_feature_key", "string_variable_key", "user_1"); |
| 39 | +Integer integerVariable = optimizelyClient.getFeatureVariableInteger("my_feature_key", "integer_variable_key", "user_1"); |
| 40 | +Double doubleVariable = optimizelyClient.getFeatureVariableDouble("my_feature_key", "double_variable_key", "user_1"); |
| 41 | +Boolean booleanVariable = optimizelyClient.getFeatureVariableBoolean("my_feature_key", "boolean_variable_key", "user_1"); |
| 42 | +``` |
| 43 | + |
| 44 | +### Breaking changes |
| 45 | +* The `track` API with revenue value as a stand-alone parameter has been removed. The revenue value should be passed in as an entry of the event tags map. The key for the revenue tag is `revenue` and will be treated by Optimizely as the key for analyzing revenue data in results. |
| 46 | +``` |
| 47 | +Map<String, Object> eventTags = new HashMap<String, Object>(); |
| 48 | +
|
| 49 | +// reserved "revenue" tag |
| 50 | +eventTags.put("revenue", 6432); |
| 51 | +
|
| 52 | +optimizelyClient.track("event_key", "user_id", userAttributes, eventTags); |
| 53 | +``` |
| 54 | + |
| 55 | +* Live variable accessor methods have been removed and have been replaced with the feature variable methods mentioned above. Feature variables are scoped to a feature so you must supply the feature key in addition to the variable key to access them. |
| 56 | + |
| 57 | + - `getVariableBoolean` now becomes `getFeatureVariableBoolean` |
| 58 | + - `getVariableString` now becomes `getFeatureVariableString` |
| 59 | + - `getVariableInteger` now becomes `getFeatureVariableInteger` |
| 60 | + - `getVariableFloat` now becomes `getFeatureVariableDouble` |
| 61 | + |
| 62 | +## 1.6.0 |
| 63 | +Febuary 3, 2018 |
| 64 | + |
| 65 | +- Release 1.6.0 |
| 66 | + |
| 67 | +This release adds support for bucketing id (By passing in `$opt_bucketing_id` in the attribute map, you can override the user id as the bucketing variable. This is useful when wanting a set of users to share the same experience such as two players in a game). |
| 68 | + |
| 69 | +This release also deprecates the old notification broadcaster in favor of a notification center that supports a wide range of notifications. The notification listener is now registered for the specific notification type such as ACTIVATE and TRACK. This is accomplished by allowing for a variable argument call to notify (a new var arg method added to the NotificationListener). Specific abstract classes exist for the associated notification type (ActivateNotificationListener and TrackNotificationListener). These abstract classes enforce the strong typing that exists in Java. You may also add custom notification types and fire them through the notification center. The notification center is implemented using this var arg approach in all Optimizely SDKs. |
| 70 | + |
| 71 | +*New Features* |
| 72 | + |
| 73 | +- Added `$opt_bucketing_id` in the attribute map for overriding bucketing using the user id. It is available as a static string in DecisionService.ATTRIBUTE_BUCKETING_ID |
| 74 | +- Optimizely notification center for activate and track notifications. |
| 75 | + |
| 76 | +*Breaking change* |
| 77 | +There is a new abstract method on NotificationListener notify(args...); |
| 78 | + |
| 79 | +## 1.5.1 |
| 80 | +November 1, 2017 |
| 81 | + |
| 82 | +- Release 1.5.1 |
| 83 | + |
| 84 | +*New Features* |
| 85 | + |
| 86 | +- Numeric metrics |
| 87 | +- Client-side programmatic forced variations. |
| 88 | +- Example of synchronous and asynchronous initialize in test-app |
| 89 | + |
| 90 | +*Bug Fixes* |
| 91 | + |
| 92 | +- Remove Espresso dependency |
| 93 | +- Narrow proguard rules |
| 94 | +- Last modified fixed so that multiple project files can be used. |
| 95 | +- Call start listener if there is an exception. |
| 96 | +- Example of overriding Gson and android-logger in test-app gradle file. |
| 97 | +- Fix crash on API 17 (missing annotation). |
| 98 | +- Support for Android O (please see developer docs for details). Basically, Android O and above will use JobScheduler and pre Android O will continue to use AlarmService. This is done through a class called the JobWorkService which allows you to keep your Service and IntentService intact. Developers can piggyback on this method and keep thier IntentServices and use the JobWorkService. |
| 99 | +- Proguard rules were broken and were causing event payload to be stripped to single character keys. |
| 100 | + |
| 101 | +*Breaking Changes* |
| 102 | + |
| 103 | +- Same as 1.4.0 see below. |
| 104 | +- Need to add permissions to both receivers in your manifest if you plan on using the EventRescheduler or the DatafileRescheduler (see test_app manifest for example) https://github.com/optimizely/android-sdk/blob/master/test-app/src/main/AndroidManifest.xml |
| 105 | +- Updated build tools and target to API 26 which will cause proguard warnings if you are not using the latest build tools. |
| 106 | +- Also for Android O, you must register for the SUPPLICANT_CONNECTION_CHANGE_ACTION intent filter in code (see the test-app for an example). |
| 107 | + |
| 108 | +## 1.5.0 |
3 | 109 | October 30, 2017 |
4 | 110 |
|
5 | 111 | - Release 1.5.0 |
|
0 commit comments