[SDK-302] New IterableEmbeddedUpdateHandler methods for sync failure and success. (#989)

Author: franco-zalamena-iterable

CHANGELOG.md

@@ -5,6 +5,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## Unreleased
 - Replaced the deprecated `AsyncTask`-based push notification handling with `WorkManager` for improved reliability and compatibility with modern Android versions. No action is required.
 - Fixed lost event tracking and missed API calls with an auto-retry feature for JWT token failures.
+- Added `onEmbeddedMessagingSyncSucceeded()` and `onEmbeddedMessagingSyncFailed()` callbacks to `IterableEmbeddedUpdateHandler` for monitoring embedded message sync results.
 
 ## [3.6.6]
 ### Fixed

iterableapi/src/main/java/com/iterable/iterableapi/IterableEmbeddedManager.kt

@@ -1,7 +1,6 @@
 package com.iterable.iterableapi
 
 import android.content.Context
-import com.iterable.iterableapi.IterableHelper.SuccessHandler
 import org.json.JSONException
 import org.json.JSONObject
 
@@ -80,12 +79,8 @@ public class IterableEmbeddedManager : IterableActivityMonitor.AppStateCallback
         return localPlacementIds
     }
 
-    fun syncMessages() {
-        syncMessages(emptyArray<Long>())
-    }
-
-    //Network call to get the embedded messages
-    fun syncMessages(placementIds: Array<Long>) {
+    @JvmOverloads
+    fun syncMessages(placementIds: Array<Long> = emptyArray()) {
         if (iterableApi.config.enableEmbeddedMessaging) {
             IterableLogger.v(TAG, "Syncing messages...")
 
@@ -141,8 +136,10 @@ public class IterableEmbeddedManager : IterableActivityMonitor.AppStateCallback
                     //store placements from payload for next comparison
                     localPlacementIds = currentPlacementIds
 
+                    notifySyncSucceeded()
                 } catch (e: JSONException) {
                     IterableLogger.e(TAG, e.toString())
+                    notifySyncFailed(e.message)
                 }
             }, object : IterableHelper.FailureHandler {
                 override fun onFailure(reason: String, data: JSONObject?) {
@@ -154,10 +151,9 @@ public class IterableEmbeddedManager : IterableActivityMonitor.AppStateCallback
                         IterableLogger.e(TAG, "Subscription is inactive. Stopping sync")
                         broadcastSubscriptionInactive()
                         return
-                    } else {
-                        //TODO: Instead of generic condition, have the retry only in certain situation
-                        IterableLogger.e(TAG, "Error while fetching embedded messages: $reason")
                     }
+                    IterableLogger.e(TAG, "Error while fetching embedded messages: $reason")
+                    notifySyncFailed(reason)
                 }
             })
         }
@@ -191,6 +187,18 @@ public class IterableEmbeddedManager : IterableActivityMonitor.AppStateCallback
         }
     }
 
