Update IAM manager & backend service with retry logic, optional headers

Motivation: the IAM fetch call (`listInAppMessages`) will include the rywToken, retryCount, & secondsSinceAppOpen (tracked on backend)

We update the request & related code here.

Handle retry logic

Author: Rodrigo Gomez Palacio

OneSignalSDK/onesignal/in-app-messages/src/main/java/com/onesignal/inAppMessages/internal/InAppMessagesManager.kt

@@ -4,6 +4,8 @@ import android.app.AlertDialog
 import com.onesignal.common.AndroidUtils
 import com.onesignal.common.IDManager
 import com.onesignal.common.JSONUtils
+import com.onesignal.common.consistency.IamFetchReadyCondition
+import com.onesignal.common.consistency.models.IConsistencyManager
 import com.onesignal.common.events.EventProducer
 import com.onesignal.common.exceptions.BackendException
 import com.onesignal.common.modeling.ISingletonModelStoreChangeHandler
@@ -66,6 +68,7 @@ internal class InAppMessagesManager(
     private val _lifecycle: IInAppLifecycleService,
     private val _languageContext: ILanguageContext,
     private val _time: ITime,
+    private val _consistencyManager: IConsistencyManager,
 ) : IInAppMessagesManager,
     IStartableService,
     ISubscriptionChangedHandler,
@@ -149,7 +152,13 @@ internal class InAppMessagesManager(
             }
 
             // attempt to fetch messages from the backend (if we have the pre-requisite data already)
-            fetchMessages()
+            val onesignalId = _userManager.onesignalId
+            val updateConditionDeferred =
+                _consistencyManager.registerCondition(IamFetchReadyCondition(onesignalId))
+            val rywToken = updateConditionDeferred.await()
+            if (rywToken != null) {
+                fetchMessages(rywToken)
+            }
         }
     }
 
@@ -181,18 +190,14 @@ internal class InAppMessagesManager(
             return
         }
 
-        suspendifyOnThread {
-            fetchMessages()
-        }
+        fetchMessagesWhenConditionIsMet()
     }
 
     override fun onModelReplaced(
         model: ConfigModel,
         tag: String,
     ) {
-        suspendifyOnThread {
-            fetchMessages()
-        }
+        fetchMessagesWhenConditionIsMet()
     }
 
     override fun onSubscriptionAdded(subscription: ISubscription) { }
@@ -207,27 +212,36 @@ internal class InAppMessagesManager(
             return
         }
 
-        suspendifyOnThread {
-            fetchMessages()
-        }
+        fetchMessagesWhenConditionIsMet()
     }
 
     override fun onSessionStarted() {
         for (redisplayInAppMessage in redisplayedInAppMessages) {
             redisplayInAppMessage.isDisplayedInSession = false
         }
 
-        suspendifyOnThread {
-            fetchMessages()
-        }
+        fetchMessagesWhenConditionIsMet()
     }
 
     override fun onSessionActive() { }
 
     override fun onSessionEnded(duration: Long) { }
 
+    private fun fetchMessagesWhenConditionIsMet() {
+        suspendifyOnThread {
+            val onesignalId = _userManager.onesignalId
+            val iamFetchCondition =
+                _consistencyManager.registerCondition(IamFetchReadyCondition(onesignalId))
+            val rywToken = iamFetchCondition.await()
+
+            if (rywToken != null) {
+                fetchMessages(rywToken)
+            }
+        }
+    }
+
     // called when a new push subscription is added, or the app id is updated, or a new session starts
