IAM Handlers refactoring (#503)

* Refactoring initial commit

* Improvements:

- fix several TODOs in the code
- remove messageDisplayedHandlers
- remove onAction listeners

* Run push open action with priority also other improvements and fixes

* Remove actionNamedHandler

* Fix dismiss of inapps when activity is changed. Add localCaps check. More details:

- Queue is paused during activity switching, i.e. when activity is paused and resumed the queue will also gets paused or resumed.
- When activity is switched (notification click) the current presented in-app dialog must be closed to avoid leaking of Window objects.
- Android OS works like that:
 * If you have activity A1 and user is switching to another activity A2 then A1.onPause is invoked first, then A2.onResume and finally A1.stop will be called.
 * If you have activity A1 shown and you bring app to background it will call A1.onPause and A1.onStop freeing our LeanplumActivityHelper.currentActivity reference, but we need to somehow keep reference to the last activity to free any Window objects.
- For the above reasons there is a change in LeanplumActivityHelper.onResume calling avoidWindowLeaks method. It works with lastForegroundActivity reference, that keeps the previous activity instance. It will be freed when onDestroy is called for the same activity (check LeanplumActivityHelper.onDestroy).
- Changes are tested with both Legacy messaging push and Campaign push, both containing "open app", "deeplink" or "iam" payload. Tested with Android 11 and Android 12, because of the notification trampolines.
- There is only one issue, or a feature, however you like it - If you have inapp M1 presented, M2 waiting in the queue, and a push P1 comes with payload M3. What will happen on a P1 click is first M1 dismisses, because activity changes (depends on implementation), next M2 is presented, but the M3 from payload is added with higher priority so M2 is dismissed too and only M3 is presented. If you have a third inapp it will remain in the queue and will present after M3.

* Change orderMessages to prioritizeMessages. Pause action queue on dev device message.

* Remove redundant deprecations

* Guard against user exception

* Fix some TODOs and improve javadoc

* Remove resolved TODOs

* Move some of the files to .internal package

* Add javadoc and convert java to kotlin

* Fix unit tests. Remove couple unnecessary

* Fix merge error

* Add setPaused and setEnabled to LeanplumActions. Fix a pause bug.

* Add MessageDisplayChoice.delayIndefinitely()

* Fix some of the review comments

* Remove functionality for ignored activites. Replaced by MessageDisplayController.shouldDisplayMessage.

* Remove the deprecated jcenter() repository

* Fix runActionNamed to not call actionDismissed. Tested all in-app templates with legacy messaging and campaigns.

* Add JvmStatic for the new static methods

* Fix review comments about queue paused state

* Allow nullable controller and listener

* IAM Handlers unit tests (#504)

* Add tests for queue and definitions

* Add setPaused and setEnabled to LeanplumActions. Fix a pause bug.

* Add tests for ActionManagerTriggering

* Add MessageDisplayChoice.delayIndefinitely()

* Add tests for ActionManagerExecution

* Add test for MessageDisplayListener. Improve readability.

Author: hborisoff

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

@@ -116,7 +116,7 @@ public ActionArgs withAction(String name, String defaultValue) {
     return this;
   }
 
-  List<ActionArg<?>> getValue() {
+  public List<ActionArg<?>> getValue() {
     return args;
   }
 

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021, Leanplum, Inc. All rights reserved.
+ * Copyright 2022, Leanplum, Inc. All rights reserved.
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -24,8 +24,11 @@
 import androidx.annotation.NonNull;
 import android.text.TextUtils;
 
-import com.leanplum.callbacks.ActionCallback;
-import com.leanplum.callbacks.VariablesChangedCallback;
+import com.leanplum.actions.internal.ActionDidExecute;
+import com.leanplum.actions.internal.ActionManagerDefinitionKt;
+import com.leanplum.actions.internal.ActionManagerTriggeringKt;
+import com.leanplum.actions.internal.ActionDidDismiss;
+import com.leanplum.actions.internal.Priority;
 import com.leanplum.internal.ActionManager;
 import com.leanplum.internal.BaseActionContext;
 import com.leanplum.internal.CollectionUtil;
@@ -57,7 +60,9 @@ public class ActionContext extends BaseActionContext implements Comparable<Actio
   private String key;
   private boolean preventRealtimeUpdating = false;
   private ContextualValues contextualValues;
-  private ActionCallback actionNamedHandler;
+  private ActionDidDismiss actionDidDismiss;
+  private ActionDidExecute actionDidExecute;
+  private boolean isChainedMessage;
 
   public static class ContextualValues {
     /**
@@ -106,29 +111,25 @@ public ContextualValues getContextualValues() {
     return contextualValues;
   }
 
-  private static Map<String, Object> getDefinition(String name) {
-    Map<String, Object> definition = CollectionUtil.uncheckedCast(
-        VarCache.actionDefinitions().get(name));
+  private Map<String, Object> getDefinition(String actionName) {
+    Map<String, Object> definition =
+        ActionManagerDefinitionKt.getActionDefinitionMap(ActionManager.getInstance(), actionName);
     if (definition == null) {
       return new HashMap<>();
     }
     return definition;
   }
 
-  private Map<String, Object> getDefinition() {
-    return getDefinition(name);
-  }
-
   private Map<String, Object> defaultValues() {
-    Map<String, Object> values = CollectionUtil.uncheckedCast(getDefinition().get("values"));
+    Map<String, Object> values = CollectionUtil.uncheckedCast(getDefinition(name).get("values"));
     if (values == null) {
       return new HashMap<>();
     }
     return values;
   }
 
   private Map<String, String> kinds() {
-    Map<String, String> kinds = CollectionUtil.uncheckedCast(getDefinition().get("kinds"));
+    Map<String, String> kinds = CollectionUtil.uncheckedCast(getDefinition(name).get("kinds"));
     if (kinds == null) {
       return new HashMap<>();
     }
@@ -352,121 +353,100 @@ private Map<String, Object> getChildArgs(String name) {
     return actionArgs;
   }
 
-  public void setActionNamedHandler(ActionCallback handler) {
-    actionNamedHandler = handler;
-  }
-
-  private void triggerActionNamedHandler(String name, Map<String, Object> args) {
-    if (actionNamedHandler != null) {
-      ActionContext actionContext = new ActionContext(name, args, messageId);
-      actionContext.parentContext = this;
-      actionNamedHandler.onResponse(actionContext);
-    }
-  }
-
   public void runActionNamed(String name) {
     if (TextUtils.isEmpty(name)) {
       Log.e("runActionNamed - Invalid name parameter provided.");
       return;
     }
     Map<String, Object> args = getChildArgs(name);
 
-    triggerActionNamedHandler(name, args);
+    if (actionDidExecute != null) {
+      ActionContext actionNamedContext = new ActionContext(name, args, messageId);
+      actionNamedContext.parentContext = this;
+      actionDidExecute.onActionExecuted(actionNamedContext);
+    }
 
     if (args == null) {
       return;
     }
 
-    // Checks if action "Chain to Existing Message" started.
-    if (!isChainToExistingMessageStarted(args, name)) {
-      // Try to start action "Chain to a new Message".
+    performChainedAction(name, args);
+  }
+
+  private void performChainedAction(String name, Map<String, Object> args) {
+    String chainedMessageId = getChainedMessageId(args);
+
+    if (chainedMessageId != null) { // Chain to existing message
+      if (shouldFetchChainedMessage(args)) {
+        boolean previousPauseState = ActionManager.getInstance().isPaused();
+        ActionManager.getInstance().setPaused(true);
+        // Message doesn't seem to be on the device,
+        // so let's forceContentUpdate and retry showing it.
+        Leanplum.forceContentUpdate(success -> {
+          if (success) {
+            executeChainedMessage(chainedMessageId, name);
+          }
+          ActionManager.getInstance().setPaused(previousPauseState); // will resume queue
+        });
+      } else {
+        executeChainedMessage(chainedMessageId, name);
+        // queue will be resumed from onDidDismiss callback in case executeChainedMessage fails
+      }
+
+    } else { // Chain to embedded message
       Object messageAction = args.get(Constants.Values.ACTION_ARG);
       if (messageAction != null) {
-        createActionContextForMessageId(messageAction.toString(), args, messageId, name, false);
+        ActionContext embeddedContext = createChainedContext(
+            messageAction.toString(),
+            args,
+            messageId,
+            name);
+        ActionManagerTriggeringKt.trigger(
+            ActionManager.getInstance(),
+            embeddedContext,
+            Priority.HIGH);
       }
     }
   }
 
-  /**
-   * Return true if here was an action for this message and we started it.
-   */
-  private boolean createActionContextForMessageId(String messageAction,
-      Map<String, Object> messageArgs, String messageId, String name, Boolean chained) {
-    try {
-      final ActionContext actionContext = new ActionContext(messageAction,
-          messageArgs, messageId);
+  private ActionContext createChainedContext(
+      String messageAction,
+      Map<String, Object> messageArgs,
+      String messageId,
+      String name) {
+
+      ActionContext actionContext = new ActionContext(messageAction, messageArgs, messageId);
       actionContext.contextualValues = contextualValues;
       actionContext.preventRealtimeUpdating = preventRealtimeUpdating;
       actionContext.isRooted = isRooted;
       actionContext.key = name;
-      if (chained) {
-        LeanplumInternal.triggerAction(actionContext, new VariablesChangedCallback() {
-          @Override
-          public void variablesChanged() {
-            try {
-              // We do not want to count occurrences for action kind, because in multi message
-              // campaigns the Open URL action is not a message. Also if the user has defined
-              // actions of type Action we do not want to count them.
-              int actionKind = VarCache.getActionDefinitionType(actionContext.name);
-              if (actionKind == Leanplum.ACTION_KIND_ACTION) {
-                ActionManager.getInstance().recordChainedActionImpression(messageId);
-              } else {
-                ActionManager.getInstance().recordMessageImpression(messageId);
-              }
-              Leanplum.triggerMessageDisplayed(actionContext);
-
-            } catch (Throwable t) {
-              Log.exception(t);
-            }
-          }
-        });
-      } else {
-        actionContext.parentContext = this;
-        LeanplumInternal.triggerAction(actionContext);
-      }
-      return true;
-    } catch (Throwable t) {
-      Log.exception(t);
-    }
-    return false;
+      actionContext.parentContext = this;
+      return actionContext;
   }
 
-  /**
-   * Return true if there was action "Chain to Existing Message" and we started it.
-   */
-  private boolean isChainToExistingMessageStarted(Map<String, Object> args, final String name) {
-    if (args == null) {
+  public static boolean shouldFetchChainedMessage(
+      @NonNull ActionContext context,
+      String actionName) {
+    if (TextUtils.isEmpty(actionName)) {
       return false;
     }
-
-    final String messageId = getChainedMessageId(args);
-    if (!shouldForceContentUpdateForChainedMessage(args)) {
-      return executeChainedMessage(messageId, VarCache.messages(), name);
-    } else {
-      // message may not on the device yet, so we need to fetch it.
-      Leanplum.forceContentUpdate(new VariablesChangedCallback() {
-        @Override
-        public void variablesChanged() {
-          executeChainedMessage(messageId, VarCache.messages(), name);
-        }
-      });
-    }
-    return false;
+    Map<String, Object> args = context.getChildArgs(actionName);
+    return shouldFetchChainedMessage(args);
   }
 
   /**
    * Return true if there is a chained message in the actionMap that is not yet loaded onto the device.
    */
-  static boolean shouldForceContentUpdateForChainedMessage(Map<String, Object> actionMap) {
+  static boolean shouldFetchChainedMessage(Map<String, Object> actionMap) {
     if (actionMap == null) {
       return false;
     }
     String chainedMessageId = getChainedMessageId(actionMap);
-    if (chainedMessageId != null
-            && (VarCache.messages() == null || !VarCache.messages().containsKey(chainedMessageId))) {
-        return true;
+    if (chainedMessageId == null) {
+      return false;
     }
-    return false;
+    return VarCache.messages() == null
+        || !VarCache.messages().containsKey(chainedMessageId);
   }
 
   /**
@@ -482,8 +462,8 @@ static String getChainedMessageId(Map<String, Object> actionMap) {
   }
 
 
-  private boolean executeChainedMessage(String messageId, Map<String, Object> messages,
-                                        String name) {
+  private boolean executeChainedMessage(String messageId, String name) {
+    Map<String, Object> messages = VarCache.messages();
     if (messages == null) {
       return false;
     }
@@ -492,8 +472,20 @@ private boolean executeChainedMessage(String messageId, Map<String, Object> mess
       Map<String, Object> messageArgs = CollectionUtil.uncheckedCast(
               message.get(Constants.Keys.VARS));
       Object messageAction = message.get("action");
-      return messageAction != null && createActionContextForMessageId(messageAction.toString(),
-              messageArgs, messageId, name, true);
+
+      if (messageAction != null) {
+        ActionContext chainContext = createChainedContext(
+            messageAction.toString(),
+            messageArgs,
+            messageId,
+            name);
+        chainContext.isChainedMessage = true;
+        ActionManagerTriggeringKt.trigger(
+            ActionManager.getInstance(),
+            chainContext,
+            Priority.HIGH);
+        return true;
+      }
     }
     return false;
   }
@@ -633,4 +625,36 @@ public static <T> Map<String, T> mapFromJson(JSONObject jsonObject) throws JSONE
   public ActionContext getParentContext() {
     return parentContext;
   }
+
+  public void setParentContext(ActionContext parentContext) {
+    this.parentContext = parentContext;
+  }
+
+  public boolean isChainedMessage() {
+    return isChainedMessage;
+  }
+
+  @Override
+  @NonNull
+  public String toString() {
+    String parent = "";
+    if (parentContext != null) {
+      parent = "(parent=" + parentContext + ")";
+    }
+    return name + ":" + messageId + parent;
+  }
+
+  public void actionDismissed() {
+    if (actionDidDismiss != null) {
+      actionDidDismiss.onDismiss();
+    }
+  }
+
+  public void setActionDidDismiss(ActionDidDismiss actionDidDismiss) {
+    this.actionDidDismiss = actionDidDismiss;
+  }
+
+  public void setActionDidExecute(ActionDidExecute actionDidExecute) {
+    this.actionDidExecute = actionDidExecute;
+  }
 }