+    private fun notifySyncSucceeded() {
+        updateHandleListeners.forEach {
+            it.onEmbeddedMessagingSyncSucceeded()
+        }
+    }
+
+    private fun notifySyncFailed(reason: String?) {
+        updateHandleListeners.forEach {
+            it.onEmbeddedMessagingSyncFailed(reason)
+        }
+    }
+
     private fun broadcastSubscriptionInactive() {
         updateHandleListeners.forEach {
             IterableLogger.d(TAG, "Broadcasting subscription inactive to the views")
@@ -263,7 +271,8 @@ public class IterableEmbeddedManager : IterableActivityMonitor.AppStateCallback
 public interface IterableEmbeddedUpdateHandler {
     fun onMessagesUpdated()
     fun onEmbeddedMessagingDisabled()
+    fun onEmbeddedMessagingSyncSucceeded() {}
+    fun onEmbeddedMessagingSyncFailed(reason: String?) {}
 }
 
 // endregion
-

iterableapi/src/test/java/com/iterable/iterableapi/IterableEmbeddedManagerTest.java

@@ -3,6 +3,8 @@
 import static android.os.Looper.getMainLooper;
 import static junit.framework.Assert.assertEquals;
 import static org.junit.Assert.assertNull;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.clearInvocations;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.never;
 import static org.mockito.Mockito.spy;
@@ -265,4 +267,64 @@ public void testOnEmbeddedMessagingDisabled() throws Exception {
         verify(mockHandler1).onEmbeddedMessagingDisabled();
     }
 
+    @Test
+    public void testOnEmbeddedMessagingSyncSucceeded() throws Exception {
+        dispatcher.enqueueResponse("/embedded-messaging/messages", new MockResponse().setBody(IterableTestUtils.getResourceString("embedded_payload_single_1.json")));
+        IterableEmbeddedManager embeddedManager = IterableApi.getInstance().getEmbeddedManager();
+        // Flush all automatic syncs (init + foreground) before adding listener
+        shadowOf(getMainLooper()).idle();
+
+        IterableEmbeddedUpdateHandler mockHandler = mock(IterableEmbeddedUpdateHandler.class);
+        embeddedManager.addUpdateListener(mockHandler);
+
+        dispatcher.enqueueResponse("/embedded-messaging/messages", new MockResponse().setBody(IterableTestUtils.getResourceString("embedded_payload_single_1.json")));
+        embeddedManager.syncMessages();
+        shadowOf(getMainLooper()).idle();
+
+        verify(mockHandler).onEmbeddedMessagingSyncSucceeded();
+        verify(mockHandler, never()).onEmbeddedMessagingSyncFailed(anyString());
+    }
+
+    @Test
+    public void testOnEmbeddedMessagingSyncFailedOnParseError() throws Exception {
+        // Enqueue malformed responses so auto-syncs also fail (avoiding mixed success/failure)
+        dispatcher.enqueueResponse("/embedded-messaging/messages", new MockResponse().setBody(IterableTestUtils.getResourceString("embedded_payload_malformed.json")));
+        dispatcher.enqueueResponse("/embedded-messaging/messages", new MockResponse().setBody(IterableTestUtils.getResourceString("embedded_payload_malformed.json")));
+        IterableEmbeddedManager embeddedManager = IterableApi.getInstance().getEmbeddedManager();
+
+        IterableEmbeddedUpdateHandler mockHandler = mock(IterableEmbeddedUpdateHandler.class);
+        embeddedManager.addUpdateListener(mockHandler);
+        shadowOf(getMainLooper()).idle();
+        clearInvocations(mockHandler);
+
+        dispatcher.enqueueResponse("/embedded-messaging/messages", new MockResponse().setBody(IterableTestUtils.getResourceString("embedded_payload_malformed.json")));
+        embeddedManager.syncMessages();
+        shadowOf(getMainLooper()).idle();
+
+        verify(mockHandler).onEmbeddedMessagingSyncFailed(anyString());
+        verify(mockHandler, never()).onEmbeddedMessagingSyncSucceeded();
+    }
+
+    @Test
+    public void testOnEmbeddedMessagingSyncFailed() throws Exception {
+        // Enqueue 500 responses so auto-syncs also fail (avoiding mixed success/failure)
+        // Note: 401 + "Invalid API Key" triggers the subscription-inactive path
+        // (onEmbeddedMessagingDisabled), not the generic failure path (onEmbeddedMessagingSyncFailed)
+        dispatcher.enqueueResponse("/embedded-messaging/messages", new MockResponse().setResponseCode(500));
+        dispatcher.enqueueResponse("/embedded-messaging/messages", new MockResponse().setResponseCode(500));
+        IterableEmbeddedManager embeddedManager = IterableApi.getInstance().getEmbeddedManager();
+
+        IterableEmbeddedUpdateHandler mockHandler = mock(IterableEmbeddedUpdateHandler.class);
+        embeddedManager.addUpdateListener(mockHandler);
+        shadowOf(getMainLooper()).idle();
+        clearInvocations(mockHandler);
+
+        dispatcher.enqueueResponse("/embedded-messaging/messages", new MockResponse().setResponseCode(500));
+        embeddedManager.syncMessages();
+        shadowOf(getMainLooper()).idle();
+
+        verify(mockHandler).onEmbeddedMessagingSyncFailed(anyString());
+        verify(mockHandler, never()).onEmbeddedMessagingSyncSucceeded();
+    }
+
 }

iterableapi/src/test/resources/embedded_payload_malformed.json

@@ -0,0 +1,7 @@
+{
+  "placements": [
+    {
+      "unexpectedField": "missingPlacementIdAndMessages"
+    }
+  ]
+}