put the protocol of OPTLYDatafileManager in Shared SDK and check that whatever is passed to the builder conforms to the manager

Author: wangjoshuah

OptimizelySDKDatafileManager/OptimizelySDKDatafileManager/OPTLYDatafileManager.h

@@ -18,23 +18,12 @@
 #import "OPTLYDatafileManagerBuilder.h"
 #import <OptimizelySDKCore/OPTLYErrorHandler.h>
 #import <OptimizelySDKCore/OPTLYLogger.h>
+#import <OptimizelySDKShared/OPTLYDatafileManager.h>
 #import <OptimizelySDKShared/OPTLYHTTPRequestManager.h>
 
 
 @protocol OPTLYErrorHandler, OPTLYLogger;
 
-@protocol OPTLYDatafileManager <NSObject>
-
-/** 
- * Download the datafile for the project ID
- * @param projectId The project ID of the datafile to request.
- * @param completion Completion handler.
- */
-- (void)downloadDatafile:(nonnull NSString *)projectId
-       completionHandler:(nullable OPTLYHTTPRequestManagerResponse)completion;
-
-@end
-
 @interface OPTLYDatafileManager : NSObject<OPTLYDatafileManager>
 
 /// The time interval to regularly fetch the datafile.

OptimizelySDKShared/OptimizelySDKShared.xcodeproj/project.pbxproj

@@ -39,6 +39,10 @@
 		2DB3D1811DC8181400ECF72E /* OPTLYManagerBuilder.m in Sources */ = {isa = PBXBuildFile; fileRef = 2DB3D17B1DC816D600ECF72E /* OPTLYManagerBuilder.m */; };
 		2DCC50B31DD3CDAB006C9815 /* OPTLYManagerTest.m in Sources */ = {isa = PBXBuildFile; fileRef = 2DCC50B21DD3CDAB006C9815 /* OPTLYManagerTest.m */; };
 		2DCC50B41DD3CDAB006C9815 /* OPTLYManagerTest.m in Sources */ = {isa = PBXBuildFile; fileRef = 2DCC50B21DD3CDAB006C9815 /* OPTLYManagerTest.m */; };
+		2DCC51231DDE3C90006C9815 /* OPTLYDatafileManager.h in Headers */ = {isa = PBXBuildFile; fileRef = 2DCC51221DDE3C90006C9815 /* OPTLYDatafileManager.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		2DCC51241DDE3C90006C9815 /* OPTLYDatafileManager.h in Headers */ = {isa = PBXBuildFile; fileRef = 2DCC51221DDE3C90006C9815 /* OPTLYDatafileManager.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		2DCC51261DDE3CA4006C9815 /* OPTLYDatafileManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 2DCC51251DDE3CA4006C9815 /* OPTLYDatafileManager.m */; };
+		2DCC51271DDE3CA4006C9815 /* OPTLYDatafileManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 2DCC51251DDE3CA4006C9815 /* OPTLYDatafileManager.m */; };
 		5318433267A9188A3D16D3A2 /* Pods_OptimizelySDKSharediOSTests.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 7B9FE2FE02E36C64D6F1F442 /* Pods_OptimizelySDKSharediOSTests.framework */; };
 		5A8753FCE65715A7A353C14C /* Pods_OptimizelySDKSharediOS.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 09704701D3CB97F3D3F408E3 /* Pods_OptimizelySDKSharediOS.framework */; };
 		6433BEBF70E8BE35397D1778 /* Pods_OptimizelySDKSharedTVOS.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 5EDD2F1182FB354ABC0E04A1 /* Pods_OptimizelySDKSharedTVOS.framework */; };
