Pull request #10: Feature/data360

HarshRaghavWingify · Parvesh Chauhan · commit c02a7ab54154 · 2023-05-31T09:44:40.000Z
Merge in SST/mobile-testing-ios-sdk from feature/data360 to dev

* commit 'c7614e13009141cab522ba144eaca6ba1382e2e5': (9 commits)
  Fix - Track goal missing on Same Event Name
  ...
diff --git a/Demo/VWO Demo/VWOManager.swift b/Demo/VWO Demo/VWOManager.swift
@@ -22,7 +22,7 @@ class VWOManager {
         VWO.logLevel = .debug
         let config = VWOConfig()
 //        config.setCustomDimension(customDimensionKey: "userId", customDimensionValue: "userName")
-        config.userID = "9c3832ad-15f9-420a-93cd-a7f2cde0f7bc"
+//        config.userID = "9c3832ad-15f9-420a-93cd-a7f2cde0f7bc"
 //        config.isChinaCDN = false
         VWO.launch(apiKey: apiKey, config: config, completion: {
             DispatchQueue.main.async {
diff --git a/VWO/Extensions/NSURLSession+Synchronous.m b/VWO/Extensions/NSURLSession+Synchronous.m
@@ -7,13 +7,34 @@
 //
 
 #import "NSURLSession+Synchronous.h"
+#import "VWOUserDefaults.h"
+#import "VWOConstants.h"
 
 // https://github.com/floschliep/NSURLSession-SynchronousTask
 @implementation NSURLSession (Synchronous)
 
 - (nullable NSData *)sendSynchronousDataTaskWithURL:(nonnull NSURL *)url
                                   returningResponse:(NSURLResponse *_Nullable*_Nullable)response
                                               error:(NSError *_Nullable*_Nullable)error {
+    if(VWOUserDefaults.IsEventArchEnabled != NULL && [VWOUserDefaults.IsEventArchEnabled isEqual:EventArchEnabled]){
+        NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:url];
+        [urlRequest setHTTPMethod:@"POST"];
+        [urlRequest setValue:UserAgentValue forHTTPHeaderField:@"User-Agent"];
+        
+        if(VWOUserDefaults.EventArchData != NULL){
+            NSString *urlString = [url absoluteString];
+            NSMutableDictionary *eventArchData = VWOUserDefaults.EventArchData;
+            NSDictionary *payloadEventArch = [eventArchData objectForKey:urlString];
+            
+            if(payloadEventArch != NULL){
+                NSData *jsonData = [NSJSONSerialization dataWithJSONObject:payloadEventArch options:NSJSONWritingPrettyPrinted error:nil];
+                [urlRequest setHTTPBody:jsonData];
+                [VWOUserDefaults removeEventArchDataItem:urlString];
+            }
+        }
+        
+        return [self sendSynchronousDataTaskWithRequest:urlRequest returningResponse:response error:error];
+    }
     return [self sendSynchronousDataTaskWithRequest:[NSURLRequest requestWithURL:url] returningResponse:response error:error];
 }
 
diff --git a/VWO/Models/VWOCampaign.h b/VWO/Models/VWOCampaign.h
@@ -36,7 +36,7 @@ typedef NS_ENUM(NSInteger, CampaignStatus) {
 -(nullable instancetype)setGroups:(NSDictionary *) campaignDict;
 - (nullable id)variationForKey:(NSString *)key;
 - (nullable id)testKey:(NSString *)testKey;
-- (nullable VWOGoal *)goalForIdentifier:(NSString *)identifier;
+- (nullable NSMutableArray <VWOGoal *>*)goalForIdentifier:(NSString *)identifier;
 
 @end
 
diff --git a/VWO/Models/VWOCampaign.m b/VWO/Models/VWOCampaign.m
@@ -120,14 +120,15 @@ - (nullable id)variationForKey:(NSString *)key {
     return self.variation.changes[key];
 }
 
-- (nullable VWOGoal *)goalForIdentifier:(NSString *)identifier {
+- (nullable NSMutableArray <VWOGoal *>*)goalForIdentifier:(NSString *)identifier {
     NSParameterAssert(identifier);
+    NSMutableArray <VWOGoal *>*matchedGoalsArray = [NSMutableArray new];
     for (VWOGoal *goal in self.goals) {
         if ([goal.identifier isEqualToString:identifier]) {
-            return goal;
+            [matchedGoalsArray addObject:goal];
         }
     }
-    return nil;
+    return matchedGoalsArray;
 }
 
 -(nullable VWOGroup *)groupForMeg{
diff --git a/VWO/Models/VWOGoal.h b/VWO/Models/VWOGoal.h
@@ -20,6 +20,8 @@ typedef NS_ENUM(NSInteger, GoalType) {
 @property(nonatomic, assign) int iD;
 @property NSString *identifier;
 @property (nonatomic, assign) GoalType type;
+@property NSString *revenueProp;
+@property(nonatomic, assign) int mca;
 
 - (nullable instancetype)initWithDictionary:(NSDictionary *)goalDict;
 
diff --git a/VWO/Models/VWOGoal.m b/VWO/Models/VWOGoal.m
@@ -9,20 +9,24 @@
 #import "VWOGoal.h"
 #import "NSDictionary+VWO.h"
 #import "VWOLogger.h"
+#import "VWOConstants.h"
 
-static NSString * kId         = @"id";
-static NSString * kType       = @"type";
-static NSString * kIdentifier = @"identifier";
-
+static NSString * kId          = @"id";
+static NSString * kType        = @"type";
+static NSString * kIdentifier  = @"identifier";
+static NSString * kRevenueProp = @"revenueProp";
+static NSString * kMca         = @"mca";
 @implementation VWOGoal
 
-- (instancetype)initWithId:(int)iD identifier:(NSString *)identifier type:(GoalType)type {
+- (instancetype)initWithId:(int)iD identifier:(NSString *)identifier type:(GoalType)type revenueProp:(NSString *)revenueProp mca:(int)mca{
     NSParameterAssert(identifier);
     self = [super init];
     if (self) {
-        self.iD         = iD;
-        self.identifier = identifier;
-        self.type       = type;
+        self.iD          = iD;
+        self.identifier  = identifier;
+        self.type        = type;
+        self.revenueProp = revenueProp;
+        self.mca         = mca;
     }
     return self;
 }
@@ -40,9 +44,16 @@ - (instancetype)initWithDictionary:(NSDictionary *)goalDict {
     NSString *identifier = goalDict[kIdentifier];
 
     GoalType type = GoalTypeCustom;
-    if([goalDict[kType] isEqualToString:@"REVENUE_TRACKING"]) { type = GoalTypeRevenue; }
+    NSString *revenueProp = @"";
+    
+    NSString *nonConstRevenueTracking = [ConstRevenueTracking copy];
+    if([goalDict[kType] isEqualToString:nonConstRevenueTracking]) {
+        type = GoalTypeRevenue;
+        revenueProp = goalDict[kRevenueProp];
+    }
 
-    return [self initWithId:id identifier:identifier type:type];
+    int mca = [goalDict[kMca] intValue];
+    return [self initWithId:id identifier:identifier type:type revenueProp:revenueProp mca:mca];
 }
 
 - (NSString *)description {
diff --git a/VWO/VWOCampaignFetcher.m b/VWO/VWOCampaignFetcher.m
@@ -65,7 +65,8 @@ + (nullable VWOCampaignArray *)getCampaignsWithTimeout:(NSNumber *)timeout
     //handle NSDict nd NSArray comparison
     NSDictionary *jsonDict = [NSJSONSerialization JSONObjectWithData:data options:0 error:&jsonerror];
     VWOLogDebug(@"%@", jsonDict);
-
+    
+    [self checkForIsEventArchEnabledFlag:jsonDict];
     VWOCampaignArray *allCampaigns = [self EUCheckAndDataFetching:jsonDict];
 
     if (completionBlock) {
@@ -139,4 +140,15 @@ + (VWOCampaignArray *)EUCheckAndDataFetching:(NSDictionary *) jsonDict{
     return newCampaignList;
 }
 
++(void)checkForIsEventArchEnabledFlag:(NSDictionary *)jsonDict{
+    BOOL isEventArchEnabledFlag = [[jsonDict objectForKey:ConstIsEventArchEnabled] boolValue];
+//    BOOL *isEventArchEnabledFlag = [jsonDict objectForKey: ConstIsEventArchEnabled];
+    if(isEventArchEnabledFlag != NULL && isEventArchEnabledFlag == YES){
+        [VWOUserDefaults updateIsEventArchEnabled: EventArchEnabled];
+    }
+    else{
+        [VWOUserDefaults updateIsEventArchEnabled: EventArchDisabled];
+    }
+}
+
 @end
diff --git a/VWO/VWOConstants.h b/VWO/VWOConstants.h
@@ -14,6 +14,48 @@ extern NSString const *ConstCampaignGroups;
 extern NSString const *ConstType;
 extern NSString const *ConstCampaigns;
 extern NSString const *ConstCollectionPrefix;
+extern NSString const *ConstIsEventArchEnabled;
 extern NSString const *ConstAPIVersion;
+extern NSString const *ConstRevenueTracking;
 
 @end
+
+@interface VWOData360Constants : NSObject
+
+extern NSString const *ConstGroups;
+
+extern NSString const *UserAgentValue;
+extern NSString const *EventArchEnabled;
+extern NSString const *EventArchDisabled;
+
+// MARK: - QueryParamsEventArchEnabled
+extern NSString const *APIEventName;
+extern NSString const *TrackUserEventName;
+extern NSString const *PushEventName;
+extern NSString const *AccountID;
+extern NSString const *APIKey;
+extern NSString const *CurrentTimeInMillis;
+extern NSString const *Random;
+
+// MARK: - Data360PayloadParams
+extern NSString const *D;
+extern NSString const *MessageID;// uuid-currentTimeStamp in seconds
+extern NSString const *VisitorID;//uuid
+extern NSString const *SessionID;//current timestamp in seconds
+extern NSString const *Event;
+extern NSString const *EventProps;
+extern NSString const *SDKName;//name of the sdk
+extern NSString const *SDKNameValue;
+extern NSString const *SDKVersion;//version of the sdk
+extern NSString const *CampaignID;//id of the campaign
+extern NSString const *VariationID;//id of the variation
+extern NSString const *IsFirst;//this will be sent as 1 always
+extern NSString const *IsCustomEvent;//this will always be sent as true
+extern NSString const *VWOMeta;
+extern NSString const *Metric;
+extern NSString const *InternalVisitor;
+extern NSString const *ExternalVisitor;
+extern NSString const *VisitorProps;
+extern NSString const *Data360EventName;//event name
+extern NSString const *EventTime;//current timestamp in milliseconds
+@end
diff --git a/VWO/VWOConstants.m b/VWO/VWOConstants.m
@@ -20,7 +20,53 @@ @implementation VWOConstants: NSObject
 
 NSString const *ConstCollectionPrefix = @"collectionPrefix";
 
+NSString const *ConstIsEventArchEnabled = @"isEventArchEnabled";
+
+NSString const *ConstRevenueTracking = @"REVENUE_TRACKING";
+
 //for making API calls
 NSString const *ConstAPIVersion = @"3";
 
 @end
+
+@implementation VWOData360Constants: NSObject
+
+//for enabling EventArch
+NSString const *EventArchEnabled = @"eventArchEnabled";
+
+//for disabling EventArch
+NSString const *EventArchDisabled = @"eventArchDisabled";
+
+NSString const *UserAgentValue = @"iOSVwoAb";
+
+//query params
+NSString const *APIEventName = @"en";// value changes based on the current API call
+NSString const *TrackUserEventName = @"vwo_variationShown";
+NSString const *PushEventName = @"vwo_syncVisitorProp";
+NSString const *AccountID = @"a";
+NSString const *APIKey = @"env";
+NSString const *CurrentTimeInMillis = @"eTime";
+NSString const *Random = @"random";
+
+//payloads params
+NSString const *D = @"d";
+NSString const *MessageID = @"msgId";// uuid-currentTimeStamp in seconds
+NSString const *VisitorID = @"visId";//uuid
+NSString const *SessionID = @"sessionId";//current timestamp in seconds
+NSString const *Event = @"event";
+NSString const *EventProps = @"props";
+NSString const *SDKName = @"sdkName";//name of the sdk
+NSString const *SDKNameValue = @"vwo-ios-sdk";
+NSString const *SDKVersion = @"sdkVersion";//version of the sdk
+NSString const *CampaignID = @"id";//id of the campaign
+NSString const *VariationID = @"variation";//id of the variation
+NSString const *IsFirst = @"isFirst";//this will be sent as 1 always
+NSString const *IsCustomEvent = @"isCustomEvent";//this will always be sent as true
+NSString const *VWOMeta = @"vwoMeta";
+NSString const *Metric = @"metric";
+NSString const *InternalVisitor = @"$visitor";
+NSString const *ExternalVisitor = @"visitor";
+NSString const *VisitorProps = @"props";
+NSString const *Data360EventName = @"name";//event name
+NSString const *EventTime = @"time";//current timestamp in milliseconds
+@end
diff --git a/VWO/VWOController.m b/VWO/VWOController.m
@@ -10,6 +10,7 @@
 #import "VWOSocketConnector.h"
 #import "VWOLogger.h"
 #import "VWOCampaign.h"
+#import "VWOConstants.h"
 #import "VWOURLQueue.h"
 #import "VWOFile.h"
 #import "VWOURL.h"
@@ -203,30 +204,62 @@ - (void)trackConversion:(NSString *)goalIdentifier withValue:(NSNumber *)value {
 
         //Check if the goal is already marked.
     for (VWOCampaign *campaign in _campaignList) {
-        VWOGoal *matchedGoal = [campaign goalForIdentifier:goalIdentifier];
-        if (matchedGoal) {
-
-            if ([VWOUserDefaults isGoalMarked:matchedGoal inCampaign:campaign]) {
-                VWOLogDebug(@"Goal '%@' already marked. Will not be marked again", matchedGoal);
-                return;
+        NSMutableArray <VWOGoal *>*matchedGoals = [campaign goalForIdentifier:goalIdentifier];
+        if([matchedGoals count] == 0){
+            continue;
+        }
+        
+        for(VWOGoal *matchedGoal in matchedGoals){
+            if (matchedGoal) {
+                
+                if ([VWOUserDefaults isGoalMarked:matchedGoal inCampaign:campaign]) {
+                    BOOL isEventArchEnabled = [VWOUserDefaults IsEventArchEnabled];
+                    if(!isEventArchEnabled){
+                        VWOLogDebug(@"Goal '%@' already marked and eventArch is not enabled. Will not be marked again", matchedGoal);
+                        return;
+                    }
+                    if([matchedGoal mca] != -1){
+                        //if mca flag != -1, then goal is not triggered multiple times.
+                        VWOLogDebug(@"Goal '%@' already marked. Will not be marked again", matchedGoal);
+                        return;
+                    }
+                }
             }
         }
     }
 
         // Mark goal(Goal can be present in multiple campaigns
     for (VWOCampaign *campaign in _campaignList) {
-        VWOGoal *matchedGoal = [campaign goalForIdentifier:goalIdentifier];
-        if (matchedGoal) {
-            if ([VWOUserDefaults isTrackingUserForCampaign:campaign]) {
-                [VWOUserDefaults markGoalConversion:matchedGoal inCampaign:campaign];
-                NSURL *url = [_vwoURL forMarkingGoal:matchedGoal
-                                          withValue:value
-                                           campaign:campaign
-                                            dateTime:NSDate.date];
-                NSString *description = [NSString stringWithFormat:@"Goal %@", matchedGoal];
-                [pendingURLQueue enqueue:url maxRetry:10 description:description];
-            } else {
-                VWOLogWarning(@"Goal %@ not tracked for %@ as user is not tracked", matchedGoal, campaign);
+        NSMutableArray <VWOGoal *>*matchedGoals = [campaign goalForIdentifier:goalIdentifier];
+        if([matchedGoals count] == 0){
+            continue;
+        }
+        for(VWOGoal *matchedGoal in matchedGoals){
+            if (matchedGoal) {
+                if ([VWOUserDefaults isTrackingUserForCampaign:campaign]) {
+                    [VWOUserDefaults markGoalConversion:matchedGoal inCampaign:campaign];
+                    
+                    NSURL *url = NULL;
+                    if((VWOUserDefaults.IsEventArchEnabled != NULL) &&
+                        ([VWOUserDefaults.IsEventArchEnabled isEqualToString:EventArchEnabled])){
+                        //for Event based API calls
+                        url = [_vwoURL forMarkingGoalEventArch:matchedGoal
+                                            withValue:value
+                                             campaign:campaign
+                                              dateTime:NSDate.date];
+                    }else{
+                        //for previous version support
+                        url = [_vwoURL forMarkingGoal:matchedGoal
+                                            withValue:value
+                                             campaign:campaign
+                                              dateTime:NSDate.date];
+                    }
+                    
+                    NSString *description = [NSString stringWithFormat:@"Goal %@", matchedGoal];
+                    [pendingURLQueue enqueue:url maxRetry:10 description:description];
+                } else {
+                    VWOLogWarning(@"Goal %@ not tracked for %@ as user is not tracked", matchedGoal, campaign);
+                }
             }
         }
     }
@@ -400,7 +433,17 @@ - (void)trackUserForCampaign:(VWOCampaign *)campaign {
 
     //Send network request and notification only if the campaign is running
 
-    NSURL *url = [_vwoURL forMakingUserPartOfCampaign:campaign dateTime:NSDate.date config: _vwoConfig];
+    NSURL *url = NULL;
+    
+    if((VWOUserDefaults.IsEventArchEnabled != NULL) &&
+       ([VWOUserDefaults.IsEventArchEnabled isEqualToString:EventArchEnabled])){
+        //for Event based API calls
+        url = [_vwoURL forMakingUserPartOfCampaignEventArch:campaign dateTime:NSDate.date config: _vwoConfig];
+    }else{
+        //for previous version support
+        url = [_vwoURL forMakingUserPartOfCampaign:campaign dateTime:NSDate.date config: _vwoConfig];
+    }
+    
     NSString *description = [NSString stringWithFormat:@"Track user %@ %@", campaign, campaign.variation];
     [pendingURLQueue enqueue:url maxRetry:10 description:description];
 
@@ -416,7 +459,18 @@ - (void)pushCustomDimension:(nonnull NSString *)customDimensionKey withCustomDim
         return;
     }
     
-    NSURL *url = [_vwoURL forPushingCustomDimension:customDimensionKey withCustomDimensionValue:customDimensionValue dateTime:NSDate.date];
+    
+    NSURL *url = NULL;
+    
+    if((VWOUserDefaults.IsEventArchEnabled != NULL) &&
+       ([VWOUserDefaults.IsEventArchEnabled isEqualToString:EventArchEnabled])){
+        //for Event based API calls
+        url = [_vwoURL forPushingCustomDimensionEventArch:customDimensionKey withCustomDimensionValue:customDimensionValue dateTime:NSDate.date];
+    }else{
+        //for previous version support
+        url = [_vwoURL forPushingCustomDimension:customDimensionKey withCustomDimensionValue:customDimensionValue dateTime:NSDate.date];
+    }
+    
     NSString *description = [NSString stringWithFormat:@"Custom Dimension %@ %@", customDimensionKey, customDimensionValue];
     [pendingURLQueue enqueue:url maxRetry:10 description:description];
     
diff --git a/VWO/VWOURL.h b/VWO/VWOURL.h
diff --git a/VWO/VWOURL.m b/VWO/VWOURL.m
diff --git a/VWO/VWOUserDefaults.h b/VWO/VWOUserDefaults.h
diff --git a/VWO/VWOUserDefaults.m b/VWO/VWOUserDefaults.m

Original file line number	Diff line number	Diff line change
`@@ -120,14 +120,15 @@ - (nullable id)variationForKey:(NSString *)key {`
`120`	`120`	`return self.variation.changes[key];`
`121`	`121`	`}`
`122`	`122`
`123`		`-- (nullable VWOGoal )goalForIdentifier:(NSString )identifier {`
	`123`	`+- (nullable NSMutableArray <VWOGoal >)goalForIdentifier:(NSString *)identifier {`
`124`	`124`	`NSParameterAssert(identifier);`
	`125`	`+ NSMutableArray <VWOGoal >matchedGoalsArray = [NSMutableArray new];`
`125`	`126`	`for (VWOGoal *goal in self.goals) {`
`126`	`127`	`if ([goal.identifier isEqualToString:identifier]) {`
`127`		`- return goal;`
	`128`	`+ [matchedGoalsArray addObject:goal];`
`128`	`129`	`}`
`129`	`130`	`}`
`130`		`- return nil;`
	`131`	`+ return matchedGoalsArray;`
`131`	`132`	`}`
`132`	`133`
`133`	`134`	`-(nullable VWOGroup *)groupForMeg{`