Alda/event tag crash (#171)

* OASIS-1606: Fixed crash with string event tags.

* Fixed typo in a log string const.

Author: alda-optimizely

OptimizelySDKCore/OptimizelySDKCore/OPTLYEventBuilder.m

@@ -121,19 +121,36 @@ - (NSDictionary *)buildEventTicket:(OPTLYProjectConfig *)config
 
     // Allow only 'revenue' eventTags with integer values (max long long); otherwise the value will be cast to an integer
     NSMutableDictionary *mutableEventTags = [[NSMutableDictionary alloc] initWithDictionary:eventTags];
+    
     if ([[eventTags allKeys] containsObject:OPTLYEventMetricNameRevenue]) {
-        if (!(strcmp([eventTags[OPTLYEventMetricNameRevenue] objCType], @encode(short)) == 0 ||
-              strcmp([eventTags[OPTLYEventMetricNameRevenue] objCType], @encode(int)) == 0 ||
-              strcmp([eventTags[OPTLYEventMetricNameRevenue] objCType], @encode(long)) == 0 ||
-              strcmp([eventTags[OPTLYEventMetricNameRevenue] objCType], @encode(long long)) == 0 ||
-              strcmp([eventTags[OPTLYEventMetricNameRevenue] objCType], @encode(unsigned short)) == 0 ||
-              strcmp([eventTags[OPTLYEventMetricNameRevenue] objCType], @encode(unsigned int)) == 0 ||
-              strcmp([eventTags[OPTLYEventMetricNameRevenue] objCType], @encode(unsigned long)) == 0 ||
-              strcmp([eventTags[OPTLYEventMetricNameRevenue] objCType], @encode(unsigned long long)) == 0)) {
-            [config.logger logMessage:OPTLYLoggerMessagesRevenueValueInvalid withLevel:OptimizelyLogLevelWarning];
+        
+        id revenueValue = eventTags[OPTLYEventMetricNameRevenue];
+            
+        // if the object is an NSNumber, then char, floats, and boolean values will be cast to a long long int
+        if ([revenueValue isKindOfClass:[NSNumber class]]) {
+            if (!(strcmp([eventTags[OPTLYEventMetricNameRevenue] objCType], @encode(short)) == 0 ||
+                  strcmp([eventTags[OPTLYEventMetricNameRevenue] objCType], @encode(int)) == 0 ||
+                  strcmp([eventTags[OPTLYEventMetricNameRevenue] objCType], @encode(long)) == 0 ||
+                  strcmp([eventTags[OPTLYEventMetricNameRevenue] objCType], @encode(long long)) == 0 ||
+                  strcmp([eventTags[OPTLYEventMetricNameRevenue] objCType], @encode(unsigned short)) == 0 ||
+                  strcmp([eventTags[OPTLYEventMetricNameRevenue] objCType], @encode(unsigned int)) == 0 ||
+                  strcmp([eventTags[OPTLYEventMetricNameRevenue] objCType], @encode(unsigned long)) == 0 ||
+                  strcmp([eventTags[OPTLYEventMetricNameRevenue] objCType], @encode(unsigned long long)) == 0)) {
+                NSNumber *revenueValue = eventTags[OPTLYEventMetricNameRevenue];
+                long long revenueValueCast = [revenueValue longLongValue];
+                mutableEventTags[OPTLYEventMetricNameRevenue] = [NSNumber numberWithLongLong:revenueValueCast];
+                [config.logger logMessage:[NSString stringWithFormat:OPTLYLoggerMessagesReveneuValueInvalidInteger, revenueValueCast] withLevel:OptimizelyLogLevelWarning];
+            }
+        // cast strings to int
+        } else if ([revenueValue isKindOfClass:[NSString class]]) {
             NSNumber *revenueValue = eventTags[OPTLYEventMetricNameRevenue];
-            long long revenueValueCast = revenueValue.longLongValue;
+            long long revenueValueCast = [revenueValue longLongValue];
+            [config.logger logMessage:[NSString stringWithFormat:OPTLYLoggerMessagesRevenueValueString, revenueValueCast] withLevel:OptimizelyLogLevelWarning];
             mutableEventTags[OPTLYEventMetricNameRevenue] = [NSNumber numberWithLongLong:revenueValueCast];
+        // all other objects can't be cast to an integer
+        } else {
+            [config.logger logMessage:OPTLYLoggerMessagesRevenueValueInvalid withLevel:OptimizelyLogLevelWarning];
+            [mutableEventTags removeObjectForKey:OPTLYEventMetricNameRevenue];
         }
     }
 

OptimizelySDKCore/OptimizelySDKCore/OPTLYLoggerMessages.h

@@ -101,6 +101,8 @@ extern NSString *const OPTLYLoggerMessagesNotBuildingDecisionEventTicket;
 extern NSString *const OPTLYLoggerMessagesUserIdInvalid;
 extern NSString *const OPTLYLoggerMessagesVariationIdInvalid;
 extern NSString *const OPTLYLoggerMessagesEventNotPassAudienceEvaluation;
+extern NSString *const OPTLYLoggerMessagesReveneuValueInvalidInteger;
+extern NSString *const OPTLYLoggerMessagesRevenueValueString;
 extern NSString *const OPTLYLoggerMessagesRevenueValueInvalid;
 extern NSString *const OPTLYLoggerMessagesEventTagValueInvalid;
 

OptimizelySDKCore/OptimizelySDKCore/OPTLYLoggerMessages.m

@@ -97,7 +97,9 @@
 NSString *const OPTLYLoggerMessagesUserIdInvalid = @"[EVENT BUILDER] User ID cannot be an empty string.";
 NSString *const OPTLYLoggerMessagesVariationIdInvalid = @"[EVENT BUILDER] Variation ID cannot be an empty string.";
 NSString *const OPTLYLoggerMessagesEventNotPassAudienceEvaluation = @"[EVENT BUILDER] None of the experiments of %@ pass audience evaluation.";
-NSString *const OPTLYLoggerMessagesRevenueValueInvalid = @"[EVENT BUILDER] Provided revenue value is not an integer.";
+NSString *const OPTLYLoggerMessagesReveneuValueInvalidInteger = @"[EVENT BUILDER] Provided revenue value is an invalid integer type and will be cast to the integer: %llu.";
+NSString *const OPTLYLoggerMessagesRevenueValueString = @"[EVENT BUILDER] Provided revenue value is a string and will be cast to the integer: %llu.";
+NSString *const OPTLYLoggerMessagesRevenueValueInvalid = @"[EVENT BUILDER] Provided revenue value is in an invalid format and will not be sent to results.";
 NSString *const OPTLYLoggerMessagesEventTagValueInvalid = @"[EVENT BUILDER] Provided event tag %@ is neither an integer nor a string; skipping.";
 
 

OptimizelySDKCore/OptimizelySDKCoreTests/OPTLYEventBuilderTest.m

@@ -261,6 +261,59 @@ - (void)testBuildEventTicketWithInvalidBooleanRevenue
              experimentIds:@[kExperimentWithAudienceId]];
 }
 
