OSMessagingController Retry Logic

Rodrigo Gomez Palacio · Rodrigo Gomez Palacio · commit 9ac1053fb862 · 2024-10-23T14:18:07.000-05:00
Motivation: retry logic should work as follows:
1. initial request with offset --&gt; failure
2. get retry limit &amp; retry after from response &amp; start retrying
3. if hit limit, make one final request with the offset: 0

The final request tells the backend, just show me what you got.

Example: If the retry limit is 3 &amp; we never get a successful response retrying, we should end up with 5 total requests.
diff --git a/iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Controller/OSMessagingController.m b/iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Controller/OSMessagingController.m
@@ -1,7 +1,7 @@
 /**
  * Modified MIT License
  *
- * Copyright 2017 OneSignal
+ * Copyright 2024 OneSignal
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -35,8 +35,14 @@
 #import "OSInAppMessagePrompt.h"
 #import "OSInAppMessagingRequests.h"
 #import "OneSignalWebViewManager.h"
+#import "OneSignalTracker.h"
 #import <OneSignalOutcomes/OneSignalOutcomes.h>
 #import "OSSessionManager.h"
+#import "OneSignalOSCore/OneSignalOSCore-Swift.h"
+
+static NSInteger const DEFAULT_RETRY_AFTER_SECONDS = 1;     // Default 1 second retry delay
+static NSInteger const DEFAULT_RETRY_LIMIT = 0;             // If not returned by backend, don't retry
+static NSInteger const IAM_FETCH_DELAY_BUFFER = 0.5;        // Fallback value if ryw_delay is nil: delay by 500 ms to increase the probability of getting a 200 & not having to retry
 
 @implementation OSInAppMessageWillDisplayEvent
 
@@ -242,22 +248,70 @@ - (void)updateInAppMessagesFromCache {
 }
 
 - (void)getInAppMessagesFromServer:(NSString *)subscriptionId {
-    [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"getInAppMessagesFromServer"];
+    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
+        [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"getInAppMessagesFromServer"];
 
-    if (!subscriptionId) {
-        [self updateInAppMessagesFromCache];
-        return;
-    }
-    
-    OSRequestGetInAppMessages *request = [OSRequestGetInAppMessages withSubscriptionId:subscriptionId];
-    [OneSignalCoreImpl.sharedClient executeRequest:request onSuccess:^(NSDictionary *result) {
+        if (!subscriptionId) {
+            [self updateInAppMessagesFromCache];
+            return;
+        }
+
+        OSConsistencyManager *consistencyManager = [OSConsistencyManager shared];
+        NSString *onesignalId = OneSignalUserManagerImpl.sharedInstance.onesignalId;
+
+        if (!onesignalId) {
+            [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"Failed to get in app messages due to no OneSignal ID"];
+            return;
+        }
+
+        OSIamFetchReadyCondition *condition = [OSIamFetchReadyCondition sharedInstanceWithId:onesignalId];
+        OSReadYourWriteData *rywData = [consistencyManager getRywTokenFromAwaitableCondition:condition forId:onesignalId];
+        
+        // We need to delay the first request by however long the backend is telling us (`ryw_delay`)
+        // This will help avoid unnecessary retries & can be easily adjusted from the backend
+        NSTimeInterval rywDelayInSeconds;
+        if (rywData.rywDelay) {
+            rywDelayInSeconds = [rywData.rywDelay doubleValue] / 1000.0;
+        } else {
+            rywDelayInSeconds = IAM_FETCH_DELAY_BUFFER;
+        }
+        dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(rywDelayInSeconds * NSEC_PER_SEC)), dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
+            
+            // Initial request
+            [self attemptFetchWithRetries:subscriptionId
+                                 rywData:rywData
+                                 attempts:@0 // Starting with 0 attempts
+                               retryLimit:nil]; // Retry limit to be set dynamically on first failure
+        });
+    });
+}
+
+
+- (void)attemptFetchWithRetries:(NSString *)subscriptionId
+                       rywData:(OSReadYourWriteData *)rywData
+                       attempts:(NSNumber *)attempts
+                     retryLimit:(NSNumber *)retryLimit {
+    NSNumber *sessionDuration = @([OSSessionManager.sharedSessionManager getTimeFocusedElapsed]);
+    NSString *rywToken = rywData.rywToken;
+    NSNumber *rywDelay = rywData.rywDelay;
+
+    // Create the request with the current attempt count
+    OSRequestGetInAppMessages *request = [OSRequestGetInAppMessages withSubscriptionId:subscriptionId
+                                                                    withSessionDuration:sessionDuration
+                                                                    withRetryCount:attempts
+                                                                    withRywToken:rywToken];
+
+    __block NSNumber *blockRetryLimit = retryLimit;
+
+    [OneSignalCoreImpl.sharedClient executeRequest:request
+                                          onSuccess:^(NSDictionary *result) {
         dispatch_async(dispatch_get_main_queue(), ^{
             [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"getInAppMessagesFromServer success"];
-            if (result[@"in_app_messages"]) { // when there are no IAMs, will this still be there?
-                let messages = [NSMutableArray new];
+            if (result[@"in_app_messages"]) {
+                NSMutableArray *messages = [NSMutableArray new];
                 
                 for (NSDictionary *messageJson in result[@"in_app_messages"]) {
-                    let message = [OSInAppMessageInternal instanceWithJson:messageJson];
+                    OSInAppMessageInternal *message = [OSInAppMessageInternal instanceWithJson:messageJson];
                     if (message) {
                         [messages addObject:message];
                     }
@@ -266,11 +320,89 @@ - (void)getInAppMessagesFromServer:(NSString *)subscriptionId {
                 [self updateInAppMessagesFromServer:messages];
                 return;
             }
+        });
+    }
+    onFailure:^(NSError *error) {
+        NSDictionary *errorInfo = error.userInfo[@"returned"];
+        NSNumber *statusCode = errorInfo[@"httpStatusCode"];
+        NSDictionary* responseHeaders = errorInfo[@"headers"];
+
+        if (!statusCode) {
+            [self updateInAppMessagesFromCache];
+            return;
+        }
+
+        [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:[NSString stringWithFormat:@"getInAppMessagesFromServer failure: %@", error.localizedDescription]];
+        
+        NSInteger code = [statusCode integerValue];
+        if (code == 425 || code == 429) { // 425 Too Early or 429 Too Many Requests
+            NSInteger retryAfter = [responseHeaders[@"Retry-After"] integerValue] ?: DEFAULT_RETRY_AFTER_SECONDS;
             
-            // TODO: Check this request and response. If no IAMs returned, should we really get from cache?
-            // This is the existing implementation but it could mean this user has no IAMs?
-            
-            // Default is using cached IAMs in the messaging controller
+            // Dynamically set the retry limit from the header, if not already set
+            if (!blockRetryLimit) {
+                blockRetryLimit = @([responseHeaders[@"OneSignal-Retry-Limit"] integerValue] ?: DEFAULT_RETRY_LIMIT);
+            }
+
+            if ([attempts integerValue] < [blockRetryLimit integerValue]) {
+                NSInteger nextAttempt = [attempts integerValue] + 1; // Increment attempts
+                [self retryAfterDelay:retryAfter
+                         subscriptionId:subscriptionId
+                                rywData:rywData
+                               attempts:@(nextAttempt)
+                             retryLimit:blockRetryLimit];
+            } else {
+                // Final attempt without rywToken
+                [self fetchInAppMessagesWithoutToken:subscriptionId];
+            }
+        } else if (code >= 500 && code <= 599) {
+            [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"Server error, skipping retries"];
+            [self updateInAppMessagesFromCache];
+        } else {
+            [self updateInAppMessagesFromCache];
+        }
+    }];
+}
+
+- (void)retryAfterDelay:(NSInteger)retryAfter
+         subscriptionId:(NSString *)subscriptionId
+               rywData:(OSReadYourWriteData *)rywData
+               attempts:(NSNumber *)attempts
+             retryLimit:(NSNumber *)retryLimit {
+
+    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(retryAfter * NSEC_PER_SEC)), dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
+        
+        [self attemptFetchWithRetries:subscriptionId
+                             rywData:rywData
+                             attempts:attempts
+                           retryLimit:retryLimit];
+    });
+}
+
+- (void)fetchInAppMessagesWithoutToken:(NSString *)subscriptionId {
+    NSNumber *sessionDuration = @([OSSessionManager.sharedSessionManager getTimeFocusedElapsed]);
+    
+    OSRequestGetInAppMessages *request = [OSRequestGetInAppMessages withSubscriptionId:subscriptionId
+                                                                      withSessionDuration:sessionDuration
+                                                                      withRetryCount:nil
+                                                                      withRywToken:nil]; // No retries for the final attempt
+
+    [OneSignalCoreImpl.sharedClient executeRequest:request
+                                          onSuccess:^(NSDictionary *result) {
+        dispatch_async(dispatch_get_main_queue(), ^{
+            [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"Final attempt without token success"];
+            if (result[@"in_app_messages"]) {
+                NSMutableArray *messages = [NSMutableArray new];
+
+                for (NSDictionary *messageJson in result[@"in_app_messages"]) {
+                    OSInAppMessageInternal *message = [OSInAppMessageInternal instanceWithJson:messageJson];
+                    if (message) {
+                        [messages addObject:message];
+                    }
+                }
+
+                [self updateInAppMessagesFromServer:messages];
+                return;
+            }
             [self updateInAppMessagesFromCache];
         });
     } onFailure:^(NSError *error) {
diff --git a/iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/Consistency/OSCondition.swift b/iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/Consistency/OSCondition.swift
@@ -1,10 +1,29 @@
-//
-//  OSCondition.swift
-//  OneSignalOSCore
-//
-//  Created by Rodrigo Gomez-Palacio on 9/10/24.
-//  Copyright © 2024 OneSignal. All rights reserved.
-//
+/*
+ Modified MIT License
+
+ Copyright 2024 OneSignal
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ 1. The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ 2. All copies of substantial portions of the Software may only be used in connection
+ with services provided by OneSignal.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+ */
 
 import Foundation
 
