perf(request): Add UUID logic. Delete on success and permanent failure state

Author: Alexis Oyama

Leanplum-SDK/Classes/Constants.h

@@ -55,7 +55,7 @@
 #define HEARTBEAT_INTERVAL 15 * 60 // 15 minutes
 
 #define MAX_STORED_OCCURRENCES_PER_MESSAGE 100
-#define MAX_STORED_API_CALLS 10000
+#define MAX_ACTIONS_PER_API_CALL 10000
 
 #define DEFAULT_PRIORITY 1000
 
@@ -157,6 +157,7 @@ OBJC_EXPORT NSString *LEANPLUM_DEFAULTS_PRE_LEANPLUM_INSTALL_KEY;
 OBJC_EXPORT NSString *LEANPLUM_DEFAULTS_SDK_VERSION;
 OBJC_EXPORT NSString *LEANPLUM_DEFAULTS_INBOX_KEY;
 OBJC_EXPORT NSString *LEANPLUM_DEFAULTS_APP_VERSION_KEY;
+OBJC_EXPORT NSString *LEANPLUM_DEFAULTS_UUID_KEY;
 
 OBJC_EXPORT NSString *LEANPLUM_SQLITE_NAME;
 
@@ -236,6 +237,7 @@ OBJC_EXPORT NSString *LP_PARAM_UPDATE_DATE;
 OBJC_EXPORT NSString *LP_PARAM_INBOX_MESSAGES;
 OBJC_EXPORT NSString *LP_PARAM_INBOX_MESSAGE_ID;
 OBJC_EXPORT NSString *LP_PARAM_RICH_PUSH_ENABLED;
+OBJC_EXPORT NSString *LP_PARAM_UUID;
 
 OBJC_EXPORT NSString *LP_KEY_VARS;
 OBJC_EXPORT NSString *LP_KEY_MESSAGES;

Leanplum-SDK/Classes/Constants.m

