[SDK-289] Fixed double callback problem for setEmail with auto push registration (#985)

Fix for residual setEmailCallbackHandler after invoking it. Clearing failure and success setEmail callback after invocation. Better messaging on local success for setEmail and setRead

Author: franco-zalamena-iterable

iterableapi/src/main/java/com/iterable/iterableapi/IterableApi.java

@@ -444,14 +444,16 @@ private void completeUserLogin(@Nullable String email, @Nullable String userId,
             IterableLogger.w(TAG, "Cannot complete user login - JWT auth enabled but no validated authToken present");
             if (_setUserFailureCallbackHandler != null) {
                 _setUserFailureCallbackHandler.onFailure("JWT authentication is enabled but no valid authToken is available", null);
+                resetCallbackHandlers();
             }
             return;
         }
 
         if (config.autoPushRegistration) {
             registerForPush();
         } else if (_setUserSuccessCallbackHandler != null) {
-            _setUserSuccessCallbackHandler.onSuccess(new JSONObject()); // passing blank json object here as onSuccess is @Nonnull
+            _setUserSuccessCallbackHandler.onSuccess(IterableResponse.setEmailLocalSuccessResponse);
+            resetCallbackHandlers();
         }
 
         getInAppManager().syncInApp();
@@ -747,6 +749,7 @@ private IterableHelper.SuccessHandler getSuccessHandler() {
 
                 if (originalSuccessHandler != null) {
                     originalSuccessHandler.onSuccess(data);
+                    resetCallbackHandlers();
                 }
             };
         }
@@ -762,11 +765,17 @@ private IterableHelper.FailureHandler getFailureHandler() {
 
                 if (originalFailureHandler != null) {
                     originalFailureHandler.onFailure(reason, data);
+                    resetCallbackHandlers();
                 }
             };
         }
         return wrappedFailureHandler;
     }
+
+    private void resetCallbackHandlers() {
+        _setUserFailureCallbackHandler = null;
+        _setUserSuccessCallbackHandler = null;
+    }
 //endregion
 
 //region SDK initialization

iterableapi/src/main/java/com/iterable/iterableapi/IterableHelper.java

@@ -6,6 +6,8 @@
 
 import org.json.JSONObject;
 
+import java.util.Map;
+
 /**
  * Created by David Truong dt@iterable.com
  */
@@ -33,4 +35,10 @@ public interface FailureHandler {
     public interface SuccessAuthHandler {
         void onSuccess(@NonNull String authToken);
     }
+}
+
+class IterableResponse {
+    static final JSONObject setEmailLocalSuccessResponse = new JSONObject(Map.of("message", "setEmail was completed locally."));
+
+    static final JSONObject setReadLocalSuccessResponse = new JSONObject(Map.of("message", "setRead was completed locally."));
 }

iterableapi/src/main/java/com/iterable/iterableapi/IterableInAppManager.java

@@ -140,7 +140,7 @@ public synchronized void setRead(@NonNull IterableInAppMessage message, boolean
     public synchronized void setRead(@NonNull IterableInAppMessage message, boolean read, @Nullable IterableHelper.SuccessHandler successHandler, @Nullable IterableHelper.FailureHandler failureHandler) {
         message.setRead(read);
         if (successHandler != null) {
-            successHandler.onSuccess(new JSONObject()); // passing blank json object here as onSuccess is @Nonnull
+            successHandler.onSuccess(IterableResponse.setReadLocalSuccessResponse);
         }
         notifyOnChange();
     }

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

@@ -1199,4 +1199,36 @@ public void testRegisterDeviceTokenIntegration_ConsentLoggingNotTriggeredWhenDis
 
     //endregion
 
+    @Test
+    public void testSetEmailWithCallbackAndManualRegisterDeviceToken_NoDoubleCallback() throws Exception {
+        // Setup: Mock server responses
+        server.enqueue(new MockResponse().setResponseCode(200).setBody("{}"));
+
+        IterableConfig config = new IterableConfig.Builder()
+            .setAutoPushRegistration(false)
+            .setPushIntegrationName("testIntegration")
+            .build();
+
+        IterableApi.initialize(getContext(), "apiKey", config);
+
+        IterableHelper.SuccessHandler successHandler = mock(IterableHelper.SuccessHandler.class);
+
+        IterableApi.getInstance().setEmail("test@example.com", successHandler, null);
+
+        verify(successHandler, times(1)).onSuccess(any(JSONObject.class));
+
+        IterableApi.getInstance().registerDeviceToken("test_token");
+
+        Thread.sleep(200);
+        shadowOf(getMainLooper()).idle();
+
+        verify(successHandler, times(1)).onSuccess(any(JSONObject.class));
+
+        RecordedRequest registerRequest = server.takeRequest(1, TimeUnit.SECONDS);
+        assertNotNull("Should have made registerDeviceToken request", registerRequest);
+        assertTrue("Should be registerDeviceToken endpoint", registerRequest.getPath().contains("registerDeviceToken"));
+    }
+
+    //endregion
+
 }