removed track APIs with revenue as a parameter (#226)

Use event tags to pass in revenue information instead.

Author: arafay-folio3

OptimizelySDKCore/OptimizelySDKCore/Optimizely.h

@@ -22,7 +22,6 @@ extern NSString * _Nonnull const OptimizelyNotificationsUserDictionaryVariationK
 extern NSString * _Nonnull const OptimizelyNotificationsUserDictionaryUserIdKey;
 extern NSString * _Nonnull const OptimizelyNotificationsUserDictionaryAttributesKey;
 extern NSString * _Nonnull const OptimizelyNotificationsUserDictionaryEventNameKey;
-extern NSString * _Nonnull const OptimizelyNotificationsUserDictionaryEventValueKey;
 extern NSString * _Nonnull const OptimizelyNotificationsUserDictionaryExperimentVariationMappingKey;
 
 @class OPTLYProjectConfig, OPTLYVariation, OPTLYDecisionService, OPTLYNotificationCenter;
@@ -201,26 +200,6 @@ extern NSString * _Nonnull const OptimizelyNotificationsUserDictionaryExperiment
 - (void)track:(nonnull NSString *)eventKey
        userId:(nonnull NSString *)userId;
 
-/** @deprecated. Use `track:userId:eventValue`.
- * Track an event
- * @param eventKey The event name
- * @param userId The user ID associated with the event to track
- * @param eventValue The event value (e.g., revenue amount)
- */
-- (void)track:(nonnull NSString *)eventKey
-       userId:(nonnull NSString *)userId
-   eventValue:(nonnull NSNumber *)eventValue __attribute((deprecated("eventValue is deprecated in track call. Use eventTags to pass in revenue value instead.")));
-
-/**
- * Track an event
- * @param eventKey The event name
- * @param userId The user ID associated with the event to track
- * @param eventTags A map of event tag names to event tag values (NSString or NSNumber containing float, double, integer, or boolean)
- */
-- (void)track:(nonnull NSString *)eventKey
-       userId:(nonnull NSString *)userId
-    eventTags:(nonnull NSDictionary<NSString *, id> *)eventTags;
-
 /**
  * Track an event
  * @param eventKey The event name
@@ -231,17 +210,15 @@ extern NSString * _Nonnull const OptimizelyNotificationsUserDictionaryExperiment
        userId:(nonnull NSString *)userId
    attributes:(nonnull NSDictionary<NSString *, NSString *> *)attributes;
 
-/** @deprecated. Use `track:userId:attributes:eventValue`.
+/**
  * Track an event
  * @param eventKey The event name
  * @param userId The user ID associated with the event to track
- * @param attributes A map of attribute names to current user attribute values
- * @param eventValue The event value (e.g., revenue amount)
+ * @param eventTags A map of event tag names to event tag values (NSString or NSNumber containing float, double, integer, or boolean)
  */
 - (void)track:(nonnull NSString *)eventKey
        userId:(nonnull NSString *)userId
-   attributes:(nullable NSDictionary<NSString *, NSString *> *)attributes
-   eventValue:(nullable NSNumber *)eventValue __attribute((deprecated("eventValue is deprecated in track call. Use eventTags to pass in revenue value instead.")));
+    eventTags:(nonnull NSDictionary<NSString *, id> *)eventTags;
 
 /**
  * Track an event
@@ -280,19 +257,16 @@ extern NSString * _Nonnull const OptimizelyNotificationsUserDictionaryExperiment
  */
 + (nullable instancetype)init:(nonnull OPTLYBuilderBlock)builderBlock;
 
-// TODO: remove when eventValue is deprecated
 /**
  * Track an event
  * @param eventKey The event name
  * @param userId The user ID associated with the event to track
  * @param attributes A map of attribute names to current user attribute values.
  * @param eventTags A map of event tag names to event tag values (string, number, or boolean)
- * @param eventValue The event value (e.g., revenue amount)
  */
 - (void)track:(nonnull NSString *)eventKey
        userId:(nonnull NSString *)userId
    attributes:(nullable NSDictionary<NSString *, NSString *> *)attributes
-    eventTags:(nullable NSDictionary<NSString *, id> *)eventTags
-   eventValue:(nullable NSNumber *)eventValue;
+    eventTags:(nullable NSDictionary<NSString *, id> *)eventTags;
 
 @end

OptimizelySDKCore/OptimizelySDKCore/Optimizely.m

@@ -43,7 +43,6 @@
 NSString *const OptimizelyNotificationsUserDictionaryUserIdKey = @"userId";
 NSString *const OptimizelyNotificationsUserDictionaryAttributesKey = @"attributes";
 NSString *const OptimizelyNotificationsUserDictionaryEventNameKey = @"eventKey";
-NSString *const OptimizelyNotificationsUserDictionaryEventValueKey = @"eventValue";
 NSString *const OptimizelyNotificationsUserDictionaryExperimentVariationMappingKey = @"ExperimentVariationMapping";
 
 @implementation Optimizely
@@ -369,66 +368,35 @@ - (NSString *)getFeatureVariableString:(nullable NSString *)featureKey
 }
 
 #pragma mark trackEvent methods
