(feat): easy event tracking. (#359)

thomaszurkan-optimizely · aliabbasrizvi · commit 1425d4b229c5 · 2019-01-22T13:39:10.000-08:00
diff --git a/OptimizelySDKCore/OptimizelySDKCore/OPTLYEventBuilder.h b/OptimizelySDKCore/OptimizelySDKCore/OPTLYEventBuilder.h
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2016,2018, Optimizely, Inc. and contributors                   *
+ * Copyright 2016-2019 Optimizely, Inc. and contributors                   *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *
@@ -57,7 +57,6 @@ NS_ASSUME_NONNULL_END
  */
 - (nullable NSDictionary *)buildConversionEventForUser:(nonnull NSString *)userId
                                                  event:(nonnull OPTLYEvent *)event
-                                             decisions:(nonnull NSArray<NSDictionary *> *)decisions
                                              eventTags:(nullable NSDictionary *)eventTags
                                             attributes:(nullable NSDictionary<NSString *, NSObject *> *)attributes;
 @end
diff --git a/OptimizelySDKCore/OptimizelySDKCore/OPTLYEventBuilder.m b/OptimizelySDKCore/OptimizelySDKCore/OPTLYEventBuilder.m
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2016,2018, Optimizely, Inc. and contributors                   *
+ * Copyright 2016,2018-2019, Optimizely, Inc. and contributors                   *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *
@@ -70,7 +70,6 @@ -(NSDictionary *)buildImpressionEventForUser:(NSString *)userId
 
 -(NSDictionary *)buildConversionEventForUser:(NSString *)userId
                                        event:(OPTLYEvent *)event
-                                   decisions:(NSArray<NSDictionary *> *)decisions
                                    eventTags:(NSDictionary *)eventTags
                                   attributes:(NSDictionary<NSString *, NSObject *> *)attributes {
 
@@ -80,7 +79,7 @@ -(NSDictionary *)buildConversionEventForUser:(NSString *)userId
     
     NSDictionary *commonParams = [self createCommonParamsForUser:userId attributes:attributes];
     NSArray *conversionOnlyParams = [self createConversionParamsOfEvent:event userId:userId
-                                                              decisions:decisions eventTags:eventTags
+                                                              eventTags:eventTags
                                                              attributes:attributes];
     NSDictionary *conversionParams = [self createImpressionOrConversionParamsWithCommonParams:commonParams conversionOrImpressionOnlyParams:conversionOnlyParams];
     
@@ -99,6 +98,8 @@ - (NSDictionary *)createCommonParamsForUser:(NSString *)userId
     commonParams[OPTLYEventParameterKeysVisitors] = @[visitor];
     commonParams[OPTLYEventParameterKeysProjectId] = [self.config.projectId getStringOrEmpty];
     commonParams[OPTLYEventParameterKeysAccountId] = [self.config.accountId getStringOrEmpty];
+    commonParams[OPTLYEventParameterKeysEnrichDecisions] = @YES;
+
     commonParams[OPTLYEventParameterKeysClientEngine] = [[self.config clientEngine] getStringOrEmpty];
     commonParams[OPTLYEventParameterKeysClientVersion] = [[self.config clientVersion] getStringOrEmpty];
     commonParams[OPTLYEventParameterKeysRevision] = [self.config.revision getStringOrEmpty];
@@ -142,7 +143,6 @@ - (NSDictionary *)createImpressionOrConversionParamsWithCommonParams:(NSDictiona
 
 - (NSArray *)createConversionParamsOfEvent:(OPTLYEvent *)event
                                     userId:(NSString *)userId
-                                 decisions:(NSArray<NSDictionary *> *)decisions
                                  eventTags:(NSDictionary *)eventTags
                                 attributes:(NSDictionary *)attributes {
     
@@ -175,7 +175,6 @@ - (NSArray *)createConversionParamsOfEvent:(OPTLYEvent *)event
         }
     }
     
-    snapshot[OPTLYEventParameterKeysDecisions] = decisions;
     snapshot[OPTLYEventParameterKeysEvents] = @[eventDict];
     
     [conversionEventParams addObject:snapshot];
diff --git a/OptimizelySDKCore/OptimizelySDKCore/OPTLYEventParameterKeys.h b/OptimizelySDKCore/OptimizelySDKCore/OPTLYEventParameterKeys.h
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2016-2018, Optimizely, Inc. and contributors                   *
+ * Copyright 2016-2019, Optimizely, Inc. and contributors                   *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *
@@ -21,6 +21,7 @@ NS_ASSUME_NONNULL_BEGIN
 // --- Base Parameters ----
 extern NSString * const OPTLYEventParameterKeysAccountId;
 extern NSString * const OPTLYEventParameterKeysProjectId;
+extern NSString * const OPTLYEventParameterKeysEnrichDecisions;
 extern NSString * const OPTLYEventParameterKeysVisitors;
 extern NSString * const OPTLYEventParameterKeysAnonymizeIP;
 extern NSString * const OPTLYEventParameterKeysClientEngine;
diff --git a/OptimizelySDKCore/OptimizelySDKCore/OPTLYEventParameterKeys.m b/OptimizelySDKCore/OptimizelySDKCore/OPTLYEventParameterKeys.m
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2016-2018, Optimizely, Inc. and contributors                   *
+ * Copyright 2016-2019, Optimizely, Inc. and contributors                   *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *
@@ -19,6 +19,7 @@
 // --- Base Parameters ----
 NSString * const OPTLYEventParameterKeysAccountId                       = @"account_id";        // nonnull
 NSString * const OPTLYEventParameterKeysProjectId                       = @"project_id";
+NSString * const OPTLYEventParameterKeysEnrichDecisions                 = @"enrich_decisions";
 NSString * const OPTLYEventParameterKeysVisitors                        = @"visitors";          // nonnull
 NSString * const OPTLYEventParameterKeysAnonymizeIP                     = @"anonymize_ip";
 NSString * const OPTLYEventParameterKeysClientEngine                    = @"client_name";
diff --git a/OptimizelySDKCore/OptimizelySDKCore/Optimizely.m b/OptimizelySDKCore/OptimizelySDKCore/Optimizely.m
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2017-2018, Optimizely, Inc. and contributors                   *
+ * Copyright 2017-2019, Optimizely, Inc. and contributors                   *
  *                                                                          *
  * Licensed under the Apache License, Version 2.0 (the "License");          *
  * you may not use this file except in compliance with the License.         *
@@ -447,17 +447,8 @@ - (void)track:(NSString *)eventKey
         return;
     }
     
-    NSArray *decisions = [self decisionsFor:event userId:userId attributes:attributes];
-    
-    if ([decisions getValidArray] == nil) {
-        NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesConversionFailure, eventKey];
-        [self handleErrorLogsForTrack:logMessage ofLevel:OptimizelyLogLevelInfo];
-        return;
-    }
-    
     NSDictionary *conversionEventParams = [self.eventBuilder buildConversionEventForUser:userId
                                                                                    event:event
-                                                                               decisions:decisions
                                                                                eventTags:eventTags
                                                                               attributes:attributes];
     if ([conversionEventParams getValidDictionary] == nil) {
@@ -909,57 +900,6 @@ - (OPTLYVariation *)sendImpressionEventFor:(OPTLYExperiment *)experiment
     return variation;
 }
 
