Audience Evaluation Logging. (#362)

* Audience Logging Implementations.

* cleaning unused code.

* 1. Fixed code review recommendations.
2. Fixed indentation of method declarations throughout the SDK.

* Fixed all condition warnings for Scripts/build_all.sh. (#369)

Author: yasirfolio3

OptimizelySDKCore/OptimizelySDKCore/OPTLYAudience.h

@@ -39,4 +39,7 @@
 - (void)setConditionsWithNSArray:(NSArray *)array;
 - (void)setConditionsWithNSDictionary:(NSDictionary *)dictionary;
 
+/// Returns conditions string
+- (NSString *)getConditionsString;
+
 @end

OptimizelySDKCore/OptimizelySDKCore/OPTLYAudience.m

@@ -14,9 +14,17 @@
  * limitations under the License.                                           *
  ***************************************************************************/
 
+
 #import "OPTLYAudience.h"
 #import "OPTLYDatafileKeys.h"
 #import "OPTLYNSObject+Validation.h"
+#import "OPTLYLoggerMessages.h"
+#import "OPTLYLogger.h"
+
+@interface OPTLYAudience()
+/// String representation of the conditions
+@property (nonatomic, strong) NSString<Ignore> *conditionsString;
+@end
 
 @implementation OPTLYAudience
 
@@ -27,12 +35,18 @@ + (OPTLYJSONKeyMapper*)keyMapper
                                                         }];
 }
 
+- (NSString *)getConditionsString {
+    return _conditionsString ?: @"";
+}
+
 - (void)setConditionsWithNSString:(NSString *)string {
     NSArray *array = [string getValidConditionsArray];
     [self setConditionsWithNSArray:array];
 }
 
 - (void)setConditionsWithNSArray:(NSArray *)array {
+    //Retrieving Jsonstring from array
+    _conditionsString = [array getJSONArrayStringOrEmpty];
     NSError *err = nil;
     self.conditions = [OPTLYCondition deserializeJSON:array error:nil];
     if (err != nil) {
@@ -50,11 +64,24 @@ - (void)setConditionsWithNSDictionary:(NSDictionary *)dictionary {
     }
 }
 
-- (nullable NSNumber *)evaluateConditionsWithAttributes:(NSDictionary<NSString *, NSObject *> *)attributes projectConfig:(nullable OPTLYProjectConfig *)config {
-    
+- (nullable NSNumber *)evaluateConditionsWithAttributes:(nullable NSDictionary<NSString *, NSObject *> *)attributes projectConfig:(nullable OPTLYProjectConfig *)config {
     NSObject<OPTLYCondition> *condition = (NSObject<OPTLYCondition> *)[self.conditions firstObject];
     if (condition) {
-        return [condition evaluateConditionsWithAttributes:attributes projectConfig:config];
+        // Log Audience Evaluation Started
+        NSString *conditionString = [self getConditionsString];
+        NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesAudienceEvaluatorEvaluationStartedWithConditions, self.audienceName, conditionString];
+        [config.logger logMessage:logMessage withLevel:OptimizelyLogLevelDebug];
+        
+        NSNumber *result = [condition evaluateConditionsWithAttributes:attributes projectConfig:config];
+        if (result == NULL) {
+            NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesAudienceEvaluatorEvaluationCompletedWithResult, self.audienceName, @"UNKNOWN"];
+            [config.logger logMessage:logMessage withLevel:OptimizelyLogLevelInfo];
+        }
+        else {
+            NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesAudienceEvaluatorEvaluationCompletedWithResult, self.audienceName, [result boolValue] ? @"TRUE" : @"FALSE"];
+            [config.logger logMessage:logMessage withLevel:OptimizelyLogLevelInfo];
+        }
+        return result;
     }
     return nil;
 }

OptimizelySDKCore/OptimizelySDKCore/OPTLYAudienceBaseCondition.h

@@ -26,8 +26,8 @@
 
 @interface OPTLYAudienceBaseCondition : NSObject <OPTLYCondition>
 
-@property (nonatomic, strong) NSString *audienceId;
-+(BOOL)isBaseConditionJSON:(NSData *)jsonData;
+@property (nonatomic, strong, nonnull) NSString *audienceId;
++(BOOL)isBaseConditionJSON:(nonnull NSData *)jsonData;
 
 @end
 

OptimizelySDKCore/OptimizelySDKCore/OPTLYAudienceBaseCondition.m

@@ -16,20 +16,25 @@
 
 #import "OPTLYAudienceBaseCondition.h"
 #import "OPTLYAudience.h"