-    private suspend fun fetchMessages() {
+    private suspend fun fetchMessages(rywToken: String?) {
         // We only want to fetch IAMs if we know the app is in the
         // foreground, as we don't want to do this for background
         // events (such as push received), wasting resources for
@@ -252,7 +266,9 @@ internal class InAppMessagesManager(
             lastTimeFetchedIAMs = now
         }
 
-        val newMessages = _backend.listInAppMessages(appId, subscriptionId)
+        // lambda so that it is updated on each potential retry
+        val sessionDurationProvider = { _time.currentTimeMillis - _sessionService.startTime }
+        val newMessages = _backend.listInAppMessages(appId, subscriptionId, rywToken, sessionDurationProvider)
 
         if (newMessages != null) {
             this.messages = newMessages as MutableList<InAppMessage>
@@ -517,7 +533,9 @@ internal class InAppMessagesManager(
         if (triggerModel != null) {
             triggerModel.value = value
         } else {
-            triggerModel = com.onesignal.inAppMessages.internal.triggers.TriggerModel()
+            triggerModel =
+                com.onesignal.inAppMessages.internal.triggers
+                    .TriggerModel()
             triggerModel.id = key
             triggerModel.key = key
             triggerModel.value = value
@@ -782,13 +800,15 @@ internal class InAppMessagesManager(
     private fun logInAppMessagePreviewActions(action: InAppMessageClickResult) {
         if (action.tags != null) {
             Logging.debug(
-                "InAppMessagesManager.logInAppMessagePreviewActions: Tags detected inside of the action click payload, ignoring because action came from IAM preview:: " + action.tags.toString(),
+                "InAppMessagesManager.logInAppMessagePreviewActions: Tags detected inside of the action click payload, ignoring because action came from IAM preview:: " +
+                    action.tags.toString(),
             )
         }
 
         if (action.outcomes.size > 0) {
             Logging.debug(
-                "InAppMessagesManager.logInAppMessagePreviewActions: Outcomes detected inside of the action click payload, ignoring because action came from IAM preview: " + action.outcomes.toString(),
+                "InAppMessagesManager.logInAppMessagePreviewActions: Outcomes detected inside of the action click payload, ignoring because action came from IAM preview: " +
+                    action.outcomes.toString(),
             )
         }
 
@@ -890,7 +910,8 @@ internal class InAppMessagesManager(
     ) {
         val messageTitle = _applicationService.appContext.getString(R.string.location_permission_missing_title)
         val message = _applicationService.appContext.getString(R.string.location_permission_missing_message)
-        AlertDialog.Builder(_applicationService.current)
+        AlertDialog
+            .Builder(_applicationService.current)
             .setTitle(messageTitle)
             .setMessage(message)
             .setPositiveButton(android.R.string.ok) { _, _ -> suspendifyOnThread { showMultiplePrompts(inAppMessage, prompts) } }

OneSignalSDK/onesignal/in-app-messages/src/main/java/com/onesignal/inAppMessages/internal/backend/IInAppBackendService.kt

@@ -13,12 +13,16 @@ internal interface IInAppBackendService {
      *
      * @param appId The ID of the application that the IAM will be retrieved from.
      * @param subscriptionId The specific subscription within the [appId] the IAM will be delivered to.
+     * @param rywToken Used for read your write consistency
+     * @param sessionDurationProvider Lambda to calculate the session duration at the time of the request
      *
      * @return The list of IAMs associated to the subscription, or null if the IAMs could not be retrieved.
      */
     suspend fun listInAppMessages(
         appId: String,
         subscriptionId: String,
+        rywToken: String?,
+        sessionDurationProvider: () -> Long,
     ): List<InAppMessage>?
 
     /**

OneSignalSDK/onesignal/in-app-messages/src/main/java/com/onesignal/inAppMessages/internal/backend/impl/InAppBackendService.kt

@@ -4,12 +4,14 @@ import com.onesignal.common.NetworkUtils
 import com.onesignal.common.exceptions.BackendException
 import com.onesignal.core.internal.device.IDeviceService
 import com.onesignal.core.internal.http.IHttpClient
+import com.onesignal.core.internal.http.impl.OptionalHeaders
 import com.onesignal.debug.internal.logging.Logging
 import com.onesignal.inAppMessages.internal.InAppMessage
 import com.onesignal.inAppMessages.internal.InAppMessageContent
 import com.onesignal.inAppMessages.internal.backend.GetIAMDataResponse
 import com.onesignal.inAppMessages.internal.backend.IInAppBackendService
 import com.onesignal.inAppMessages.internal.hydrators.InAppHydrator
+import kotlinx.coroutines.delay
 import org.json.JSONObject
 
 internal class InAppBackendService(
@@ -22,24 +24,11 @@ internal class InAppBackendService(
     override suspend fun listInAppMessages(
         appId: String,
         subscriptionId: String,
+        rywToken: String?,
+        sessionDurationProvider: () -> Long,
     ): List<InAppMessage>? {
-        // Retrieve any in app messages that might exist
-        val response = _httpClient.get("apps/$appId/subscriptions/$subscriptionId/iams")
-
-        if (response.isSuccess) {
-            val jsonResponse = JSONObject(response.payload)
-
-            if (jsonResponse.has("in_app_messages")) {
-                val iamMessagesAsJSON = jsonResponse.getJSONArray("in_app_messages")
-                // TODO: Outstanding question on whether we still want to cache this.  Only used when
-                //       hard start of the app, but within 30 seconds of it being killed (i.e. same session startup).
-                // Cache copy for quick cold starts
-//                _prefs.savedIAMs = iamMessagesAsJSON.toString()
-                return _hydrator.hydrateIAMMessages(iamMessagesAsJSON)
-            }
-        }
-
-        return null
+        val baseUrl = "apps/$appId/subscriptions/$subscriptionId/iams"
+        return attemptFetchWithRetries(baseUrl, rywToken, sessionDurationProvider)
     }
 
     override suspend fun getIAMData(
@@ -51,7 +40,7 @@ internal class InAppBackendService(
             htmlPathForMessage(messageId, variantId, appId)
                 ?: return GetIAMDataResponse(null, false)
 
-        val response = _httpClient.get(htmlPath, null)
+        val response = _httpClient.get(htmlPath)
 
         if (response.isSuccess) {
             // Successful request, reset count
@@ -81,7 +70,7 @@ internal class InAppBackendService(
     ): InAppMessageContent? {
         val htmlPath = "in_app_messages/device_preview?preview_id=$previewUUID&app_id=$appId"
 
-        val response = _httpClient.get(htmlPath, null)
+        val response = _httpClient.get(htmlPath)
 
         return if (response.isSuccess) {
             val jsonResponse = JSONObject(response.payload!!)
@@ -209,4 +198,75 @@ internal class InAppBackendService(
     ) {
         Logging.error("Encountered a $statusCode error while attempting in-app message $requestType request: $response")
     }
+
+    private suspend fun attemptFetchWithRetries(
+        baseUrl: String,
+        rywToken: String?,
+        sessionDurationProvider: () -> Long,
+    ): List<InAppMessage>? {
+        var attempts = 1
+        var retryLimit: Int? = null // Retry limit will be determined dynamically
+
+        while (retryLimit == null || attempts <= retryLimit + 1) {
+            val retryCount = if (attempts > 1) attempts - 1 else null
+            val values =
+                OptionalHeaders(
+                    rywToken = rywToken,
+                    sessionDuration = sessionDurationProvider(),
+                    retryCount = retryCount,
+                )
+            val response = _httpClient.get(baseUrl, values)
+
+            if (response.isSuccess) {
+                val jsonResponse = response.payload?.let { JSONObject(it) }
+                return jsonResponse?.let { hydrateInAppMessages(it) }
+            } else if (response.statusCode == 425 || response.statusCode == 429) {
+                // Dynamically update the retry limit from response
+                retryLimit = response.retryLimit ?: retryLimit
+
+                // Apply the Retry-After delay if present, otherwise proceed without delay
+                val retryAfter = response.retryAfterSeconds
+                if (retryAfter != null) {
+                    delay(retryAfter * 1_000L)
+                }
+            } else if (response.statusCode in 500..599) {
+                return null
+            } else {
+                return null
+            }
+
+            attempts++
+        }
+
+        // Final attempt without the RYW token if retries fail
+        return fetchInAppMessagesWithoutRywToken(baseUrl, sessionDurationProvider)
+    }
+
+    private suspend fun fetchInAppMessagesWithoutRywToken(
+        url: String,
+        sessionDurationProvider: () -> Long,
+    ): List<InAppMessage>? {
+        val response =
+            _httpClient.get(
+                url,
+                OptionalHeaders(
+                    sessionDuration = sessionDurationProvider(),
+                ),
+            )
+
+        if (response.isSuccess) {
+            val jsonResponse = response.payload?.let { JSONObject(it) }
+            return jsonResponse?.let { hydrateInAppMessages(it) }
+        } else {
+            return null
+        }
+    }
+
+    private fun hydrateInAppMessages(jsonResponse: JSONObject): List<InAppMessage>? =
+        if (jsonResponse.has("in_app_messages")) {
+            val iamMessagesAsJSON = jsonResponse.getJSONArray("in_app_messages")
+            _hydrator.hydrateIAMMessages(iamMessagesAsJSON)
+        } else {
+            null
+        }
 }

OneSignalSDK/onesignal/in-app-messages/src/test/java/com/onesignal/inAppMessages/internal/InAppMessagesManagerTests.kt

@@ -1,5 +1,6 @@
 package com.onesignal.inAppMessages.internal
 
+import com.onesignal.common.consistency.models.IConsistencyManager
 import com.onesignal.core.internal.config.ConfigModelStore
 import com.onesignal.inAppMessages.internal.backend.IInAppBackendService
 import com.onesignal.inAppMessages.internal.display.IInAppDisplayer
@@ -52,6 +53,7 @@ class InAppMessagesManagerTests : FunSpec({
                 mockk<IInAppLifecycleService>(),
                 MockHelper.languageContext(),
                 MockHelper.time(1000),
+                mockk<IConsistencyManager>(),
             )
 
         // When