+- (void)testBuildEventTicketWithInvalidStringRevenue
+{
+    NSString *stringRevenue = @"8.234";
+    long long int castStringRevenue = [stringRevenue longLongValue];
+    
+    NSDictionary *attributes = @{kAttributeKeyBrowserType : kAttributeValueFirefox};
+    
+    NSDictionary *params = [self.eventBuilder buildEventTicket:self.config
+                                                      bucketer:self.bucketer
+                                                        userId:kUserId
+                                                     eventName:kEventWithAudienceName
+                                                     eventTags:@{ OPTLYEventMetricNameRevenue : stringRevenue,
+                                                                  kAttributeKeyBrowserType : kAttributeValueChrome }
+                                                    attributes:attributes];
+    [self checkCommonParams:params withAttributes:attributes];
+    
+    // the revenue value should be cast to an int
+    [self checkEventTicket:params
+                    config:self.config
+                   eventId:kEventWithAudienceId
+                 eventName:kEventWithAudienceName
+                 eventTags:@{ OPTLYEventMetricNameRevenue : [NSNumber numberWithInteger:castStringRevenue],
+                              kAttributeKeyBrowserType : kAttributeValueChrome}
+                attributes:attributes
+                    userId:kUserId
+             experimentIds:@[kExperimentWithAudienceId]];
+}
+
+- (void)testBuildEventTicketWithInvalidObjectRevenue
+{
+    NSDictionary *attributes = @{kAttributeKeyBrowserType : kAttributeValueFirefox};
+    
+    NSDictionary *params = [self.eventBuilder buildEventTicket:self.config
+                                                      bucketer:self.bucketer
+                                                        userId:kUserId
+                                                     eventName:kEventWithAudienceName
+                                                     eventTags:@{ OPTLYEventMetricNameRevenue : attributes,
+                                                                  kAttributeKeyBrowserType : kAttributeValueChrome }
+                                                    attributes:attributes];
+    [self checkCommonParams:params withAttributes:attributes];
+    
+    // no revenue value should be included
+    [self checkEventTicket:params
+                    config:self.config
+                   eventId:kEventWithAudienceId
+                 eventName:kEventWithAudienceName
+                 eventTags:@{ kAttributeKeyBrowserType : kAttributeValueChrome }
+                attributes:attributes
+                    userId:kUserId
+             experimentIds:@[kExperimentWithAudienceId]];
+}
+
+
 - (void)testBuildEventTicketWithEventTags
 {
     NSDictionary *attributes = @{kAttributeKeyBrowserType : kAttributeValueFirefox};