Merge pull request #43 from optimizely/josh.wang/user_profile/check_sticky_bucketing

Sticky Bucketing

Author: wangjoshuah

OptimizelySDKCore/OptimizelySDKCore/OPTLYLoggerMessages.h

@@ -122,6 +122,8 @@ extern NSString *const OPTLYLoggerMessagesDataStoreDatabaseGetNumberEventsTVOSWa
 extern NSString *const OPTLYLoggerMessagesDataStoreDatabaseRemoveTVOSWarning;
 
 // ---- User Profile ----
+// warning
+extern NSString *const OPTLYLoggerMessagesUserProfileVariationNoLongerInDatafile;
 // Debug
 extern NSString *const OPTLYLoggerMessagesUserProfileVariation;
 extern NSString *const OPTLYLoggerMessagesUserProfileNoVariation;

OptimizelySDKCore/OptimizelySDKCore/OPTLYLoggerMessages.m

@@ -122,6 +122,8 @@
 NSString *const OPTLYLoggerMessagesDataStoreDatabaseRemoveTVOSWarning = @"[DATABASE] tvOS can only remove data from cache> Number of events: %ld, eventType: %ld.";
 
 // ---- User Profile ----
+//warning
+NSString *const OPTLYLoggerMessagesUserProfileVariationNoLongerInDatafile = @"Variation %@ for experiment %@ no longer found in datafile.";
 // Debug
 NSString *const OPTLYLoggerMessagesUserProfileVariation = @"Variation %@ for user %@, experiment %@ found.";
 NSString *const OPTLYLoggerMessagesUserProfileNoVariation = @"Variation for user %@, experiment %@ not found.";

OptimizelySDKCore/OptimizelySDKCore/Optimizely.m

@@ -28,6 +28,7 @@
 #import "OPTLYExperiment.h"
 #import "OPTLYLogger.h"
 #import "OPTLYProjectConfig.h"
+#import "OPTLYUserProfile.h"
 #import "OPTLYValidator.h"
 #import "OPTLYVariable.h"
 #import "OPTLYVariation.h"
@@ -141,11 +142,29 @@ - (OPTLYVariation *)getVariationForExperiment:(NSString *)experimentKey
                                        userId:(NSString *)userId
                                    attributes:(NSDictionary<NSString *,NSString *> *)attributes
 {
+    if (self.userProfile != nil) {
+        NSString *storedVariationKey = [self.userProfile getVariationForUser:userId experiment:experimentKey];
+        if (storedVariationKey != nil) {
+            OPTLYVariation *storedVariation = [[self.config getExperimentForKey:experimentKey]
+                                               getVariationForVariationKey:storedVariationKey];
+            if (storedVariation != nil) {
+                return storedVariation;
+            }
+            else { // stored variation is no longer in datafile
+                [self.userProfile removeUser:userId experiment:experimentKey];
+                [self.logger logMessage:[NSString stringWithFormat:OPTLYLoggerMessagesUserProfileVariationNoLongerInDatafile, storedVariationKey, experimentKey]
+                              withLevel:OptimizelyLogLevelWarning];
+            }
+        }
+    }
     OPTLYVariation *bucketedVariation = nil;
     bucketedVariation = [self.config getVariationForExperiment:experimentKey
                                                         userId:userId
                                                     attributes:attributes
                                                       bucketer:self.bucketer];
+    [self.userProfile saveUser:userId
+                experiment:experimentKey
+                 variation:bucketedVariation.variationKey];
     return bucketedVariation;
 }
 

OptimizelySDKCore/OptimizelySDKCore/OptimizelySDKCore.h

@@ -17,6 +17,7 @@
 #import "Optimizely.h"
 #import "OPTLYBucketer.h"
 #import "OPTLYBuilder.h"
+#import "OPTLYDatafileManager.h"
 #import "OPTLYErrorHandler.h"
 #import "OPTLYErrorHandlerMessages.h"
 #import "OPTLYEventBuilder.h"

OptimizelySDKShared/OptimizelySDKShared/OPTLYClientBuilder.h

@@ -17,7 +17,7 @@
 #import <Foundation/Foundation.h>
 
 @class Optimizely, OPTLYProjectConfig, OPTLYBucketer, OPTLYEventBuilder, OPTLYEventBuilderDefault;
