Xiaomi MiPush Messaging Integration (#442)

* Add MiPush module

* Temporarily comment VerifyError fix

* Add delivery channel to push metrics. Parse MiPush payload.

* Support Mute inside app

* Add unit tests

* Uncomment sending of regId. Improve logging.

* Send correct reg id

* Fix docs and logs

* Resolve lp_message from description

* Add sentTime to push metrics

* Remove DeliveryChannel enum to simplify the code

* Use hashCode for notification id, because UUID is sent in some cases

* Protect against exceptions

* Fix thread safety issues

* Handle lp_notification_id (occurrence id) and send with push event params

* Do not initialize MiPush for non-Xiaomi devices

* SDK-302 - enable/disable push delivery tracking

* Change event param name for the occurrence id

* Fix local pushes for offline and locked device

* Change lp_occurrence_id to lp_occurrenceId

* Change push param lp_occurrenceId to lp_occurrence_id

Author: hborisoff

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020, Leanplum, Inc. All rights reserved.
+ * Copyright 2021, Leanplum, Inc. All rights reserved.
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -110,10 +110,9 @@ public class Leanplum {
   private static String customAppVersion = null;
   private static boolean userSpecifiedDeviceId;
   private static boolean locationCollectionEnabled = true;
+  private static volatile boolean pushDeliveryTrackingEnabled = true;
   private static Context context;
 
-  private static Runnable pushStartCallback;
-
   private static CountAggregator countAggregator = new CountAggregator();
   private static FeatureFlagManager featureFlagManager = FeatureFlagManager.INSTANCE;
 
@@ -692,6 +691,8 @@ private static void startHelper(
 
     String fcmRegistrationId = SharedPreferencesUtil.getString(context,
         Constants.Defaults.LEANPLUM_PUSH, Constants.Defaults.PROPERTY_FCM_TOKEN_ID);
+    String miPushRegistrationId = SharedPreferencesUtil.getString(context,
+        Constants.Defaults.LEANPLUM_PUSH, Constants.Defaults.PROPERTY_MIPUSH_TOKEN_ID);
 
     HashMap<String, Object> params = new HashMap<>();
     params.put(Constants.Params.INCLUDE_DEFAULTS, Boolean.toString(false));
@@ -706,6 +707,9 @@ private static void startHelper(
     if (!TextUtils.isEmpty(fcmRegistrationId)) {
       params.put(Constants.Params.DEVICE_FCM_PUSH_TOKEN, fcmRegistrationId);
     }
+    if (!TextUtils.isEmpty(miPushRegistrationId)) {
+      params.put(Constants.Params.DEVICE_MIPUSH_TOKEN, miPushRegistrationId);
+    }
     params.put(Constants.Keys.TIMEZONE, localTimeZone.getID());
     params.put(Constants.Keys.TIMEZONE_OFFSET_SECONDS, Integer.toString(timezoneOffsetSeconds));
     params.put(Constants.Keys.LOCALE, Util.getLocale());
@@ -1555,10 +1559,13 @@ static void setRegistrationId(PushProviderType type, final String registrationId
       case FCM:
         attributeName = Constants.Params.DEVICE_FCM_PUSH_TOKEN;
         break;
+      case MIPUSH:
+        attributeName = Constants.Params.DEVICE_MIPUSH_TOKEN;
+        break;
       default:
         return;
     }
-    pushStartCallback = new Runnable() {
+    Runnable startIssuedHandler = new Runnable() {
       @Override
       public void run() {
         if (Constants.isNoop()) {
@@ -1576,7 +1583,7 @@ public void run() {
         }
       }
     };
-    LeanplumInternal.addStartIssuedHandler(pushStartCallback);
+    LeanplumInternal.addStartIssuedHandler(startIssuedHandler);
   }
 
   /**
@@ -2295,4 +2302,20 @@ public static void setEventsUploadInterval(EventsUploadInterval uploadInterval)
       RequestSenderTimer.get().setTimerInterval(uploadInterval);
     }
   }
+
+  /**
+   * Enable or disable push delivery tracking. It is enabled by default.
+   */
+  public static void setPushDeliveryTracking(boolean enable) {
+    pushDeliveryTrackingEnabled = enable;
+  }
+
+  /**
+   * Returns whether the push delivery tracking is enabled.
+   *
+   * @return True if push delivery tracking is enabled, false otherwise.
+   */
+  public static boolean isPushDeliveryTrackingEnabled() {
+    return pushDeliveryTrackingEnabled;
+  }
 }

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

@@ -22,5 +22,6 @@
 package com.leanplum;
 
 enum PushProviderType {
-  FCM
+  FCM,
+  MIPUSH
 }

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

@@ -87,6 +87,7 @@ public static class Defaults {
     public static final String LEANPLUM_PUSH = "__leanplum_push__";
     public static final String APP_ID = "__app_id";
     public static final String PROPERTY_FCM_TOKEN_ID = "registration_id";
+    public static final String PROPERTY_MIPUSH_TOKEN_ID = "mipush_registration_id";
     public static final String PROPERTY_SENDER_IDS = "sender_ids";
     public static final String NOTIFICATION_CHANNELS_KEY = "__leanplum_notification_channels";
     public static final String DEFAULT_NOTIFICATION_CHANNEL_KEY = "__leanplum_default_notification_channels";
@@ -108,6 +109,7 @@ public static class Params {
     public static final String DEVICE_MODEL = "deviceModel";
     public static final String DEVICE_NAME = "deviceName";
     public static final String DEVICE_FCM_PUSH_TOKEN = "gcmRegistrationId";
+    public static final String DEVICE_MIPUSH_TOKEN = "miPushRegId";
     public static final String DEVICE_SYSTEM_NAME = "systemName";
     public static final String DEVICE_SYSTEM_VERSION = "systemVersion";
     public static final String EMAIL = "email";
@@ -175,8 +177,18 @@ public static class Keys {
     public static final String PUSH_MESSAGE_ID_NO_MUTE = "_lpn";
     public static final String PUSH_MESSAGE_ID_MUTE = "_lpv";
     public static final String PUSH_MESSAGE_ID = "lp_messageId";
+    public static final String PUSH_MESSAGE_NOTIFICATION_ID = "lp_notificationId";
     public static final String PUSH_MESSAGE_TEXT = "lp_message";
+    public static final String PUSH_VERSION = "lp_version";
     public static final String PUSH_MESSAGE_IMAGE_URL = "lp_imageUrl";
+    public static final String PUSH_METRIC_SENT_TIME = "sentTime";
+    public static final String PUSH_METRIC_OCCURRENCE_ID = "occurrenceId";
+    public static final String PUSH_METRIC_CHANNEL = "channel";
+    public static final String PUSH_METRIC_MESSAGE_ID = "messageID";
+    public static final String CHANNEL_INTERNAL_KEY = "_channel_internal";
+    public static final String PUSH_MESSAGE_SILENT_TRACK = "lp_silent_track";
+    public static final String PUSH_SENT_TIME = "lp_sent_time";
+    public static final String PUSH_OCCURRENCE_ID = "lp_occurrence_id";
     public static final String REGION = "region";
     public static final String REGION_STATE = "regionState";
     public static final String REGIONS = "regions";

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

@@ -656,4 +656,13 @@ public static int generateIdFromResourceName(String resourceName) {
     Log.d("Could not extract resource id from provided resource name: ", resourceName);
     return 0;
   }
+
+  /**
+   * Checks if device is manufactured by Xiaomi.
+   *
+   * @return True if device is manufactured by Xiaomi.
+   */
+  public static boolean isXiaomiDevice() {
+    return Build.MANUFACTURER != null && Build.MANUFACTURER.toLowerCase().contains("xiaomi");
+  }
 }

AndroidSDKFcm/src/main/java/com/leanplum/LeanplumFirebaseServiceHandler.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020, Leanplum, Inc. All rights reserved.
+ * Copyright 2021, Leanplum, Inc. All rights reserved.
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -26,6 +26,7 @@
 import com.google.firebase.messaging.FirebaseMessagingService;
 import com.google.firebase.messaging.RemoteMessage;
 import com.leanplum.internal.Constants;
+import com.leanplum.internal.Constants.Keys;
 import com.leanplum.internal.Log;
 import java.util.Map;
 
@@ -57,8 +58,18 @@ public void onNewToken(String token, Context context) {
   public void onMessageReceived(RemoteMessage remoteMessage, Context context) {
     try {
       Map<String, String> messageMap = remoteMessage.getData();
+
+      String channel;
+      if (messageMap.containsKey(Keys.PUSH_MESSAGE_SILENT_TRACK)) {
+        channel = PushTracking.CHANNEL_FCM_SILENT_TRACK;
+      } else {
+        channel = PushTracking.CHANNEL_FCM;
+      }
+
       if (messageMap.containsKey(Constants.Keys.PUSH_MESSAGE_TEXT)) {
-        LeanplumPushService.handleNotification(context, getBundle(messageMap));
+        Bundle notification = getBundle(messageMap);
+        notification.putString(Keys.CHANNEL_INTERNAL_KEY, channel);
+        LeanplumPushService.handleNotification(context, notification);
       }
       Log.d("Received push notification message: %s", messageMap.toString());
     } catch (Throwable t) {

AndroidSDKMiPush/.gitignore

@@ -0,0 +1 @@
+/build

AndroidSDKMiPush/build.gradle

@@ -0,0 +1,46 @@
+apply plugin: 'com.android.library'
+apply plugin: 'com.jfrog.artifactory'
+apply plugin: 'com.jfrog.bintray'
+apply plugin: 'maven-publish'
+apply from: "../common-methods.gradle"
+
+android {
+    compileSdkVersion COMPILE_SDK_VERSION
+    defaultConfig {
+        minSdkVersion MIN_SDK_VERSION
+        defaultConfig {
+            consumerProguardFiles 'consumer-proguard-rules.pro'
+        }
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled true
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+
+    compileOptions {
+        sourceCompatibility JAVA_VERSION
+        targetCompatibility JAVA_VERSION
+    }
+}
+
+dependencies {
+    debugApi project(':AndroidSDKCore')
+    releaseApi project(':AndroidSDKCore')
+    debugApi project(':AndroidSDKPush')
+    releaseApi project(':AndroidSDKPush')
+
+    // MiPush SDK is located in libs
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+}
+
+task generateJavadoc(type: Javadoc) {
+    source = android.sourceSets.main.java.srcDirs
+    classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
+    destinationDir = file("./javadoc/")
+    failOnError false
+}
+
+publishing_task(LEANPLUM_MIPUSH_ARTIFACT_ID)

AndroidSDKMiPush/consumer-proguard-rules.pro

@@ -0,0 +1,7 @@
+# Keep default Leanplum classes.
+-keepclassmembers class * {
+@com.leanplum.annotations.* <fields>;
+}
+
+-keep class com.leanplum.** { *; }
+-dontwarn com.leanplum.**