Release version 1.3.0 (#64)

Author: Vignesh Raja

CHANGELOG.md

@@ -1,45 +1,71 @@
+## 1.3.0
+
+January 17, 2017
+
+- Add `onEventTracked` listener
+- Change `getVariableFloat` to `getVariableDouble`
+- Persist experiment and variation IDs instead of keys in the `UserProfile`
+
 ## 1.2.0
 
+December 15, 2016
+
 - Change position of `activateExperiment` parameter in the method signatures of `getVariableString`, `getVariableBoolean`, `getVariableInteger`, and `getVariableFloat`
 - Change `UserExperimentRecord` to `UserProfile`
 - Add support for IP anonymization
 - Add `NotificationListener` for SDK events
 
 ## 1.1.0
 
+December 8, 2016
+
 - Add support for live variables
 
 ## 1.0.3
 
+November 28, 2016
+
 - Remove extraneous log message in `AsyncEventHandler`
 - Add `jackson-annotations` as a compiled dependency
 
 ## 1.0.2
 
+October 5, 2016
+
 - Gracefully handle datafile that doesn't contain required fields
 
 ## 1.0.1
 
+October 5, 2016
+
 - Allow for configurability of `clientEngine` and `clientVersion` through `Optimizely.Builder`
 - Remove ppid query string from V1 events
 
 ## 1.0.0
 
+October 3, 2016
+
 - Introduce support for Full Stack projects in Optimizely X with no breaking changes from previous version
 - Update whitelisting to take precedence over audience condition evaluation
 - Introduce more graceful exception handling in instantiation and core methods
 
 ## 0.1.71
 
+September 19, 2016
+
 - Add support for v2 backend endpoint and datafile
 
 ## 0.1.70
 
+August 29, 2016
+
 - Add a `UserExperimentRecord` interface
     - Implementors will get a chance to save and restore activations during bucketing
     - Can be used to make bucketing persistent or to keep a bucketing history
     - Pass implementations to `Optimizely.Builder#withUserExperimentRecord(UserExperimentRecord)` when creating `Optimizely` instances
 
 ## 0.1.68
 
+July 26, 2016
+
 - Beta release of the Java SDK for server-side testing

README.md

@@ -89,7 +89,7 @@ Please see [CONTRIBUTING](CONTRIBUTING.md).
 
 ## License
 ```
-   Copyright 2017, Optimizely
+   Copyright 2016, Optimizely
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

core-api/build.gradle

@@ -1,23 +1,3 @@
-/*
- *    Copyright 2017, Optimizely
- *
- *    Licensed under the Apache License, Version 2.0 (the "License");
- *    you may not use this file except in compliance with the License.
- *    You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- *    Unless required by applicable law or agreed to in writing, software
- *    distributed under the License is distributed on an "AS IS" BASIS,
- *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *    See the License for the specific language governing permissions and
- *    limitations under the License.
- */
-
-plugins {
-    id 'de.fuerstenau.buildconfig' version '1.1.7'
-}
-
 dependencies {
     compile group: 'org.slf4j', name: 'slf4j-api', version: slf4jVersion
     compile group: 'com.fasterxml.jackson.core', name: 'jackson-annotations', version: jacksonVersion
@@ -32,16 +12,10 @@ dependencies {
     provided group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: jacksonVersion, optional
 }
 
-apply plugin: 'de.fuerstenau.buildconfig'
-apply plugin: 'maven-publish'
-
-buildConfig {
-    appName = 'core-api'
-    version = rootProject.version
+task generateVersionFile {
+    // add the build version information into a file that'll go into the distribution
+    ext.buildVersion = new File(projectDir, "src/main/resources/optimizely-build-version")
+    buildVersion.text = version
 }
 
-sourceSets {
-    main {
-        java.srcDir "${buildDir}/gen/buildconfig/src/main/"
-    }
-}
+build.finalizedBy(generateVersionFile)

core-api/src/jmh/java/com/optimizely/ab/BenchmarkUtils.java

@@ -1,5 +1,6 @@
-/*
- *    Copyright 2017, Optimizely
+/**
+ *
+ *    Copyright 2016, Optimizely and contributors
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

core-api/src/jmh/java/com/optimizely/ab/OptimizelyBenchmark.java

@@ -1,5 +1,6 @@
-/*
- *    Copyright 2017, Optimizely
+/**
+ *
+ *    Copyright 2016, Optimizely and contributors
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

core-api/src/jmh/java/com/optimizely/ab/OptimizelyBuilderBenchmark.java

@@ -1,5 +1,6 @@
-/*
- *    Copyright 2017, Optimizely
+/**
+ *
+ *    Copyright 2016, Optimizely and contributors
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

core-api/src/jmh/resources/benchmark.properties

@@ -1,19 +1,3 @@
-#
-#    Copyright 2017, Optimizely
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-#
-
 datafilePathTemplate=config/profiling-test-data-%d-experiments.json
 activateGroupExperimentUserIdPropTemplate=activateGroupExperiment%dExperimentsUserId
 activateGroupExperiment10ExperimentsUserId=no

core-api/src/jmh/resources/logback.xml

@@ -1,19 +1,3 @@
-<!--
-  ~    Copyright 2017, Optimizely
-  ~
-  ~    Licensed under the Apache License, Version 2.0 (the "License");
-  ~    you may not use this file except in compliance with the License.
-  ~    You may obtain a copy of the License at
-  ~
-  ~        http://www.apache.org/licenses/LICENSE-2.0
-  ~
-  ~    Unless required by applicable law or agreed to in writing, software
-  ~    distributed under the License is distributed on an "AS IS" BASIS,
-  ~    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  ~    See the License for the specific language governing permissions and
-  ~    limitations under the License.
-  -->
-
 <configuration>
     <root level="warn"/>
 </configuration>

core-api/src/main/java/com/optimizely/ab/Optimizely.java

@@ -1,5 +1,6 @@
-/*
- *    Copyright 2017, Optimizely
+/**
+ *
+ *    Copyright 2016, Optimizely and contributors
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -32,6 +33,7 @@
 import com.optimizely.ab.error.RaiseExceptionErrorHandler;
 import com.optimizely.ab.event.EventHandler;
 import com.optimizely.ab.event.LogEvent;
+import com.optimizely.ab.event.internal.BuildVersionInfo;
 import com.optimizely.ab.event.internal.EventBuilder;
 import com.optimizely.ab.event.internal.EventBuilderV1;
 import com.optimizely.ab.event.internal.EventBuilderV2;
@@ -256,6 +258,9 @@ private void track(@Nonnull String eventName,
         } catch (Exception e) {
             logger.error("Unexpected exception in event dispatcher", e);
         }
+
+        notificationBroadcaster.broadcastEventTracked(eventName, userId, attributes, eventValue,
+                conversionEvent);
     }
 
     //======== live variable getters ========//
@@ -350,24 +355,24 @@ private void track(@Nonnull String eventName,
         return null;
     }
 
-    public @Nullable Float getVariableFloat(@Nonnull String variableKey,
-                                            @Nonnull String userId,
-                                            boolean activateExperiment) throws UnknownLiveVariableException {
-        return getVariableFloat(variableKey, userId, Collections.<String, String>emptyMap(), activateExperiment);
+    public @Nullable Double getVariableDouble(@Nonnull String variableKey,
+                                              @Nonnull String userId,
+                                              boolean activateExperiment) throws UnknownLiveVariableException {
+        return getVariableDouble(variableKey, userId, Collections.<String, String>emptyMap(), activateExperiment);
     }
 
-    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)
             throws UnknownLiveVariableException {
 
         String variableValueString = getVariableString(variableKey, userId, attributes, activateExperiment);
         if (variableValueString != null) {
             try {
-                return Float.parseFloat(variableValueString);
+                return Double.parseDouble(variableValueString);
             } catch (NumberFormatException e) {
-                logger.error("Variable value \"{}\" for live variable \"{}\" is not a float.", variableValueString,
+                logger.error("Variable value \"{}\" for live variable \"{}\" is not a double.", variableValueString,
                              variableKey);
             }
         }
@@ -691,7 +696,7 @@ public Optimizely build() throws ConfigParseException {
             }
 
             if (clientVersion == null) {
-                clientVersion = BuildConfig.VERSION;
+                clientVersion = BuildVersionInfo.VERSION;
             }
 
             if (eventBuilder == null) {

core-api/src/main/java/com/optimizely/ab/OptimizelyRuntimeException.java

@@ -1,5 +1,6 @@
-/*
- *    Copyright 2017, Optimizely
+/**
+ *
+ *    Copyright 2016, Optimizely and contributors
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

core-api/src/main/java/com/optimizely/ab/UnknownEventTypeException.java

@@ -1,5 +1,6 @@
-/*
- *    Copyright 2017, Optimizely
+/**
+ *
+ *    Copyright 2016, Optimizely and contributors
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

core-api/src/main/java/com/optimizely/ab/UnknownExperimentException.java

@@ -1,5 +1,6 @@
-/*
- *    Copyright 2017, Optimizely
+/**
+ *
+ *    Copyright 2016, Optimizely and contributors
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

core-api/src/main/java/com/optimizely/ab/UnknownLiveVariableException.java

@@ -1,5 +1,6 @@
-/*
- *    Copyright 2017, Optimizely
+/**
+ *
+ *    Copyright 2016, Optimizely and contributors
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

core-api/src/main/java/com/optimizely/ab/annotations/VisibleForTesting.java

@@ -1,5 +1,6 @@
-/*
- *    Copyright 2017, Optimizely
+/**
+ *
+ *    Copyright 2016, Optimizely and contributors
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.

core-api/src/main/java/com/optimizely/ab/bucketing/Bucketer.java

@@ -1,5 +1,6 @@
-/*
- *    Copyright 2017, Optimizely
+/**
+ *
+ *    Copyright 2016, Optimizely and contributors
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -113,17 +114,18 @@ private Variation bucketToVariation(@Nonnull Experiment experiment,
 
         // If a user profile instance is present then check it for a saved variation
         if (userProfile != null) {
-            String variationKey = userProfile.lookup(userId, experimentKey);
-            if (variationKey != null) {
+            String variationId = userProfile.lookup(userId, experimentId);
+            if (variationId != null) {
+                Variation savedVariation = projectConfig
+                    .getExperimentIdMapping()
+                    .get(experimentId)
+                    .getVariationIdToVariationMap()
+                    .get(variationId);
                 logger.info("Returning previously activated variation \"{}\" of experiment \"{}\" "
                             + "for user \"{}\" from user profile.",
-                            variationKey, experimentKey, userId);
+                            savedVariation.getKey(), experimentKey, userId);
                 // A variation is stored for this combined bucket id
-                return projectConfig
-                    .getExperimentIdMapping()
-                    .get(experimentId)
-                    .getVariationKeyToVariationMap()
-                    .get(variationKey);
+                return savedVariation;
             } else {
                 logger.info("No previously activated variation of experiment \"{}\" "
                             + "for user \"{}\" found in user profile.",
@@ -141,18 +143,18 @@ private Variation bucketToVariation(@Nonnull Experiment experiment,
         if (bucketedVariationId != null) {
             Variation bucketedVariation = experiment.getVariationIdToVariationMap().get(bucketedVariationId);
             String variationKey = bucketedVariation.getKey();
-                logger.info("User \"{}\" is in variation \"{}\" of experiment \"{}\".", userId, variationKey,
+            logger.info("User \"{}\" is in variation \"{}\" of experiment \"{}\".", userId, variationKey,
                         experimentKey);
 
             // If a user profile is present give it a variation to store
             if (userProfile != null) {
-                boolean saved = userProfile.save(userId, experiment.getKey(), variationKey);
+                boolean saved = userProfile.save(userId, experimentId, bucketedVariationId);
                 if (saved) {
                     logger.info("Saved variation \"{}\" of experiment \"{}\" for user \"{}\".",
-                                variationKey, experimentKey, userId);
+                                bucketedVariationId, experimentId, userId);
                 } else {
                     logger.warn("Failed to save variation \"{}\" of experiment \"{}\" for user \"{}\".",
-                                variationKey, experimentKey, userId);
+                                bucketedVariationId, experimentId, userId);
                 }
             }
 
@@ -236,10 +238,10 @@ public void cleanUserProfiles() {
             Map<String, Map<String,String>> records = userProfile.getAllRecords();
             if (records != null) {
                 for (Map.Entry<String,Map<String,String>> record : records.entrySet()) {
-                    for (String experimentKey : record.getValue().keySet()) {
-                        Experiment experiment = projectConfig.getExperimentKeyMapping().get(experimentKey);
+                    for (String experimentId : record.getValue().keySet()) {
+                        Experiment experiment = projectConfig.getExperimentIdMapping().get(experimentId);
                         if (experiment == null || !experiment.isRunning()) {
-                            userProfile.remove(record.getKey(), experimentKey);
+                            userProfile.remove(record.getKey(), experimentId);
                         }
                     }
                 }