callback on message displayed (#270)

Author: e7mac

AndroidSDKCore/src/main/java/com/leanplum/ActionContext.java

@@ -389,7 +389,7 @@ private boolean createActionContextForMessageId(String messageAction,
           @Override
           public void variablesChanged() {
             try {
-              ActionManager.getInstance().recordMessageImpression(actionContext.getMessageId());
+              Leanplum.triggerMessageDisplayed(actionContext);
             } catch (Throwable t) {
               Util.handleException(t);
             }

AndroidSDKCore/src/main/java/com/leanplum/Leanplum.java

@@ -25,15 +25,18 @@
 import android.content.Context;
 import android.location.Location;
 import android.os.AsyncTask;
+import android.os.Message;
 import android.support.annotation.VisibleForTesting;
 import android.text.TextUtils;
 
 import com.leanplum.ActionContext.ContextualValues;
 import com.leanplum.callbacks.ActionCallback;
+import com.leanplum.callbacks.MessageDisplayedCallback;
 import com.leanplum.callbacks.RegisterDeviceCallback;
 import com.leanplum.callbacks.RegisterDeviceFinishedCallback;
 import com.leanplum.callbacks.StartCallback;
 import com.leanplum.callbacks.VariablesChangedCallback;
+import com.leanplum.internal.ActionManager;
 import com.leanplum.internal.Constants;
 import com.leanplum.internal.FileManager;
 import com.leanplum.internal.JsonConverter;
@@ -51,6 +54,7 @@
 import com.leanplum.internal.Util.DeviceIdInfo;
 import com.leanplum.internal.VarCache;
 import com.leanplum.messagetemplates.MessageTemplates;
+import com.leanplum.models.MessageArchiveData;
 import com.leanplum.utils.BuildUtil;
 import com.leanplum.utils.SharedPreferencesUtil;
 
@@ -93,6 +97,8 @@ public class Leanplum {
       new ArrayList<>();
   private static final ArrayList<VariablesChangedCallback> onceNoDownloadsHandlers =
       new ArrayList<>();
+  private static final ArrayList<MessageDisplayedCallback> messageDisplayedHandlers =
+          new ArrayList<>();
   private static final Object heartbeatLock = new Object();
   private static final String LEANPLUM_NOTIFICATION_CHANNEL =
       "com.leanplum.LeanplumNotificationChannel";
@@ -1296,6 +1302,60 @@ public static void removeVariablesChangedAndNoDownloadsPendingHandler(
     }
   }
 
+  /**
+   * Add a callback for when a message is displayed.
+   */
+  public static void addMessageDisplayedHandler(
+          MessageDisplayedCallback handler) {
+    if (handler == null) {
+      Log.e("addMessageDisplayedHandler - Invalid handler parameter " +
+              "provided.");
+      return;
+    }
+
+    synchronized (messageDisplayedHandlers) {
+      messageDisplayedHandlers.add(handler);
+    }
+  }
+
+  /**
+   * Removes a variables changed and no downloads pending callback.
+   */
+  public static void removeMessageDisplayedHandler(
+          MessageDisplayedCallback handler) {
+    if (handler == null) {
+      Log.e("removeMessageDisplayedHandler - Invalid handler parameter " +
+              "provided.");
+      return;
+    }
+
+    synchronized (messageDisplayedHandlers) {
+      messageDisplayedHandlers.remove(handler);
+    }
+  }
+
+  public static void triggerMessageDisplayed(ActionContext actionContext) {
+    ActionManager.getInstance().recordMessageImpression(actionContext.getMessageId());
+    synchronized (messageDisplayedHandlers) {
+      for (MessageDisplayedCallback callback : messageDisplayedHandlers) {
+        String messageID = actionContext.getMessageId();
+        String messageBody = "";
+        try {
+          messageBody = (String) actionContext.getArgs().get("Message");
+        } catch (Throwable t) {
+          Util.handleException(t);
+        }
+        String recipientUserID = Leanplum.getUserId();
+        Date deliveryDateTime = new Date();
+
+        MessageArchiveData messageArchiveData = new MessageArchiveData(messageID,
+                messageBody, recipientUserID, deliveryDateTime);
+        callback.setMessageArchiveData(messageArchiveData);
+        OsHandler.getInstance().post(callback);
+      }
+    }
+  }
+
   /**
    * Add a callback to call ONCE when no more file downloads are pending (either when no files
    * needed to be downloaded or all downloads have been completed).

AndroidSDKCore/src/main/java/com/leanplum/callbacks/MessageDisplayedCallback.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2013, Leanplum, Inc. All rights reserved.
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.leanplum.callbacks;
+
+import com.leanplum.models.MessageArchiveData;
+
+/**
+ * Message displayed callback.
+ *
+ * @author Mayank Sanganeria
+ */
+public abstract class MessageDisplayedCallback implements Runnable {
+
+  private MessageArchiveData messageArchiveData;
+
+  public void setMessageArchiveData(MessageArchiveData messageArchiveData) {
+    this.messageArchiveData = messageArchiveData;
+  }
+
+  public void run() {
+    this.messageDisplayed(messageArchiveData);
+  }
+
+  public abstract void messageDisplayed(MessageArchiveData messageArchiveData);
+}

AndroidSDKCore/src/main/java/com/leanplum/internal/LeanplumInternal.java

@@ -259,7 +259,7 @@ public int compare(ActionContext o1, ActionContext o2) {
             @Override
             public void variablesChanged() {
               try {
-                ActionManager.getInstance().recordMessageImpression(actionContext.getMessageId());
+                Leanplum.triggerMessageDisplayed(actionContext);
               } catch (Throwable t) {
                 Util.handleException(t);
               }

AndroidSDKCore/src/main/java/com/leanplum/internal/Socket.java

@@ -234,7 +234,7 @@ void handleTriggerEvent(JSONArray arguments) {
         ((BaseActionContext) context).setIsPreview(true);
         context.update();
         LeanplumInternal.triggerAction(context);
-        ActionManager.getInstance().recordMessageImpression(messageId);
+        Leanplum.triggerMessageDisplayed(context);
       }
     } catch (JSONException e) {
       Log.e("Error getting action info", e);

AndroidSDKCore/src/main/java/com/leanplum/models/MessageArchiveData.java

@@ -0,0 +1,19 @@
+package com.leanplum.models;
+
+import android.support.annotation.NonNull;
+
+import java.util.Date;
+
+public class MessageArchiveData {
+    @NonNull public String messageID;
+    @NonNull public String messageBody;
+    @NonNull public String recipientUserID;
+    @NonNull public Date deliveryDateTime;
+
+    public MessageArchiveData(String messageID, String messageBody, String recipientUserID, Date deliveryDateTime) {
+        this.messageID = messageID;
+        this.messageBody = messageBody;
+        this.recipientUserID = recipientUserID;
+        this.deliveryDateTime = deliveryDateTime;
+    }
+}

AndroidSDKTests/src/test/java/com/leanplum/LeanplumTest.java

@@ -32,6 +32,7 @@
 import com.leanplum._whitebox.utilities.ResponseHelper;
 import com.leanplum._whitebox.utilities.VariablesTestClass;
 import com.leanplum.annotations.Parser;
+import com.leanplum.callbacks.MessageDisplayedCallback;
 import com.leanplum.callbacks.StartCallback;
 import com.leanplum.callbacks.VariablesChangedCallback;
 import com.leanplum.internal.CollectionUtil;
@@ -45,18 +46,21 @@
 import com.leanplum.internal.Request;
 import com.leanplum.internal.Util;
 import com.leanplum.internal.VarCache;
+import com.leanplum.models.MessageArchiveData;
 
 import org.json.JSONArray;
 import org.json.JSONException;
 import org.json.JSONObject;
 import org.junit.Test;
+import org.mockito.Mock;
 import org.mockito.Mockito;
 import org.robolectric.RuntimeEnvironment;
 
 import java.lang.reflect.Method;
 import java.net.URLConnection;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Date;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Iterator;
@@ -80,7 +84,9 @@
 import static org.mockito.Matchers.anyInt;
 import static org.mockito.Matchers.anyString;
 import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.only;
 import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.when;
 import static org.powermock.api.mockito.PowerMockito.doNothing;
 import static org.powermock.api.mockito.PowerMockito.doReturn;
 import static org.powermock.api.mockito.PowerMockito.verifyStatic;
@@ -1048,7 +1054,7 @@ public void testLocationProvider() throws Exception {
     addresses.add(address);
     Geocoder geocoder = Mockito.mock(Geocoder.class);
     whenNew(Geocoder.class).withAnyArguments().thenReturn(geocoder);
-    Mockito.when(geocoder.getFromLocation(anyDouble(), anyDouble(), anyInt()))
+    when(geocoder.getFromLocation(anyDouble(), anyDouble(), anyInt()))
         .thenReturn(addresses);
 
     // Validate set location request shorthand.
@@ -1455,4 +1461,45 @@ private List<JSONObject> responsesWithCountAndPrefix(int n, String prefix) {
     }
     return responsesList;
   }
+
+  /**
+   * Test trigger message displayed calls callback
+   */
+  @Test
+  public void testTriggerMessageDisplayedCallbackCalled() {
+    final String messageID = "testMessageID";
+    final String messageBody = "testMessageBody";
+    final String userID = "testUserID";
+
+    Map<String, Object> args = new HashMap<>();
+    args.put("Message", messageBody);
+    final ActionContext testActionContext = new ActionContext("test", args, messageID);
+
+    when(Leanplum.getUserId()).thenReturn(userID);
+
+    class CallbackTest {
+      public boolean callbackCalled = false;
+      public MessageDisplayedCallback callback;
+
+      CallbackTest() {
+        callback = new MessageDisplayedCallback() {
+          @Override
+          public void messageDisplayed(MessageArchiveData messageArchiveData) {
+            callbackCalled = true;
+            assertTrue(messageArchiveData.messageID.equals(messageID));
+            assertTrue(messageArchiveData.messageBody.equals(messageBody));
+            assertTrue(messageArchiveData.recipientUserID.equals(userID));
+            long timeDiff = new Date().getTime() - messageArchiveData.deliveryDateTime.getTime();
+            assertTrue(timeDiff < 1000);
+          }
+        };
+      }
+    }
+
+    CallbackTest callbackTest = new CallbackTest();
+
+    Leanplum.addMessageDisplayedHandler(callbackTest.callback);
+    Leanplum.triggerMessageDisplayed(testActionContext);
+    assertTrue(callbackTest.callbackCalled);
+  }
 }