+#import "OPTLYLogger.h"
+#import "OPTLYLoggerMessages.h"
+#import "OPTLYNSObject+Validation.h"
 
 @implementation OPTLYAudienceBaseCondition
 
-+ (BOOL) isBaseConditionJSON:(NSData *)jsonData {
++ (BOOL) isBaseConditionJSON:(nonnull NSData *)jsonData {
     return [jsonData isKindOfClass:[NSString class]];
 }
 
-- (nullable NSNumber *)evaluateConditionsWithAttributes:(NSDictionary<NSString *, NSObject *> *)attributes projectConfig:(nullable OPTLYProjectConfig *)config {
+- (nullable NSNumber *)evaluateConditionsWithAttributes:(nullable NSDictionary<NSString *, NSObject *> *)attributes projectConfig:(nullable OPTLYProjectConfig *)config {
     if (attributes == nil) {
         // if the user did not pass in attributes, return false
         return [NSNumber numberWithBool:false];
     }
-    
     OPTLYAudience *audience = [config getAudienceForId:self.audienceId];
+    if (audience == nil) {
+        return nil;
+    }
     return [audience evaluateConditionsWithAttributes:attributes projectConfig:config];
 }
 

OptimizelySDKCore/OptimizelySDKCore/OPTLYBaseCondition.h

@@ -32,15 +32,17 @@
 @interface OPTLYBaseCondition : OPTLYJSONModel <OPTLYCondition>
 
 /// Condition name
-@property (nonatomic, strong) NSString *name;
+@property (nonatomic, strong, nonnull) NSString *name;
 /// Condition type
 @property (nonatomic, strong, nullable) NSString<OPTLYOptional> *type;
 /// Condition value
 @property (nonatomic, strong, nullable) NSObject<OPTLYOptional> *value;
 /// Condition match type
 @property (nonatomic, strong, nullable) NSString<OPTLYOptional> *match;
 
+/// Returns string representation
+- (nonnull NSString *)toString;
 
-+(BOOL)isBaseConditionJSON:(NSData *)jsonData;
++(BOOL)isBaseConditionJSON:(nonnull NSData *)jsonData;
 
 @end

OptimizelySDKCore/OptimizelySDKCore/OPTLYBaseCondition.m

@@ -17,9 +17,25 @@
 #import "OPTLYBaseCondition.h"
 #import "OPTLYDatafileKeys.h"
 #import "OPTLYNSObject+Validation.h"
+#import "OPTLYLoggerMessages.h"
+#import "OPTLYLogger.h"
+
+@interface OPTLYBaseCondition()
+/// String representation of self
+@property (nonatomic, strong) NSString<Ignore> *stringRepresentation;
+@end
 
 @implementation OPTLYBaseCondition
 
+- (instancetype)initWithDictionary:(NSDictionary *)dict error:(NSError *__autoreleasing *)err {
+    self.stringRepresentation = [NSString stringWithFormat:@"%@", dict];;
+    return [super initWithDictionary:dict error:err];
+}
+
+- (nonnull NSString *)toString {
+    return _stringRepresentation ?: @"";
+}
+
 /**
  * Given a json, this mapper finds JSON keys for each key in the provided dictionary and maps the json value to the class property with name corresponding to the dictionary value
  */
@@ -32,77 +48,160 @@ + (OPTLYJSONKeyMapper*)keyMapper
                                                              }];
 }
 
