Added a timer to the datafile manager to periodically download the datafile. Also moved the datafile manager protocol to core as the core should have a basic datafile downloader (the network classes will be moved to core as well in another commit.). Cleaned up the headers and was being more deligent about alphabetizing imports and initializing modules.

Author: alda-optimizely

OptimizelySDKCore/OptimizelySDKCore.xcodeproj/project.pbxproj

@@ -218,6 +218,10 @@
 		EA87A02B1DE31453002E9EF7 /* OPTLYUserProfile.h in Headers */ = {isa = PBXBuildFile; fileRef = EA87A0281DE31453002E9EF7 /* OPTLYUserProfile.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		EA87A02C1DE31453002E9EF7 /* OPTLYUserProfile.m in Sources */ = {isa = PBXBuildFile; fileRef = EA87A0291DE31453002E9EF7 /* OPTLYUserProfile.m */; };
 		EA87A02D1DE31453002E9EF7 /* OPTLYUserProfile.m in Sources */ = {isa = PBXBuildFile; fileRef = EA87A0291DE31453002E9EF7 /* OPTLYUserProfile.m */; };
+		EA8FD0FC1DEB12A400D950AD /* OPTLYDatafileManager.h in Headers */ = {isa = PBXBuildFile; fileRef = EA8FD0FA1DEB12A400D950AD /* OPTLYDatafileManager.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		EA8FD0FD1DEB12A400D950AD /* OPTLYDatafileManager.h in Headers */ = {isa = PBXBuildFile; fileRef = EA8FD0FA1DEB12A400D950AD /* OPTLYDatafileManager.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		EA8FD0FE1DEB12A400D950AD /* OPTLYDatafileManager.m in Sources */ = {isa = PBXBuildFile; fileRef = EA8FD0FB1DEB12A400D950AD /* OPTLYDatafileManager.m */; };
+		EA8FD0FF1DEB12A400D950AD /* OPTLYDatafileManager.m in Sources */ = {isa = PBXBuildFile; fileRef = EA8FD0FB1DEB12A400D950AD /* OPTLYDatafileManager.m */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -369,6 +373,8 @@
 		EA5249631DC7B69A00AF6685 /* OPTLYEventDispatcher.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OPTLYEventDispatcher.m; sourceTree = "<group>"; };
 		EA87A0281DE31453002E9EF7 /* OPTLYUserProfile.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = OPTLYUserProfile.h; path = OptimizelySDKCore/OPTLYUserProfile.h; sourceTree = "<group>"; };
 		EA87A0291DE31453002E9EF7 /* OPTLYUserProfile.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = OPTLYUserProfile.m; path = OptimizelySDKCore/OPTLYUserProfile.m; sourceTree = "<group>"; };
+		EA8FD0FA1DEB12A400D950AD /* OPTLYDatafileManager.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OPTLYDatafileManager.h; sourceTree = "<group>"; };
+		EA8FD0FB1DEB12A400D950AD /* OPTLYDatafileManager.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OPTLYDatafileManager.m; sourceTree = "<group>"; };
 		F5B1C4BBC7682A657C92ABD3 /* Pods_OptimizelySDKCore.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_OptimizelySDKCore.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		F6CC17F155793CF43AB7A3D9 /* Pods-OptimizelySDKCoreTVOS.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-OptimizelySDKCoreTVOS.debug.xcconfig"; path = "../Pods/Target Support Files/Pods-OptimizelySDKCoreTVOS/Pods-OptimizelySDKCoreTVOS.debug.xcconfig"; sourceTree = "<group>"; };
 /* End PBXFileReference section */
@@ -627,9 +633,10 @@
 				EA2FA83F1DC5E11F00B1D81B /* Bucketer */,
 				EA2FA90B1DC6F17400B1D81B /* Builder */,
 				EA2FA8401DC5E13A00B1D81B /* Data Models */,
+				EA8FD0F91DEB120C00D950AD /* Datafile Manager */,
 				EA2FA8411DC5E14700B1D81B /* Error Handler */,
 				EA2FA8421DC5E15700B1D81B /* Event Builder */,
-				EA5249611DC7B64C00AF6685 /* EventDispatcher */,
+				EA5249611DC7B64C00AF6685 /* Event Dispatcher */,
 				EA87A0271DE3142A002E9EF7 /* UserProfile */,
 				EA2FA8451DC5E1A300B1D81B /* Loggers */,
 				EA2FA83D1DC5E0E900B1D81B /* Utilities */,
@@ -661,13 +668,13 @@
 			path = OptimizelySDKCoreTests;
 			sourceTree = "<group>";
 		};
-		EA5249611DC7B64C00AF6685 /* EventDispatcher */ = {
+		EA5249611DC7B64C00AF6685 /* Event Dispatcher */ = {
 			isa = PBXGroup;
 			children = (
 				EA5249621DC7B69A00AF6685 /* OPTLYEventDispatcher.h */,
 				EA5249631DC7B69A00AF6685 /* OPTLYEventDispatcher.m */,
 			);
-			name = EventDispatcher;
+			name = "Event Dispatcher";
 			sourceTree = "<group>";
 		};
 		EA87A0271DE3142A002E9EF7 /* UserProfile */ = {
@@ -680,6 +687,15 @@
 			path = ..;
 			sourceTree = "<group>";
 		};
+		EA8FD0F91DEB120C00D950AD /* Datafile Manager */ = {
+			isa = PBXGroup;
+			children = (
+				EA8FD0FA1DEB12A400D950AD /* OPTLYDatafileManager.h */,
+				EA8FD0FB1DEB12A400D950AD /* OPTLYDatafileManager.m */,
+			);
+			name = "Datafile Manager";
+			sourceTree = "<group>";
+		};
 /* End PBXGroup section */
 
 /* Begin PBXHeadersBuildPhase section */
@@ -705,6 +721,7 @@
 				EA2C242D1DE6A2470063ADA0 /* OPTLYProjectConfigBuilder.h in Headers */,
 				EA87A02A1DE31453002E9EF7 /* OPTLYUserProfile.h in Headers */,
 				EA064BC71DD3FC8800DF7537 /* OPTLYQueue.h in Headers */,
+				EA8FD0FC1DEB12A400D950AD /* OPTLYDatafileManager.h in Headers */,
 				EA2FAB791DC6F5F400B1D81B /* OPTLYMacros.h in Headers */,
 				EA2FAAF41DC6F57200B1D81B /* OPTLYEventTicket.h in Headers */,
 				EA2FAB121DC6F57200B1D81B /* OPTLYTrafficAllocation.h in Headers */,
@@ -753,6 +770,7 @@
 				EA2FAB741DC6F5F400B1D81B /* OPTLYLog.h in Headers */,
 				EA87A02B1DE31453002E9EF7 /* OPTLYUserProfile.h in Headers */,
 				EA064BC81DD3FC8800DF7537 /* OPTLYQueue.h in Headers */,
+				EA8FD0FD1DEB12A400D950AD /* OPTLYDatafileManager.h in Headers */,
 				EA2C242E1DE6A2470063ADA0 /* OPTLYProjectConfigBuilder.h in Headers */,
 				EA2FAC7B1DC70EBC00B1D81B /* murmur3.h in Headers */,
 				EA2FAB7A1DC6F5F400B1D81B /* OPTLYMacros.h in Headers */,
@@ -1153,6 +1171,7 @@
 				EA2FAC261DC6FFC600B1D81B /* OPTLYLoggerMessages.m in Sources */,
 				EA2FAC291DC6FFC600B1D81B /* OPTLYLog.m in Sources */,
 				EA2C24351DE7887C0063ADA0 /* OPTLYVariationVariable.m in Sources */,
+				EA8FD0FE1DEB12A400D950AD /* OPTLYDatafileManager.m in Sources */,
 				EA2FAC2A1DC6FFC600B1D81B /* OPTLYValidator.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
@@ -1221,6 +1240,7 @@
 				EA2FAC011DC6FFA100B1D81B /* OPTLYLoggerMessages.m in Sources */,
 				EA2FAC041DC6FFA100B1D81B /* OPTLYLog.m in Sources */,
 				EA2C24361DE7887C0063ADA0 /* OPTLYVariationVariable.m in Sources */,
+				EA8FD0FF1DEB12A400D950AD /* OPTLYDatafileManager.m in Sources */,
 				EA2FAC051DC6FFA100B1D81B /* OPTLYValidator.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;

OptimizelySDKCore/OptimizelySDKCore/OPTLYBuilder.h

@@ -17,7 +17,7 @@
 #import <Foundation/Foundation.h>
 
 @class OPTLYBucketer, OPTLYEventBuilder, OPTLYEventBuilderDefault, OPTLYProjectConfig;
-@protocol OPTLYErrorHandler, OPTLYEventBuilder, OPTLYEventDispatcher, OPTLYLogger, OPTLYProjectConfig, OPTLYUserProfile;
+@protocol OPTLYDatafileManager, OPTLYErrorHandler, OPTLYEventBuilder, OPTLYEventDispatcher, OPTLYLogger, OPTLYUserProfile;
 
 /**
  * This class contains the information on how your Optimizely instance will be built.
@@ -46,6 +46,8 @@ typedef void (^OPTLYBuilderBlock)(OPTLYBuilder * _Nullable builder);
 @property (nonatomic, readwrite, strong, nullable) id<OPTLYLogger> logger;
 /// User profile stores user-specific data, like bucketing.
 @property (nonatomic, readwrite, strong, nullable) id<OPTLYUserProfile> userProfile;
+/// The datafile manager that will download the datafile for the manager
+@property (nonatomic, readwrite, strong, nullable) id<OPTLYDatafileManager> datafileManager;
 
 /// Create an Optimizely Builder object.
 + (nullable instancetype)builderWithBlock:(nonnull OPTLYBuilderBlock)block;

OptimizelySDKCore/OptimizelySDKCore/OPTLYBuilder.m

@@ -16,6 +16,7 @@
 
 #import "OPTLYBucketer.h"
 #import "OPTLYBuilder.h"
+#import "OPTLYDatafileManager.h"
 #import "OPTLYErrorHandler.h"
 #import "OPTLYEventBuilder.h"
 #import "OPTLYEventDispatcher.h"
@@ -85,6 +86,13 @@ - (NSData *)datafile {
     return _datafile;
 }
 
+- (id<OPTLYDatafileManager>)datafileManager {
+    if (!_datafileManager) {
+        _datafileManager = [[OPTLYDatafileManagerNoOp alloc] init];
+    }
+    return _datafileManager;
+}
+
 - (id<OPTLYErrorHandler>)errorHandler {
     if (!_errorHandler) {
         _errorHandler = [[OPTLYErrorHandlerNoOp alloc] init];

OptimizelySDKShared/OptimizelySDKShared/OPTLYDatafileManager.h renamed to OptimizelySDKCore/OptimizelySDKCore/OPTLYDatafileManager.h

@@ -15,12 +15,6 @@
  ***************************************************************************/
 
 #import <Foundation/Foundation.h>
-#import <OptimizelySDKCore/OPTLYErrorHandler.h>
-#import <OptimizelySDKCore/OPTLYLogger.h>
-#import <OptimizelySDKShared/OPTLYHTTPRequestManager.h>
-
-
-@protocol OPTLYErrorHandler, OPTLYLogger;
 
 @protocol OPTLYDatafileManager <NSObject>
 
@@ -30,7 +24,7 @@
  * @param completion Completion handler.
  */
 - (void)downloadDatafile:(nonnull NSString *)projectId
-       completionHandler:(nullable OPTLYHTTPRequestManagerResponse)completion;
+       completionHandler:(nullable void (^)(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error))completion;
 
 @end
 

OptimizelySDKShared/OptimizelySDKShared/OPTLYDatafileManager.m renamed to OptimizelySDKCore/OptimizelySDKCore/OPTLYDatafileManager.m

@@ -32,7 +32,8 @@ + (BOOL)conformsToOPTLYDatafileManagerProtocol:(Class)instanceClass {
 
 @implementation OPTLYDatafileManagerNoOp
 
-- (void)downloadDatafile:(NSString *)projectId completionHandler:(OPTLYHTTPRequestManagerResponse)completion {
+- (void)downloadDatafile:(nonnull NSString *)projectId
+       completionHandler:(nullable void (^)(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error))completion {
     completion(nil, nil, nil);
     return;
 }

OptimizelySDKCore/OptimizelySDKCore/Optimizely.h

@@ -18,7 +18,7 @@
 #import "OPTLYBuilder.h"
 
 @class OPTLYProjectConfig, OPTLYVariation;
-@protocol OPTLYBucketer, OPTLYErrorHandler, OPTLYEventBuilder, OPTLYEventDispatcher, OPTLYLogger;
+@protocol OPTLYBucketer, OPTLYDatafileManager, OPTLYErrorHandler, OPTLYEventBuilder, OPTLYEventDispatcher, OPTLYLogger;
 
 // ---- Live Variable Getter Errors ----
 
@@ -220,8 +220,9 @@ typedef NS_ENUM(NSInteger, OPTLYLiveVariableError) {
  */
 @interface Optimizely : NSObject <Optimizely>
 
-@property (nonatomic, strong, readonly, nullable) OPTLYProjectConfig *config;
 @property (nonatomic, strong, readonly, nullable) id<OPTLYBucketer> bucketer;
+@property (nonatomic, strong, readonly, nullable) OPTLYProjectConfig *config;
+@property (nonatomic, strong, readonly, nullable) id<OPTLYDatafileManager> datafileManager;
 @property (nonatomic, strong, readonly, nullable) id<OPTLYErrorHandler> errorHandler;
 @property (nonatomic, strong, readonly, nullable) id<OPTLYEventBuilder> eventBuilder;
 @property (nonatomic, strong, readonly, nullable) id<OPTLYEventDispatcher> eventDispatcher;

OptimizelySDKCore/OptimizelySDKCore/Optimizely.m

@@ -51,11 +51,12 @@ - (instancetype)initWithBuilder:(OPTLYBuilder *)builder {
     if (builder != nil) {
         self = [super init];
         if (self != nil) {
-            _config = builder.config;
             _bucketer = builder.bucketer;
-            _errorHandler = builder.errorHandler;
+            _config = builder.config;
+            _datafileManager = builder.datafileManager;
             _eventBuilder = builder.eventBuilder;
             _eventDispatcher = builder.eventDispatcher;
+            _errorHandler = builder.errorHandler;
             _logger = builder.logger;
             _userProfile = builder.userProfile;
         }

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"

OptimizelySDKCore/OptimizelySDKCoreTests/OPTLYBuilderTest.m

@@ -15,12 +15,12 @@
  ***************************************************************************/
 
 #import <XCTest/XCTest.h>
-#import "OPTLYTestHelper.h"
-
 #import "Optimizely.h"
+#import "OPTLYDatafileManager.h"
 #import "OPTLYErrorHandler.h"
 #import "OPTLYEventDispatcher.h"
 #import "OPTLYLogger.h"
+#import "OPTLYTestHelper.h"
 
 // static data from datafile
 static NSString * const kDataModelDatafileName = @"datafile_6372300739";
@@ -45,6 +45,7 @@ - (void)testBuilderBuildsDefaults {
     XCTAssertNotNil(optimizely);
     XCTAssertNotNil(optimizely.bucketer);
     XCTAssertNotNil(optimizely.config);
+    XCTAssertNotNil(optimizely.datafileManager);
     XCTAssertNotNil(optimizely.errorHandler);
     XCTAssertNotNil(optimizely.eventBuilder);
     XCTAssertNotNil(optimizely.eventDispatcher);
@@ -108,6 +109,21 @@ - (void)testBuilderCanAssignLogger {
     XCTAssertEqual(logger, customOptimizely.logger, @"Should be the same object with custom builder");
 }
 
+- (void)testBuilderCanAssignDatafileManager {
+    NSData *datafile = [OPTLYTestHelper loadJSONDatafileIntoDataObject:kDataModelDatafileName];
+    
+    id<OPTLYDatafileManager> datafileManager = [OPTLYDatafileManagerNoOp new];
+    
+    Optimizely *customOptimizely = [Optimizely initWithBuilderBlock:^(OPTLYBuilder *builder) {
+        builder.datafile = datafile;
+        builder.datafileManager = datafileManager;
+    }];
+    
+    XCTAssertNotNil(customOptimizely);
+    XCTAssertNotNil(customOptimizely.datafileManager);
+    XCTAssertEqualObjects(datafileManager, customOptimizely.datafileManager, @"Should be same object with custom Builder");
+}
+
 - (void)testInitializationWithoutBuilder {
     Optimizely *optimizely = [Optimizely initWithBuilderBlock:nil];
     XCTAssertNil(optimizely);

OptimizelySDKDatafileManager/OptimizelySDKDatafileManager/OPTLYDatafileManager.h

@@ -15,13 +15,10 @@
  ***************************************************************************/
 
 #import <Foundation/Foundation.h>
-#import <OptimizelySDKShared/OPTLYDatafileManager.h>
-#import <OptimizelySDKCore/OPTLYErrorHandler.h>
-#import <OptimizelySDKShared/OPTLYHTTPRequestManager.h>
-#import <OptimizelySDKCore/OPTLYLogger.h>
+#import <OptimizelySDKCore/OPTLYDatafileManager.h>
 #import "OPTLYDatafileManagerBuilder.h"
 
-@protocol OPTLYErrorHandler, OPTLYLogger;
+@protocol OPTLYDatafileManager, OPTLYErrorHandler, OPTLYLogger;
 
 @interface OPTLYDatafileManager : NSObject<OPTLYDatafileManager>