@@ -161,6 +165,8 @@
 		2DB3D17A1DC816D600ECF72E /* OPTLYManagerBuilder.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OPTLYManagerBuilder.h; sourceTree = "<group>"; };
 		2DB3D17B1DC816D600ECF72E /* OPTLYManagerBuilder.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OPTLYManagerBuilder.m; sourceTree = "<group>"; };
 		2DCC50B21DD3CDAB006C9815 /* OPTLYManagerTest.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OPTLYManagerTest.m; sourceTree = "<group>"; };
+		2DCC51221DDE3C90006C9815 /* OPTLYDatafileManager.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OPTLYDatafileManager.h; sourceTree = "<group>"; };
+		2DCC51251DDE3CA4006C9815 /* OPTLYDatafileManager.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OPTLYDatafileManager.m; sourceTree = "<group>"; };
 		5CF4F1B8D6539A2AE661E1E1 /* Pods-OptimizelySDKSharedTVOS.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-OptimizelySDKSharedTVOS.debug.xcconfig"; path = "../Pods/Target Support Files/Pods-OptimizelySDKSharedTVOS/Pods-OptimizelySDKSharedTVOS.debug.xcconfig"; sourceTree = "<group>"; };
 		5EDD2F1182FB354ABC0E04A1 /* Pods_OptimizelySDKSharedTVOS.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_OptimizelySDKSharedTVOS.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		6042179012EFD11109128C34 /* Pods-OptimizelySDKSharedTVOS.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-OptimizelySDKSharedTVOS.release.xcconfig"; path = "../Pods/Target Support Files/Pods-OptimizelySDKSharedTVOS/Pods-OptimizelySDKSharedTVOS.release.xcconfig"; sourceTree = "<group>"; };
@@ -273,6 +279,15 @@
 			name = TestData;
 			sourceTree = "<group>";
 		};
+		2DCC51211DDE3C74006C9815 /* DatafileManager */ = {
+			isa = PBXGroup;
+			children = (
+				2DCC51221DDE3C90006C9815 /* OPTLYDatafileManager.h */,
+				2DCC51251DDE3CA4006C9815 /* OPTLYDatafileManager.m */,
+			);
+			name = DatafileManager;
+			sourceTree = "<group>";
+		};
 		B770041BA173BC0CC7E9DB5F /* Pods */ = {
 			isa = PBXGroup;
 			children = (
@@ -326,6 +341,7 @@
 				EA3C682C1DC1E68E00C578CA /* OptimizelySDKShared.h */,
 				EA52478F1DC7246C00AF6685 /* Manager */,
 				2D08FB671DCA5A78006CA063 /* Client */,
+				2DCC51211DDE3C74006C9815 /* DatafileManager */,
 				EA5247911DC7248200AF6685 /* DataStore */,
 				EA5247901DC7247500AF6685 /* Network */,
 			);
@@ -420,6 +436,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				2D08FB9F1DCA5FA8006CA063 /* OPTLYClientBuilder.h in Headers */,
+				2DCC51231DDE3C90006C9815 /* OPTLYDatafileManager.h in Headers */,
 				EA5249971DC7D8AD00AF6685 /* OptimizelySDKShared.h in Headers */,
 				2D08FB6B1DCA5A99006CA063 /* OPTLYClient.h in Headers */,
 				EA5247851DC7226400AF6685 /* OPTLYManager.h in Headers */,
@@ -440,6 +457,7 @@
 				2D08FBA01DCA5FA8006CA063 /* OPTLYClientBuilder.h in Headers */,
 				EA52499A1DC7D8B800AF6685 /* OptimizelySDKShared.h in Headers */,
 				2DB3D1801DC8181100ECF72E /* OPTLYManagerBuilder.h in Headers */,
+				2DCC51241DDE3C90006C9815 /* OPTLYDatafileManager.h in Headers */,
 				2D08FB6C1DCA5A99006CA063 /* OPTLYClient.h in Headers */,
 				EA5247861DC7226400AF6685 /* OPTLYManager.h in Headers */,
 				EA5247971DC724AF00AF6685 /* OPTLYHTTPRequestManager.h in Headers */,
@@ -825,6 +843,7 @@
 				EA29D8FF1DCBBE250034A4FE /* OPTLYFileManager.m in Sources */,
 				EA5247981DC724AF00AF6685 /* OPTLYHTTPRequestManager.m in Sources */,
 				EA5247871DC7226400AF6685 /* OPTLYManager.m in Sources */,
+				2DCC51261DDE3CA4006C9815 /* OPTLYDatafileManager.m in Sources */,
 				2D08FB6E1DCA5B3D006CA063 /* OPTLYClient.m in Sources */,
 				2D08FBA21DCA5FB3006CA063 /* OPTLYClientBuilder.m in Sources */,
 				EA52479C1DC724AF00AF6685 /* OPTLYNetworkService.m in Sources */,
@@ -860,6 +879,7 @@
 				2D08FBA31DCA5FB3006CA063 /* OPTLYClientBuilder.m in Sources */,
 				EA52479D1DC724AF00AF6685 /* OPTLYNetworkService.m in Sources */,
 				2DB3D1811DC8181400ECF72E /* OPTLYManagerBuilder.m in Sources */,
+				2DCC51271DDE3CA4006C9815 /* OPTLYDatafileManager.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

OptimizelySDKShared/OptimizelySDKShared/OPTLYDatafileManager.h

@@ -0,0 +1,49 @@
+/****************************************************************************
+ * Copyright 2016, Optimizely, Inc. and contributors                        *
+ *                                                                          *
+ * 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.                                           *
+ ***************************************************************************/
+
+#import <Foundation/Foundation.h>
+#import <OptimizelySDKCore/OPTLYErrorHandler.h>
+#import <OptimizelySDKCore/OPTLYLogger.h>
+#import <OptimizelySDKShared/OPTLYHTTPRequestManager.h>
+
+
+@protocol OPTLYErrorHandler, OPTLYLogger;
+
+@protocol OPTLYDatafileManager <NSObject>
+
+/**
+ * Download the datafile for the project ID
+ * @param projectId The project ID of the datafile to request.
+ * @param completion Completion handler.
+ */
+- (void)downloadDatafile:(nonnull NSString *)projectId
+       completionHandler:(nullable OPTLYHTTPRequestManagerResponse)completion;
+
+@end
+
+@interface OPTLYDatafileManagerUtility : NSObject
+
+/**
+ * Utility method to check if a class conforms to the OPTLYDatafileManager protocol
+ * This method uses compile and run time checks
+ */
++ (BOOL)conformsToOPTLYDatafileManagerProtocol:(nonnull Class)instanceClass;
+
+@end
+
+@interface OPTLYDatafileManagerNoOp : NSObject<OPTLYDatafileManager>
+
+@end

OptimizelySDKShared/OptimizelySDKShared/OPTLYDatafileManager.m

@@ -0,0 +1,40 @@
+/****************************************************************************
+ * Copyright 2016, Optimizely, Inc. and contributors                        *
+ *                                                                          *
+ * 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.                                           *
+ ***************************************************************************/
+
+#import "OPTLYDatafileManager.h"
+
+@implementation OPTLYDatafileManagerUtility
+
++ (BOOL)conformsToOPTLYDatafileManagerProtocol:(Class)instanceClass {
+    // compile time check
+    BOOL validProtocolDeclaration = [instanceClass conformsToProtocol:@protocol(OPTLYDatafileManager)];
+    
+    // runtime check
+    BOOL implementsDownloadDatafileMethod = [instanceClass instancesRespondToSelector:@selector(downloadDatafile:completionHandler:)];
+    
+    return validProtocolDeclaration && implementsDownloadDatafileMethod;
+}
+
+@end
+
+@implementation OPTLYDatafileManagerNoOp
+
+- (void)downloadDatafile:(NSString *)projectId completionHandler:(OPTLYHTTPRequestManagerResponse)completion {
+    completion(nil, nil, nil);
+    return;
+}
+
+@end

OptimizelySDKShared/OptimizelySDKShared/OPTLYManager.h

@@ -25,6 +25,8 @@
 @property (nonatomic, readonly, strong, nonnull) NSString *projectId;
 /// The default datafile to initialize an Optimizely Client with
 @property (nonatomic, readwrite, strong, nullable) NSData *datafile;
+/// The datafile manager that will download the datafile for the manager
+@property (nonatomic, readwrite, strong, nullable) id<OPTLYDatafileManager> datafileManager;
 /// The error handler to be used for the manager, client, and all subcomponents
 @property (nonatomic, readwrite, strong, nullable) id<OPTLYErrorHandler> errorHandler;
 /// The event dispatcher to initialize an Optimizely Client with

OptimizelySDKShared/OptimizelySDKShared/OPTLYManager.m

@@ -52,7 +52,8 @@ - (instancetype)initWithBuilder:(OPTLYManagerBuilder *)builder {
             _errorHandler = builder.errorHandler;
             _eventDispatcher = builder.eventDispatcher;
             _logger = builder.logger;
-            // TODO: Josh W. initialize datafile manager
+            // initialize datafile manager
+            _datafileManager = builder.datafileManager;
             // TODO: Josh W. initialize event dispatcher
             // TODO: Josh W. initialize user experiment record
         }

OptimizelySDKShared/OptimizelySDKShared/OPTLYManagerBuilder.h

@@ -16,7 +16,7 @@
 
 #import <Foundation/Foundation.h>
 
-@protocol OPTLYErrorHandler, OPTLYEventDispatcher, OPTLYLogger;
+@protocol OPTLYDatafileManager, OPTLYErrorHandler, OPTLYEventDispatcher, OPTLYLogger;
 
 @class OPTLYManagerBuilder;
 
@@ -30,6 +30,8 @@ typedef void (^OPTLYManagerBuilderBlock)(OPTLYManagerBuilder * _Nullable builder
 @property (nonatomic, readwrite) NSTimeInterval eventDispatchInterval;
 /// The ID of the Optimizely Project the manager will oversee
 @property (nonatomic, readwrite, strong, nonnull) NSString *projectId;
+/// The datafile manager to be used for the manager
+@property (nonatomic, readwrite, strong, nonnull) id<OPTLYDatafileManager> datafileManager;
 /// The error handler to be used for the manager, client, and all subcomponents
 @property (nonatomic, readwrite, strong, nullable) id<OPTLYErrorHandler> errorHandler;
 /// The event dispatcher to initialize an Optimizely Client with

OptimizelySDKShared/OptimizelySDKShared/OPTLYManagerBuilder.m

@@ -15,9 +15,11 @@
  ***************************************************************************/
 
 #import "OPTLYManagerBuilder.h"
+#import "OPTLYDatafileManager.h"
 #import <OptimizelySDKCore/OPTLYErrorHandler.h>
 #import <OptimizelySDKCore/OPTLYEventDispatcher.h>
 #import <OptimizelySDKCore/OPTLYLogger.h>
+#import <OptimizelySDKShared/OPTLYDatafileManager.h>
 
 @implementation OPTLYManagerBuilder
 
@@ -34,10 +36,20 @@ - (id)initWithBlock:(OPTLYManagerBuilderBlock)block {
     self = [super init];
     if (self != nil) {
         block(self);
+        if (![OPTLYDatafileManagerUtility conformsToOPTLYDatafileManagerProtocol:[self.datafileManager class]]) {
+            return nil;
+        }
     }    
     return self;
 }
 
+- (id<OPTLYDatafileManager>)datafileManager {
+    if (!_datafileManager) {
+        _datafileManager = [[OPTLYDatafileManagerNoOp alloc] init];
+    }
+    return _datafileManager;
+}
+
 - (id<OPTLYErrorHandler>)errorHandler {
     if (!_errorHandler) {
         _errorHandler = [[OPTLYErrorHandlerNoOp alloc] init];

OptimizelySDKShared/OptimizelySDKShared/OptimizelySDKShared.h

@@ -18,6 +18,7 @@
 #import "OPTLYManager.h"
 #import "OPTLYHTTPRequestManager.h"
 #import "OPTLYNetworkService.h"
+#import "OPTLYDatafileManager.h"
 #import "OPTLYDataStore.h"
 #import "OPTLYClient.h"
 #import "OPTLYFileManager.h"

OptimizelySDKShared/OptimizelySDKSharedTests/OPTLYManagerBuilderTest.m

@@ -21,9 +21,17 @@
 #import <OptimizelySDKCore/OPTLYLogger.h>
 #import "OPTLYManager.h"
 #import "OPTLYManagerBuilder.h"
+#import "OPTLYDatafileManager.h"
 
 static NSString *const kProjectId = @"6372300739";
 
+@interface OPTLYFakeDatafileManagerClass : NSObject <OPTLYDatafileManager>
+
+@end
+
+@implementation OPTLYFakeDatafileManagerClass
+@end
+
 @interface OPTLYManagerBuilderTest : XCTestCase
 
 @end
@@ -52,6 +60,7 @@ - (void)testManagerBuilderBuildsSuccessfulWithProjectId {
     XCTAssertNotNil(manager.errorHandler);
     XCTAssertNotNil(manager.eventDispatcher);
     XCTAssertNotNil(manager.logger);
+    XCTAssertNotNil(manager.datafileManager);
 }
 
 - (void)testBuilderCanAssignErrorHandler {
@@ -73,7 +82,7 @@ - (void)testBuilderCanAssignErrorHandler {
 }
 
 - (void)testBuilderCanAssignEventDispatcher {
-    id<OPTLYEventDispatcher> eventDispatcher = [[NSObject alloc] init];
+    OPTLYEventDispatcherNoOp *eventDispatcher = [[OPTLYEventDispatcherNoOp alloc] init];
 
     OPTLYManager *defaultManager = [OPTLYManager initWithBuilderBlock:^(OPTLYManagerBuilder * _Nullable builder) {
         builder.projectId = kProjectId;
@@ -108,5 +117,33 @@ - (void)testBuilderCanAssignLogger {
     XCTAssertEqual(logger, customManager.logger, @"Should be the same object with custom builder");
 }
 
+- (void)testBuilderCanAssignDatafileManager {
+    OPTLYDatafileManagerNoOp *datafileManager = [[OPTLYDatafileManagerNoOp alloc] init];
+    
+    OPTLYManager *defaultManager = [OPTLYManager initWithBuilderBlock:^(OPTLYManagerBuilder * _Nullable builder) {
+        builder.projectId = kProjectId;
+    }];
+    
+    OPTLYManager *customManager = [OPTLYManager initWithBuilderBlock:^(OPTLYManagerBuilder * _Nullable builder) {
+        builder.projectId = kProjectId;
+        builder.datafileManager = datafileManager;
+    }];
+    
+    XCTAssertNotNil(customManager);
+    XCTAssertNotNil(customManager.datafileManager);
+    XCTAssertNotEqual(customManager.datafileManager, defaultManager.datafileManager);
+    XCTAssertEqual(datafileManager, customManager.datafileManager);
+}
+
+- (void)testBuilderCannotAssignDatafileManagerThatDoesNotConformToProtocol {
+    OPTLYFakeDatafileManagerClass *object = [[OPTLYFakeDatafileManagerClass alloc] init];
+    
+    OPTLYManager *managerWithObject = [OPTLYManager initWithBuilderBlock:^(OPTLYManagerBuilder * _Nullable builder) {
+        builder.projectId = kProjectId;
+        builder.datafileManager = object;
+    }];
+    
+    XCTAssertNil(managerWithObject);
+}
 
 @end