-+ (BOOL) isBaseConditionJSON:(NSData *)jsonData {
++ (BOOL)isBaseConditionJSON:(nonnull NSData *)jsonData {
     return [jsonData isKindOfClass:[NSDictionary class]];
 }
 
--(nullable NSNumber *)evaluateMatchTypeExact:(NSDictionary<NSString *, NSObject *> *)attributes{
+- (nullable NSNumber *)evaluateMatchTypeExact:(NSDictionary<NSString *, NSObject *> *)attributes projectConfig:(nullable OPTLYProjectConfig *)config {
     // check if user attributes contain a value that is of similar class type to our value and also equals to our value, else return Null
+    
+    // check if condition value is invalid
+    if (![self.value isValidExactMatchTypeValue]) {
+        return NULL;
+    }
+    // check if attributes exists
+    if (![attributes.allKeys containsObject:self.name]) {
+        NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesAudienceEvaluatorConditionEvaluatedAsUnknownForMissingAttribute, self.stringRepresentation, self.name];
+        [config.logger logMessage:logMessage withLevel:OptimizelyLogLevelDebug];
+        return NULL;
+    }
+    // check if attribute value is invalid
     NSObject *userAttribute = [attributes objectForKey:self.name];
-    NSNumber *success = NULL;
+    if (![userAttribute isValidExactMatchTypeValue]) {
+        // Log Invalid Attribute Value Type
+        NSString *userAttributeClassName = NSStringFromClass([userAttribute class]) ?: @"null";
+        NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesAudienceEvaluatorConditionEvaluatedAsUnknownForUnexpectedType, self.stringRepresentation, userAttributeClassName, self.name];
+        [config.logger logMessage:logMessage withLevel:OptimizelyLogLevelWarning];
+        return NULL;
+    }
 
     if ([self.value isValidStringType] && [userAttribute isValidStringType]) {
-        success = [NSNumber numberWithBool:[self.value isEqual:userAttribute]];
+        return [NSNumber numberWithBool:[self.value isEqual:userAttribute]];
     }
     else if ([self.value isValidNumericAttributeValue] && [userAttribute isValidNumericAttributeValue]) {
-        success = [NSNumber numberWithBool:[self.value isEqual:userAttribute]];
+        return [NSNumber numberWithBool:[self.value isEqual:userAttribute]];
     }
     else if ([self.value isKindOfClass:[NSNull class]] && [userAttribute isKindOfClass:[NSNull class]]) {
-        success = [NSNumber numberWithBool:[self.value isEqual:userAttribute]];
+        return [NSNumber numberWithBool:[self.value isEqual:userAttribute]];
     }
     else if ([self.value isValidBooleanAttributeValue] && [userAttribute isValidBooleanAttributeValue]) {
-        success = [NSNumber numberWithBool:[self.value isEqual:userAttribute]];
+        return [NSNumber numberWithBool:[self.value isEqual:userAttribute]];
     }
-    return success;
+    return NULL;
 }
 
--(nullable NSNumber *)evaluateMatchTypeExist:(NSDictionary<NSString *, NSObject *> *)attributes{
+- (nullable NSNumber *)evaluateMatchTypeExist:(NSDictionary<NSString *, NSObject *> *)attributes projectConfig:(nullable OPTLYProjectConfig *)config {
     // check if user attributes contain our name as a key to a Non nullable object
     return [NSNumber numberWithBool:([attributes objectForKey:self.name] && ![attributes[self.name] isKindOfClass:[NSNull class]])];
 }
 
--(nullable NSNumber *)evaluateMatchTypeSubstring:(NSDictionary<NSString *, NSObject *> *)attributes{
+- (nullable NSNumber *)evaluateMatchTypeSubstring:(NSDictionary<NSString *, NSObject *> *)attributes projectConfig:(nullable OPTLYProjectConfig *)config {
     // check if user attributes contain our value as substring
-    NSObject *userAttribute = [attributes objectForKey:self.name];
-    BOOL userAndOurValueHaveStringClassTypes = ([self.value isKindOfClass: [NSString class]] && [userAttribute isKindOfClass: [NSString class]]);
 
-    if (userAndOurValueHaveStringClassTypes) {
-        BOOL containsSubstring = [((NSString *)userAttribute) containsString: (NSString *)self.value];
-        return [NSNumber numberWithBool:containsSubstring];
+    // check if condition value is invalid
+    if (self.value == nil || [self.value isKindOfClass:[NSNull class]] || ![self.value isKindOfClass: [NSString class]]) {
+        return NULL;
     }
-    return NULL;
+    // check if attributes exists
+    if (![attributes.allKeys containsObject:self.name]) {
+        NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesAudienceEvaluatorConditionEvaluatedAsUnknownForMissingAttribute, self.stringRepresentation, self.name];
+        [config.logger logMessage:logMessage withLevel:OptimizelyLogLevelDebug];
+        return NULL;
+    }
+    // check if user attributes are invalid
+    NSObject *userAttribute = [attributes objectForKey:self.name];
+    if (![userAttribute isKindOfClass: [NSString class]]) {
+        // Log Invalid Attribute Value Type
+        if (!userAttribute || [userAttribute isKindOfClass:[NSNull class]]) {
+            NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesAudienceEvaluatorConditionEvaluatedAsUnknownForUnexpectedTypeNull, self.stringRepresentation, self.name];
+            [config.logger logMessage:logMessage withLevel:OptimizelyLogLevelWarning];
+        }
+        else {
+            NSString *userAttributeClassName = NSStringFromClass([userAttribute class]);
+            NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesAudienceEvaluatorConditionEvaluatedAsUnknownForUnexpectedType, self.stringRepresentation, userAttributeClassName, self.name];
+            [config.logger logMessage:logMessage withLevel:OptimizelyLogLevelWarning];
+        }
+        return NULL;
+    }
+    
+    BOOL containsSubstring = [((NSString *)userAttribute) containsString: (NSString *)self.value];
+    return [NSNumber numberWithBool:containsSubstring];
 }
 