diff --git a/iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/Consistency/OSConsistencyKeyEnum.swift b/iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/Consistency/OSConsistencyKeyEnum.swift
@@ -1,10 +1,29 @@
-//
-//  OSConsistencyKeyEnum.swift
-//  OneSignalOSCore
-//
-//  Created by Rodrigo Gomez-Palacio on 9/10/24.
-//  Copyright © 2024 OneSignal. All rights reserved.
-//
+/*
+ Modified MIT License
+
+ Copyright 2024 OneSignal
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ 1. The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ 2. All copies of substantial portions of the Software may only be used in connection
+ with services provided by OneSignal.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+ */
 
 import Foundation
 
diff --git a/iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/Consistency/OSConsistencyManager.swift b/iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/Consistency/OSConsistencyManager.swift
@@ -1,12 +1,32 @@
-//
-//  OSConsistencyManager.swift
-//  OneSignalOSCore
-//
-//  Created by Rodrigo Gomez-Palacio on 9/10/24.
-//  Copyright © 2024 OneSignal. All rights reserved.
-//
+/*
+ Modified MIT License
+
+ Copyright 2024 OneSignal
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ 1. The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ 2. All copies of substantial portions of the Software may only be used in connection
+ with services provided by OneSignal.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+ */
 
 import Foundation
+import OneSignalCore
 
 @objc public class OSConsistencyManager: NSObject {
     // Singleton instance
@@ -41,10 +61,10 @@ import Foundation
     @objc public func getRywTokenFromAwaitableCondition(_ condition: OSCondition, forId id: String) -> OSReadYourWriteData? {
         let semaphore = DispatchSemaphore(value: 0)
         queue.sync {
-            if self.conditions[id] == nil {
-                self.conditions[id] = []
+            if self.indexedConditions[id] == nil {
+                self.indexedConditions[id] = []
             }
-            self.conditions[id]?.append((condition, semaphore))
+            self.indexedConditions[id]?.append((condition, semaphore))
             self.checkConditionsAndComplete(forId: id)
         }
         semaphore.wait() // Block until the condition is met
@@ -55,33 +75,33 @@ import Foundation
     
     // Method to resolve conditions by condition ID (e.g. OSIamFetchReadyCondition.ID)
     @objc public func resolveConditionsWithID(id: String) {
-        guard let conditionList = conditions[id] else { return }
+        guard let conditionList = indexedConditions[id] else { return }
         var completedConditions: [(OSCondition, DispatchSemaphore)] = []
         for (condition, semaphore) in conditionList {
             if (condition.conditionId == id) {
                 semaphore.signal()
                 completedConditions.append((condition, semaphore))
             }
         }
-        conditions[id]?.removeAll { condition, semaphore in
+        indexedConditions[id]?.removeAll { condition, semaphore in
             completedConditions.contains(where: { $0.0 === condition && $0.1 == semaphore })
         }
     }
 
     // Private method to check conditions for a specific id (unique ID like onesignalId)
     private func checkConditionsAndComplete(forId id: String) {
-        guard let conditionList = conditions[id] else { return }
+        guard let conditionList = indexedConditions[id] else { return }
         var completedConditions: [(OSCondition, DispatchSemaphore)] = []
         for (condition, semaphore) in conditionList {
             if condition.isMet(indexedTokens: indexedTokens) {
-                print("Condition met for id: \(id)")
+                OneSignalLog.onesignalLog(.LL_INFO, message: "Condition met for id: \(id)")
                 semaphore.signal()
                 completedConditions.append((condition, semaphore))
             } else {
-                print("Condition not met for id: \(id)")
+                OneSignalLog.onesignalLog(.LL_INFO, message: "Condition not met for id: \(id)")
             }
         }
-        conditions[id]?.removeAll { condition, semaphore in
+        indexedConditions[id]?.removeAll { condition, semaphore in
             completedConditions.contains(where: { $0.0 === condition && $0.1 == semaphore })
         }
     }