-/**
- Helper method to retrieve decisions for the user from the provided event.
-
- @param event The event which needs to be recorded.
- @param userId Id for user.
- @param attributes The user's attributes.
- @return Array of dictionaries containing valid experiment Ids, variation Ids and layer Ids into which the user is bucketed.
- */
-- (NSArray<NSDictionary *> *)decisionsFor:(OPTLYEvent *)event
-                                   userId:(NSString *)userId
-                               attributes:(NSDictionary<NSString *, NSObject *> *)attributes {
-    
-    NSArray *experimentIds = event.experimentIds;
-    
-    if ([experimentIds count] == 0) {
-        NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesTrackEventNoAssociation, event.eventKey];
-        [self handleErrorLogsForTrack:logMessage ofLevel:OptimizelyLogLevelDebug];
-        return nil;
-    }
-    
-    NSMutableArray *decisions = [NSMutableArray new];
-    
-    for (NSString *experimentId in experimentIds) {
-        OPTLYExperiment *experiment = [self.config getExperimentForId:experimentId];
-        
-        // if the experiment is nil, then it is not part of the project's list of experiments
-        if (!experiment) {
-            NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesTrackExperimentNoAssociation, experiment.experimentKey, event.eventKey];
-            [self handleErrorLogsForTrack:logMessage ofLevel:OptimizelyLogLevelDebug];
-            continue;
-        }
-        
-        // bucket user into a variation
-        OPTLYVariation *variation = [self variation:experiment.experimentKey userId:userId attributes:attributes];
-        
-        // if the variation is nil, then experiment should not be tracked
-        if (!variation) {
-            NSString *logMessage = [NSString stringWithFormat:OPTLYLoggerMessagesTrackExperimentNotTracked, userId, experiment.experimentKey];
-            [self handleErrorLogsForTrack:logMessage ofLevel:OptimizelyLogLevelDebug];
-            continue;
-        }
-        
-        NSMutableDictionary *decision = [NSMutableDictionary new];
-        decision[OPTLYEventParameterKeysDecisionCampaignId]         = [experiment.layerId getStringOrEmpty];
-        decision[OPTLYEventParameterKeysDecisionExperimentId]       = experiment.experimentId;
-        decision[OPTLYEventParameterKeysDecisionVariationId]        = variation.variationId;
-        [decisions addObject:decision];
-    }
-    return decisions;
-}
-                                      
 + (BOOL)isEmptyArray:(NSObject*)array {
     return (!array
             || ![array isKindOfClass:[NSArray class]]
diff --git a/OptimizelySDKCore/OptimizelySDKCoreTests/OPTLYEventBuilderTest.m b/OptimizelySDKCore/OptimizelySDKCoreTests/OPTLYEventBuilderTest.m
diff --git a/OptimizelySDKCore/OptimizelySDKCoreTests/OptimizelyTest.m b/OptimizelySDKCore/OptimizelySDKCoreTests/OptimizelyTest.m