@@ -94,6 +94,7 @@ - (id)init {
 NSString *LEANPLUM_DEFAULTS_SDK_VERSION = @"__leanplum_version";
 NSString *LEANPLUM_DEFAULTS_INBOX_KEY = @"__leanplum_newsfeed";
 NSString *LEANPLUM_DEFAULTS_APP_VERSION_KEY = @"leanplum_savedAppVersionKey";
+NSString *LEANPLUM_DEFAULTS_UUID_KEY = @"__leanplum_uuid";
 
 NSString *LEANPLUM_SQLITE_NAME = @"__leanplum.sqlite";
 
@@ -172,6 +173,7 @@ - (id)init {
 NSString *LP_PARAM_INBOX_MESSAGES = @"newsfeedMessages";
 NSString *LP_PARAM_INBOX_MESSAGE_ID = @"newsfeedMessageId";
 NSString *LP_PARAM_RICH_PUSH_ENABLED = @"richPushEnabled";
+NSString *LP_PARAM_UUID = @"uuid";
 
 NSString *LP_KEY_REASON = @"reason";
 NSString *LP_KEY_STACK_TRACE = @"stackTrace";

Leanplum-SDK/Classes/LPEventDataManager.h

@@ -48,4 +48,9 @@
  */
 + (void)deleteEventsWithLimit:(NSInteger)limit;
 
+/**
+ * Returns the number of total events stored.
+ */
++ (NSInteger)count;
+
 @end

Leanplum-SDK/Classes/LPEventDataManager.m

@@ -95,4 +95,14 @@ + (void)deleteEventsWithLimit:(NSInteger)limit
     [[LPDatabase database] runQuery:query];
 }
 
++ (NSInteger)count
+{
+    NSArray *rows = [[LPDatabase database] rowsFromQuery:@"SELECT count(*) FROM event;"];
+    if (!rows || !rows.count) {
+        return 0;
+    }
+    
+    return [rows.firstObject[@"count(*)"] integerValue];
+}
+
 @end

Leanplum-SDK/Classes/LPRequestStorage.m

@@ -97,8 +97,8 @@ - (void)migrateRequests
  */
 - (void)saveRequests:(NSMutableArray *)requests
 {
-    if (requests.count > MAX_STORED_API_CALLS) {
-        NSRange range = NSMakeRange(0, requests.count - MAX_STORED_API_CALLS);
+    if (requests.count > MAX_ACTIONS_PER_API_CALL) {
+        NSRange range = NSMakeRange(0, requests.count - MAX_ACTIONS_PER_API_CALL);
         [requests removeObjectsInRange:range];
     }
 

Leanplum-SDK/Classes/Leanplum.m

@@ -3466,7 +3466,7 @@ - (BOOL)boolNamed:(NSString *)name
 {
     if ([Utils isNullOrEmpty:name]) {
         [Leanplum throwError:@"[LPActionContext boolNamed:] Empty name parameter provided."];
-        return nil;
+        return NO;
     }
     LP_TRY
     id object = [self objectNamed:name];

Leanplum-SDK/Classes/LeanplumRequest.h

@@ -81,8 +81,6 @@
  */
 - (void)sendDatasNow:(NSDictionary *)datas;
 
-+ (void)pushUnsentRequests:(NSArray *)requestData;
-
 - (void)downloadFile:(NSString *)path;
 
 + (int)numPendingDownloads;

Leanplum-SDK/Classes/LeanplumRequest.m

@@ -178,6 +178,15 @@ + (LeanplumRequest *)post:(NSString *)apiMethod params:(NSDictionary *)params
     return [[LeanplumRequest alloc] initWithHttpMethod:@"POST" apiMethod:apiMethod params:params];
 }
 
++ (NSString *)generateUUID
+{
+    NSString *uuid = [[NSUUID UUID] UUIDString];
+    NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
+    [userDefaults setObject:uuid forKey:LEANPLUM_DEFAULTS_UUID_KEY];
+    [userDefaults synchronize];
+    return uuid;
+}
+
 - (void)onResponse:(LPNetworkResponseBlock)response
 {
     _response = [response copy];
@@ -191,15 +200,16 @@ - (void)onError:(LPNetworkErrorBlock)error
 - (NSMutableDictionary *)createArgsDictionary
 {
     LPConstantsState *constants = [LPConstantsState sharedState];
-    NSMutableDictionary *args = [NSMutableDictionary
-                                 dictionaryWithObjectsAndKeys:
-                                 _apiMethod, LP_PARAM_ACTION,
-                                 deviceId ? deviceId : @"", LP_PARAM_DEVICE_ID,
-                                 userId ? userId : @"", LP_PARAM_USER_ID,
-                                 constants.sdkVersion, LP_PARAM_SDK_VERSION,
-                                 constants.client, LP_PARAM_CLIENT,
-                                 @(constants.isDevelopmentModeEnabled), LP_PARAM_DEV_MODE,
-                                 [NSString stringWithFormat:@"%f", [[NSDate date] timeIntervalSince1970]], LP_PARAM_TIME, nil];
+    NSString *timestamp = [NSString stringWithFormat:@"%f", [[NSDate date] timeIntervalSince1970]];
+    NSMutableDictionary *args = [@{
+                                   LP_PARAM_ACTION: _apiMethod,
+                                   LP_PARAM_DEVICE_ID: deviceId ?: @"",
+                                   LP_PARAM_USER_ID: userId ?: @"",
+                                   LP_PARAM_SDK_VERSION: constants.sdkVersion,
+                                   LP_PARAM_CLIENT: constants.client,
+                                   LP_PARAM_DEV_MODE: @(constants.isDevelopmentModeEnabled),
+                                   LP_PARAM_TIME: timestamp,
+                                   } mutableCopy];
     if (token) {
         args[LP_PARAM_TOKEN] = token;
     }
@@ -293,10 +303,10 @@ - (void)sendNow:(BOOL)async
     [self sendEventually];
 
     void (^operationBlock)() = ^void() {
+        [LeanplumRequest generateUUID];
+        
         // Simulate pop all requests.
-        NSArray *requestsToSend = [LPEventDataManager eventsWithLimit:MAX_STORED_API_CALLS];
-        // !!!: Remove in next commit (New Network flow).
-        [LPEventDataManager deleteEventsWithLimit:requestsToSend.count];
+        NSArray *requestsToSend = [LPEventDataManager eventsWithLimit:MAX_ACTIONS_PER_API_CALL];
         lastSentTime = [NSDate timeIntervalSinceReferenceDate];
 
         if (requestsToSend.count == 0) {
@@ -329,7 +339,6 @@ - (void)sendNow:(BOOL)async
             LP_TRY
             NSLog(@"Leanplum: Request %@ timed out", _apiMethod);
             [op cancel];
-            [LeanplumRequest pushUnsentRequests:requestsToSend];
             if (_error != nil) {
                 _error([NSError errorWithDomain:@"Leanplum" code:1
                                        userInfo:@{NSLocalizedDescriptionKey: @"Request timed out"}]);
@@ -365,6 +374,9 @@ - (void)sendNow:(BOOL)async
                     }
                 }
             }
+            
+            // Delete events on success.
+            [LPEventDataManager deleteEventsWithLimit:requestsToSend.count];
             LP_END_TRY
             if (_response != nil) {
                 _response(operation, json);
@@ -384,7 +396,6 @@ - (void)sendNow:(BOOL)async
                 || err.code == NSURLErrorNotConnectedToInternet
                 || err.code == NSURLErrorTimedOut) {
                 NSLog(@"Leanplum: %@", err);
-                [LeanplumRequest pushUnsentRequests:requestsToSend];
             } else {
                 id errorResponse = completedOperation.responseJSON;
                 NSString *errorMessage = [LPResponse getResponseError:[LPResponse getLastResponse:errorResponse]];
@@ -403,6 +414,9 @@ - (void)sendNow:(BOOL)async
                 } else {
                     NSLog(@"Leanplum: %@", err);
                 }
+                
+                // Delete on permanant error state.
+                [LPEventDataManager deleteEventsWithLimit:requestsToSend.count];
             }
             if (_error != nil) {
                 _error(err);
@@ -442,25 +456,19 @@ - (void)sendEventually
     RETURN_IF_TEST_MODE;
     if (!_sent) {
         _sent = YES;
+        NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
+        NSString *uuid = [userDefaults objectForKey:LEANPLUM_DEFAULTS_UUID_KEY];
+        NSInteger count = [LPEventDataManager count];
+        if (!uuid || count % MAX_ACTIONS_PER_API_CALL == 0) {
+            uuid = [LeanplumRequest generateUUID];
+        }
+        
         NSMutableDictionary *args = [self createArgsDictionary];
+        args[LP_PARAM_UUID] = uuid;
         [LPEventDataManager addEvent:args];
     }
 }
 
-+ (void)pushUnsentRequests:(NSArray *)requestData
-{
-    for (NSMutableDictionary *args in requestData) {
-        NSNumber *retryCount = args[@"retryCount"];
-        if (!retryCount) {
-            retryCount = @1;
-        } else {
-            retryCount = @([retryCount integerValue] + 1);
-        }
-        args[@"retryCount"] = retryCount;
-    }
-    [LPEventDataManager addEvents:requestData];
-}
-
 + (NSString *)getSizeAsString:(int)size
 {
     if (size < (1 << 10)) {