refactor(EventBuilder): Moved decision service and bucketing from EventBuilder to Optimizely (#306)

* Send decisions for all experiments using an event

* nits

* accept tags as event tags even if not convertible to revenue or value tag

* Optimizely refactored

* make projectConfig a private property of EventBuilder instead passing it to every method

* impression event refactored

* track and conversion refactored

* test cases

* fixed test cases

* Optimizely coverage increased

* EventBuilder coverage increased

* LoggerMessages refactored

* removed params validation from eventBuilder methods, 
updated license headers, 
removed unused loggerMessages

* removed 'ticket' from eventBuilder methods and separated event tags work from EventBuilder class by making it a Util

Author: arafay-folio3

OptimizelySDKCore/OptimizelySDKCore.xcodeproj/project.pbxproj

@@ -217,6 +217,10 @@
 		5E4C07FC1DFF66B00042B1F8 /* OPTLYNetworkServiceTest.m in Sources */ = {isa = PBXBuildFile; fileRef = 5E4C07FA1DFF66B00042B1F8 /* OPTLYNetworkServiceTest.m */; };
 		5ECBBE681DDE6A800028FF6B /* OPTLYVariable.h in Headers */ = {isa = PBXBuildFile; fileRef = 5ECBBE661DDE6A800028FF6B /* OPTLYVariable.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		5ECBBE691DDE6A800028FF6B /* OPTLYVariable.m in Sources */ = {isa = PBXBuildFile; fileRef = 5ECBBE671DDE6A800028FF6B /* OPTLYVariable.m */; };
+		9084F7812150D4F700ACBA99 /* OPTLYEventTagUtil.h in Headers */ = {isa = PBXBuildFile; fileRef = 9084F77F2150D4F700ACBA99 /* OPTLYEventTagUtil.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		9084F7822150D4F800ACBA99 /* OPTLYEventTagUtil.h in Headers */ = {isa = PBXBuildFile; fileRef = 9084F77F2150D4F700ACBA99 /* OPTLYEventTagUtil.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		9084F7832150D4F800ACBA99 /* OPTLYEventTagUtil.m in Sources */ = {isa = PBXBuildFile; fileRef = 9084F7802150D4F700ACBA99 /* OPTLYEventTagUtil.m */; };
+		9084F7842150D4F800ACBA99 /* OPTLYEventTagUtil.m in Sources */ = {isa = PBXBuildFile; fileRef = 9084F7802150D4F700ACBA99 /* OPTLYEventTagUtil.m */; };
 		90855D0020ED254500A97BEC /* OPTLYControlAttributes.h in Headers */ = {isa = PBXBuildFile; fileRef = 90855CFC20ED237F00A97BEC /* OPTLYControlAttributes.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		90855D0120ED254600A97BEC /* OPTLYControlAttributes.h in Headers */ = {isa = PBXBuildFile; fileRef = 90855CFC20ED237F00A97BEC /* OPTLYControlAttributes.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		90855D0D20ED2E0100A97BEC /* OPTLYControlAttributes.m in Sources */ = {isa = PBXBuildFile; fileRef = 90855D0420ED2B0200A97BEC /* OPTLYControlAttributes.m */; };
@@ -614,6 +618,8 @@
 		5ECBBE671DDE6A800028FF6B /* OPTLYVariable.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OPTLYVariable.m; sourceTree = "<group>"; };
 		8766E217ECD3BEA353B080F5 /* Pods_OptimizelySDKCoreiOSTests.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_OptimizelySDKCoreiOSTests.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		8B04E0101E180FAD8C9CA7A6 /* Pods_OptimizelySDKCoreiOS.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_OptimizelySDKCoreiOS.framework; sourceTree = BUILT_PRODUCTS_DIR; };
+		9084F77F2150D4F700ACBA99 /* OPTLYEventTagUtil.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OPTLYEventTagUtil.h; sourceTree = "<group>"; };
+		9084F7802150D4F700ACBA99 /* OPTLYEventTagUtil.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OPTLYEventTagUtil.m; sourceTree = "<group>"; };
 		90855CFC20ED237F00A97BEC /* OPTLYControlAttributes.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = OPTLYControlAttributes.h; path = OptimizelySDKCore/OPTLYControlAttributes.h; sourceTree = "<group>"; };
 		90855D0420ED2B0200A97BEC /* OPTLYControlAttributes.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = OPTLYControlAttributes.m; path = OptimizelySDKCore/OPTLYControlAttributes.m; sourceTree = "<group>"; };
 		924C83E5511EF3E43FC015AF /* Pods-OptimizelySDKCoreTVOSTests.rc.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-OptimizelySDKCoreTVOSTests.rc.xcconfig"; path = "../Pods/Target Support Files/Pods-OptimizelySDKCoreTVOSTests/Pods-OptimizelySDKCoreTVOSTests.rc.xcconfig"; sourceTree = "<group>"; };
@@ -1004,6 +1010,8 @@
 				EA2FAB6E1DC6F5F400B1D81B /* OPTLYLog.m */,
 				EA064BC51DD3FC8800DF7537 /* OPTLYQueue.h */,
 				EA064BC61DD3FC8800DF7537 /* OPTLYQueue.m */,
+				9084F77F2150D4F700ACBA99 /* OPTLYEventTagUtil.h */,
+				9084F7802150D4F700ACBA99 /* OPTLYEventTagUtil.m */,
 			);
 			name = Utilities;
 			sourceTree = "<group>";
@@ -1350,6 +1358,7 @@
 				EA2FAAE21DC6F57200B1D81B /* OPTLYEventMetric.h in Headers */,
 				EA2FAA8E1DC6F57100B1D81B /* OPTLYAudience.h in Headers */,
 				EA2FAA9A1DC6F57100B1D81B /* OPTLYCondition.h in Headers */,
+				9084F7812150D4F700ACBA99 /* OPTLYEventTagUtil.h in Headers */,
 				EA16D9361ECBA9B200C4C998 /* OPTLYUserProfile.h in Headers */,
 				EA16D93C1ECBD90E00C4C998 /* OPTLYExperimentBucketMapEntity.h in Headers */,
 				EA8FD0DF1DE9798E00D950AD /* OPTLYNetworkService.h in Headers */,
@@ -1414,6 +1423,7 @@
 				EA2FAAEF1DC6F57200B1D81B /* OPTLYEventRelatedEvent.h in Headers */,
 				EAC5F3441E7B7DDF00C087B8 /* OPTLYEventDispatcherBasic.h in Headers */,
 				EA16D9371ECBA9B200C4C998 /* OPTLYUserProfile.h in Headers */,
+				9084F7822150D4F800ACBA99 /* OPTLYEventTagUtil.h in Headers */,
 				EA16D93D1ECBD90E00C4C998 /* OPTLYExperimentBucketMapEntity.h in Headers */,
 				EAC5F3541E7B7EEF00C087B8 /* OPTLYUserProfileServiceBasic.h in Headers */,
 				EA2FAAA71DC6F57200B1D81B /* OPTLYDecisionEventTicket.h in Headers */,
@@ -1910,6 +1920,7 @@
 				EA2FAC101DC6FFC600B1D81B /* OPTLYEvent.m in Sources */,
 				3EA563A11FFD23FF00D0E311 /* OPTLYNotificationCenter.m in Sources */,
 				EA16D9441ECCC5C600C4C998 /* OPTLYDecisionService.m in Sources */,
+				9084F7832150D4F800ACBA99 /* OPTLYEventTagUtil.m in Sources */,
 				EAC5F3551E7B7EEF00C087B8 /* OPTLYUserProfileServiceBasic.m in Sources */,
 				EA2FAC111DC6FFC600B1D81B /* OPTLYEventAudience.m in Sources */,
 				EA2FAC121DC6FFC600B1D81B /* OPTLYEventDecision.m in Sources */,
@@ -2000,6 +2011,7 @@
 				EA16D9451ECCC5C600C4C998 /* OPTLYDecisionService.m in Sources */,
 				3EA563A21FFD23FF00D0E311 /* OPTLYNotificationCenter.m in Sources */,
 				EA2FABEC1DC6FFA100B1D81B /* OPTLYEventAudience.m in Sources */,
+				9084F7842150D4F800ACBA99 /* OPTLYEventTagUtil.m in Sources */,
 				EA2FABED1DC6FFA100B1D81B /* OPTLYEventDecision.m in Sources */,
 				EA2FABEE1DC6FFA100B1D81B /* OPTLYEventDecisionTicket.m in Sources */,
 				EA2FABEF1DC6FFA100B1D81B /* OPTLYEventFeature.m in Sources */,

OptimizelySDKCore/OptimizelySDKCore/OPTLYBuilder.m

@@ -74,7 +74,7 @@ - (id)initWithBlock:(OPTLYBuilderBlock)block {
 
     _bucketer = [[OPTLYBucketer alloc] initWithConfig:_config];
     _decisionService = [[OPTLYDecisionService alloc] initWithProjectConfig:_config bucketer:_bucketer];
-    _eventBuilder = [[OPTLYEventBuilderDefault alloc] init];
+    _eventBuilder = [[OPTLYEventBuilderDefault alloc] initWithConfig:_config];
     _notificationCenter = [[OPTLYNotificationCenter alloc] initWithProjectConfig:_config];
 
     return self;

OptimizelySDKCore/OptimizelySDKCore/OPTLYEventBuilder.h

@@ -20,7 +20,7 @@
 
 #import <Foundation/Foundation.h>
 
-@class OPTLYProjectConfig, OPTLYDecisionEventTicket;
+@class OPTLYProjectConfig, OPTLYExperiment, OPTLYVariation, OPTLYEvent;
 @protocol OPTLYBucketer;
 
 // --- Event URLs ----
@@ -34,39 +34,45 @@ NS_ASSUME_NONNULL_END
 /**
  * Create the parameters for an impression event.
  *
- * @param config The project config object.
  * @param userId The ID of the user.
- * @param experimentKey The experiment name.
- * @param variationId The variation ID.
+ * @param experiment The experiment.
+ * @param variation The variation.
  * @param attributes A map of attribute names to current user attribute values.
  * @return A map of parameters for an impression event. This value can be nil.
  *
  */
-- (nullable NSDictionary *)buildImpressionEventTicket:(nonnull OPTLYProjectConfig *)config
-                                         userId:(nonnull NSString *)userId
-                                  experimentKey:(nonnull NSString *)experimentKey
-                                    variationId:(nonnull NSString *)variationId
-                                     attributes:(nullable NSDictionary<NSString *, NSString *> *)attributes;
+- (nullable NSDictionary *)buildImpressionEventForUser:(nonnull NSString *)userId
+                                            experiment:(nonnull OPTLYExperiment *)experiment
+                                             variation:(nonnull OPTLYVariation *)variation
+                                            attributes:(nullable NSDictionary<NSString *, NSString *> *)attributes;
 
 /**
  * Create the parameters for a conversion event.
  *
- * @param config The project config object.
  * @param userId The ID of the user.
- * @param eventName The event name.
+ * @param event The event name.
  * @param eventTags A map of event tag names to event tag values (NSString or NSNumber containing float, double, integer, or boolean).
  * @param attributes A map of attribute names to current user attribute values.
  * @return A map of parameters for a conversion event. This value can be nil.
  *
  */
-- (nullable NSDictionary *)buildConversionTicket:(nonnull OPTLYProjectConfig *)config
-                               bucketer:(nonnull id<OPTLYBucketer>)bucketer
-                                 userId:(nonnull NSString *)userId
-                              eventName:(nonnull NSString *)eventName
-                              eventTags:(nullable NSDictionary *)eventTags
-                             attributes:(nullable NSDictionary<NSString *, NSString *> *)attributes;
+- (nullable NSDictionary *)buildConversionEventForUser:(nonnull NSString *)userId
+                                                 event:(nonnull OPTLYEvent *)event
+                                             decisions:(nonnull NSArray<NSDictionary *> *)decisions
+                                             eventTags:(nullable NSDictionary *)eventTags
+                                            attributes:(nullable NSDictionary<NSString *, NSString *> *)attributes;
 @end
 
 @interface OPTLYEventBuilderDefault : NSObject<OPTLYEventBuilder>
 
+/// init is disabled. Please use initWithConfig to create an Event Builder
+- (instancetype)init NS_UNAVAILABLE;
+
+/**
+ * Initialize the default event build with the project config.
+ * @param config The project config that the event builder will use for event building.
+ * @return The event builder that has been created.
+ */
+- (nullable instancetype)initWithConfig:(nonnull OPTLYProjectConfig *)config;
+
 @end