Implement wrapper of CleverTap SDK (#512)

* Add CleverTap wrapper

* [SDK-1836] Bump huawei, xiaomi, and fcm versions. Remove ct templates dependency.

* Move migration config to separate class. Delete persistence of enum and use string.

* Update migration state mid-session

* Fix mid-session start of CT

* Allow partial wrapper initialisation for early access

* Add debug logs in wrapper

* Fix app launched event, do not start dev socket if ct only, use operation queue for sending requests

* Improve user identity mapping

* Little fix in factory

* Add purchase methods, mappings, LP.start attributes

* Merge anonymous user into first login user

* Fix and remove unnecessary TODOs

* Map param values to CT

* Add traffic source info to wrapper

* Add CT instance callback, deprecate leanplum-mipush

* Fix unit tests

* Remove SyncListener usage and replace with custom

* Remove setDeviceId from wrapper

* Track value each time

Author: hborisoff

AndroidSDKCore/build.gradle

@@ -41,6 +41,8 @@ dependencies {
     // Compile dependencies will be added as dependency in pom file.
     api "androidx.legacy:legacy-support-v4:1.0.0"
     api "androidx.appcompat:appcompat:${APPCOMPAT_LIBRARY_VERSION}"
+
+    api "com.clevertap.android:clevertap-android-sdk:4.6.3"
 }
 
 task generateJavadoc(type: Javadoc) {

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

@@ -27,10 +27,12 @@
 
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import com.clevertap.android.sdk.CleverTapAPI;
 import com.leanplum.ActionContext.ContextualValues;
 import com.leanplum.actions.internal.ActionDefinition;
 import com.leanplum.actions.internal.ActionManagerDefinitionKt;
 import com.leanplum.callbacks.ActionCallback;
+import com.leanplum.callbacks.CleverTapInstanceCallback;
 import com.leanplum.callbacks.ForceContentUpdateCallback;
 import com.leanplum.callbacks.RegisterDeviceCallback;
 import com.leanplum.callbacks.RegisterDeviceFinishedCallback;
@@ -61,6 +63,7 @@
 import com.leanplum.internal.Util.DeviceIdInfo;
 import com.leanplum.internal.VarCache;
 import com.leanplum.messagetemplates.MessageTemplates;
+import com.leanplum.migration.MigrationManager;
 import com.leanplum.models.GeofenceEventType;
 import com.leanplum.utils.BuildUtil;
 import com.leanplum.utils.SharedPreferencesUtil;
@@ -101,7 +104,6 @@ public class Leanplum {
       new ArrayList<>();
   private static final ArrayList<VariablesChangedCallback> onceNoDownloadsHandlers =
       new ArrayList<>();
-  private static final Object heartbeatLock = new Object();
   private static final String LEANPLUM_NOTIFICATION_CHANNEL =
       "com.leanplum.LeanplumNotificationChannel";
   private static RegisterDeviceCallback registerDeviceHandler;
@@ -195,6 +197,7 @@ public static void enableVerboseLoggingInDevelopmentMode() {
    */
   public static void setLogLevel(int level) {
     Log.setLogLevel(level);
+    MigrationManager.getWrapper().setLogLevel(level);
   }
 
   /**
@@ -332,7 +335,11 @@ public static void setDeviceId(String deviceId) {
    * (Advanced) Sets new device ID. Must be called after Leanplum finished starting.
    * This method allows multiple changes of device ID in opposite of
    * {@link Leanplum#setDeviceId(String)}, which allows only one.
+   *
+   * @deprecated When migration of data to CleverTap is turned on calling this method with different
+   * device ID would not work any more.
    */
+  @Deprecated
   public static void forceNewDeviceId(String deviceId) {
     if (TextUtils.isEmpty(deviceId)) {
       Log.i("forceNewDeviceId - Empty deviceId parameter provided.");
@@ -344,6 +351,11 @@ public static void forceNewDeviceId(String deviceId) {
       return;
     }
 
+    if (MigrationManager.getState().useCleverTap()) {
+      Log.i("Setting new device ID is not allowed when migration to CleverTap is turned on.");
+      return;
+    }
+
     if (hasStarted()) {
       APIConfig.getInstance().setDeviceId(deviceId);
       APIConfig.getInstance().save();
@@ -379,6 +391,7 @@ public static void setLocale(String locale) {
    *
    * @return String Returns the deviceId in the current Leanplum session.
    */
+  @Nullable
   public static String getDeviceId() {
     if (!LeanplumInternal.hasCalledStart()) {
       Log.i("Leanplum.start() must be called before calling getDeviceId.");
@@ -394,13 +407,14 @@ public static void setApplicationContext(Context context) {
     if (context == null) {
       Log.i("setApplicationContext - Null context parameter provided.");
     }
-
     Leanplum.context = context;
+    MigrationManager.updateWrapper(); // init with StaticMethodsWrapper if migrating
   }
 
   /**
    * Gets the application context.
    */
+  @Nullable
   public static Context getContext() {
     if (context == null) {
       Log.e("Your application context is not set. "
@@ -607,6 +621,10 @@ static synchronized void start(final Context context, final String userId,
 
       LeanplumInternal.setStartedInBackground(actuallyInBackground);
 
+      LeanplumInternal.addStartIssuedHandler(() -> {
+        MigrationManager.getWrapper().setUserAttributes(attributes);
+      });
+
       final Map<String, ?> validAttributes = LeanplumInternal.validateAttributes(attributes,
           "userAttributes", true);
       LeanplumInternal.setCalledStart(true);
@@ -775,30 +793,42 @@ private static void startHelper(
 
     Util.initializePreLeanplumInstall(params);
 
-    // Issue start API call.
+    MigrationManager.fetchState(state -> {
+      if (state.useLeanplum()) {
+        issueLeanplumStart(isBackground, params);
+      } else {
+        overrideLeanplumStart();
+      }
+      return null;
+    });
+  }
+
+  private static void issueLeanplumStart(boolean isBackground, Map<String, Object> startParams) {
     RequestType requestType = isBackground ? RequestType.DEFAULT : RequestType.IMMEDIATE;
     Request request = RequestBuilder
         .withStartAction()
-        .andParams(params)
+        .andParams(startParams)
         .andType(requestType)
         .create();
-    request.onResponse(new Request.ResponseCallback() {
-      @Override
-      public void response(JSONObject response) {
-        Log.d("Received start response: %s", response);
-        handleStartResponse(response);
-      }
+    request.onResponse(response -> {
+      Log.d("Received start response: %s", response);
+      handleStartResponse(response);
     });
-    request.onError(new Request.ErrorCallback() {
-      @Override
-      public void error(Exception e) {
-        Log.e("Failed to receive start response", e);
-        handleStartResponse(null);
-      }
+    request.onError(e -> {
+      Log.e("Failed to receive start response", e);
+      handleStartResponse(null);
     });
     RequestSender.getInstance().send(request);
+    LeanplumInternal.triggerStartIssued();
+  }
 
+  private static void overrideLeanplumStart() {
+    // Override issueStart and hasStarted
     LeanplumInternal.triggerStartIssued();
+    LeanplumInternal.setHasStarted(true);
+    LeanplumInternal.setStartSuccessful(true);
+    LeanplumInternal.moveToForeground();
+    Leanplum.triggerStartResponse(true);
   }
 
   private static void handleStartResponse(final JSONObject response) {
@@ -1161,11 +1191,12 @@ public static boolean hasStarted() {
    * Returns the userId in the current Leanplum session. This should only be called after
    * Leanplum.start().
    */
+  @Nullable
   public static String getUserId() {
-    if (hasStarted()) {
+    if (LeanplumInternal.hasCalledStart()) {
       return APIConfig.getInstance().userId();
     } else {
-      Log.e("Leanplum.start() must be called before calling getUserId()");
+      Log.i("Leanplum.start() must be called before calling getUserId()");
     }
     return null;
   }
@@ -1466,19 +1497,23 @@ public static void setUserAttributes(final String userId, Map<String, ?> userAtt
         params.put(Constants.Params.NEW_USER_ID, userId);
       }
       if (userAttributes != null) {
-        userAttributes = LeanplumInternal.validateAttributes(userAttributes, "userAttributes",
-            true);
-        params.put(Constants.Params.USER_ATTRIBUTES, JsonConverter.toJson(userAttributes));
-        LeanplumInternal.getUserAttributeChanges().add(userAttributes);
+        Map<String, ?> validUserAttributes =
+            LeanplumInternal.validateAttributes(userAttributes, "userAttributes", true);
+        params.put(Constants.Params.USER_ATTRIBUTES, JsonConverter.toJson(validUserAttributes));
+        LeanplumInternal.getUserAttributeChanges().add(validUserAttributes);
       }
 
       if (LeanplumInternal.issuedStart()) {
+        MigrationManager.getWrapper().setUserId(userId);
+        MigrationManager.getWrapper().setUserAttributes(userAttributes);
         setUserAttributesInternal(userId, params);
       } else {
         LeanplumInternal.addStartIssuedHandler(new Runnable() {
           @Override
           public void run() {
             try {
+              MigrationManager.getWrapper().setUserId(userId);
+              MigrationManager.getWrapper().setUserAttributes(userAttributes);
               setUserAttributesInternal(userId, params);
             } catch (Throwable t) {
               Log.exception(t);
@@ -1590,15 +1625,17 @@ public static void setTrafficSourceInfo(Map<String, String> info) {
 
     try {
       final HashMap<String, Object> params = new HashMap<>();
-      info = LeanplumInternal.validateAttributes(info, "info", false);
-      params.put(Constants.Params.TRAFFIC_SOURCE, JsonConverter.toJson(info));
+      Map<String, String> validInfo = LeanplumInternal.validateAttributes(info, "info", false);
+      params.put(Constants.Params.TRAFFIC_SOURCE, JsonConverter.toJson(validInfo));
       if (LeanplumInternal.issuedStart()) {
+        MigrationManager.getWrapper().setTrafficSourceInfo(info);
         setTrafficSourceInfoInternal(params);
       } else {
         LeanplumInternal.addStartIssuedHandler(new Runnable() {
           @Override
           public void run() {
             try {
+              MigrationManager.getWrapper().setTrafficSourceInfo(info);
               setTrafficSourceInfoInternal(params);
             } catch (Throwable t) {
               Log.exception(t);
@@ -1635,6 +1672,7 @@ private static void setTrafficSourceInfoInternal(HashMap<String, Object> params)
    */
   public static void track(final String event, double value, String info,
       Map<String, ?> params) {
+    MigrationManager.getWrapper().track(event, value, info, params);
     LeanplumInternal.track(event, value, info, params, null);
   }
 
@@ -1660,6 +1698,7 @@ public static void trackPurchase(final String event, double value, String curren
         requestArgs.put(Constants.Params.IAP_CURRENCY_CODE, currencyCode);
       }
 
+      MigrationManager.getWrapper().trackPurchase(event, value, currencyCode, params);
       LeanplumInternal.track(event, value, null, params, requestArgs);
     } catch (Throwable t) {
       Log.exception(t);
@@ -1729,6 +1768,17 @@ public static void trackGooglePlayPurchase(String eventName, String item, long p
     }
     modifiedParams.put(Constants.Params.IAP_ITEM, item);
 
+    if (MigrationManager.trackGooglePlayPurchases()) {
+      MigrationManager.getWrapper().trackGooglePlayPurchase(
+          eventName,
+          item,
+          priceMicros / 1000000.0,
+          currencyCode,
+          purchaseData,
+          dataSignature,
+          params
+      );
+    }
     LeanplumInternal.track(eventName, priceMicros / 1000000.0, null, modifiedParams, requestArgs);
   }
 
@@ -1859,12 +1909,14 @@ public static void advanceTo(final String state, String info, final Map<String,
       }
 
       if (LeanplumInternal.issuedStart()) {
+        MigrationManager.getWrapper().advanceTo(state, info, params);
         advanceToInternal(state, validatedParams, requestParams);
       } else {
         LeanplumInternal.addStartIssuedHandler(new Runnable() {
           @Override
           public void run() {
             try {
+              MigrationManager.getWrapper().advanceTo(state, info, params);
               advanceToInternal(state, validatedParams, requestParams);
             } catch (Throwable t) {
               Log.exception(t);
@@ -2330,4 +2382,14 @@ public static void setPushDeliveryTracking(boolean enable) {
   public static boolean isPushDeliveryTrackingEnabled() {
     return pushDeliveryTrackingEnabled;
   }
+
+  /**
+   * Sets callback object to be notified when CleverTapAPI instance is created.
+   * Use this callback to initialise any CleverTap state.
+   *
+   * @param callback Null value will remove the callback.
+   */
+  public static void onCleverTapInstanceInitialized(@Nullable CleverTapInstanceCallback callback) {
+    MigrationManager.setCleverTapInstanceCallback(callback);
+  }
 }

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

@@ -29,6 +29,7 @@
 import android.content.res.Resources;
 import android.os.Bundle;
 
+import com.clevertap.android.sdk.ActivityLifecycleCallback;
 import com.leanplum.actions.internal.ActionManagerExecutionKt;
 import com.leanplum.annotations.Parser;
 import com.leanplum.internal.ActionManager;
@@ -37,6 +38,7 @@
 import com.leanplum.internal.Log;
 
 import com.leanplum.internal.OperationQueue;
+import com.leanplum.migration.MigrationManager;
 import com.leanplum.utils.BuildUtil;
 import java.util.LinkedList;
 import java.util.Queue;
@@ -206,6 +208,8 @@ public static void enableLifecycleCallbacks(final Application app) {
       app.registerActivityLifecycleCallbacks(new LeanplumLifecycleCallbacks());
     }
 
+    MigrationManager.getWrapper().registerLifecycleCallback(app);
+
     registeredCallbacks = true;
     // run pending actions if any upon start
     LeanplumInternal.addStartIssuedHandler(runPendingActionsRunnable);

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

@@ -0,0 +1,8 @@
+package com.leanplum.callbacks;
+
+import androidx.annotation.NonNull;
+import com.clevertap.android.sdk.CleverTapAPI;
+
+public interface CleverTapInstanceCallback {
+  void onInstance(@NonNull CleverTapAPI cleverTapInstance);
+}

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

@@ -158,6 +158,16 @@ public static class Params {
     public static final String API_HOST = "apiHost";
     public static final String API_PATH = "apiPath";
     public static final String DEV_SERVER_HOST = "devServerHost";
+    public static final String MIGRATE_STATE = "migrateState";
+    public static final String MIGRATE_STATE_HASH = "sha256";
+    public static final String SDK = "sdk";
+    public static final String CT_DUPLICATE = "ct";
+    public static final String CLEVERTAP = "ct";
+    public static final String CT_ACCOUNT_ID = "accountId";
+    public static final String CT_TOKEN = "token";
+    public static final String CT_REGION_CODE = "regionCode";
+    public static final String CT_ATTRIBUTE_MAPPINGS = "attributeMappings";
+    public static final String API_EVENTS_STATE = "events";
   }
 
   public static class Keys {

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

@@ -36,6 +36,7 @@
 import com.leanplum.actions.internal.Priority;
 import com.leanplum.callbacks.StartCallback;
 import com.leanplum.internal.Request.RequestType;
+import com.leanplum.migration.MigrationManager;
 import com.leanplum.models.GeofenceEventType;
 
 import java.util.Arrays;
@@ -573,6 +574,9 @@ public void onResponse(boolean success) {
         if (!inForeground) {
           return;
         }
+        if (!MigrationManager.getState().useLeanplum()) {
+          return;
+        }
         if (Constants.isDevelopmentModeEnabled && !Constants.isNoop()) {
           Socket.connectSocket();
         }

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

@@ -54,6 +54,7 @@ public class RequestBuilder {
   public static final String ACTION_GET_INBOX_MESSAGES = "getNewsfeedMessages";
   public static final String ACTION_MARK_INBOX_MESSAGE_AS_READ = "markNewsfeedMessageAsRead";
   public static final String ACTION_DELETE_INBOX_MESSAGE = "deleteNewsfeedMessage";
+  public static final String ACTION_GET_MIGRATE_STATE = "getMigrateState";
 
   private String httpMethod;
   private String apiAction;
@@ -162,6 +163,10 @@ public static RequestBuilder withDeleteInboxMessageAction() {
     return new RequestBuilder(POST, ACTION_DELETE_INBOX_MESSAGE);
   }
 
+  public static RequestBuilder withGetMigrateState() {
+    return new RequestBuilder(POST, ACTION_GET_MIGRATE_STATE);
+  }
+
   public RequestBuilder andParam(String param, Object value) {
     if (params == null)
       params = new HashMap<>();