Merge pull request #35 from optimizely/mng/rename-user-profile

Rename UserExperimentRecord to UserProfile.

Author: mikeproeng37

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

@@ -18,7 +18,7 @@
 
 import com.optimizely.ab.annotations.VisibleForTesting;
 import com.optimizely.ab.bucketing.Bucketer;
-import com.optimizely.ab.bucketing.UserExperimentRecord;
+import com.optimizely.ab.bucketing.UserProfile;
 import com.optimizely.ab.config.Attribute;
 import com.optimizely.ab.config.EventType;
 import com.optimizely.ab.config.Experiment;
@@ -102,7 +102,7 @@ private Optimizely(@Nonnull ProjectConfig projectConfig,
 
     // Do work here that should be done once per Optimizely lifecycle
     @VisibleForTesting void initialize() {
-        bucketer.cleanUserExperimentRecords();
+        bucketer.cleanUserProfiles();
     }
 
     //======== activate calls ========//
@@ -439,7 +439,7 @@ public static class Builder {
 
         private String datafile;
         private Bucketer bucketer;
-        private UserExperimentRecord userExperimentRecord;
+        private UserProfile userProfile;
         private ErrorHandler errorHandler;
         private EventHandler eventHandler;
         private EventBuilder eventBuilder;
@@ -458,8 +458,8 @@ public Builder withErrorHandler(ErrorHandler errorHandler) {
             return this;
         }
 
-        public Builder withUserExperimentRecord(UserExperimentRecord userExperimentRecord) {
-            this.userExperimentRecord = userExperimentRecord;
+        public Builder withUserProfile(UserProfile userProfile) {
+            this.userProfile = userProfile;
             return this;
         }
 
@@ -496,7 +496,7 @@ public Optimizely build() throws ConfigParseException {
 
             // use the default bucketer and event builder, if no overrides were provided
             if (bucketer == null) {
-                bucketer = new Bucketer(projectConfig, userExperimentRecord);
+                bucketer = new Bucketer(projectConfig, userProfile);
             }
 
             if (clientEngine == null) {

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

@@ -47,7 +47,7 @@ public class Bucketer {
 
     private final ProjectConfig projectConfig;
 
-    @Nullable private final UserExperimentRecord userExperimentRecord;
+    @Nullable private final UserProfile userProfile;
 
     private static final Logger logger = LoggerFactory.getLogger(Bucketer.class);
 
@@ -63,9 +63,9 @@ public Bucketer(ProjectConfig projectConfig) {
         this(projectConfig, null);
     }
 
-    public Bucketer(ProjectConfig projectConfig, @Nullable UserExperimentRecord userExperimentRecord) {
+    public Bucketer(ProjectConfig projectConfig, @Nullable UserProfile userProfile) {
         this.projectConfig = projectConfig;
-        this.userExperimentRecord = userExperimentRecord;
+        this.userProfile = userProfile;
     }
 
     private String bucketToEntity(int bucketValue, List<TrafficAllocation> trafficAllocations) {
@@ -112,12 +112,12 @@ private Variation bucketToVariation(@Nonnull Experiment experiment,
         String experimentKey = experiment.getKey();
         String combinedBucketId = userId + experimentId;
 
-        // If a user experiment record instance is present then check it for a saved variation
-        if (userExperimentRecord != null) {
-            String variationKey = userExperimentRecord.lookup(userId, experimentKey);
+        // 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) {
                 logger.info("Returning previously activated variation \"{}\" of experiment \"{}\" "
-                            + "for user \"{}\" from user experiment record.",
+                            + "for user \"{}\" from user profile.",
                             variationKey, experimentKey, userId);
                 // A variation is stored for this combined bucket id
                 return projectConfig
@@ -127,7 +127,7 @@ private Variation bucketToVariation(@Nonnull Experiment experiment,
                     .get(variationKey);
             } else {
                 logger.info("No previously activated variation of experiment \"{}\" "
-                            + "for user \"{}\" found in user experiment record.",
+                            + "for user \"{}\" found in user profile.",
                             experimentKey, userId);
             }
         }
@@ -145,9 +145,9 @@ private Variation bucketToVariation(@Nonnull Experiment experiment,
                 logger.info("User \"{}\" is in variation \"{}\" of experiment \"{}\".", userId, variationKey,
                         experimentKey);
 
-            // If a user experiment record is present give it a variation to store
-            if (userExperimentRecord != null) {
-                boolean saved = userExperimentRecord.save(userId, experiment.getKey(), variationKey);
+            // If a user profile is present give it a variation to store
+            if (userProfile != null) {
+                boolean saved = userProfile.save(userId, experiment.getKey(), variationKey);
                 if (saved) {
                     logger.info("Saved variation \"{}\" of experiment \"{}\" for user \"{}\".",
                                 variationKey, experimentKey, userId);
@@ -224,23 +224,23 @@ int generateBucketValue(int hashCode) {
     }
 
     @Nullable
-    public UserExperimentRecord getUserExperimentRecord() {
-        return userExperimentRecord;
+    public UserProfile getUserProfile() {
+        return userProfile;
     }
 
     /**
-     * Gives implementations of {@link UserExperimentRecord} a chance to remove records
+     * Gives implementations of {@link UserProfile} a chance to remove records
      * of experiments that are deleted or not running.
      */
-    public void cleanUserExperimentRecords() {
-        if (userExperimentRecord != null) {
-            Map<String, Map<String,String>> records = userExperimentRecord.getAllRecords();
+    public void cleanUserProfiles() {
+        if (userProfile != null) {
+            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);
                         if (experiment == null || !experiment.isRunning()) {
-                            userExperimentRecord.remove(record.getKey(), experimentKey);
+                            userProfile.remove(record.getKey(), experimentKey);
                         }
                     }
                 }

core-api/src/main/java/com/optimizely/ab/bucketing/UserExperimentRecord.java renamed to core-api/src/main/java/com/optimizely/ab/bucketing/UserProfile.java

@@ -25,7 +25,7 @@
  * user experience after changing traffic allocations.  Also, this interface gives users
  * a hook to keep track of activation history.
  */
-public interface UserExperimentRecord {
+public interface UserProfile {
 
     /**
      * Called when implementors should save an activation
@@ -47,7 +47,7 @@ public interface UserExperimentRecord {
     String lookup(String userId, String experimentKey);
 
     /**
-     * Called when user experiment record should be removed
+     * Called when user profile should be removed
      *
      * Records should be removed when an experiment is not running or when an experiment has been
      * deleted.

core-api/src/test/java/com/optimizely/ab/OptimizelyBuilderTest.java

@@ -16,7 +16,7 @@
  */
 package com.optimizely.ab;
 
-import com.optimizely.ab.bucketing.UserExperimentRecord;
+import com.optimizely.ab.bucketing.UserProfile;
 import com.optimizely.ab.config.ProjectConfigTestUtils;
 import com.optimizely.ab.config.parser.ConfigParseException;
 import com.optimizely.ab.error.ErrorHandler;
@@ -102,13 +102,13 @@ public void withDefaultErrorHandler() throws Exception {
     }
 
     @Test
-    public void withUserExperimentRecord() throws Exception {
-        UserExperimentRecord userExperimentRecord = mock(UserExperimentRecord.class);
+    public void withUserProfile() throws Exception {
+        UserProfile userProfile = mock(UserProfile.class);
         Optimizely optimizelyClient = Optimizely.builder(validConfigJsonV2(), mockEventHandler)
-            .withUserExperimentRecord(userExperimentRecord)
+            .withUserProfile(userProfile)
             .build();
 
-        assertThat(optimizelyClient.bucketer.getUserExperimentRecord(), is(userExperimentRecord));
+        assertThat(optimizelyClient.bucketer.getUserProfile(), is(userProfile));
     }
 
     @Test

core-api/src/test/java/com/optimizely/ab/OptimizelyTestV1.java

@@ -159,7 +159,7 @@ public void initializationOccursForBucketerWhenBuildingOptly() throws Exception
             .withErrorHandler(mockErrorHandler)
             .build();
 
-        verify(mockBucketer).cleanUserExperimentRecords();
+        verify(mockBucketer).cleanUserProfiles();
     }
 
     /**

core-api/src/test/java/com/optimizely/ab/OptimizelyTestV2.java

@@ -31,10 +31,8 @@
 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.EventBuilderV2;
-import com.optimizely.ab.event.internal.payload.Event.ClientEngine;
 import com.optimizely.ab.internal.LogbackVerifier;
 import com.optimizely.ab.internal.ProjectValidationUtils;
 
@@ -161,7 +159,7 @@ public void initializationOccursForBucketerWhenBuildingOptly() throws Exception
                 .withErrorHandler(mockErrorHandler)
                 .build();
 
-        verify(mockBucketer).cleanUserExperimentRecords();
+        verify(mockBucketer).cleanUserProfiles();
     }
 
     /**