-@protocol OPTLYErrorHandler, OPTLYEventBuilder, OPTLYEventDispatcher, OPTLYLogger;
+@protocol OPTLYErrorHandler, OPTLYEventBuilder, OPTLYEventDispatcher, OPTLYLogger, OPTLYUserProfile;
 
 /**
  * This class contains the informaation on how your Optimizely Client instance will be built.
@@ -39,6 +39,8 @@ typedef void (^OPTLYClientBuilderBlock)(OPTLYClientBuilder * _Nonnull builder);
 @property (nonatomic, readwrite, strong, nullable) id<OPTLYEventDispatcher> eventDispatcher;
 /// The logger is by default set to one that is created by Optimizely. This default logger can be overridden by any object that conforms to the OPTLYLogger protocol.
 @property (nonatomic, readwrite, strong, nullable) id<OPTLYLogger> logger;
+/// User profile to be used by the Optimizely instance to store user-specific data.
+@property (nonatomic, readwrite, strong, nullable) id<OPTLYUserProfile> userProfile;
 
 /// Create an Optimizely Client object.
 + (nonnull instancetype)builderWithBlock:(nonnull OPTLYClientBuilderBlock)block;

OptimizelySDKShared/OptimizelySDKShared/OPTLYClientBuilder.m

@@ -37,6 +37,7 @@ - (id)initWithBlock:(OPTLYClientBuilderBlock)block {
             builder.errorHandler = _errorHandler;
             builder.eventDispatcher = _eventDispatcher;
             builder.logger = _logger;
+            builder.userProfile = _userProfile;
         }];
         _logger = _optimizely.logger;
         if (!_logger) {

OptimizelySDKShared/OptimizelySDKShared/OPTLYManager.h

@@ -33,6 +33,8 @@
 @property (nonatomic, readonly, strong, nullable) id<OPTLYEventDispatcher> eventDispatcher;
 /// The logger to be used for the manager, client, and all subcomponents
 @property (nonatomic, readonly, strong, nullable) id<OPTLYLogger> logger;
+/// User profile to be used by the client to store user-specific data.
+@property (nonatomic, readonly, strong, nullable) id<OPTLYUserProfile> userProfile;
 
 /**
  * Init with builder block

OptimizelySDKShared/OptimizelySDKShared/OPTLYManager.m

@@ -47,15 +47,13 @@ - (instancetype)initWithBuilder:(OPTLYManagerBuilder *)builder {
                                  withLevel:OptimizelyLogLevelError];
                 return nil;
             }
-            _projectId = builder.projectId;
             _datafile = builder.datafile;
+            _datafileManager = builder.datafileManager;
             _errorHandler = builder.errorHandler;
             _eventDispatcher = builder.eventDispatcher;
             _logger = builder.logger;
-            // initialize datafile manager
-            _datafileManager = builder.datafileManager;
-            // TODO: Josh W. initialize event dispatcher
-            // TODO: Josh W. initialize user experiment record
+            _projectId = builder.projectId;
+            _userProfile = builder.userProfile;
         }
         return self;
     }
@@ -80,19 +78,15 @@ - (instancetype)initWithBuilder:(OPTLYManagerBuilder *)builder {
 }
 
 - (OPTLYClient *)initializeClient {
-    OPTLYClient *client = [OPTLYClient initWithBuilderBlock:^(OPTLYClientBuilder * _Nonnull builder) {
-        builder.datafile = self.datafile;
-    }];
+    OPTLYClient *client = [self initializeClientWithManagerSettingsAndDatafile:self.datafile];
     if (client.optimizely != nil) {
         self.optimizelyClient = client;
     }
     return client;
 }
 
 - (OPTLYClient *)initializeClientWithDatafile:(NSData *)datafile {
-    OPTLYClient *client = [OPTLYClient initWithBuilderBlock:^(OPTLYClientBuilder * _Nonnull builder) {
-        builder.datafile = datafile;
-    }];
+    OPTLYClient *client = [self initializeClientWithManagerSettingsAndDatafile:datafile];
     if (client.optimizely != nil) {
         self.optimizelyClient = client;
         return client;
@@ -104,11 +98,8 @@ - (OPTLYClient *)initializeClientWithDatafile:(NSData *)datafile {
 
 - (void)initializeClientWithCallback:(void (^)(NSError * _Nullable, OPTLYClient * _Nullable))callback {
     [self.datafileManager downloadDatafile:self.projectId completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
-        OPTLYClient *client = nil;
         if (!error) {
-            client = [OPTLYClient initWithBuilderBlock:^(OPTLYClientBuilder * _Nonnull builder) {
-                builder.datafile = data;
-            }];
+            OPTLYClient *client = [self initializeClientWithManagerSettingsAndDatafile:data];
             if (client.optimizely) {
                 self.optimizelyClient = client;
             }
@@ -117,7 +108,7 @@ - (void)initializeClientWithCallback:(void (^)(NSError * _Nullable, OPTLYClient
         }
 
         if (callback) {
-            callback(error, client);
+            callback(error, self.optimizelyClient);
         }
     }];
 }
@@ -126,4 +117,15 @@ - (OPTLYClient *)getOptimizely {
     return self.optimizelyClient;
 }
 
+- (OPTLYClient *)initializeClientWithManagerSettingsAndDatafile:(NSData *)datafile {
+    OPTLYClient *client = [OPTLYClient initWithBuilderBlock:^(OPTLYClientBuilder * _Nonnull builder) {
+        builder.datafile = datafile;
+        builder.errorHandler = self.errorHandler;
+        builder.eventDispatcher = self.eventDispatcher;
+        builder.logger = self.logger;
+        builder.userProfile = self.userProfile;
+    }];
+    return client;
+}
+
 @end

OptimizelySDKShared/OptimizelySDKShared/OPTLYManagerBuilder.h

@@ -16,7 +16,7 @@
 
 #import <Foundation/Foundation.h>
 
-@protocol OPTLYDatafileManager, OPTLYErrorHandler, OPTLYEventDispatcher, OPTLYLogger;
+@protocol OPTLYDatafileManager, OPTLYErrorHandler, OPTLYEventDispatcher, OPTLYLogger, OPTLYUserProfile;
 @class OPTLYManagerBuilder;
 
 typedef void (^OPTLYManagerBuilderBlock)(OPTLYManagerBuilder * _Nullable builder);
@@ -37,6 +37,8 @@ typedef void (^OPTLYManagerBuilderBlock)(OPTLYManagerBuilder * _Nullable builder
 @property (nonatomic, readwrite, strong, nullable) id<OPTLYEventDispatcher> eventDispatcher;
 /// The logger to be used for the manager, client, and all subcomponents
 @property (nonatomic, readwrite, strong, nullable) id<OPTLYLogger> logger;
+/// User profile to be used by the client to store user-specific data.
+@property (nonatomic, readwrite, strong, nullable) id<OPTLYUserProfile> userProfile;
 
 /// Create the Optimizely Manager object.
 + (nullable instancetype)builderWithBlock:(nonnull OPTLYManagerBuilderBlock)block;

OptimizelySDKShared/OptimizelySDKSharedTests/OPTLYManagerTest.m

@@ -16,7 +16,8 @@
 
 #import <XCTest/XCTest.h>
 #import <OHHTTPStubs/OHHTTPStubs.h>
-#import <OptimizelySDKCore/OPTLYDatafileManager.h>
+
+#import <OptimizelySDKCore/OptimizelySDKCore.h>
 #import <OptimizelySDKCore/OPTLYNetworkService.h>
 #import <OptimizelySDKCore/OPTLYProjectConfig.h>
 #import "OPTLYClient.h"
@@ -49,6 +50,39 @@ - (void)tearDown {
     self.alternateDatafile = nil;
 }
 
+- (void)testInitializationSettingsGetPropogatedToClientAndCore {
+    // initialize manager settings
+    id<OPTLYDatafileManager> datafileManager = [[OPTLYDatafileManagerNoOp alloc] init];
+    id<OPTLYErrorHandler> errorHandler = [[OPTLYErrorHandlerNoOp alloc] init];
+    id<OPTLYEventDispatcher> eventDispatcher = [[OPTLYEventDispatcherDefault alloc] init];
+    id<OPTLYLogger> logger = [[OPTLYLoggerDefault alloc] initWithLogLevel:OptimizelyLogLevelOff];
+    id<OPTLYUserProfile> userProfile = [[OPTLYUserProfileNoOp alloc] init];
+    
+    // initialize Manager
+    OPTLYManager *manager = [OPTLYManager initWithBuilderBlock:^(OPTLYManagerBuilder * _Nullable builder) {
+        builder.datafile = self.defaultDatafile;
+        builder.datafileManager = datafileManager;
+        builder.errorHandler = errorHandler;
+        builder.eventDispatcher = eventDispatcher;
+        builder.logger = logger;
+        builder.projectId = kProjectId;
+        builder.userProfile = userProfile;
+    }];
+    XCTAssertEqual(manager.datafileManager, datafileManager);
+    
+    // get the client
+    OPTLYClient *client = [manager initializeClient];
+    XCTAssertEqual(client.logger, logger);
+    
+    // check optimizely core has been initialized correctly
+    Optimizely *optimizely = client.optimizely;
+    XCTAssertNotNil(optimizely);
+    XCTAssertEqual(optimizely.errorHandler, errorHandler);
+    XCTAssertEqual(optimizely.eventDispatcher, eventDispatcher);
+    XCTAssertEqual(optimizely.logger, logger);
+    XCTAssertEqual(optimizely.userProfile, userProfile);
+}
+
 - (void)testInitializeClientWithoutDatafileReturnsDummy {
     // initialize manager without datafile
     OPTLYManager *manager = [OPTLYManager initWithBuilderBlock:^(OPTLYManagerBuilder * _Nullable builder) {