--(nullable NSNumber *)evaluateMatchTypeGreaterThan:(NSDictionary<NSString *, NSObject *> *)attributes{
+- (nullable NSNumber *)evaluateMatchTypeGreaterThan:(NSDictionary<NSString *, NSObject *> *)attributes projectConfig:(nullable OPTLYProjectConfig *)config {
     // check if user attributes contain a value greater than our value
-    NSObject *userAttribute = [attributes objectForKey:self.name];
-    BOOL userValueAndOurValueHaveNSNumberClassTypes = [self.value isValidNumericAttributeValue] && [userAttribute isValidNumericAttributeValue];
 
-    if (userValueAndOurValueHaveNSNumberClassTypes) {
-        NSNumber *ourValue = (NSNumber *)self.value;
-        NSNumber *userValue = (NSNumber *)userAttribute;
-        return [NSNumber numberWithBool: ([userValue doubleValue] > [ourValue doubleValue])];
+    // check if condition value is invalid
+    if (self.value == nil || [self.value isKindOfClass:[NSNull class]] || ![self.value isValidNumericAttributeValue]) {
+        return NULL;
     }
-    return NULL;
+    // check if attributes exists
+    if (![attributes.allKeys containsObject:self.name]) {
+        NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesAudienceEvaluatorConditionEvaluatedAsUnknownForMissingAttribute, self.stringRepresentation, self.name];
+        [config.logger logMessage:logMessage withLevel:OptimizelyLogLevelDebug];
+        return NULL;
+    }
+    // check if user attributes are invalid
+    NSObject *userAttribute = [attributes objectForKey:self.name];
+    if (![userAttribute isValidNumericAttributeValue]) {
+        // Log Invalid Attribute Value Type
+        if (!userAttribute || [userAttribute isKindOfClass:[NSNull class]]) {
+            NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesAudienceEvaluatorConditionEvaluatedAsUnknownForUnexpectedTypeNull, self.stringRepresentation, self.name];
+            [config.logger logMessage:logMessage withLevel:OptimizelyLogLevelWarning];
+        }
+        else {
+            NSString *userAttributeClassName = NSStringFromClass([userAttribute class]);
+            NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesAudienceEvaluatorConditionEvaluatedAsUnknownForUnexpectedType, self.stringRepresentation, userAttributeClassName, self.name];
+            [config.logger logMessage:logMessage withLevel:OptimizelyLogLevelWarning];
+        }
+        return NULL;
+    }
+    
+    NSNumber *ourValue = (NSNumber *)self.value;
+    NSNumber *userValue = (NSNumber *)userAttribute;
+    return [NSNumber numberWithBool: ([userValue doubleValue] > [ourValue doubleValue])];
 }
 
