Release version 0.5.0 (#81)

Author: Vignesh Raja

CHANGELOG.md

@@ -1,4 +1,14 @@
 # Optimizely Android X SDK Changelog
+### 0.5.0
+
+*Bug Fixes*
+
+- Persist experiment and variation IDs instead of keys in the `AndroidUserProfile`
+
+*Breaking Changes*
+
+- Change live variable getter signature from `getVariableFloat` to `getVariableDouble`
+
 ### 0.4.1
 December 28, 2016
 
@@ -28,6 +38,7 @@ December 8, 2016
 
 ### 0.2.2
 November 30, 2016
+
 *Bug Fixes*
 - Update to java-core 1.0.3 which fixes crashes with Jackson annotations on ICS
 - Use the old SQLiteDatabse constructor for compatibility with ICS

README.md

@@ -1,4 +1,4 @@
-# optimizely-ab-android-sdk
+# Optimizely Android SDK
 Master<br/> 
 [![Master Status](https://travis-ci.org/optimizely/android-sdk.svg?branch=master)](https://travis-ci.org/optimizely/android-sdk)
 <br/>
@@ -12,11 +12,9 @@ Devel<br/>
 [![Apache 2.0](https://img.shields.io/github/license/nebula-plugins/gradle-extra-configurations-plugin.svg)](http://www.apache.org/licenses/LICENSE-2.0)
 ## Overview
 
-Our Optimizely X Android solution allows you to easily run experiments anywhere in an Android application, even Services. The solution includes easy-to-use SDKs for experimenting in your code and tracking conversion events in Optimizely.
+This repository houses the Android SDK for Optimizely's Mobile product. To find out more check out the [documentation](https://developers.optimizely.com/x/solutions/sdks/introduction/index.html?language=android&platform=mobile).
 
-To find out more check out the [documentation](https://developers.optimizely.com/x/solutions/sdks/introduction/index.html?language=android&platform=mobile). 
-
-This repo depends on [Optimizely X Java](https://github.com/optimizely/java-sdk).
+This repo depends on the [Optimizely Java SDK](https://github.com/optimizely/java-sdk).
 
 ## Architecture
 
@@ -27,13 +25,13 @@ root declares modules.  The `build.gradle` in the project root has build
 config common for all modules.
 
 1. Android SDK
-  - Users who want all modules should just declare a dependency on this module
+  - Users who want all modules should declare a dependency on this module
   - This is the outer module that depends on all other modules
-  - Handles downloading the Optimizely Data File and building Optimizely objects
+  - Handles downloading the Optimizely datafile and building Optimizely objects
   - Delivers the built Optimizely object to listeners and caches it in memory
 2. Event Handler
-  - Handles dispatching events to the Optimizely Backend
-  - Uses a Service so events can be sent without the app being reopened
+  - Handles dispatching events to the Optimizely backend
+  - Uses a Service so events can be sent without the app being re-opened
   - Persists events in a SQLite3 database
   - Required to be implemented by the Optimizely Java core
 3. User Profile
@@ -51,10 +49,8 @@ config common for all modules.
 ### Command Line
 
 1. Clone the repo
-  * `git clone [email protected]:optimizely/optimizely-ab-android-sdk.git`
-3. Create, or use an existing, Optimizely Custom Project 
-  * put a file in `test-app/src/main/res/values/git_ignored_strings.xml`
-  * Give it this contents `<resources><string name="optly_project_id">{CUSTOM_PROJECT_ID}</string></resources>`
+  * `git clone [email protected]:optimizely/android-sdk.git`
+3. Create, or use an existing, Optimizely Android project
 4. Build the project (from the project root)
   * `./gradlew assemble`
 5. Run tests for all modules
@@ -84,7 +80,7 @@ The default branch is devel.  Feature branch PRs are automatically made against
 
 Versions are managed via git tags.  Tags can be created from the command line or from the Github UI.
 
-Snapshot builds are made off of the beta branch.  Travis will test all commits to this branch.  When commit is tagged and pushed travis will build, test, *and*, ship the build bintray.  The version name used
+Snapshot builds are made off of the beta branch.  Travis will test all commits to this branch.  When a commit is tagged and pushed, Travis will build, test, *and*, ship the build to Bintray.  The version name used
 is the name of the tag.  For snapshot builds the version should have `-SNAPSHOT` appended.  For example `0.1.2-SNAPSHOT`.  Multiple builds with the same version can be pushed to Bintray when using snapshot versions.
 This keeps the version number from increasing too quickly for beta builds.  Grade and maven ensure that users are on the latest snapshot via timestamps.
 There can be only one git tag per version name so snapshot tags may need to be moved.  For example `git tag -f -a 0.1.2` and `git push -f --tags`.  

android-sdk/src/main/java/com/optimizely/ab/android/sdk/OptimizelyClient.java

@@ -276,33 +276,34 @@ public void track(@NonNull String eventName,
     }
 
     /**
-     * Get the value of a Float live variable
+     * Get the value of a Double live variable
      * @param variableKey the String key for the variable
      * @param userId the user ID
      * @param activateExperiment the flag denoting whether to activate an experiment or not
-     * @return Float value of the live variable
+     * @return Double value of the live variable
      */
-    public @Nullable Float getVariableFloat(@NonNull String variableKey,
-                                            @NonNull String userId,
-                                            boolean activateExperiment) {
-        return getVariableFloat(variableKey, userId, Collections.<String, String>emptyMap(),
-                                activateExperiment);
+    public @Nullable Double getVariableDouble(@NonNull String variableKey,
+                                              @NonNull String userId,
+                                              boolean activateExperiment) {
+        return getVariableDouble(variableKey, userId, Collections.<String, String>emptyMap(),
+                                 activateExperiment);
     }
 
     /**
-     * Get the value of a Float live variable
+     * Get the value of a Double live variable
      * @param variableKey the String key for the variable
      * @param userId the user ID
      * @param attributes a map of attributes about the user
      * @param activateExperiment the flag denoting whether to activate an experiment or not
-     * @return Float value of the live variable
+     * @return Double value of the live variable
      */
-    public @Nullable Float getVariableFloat(@NonNull String variableKey,
-                                            @NonNull String userId,
-                                            @NonNull Map<String, String> attributes,
-                                            boolean activateExperiment) {
+    public @Nullable Double getVariableDouble(@NonNull String variableKey,
+                                              @NonNull String userId,
+                                              @NonNull Map<String, String> attributes,
+                                              boolean activateExperiment) {
         if (optimizely != null) {
-            return optimizely.getVariableFloat(variableKey, userId, attributes, activateExperiment);
+            return optimizely.getVariableDouble(variableKey, userId, attributes,
+                                                activateExperiment);
         } else {
             logger.warn("Optimizely is not initialized, could not get live variable {} " +
                     "for user {}", variableKey, userId);

android-sdk/src/test/java/com/optimizely/ab/android/sdk/OptimizelyClientTest.java

@@ -238,19 +238,19 @@ public void testBadGetVariableInteger() {
     }
 
     @Test
-    public void testGoodGetVariableFloat() {
+    public void testGoodGetVariableDouble() {
         OptimizelyClient optimizelyClient = new OptimizelyClient(optimizely, logger);
-        optimizelyClient.getVariableFloat("test_key", "userId",
-                                          Collections.<String, String>emptyMap(), true);
-        verify(optimizely).getVariableFloat("test_key", "userId",
-                                            Collections.<String, String>emptyMap(), true);
+        optimizelyClient.getVariableDouble("test_key", "userId",
+                                           Collections.<String, String>emptyMap(), true);
+        verify(optimizely).getVariableDouble("test_key", "userId",
+                                             Collections.<String, String>emptyMap(), true);
     }
 
     @Test
-    public void testBadGetVariableFloat() {
+    public void testBadGetVariableDouble() {
         OptimizelyClient optimizelyClient = new OptimizelyClient(null, logger);
-        optimizelyClient.getVariableFloat("test_key", "userId",
-                                          Collections.<String, String>emptyMap(), true);
+        optimizelyClient.getVariableDouble("test_key", "userId",
+                                           Collections.<String, String>emptyMap(), true);
         verify(logger).warn("Optimizely is not initialized, could not get live variable {} " +
                 "for user {}", "test_key", "userId");
     }

build.gradle

@@ -52,7 +52,7 @@ ext {
     min_sdk_version = 10
     target_sdk_version = 24
 
-    java_core_ver = "1.2.0"
+    java_core_ver = "1.3.0"
     android_logger_ver = "1.3.1"
     support_annotations_ver = "24.2.1"
     junit_ver = "4.12"

test-app/README.md

@@ -5,8 +5,6 @@ is also used to run integration tests on using the Android Espresso framework.
 
 ## Experiments Run
 
-The experiments run in this demo app are part of the [email protected] account.
-
 We run the following experiment:
   - Background change in second activity, which is loaded after the splash screen.
 
@@ -15,12 +13,12 @@ We run the following experiment:
 The SDK is implemented in the following way:
   - The splash screen initializes the Optimizely manager asynchronously. This starts the datafile
   fetch.
-  - Once the datafile is fetched and the Optimizely manager is started, we use grab the `optimizelyClient`
-  from the manager and use it to activate the `background_experiment`. This buckets the user and sends
+  - Once the datafile is fetched and the Optimizely manager is started, we grab the `optimizelyClient`
+  from the manager and use it to activate the experiment named `background_experiment`. This buckets the user and sends
   an impression event.
   - We then use the bucketed variation to determine which activity to show. `VariationAActivity` for
-  `variation_a` and `VariationBActivity` for `variation_b`.
-  - Each of those activities include a `Test Conversion` button.
+  `variation_a`, `VariationBActivity` for `variation_b`, or `ActivationErrorActivity` for the control.
+  - Each of the variation activities includes a `Test Conversion` button.
   - Clicking on that button will call `optimizelyClient.track()` and send a conversion event for the
   event named `sample_conversion`.
   - Then the application will navigate to the conversion page to confirm that a conversion event has

test-app/build.gradle

@@ -29,14 +29,14 @@ android {
 dependencies {
     // Includes SST Java core, event handler, and user profile
     compile project(':android-sdk')
-    // compile 'com.optimizely.ab:android-sdk:0.3.1'
+    // compile 'com.optimizely.ab:android-sdk:0.5.0'
     compile 'com.android.support:appcompat-v7:24.2.1'
     compile 'com.android.support:design:24.2.1'
 
     testCompile "junit:junit:$junit_ver"
     testCompile "org.mockito:mockito-core:$mockito_ver"
     testCompile "com.noveogroup.android:android-logger:$android_logger_ver"
-    // testCompile 'com.optimizely.ab:android-sdk:0.3.1'
+    // testCompile 'com.optimizely.ab:android-sdk:0.5.0'
     testCompile project(':android-sdk')
 
     androidTestCompile("com.android.support.test:runner:$support_test_runner_ver")
@@ -48,6 +48,6 @@ dependencies {
     androidTestCompile "org.mockito:mockito-core:$mockito_ver"
     androidTestCompile "com.google.dexmaker:dexmaker:$dexmaker_ver"
     androidTestCompile "com.google.dexmaker:dexmaker-mockito:$dexmaker_ver"
-    // androidTestCompile 'com.optimizely.ab:android-sdk:0.3.1'
+    // androidTestCompile 'com.optimizely.ab:android-sdk:0.5.0'
     androidTestCompile project(':android-sdk')
 }

user-profile/src/androidTest/java/com/optimizely/ab/android/user_profile/AndroidUserProfileTest.java

@@ -80,131 +80,131 @@ public void teardown() {
     @Test
     public void saveActivation() {
         String userId = "user1";
-        String expKey = "exp1";
-        String varKey = "var1";
-        assertTrue(androidUserProfile.save(userId, expKey, varKey));
+        String expId = "1";
+        String varId = "2";
+        assertTrue(androidUserProfile.save(userId, expId, varId));
         try {
             executor.awaitTermination(5, TimeUnit.SECONDS);
         } catch (InterruptedException e) {
             fail("Time out");
         }
-        assertEquals(varKey, androidUserProfile.lookup(userId, expKey));
+        assertEquals(varId, androidUserProfile.lookup(userId, expId));
     }
 
     @Test
     public void saveActivationNullUserId() {
-        assertFalse(androidUserProfile.save(null, "exp1", "var1"));
-        verify(logger).error("Received null userId, unable to save activation");
+        assertFalse(androidUserProfile.save(null, "1", "2"));
+        verify(logger).error("Received null userId, unable to save activation.");
     }
 
     @Test
-    public void saveActivationNullExperimentKey() {
-        assertFalse(androidUserProfile.save("foo", null, "var1"));
-        verify(logger).error("Received null experiment key, unable to save activation");
+    public void saveActivationNullExperimentId() {
+        assertFalse(androidUserProfile.save("foo", null, "1"));
+        verify(logger).error("Received null experiment ID, unable to save activation.");
     }
 
     @Test
-    public void saveActivationNullVariationKey() {
-        assertFalse(androidUserProfile.save("foo", "exp1", null));
-        verify(logger).error("Received null variation key, unable to save activation");
+    public void saveActivationNullVariationId() {
+        assertFalse(androidUserProfile.save("foo", "1", null));
+        verify(logger).error("Received null variation ID, unable to save activation.");
     }
 
     @Test
     public void saveActivationEmptyUserId() {
-        assertFalse(androidUserProfile.save("", "exp1", "var1"));
-        verify(logger).error("Received empty user id, unable to save activation");
+        assertFalse(androidUserProfile.save("", "1", "2"));
+        verify(logger).error("Received empty user ID, unable to save activation.");
     }
 
     @Test
-    public void saveActivationEmptyExperimentKey() {
-        assertFalse(androidUserProfile.save("foo", "", "var1"));
-        verify(logger).error("Received empty experiment key, unable to save activation");
+    public void saveActivationEmptyExperimentId() {
+        assertFalse(androidUserProfile.save("foo", "", "1"));
+        verify(logger).error("Received empty experiment ID, unable to save activation.");
     }
 
     @Test
-    public void saveActivationEmptyVariationKey() {
-        assertFalse(androidUserProfile.save("foo", "exp1", ""));
-        verify(logger).error("Received empty variation key, unable to save activation");
+    public void saveActivationEmptyVariationId() {
+        assertFalse(androidUserProfile.save("foo", "1", ""));
+        verify(logger).error("Received empty variation ID, unable to save activation.");
     }
 
     @Test
     public void lookupActivationNullUserId() {
-        assertNull(androidUserProfile.lookup(null, "exp1"));
-        verify(logger).error("Received null user id, unable to lookup activation");
+        assertNull(androidUserProfile.lookup(null, "1"));
+        verify(logger).error("Received null user ID, unable to lookup activation.");
     }
 
     @Test
-    public void lookupActivationNullExperimentKey() {
-        assertNull(androidUserProfile.lookup("foo", null));
-        verify(logger).error("Received null experiment key, unable to lookup activation");
+    public void lookupActivationNullExperimentId() {
+        assertNull(androidUserProfile.lookup("1", null));
+        verify(logger).error("Received null experiment ID, unable to lookup activation.");
     }
 
     @Test
     public void lookupActivationEmptyUserId() {
-        assertNull(androidUserProfile.lookup("", "exp1"));
-        verify(logger).error("Received empty user id, unable to lookup activation");
+        assertNull(androidUserProfile.lookup("", "1"));
+        verify(logger).error("Received empty user ID, unable to lookup activation.");
     }
 
     @Test
-    public void lookupActivationEmptyExperimentKey() {
+    public void lookupActivationEmptyExperimentId() {
         assertNull(androidUserProfile.lookup("foo", ""));
-        verify(logger).error("Received empty experiment key, unable to lookup activation");
+        verify(logger).error("Received empty experiment ID, unable to lookup activation.");
     }
 
     @Test
     public void removeExistingActivation() {
-        androidUserProfile.save("user1", "exp1", "var1");
-        assertTrue(androidUserProfile.remove("user1", "exp1"));
-        assertNull(androidUserProfile.lookup("user1", "exp1"));
+        androidUserProfile.save("user1", "1", "2");
+        assertTrue(androidUserProfile.remove("user1", "1"));
+        assertNull(androidUserProfile.lookup("user1", "1"));
     }
 
     @Test
     public void removeNonExistingActivation() {
-        assertFalse(androidUserProfile.remove("user1", "exp1"));
+        assertFalse(androidUserProfile.remove("user1", "1"));
     }
 
     @Test
     public void removeActivationNullUserId() {
-        assertFalse(androidUserProfile.remove(null, "exp1"));
-        verify(logger).error("Received null user id, unable to remove activation");
+        assertFalse(androidUserProfile.remove(null, "1"));
+        verify(logger).error("Received null user ID, unable to remove activation.");
     }
 
     @Test
-    public void removeActivationNullExperimentKey() {
+    public void removeActivationNullExperimentId() {
         assertFalse(androidUserProfile.remove("foo", null));
-        verify(logger).error("Received null experiment key, unable to remove activation");
+        verify(logger).error("Received null experiment ID, unable to remove activation.");
     }
 
     @Test
     public void removeActivationEmptyUserId() {
-        assertFalse(androidUserProfile.remove("", "exp1"));
-        verify(logger).error("Received empty user id, unable to remove activation");
+        assertFalse(androidUserProfile.remove("", "1"));
+        verify(logger).error("Received empty user ID, unable to remove activation.");
     }
 
     @Test
-    public void removeActivationEmptyExperimentKey() {
+    public void removeActivationEmptyExperimentId() {
         assertFalse(androidUserProfile.remove("foo", ""));
-        verify(logger).error("Received empty experiment key, unable to remove activation");
+        verify(logger).error("Received empty experiment ID, unable to remove activation.");
     }
 
     @Test
     public void startHandlesJSONException() throws IOException {
         assertTrue(cache.save(diskUserProfileCache.getFileName(), "{"));
         androidUserProfile.start();
-        verify(logger).error(eq("Unable to parse user profile cache"), any(JSONException.class));
+        verify(logger).error(eq("Unable to parse user profile cache."), any(JSONException.class));
     }
 
     @Test
     public void start() throws JSONException {
         androidUserProfile.start();
-        androidUserProfile.save("user1", "exp1", "var1");
-        androidUserProfile.save("user1", "exp2", "var2");
+        androidUserProfile.save("user1", "1", "3");
+        androidUserProfile.save("user1", "2", "4");
 
-        Map<String, String> expKeyToVarKeyMap = new HashMap<>();
-        expKeyToVarKeyMap.put("exp1", "var1");
-        expKeyToVarKeyMap.put("exp2", "var2");
+        Map<String, String> expIdToVarIdMap = new HashMap<>();
+        expIdToVarIdMap.put("1", "3");
+        expIdToVarIdMap.put("2", "4");
         Map<String, Map<String, String>> profileMap = new HashMap<>();
-        profileMap.put("user1", expKeyToVarKeyMap);
+        profileMap.put("user1", expIdToVarIdMap);
 
         assertEquals(profileMap, memoryUserProfileCache);
     }