-- (void)track:(NSString *)eventKey userId:(NSString *)userId
-{
-    [self track:eventKey userId:userId attributes:nil eventTags:nil eventValue:nil];
-}
-
-- (void)track:(NSString *)eventKey
-       userId:(NSString *)userId
-   attributes:(NSDictionary<NSString *, NSString *> * )attributes
-{
-    [self track:eventKey userId:userId attributes:attributes eventTags:nil eventValue:nil];
-}
-
-- (void)track:(NSString *)eventKey
-       userId:(NSString *)userId
-   eventValue:(NSNumber *)eventValue
-{
-    [self track:eventKey userId:userId attributes:nil eventTags:nil eventValue:eventValue];
-}
 
-- (void)track:(NSString *)eventKey
-       userId:(NSString *)userId
-    eventTags:(NSDictionary *)eventTags
-{
-    [self track:eventKey userId:userId attributes:nil eventTags:eventTags eventValue:nil];
+- (void)track:(NSString *)eventKey userId:(NSString *)userId {
+    [self track:eventKey userId:userId attributes:nil eventTags:nil];
 }
 
 - (void)track:(NSString *)eventKey
        userId:(NSString *)userId
-   attributes:(NSDictionary *)attributes
-   eventValue:(NSNumber *)eventValue
-{
-    [self track:eventKey userId:userId attributes:attributes eventTags:nil eventValue:eventValue];
+   attributes:(NSDictionary<NSString *, NSString *> * )attributes {
+    [self track:eventKey userId:userId attributes:attributes eventTags:nil];
 }
 
 - (void)track:(NSString *)eventKey
        userId:(NSString *)userId
-   attributes:(NSDictionary *)attributes
-    eventTags:(NSDictionary *)eventTags
-{
-    [self track:eventKey userId:userId attributes:attributes eventTags:eventTags eventValue:nil];
+    eventTags:(NSDictionary<NSString *,id> *)eventTags {
+    [self track:eventKey userId:userId attributes:nil eventTags:eventTags];
 }
 
 - (void)track:(NSString *)eventKey
        userId:(NSString *)userId
-   attributes:(NSDictionary *)attributes
-    eventTags:(NSDictionary *)eventTags
-   eventValue:(NSNumber *)eventValue
-{
+   attributes:(NSDictionary<NSString *,NSString *> *)attributes
+    eventTags:(NSDictionary<NSString *,id> *)eventTags {
+    
     OPTLYEvent *event = [self.config getEventForKey:eventKey];
 
     if (!event) {
         [self handleErrorLogsForTrackEvent:eventKey userId:userId];
         return;
     }
 
-    // eventValue and eventTags are mutually exclusive
-    if (eventValue) {
-        eventTags = @{ OPTLYEventMetricNameRevenue: eventValue };
-    }
-    
     NSDictionary *conversionEventParams = [self.eventBuilder buildConversionTicket:self.config
                                                                           bucketer:self.bucketer
                                                                             userId:userId
@@ -463,9 +431,6 @@ - (void)track:(NSString *)eventKey
     if (attributes != nil) {
         userInfo[OptimizelyNotificationsUserDictionaryAttributesKey] = attributes;
     }
-    if (eventValue != nil) {
-        userInfo[OptimizelyNotificationsUserDictionaryEventValueKey] = eventValue;
-    }
     NSMutableDictionary *experimentVariationMapping = [NSMutableDictionary new];
 
     NSArray *visitors = conversionEventParams[OPTLYEventParameterKeysVisitors];

OptimizelySDKCore/OptimizelySDKCoreTests/OptimizelyTest.m

@@ -30,6 +30,7 @@
 #import "OPTLYFeatureDecision.h"
 #import "OPTLYFeatureVariable.h"
 #import "OPTLYNotificationCenter.h"
+#import "OPTLYEventMetric.h"
 
 static NSString *const kUserId = @"userId";
 static NSString *const kExperimentKey = @"testExperimentWithFirefoxAudience";
@@ -275,6 +276,22 @@ - (void)testOptimizelyPostEventTrackNotification {
     XCTAssertEqual(eventKey, notificationEventKey);
 }
 
+- (void)testOptimizelyPostEventTrackNotificationWithEventTags {
+    
+    NSString *eventKey = @"testEvent";
+    NSDictionary *eventTags = @{ OPTLYEventMetricNameRevenue: @(2.5)};
+    __block NSString *notificationEventKey = nil;
+    __block NSDictionary *notificationEventTags = nil;
+    
+    [self.optimizely.notificationCenter addTrackNotificationListener:^(NSString * _Nonnull eventKey, NSString * _Nonnull userId, NSDictionary<NSString *,NSString *> * _Nonnull attributes, NSDictionary * _Nonnull eventTags, NSDictionary<NSString *,NSObject *> * _Nonnull event) {
+        notificationEventKey = eventKey;
+        notificationEventTags = eventTags;
+    }];
+    [self.optimizely track:eventKey userId:kUserId eventTags:eventTags];
+    XCTAssertEqual(eventKey, notificationEventKey);
+    XCTAssertEqual(eventTags, notificationEventTags);
+}
+
 # pragma mark - IsFeatureEnabled Tests
 
 // Should return false when arguments are nil or empty.

OptimizelySDKShared/OptimizelySDKShared/OPTLYClient.m

@@ -230,53 +230,26 @@ - (NSString * _Nullable)getFeatureVariableString:(nullable NSString *)featureKey
 }
 
 #pragma mark trackEvent methods
-- (void)track:(NSString *)eventKey userId:(NSString *)userId
-{
-    [self track:eventKey userId:userId attributes:nil eventTags:nil eventValue:nil];
+- (void)track:(NSString *)eventKey userId:(NSString *)userId {
+    [self track:eventKey userId:userId attributes:nil eventTags:nil];
 }
 
 - (void)track:(NSString *)eventKey
        userId:(NSString *)userId
-   attributes:(NSDictionary<NSString *, NSString *> * )attributes
-{
-    [self track:eventKey userId:userId attributes:attributes eventTags:nil eventValue:nil];
+   attributes:(NSDictionary<NSString *, NSString *> * )attributes {
+    [self track:eventKey userId:userId attributes:attributes eventTags:nil];
 }
 
 - (void)track:(NSString *)eventKey
-       userId:(NSString *)userId
-   eventValue:(NSNumber *)eventValue
-{
-    [self track:eventKey userId:userId attributes:nil eventTags:nil eventValue:eventValue];
-}
-
-- (void)track:(NSString *)eventKey
-       userId:(NSString *)userId
-    eventTags:(NSDictionary *)eventTags
-{
-    [self track:eventKey userId:userId attributes:nil eventTags:eventTags eventValue:nil];
-}
-
-- (void)track:(NSString *)eventKey
-       userId:(NSString *)userId
-   attributes:(NSDictionary *)attributes
-   eventValue:(NSNumber *)eventValue
-{
-    [self track:eventKey userId:userId attributes:attributes eventTags:nil eventValue:eventValue];
+      userId:(NSString *)userId
+   eventTags:(NSDictionary<NSString *,id> *)eventTags {
+    [self track:eventKey userId:userId attributes:nil eventTags:eventTags];
 }
 
 - (void)track:(NSString *)eventKey
-       userId:(NSString *)userId
-   attributes:(NSDictionary *)attributes
-    eventTags:(NSDictionary *)eventTags
-{
-    [self track:eventKey userId:userId attributes:attributes eventTags:eventTags eventValue:nil];
-}
-
-- (void)track:(NSString *)eventKey
-       userId:(NSString *)userId
-   attributes:(NSDictionary *)attributes
-    eventTags:(NSDictionary *)eventTags
-   eventValue:(NSNumber *)eventValue {
+      userId:(NSString *)userId
+  attributes:(NSDictionary<NSString *,NSString *> *)attributes
+   eventTags:(NSDictionary<NSString *,id> *)eventTags {
     if (self.optimizely == nil) {
         [self.logger logMessage:OPTLYLoggerMessagesClientDummyOptimizelyError
                       withLevel:OptimizelyLogLevelError];
@@ -285,8 +258,7 @@ - (void)track:(NSString *)eventKey
     [self.optimizely track:eventKey
                     userId:userId
                 attributes:attributes
-                 eventTags:eventTags
-                eventValue:eventValue];
+                 eventTags:eventTags];
 }
 
 - (NSString *)description {