--(nullable NSNumber *)evaluateMatchTypeLessThan:(NSDictionary<NSString *, NSObject *> *)attributes{
+- (nullable NSNumber *)evaluateMatchTypeLessThan:(NSDictionary<NSString *, NSObject *> *)attributes projectConfig:(nullable OPTLYProjectConfig *)config {
     // check if user attributes contain a value lesser than our value
-    NSObject *userAttribute = [attributes objectForKey:self.name];
-    BOOL userValueAndOurValueHaveNSNumberClassTypes = [self.value isValidNumericAttributeValue] && [userAttribute isValidNumericAttributeValue];
 
-    if (userValueAndOurValueHaveNSNumberClassTypes) {
-        NSNumber *ourValue = (NSNumber *)self.value;
-        NSNumber *userValue = (NSNumber *)userAttribute;
-        return [NSNumber numberWithBool: ([userValue doubleValue] < [ourValue doubleValue])];
+    // check if condition value is invalid
+    if (![self.value isValidGTLTMatchTypeValue]) {
+        return NULL;
     }
-    return NULL;
+    // check if attributes exists
+    if (![attributes.allKeys containsObject:self.name]) {
+        NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesAudienceEvaluatorConditionEvaluatedAsUnknownForMissingAttribute, self.stringRepresentation, self.name];
+        [config.logger logMessage:logMessage withLevel:OptimizelyLogLevelDebug];
+        return NULL;
+    }
+    // check if user attributes are invalid
+    NSObject *userAttribute = [attributes objectForKey:self.name];
+    if (![userAttribute isValidNumericAttributeValue]) {
+        // Log Invalid Attribute Value Type
+        if (!userAttribute || [userAttribute isKindOfClass:[NSNull class]]) {
+            NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesAudienceEvaluatorConditionEvaluatedAsUnknownForUnexpectedTypeNull, self.stringRepresentation, self.name];
+            [config.logger logMessage:logMessage withLevel:OptimizelyLogLevelWarning];
+        }
+        else {
+            NSString *userAttributeClassName = NSStringFromClass([userAttribute class]);
+            NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesAudienceEvaluatorConditionEvaluatedAsUnknownForUnexpectedType, self.stringRepresentation, userAttributeClassName, self.name];
+            [config.logger logMessage:logMessage withLevel:OptimizelyLogLevelWarning];
+        }
+        return NULL;
+    }
+    
+    NSNumber *ourValue = (NSNumber *)self.value;
+    NSNumber *userValue = (NSNumber *)userAttribute;
+    return [NSNumber numberWithBool: ([userValue doubleValue] < [ourValue doubleValue])];
 }
 
--(nullable NSNumber *)evaluateCustomMatchType:(NSDictionary<NSString *, NSObject *> *)attributes {
+- (nullable NSNumber *)evaluateCustomMatchType:(NSDictionary<NSString *, NSObject *> *)attributes projectConfig:(nullable OPTLYProjectConfig *)config {
 
     if (![self.type isEqual:OPTLYDatafileKeysCustomAttributeConditionType]){
         //Check if given type is the required type
+        NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesAudienceEvaluatorUnknownConditionType, self.stringRepresentation];
+        [config.logger logMessage:logMessage withLevel:OptimizelyLogLevelWarning];
         return NULL;
     }
     else if (self.value == NULL && ![self.match isEqualToString:OPTLYDatafileKeysMatchTypeExists]){
@@ -116,21 +215,23 @@ -(nullable NSNumber *)evaluateCustomMatchType:(NSDictionary<NSString *, NSObject
 
     SWITCH(self.match){
         CASE(OPTLYDatafileKeysMatchTypeExact) {
-            return [self evaluateMatchTypeExact: attributes];
+            return [self evaluateMatchTypeExact: attributes projectConfig:config];
         }
         CASE(OPTLYDatafileKeysMatchTypeExists) {
-            return [self evaluateMatchTypeExist: attributes];
+            return [self evaluateMatchTypeExist: attributes projectConfig:config];
         }
         CASE(OPTLYDatafileKeysMatchTypeSubstring) {
-            return [self evaluateMatchTypeSubstring: attributes];
+            return [self evaluateMatchTypeSubstring: attributes projectConfig:config];
         }
         CASE(OPTLYDatafileKeysMatchTypeGreaterThan) {
-            return [self evaluateMatchTypeGreaterThan: attributes];
+            return [self evaluateMatchTypeGreaterThan: attributes projectConfig:config];
         }
         CASE(OPTLYDatafileKeysMatchTypeLessThan) {
-            return [self evaluateMatchTypeLessThan: attributes];
+            return [self evaluateMatchTypeLessThan: attributes projectConfig:config];
         }
         DEFAULT {
+            NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesAudienceEvaluatorUnknownMatchType, self.stringRepresentation];
+            [config.logger logMessage:logMessage withLevel:OptimizelyLogLevelWarning];
             return NULL;
         }
     }
@@ -139,9 +240,9 @@ -(nullable NSNumber *)evaluateCustomMatchType:(NSDictionary<NSString *, NSObject
 /**
  * Evaluates the condition against the user attributes, returns NULL if invalid.
  */
-- (nullable NSNumber *)evaluateConditionsWithAttributes:(NSDictionary<NSString *, NSObject *> *)attributes projectConfig:(nullable OPTLYProjectConfig *)config {
+- (nullable NSNumber *)evaluateConditionsWithAttributes:(nullable NSDictionary<NSString *, NSObject *> *)attributes projectConfig:(nullable OPTLYProjectConfig *)config {
     // check user attribute value for the condition and match type against our condition value
-    return [self evaluateCustomMatchType: attributes];
+    return [self evaluateCustomMatchType: attributes projectConfig:config];
 }
 
 @end