Remove init method that threw runtime exception so that it causes a compile time exception (#286)

Remove init method that threw runtime exception so that it causes a compile time error

Author: thomaszurkan-optimizely

OptimizelySDKCore/OptimizelySDKCore/OPTLYLoggerMessages.h

@@ -168,6 +168,7 @@ extern NSString *const OPTLYLoggerMessagesVariableUnknownForVariableKey;
 
 // ---- Manager ----
 // error
+extern NSString *const OPTLYLoggerMessagesManagerBuilderBlockNotValid;
 extern NSString *const OPTLYLoggerMessagesManagerBuilderNotValid;
 extern NSString *const OPTLYLoggerMessagesManagerDatafileManagerDoesNotConformToOPTLYDatafileManagerProtocol;
 extern NSString *const OPTLYLoggerMessagesManagerErrorHandlerDoesNotConformToOPTLYErrorHandlerProtocol;

OptimizelySDKCore/OptimizelySDKCore/OPTLYLoggerMessages.m

@@ -162,6 +162,7 @@
 
 // ---- Manager ----
 // error
+NSString *const OPTLYLoggerMessagesManagerBuilderBlockNotValid = @"[MANAGER] An Optimizely Manager Builder instance was not able to be initialized because the OPTLYManagerBuilderBlock was nil.";
 NSString *const OPTLYLoggerMessagesManagerBuilderNotValid = @"[MANAGER] An Optimizely Manager instance was not able to be initialized because the OPTLYManagerBuilder object was invalid.";
 NSString *const OPTLYLoggerMessagesManagerDatafileManagerDoesNotConformToOPTLYDatafileManagerProtocol = @"[MANAGER] Datafile manager does not conform to the OPTLYDatafileManager protocol.";
 NSString *const OPTLYLoggerMessagesManagerErrorHandlerDoesNotConformToOPTLYErrorHandlerProtocol = @"[MANAGER] Error handler does not conform to the OPTLYErrorHandler protocol.";

OptimizelySDKShared/OptimizelySDKShared/OPTLYManagerBuilder.h

@@ -42,7 +42,9 @@ typedef void (^OPTLYManagerBuilderBlock)(OPTLYManagerBuilder * _Nullable builder
 /// User profile to be used by the client to store user-specific data.
 @property (nonatomic, readwrite, strong, nullable) id<OPTLYUserProfileService> userProfileService;
 
-/// Create the Optimizely Manager object.
+/// init is disabled. Please use builderWithBlock to create a Manager Builder
+- (instancetype)init NS_UNAVAILABLE;
+/// Create the Optimizely Manager Builder object.
 + (nullable instancetype)builderWithBlock:(nonnull OPTLYManagerBuilderBlock)block;
 
 @end

OptimizelySDKShared/OptimizelySDKShared/OPTLYManagerBuilder.m

@@ -33,15 +33,17 @@ + (nullable instancetype)builderWithBlock:(OPTLYManagerBuilderBlock)block {
     return [[self alloc] initWithBlock:block];
 }
 
-- (id)init {
-    return [self initWithBlock:nil];
-}
-
 - (id)initWithBlock:(OPTLYManagerBuilderBlock)block {
-    NSParameterAssert(block);
     self = [super init];
     if (self != nil) {
-        block(self);
+        if (block != nil) {
+            block(self);
+        }
+        else {
+            [[OPTLYLoggerDefault new] logMessage:OPTLYLoggerMessagesManagerBuilderBlockNotValid
+                      withLevel:OptimizelyLogLevelError];
+            return nil;
+        }
 
         // check the logger
         if (_logger) {
@@ -51,6 +53,9 @@ - (id)initWithBlock:(OPTLYManagerBuilderBlock)block {
                 return nil;
             }
         }
+        else {
+            _logger = [OPTLYLoggerDefault new];
+        }
 
         // check the error handler
         if (_errorHandler) {

OptimizelySDKShared/OptimizelySDKSharedTests/OPTLYManagerBuilderTest.m

@@ -156,5 +156,12 @@ - (void)testManagerIsNotInitializedWhenProjectIdIsEmptyString {
     }]];
     XCTAssertNil(manager, @"Manager should not be initialized if we pass in an empty string as the project ID");
 }
+/**
+ * Test the manager is not initialized when an nil builder block.
+ */
+- (void)testManagerIsNotInitializedWhenNilBuilderBlock {
+    OPTLYManagerBasic *manager = [[OPTLYManagerBasic alloc] initWithBuilder:nil];
+    XCTAssertNil(manager, @"Manager should not be initialized if we pass in an nil builder");
+}
 
 @end

OptimizelySDKUniversal/generated-frameworks/Release-iOS-universal-SDK/OptimizelySDKiOS.framework.zip

@@ -168,6 +168,7 @@ extern NSString *const OPTLYLoggerMessagesVariableUnknownForVariableKey;
 
 // ---- Manager ----
 // error
+extern NSString *const OPTLYLoggerMessagesManagerBuilderBlockNotValid;
 extern NSString *const OPTLYLoggerMessagesManagerBuilderNotValid;
 extern NSString *const OPTLYLoggerMessagesManagerDatafileManagerDoesNotConformToOPTLYDatafileManagerProtocol;
 extern NSString *const OPTLYLoggerMessagesManagerErrorHandlerDoesNotConformToOPTLYErrorHandlerProtocol;

OptimizelySDKUniversal/generated-frameworks/Release-iOS-universal-SDK/OptimizelySDKiOS.framework/Headers/OPTLYLoggerMessages.h

@@ -42,7 +42,9 @@ typedef void (^OPTLYManagerBuilderBlock)(OPTLYManagerBuilder * _Nullable builder
 /// User profile to be used by the client to store user-specific data.
 @property (nonatomic, readwrite, strong, nullable) id<OPTLYUserProfileService> userProfileService;
 
-/// Create the Optimizely Manager object.
+/// init is disabled. Please use builderWithBlock to create a Manager Builder
+- (instancetype)init NS_UNAVAILABLE;
+/// Create the Optimizely Manager Builder object.
 + (nullable instancetype)builderWithBlock:(nonnull OPTLYManagerBuilderBlock)block;
 
 @end

OptimizelySDKUniversal/generated-frameworks/Release-iOS-universal-SDK/OptimizelySDKiOS.framework/Headers/OPTLYManagerBuilder.h

@@ -168,6 +168,7 @@ extern NSString *const OPTLYLoggerMessagesVariableUnknownForVariableKey;
 
 // ---- Manager ----
 // error
+extern NSString *const OPTLYLoggerMessagesManagerBuilderBlockNotValid;
 extern NSString *const OPTLYLoggerMessagesManagerBuilderNotValid;
 extern NSString *const OPTLYLoggerMessagesManagerDatafileManagerDoesNotConformToOPTLYDatafileManagerProtocol;
 extern NSString *const OPTLYLoggerMessagesManagerErrorHandlerDoesNotConformToOPTLYErrorHandlerProtocol;

OptimizelySDKUniversal/generated-frameworks/Release-iOS-universal-SDK/OptimizelySDKiOS.framework/OptimizelySDKiOS

@@ -42,7 +42,9 @@ typedef void (^OPTLYManagerBuilderBlock)(OPTLYManagerBuilder * _Nullable builder
 /// User profile to be used by the client to store user-specific data.
 @property (nonatomic, readwrite, strong, nullable) id<OPTLYUserProfileService> userProfileService;
 
-/// Create the Optimizely Manager object.
+/// init is disabled. Please use builderWithBlock to create a Manager Builder
+- (instancetype)init NS_UNAVAILABLE;
+/// Create the Optimizely Manager Builder object.
 + (nullable instancetype)builderWithBlock:(nonnull OPTLYManagerBuilderBlock)block;
 
 @end