[iOS] Fix for: "unrecognized selector sent to instance" for datafile with audience having no specified value (#178)

alda-optimizely · web-flow · commit 80b0f4320bdd · 2017-10-04T15:28:53.000-07:00
* [OASIS-1423] Fixed crash caused by missing value in attributes. This just prevents a crash, but the datafile generation should not allow the missing value.

* Changed dictionary index back to literal as this is the preferred Apple way.

* Added a few more tests for the condition deserializer.
diff --git a/OptimizelySDKCore/OptimizelySDKCore/OPTLYAudience.m b/OptimizelySDKCore/OptimizelySDKCore/OPTLYAudience.m
@@ -22,7 +22,7 @@ @implementation OPTLYAudience
 + (OPTLYJSONKeyMapper*)keyMapper
 {
     return [[OPTLYJSONKeyMapper alloc] initWithDictionary:@{ OPTLYDatafileKeysAudienceId   : @"audienceId",
-                                                        OPTLYDatafileKeysAudienceName : @"audienceName"
+                                                             OPTLYDatafileKeysAudienceName : @"audienceName"
                                                         }];
 }
 
@@ -38,7 +38,12 @@ - (void)setConditionsWithNSString:(NSString *)string {
         @throw exception;
     }
     
-    self.conditions = [OPTLYCondition deserializeJSONArray:array];
+    self.conditions = [OPTLYCondition deserializeJSONArray:array error:&err];
+    
+    if (err != nil) {
+        NSException *exception = [[NSException alloc] initWithName:err.domain reason:err.localizedFailureReason userInfo:@{@"Error" : err}];
+        @throw exception;
+    }
 }
 
 - (BOOL)evaluateConditionsWithAttributes:(NSDictionary<NSString *,NSString *> *)attributes {
diff --git a/OptimizelySDKCore/OptimizelySDKCore/OPTLYBaseCondition.m b/OptimizelySDKCore/OptimizelySDKCore/OPTLYBaseCondition.m
@@ -25,9 +25,10 @@ + (BOOL) isBaseConditionJSON:(NSData *)jsonData {
     }
     else {
         NSDictionary *dict = (NSDictionary *)jsonData;
-        if (dict[OPTLYDatafileKeysConditionName] != nil
-            && dict[OPTLYDatafileKeysConditionType] != nil
-            && dict[OPTLYDatafileKeysConditionValue] != nil) {
+        
+        if (dict[OPTLYDatafileKeysConditionName] != nil &&
+            dict[OPTLYDatafileKeysConditionType] != nil &&
+            dict[OPTLYDatafileKeysConditionValue] != nil) {
             return true;
         }
         return false;
diff --git a/OptimizelySDKCore/OptimizelySDKCore/OPTLYCondition.h b/OptimizelySDKCore/OptimizelySDKCore/OPTLYCondition.h
@@ -27,6 +27,8 @@
 
 @interface OPTLYCondition : NSObject
 
++ (NSArray<OPTLYCondition> *)deserializeJSONArray:(NSArray *)jsonArray
+                                            error:(NSError **)error;
 + (NSArray<OPTLYCondition> *)deserializeJSONArray:(NSArray *)jsonArray;
 
 @end
diff --git a/OptimizelySDKCore/OptimizelySDKCore/OPTLYCondition.m b/OptimizelySDKCore/OptimizelySDKCore/OPTLYCondition.m
@@ -22,6 +22,25 @@
 @implementation OPTLYCondition
 
 + (NSArray<OPTLYCondition> *)deserializeJSONArray:(NSArray *)jsonArray {
+    return [OPTLYCondition deserializeJSONArray:jsonArray error:nil];
+}
+
+// example jsonArray:
+//  [“and", [“or", [“or", {"name": "sample_attribute_key", "type": "custom_attribute", "value": “a”}], [“or", {"name": "sample_attribute_key", "type": "custom_attribute", "value": "b"}], [“or", {"name": "sample_attribute_key", "type": "custom_attribute", "value": "c"}]
++ (NSArray<OPTLYCondition> *)deserializeJSONArray:(NSArray *)jsonArray
+                                            error:(NSError **)error {
+    
+    // need to check if the jsonArray is actually an array, otherwise, something is wrong with the audience condition
+    if (![jsonArray isKindOfClass:[NSArray class]]) {
+        NSError *err = [NSError errorWithDomain:OPTLYErrorHandlerMessagesDomain
+                                           code:OPTLYErrorTypesDatafileInvalid
+                                       userInfo:@{NSLocalizedDescriptionKey : OPTLYErrorHandlerMessagesProjectConfigInvalidAudienceCondition}];
+        if (error && err) {
+            *error = err;
+        }
+        return nil;
+    }
+    
     if (jsonArray.count > 1 && [OPTLYBaseCondition isBaseConditionJSON:jsonArray[1]]) { //base case condition
         
         // generate all base conditions
@@ -31,24 +50,38 @@ @implementation OPTLYCondition
             NSError *err = nil;
             OPTLYBaseCondition *condition = [[OPTLYBaseCondition alloc] initWithDictionary:info
                                                                                      error:&err];
-            if (err != nil) {
-                NSException *exception = [[NSException alloc] initWithName:err.domain reason:err.localizedFailureReason userInfo:@{@"Error" : err}];
-                @throw exception;
+            if (error && err) {
+                *error = err;
             } else {
-                [conditions addObject:condition];
+                if (condition != nil) {
+                    [conditions addObject:condition];
+                }
             }
         }
         
         // return an (And/Or/Not) Condition handling the base conditions
-        return (NSArray<OPTLYCondition> *)@[[OPTLYCondition createConditionInstanceOfClass:jsonArray[0] withConditions:conditions]];
+        NSObject<OPTLYCondition> *condition = [OPTLYCondition createConditionInstanceOfClass:jsonArray[0]
+                                                                              withConditions:conditions];
+        return (NSArray<OPTLYCondition> *)@[condition];
     }
     else { // further condition arrays to deserialize
         NSMutableArray<OPTLYCondition> *subConditions = (NSMutableArray<OPTLYCondition> *)[[NSMutableArray alloc] initWithCapacity:(jsonArray.count - 1)];
         for (int i = 1; i < jsonArray.count; i++) {
-            [subConditions addObjectsFromArray:[OPTLYCondition deserializeJSONArray:jsonArray[i]]];
+            NSError *err = nil;
+            NSArray *deserializedJsonObject = [OPTLYCondition deserializeJSONArray:jsonArray[i] error:&err];
+            
+            if (err) {
+                *error = err;
+                return nil;
+            }
+
+            if (deserializedJsonObject != nil) {
+                [subConditions addObjectsFromArray:deserializedJsonObject];
+            }
         }
-        return (NSArray<OPTLYCondition> *)@[[OPTLYCondition createConditionInstanceOfClass:jsonArray[0]
-                                                                            withConditions:subConditions]];
+        NSObject<OPTLYCondition> *condition = [OPTLYCondition createConditionInstanceOfClass:jsonArray[0]
+                                                                              withConditions:subConditions];
+        return (NSArray<OPTLYCondition> *)@[condition];
     }
 }
 
diff --git a/OptimizelySDKCore/OptimizelySDKCore/OPTLYErrorHandlerMessages.h b/OptimizelySDKCore/OptimizelySDKCore/OPTLYErrorHandlerMessages.h
@@ -54,6 +54,7 @@ extern NSString *const OPTLYErrorHandlerMessagesDataStoreInvalidDataStoreEntityV
 extern NSString *const OPTLYErrorHandlerMessagesHTTPRequestManagerPOSTRetryFailure;
 extern NSString *const OPTLYErrorHandlerMessagesHTTPRequestManagerGETRetryFailure;
 extern NSString *const OPTLYErrorHandlerMessagesHTTPRequestManagerGETIfModifiedFailure;
+extern NSString *const OPTLYErrorHandlerMessagesProjectConfigInvalidAudienceCondition;
 
 
 typedef NS_ENUM(NSUInteger, OPTLYErrorTypes) {
diff --git a/OptimizelySDKCore/OptimizelySDKCore/OPTLYErrorHandlerMessages.m b/OptimizelySDKCore/OptimizelySDKCore/OPTLYErrorHandlerMessages.m
@@ -59,5 +59,8 @@
 NSString *const OPTLYErrorHandlerMessagesHTTPRequestManagerGETRetryFailure = @"[HTTP] The max backoff retry has been exceeded. GET failed with error: %@.";
 NSString *const OPTLYErrorHandlerMessagesHTTPRequestManagerGETIfModifiedFailure = @"[HTTP] The max backoff retry has been exceeded. GET if modified failed with error: %@.";
 
+// ---- Project Config ----
+NSString *const OPTLYErrorHandlerMessagesProjectConfigInvalidAudienceCondition = @"[CONFIG] Invalid audience condition.";
+
 @implementation OPTLYErrorHandlerMessages
 @end
diff --git a/OptimizelySDKCore/OptimizelySDKCoreTests/OPTLYConditionTest.m b/OptimizelySDKCore/OptimizelySDKCoreTests/OPTLYConditionTest.m
@@ -179,6 +179,34 @@ - (void)testDeserializeConditions {
     XCTAssertTrue([conditionsArray[0] evaluateConditionsWithAttributes:self.testUserAttributes]);
 }
 
+- (void)testDeserializeConditionsNoValue {
+    NSString *conditionString = @"[\"and\", [\"or\", [\"or\", {\"name\": \"browser_type\", \"type\": \"custom_dimension\"}]]]";
+    NSData *conditionData = [conditionString dataUsingEncoding:NSUTF8StringEncoding];
+    NSArray *conditionStringJSONArray = [NSJSONSerialization JSONObjectWithData:conditionData
+                                                                        options:NSJSONReadingAllowFragments
+                                                                          error:nil];
+    NSError *error = nil;
+    NSArray *conditionsArray = [OPTLYCondition deserializeJSONArray:conditionStringJSONArray error:&error];
+    XCTAssertNil(conditionsArray);
+}
+
+- (void)testDeserializeConditionsEmptyConditions {
+    NSString *conditionString = @"";
+    NSData *conditionData = [conditionString dataUsingEncoding:NSUTF8StringEncoding];
+    NSArray *conditionStringJSONArray = [NSJSONSerialization JSONObjectWithData:conditionData
+                                                                        options:NSJSONReadingAllowFragments
+                                                                          error:nil];
+    NSError *error = nil;
+    NSArray *conditionsArray = [OPTLYCondition deserializeJSONArray:conditionStringJSONArray error:&error];
+    XCTAssertNil(conditionsArray);
+}
+
+- (void)testDeserializeConditionsNilConditions {
+    NSError *error = nil;
+    NSArray *conditionsArray = [OPTLYCondition deserializeJSONArray:nil error:&error];
+    XCTAssertNil(conditionsArray);
+}
+
 - (OPTLYBaseCondition *)mockBaseConditionAlwaysFalse {
     id falseBaseCondition = OCMClassMock([OPTLYBaseCondition class]);
     OCMStub([falseBaseCondition evaluateConditionsWithAttributes:[OCMArg isKindOfClass:[NSDictionary class]]]).andReturn(false);

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ @implementation OPTLYAudience`
`22`	`22`	`+ (OPTLYJSONKeyMapper*)keyMapper`
`23`	`23`	`{`
`24`	`24`	`return [[OPTLYJSONKeyMapper alloc] initWithDictionary:@{ OPTLYDatafileKeysAudienceId : @"audienceId",`
`25`		`- OPTLYDatafileKeysAudienceName : @"audienceName"`
	`25`	`+ OPTLYDatafileKeysAudienceName : @"audienceName"`
`26`	`26`	`}];`
`27`	`27`	`}`
`28`	`28`
`@@ -38,7 +38,12 @@ - (void)setConditionsWithNSString:(NSString *)string {`
`38`	`38`	`@throw exception;`
`39`	`39`	`}`
`40`	`40`
`41`		`- self.conditions = [OPTLYCondition deserializeJSONArray:array];`
	`41`	`+ self.conditions = [OPTLYCondition deserializeJSONArray:array error:&err];`
	`42`	`+`
	`43`	`+ if (err != nil) {`
	`44`	`+ NSException *exception = [[NSException alloc] initWithName:err.domain reason:err.localizedFailureReason userInfo:@{@"Error" : err}];`
	`45`	`+ @throw exception;`
	`46`	`+ }`
`42`	`47`	`}`
`43`	`48`
`44`	`49`	`- (BOOL)evaluateConditionsWithAttributes:(NSDictionary<NSString ,NSString > *)attributes {`
Original file line number	Diff line number	Diff line change
`@@ -25,9 +25,10 @@ + (BOOL) isBaseConditionJSON:(NSData *)jsonData {`
`25`	`25`	`}`
`26`	`26`	`else {`
`27`	`27`	`NSDictionary dict = (NSDictionary )jsonData;`
`28`		`- if (dict[OPTLYDatafileKeysConditionName] != nil`
`29`		`- && dict[OPTLYDatafileKeysConditionType] != nil`
`30`		`- && dict[OPTLYDatafileKeysConditionValue] != nil) {`
	`28`	`+`
	`29`	`+ if (dict[OPTLYDatafileKeysConditionName] != nil &&`
	`30`	`+ dict[OPTLYDatafileKeysConditionType] != nil &&`
	`31`	`+ dict[OPTLYDatafileKeysConditionValue] != nil) {`
`31`	`32`	`return true;`
`32`	`33`	`}`
`33`	`34`	`return false;`